| 1234567891011121314151617181920212223242526272829303132333435363738394041424344454647484950515253545556575859606162636465666768697071727374757677787980818283848586878889909192939495969798991001011021031041051061071081091101111121131141151161171181191201211221231241251261271281291301311321331341351361371381391401411421431441451461471481491501511521531541551561571581591601611621631641651661671681691701711721731741751761771781791801811821831841851861871881891901911921931941951961971981992002012022032042052062072082092102112122132142152162172182192202212222232242252262272282292302312322332342352362372382392402412422432442452462472482492502512522532542552562572582592602612622632642652662672682692702712722732742752762772782792802812822832842852862872882892902912922932942952962972982993003013023033043053063073083093103113123133143153163173183193203213223233243253263273283293303313323333343353363373383393403413423433443453463473483493503513523533543553563573583593603613623633643653663673683693703713723733743753763773783793803813823833843853863873883893903913923933943953963973983994004014024034044054064074084094104114124134144154164174184194204214224234244254264274284294304314324334344354364374384394404414424434444454464474484494504514524534544554564574584594604614624634644654664674684694704714724734744754764774784794804814824834844854864874884894904914924934944954964974984995005015025035045055065075085095105115125135145155165175185195205215225235245255265275285295305315325335345355365375385395405415425435445455465475485495505515525535545555565575585595605615625635645655665675685695705715725735745755765775785795805815825835845855865875885895905915925935945955965975985996006016026036046056066076086096106116126136146156166176186196206216226236246256266276286296306316326336346356366376386396406416426436446456466476486496506516526536546556566576586596606616626636646656666676686696706716726736746756766776786796806816826836846856866876886896906916926936946956966976986997007017027037047057067077087097107117127137147157167177187197207217227237247257267277287297307317327337347357367377387397407417427437447457467477487497507517527537547557567577587597607617627637647657667677687697707717727737747757767777787797807817827837847857867877887897907917927937947957967977987998008018028038048058068078088098108118128138148158168178188198208218228238248258268278288298308318328338348358368378388398408418428438448458468478488498508518528538548558568578588598608618628638648658668678688698708718728738748758768778788798808818828838848858868878888898908918928938948958968978988999009019029039049059069079089099109119129139149159169179189199209219229239249259269279289299309319329339349359369379389399409419429439449459469479489499509519529539549559569579589599609619629639649659669679689699709719729739749759769779789799809819829839849859869879889899909919929939949959969979989991000100110021003100410051006100710081009101010111012101310141015101610171018101910201021102210231024102510261027102810291030103110321033103410351036103710381039104010411042104310441045104610471048104910501051105210531054105510561057105810591060106110621063106410651066106710681069107010711072107310741075107610771078107910801081108210831084108510861087108810891090109110921093109410951096109710981099110011011102110311041105110611071108110911101111111211131114111511161117111811191120112111221123112411251126112711281129113011311132113311341135113611371138113911401141114211431144114511461147114811491150115111521153115411551156115711581159116011611162116311641165116611671168116911701171117211731174117511761177117811791180118111821183118411851186118711881189119011911192119311941195119611971198119912001201120212031204120512061207120812091210121112121213121412151216121712181219122012211222122312241225122612271228122912301231123212331234123512361237123812391240124112421243124412451246124712481249125012511252125312541255125612571258125912601261126212631264126512661267126812691270127112721273127412751276127712781279128012811282128312841285128612871288128912901291129212931294129512961297129812991300130113021303130413051306130713081309131013111312131313141315131613171318131913201321132213231324132513261327132813291330133113321333133413351336133713381339134013411342134313441345134613471348134913501351135213531354135513561357135813591360136113621363136413651366136713681369137013711372137313741375137613771378137913801381138213831384138513861387138813891390139113921393139413951396139713981399140014011402140314041405140614071408140914101411141214131414141514161417141814191420142114221423142414251426142714281429143014311432143314341435143614371438143914401441144214431444144514461447144814491450145114521453145414551456145714581459146014611462146314641465146614671468146914701471147214731474147514761477147814791480148114821483148414851486148714881489149014911492149314941495149614971498149915001501150215031504150515061507150815091510151115121513151415151516151715181519152015211522152315241525152615271528152915301531153215331534153515361537153815391540154115421543154415451546154715481549155015511552155315541555155615571558155915601561156215631564156515661567156815691570157115721573157415751576157715781579158015811582158315841585158615871588158915901591159215931594159515961597159815991600160116021603160416051606160716081609161016111612161316141615161616171618161916201621162216231624162516261627162816291630163116321633163416351636163716381639164016411642164316441645164616471648164916501651165216531654165516561657165816591660166116621663166416651666166716681669167016711672167316741675167616771678167916801681168216831684168516861687168816891690169116921693169416951696169716981699170017011702170317041705170617071708170917101711171217131714171517161717171817191720172117221723172417251726172717281729173017311732173317341735173617371738173917401741174217431744174517461747174817491750175117521753175417551756175717581759176017611762176317641765176617671768176917701771177217731774177517761777177817791780178117821783178417851786178717881789179017911792179317941795179617971798179918001801180218031804180518061807180818091810181118121813181418151816181718181819182018211822182318241825182618271828182918301831183218331834183518361837183818391840184118421843184418451846184718481849185018511852185318541855185618571858185918601861186218631864186518661867186818691870187118721873187418751876187718781879188018811882188318841885188618871888188918901891189218931894189518961897189818991900190119021903190419051906190719081909191019111912191319141915191619171918191919201921192219231924192519261927192819291930193119321933193419351936193719381939194019411942194319441945194619471948194919501951195219531954195519561957195819591960196119621963196419651966196719681969197019711972197319741975197619771978197919801981198219831984198519861987198819891990199119921993199419951996199719981999200020012002200320042005200620072008200920102011201220132014201520162017201820192020202120222023202420252026202720282029203020312032203320342035203620372038203920402041204220432044204520462047204820492050205120522053205420552056205720582059206020612062206320642065206620672068206920702071207220732074207520762077207820792080208120822083208420852086208720882089209020912092209320942095209620972098209921002101210221032104210521062107210821092110211121122113211421152116211721182119212021212122212321242125212621272128212921302131213221332134213521362137213821392140214121422143214421452146214721482149215021512152215321542155215621572158215921602161216221632164216521662167216821692170217121722173217421752176217721782179218021812182218321842185218621872188218921902191219221932194219521962197219821992200220122022203220422052206220722082209221022112212221322142215221622172218221922202221222222232224222522262227222822292230223122322233223422352236223722382239224022412242224322442245224622472248224922502251225222532254225522562257225822592260226122622263226422652266226722682269227022712272227322742275227622772278227922802281228222832284228522862287228822892290229122922293229422952296229722982299230023012302230323042305230623072308230923102311231223132314231523162317231823192320232123222323232423252326232723282329233023312332233323342335233623372338233923402341234223432344234523462347234823492350235123522353235423552356235723582359236023612362236323642365236623672368236923702371237223732374237523762377237823792380238123822383238423852386238723882389239023912392239323942395239623972398239924002401240224032404240524062407240824092410241124122413241424152416241724182419242024212422242324242425242624272428242924302431243224332434243524362437243824392440244124422443244424452446244724482449245024512452245324542455245624572458245924602461246224632464246524662467246824692470247124722473247424752476247724782479248024812482248324842485248624872488248924902491249224932494249524962497249824992500250125022503250425052506250725082509251025112512251325142515251625172518251925202521252225232524252525262527252825292530253125322533253425352536253725382539254025412542254325442545254625472548254925502551255225532554255525562557255825592560256125622563256425652566256725682569257025712572257325742575257625772578257925802581258225832584258525862587258825892590259125922593259425952596259725982599260026012602260326042605260626072608260926102611261226132614261526162617261826192620262126222623262426252626262726282629263026312632263326342635263626372638263926402641264226432644264526462647264826492650265126522653265426552656265726582659266026612662266326642665266626672668266926702671267226732674267526762677267826792680268126822683268426852686268726882689269026912692269326942695269626972698269927002701270227032704270527062707270827092710271127122713271427152716271727182719272027212722272327242725272627272728272927302731273227332734273527362737273827392740274127422743274427452746274727482749275027512752275327542755275627572758275927602761276227632764276527662767276827692770277127722773277427752776277727782779278027812782278327842785278627872788278927902791279227932794279527962797279827992800280128022803280428052806280728082809281028112812281328142815281628172818281928202821282228232824282528262827282828292830283128322833283428352836283728382839284028412842284328442845284628472848284928502851285228532854285528562857285828592860286128622863286428652866286728682869287028712872287328742875287628772878287928802881288228832884288528862887288828892890289128922893289428952896289728982899290029012902290329042905290629072908290929102911291229132914291529162917291829192920292129222923292429252926292729282929293029312932293329342935293629372938293929402941294229432944294529462947294829492950295129522953295429552956295729582959296029612962296329642965296629672968296929702971297229732974297529762977297829792980298129822983298429852986298729882989299029912992299329942995299629972998299930003001300230033004300530063007300830093010301130123013301430153016301730183019302030213022302330243025302630273028302930303031303230333034303530363037303830393040304130423043304430453046304730483049305030513052305330543055305630573058305930603061306230633064306530663067306830693070307130723073307430753076307730783079308030813082308330843085308630873088308930903091309230933094309530963097309830993100310131023103310431053106310731083109311031113112311331143115311631173118311931203121312231233124312531263127312831293130313131323133313431353136313731383139314031413142314331443145314631473148314931503151315231533154315531563157315831593160316131623163316431653166316731683169317031713172317331743175317631773178317931803181318231833184318531863187318831893190319131923193319431953196319731983199320032013202320332043205320632073208320932103211321232133214321532163217321832193220322132223223322432253226322732283229323032313232323332343235323632373238323932403241324232433244324532463247324832493250325132523253325432553256325732583259326032613262326332643265326632673268326932703271327232733274327532763277327832793280328132823283328432853286328732883289329032913292329332943295329632973298329933003301330233033304330533063307330833093310331133123313331433153316331733183319332033213322332333243325332633273328332933303331333233333334333533363337333833393340334133423343334433453346334733483349335033513352335333543355335633573358335933603361336233633364336533663367336833693370337133723373337433753376337733783379338033813382338333843385338633873388338933903391339233933394339533963397339833993400340134023403340434053406340734083409341034113412341334143415341634173418341934203421342234233424342534263427342834293430343134323433343434353436343734383439344034413442344334443445344634473448344934503451345234533454345534563457345834593460346134623463346434653466346734683469347034713472347334743475347634773478347934803481348234833484348534863487348834893490349134923493349434953496349734983499350035013502350335043505350635073508350935103511351235133514351535163517351835193520352135223523352435253526352735283529353035313532353335343535353635373538353935403541354235433544354535463547354835493550355135523553355435553556355735583559356035613562356335643565356635673568356935703571357235733574357535763577357835793580358135823583358435853586358735883589359035913592359335943595359635973598359936003601360236033604360536063607360836093610361136123613361436153616361736183619362036213622362336243625362636273628362936303631363236333634363536363637363836393640364136423643364436453646364736483649365036513652365336543655365636573658365936603661366236633664366536663667366836693670367136723673367436753676367736783679368036813682368336843685368636873688368936903691369236933694369536963697369836993700370137023703370437053706370737083709371037113712371337143715371637173718371937203721372237233724372537263727372837293730373137323733373437353736373737383739374037413742374337443745374637473748374937503751375237533754375537563757375837593760376137623763376437653766376737683769377037713772377337743775377637773778377937803781378237833784378537863787378837893790379137923793379437953796379737983799380038013802380338043805380638073808380938103811381238133814381538163817381838193820382138223823382438253826382738283829383038313832383338343835383638373838383938403841384238433844384538463847384838493850385138523853385438553856385738583859386038613862386338643865386638673868386938703871387238733874387538763877387838793880388138823883388438853886388738883889389038913892389338943895389638973898389939003901390239033904390539063907390839093910391139123913391439153916391739183919392039213922392339243925392639273928392939303931393239333934393539363937393839393940394139423943394439453946394739483949395039513952395339543955395639573958395939603961396239633964396539663967396839693970397139723973397439753976397739783979398039813982398339843985398639873988398939903991399239933994399539963997399839994000400140024003400440054006400740084009401040114012401340144015401640174018401940204021402240234024402540264027402840294030403140324033403440354036403740384039404040414042404340444045404640474048404940504051405240534054405540564057405840594060406140624063406440654066406740684069407040714072407340744075407640774078407940804081408240834084408540864087408840894090409140924093409440954096409740984099410041014102410341044105410641074108410941104111411241134114411541164117411841194120412141224123412441254126412741284129413041314132413341344135413641374138413941404141414241434144414541464147414841494150415141524153415441554156415741584159416041614162416341644165416641674168416941704171417241734174417541764177417841794180418141824183418441854186418741884189419041914192419341944195419641974198419942004201420242034204420542064207420842094210421142124213421442154216421742184219422042214222422342244225422642274228422942304231423242334234423542364237423842394240424142424243424442454246424742484249425042514252425342544255425642574258425942604261426242634264426542664267426842694270427142724273427442754276427742784279428042814282428342844285428642874288428942904291429242934294429542964297429842994300430143024303430443054306430743084309431043114312431343144315431643174318431943204321432243234324432543264327432843294330433143324333433443354336433743384339434043414342434343444345434643474348434943504351435243534354435543564357435843594360436143624363436443654366436743684369437043714372437343744375437643774378437943804381438243834384438543864387438843894390439143924393439443954396439743984399440044014402440344044405440644074408440944104411441244134414441544164417441844194420442144224423442444254426442744284429443044314432443344344435443644374438443944404441444244434444444544464447444844494450445144524453445444554456445744584459446044614462446344644465446644674468446944704471447244734474447544764477447844794480448144824483448444854486448744884489449044914492449344944495449644974498449945004501450245034504450545064507450845094510451145124513451445154516451745184519452045214522452345244525452645274528452945304531453245334534453545364537453845394540454145424543454445454546454745484549455045514552455345544555455645574558455945604561456245634564456545664567456845694570457145724573457445754576457745784579458045814582458345844585458645874588458945904591459245934594459545964597459845994600460146024603460446054606460746084609461046114612461346144615461646174618461946204621462246234624462546264627462846294630463146324633463446354636463746384639464046414642464346444645464646474648464946504651465246534654465546564657465846594660466146624663466446654666466746684669467046714672467346744675467646774678467946804681468246834684468546864687468846894690469146924693469446954696469746984699470047014702470347044705470647074708470947104711471247134714471547164717471847194720472147224723472447254726472747284729473047314732473347344735473647374738473947404741474247434744474547464747474847494750475147524753475447554756475747584759476047614762476347644765476647674768476947704771477247734774477547764777477847794780478147824783478447854786478747884789479047914792479347944795479647974798479948004801480248034804480548064807480848094810481148124813481448154816481748184819482048214822482348244825482648274828482948304831483248334834483548364837483848394840484148424843484448454846484748484849485048514852485348544855485648574858485948604861486248634864486548664867486848694870487148724873487448754876487748784879488048814882488348844885488648874888488948904891489248934894489548964897489848994900490149024903490449054906490749084909491049114912491349144915491649174918491949204921492249234924492549264927492849294930493149324933493449354936493749384939494049414942494349444945494649474948494949504951495249534954495549564957495849594960496149624963496449654966496749684969497049714972497349744975497649774978497949804981498249834984498549864987498849894990499149924993499449954996499749984999500050015002500350045005500650075008500950105011501250135014501550165017501850195020502150225023502450255026502750285029503050315032503350345035503650375038503950405041504250435044504550465047504850495050505150525053505450555056505750585059506050615062506350645065506650675068506950705071507250735074507550765077507850795080508150825083508450855086508750885089509050915092509350945095509650975098509951005101510251035104510551065107510851095110511151125113511451155116511751185119512051215122512351245125512651275128512951305131513251335134513551365137513851395140514151425143514451455146514751485149515051515152515351545155515651575158515951605161516251635164516551665167516851695170517151725173517451755176517751785179518051815182518351845185518651875188518951905191519251935194519551965197519851995200520152025203520452055206520752085209521052115212521352145215521652175218521952205221522252235224522552265227522852295230523152325233523452355236523752385239524052415242524352445245524652475248524952505251525252535254525552565257525852595260526152625263526452655266526752685269527052715272527352745275527652775278527952805281528252835284528552865287528852895290529152925293529452955296529752985299530053015302530353045305530653075308530953105311531253135314531553165317531853195320532153225323532453255326532753285329533053315332533353345335533653375338533953405341534253435344534553465347534853495350535153525353535453555356535753585359536053615362536353645365536653675368536953705371537253735374537553765377537853795380538153825383538453855386538753885389539053915392539353945395539653975398539954005401540254035404540554065407540854095410541154125413541454155416541754185419542054215422542354245425542654275428542954305431543254335434543554365437543854395440544154425443544454455446544754485449545054515452545354545455545654575458545954605461546254635464546554665467546854695470547154725473547454755476547754785479548054815482548354845485548654875488548954905491549254935494549554965497549854995500550155025503550455055506550755085509551055115512551355145515551655175518551955205521552255235524552555265527552855295530553155325533553455355536553755385539554055415542554355445545554655475548554955505551555255535554555555565557555855595560556155625563556455655566556755685569557055715572557355745575557655775578557955805581558255835584558555865587558855895590559155925593559455955596559755985599560056015602560356045605560656075608560956105611561256135614561556165617561856195620562156225623562456255626562756285629563056315632563356345635563656375638563956405641564256435644564556465647564856495650565156525653565456555656565756585659566056615662566356645665566656675668566956705671567256735674567556765677567856795680568156825683568456855686568756885689569056915692569356945695569656975698569957005701570257035704570557065707570857095710571157125713571457155716571757185719572057215722572357245725572657275728572957305731573257335734573557365737573857395740574157425743574457455746574757485749575057515752575357545755575657575758575957605761576257635764576557665767576857695770577157725773577457755776577757785779578057815782578357845785578657875788578957905791579257935794579557965797579857995800580158025803580458055806580758085809581058115812581358145815581658175818581958205821582258235824582558265827582858295830583158325833583458355836583758385839584058415842584358445845584658475848584958505851585258535854585558565857585858595860586158625863586458655866586758685869587058715872587358745875587658775878587958805881588258835884588558865887588858895890589158925893589458955896589758985899590059015902590359045905590659075908590959105911591259135914591559165917591859195920592159225923592459255926592759285929593059315932593359345935593659375938593959405941594259435944594559465947594859495950595159525953595459555956595759585959596059615962596359645965596659675968596959705971597259735974597559765977597859795980598159825983598459855986598759885989599059915992599359945995599659975998599960006001600260036004600560066007600860096010601160126013601460156016601760186019602060216022602360246025602660276028602960306031603260336034603560366037603860396040604160426043604460456046604760486049605060516052605360546055605660576058605960606061606260636064606560666067606860696070607160726073607460756076607760786079608060816082608360846085608660876088608960906091609260936094609560966097609860996100610161026103610461056106610761086109611061116112611361146115611661176118611961206121612261236124612561266127612861296130613161326133613461356136613761386139614061416142614361446145614661476148614961506151615261536154615561566157615861596160616161626163616461656166616761686169617061716172617361746175617661776178617961806181618261836184618561866187618861896190619161926193619461956196619761986199620062016202620362046205620662076208620962106211621262136214621562166217621862196220622162226223622462256226622762286229623062316232623362346235623662376238623962406241624262436244624562466247624862496250625162526253625462556256625762586259626062616262626362646265626662676268626962706271627262736274627562766277627862796280628162826283628462856286628762886289629062916292629362946295629662976298629963006301630263036304630563066307630863096310631163126313631463156316631763186319632063216322632363246325632663276328632963306331633263336334633563366337633863396340634163426343634463456346634763486349635063516352635363546355635663576358635963606361636263636364636563666367636863696370637163726373637463756376637763786379638063816382638363846385638663876388638963906391639263936394639563966397639863996400640164026403640464056406640764086409641064116412641364146415641664176418641964206421642264236424642564266427642864296430643164326433643464356436643764386439644064416442644364446445644664476448644964506451645264536454645564566457645864596460646164626463646464656466646764686469647064716472647364746475647664776478647964806481648264836484648564866487648864896490649164926493649464956496649764986499650065016502650365046505650665076508650965106511651265136514651565166517651865196520652165226523652465256526652765286529653065316532653365346535653665376538653965406541654265436544654565466547654865496550655165526553655465556556655765586559656065616562656365646565656665676568656965706571657265736574657565766577657865796580658165826583658465856586658765886589659065916592659365946595659665976598659966006601660266036604660566066607660866096610661166126613661466156616661766186619662066216622662366246625662666276628662966306631663266336634663566366637663866396640664166426643664466456646664766486649665066516652665366546655665666576658665966606661666266636664666566666667666866696670667166726673667466756676667766786679668066816682668366846685668666876688668966906691669266936694669566966697669866996700670167026703670467056706670767086709671067116712671367146715671667176718671967206721672267236724672567266727672867296730673167326733673467356736673767386739674067416742674367446745674667476748674967506751675267536754675567566757675867596760676167626763676467656766676767686769677067716772677367746775677667776778677967806781678267836784678567866787678867896790679167926793679467956796679767986799680068016802680368046805680668076808680968106811681268136814681568166817681868196820682168226823682468256826682768286829683068316832683368346835683668376838683968406841684268436844684568466847684868496850685168526853685468556856685768586859686068616862686368646865686668676868686968706871687268736874687568766877687868796880688168826883688468856886688768886889689068916892689368946895689668976898689969006901690269036904690569066907690869096910691169126913691469156916691769186919692069216922692369246925692669276928692969306931693269336934693569366937693869396940694169426943694469456946694769486949695069516952695369546955695669576958695969606961696269636964696569666967696869696970697169726973697469756976697769786979698069816982698369846985698669876988698969906991699269936994699569966997699869997000700170027003700470057006700770087009701070117012701370147015701670177018701970207021702270237024702570267027702870297030703170327033703470357036703770387039704070417042704370447045704670477048704970507051705270537054705570567057705870597060706170627063706470657066706770687069707070717072707370747075707670777078707970807081708270837084708570867087708870897090709170927093709470957096709770987099710071017102710371047105710671077108710971107111711271137114711571167117711871197120712171227123712471257126712771287129713071317132713371347135713671377138713971407141714271437144714571467147714871497150715171527153715471557156715771587159716071617162716371647165716671677168716971707171717271737174717571767177717871797180718171827183718471857186718771887189719071917192719371947195719671977198719972007201720272037204720572067207720872097210721172127213721472157216721772187219722072217222722372247225722672277228722972307231723272337234723572367237723872397240724172427243724472457246724772487249725072517252725372547255725672577258725972607261726272637264726572667267726872697270727172727273727472757276727772787279728072817282728372847285728672877288728972907291729272937294729572967297729872997300730173027303730473057306730773087309731073117312731373147315731673177318731973207321732273237324732573267327732873297330733173327333733473357336733773387339734073417342734373447345734673477348734973507351735273537354735573567357735873597360736173627363736473657366736773687369737073717372737373747375737673777378737973807381738273837384738573867387738873897390739173927393739473957396739773987399740074017402740374047405740674077408740974107411741274137414741574167417741874197420742174227423742474257426742774287429743074317432743374347435743674377438743974407441744274437444744574467447744874497450745174527453745474557456745774587459746074617462746374647465746674677468746974707471747274737474747574767477747874797480748174827483748474857486748774887489749074917492749374947495749674977498749975007501750275037504750575067507750875097510751175127513751475157516751775187519752075217522752375247525752675277528752975307531753275337534753575367537753875397540754175427543754475457546754775487549755075517552755375547555755675577558755975607561756275637564756575667567756875697570757175727573757475757576757775787579758075817582758375847585758675877588758975907591759275937594759575967597759875997600760176027603760476057606760776087609761076117612761376147615761676177618761976207621762276237624762576267627762876297630763176327633763476357636763776387639764076417642764376447645764676477648764976507651765276537654765576567657765876597660766176627663766476657666766776687669767076717672767376747675767676777678767976807681768276837684768576867687768876897690769176927693769476957696769776987699770077017702770377047705770677077708770977107711771277137714771577167717771877197720772177227723772477257726772777287729773077317732773377347735773677377738773977407741774277437744774577467747774877497750775177527753775477557756775777587759776077617762776377647765776677677768776977707771777277737774777577767777777877797780778177827783778477857786778777887789779077917792779377947795779677977798779978007801780278037804780578067807780878097810781178127813781478157816781778187819782078217822782378247825782678277828782978307831783278337834783578367837783878397840784178427843784478457846784778487849785078517852785378547855785678577858785978607861786278637864786578667867786878697870787178727873787478757876787778787879788078817882788378847885788678877888788978907891789278937894789578967897789878997900790179027903790479057906790779087909791079117912791379147915791679177918791979207921792279237924792579267927792879297930793179327933793479357936793779387939794079417942794379447945794679477948794979507951795279537954795579567957795879597960796179627963796479657966796779687969797079717972797379747975797679777978797979807981798279837984798579867987798879897990799179927993799479957996799779987999800080018002800380048005800680078008800980108011801280138014801580168017801880198020802180228023802480258026802780288029803080318032803380348035803680378038803980408041804280438044804580468047804880498050805180528053805480558056805780588059806080618062806380648065806680678068806980708071807280738074807580768077807880798080808180828083808480858086808780888089809080918092809380948095809680978098809981008101810281038104810581068107810881098110811181128113811481158116811781188119812081218122812381248125812681278128812981308131813281338134813581368137813881398140814181428143814481458146814781488149815081518152815381548155815681578158815981608161816281638164816581668167816881698170817181728173817481758176817781788179818081818182818381848185818681878188818981908191819281938194819581968197819881998200820182028203820482058206820782088209821082118212821382148215821682178218821982208221822282238224822582268227822882298230823182328233823482358236823782388239824082418242824382448245824682478248824982508251825282538254825582568257825882598260826182628263826482658266826782688269827082718272827382748275827682778278827982808281828282838284828582868287828882898290829182928293829482958296829782988299830083018302830383048305830683078308830983108311831283138314831583168317831883198320832183228323832483258326832783288329833083318332833383348335833683378338833983408341834283438344834583468347834883498350835183528353835483558356835783588359836083618362836383648365836683678368836983708371837283738374837583768377837883798380838183828383838483858386838783888389839083918392839383948395839683978398839984008401840284038404840584068407840884098410841184128413841484158416841784188419842084218422842384248425842684278428842984308431843284338434843584368437843884398440844184428443844484458446844784488449845084518452845384548455845684578458845984608461846284638464846584668467846884698470847184728473847484758476847784788479848084818482848384848485848684878488848984908491849284938494849584968497849884998500850185028503850485058506850785088509851085118512851385148515851685178518851985208521852285238524852585268527852885298530853185328533853485358536853785388539854085418542854385448545854685478548854985508551855285538554855585568557855885598560856185628563856485658566856785688569857085718572857385748575857685778578857985808581858285838584858585868587858885898590859185928593859485958596859785988599860086018602860386048605860686078608860986108611861286138614861586168617861886198620862186228623862486258626862786288629863086318632863386348635863686378638863986408641864286438644864586468647864886498650865186528653865486558656865786588659866086618662866386648665866686678668866986708671867286738674867586768677867886798680868186828683868486858686868786888689869086918692869386948695869686978698869987008701870287038704870587068707870887098710871187128713871487158716871787188719872087218722872387248725872687278728872987308731873287338734873587368737873887398740874187428743874487458746874787488749875087518752875387548755875687578758875987608761876287638764876587668767876887698770877187728773877487758776877787788779878087818782878387848785878687878788878987908791879287938794879587968797879887998800880188028803880488058806880788088809881088118812881388148815881688178818881988208821882288238824882588268827882888298830883188328833883488358836883788388839884088418842884388448845884688478848884988508851885288538854885588568857885888598860886188628863886488658866886788688869887088718872887388748875887688778878887988808881888288838884888588868887888888898890889188928893889488958896889788988899890089018902890389048905890689078908890989108911891289138914891589168917891889198920892189228923892489258926892789288929893089318932893389348935893689378938893989408941894289438944894589468947894889498950895189528953895489558956895789588959896089618962896389648965896689678968896989708971897289738974897589768977897889798980898189828983898489858986898789888989899089918992899389948995899689978998899990009001900290039004900590069007900890099010901190129013901490159016901790189019902090219022902390249025902690279028902990309031903290339034903590369037903890399040904190429043904490459046904790489049905090519052905390549055905690579058905990609061906290639064906590669067906890699070907190729073907490759076907790789079908090819082908390849085908690879088908990909091909290939094909590969097909890999100910191029103910491059106910791089109911091119112911391149115911691179118911991209121912291239124912591269127912891299130913191329133913491359136913791389139914091419142914391449145914691479148914991509151915291539154915591569157915891599160916191629163916491659166916791689169917091719172917391749175917691779178917991809181918291839184918591869187918891899190919191929193919491959196919791989199920092019202920392049205920692079208920992109211921292139214921592169217921892199220922192229223922492259226922792289229923092319232923392349235923692379238923992409241924292439244924592469247924892499250925192529253925492559256925792589259926092619262926392649265926692679268926992709271927292739274927592769277927892799280928192829283928492859286928792889289929092919292929392949295929692979298929993009301930293039304930593069307930893099310931193129313931493159316931793189319932093219322932393249325932693279328932993309331933293339334933593369337933893399340934193429343934493459346934793489349935093519352935393549355935693579358935993609361936293639364936593669367936893699370937193729373937493759376937793789379938093819382938393849385938693879388938993909391939293939394939593969397939893999400940194029403940494059406940794089409941094119412941394149415941694179418941994209421942294239424942594269427942894299430943194329433943494359436943794389439944094419442944394449445944694479448944994509451945294539454945594569457945894599460946194629463946494659466946794689469947094719472947394749475947694779478947994809481948294839484948594869487948894899490949194929493949494959496949794989499950095019502950395049505950695079508950995109511951295139514951595169517951895199520952195229523952495259526952795289529953095319532953395349535953695379538953995409541954295439544954595469547954895499550955195529553955495559556955795589559956095619562956395649565956695679568956995709571957295739574957595769577957895799580958195829583958495859586958795889589959095919592959395949595959695979598959996009601960296039604960596069607960896099610961196129613961496159616961796189619962096219622962396249625962696279628962996309631963296339634963596369637963896399640964196429643964496459646964796489649965096519652965396549655965696579658965996609661966296639664966596669667966896699670967196729673967496759676967796789679968096819682968396849685968696879688968996909691969296939694969596969697969896999700970197029703970497059706970797089709971097119712971397149715971697179718971997209721972297239724972597269727972897299730973197329733973497359736973797389739974097419742974397449745974697479748974997509751975297539754975597569757975897599760976197629763976497659766976797689769977097719772977397749775977697779778977997809781978297839784978597869787978897899790979197929793979497959796979797989799980098019802980398049805980698079808980998109811981298139814981598169817981898199820982198229823982498259826982798289829983098319832983398349835983698379838983998409841984298439844984598469847984898499850985198529853985498559856985798589859986098619862986398649865986698679868986998709871987298739874987598769877987898799880988198829883988498859886988798889889989098919892989398949895989698979898989999009901990299039904990599069907990899099910991199129913991499159916991799189919992099219922992399249925992699279928992999309931993299339934993599369937993899399940994199429943994499459946994799489949995099519952995399549955995699579958995999609961996299639964996599669967996899699970997199729973997499759976997799789979998099819982998399849985998699879988998999909991999299939994999599969997999899991000010001100021000310004100051000610007100081000910010100111001210013100141001510016100171001810019100201002110022100231002410025100261002710028100291003010031100321003310034100351003610037100381003910040100411004210043100441004510046100471004810049100501005110052100531005410055100561005710058100591006010061100621006310064100651006610067100681006910070100711007210073100741007510076100771007810079100801008110082100831008410085100861008710088100891009010091100921009310094100951009610097100981009910100101011010210103101041010510106101071010810109101101011110112101131011410115101161011710118101191012010121101221012310124101251012610127101281012910130101311013210133101341013510136101371013810139101401014110142101431014410145101461014710148101491015010151101521015310154101551015610157101581015910160101611016210163101641016510166101671016810169101701017110172101731017410175101761017710178101791018010181101821018310184101851018610187101881018910190101911019210193101941019510196101971019810199102001020110202102031020410205102061020710208102091021010211102121021310214102151021610217102181021910220102211022210223102241022510226102271022810229102301023110232102331023410235102361023710238102391024010241102421024310244102451024610247102481024910250102511025210253102541025510256102571025810259102601026110262102631026410265102661026710268102691027010271102721027310274102751027610277102781027910280102811028210283102841028510286102871028810289102901029110292102931029410295102961029710298102991030010301103021030310304103051030610307103081030910310103111031210313103141031510316103171031810319103201032110322103231032410325103261032710328103291033010331103321033310334103351033610337103381033910340103411034210343103441034510346103471034810349103501035110352103531035410355103561035710358103591036010361103621036310364103651036610367103681036910370103711037210373103741037510376103771037810379103801038110382103831038410385103861038710388103891039010391103921039310394103951039610397103981039910400104011040210403104041040510406104071040810409104101041110412104131041410415104161041710418104191042010421104221042310424104251042610427104281042910430104311043210433104341043510436104371043810439104401044110442104431044410445104461044710448104491045010451104521045310454104551045610457104581045910460104611046210463104641046510466104671046810469104701047110472104731047410475104761047710478104791048010481104821048310484104851048610487104881048910490104911049210493104941049510496104971049810499105001050110502105031050410505105061050710508105091051010511105121051310514105151051610517105181051910520105211052210523105241052510526105271052810529105301053110532105331053410535105361053710538105391054010541105421054310544105451054610547105481054910550105511055210553105541055510556105571055810559105601056110562105631056410565105661056710568105691057010571105721057310574105751057610577105781057910580105811058210583105841058510586105871058810589105901059110592105931059410595105961059710598105991060010601106021060310604106051060610607106081060910610106111061210613106141061510616106171061810619106201062110622106231062410625106261062710628106291063010631106321063310634106351063610637106381063910640106411064210643106441064510646106471064810649106501065110652106531065410655106561065710658106591066010661106621066310664106651066610667106681066910670106711067210673106741067510676106771067810679106801068110682106831068410685106861068710688106891069010691106921069310694106951069610697106981069910700107011070210703107041070510706107071070810709107101071110712107131071410715107161071710718107191072010721107221072310724107251072610727107281072910730107311073210733107341073510736107371073810739107401074110742107431074410745107461074710748107491075010751107521075310754107551075610757107581075910760107611076210763107641076510766107671076810769107701077110772107731077410775107761077710778107791078010781107821078310784107851078610787107881078910790107911079210793107941079510796107971079810799108001080110802108031080410805108061080710808108091081010811108121081310814108151081610817108181081910820108211082210823108241082510826108271082810829108301083110832108331083410835108361083710838108391084010841108421084310844108451084610847108481084910850108511085210853108541085510856108571085810859108601086110862108631086410865108661086710868108691087010871108721087310874108751087610877108781087910880108811088210883108841088510886108871088810889108901089110892108931089410895108961089710898108991090010901109021090310904109051090610907109081090910910109111091210913109141091510916109171091810919109201092110922109231092410925109261092710928109291093010931109321093310934109351093610937109381093910940109411094210943109441094510946109471094810949109501095110952109531095410955109561095710958109591096010961109621096310964109651096610967109681096910970109711097210973109741097510976109771097810979109801098110982109831098410985109861098710988109891099010991109921099310994109951099610997109981099911000110011100211003110041100511006110071100811009110101101111012110131101411015110161101711018110191102011021110221102311024110251102611027110281102911030110311103211033110341103511036110371103811039110401104111042110431104411045110461104711048110491105011051110521105311054110551105611057110581105911060110611106211063110641106511066110671106811069110701107111072110731107411075110761107711078110791108011081110821108311084110851108611087110881108911090110911109211093110941109511096110971109811099111001110111102111031110411105111061110711108111091111011111111121111311114111151111611117111181111911120111211112211123111241112511126111271112811129111301113111132111331113411135111361113711138111391114011141111421114311144111451114611147111481114911150111511115211153111541115511156111571115811159111601116111162111631116411165111661116711168111691117011171111721117311174111751117611177111781117911180111811118211183111841118511186111871118811189111901119111192111931119411195111961119711198111991120011201112021120311204112051120611207112081120911210112111121211213112141121511216112171121811219112201122111222112231122411225112261122711228112291123011231112321123311234112351123611237112381123911240112411124211243112441124511246112471124811249112501125111252112531125411255112561125711258112591126011261112621126311264112651126611267112681126911270112711127211273112741127511276112771127811279112801128111282112831128411285112861128711288112891129011291112921129311294112951129611297112981129911300113011130211303113041130511306113071130811309113101131111312113131131411315113161131711318113191132011321113221132311324113251132611327113281132911330113311133211333113341133511336113371133811339113401134111342113431134411345113461134711348113491135011351113521135311354113551135611357113581135911360113611136211363113641136511366113671136811369113701137111372113731137411375113761137711378113791138011381113821138311384113851138611387113881138911390113911139211393113941139511396113971139811399114001140111402114031140411405114061140711408114091141011411114121141311414114151141611417114181141911420114211142211423114241142511426114271142811429114301143111432114331143411435114361143711438114391144011441114421144311444114451144611447114481144911450114511145211453114541145511456114571145811459114601146111462114631146411465114661146711468114691147011471114721147311474114751147611477114781147911480114811148211483114841148511486114871148811489114901149111492114931149411495114961149711498114991150011501115021150311504115051150611507115081150911510115111151211513115141151511516115171151811519115201152111522115231152411525115261152711528115291153011531115321153311534115351153611537115381153911540115411154211543115441154511546115471154811549115501155111552115531155411555115561155711558115591156011561115621156311564115651156611567115681156911570115711157211573115741157511576115771157811579115801158111582115831158411585115861158711588115891159011591115921159311594115951159611597115981159911600116011160211603116041160511606116071160811609116101161111612116131161411615116161161711618116191162011621116221162311624116251162611627116281162911630116311163211633116341163511636116371163811639116401164111642116431164411645116461164711648116491165011651116521165311654116551165611657116581165911660116611166211663116641166511666116671166811669116701167111672116731167411675116761167711678116791168011681116821168311684116851168611687116881168911690116911169211693116941169511696116971169811699117001170111702117031170411705117061170711708117091171011711117121171311714117151171611717117181171911720117211172211723117241172511726117271172811729117301173111732117331173411735117361173711738117391174011741117421174311744117451174611747117481174911750117511175211753117541175511756117571175811759117601176111762117631176411765117661176711768117691177011771117721177311774117751177611777117781177911780117811178211783117841178511786117871178811789117901179111792117931179411795117961179711798117991180011801118021180311804118051180611807118081180911810118111181211813118141181511816118171181811819118201182111822118231182411825118261182711828118291183011831118321183311834118351183611837118381183911840118411184211843118441184511846118471184811849118501185111852118531185411855118561185711858118591186011861118621186311864118651186611867118681186911870118711187211873118741187511876118771187811879118801188111882118831188411885118861188711888118891189011891118921189311894118951189611897118981189911900119011190211903119041190511906119071190811909119101191111912119131191411915119161191711918119191192011921119221192311924119251192611927119281192911930119311193211933119341193511936119371193811939119401194111942119431194411945119461194711948119491195011951119521195311954119551195611957119581195911960119611196211963119641196511966119671196811969119701197111972119731197411975119761197711978119791198011981119821198311984119851198611987119881198911990119911199211993119941199511996119971199811999120001200112002120031200412005120061200712008120091201012011120121201312014120151201612017120181201912020120211202212023120241202512026120271202812029120301203112032120331203412035120361203712038120391204012041120421204312044120451204612047120481204912050120511205212053120541205512056120571205812059120601206112062120631206412065120661206712068120691207012071120721207312074120751207612077120781207912080120811208212083120841208512086120871208812089120901209112092120931209412095120961209712098120991210012101121021210312104121051210612107121081210912110121111211212113121141211512116121171211812119121201212112122121231212412125121261212712128121291213012131121321213312134121351213612137121381213912140121411214212143121441214512146121471214812149121501215112152121531215412155121561215712158121591216012161121621216312164121651216612167121681216912170121711217212173121741217512176121771217812179121801218112182121831218412185121861218712188121891219012191121921219312194121951219612197121981219912200122011220212203122041220512206122071220812209122101221112212122131221412215122161221712218122191222012221122221222312224122251222612227122281222912230122311223212233122341223512236122371223812239122401224112242122431224412245122461224712248122491225012251122521225312254122551225612257122581225912260122611226212263122641226512266122671226812269122701227112272122731227412275122761227712278122791228012281122821228312284122851228612287122881228912290122911229212293122941229512296122971229812299123001230112302123031230412305123061230712308123091231012311123121231312314123151231612317123181231912320123211232212323123241232512326123271232812329123301233112332123331233412335123361233712338123391234012341123421234312344123451234612347123481234912350123511235212353123541235512356123571235812359123601236112362123631236412365123661236712368123691237012371123721237312374123751237612377123781237912380123811238212383123841238512386123871238812389123901239112392123931239412395123961239712398123991240012401124021240312404124051240612407124081240912410124111241212413124141241512416124171241812419124201242112422124231242412425124261242712428124291243012431124321243312434124351243612437124381243912440124411244212443124441244512446124471244812449124501245112452124531245412455124561245712458124591246012461124621246312464124651246612467124681246912470124711247212473124741247512476124771247812479124801248112482124831248412485124861248712488124891249012491124921249312494124951249612497124981249912500125011250212503125041250512506125071250812509125101251112512125131251412515125161251712518125191252012521125221252312524125251252612527125281252912530125311253212533125341253512536125371253812539125401254112542125431254412545125461254712548125491255012551125521255312554125551255612557125581255912560125611256212563125641256512566125671256812569125701257112572125731257412575125761257712578125791258012581125821258312584125851258612587125881258912590125911259212593125941259512596125971259812599126001260112602126031260412605126061260712608126091261012611126121261312614126151261612617126181261912620126211262212623126241262512626126271262812629126301263112632126331263412635126361263712638126391264012641126421264312644126451264612647126481264912650126511265212653126541265512656126571265812659126601266112662126631266412665126661266712668126691267012671126721267312674126751267612677126781267912680126811268212683126841268512686126871268812689126901269112692126931269412695126961269712698126991270012701127021270312704127051270612707127081270912710127111271212713127141271512716127171271812719127201272112722127231272412725127261272712728127291273012731127321273312734127351273612737127381273912740127411274212743127441274512746127471274812749127501275112752127531275412755127561275712758127591276012761127621276312764127651276612767127681276912770127711277212773127741277512776127771277812779127801278112782127831278412785127861278712788127891279012791127921279312794127951279612797127981279912800128011280212803128041280512806128071280812809128101281112812128131281412815128161281712818128191282012821128221282312824128251282612827128281282912830128311283212833128341283512836128371283812839128401284112842128431284412845128461284712848128491285012851128521285312854128551285612857128581285912860128611286212863128641286512866128671286812869128701287112872128731287412875128761287712878128791288012881128821288312884128851288612887128881288912890128911289212893128941289512896128971289812899129001290112902129031290412905129061290712908129091291012911129121291312914129151291612917129181291912920129211292212923129241292512926129271292812929129301293112932129331293412935129361293712938129391294012941129421294312944129451294612947129481294912950129511295212953129541295512956129571295812959129601296112962129631296412965129661296712968129691297012971129721297312974129751297612977129781297912980129811298212983129841298512986129871298812989129901299112992129931299412995129961299712998129991300013001130021300313004130051300613007130081300913010130111301213013130141301513016130171301813019130201302113022130231302413025130261302713028130291303013031130321303313034130351303613037130381303913040130411304213043130441304513046130471304813049130501305113052130531305413055130561305713058130591306013061130621306313064130651306613067130681306913070130711307213073130741307513076130771307813079130801308113082130831308413085130861308713088130891309013091130921309313094130951309613097130981309913100131011310213103131041310513106131071310813109131101311113112131131311413115131161311713118131191312013121131221312313124131251312613127131281312913130131311313213133131341313513136131371313813139131401314113142131431314413145131461314713148131491315013151131521315313154131551315613157131581315913160131611316213163131641316513166131671316813169131701317113172131731317413175131761317713178131791318013181131821318313184131851318613187131881318913190131911319213193131941319513196131971319813199132001320113202132031320413205132061320713208132091321013211132121321313214132151321613217132181321913220132211322213223132241322513226132271322813229132301323113232132331323413235132361323713238132391324013241132421324313244132451324613247132481324913250132511325213253132541325513256132571325813259132601326113262132631326413265132661326713268132691327013271132721327313274132751327613277132781327913280132811328213283132841328513286132871328813289132901329113292132931329413295132961329713298132991330013301133021330313304133051330613307133081330913310133111331213313133141331513316133171331813319133201332113322133231332413325133261332713328133291333013331133321333313334133351333613337133381333913340133411334213343133441334513346133471334813349133501335113352133531335413355133561335713358133591336013361133621336313364133651336613367133681336913370133711337213373133741337513376133771337813379133801338113382133831338413385133861338713388133891339013391133921339313394133951339613397133981339913400134011340213403134041340513406134071340813409134101341113412134131341413415134161341713418134191342013421134221342313424134251342613427134281342913430134311343213433134341343513436134371343813439134401344113442134431344413445134461344713448134491345013451134521345313454134551345613457134581345913460134611346213463134641346513466134671346813469134701347113472134731347413475134761347713478134791348013481134821348313484134851348613487134881348913490134911349213493134941349513496134971349813499135001350113502135031350413505135061350713508135091351013511135121351313514135151351613517135181351913520135211352213523135241352513526135271352813529135301353113532135331353413535135361353713538135391354013541135421354313544135451354613547135481354913550135511355213553135541355513556135571355813559135601356113562135631356413565135661356713568135691357013571135721357313574135751357613577135781357913580135811358213583135841358513586135871358813589135901359113592135931359413595135961359713598135991360013601136021360313604136051360613607136081360913610136111361213613136141361513616136171361813619136201362113622136231362413625136261362713628136291363013631136321363313634136351363613637136381363913640136411364213643136441364513646136471364813649136501365113652136531365413655136561365713658136591366013661136621366313664136651366613667136681366913670136711367213673136741367513676136771367813679136801368113682136831368413685136861368713688136891369013691136921369313694136951369613697136981369913700137011370213703137041370513706137071370813709137101371113712137131371413715137161371713718137191372013721137221372313724137251372613727137281372913730137311373213733137341373513736137371373813739137401374113742137431374413745137461374713748137491375013751137521375313754137551375613757137581375913760137611376213763137641376513766137671376813769137701377113772137731377413775137761377713778137791378013781137821378313784137851378613787137881378913790137911379213793137941379513796137971379813799138001380113802138031380413805138061380713808138091381013811138121381313814138151381613817138181381913820138211382213823138241382513826138271382813829138301383113832138331383413835138361383713838138391384013841138421384313844138451384613847138481384913850138511385213853138541385513856138571385813859138601386113862138631386413865138661386713868138691387013871138721387313874138751387613877138781387913880138811388213883138841388513886138871388813889138901389113892138931389413895138961389713898138991390013901139021390313904139051390613907139081390913910139111391213913139141391513916139171391813919139201392113922139231392413925139261392713928139291393013931139321393313934139351393613937139381393913940139411394213943139441394513946139471394813949139501395113952139531395413955139561395713958139591396013961139621396313964139651396613967139681396913970139711397213973139741397513976139771397813979139801398113982139831398413985139861398713988139891399013991139921399313994139951399613997139981399914000140011400214003140041400514006140071400814009140101401114012140131401414015140161401714018140191402014021140221402314024140251402614027140281402914030140311403214033140341403514036140371403814039140401404114042140431404414045140461404714048140491405014051140521405314054140551405614057140581405914060140611406214063140641406514066140671406814069140701407114072140731407414075140761407714078140791408014081140821408314084140851408614087140881408914090140911409214093140941409514096140971409814099141001410114102141031410414105141061410714108141091411014111141121411314114141151411614117141181411914120141211412214123141241412514126141271412814129141301413114132141331413414135141361413714138141391414014141141421414314144141451414614147141481414914150141511415214153141541415514156141571415814159141601416114162141631416414165141661416714168141691417014171141721417314174141751417614177141781417914180141811418214183141841418514186141871418814189141901419114192141931419414195141961419714198141991420014201142021420314204142051420614207142081420914210142111421214213142141421514216142171421814219142201422114222142231422414225142261422714228142291423014231142321423314234142351423614237142381423914240142411424214243142441424514246142471424814249142501425114252142531425414255142561425714258142591426014261142621426314264142651426614267142681426914270142711427214273142741427514276142771427814279142801428114282142831428414285142861428714288142891429014291142921429314294142951429614297142981429914300143011430214303143041430514306143071430814309143101431114312143131431414315143161431714318143191432014321143221432314324143251432614327143281432914330143311433214333143341433514336143371433814339143401434114342143431434414345143461434714348143491435014351143521435314354143551435614357143581435914360143611436214363143641436514366143671436814369143701437114372143731437414375143761437714378143791438014381143821438314384143851438614387143881438914390143911439214393143941439514396143971439814399144001440114402144031440414405144061440714408144091441014411144121441314414144151441614417144181441914420144211442214423144241442514426144271442814429144301443114432144331443414435144361443714438144391444014441144421444314444144451444614447144481444914450144511445214453144541445514456144571445814459144601446114462144631446414465144661446714468144691447014471144721447314474144751447614477144781447914480144811448214483144841448514486144871448814489144901449114492144931449414495144961449714498144991450014501145021450314504145051450614507145081450914510145111451214513145141451514516145171451814519145201452114522145231452414525145261452714528145291453014531145321453314534145351453614537145381453914540145411454214543145441454514546145471454814549145501455114552145531455414555145561455714558145591456014561145621456314564145651456614567145681456914570145711457214573145741457514576145771457814579145801458114582145831458414585145861458714588145891459014591145921459314594145951459614597145981459914600146011460214603146041460514606146071460814609146101461114612146131461414615146161461714618146191462014621146221462314624146251462614627146281462914630146311463214633146341463514636146371463814639146401464114642146431464414645146461464714648146491465014651146521465314654146551465614657146581465914660146611466214663146641466514666146671466814669146701467114672146731467414675146761467714678146791468014681146821468314684146851468614687146881468914690146911469214693146941469514696146971469814699147001470114702147031470414705147061470714708147091471014711147121471314714147151471614717147181471914720147211472214723147241472514726147271472814729147301473114732147331473414735147361473714738147391474014741147421474314744147451474614747147481474914750147511475214753147541475514756147571475814759147601476114762147631476414765147661476714768147691477014771147721477314774147751477614777147781477914780147811478214783147841478514786147871478814789147901479114792147931479414795147961479714798147991480014801148021480314804148051480614807148081480914810148111481214813148141481514816148171481814819148201482114822148231482414825148261482714828148291483014831148321483314834148351483614837148381483914840148411484214843148441484514846148471484814849148501485114852148531485414855148561485714858148591486014861148621486314864148651486614867148681486914870148711487214873148741487514876148771487814879148801488114882148831488414885148861488714888148891489014891148921489314894148951489614897148981489914900149011490214903149041490514906149071490814909149101491114912149131491414915149161491714918149191492014921149221492314924149251492614927149281492914930149311493214933149341493514936149371493814939149401494114942149431494414945149461494714948149491495014951149521495314954149551495614957149581495914960149611496214963149641496514966149671496814969149701497114972149731497414975149761497714978149791498014981149821498314984149851498614987149881498914990149911499214993149941499514996149971499814999150001500115002150031500415005150061500715008150091501015011150121501315014150151501615017150181501915020150211502215023150241502515026150271502815029150301503115032150331503415035150361503715038150391504015041150421504315044150451504615047150481504915050150511505215053150541505515056150571505815059150601506115062150631506415065150661506715068150691507015071150721507315074150751507615077150781507915080150811508215083150841508515086150871508815089150901509115092150931509415095150961509715098150991510015101151021510315104151051510615107151081510915110151111511215113151141511515116151171511815119151201512115122151231512415125151261512715128151291513015131151321513315134151351513615137151381513915140151411514215143151441514515146151471514815149151501515115152151531515415155151561515715158151591516015161151621516315164151651516615167151681516915170151711517215173151741517515176151771517815179151801518115182151831518415185151861518715188151891519015191151921519315194151951519615197151981519915200152011520215203152041520515206152071520815209152101521115212152131521415215152161521715218152191522015221152221522315224152251522615227152281522915230152311523215233152341523515236152371523815239152401524115242152431524415245152461524715248152491525015251152521525315254152551525615257152581525915260152611526215263152641526515266152671526815269152701527115272152731527415275152761527715278152791528015281152821528315284152851528615287152881528915290152911529215293152941529515296152971529815299153001530115302153031530415305153061530715308153091531015311153121531315314153151531615317153181531915320153211532215323153241532515326153271532815329153301533115332153331533415335153361533715338153391534015341153421534315344153451534615347153481534915350153511535215353153541535515356153571535815359153601536115362153631536415365153661536715368153691537015371153721537315374153751537615377153781537915380153811538215383153841538515386153871538815389153901539115392153931539415395153961539715398153991540015401154021540315404154051540615407154081540915410154111541215413154141541515416154171541815419154201542115422154231542415425154261542715428154291543015431154321543315434154351543615437154381543915440154411544215443154441544515446154471544815449154501545115452154531545415455154561545715458154591546015461154621546315464154651546615467154681546915470154711547215473154741547515476154771547815479154801548115482154831548415485154861548715488154891549015491154921549315494154951549615497154981549915500155011550215503155041550515506155071550815509155101551115512155131551415515155161551715518155191552015521155221552315524155251552615527155281552915530155311553215533155341553515536155371553815539155401554115542155431554415545155461554715548155491555015551155521555315554155551555615557155581555915560155611556215563155641556515566155671556815569155701557115572155731557415575155761557715578155791558015581155821558315584155851558615587155881558915590155911559215593155941559515596155971559815599156001560115602156031560415605156061560715608156091561015611156121561315614156151561615617156181561915620156211562215623156241562515626156271562815629156301563115632156331563415635156361563715638156391564015641156421564315644156451564615647156481564915650156511565215653156541565515656156571565815659156601566115662156631566415665156661566715668156691567015671156721567315674156751567615677156781567915680156811568215683156841568515686156871568815689156901569115692156931569415695156961569715698156991570015701157021570315704157051570615707157081570915710157111571215713157141571515716157171571815719157201572115722157231572415725157261572715728157291573015731157321573315734157351573615737157381573915740157411574215743157441574515746157471574815749157501575115752157531575415755157561575715758157591576015761157621576315764157651576615767157681576915770157711577215773157741577515776157771577815779157801578115782157831578415785157861578715788157891579015791157921579315794157951579615797157981579915800158011580215803158041580515806158071580815809158101581115812158131581415815158161581715818158191582015821158221582315824158251582615827158281582915830158311583215833158341583515836158371583815839158401584115842158431584415845158461584715848158491585015851158521585315854158551585615857158581585915860158611586215863158641586515866158671586815869158701587115872158731587415875158761587715878158791588015881158821588315884158851588615887158881588915890158911589215893158941589515896158971589815899159001590115902159031590415905159061590715908159091591015911159121591315914159151591615917159181591915920159211592215923159241592515926159271592815929159301593115932159331593415935159361593715938159391594015941159421594315944159451594615947159481594915950159511595215953159541595515956159571595815959159601596115962159631596415965159661596715968159691597015971159721597315974159751597615977159781597915980159811598215983159841598515986159871598815989159901599115992159931599415995159961599715998159991600016001160021600316004160051600616007160081600916010160111601216013160141601516016160171601816019160201602116022160231602416025160261602716028160291603016031160321603316034160351603616037160381603916040160411604216043160441604516046160471604816049160501605116052160531605416055160561605716058160591606016061160621606316064160651606616067160681606916070160711607216073160741607516076160771607816079160801608116082160831608416085160861608716088160891609016091160921609316094160951609616097160981609916100161011610216103161041610516106161071610816109161101611116112161131611416115161161611716118161191612016121161221612316124161251612616127161281612916130161311613216133161341613516136161371613816139161401614116142161431614416145161461614716148161491615016151161521615316154161551615616157161581615916160161611616216163161641616516166161671616816169161701617116172161731617416175161761617716178161791618016181161821618316184161851618616187161881618916190161911619216193161941619516196161971619816199162001620116202162031620416205162061620716208162091621016211162121621316214162151621616217162181621916220162211622216223162241622516226162271622816229162301623116232162331623416235162361623716238162391624016241162421624316244162451624616247162481624916250162511625216253162541625516256162571625816259162601626116262162631626416265162661626716268162691627016271162721627316274162751627616277162781627916280162811628216283162841628516286162871628816289162901629116292162931629416295162961629716298162991630016301163021630316304163051630616307163081630916310163111631216313163141631516316163171631816319163201632116322163231632416325163261632716328163291633016331163321633316334163351633616337163381633916340163411634216343163441634516346163471634816349163501635116352163531635416355163561635716358163591636016361163621636316364163651636616367163681636916370163711637216373163741637516376163771637816379163801638116382163831638416385163861638716388163891639016391163921639316394163951639616397163981639916400164011640216403164041640516406164071640816409164101641116412164131641416415164161641716418164191642016421164221642316424164251642616427164281642916430164311643216433164341643516436164371643816439164401644116442164431644416445164461644716448164491645016451164521645316454164551645616457164581645916460164611646216463164641646516466164671646816469164701647116472164731647416475164761647716478164791648016481164821648316484164851648616487164881648916490164911649216493164941649516496164971649816499165001650116502165031650416505165061650716508165091651016511165121651316514165151651616517165181651916520165211652216523165241652516526165271652816529165301653116532165331653416535165361653716538165391654016541165421654316544165451654616547165481654916550165511655216553165541655516556165571655816559165601656116562165631656416565165661656716568165691657016571165721657316574165751657616577165781657916580165811658216583165841658516586165871658816589165901659116592165931659416595165961659716598165991660016601166021660316604166051660616607166081660916610166111661216613166141661516616166171661816619166201662116622166231662416625166261662716628166291663016631166321663316634166351663616637166381663916640166411664216643166441664516646166471664816649166501665116652166531665416655166561665716658166591666016661166621666316664166651666616667166681666916670166711667216673166741667516676166771667816679166801668116682166831668416685166861668716688166891669016691166921669316694166951669616697166981669916700167011670216703167041670516706167071670816709167101671116712167131671416715167161671716718167191672016721167221672316724167251672616727167281672916730167311673216733167341673516736167371673816739167401674116742167431674416745167461674716748167491675016751167521675316754167551675616757167581675916760167611676216763167641676516766167671676816769167701677116772167731677416775167761677716778167791678016781167821678316784167851678616787167881678916790167911679216793167941679516796167971679816799168001680116802168031680416805168061680716808168091681016811168121681316814168151681616817168181681916820168211682216823168241682516826168271682816829168301683116832168331683416835168361683716838168391684016841168421684316844168451684616847168481684916850168511685216853168541685516856168571685816859168601686116862168631686416865168661686716868168691687016871168721687316874168751687616877168781687916880168811688216883168841688516886168871688816889168901689116892168931689416895168961689716898168991690016901169021690316904169051690616907169081690916910169111691216913169141691516916169171691816919169201692116922169231692416925169261692716928169291693016931169321693316934169351693616937169381693916940169411694216943169441694516946169471694816949169501695116952169531695416955169561695716958169591696016961169621696316964169651696616967169681696916970169711697216973169741697516976169771697816979169801698116982169831698416985169861698716988169891699016991169921699316994169951699616997169981699917000170011700217003170041700517006170071700817009170101701117012170131701417015170161701717018170191702017021170221702317024170251702617027170281702917030170311703217033170341703517036170371703817039170401704117042170431704417045170461704717048170491705017051170521705317054170551705617057170581705917060170611706217063170641706517066170671706817069170701707117072170731707417075170761707717078170791708017081170821708317084170851708617087170881708917090170911709217093170941709517096170971709817099171001710117102171031710417105171061710717108171091711017111171121711317114171151711617117171181711917120171211712217123171241712517126171271712817129171301713117132171331713417135171361713717138171391714017141171421714317144171451714617147171481714917150171511715217153171541715517156171571715817159171601716117162171631716417165171661716717168171691717017171171721717317174171751717617177171781717917180171811718217183171841718517186171871718817189171901719117192171931719417195171961719717198171991720017201172021720317204172051720617207172081720917210172111721217213172141721517216172171721817219172201722117222172231722417225172261722717228172291723017231172321723317234172351723617237172381723917240172411724217243172441724517246172471724817249172501725117252172531725417255172561725717258172591726017261172621726317264172651726617267172681726917270172711727217273172741727517276172771727817279172801728117282172831728417285172861728717288172891729017291172921729317294172951729617297172981729917300173011730217303173041730517306173071730817309173101731117312173131731417315173161731717318173191732017321173221732317324173251732617327173281732917330173311733217333173341733517336173371733817339173401734117342173431734417345173461734717348173491735017351173521735317354173551735617357173581735917360173611736217363173641736517366173671736817369173701737117372173731737417375173761737717378173791738017381173821738317384173851738617387173881738917390173911739217393173941739517396173971739817399174001740117402174031740417405174061740717408174091741017411174121741317414174151741617417174181741917420174211742217423174241742517426174271742817429174301743117432174331743417435174361743717438174391744017441174421744317444174451744617447174481744917450174511745217453174541745517456174571745817459174601746117462174631746417465174661746717468174691747017471174721747317474174751747617477174781747917480174811748217483174841748517486174871748817489174901749117492174931749417495174961749717498174991750017501175021750317504175051750617507175081750917510175111751217513175141751517516175171751817519175201752117522175231752417525175261752717528175291753017531175321753317534175351753617537175381753917540175411754217543175441754517546175471754817549175501755117552175531755417555175561755717558175591756017561175621756317564175651756617567175681756917570175711757217573175741757517576175771757817579175801758117582175831758417585175861758717588175891759017591175921759317594175951759617597175981759917600176011760217603176041760517606176071760817609176101761117612176131761417615176161761717618176191762017621176221762317624176251762617627176281762917630176311763217633176341763517636176371763817639176401764117642176431764417645176461764717648176491765017651176521765317654176551765617657176581765917660176611766217663176641766517666176671766817669176701767117672176731767417675176761767717678176791768017681176821768317684176851768617687176881768917690176911769217693176941769517696176971769817699177001770117702177031770417705177061770717708177091771017711177121771317714177151771617717177181771917720177211772217723177241772517726177271772817729177301773117732177331773417735177361773717738177391774017741177421774317744177451774617747177481774917750177511775217753177541775517756177571775817759177601776117762177631776417765177661776717768177691777017771177721777317774177751777617777177781777917780177811778217783177841778517786177871778817789177901779117792177931779417795177961779717798177991780017801178021780317804178051780617807178081780917810178111781217813178141781517816178171781817819178201782117822178231782417825178261782717828178291783017831178321783317834178351783617837178381783917840178411784217843178441784517846178471784817849178501785117852178531785417855178561785717858178591786017861178621786317864178651786617867178681786917870178711787217873178741787517876178771787817879178801788117882178831788417885178861788717888178891789017891178921789317894178951789617897178981789917900179011790217903179041790517906179071790817909179101791117912179131791417915179161791717918179191792017921179221792317924179251792617927179281792917930179311793217933179341793517936179371793817939179401794117942179431794417945179461794717948179491795017951179521795317954179551795617957179581795917960179611796217963179641796517966179671796817969179701797117972179731797417975179761797717978179791798017981179821798317984179851798617987179881798917990179911799217993179941799517996179971799817999180001800118002180031800418005180061800718008180091801018011180121801318014180151801618017180181801918020180211802218023180241802518026180271802818029180301803118032180331803418035180361803718038180391804018041180421804318044180451804618047180481804918050180511805218053180541805518056180571805818059180601806118062180631806418065180661806718068180691807018071180721807318074180751807618077180781807918080180811808218083180841808518086180871808818089180901809118092180931809418095180961809718098180991810018101181021810318104181051810618107181081810918110181111811218113181141811518116181171811818119181201812118122181231812418125181261812718128181291813018131181321813318134181351813618137181381813918140181411814218143181441814518146181471814818149181501815118152181531815418155181561815718158181591816018161181621816318164181651816618167181681816918170181711817218173181741817518176181771817818179181801818118182181831818418185181861818718188181891819018191181921819318194181951819618197181981819918200182011820218203182041820518206182071820818209182101821118212182131821418215182161821718218182191822018221182221822318224182251822618227182281822918230182311823218233182341823518236182371823818239182401824118242182431824418245182461824718248182491825018251182521825318254182551825618257182581825918260182611826218263182641826518266182671826818269182701827118272182731827418275182761827718278182791828018281182821828318284182851828618287182881828918290182911829218293182941829518296182971829818299183001830118302183031830418305183061830718308183091831018311183121831318314183151831618317183181831918320183211832218323183241832518326183271832818329183301833118332183331833418335183361833718338183391834018341183421834318344183451834618347183481834918350183511835218353183541835518356183571835818359183601836118362183631836418365183661836718368183691837018371183721837318374183751837618377183781837918380183811838218383183841838518386183871838818389183901839118392183931839418395183961839718398183991840018401184021840318404184051840618407184081840918410184111841218413184141841518416184171841818419184201842118422184231842418425184261842718428184291843018431184321843318434184351843618437184381843918440184411844218443184441844518446184471844818449184501845118452184531845418455184561845718458184591846018461184621846318464184651846618467184681846918470184711847218473184741847518476184771847818479184801848118482184831848418485184861848718488184891849018491184921849318494184951849618497184981849918500185011850218503185041850518506185071850818509185101851118512185131851418515185161851718518185191852018521185221852318524185251852618527185281852918530185311853218533185341853518536185371853818539185401854118542185431854418545185461854718548185491855018551185521855318554185551855618557185581855918560185611856218563185641856518566185671856818569185701857118572185731857418575185761857718578185791858018581185821858318584185851858618587185881858918590185911859218593185941859518596185971859818599186001860118602186031860418605186061860718608186091861018611186121861318614186151861618617186181861918620186211862218623186241862518626186271862818629186301863118632186331863418635186361863718638186391864018641186421864318644186451864618647186481864918650186511865218653186541865518656186571865818659186601866118662186631866418665186661866718668186691867018671186721867318674186751867618677186781867918680186811868218683186841868518686186871868818689186901869118692186931869418695186961869718698186991870018701187021870318704187051870618707187081870918710187111871218713187141871518716187171871818719187201872118722187231872418725187261872718728187291873018731187321873318734187351873618737187381873918740187411874218743187441874518746187471874818749187501875118752187531875418755187561875718758187591876018761187621876318764187651876618767187681876918770187711877218773187741877518776187771877818779187801878118782187831878418785187861878718788187891879018791187921879318794187951879618797187981879918800188011880218803188041880518806188071880818809188101881118812188131881418815188161881718818188191882018821188221882318824188251882618827188281882918830188311883218833188341883518836188371883818839188401884118842188431884418845188461884718848188491885018851188521885318854188551885618857188581885918860188611886218863188641886518866188671886818869188701887118872188731887418875188761887718878188791888018881188821888318884188851888618887188881888918890188911889218893188941889518896188971889818899189001890118902189031890418905189061890718908189091891018911189121891318914189151891618917189181891918920189211892218923189241892518926189271892818929189301893118932189331893418935189361893718938189391894018941189421894318944189451894618947189481894918950189511895218953189541895518956189571895818959189601896118962189631896418965189661896718968189691897018971189721897318974189751897618977189781897918980189811898218983189841898518986189871898818989189901899118992189931899418995189961899718998189991900019001190021900319004190051900619007190081900919010190111901219013190141901519016190171901819019190201902119022190231902419025190261902719028190291903019031190321903319034190351903619037190381903919040190411904219043190441904519046190471904819049190501905119052190531905419055190561905719058190591906019061190621906319064190651906619067190681906919070190711907219073190741907519076190771907819079190801908119082190831908419085190861908719088190891909019091190921909319094190951909619097190981909919100191011910219103191041910519106191071910819109191101911119112191131911419115191161911719118191191912019121191221912319124191251912619127191281912919130191311913219133191341913519136191371913819139191401914119142191431914419145191461914719148191491915019151191521915319154191551915619157191581915919160191611916219163191641916519166191671916819169191701917119172191731917419175191761917719178191791918019181191821918319184191851918619187191881918919190191911919219193191941919519196191971919819199192001920119202192031920419205192061920719208192091921019211192121921319214192151921619217192181921919220192211922219223192241922519226192271922819229192301923119232192331923419235192361923719238192391924019241192421924319244192451924619247192481924919250192511925219253192541925519256192571925819259192601926119262192631926419265192661926719268192691927019271192721927319274192751927619277192781927919280192811928219283192841928519286192871928819289192901929119292192931929419295192961929719298192991930019301193021930319304193051930619307193081930919310193111931219313193141931519316193171931819319193201932119322193231932419325193261932719328193291933019331193321933319334193351933619337193381933919340193411934219343193441934519346193471934819349193501935119352193531935419355193561935719358193591936019361193621936319364193651936619367193681936919370193711937219373193741937519376193771937819379193801938119382193831938419385193861938719388193891939019391193921939319394193951939619397193981939919400194011940219403194041940519406194071940819409194101941119412194131941419415194161941719418194191942019421194221942319424194251942619427194281942919430194311943219433194341943519436194371943819439194401944119442194431944419445194461944719448194491945019451194521945319454194551945619457194581945919460194611946219463194641946519466194671946819469194701947119472194731947419475194761947719478194791948019481194821948319484194851948619487194881948919490194911949219493194941949519496194971949819499195001950119502195031950419505195061950719508195091951019511195121951319514195151951619517195181951919520195211952219523195241952519526195271952819529195301953119532195331953419535195361953719538195391954019541195421954319544195451954619547195481954919550195511955219553195541955519556195571955819559195601956119562195631956419565195661956719568195691957019571195721957319574195751957619577195781957919580195811958219583195841958519586195871958819589195901959119592195931959419595195961959719598195991960019601196021960319604196051960619607196081960919610196111961219613196141961519616196171961819619196201962119622196231962419625196261962719628196291963019631196321963319634196351963619637196381963919640196411964219643196441964519646196471964819649196501965119652196531965419655196561965719658196591966019661196621966319664196651966619667196681966919670196711967219673196741967519676196771967819679196801968119682196831968419685196861968719688196891969019691196921969319694196951969619697196981969919700197011970219703197041970519706197071970819709197101971119712197131971419715197161971719718197191972019721197221972319724197251972619727197281972919730197311973219733197341973519736197371973819739197401974119742197431974419745197461974719748197491975019751197521975319754197551975619757197581975919760197611976219763197641976519766197671976819769197701977119772197731977419775197761977719778197791978019781197821978319784197851978619787197881978919790197911979219793197941979519796197971979819799198001980119802198031980419805198061980719808198091981019811198121981319814198151981619817198181981919820198211982219823198241982519826198271982819829198301983119832198331983419835198361983719838198391984019841198421984319844198451984619847198481984919850198511985219853198541985519856198571985819859198601986119862198631986419865198661986719868198691987019871198721987319874198751987619877198781987919880198811988219883198841988519886198871988819889198901989119892198931989419895198961989719898198991990019901199021990319904199051990619907199081990919910199111991219913199141991519916199171991819919199201992119922199231992419925199261992719928199291993019931199321993319934199351993619937199381993919940199411994219943199441994519946199471994819949199501995119952199531995419955199561995719958199591996019961199621996319964199651996619967199681996919970199711997219973199741997519976199771997819979199801998119982199831998419985199861998719988199891999019991199921999319994199951999619997199981999920000200012000220003200042000520006200072000820009200102001120012200132001420015200162001720018200192002020021200222002320024200252002620027200282002920030200312003220033200342003520036200372003820039200402004120042200432004420045200462004720048200492005020051200522005320054200552005620057200582005920060200612006220063200642006520066200672006820069200702007120072200732007420075200762007720078200792008020081200822008320084200852008620087200882008920090200912009220093200942009520096200972009820099201002010120102201032010420105201062010720108201092011020111201122011320114201152011620117201182011920120201212012220123201242012520126201272012820129201302013120132201332013420135201362013720138201392014020141201422014320144201452014620147201482014920150201512015220153201542015520156201572015820159201602016120162201632016420165201662016720168201692017020171201722017320174201752017620177201782017920180201812018220183201842018520186201872018820189201902019120192201932019420195201962019720198201992020020201202022020320204202052020620207202082020920210202112021220213202142021520216202172021820219202202022120222202232022420225202262022720228202292023020231202322023320234202352023620237202382023920240202412024220243202442024520246202472024820249202502025120252202532025420255202562025720258202592026020261202622026320264202652026620267202682026920270202712027220273202742027520276202772027820279202802028120282202832028420285202862028720288202892029020291202922029320294202952029620297202982029920300203012030220303203042030520306203072030820309203102031120312203132031420315203162031720318203192032020321203222032320324203252032620327203282032920330203312033220333203342033520336203372033820339203402034120342203432034420345203462034720348203492035020351203522035320354203552035620357203582035920360203612036220363203642036520366203672036820369203702037120372203732037420375203762037720378203792038020381203822038320384203852038620387203882038920390203912039220393203942039520396203972039820399204002040120402204032040420405204062040720408204092041020411204122041320414204152041620417204182041920420204212042220423204242042520426204272042820429204302043120432204332043420435204362043720438204392044020441204422044320444204452044620447204482044920450204512045220453204542045520456204572045820459204602046120462204632046420465204662046720468204692047020471204722047320474204752047620477204782047920480204812048220483204842048520486204872048820489204902049120492204932049420495204962049720498204992050020501205022050320504205052050620507205082050920510205112051220513205142051520516205172051820519205202052120522205232052420525205262052720528205292053020531205322053320534205352053620537205382053920540205412054220543205442054520546205472054820549205502055120552205532055420555205562055720558205592056020561205622056320564205652056620567205682056920570205712057220573205742057520576205772057820579205802058120582205832058420585205862058720588205892059020591205922059320594205952059620597205982059920600206012060220603206042060520606206072060820609206102061120612206132061420615206162061720618206192062020621206222062320624206252062620627206282062920630206312063220633206342063520636206372063820639206402064120642206432064420645206462064720648206492065020651206522065320654206552065620657206582065920660206612066220663206642066520666206672066820669206702067120672206732067420675206762067720678206792068020681206822068320684206852068620687206882068920690206912069220693206942069520696206972069820699207002070120702207032070420705207062070720708207092071020711207122071320714207152071620717207182071920720207212072220723207242072520726207272072820729207302073120732207332073420735207362073720738207392074020741207422074320744207452074620747207482074920750207512075220753207542075520756207572075820759207602076120762207632076420765207662076720768207692077020771207722077320774207752077620777207782077920780207812078220783207842078520786207872078820789207902079120792207932079420795207962079720798207992080020801208022080320804208052080620807208082080920810208112081220813208142081520816208172081820819208202082120822208232082420825208262082720828208292083020831208322083320834208352083620837208382083920840208412084220843208442084520846208472084820849208502085120852208532085420855208562085720858208592086020861208622086320864208652086620867208682086920870208712087220873208742087520876208772087820879208802088120882208832088420885208862088720888208892089020891208922089320894208952089620897208982089920900209012090220903209042090520906209072090820909209102091120912209132091420915209162091720918209192092020921209222092320924209252092620927209282092920930209312093220933209342093520936209372093820939209402094120942209432094420945209462094720948209492095020951209522095320954209552095620957209582095920960209612096220963209642096520966209672096820969209702097120972209732097420975209762097720978209792098020981209822098320984209852098620987209882098920990209912099220993209942099520996209972099820999210002100121002210032100421005210062100721008210092101021011210122101321014210152101621017210182101921020210212102221023210242102521026210272102821029210302103121032210332103421035210362103721038210392104021041210422104321044210452104621047210482104921050210512105221053210542105521056210572105821059210602106121062210632106421065210662106721068210692107021071210722107321074210752107621077210782107921080210812108221083210842108521086210872108821089210902109121092210932109421095210962109721098210992110021101211022110321104211052110621107211082110921110211112111221113211142111521116211172111821119211202112121122211232112421125211262112721128211292113021131211322113321134211352113621137211382113921140211412114221143211442114521146211472114821149211502115121152211532115421155211562115721158211592116021161211622116321164211652116621167211682116921170211712117221173211742117521176211772117821179211802118121182211832118421185211862118721188211892119021191211922119321194211952119621197211982119921200212012120221203212042120521206212072120821209212102121121212212132121421215212162121721218212192122021221212222122321224212252122621227212282122921230212312123221233212342123521236212372123821239212402124121242212432124421245212462124721248212492125021251212522125321254212552125621257212582125921260212612126221263212642126521266212672126821269212702127121272212732127421275212762127721278212792128021281212822128321284212852128621287212882128921290212912129221293212942129521296212972129821299213002130121302213032130421305213062130721308213092131021311213122131321314213152131621317213182131921320213212132221323213242132521326213272132821329213302133121332213332133421335213362133721338213392134021341213422134321344213452134621347213482134921350213512135221353213542135521356213572135821359213602136121362213632136421365213662136721368213692137021371213722137321374213752137621377213782137921380213812138221383213842138521386213872138821389213902139121392213932139421395213962139721398213992140021401214022140321404214052140621407214082140921410214112141221413214142141521416214172141821419214202142121422214232142421425214262142721428214292143021431214322143321434214352143621437214382143921440214412144221443214442144521446214472144821449214502145121452214532145421455214562145721458214592146021461214622146321464214652146621467214682146921470214712147221473214742147521476214772147821479214802148121482214832148421485214862148721488214892149021491214922149321494214952149621497214982149921500215012150221503215042150521506215072150821509215102151121512215132151421515215162151721518215192152021521215222152321524215252152621527215282152921530215312153221533215342153521536215372153821539215402154121542215432154421545215462154721548215492155021551215522155321554215552155621557215582155921560215612156221563215642156521566215672156821569215702157121572215732157421575215762157721578215792158021581215822158321584215852158621587215882158921590215912159221593215942159521596215972159821599216002160121602216032160421605216062160721608216092161021611216122161321614216152161621617216182161921620216212162221623216242162521626216272162821629216302163121632216332163421635216362163721638216392164021641216422164321644216452164621647216482164921650216512165221653216542165521656216572165821659216602166121662216632166421665216662166721668216692167021671216722167321674216752167621677216782167921680216812168221683216842168521686216872168821689216902169121692216932169421695216962169721698216992170021701217022170321704217052170621707217082170921710217112171221713217142171521716217172171821719217202172121722217232172421725217262172721728217292173021731217322173321734217352173621737217382173921740217412174221743217442174521746217472174821749217502175121752217532175421755217562175721758217592176021761217622176321764217652176621767217682176921770217712177221773 |
- //
- // httplib.h
- //
- // Copyright (c) 2026 Yuji Hirose. All rights reserved.
- // MIT License
- //
- #ifndef CPPHTTPLIB_HTTPLIB_H
- #define CPPHTTPLIB_HTTPLIB_H
- #define CPPHTTPLIB_VERSION "0.52.0"
- #define CPPHTTPLIB_VERSION_NUM "0x003400"
- #ifdef _WIN32
- #if defined(_WIN32_WINNT) && _WIN32_WINNT < 0x0A00
- #error \
- "cpp-httplib doesn't support Windows 8 or lower. Please use Windows 10 or later."
- #endif
- #endif
- /*
- * Configuration
- */
- #ifndef CPPHTTPLIB_KEEPALIVE_TIMEOUT_SECOND
- #define CPPHTTPLIB_KEEPALIVE_TIMEOUT_SECOND 5
- #endif
- #ifndef CPPHTTPLIB_KEEPALIVE_TIMEOUT_CHECK_INTERVAL_USECOND
- #define CPPHTTPLIB_KEEPALIVE_TIMEOUT_CHECK_INTERVAL_USECOND 10000
- #endif
- #ifndef CPPHTTPLIB_KEEPALIVE_MAX_COUNT
- #define CPPHTTPLIB_KEEPALIVE_MAX_COUNT 100
- #endif
- #ifndef CPPHTTPLIB_CONNECTION_TIMEOUT_SECOND
- #define CPPHTTPLIB_CONNECTION_TIMEOUT_SECOND 300
- #endif
- #ifndef CPPHTTPLIB_CONNECTION_TIMEOUT_USECOND
- #define CPPHTTPLIB_CONNECTION_TIMEOUT_USECOND 0
- #endif
- #ifndef CPPHTTPLIB_SERVER_READ_TIMEOUT_SECOND
- #define CPPHTTPLIB_SERVER_READ_TIMEOUT_SECOND 5
- #endif
- #ifndef CPPHTTPLIB_SERVER_READ_TIMEOUT_USECOND
- #define CPPHTTPLIB_SERVER_READ_TIMEOUT_USECOND 0
- #endif
- #ifndef CPPHTTPLIB_SERVER_WRITE_TIMEOUT_SECOND
- #define CPPHTTPLIB_SERVER_WRITE_TIMEOUT_SECOND 5
- #endif
- #ifndef CPPHTTPLIB_SERVER_WRITE_TIMEOUT_USECOND
- #define CPPHTTPLIB_SERVER_WRITE_TIMEOUT_USECOND 0
- #endif
- #ifndef CPPHTTPLIB_CLIENT_READ_TIMEOUT_SECOND
- #define CPPHTTPLIB_CLIENT_READ_TIMEOUT_SECOND 300
- #endif
- #ifndef CPPHTTPLIB_CLIENT_READ_TIMEOUT_USECOND
- #define CPPHTTPLIB_CLIENT_READ_TIMEOUT_USECOND 0
- #endif
- #ifndef CPPHTTPLIB_CLIENT_WRITE_TIMEOUT_SECOND
- #define CPPHTTPLIB_CLIENT_WRITE_TIMEOUT_SECOND 5
- #endif
- #ifndef CPPHTTPLIB_CLIENT_WRITE_TIMEOUT_USECOND
- #define CPPHTTPLIB_CLIENT_WRITE_TIMEOUT_USECOND 0
- #endif
- #ifndef CPPHTTPLIB_CLIENT_MAX_TIMEOUT_MSECOND
- #define CPPHTTPLIB_CLIENT_MAX_TIMEOUT_MSECOND 0
- #endif
- #ifndef CPPHTTPLIB_EXPECT_100_THRESHOLD
- #define CPPHTTPLIB_EXPECT_100_THRESHOLD 1024
- #endif
- #ifndef CPPHTTPLIB_EXPECT_100_TIMEOUT_MSECOND
- #define CPPHTTPLIB_EXPECT_100_TIMEOUT_MSECOND 1000
- #endif
- #ifndef CPPHTTPLIB_WAIT_EARLY_SERVER_RESPONSE_THRESHOLD
- #define CPPHTTPLIB_WAIT_EARLY_SERVER_RESPONSE_THRESHOLD (1024 * 1024)
- #endif
- #ifndef CPPHTTPLIB_WAIT_EARLY_SERVER_RESPONSE_TIMEOUT_MSECOND
- #define CPPHTTPLIB_WAIT_EARLY_SERVER_RESPONSE_TIMEOUT_MSECOND 50
- #endif
- #ifndef CPPHTTPLIB_IDLE_INTERVAL_SECOND
- #define CPPHTTPLIB_IDLE_INTERVAL_SECOND 0
- #endif
- #ifndef CPPHTTPLIB_IDLE_INTERVAL_USECOND
- #ifdef _WIN32
- #define CPPHTTPLIB_IDLE_INTERVAL_USECOND 1000
- #else
- #define CPPHTTPLIB_IDLE_INTERVAL_USECOND 0
- #endif
- #endif
- #ifndef CPPHTTPLIB_REQUEST_URI_MAX_LENGTH
- #define CPPHTTPLIB_REQUEST_URI_MAX_LENGTH 8192
- #endif
- #ifndef CPPHTTPLIB_HEADER_MAX_LENGTH
- #define CPPHTTPLIB_HEADER_MAX_LENGTH 8192
- #endif
- #ifndef CPPHTTPLIB_HEADER_MAX_COUNT
- #define CPPHTTPLIB_HEADER_MAX_COUNT 100
- #endif
- #ifndef CPPHTTPLIB_REDIRECT_MAX_COUNT
- #define CPPHTTPLIB_REDIRECT_MAX_COUNT 20
- #endif
- #ifndef CPPHTTPLIB_MULTIPART_FORM_DATA_FILE_MAX_COUNT
- #define CPPHTTPLIB_MULTIPART_FORM_DATA_FILE_MAX_COUNT 1024
- #endif
- #ifndef CPPHTTPLIB_PAYLOAD_MAX_LENGTH
- #define CPPHTTPLIB_PAYLOAD_MAX_LENGTH (100 * 1024 * 1024) // 100MB
- #endif
- #ifndef CPPHTTPLIB_FORM_URL_ENCODED_PAYLOAD_MAX_LENGTH
- #define CPPHTTPLIB_FORM_URL_ENCODED_PAYLOAD_MAX_LENGTH 8192
- #endif
- #ifndef CPPHTTPLIB_RANGE_MAX_COUNT
- #define CPPHTTPLIB_RANGE_MAX_COUNT 1024
- #endif
- #ifndef CPPHTTPLIB_TCP_NODELAY
- #define CPPHTTPLIB_TCP_NODELAY false
- #endif
- #ifndef CPPHTTPLIB_IPV6_V6ONLY
- #define CPPHTTPLIB_IPV6_V6ONLY false
- #endif
- #ifndef CPPHTTPLIB_RECV_BUFSIZ
- #define CPPHTTPLIB_RECV_BUFSIZ size_t(16384u)
- #endif
- #ifndef CPPHTTPLIB_SEND_BUFSIZ
- #define CPPHTTPLIB_SEND_BUFSIZ size_t(16384u)
- #endif
- #ifndef CPPHTTPLIB_COMPRESSION_BUFSIZ
- #define CPPHTTPLIB_COMPRESSION_BUFSIZ size_t(16384u)
- #endif
- #ifndef CPPHTTPLIB_THREAD_POOL_COUNT
- #define CPPHTTPLIB_THREAD_POOL_COUNT \
- ((std::max)(8u, std::thread::hardware_concurrency() > 0 \
- ? std::thread::hardware_concurrency() - 1 \
- : 0))
- #endif
- #ifndef CPPHTTPLIB_THREAD_POOL_MAX_COUNT
- #define CPPHTTPLIB_THREAD_POOL_MAX_COUNT (CPPHTTPLIB_THREAD_POOL_COUNT * 4)
- #endif
- #ifndef CPPHTTPLIB_THREAD_POOL_IDLE_TIMEOUT
- #define CPPHTTPLIB_THREAD_POOL_IDLE_TIMEOUT 3 // seconds
- #endif
- #ifndef CPPHTTPLIB_RECV_FLAGS
- #define CPPHTTPLIB_RECV_FLAGS 0
- #endif
- #ifndef CPPHTTPLIB_SEND_FLAGS
- #define CPPHTTPLIB_SEND_FLAGS 0
- #endif
- #ifndef CPPHTTPLIB_LISTEN_BACKLOG
- #define CPPHTTPLIB_LISTEN_BACKLOG 128
- #endif
- #ifndef CPPHTTPLIB_MAX_LINE_LENGTH
- #define CPPHTTPLIB_MAX_LINE_LENGTH 32768
- #endif
- #ifndef CPPHTTPLIB_WEBSOCKET_MAX_PAYLOAD_LENGTH
- #define CPPHTTPLIB_WEBSOCKET_MAX_PAYLOAD_LENGTH 16777216
- #endif
- #ifndef CPPHTTPLIB_WEBSOCKET_READ_TIMEOUT_SECOND
- #define CPPHTTPLIB_WEBSOCKET_READ_TIMEOUT_SECOND 300
- #endif
- #ifndef CPPHTTPLIB_WEBSOCKET_CLOSE_TIMEOUT_SECOND
- #define CPPHTTPLIB_WEBSOCKET_CLOSE_TIMEOUT_SECOND 5
- #endif
- #ifndef CPPHTTPLIB_WEBSOCKET_PING_INTERVAL_SECOND
- #define CPPHTTPLIB_WEBSOCKET_PING_INTERVAL_SECOND 30
- #endif
- #ifndef CPPHTTPLIB_WEBSOCKET_MAX_MISSED_PONGS
- #define CPPHTTPLIB_WEBSOCKET_MAX_MISSED_PONGS 0
- #endif
- /*
- * Headers
- */
- #ifdef _WIN32
- #ifndef _CRT_SECURE_NO_WARNINGS
- #define _CRT_SECURE_NO_WARNINGS
- #endif //_CRT_SECURE_NO_WARNINGS
- #ifndef _CRT_NONSTDC_NO_DEPRECATE
- #define _CRT_NONSTDC_NO_DEPRECATE
- #endif //_CRT_NONSTDC_NO_DEPRECATE
- #if defined(_MSC_VER)
- #if _MSC_VER < 1900
- #error Sorry, Visual Studio versions prior to 2015 are not supported
- #endif
- #pragma comment(lib, "ws2_32.lib")
- #ifndef _SSIZE_T_DEFINED
- using ssize_t = __int64;
- #define _SSIZE_T_DEFINED
- #endif
- #endif // _MSC_VER
- #ifndef S_ISREG
- #define S_ISREG(m) (((m) & S_IFREG) == S_IFREG)
- #endif // S_ISREG
- #ifndef S_ISDIR
- #define S_ISDIR(m) (((m) & S_IFDIR) == S_IFDIR)
- #endif // S_ISDIR
- #ifndef NOMINMAX
- #define NOMINMAX
- #endif // NOMINMAX
- #include <io.h>
- #include <winsock2.h>
- #include <ws2tcpip.h>
- #if defined(__has_include)
- #if __has_include(<afunix.h>)
- // afunix.h uses types declared in winsock2.h, so has to be included after it.
- #include <afunix.h>
- #define CPPHTTPLIB_HAVE_AFUNIX_H 1
- #endif
- #endif
- #ifndef WSA_FLAG_NO_HANDLE_INHERIT
- #define WSA_FLAG_NO_HANDLE_INHERIT 0x80
- #endif
- using nfds_t = unsigned long;
- using socket_t = SOCKET;
- using socklen_t = int;
- #else // not _WIN32
- #include <arpa/inet.h>
- #if !defined(_AIX) && !defined(__MVS__)
- #include <ifaddrs.h>
- #endif
- #ifdef __MVS__
- #include <strings.h>
- #ifndef NI_MAXHOST
- #define NI_MAXHOST 1025
- #endif
- #endif
- #include <net/if.h>
- #include <netdb.h>
- #include <netinet/in.h>
- #ifdef __linux__
- #include <resolv.h>
- #undef _res // Undefine _res macro to avoid conflicts with user code (#2278)
- #endif
- #include <csignal>
- #include <netinet/tcp.h>
- #include <poll.h>
- #include <pthread.h>
- #include <sys/mman.h>
- #include <sys/socket.h>
- #include <sys/un.h>
- #include <unistd.h>
- using socket_t = int;
- #ifndef INVALID_SOCKET
- #define INVALID_SOCKET (-1)
- #endif
- #endif //_WIN32
- #if defined(__APPLE__)
- #include <TargetConditionals.h>
- #endif
- #include <algorithm>
- #include <array>
- #include <atomic>
- #include <cassert>
- #include <chrono>
- #include <climits>
- #include <condition_variable>
- #include <cstdlib>
- #include <cstring>
- #include <errno.h>
- #include <exception>
- #include <fcntl.h>
- #include <fstream>
- #include <functional>
- #include <iomanip>
- #include <iostream>
- #include <iterator>
- #include <list>
- #include <map>
- #include <memory>
- #include <mutex>
- #include <random>
- #include <regex>
- #include <set>
- #include <sstream>
- #include <string>
- #include <sys/stat.h>
- #include <system_error>
- #include <thread>
- #include <type_traits>
- #include <unordered_map>
- #include <unordered_set>
- #include <utility>
- #include <vector>
- // On macOS with a TLS backend, enable Keychain root certificates by default
- // unless the user explicitly opts out. Not enabled on iOS/tvOS/watchOS since
- // the SecTrustSettings APIs used to enumerate anchor certificates are macOS
- // only; on those platforms the user must provide a CA bundle explicitly.
- #if defined(__APPLE__) && defined(__clang__) && \
- !defined(CPPHTTPLIB_DISABLE_MACOSX_AUTOMATIC_ROOT_CERTIFICATES) && \
- (defined(CPPHTTPLIB_OPENSSL_SUPPORT) || \
- defined(CPPHTTPLIB_MBEDTLS_SUPPORT) || \
- defined(CPPHTTPLIB_WOLFSSL_SUPPORT))
- #if TARGET_OS_OSX
- #ifndef CPPHTTPLIB_USE_CERTS_FROM_MACOSX_KEYCHAIN
- #define CPPHTTPLIB_USE_CERTS_FROM_MACOSX_KEYCHAIN
- #endif
- #endif
- #endif
- #if defined(CPPHTTPLIB_USE_CERTS_FROM_MACOSX_KEYCHAIN) && \
- defined(__APPLE__) && !TARGET_OS_OSX
- #error \
- "CPPHTTPLIB_USE_CERTS_FROM_MACOSX_KEYCHAIN is only supported on macOS. On iOS/tvOS/watchOS, supply a CA bundle via set_ca_cert_path()."
- #endif
- // On Windows, enable Schannel certificate verification by default
- // unless the user explicitly opts out.
- #if defined(_WIN32) && \
- !defined(CPPHTTPLIB_DISABLE_WINDOWS_AUTOMATIC_ROOT_CERTIFICATES_UPDATE)
- #define CPPHTTPLIB_WINDOWS_AUTOMATIC_ROOT_CERTIFICATES_UPDATE
- #endif
- #if defined(CPPHTTPLIB_USE_NON_BLOCKING_GETADDRINFO) || \
- defined(CPPHTTPLIB_USE_CERTS_FROM_MACOSX_KEYCHAIN)
- #if TARGET_OS_MAC && defined(__clang__)
- #include <CFNetwork/CFHost.h>
- #include <CoreFoundation/CoreFoundation.h>
- #endif
- #endif
- #ifdef CPPHTTPLIB_OPENSSL_SUPPORT
- #ifdef _WIN32
- #include <wincrypt.h>
- // these are defined in wincrypt.h and it breaks compilation if BoringSSL is
- // used
- #undef X509_NAME
- #undef X509_CERT_PAIR
- #undef X509_EXTENSIONS
- #undef PKCS7_SIGNER_INFO
- #ifdef _MSC_VER
- #pragma comment(lib, "crypt32.lib")
- #endif
- #endif // _WIN32
- #ifdef CPPHTTPLIB_USE_CERTS_FROM_MACOSX_KEYCHAIN
- #if TARGET_OS_OSX
- #include <Security/Security.h>
- #endif
- #endif
- #include <openssl/err.h>
- #include <openssl/evp.h>
- #include <openssl/ssl.h>
- #include <openssl/x509v3.h>
- #if defined(_WIN32) && defined(OPENSSL_USE_APPLINK)
- #include <openssl/applink.c>
- #endif
- #include <iostream>
- #include <sstream>
- #if defined(OPENSSL_IS_BORINGSSL) || defined(LIBRESSL_VERSION_NUMBER)
- #if OPENSSL_VERSION_NUMBER < 0x1010107f
- #error Please use OpenSSL or a current version of BoringSSL
- #endif
- #define SSL_get1_peer_certificate SSL_get_peer_certificate
- #elif OPENSSL_VERSION_NUMBER < 0x30000000L
- #error Sorry, OpenSSL versions prior to 3.0.0 are not supported
- #endif
- #endif // CPPHTTPLIB_OPENSSL_SUPPORT
- #ifdef CPPHTTPLIB_MBEDTLS_SUPPORT
- // version.h defines MBEDTLS_VERSION_MAJOR (on 2.x/3.x/4.x alike); it is pulled
- // in with this first include group so the version gating below can use it.
- #include <mbedtls/error.h>
- #include <mbedtls/net_sockets.h>
- #include <mbedtls/oid.h>
- #include <mbedtls/pk.h>
- #include <mbedtls/ssl.h>
- #include <mbedtls/version.h>
- #include <mbedtls/x509_crt.h>
- #if MBEDTLS_VERSION_MAJOR >= 4
- // Mbed TLS 4.x moved hashing/RNG to PSA Crypto and removed these headers.
- #include <psa/crypto.h>
- #else
- #include <mbedtls/ctr_drbg.h>
- #include <mbedtls/entropy.h>
- #include <mbedtls/md5.h>
- #include <mbedtls/sha1.h>
- #include <mbedtls/sha256.h>
- #include <mbedtls/sha512.h>
- #endif
- #ifdef _WIN32
- #include <wincrypt.h>
- #ifdef _MSC_VER
- #pragma comment(lib, "crypt32.lib")
- #endif
- #endif // _WIN32
- #ifdef CPPHTTPLIB_USE_CERTS_FROM_MACOSX_KEYCHAIN
- #if TARGET_OS_OSX
- #include <Security/Security.h>
- #endif
- #endif
- // Mbed TLS version API compatibility. Note: V4 implies V3 (both defined on
- // 4.x), so version-specific 3.x-only code must check V3 && !V4.
- #if MBEDTLS_VERSION_MAJOR >= 4
- #define CPPHTTPLIB_MBEDTLS_V4
- #endif
- #if MBEDTLS_VERSION_MAJOR >= 3
- #define CPPHTTPLIB_MBEDTLS_V3
- #endif
- #endif // CPPHTTPLIB_MBEDTLS_SUPPORT
- #ifdef CPPHTTPLIB_WOLFSSL_SUPPORT
- #include <wolfssl/options.h>
- #include <wolfssl/openssl/x509v3.h>
- // Fallback definitions for older wolfSSL versions (e.g., 5.6.6)
- #ifndef WOLFSSL_GEN_EMAIL
- #define WOLFSSL_GEN_EMAIL 1
- #endif
- #ifndef WOLFSSL_GEN_DNS
- #define WOLFSSL_GEN_DNS 2
- #endif
- #ifndef WOLFSSL_GEN_URI
- #define WOLFSSL_GEN_URI 6
- #endif
- #ifndef WOLFSSL_GEN_IPADD
- #define WOLFSSL_GEN_IPADD 7
- #endif
- #include <wolfssl/ssl.h>
- #include <wolfssl/wolfcrypt/hash.h>
- #include <wolfssl/wolfcrypt/md5.h>
- #include <wolfssl/wolfcrypt/sha256.h>
- #include <wolfssl/wolfcrypt/sha512.h>
- #ifdef _WIN32
- #include <wincrypt.h>
- #ifdef _MSC_VER
- #pragma comment(lib, "crypt32.lib")
- #endif
- #endif // _WIN32
- #ifdef CPPHTTPLIB_USE_CERTS_FROM_MACOSX_KEYCHAIN
- #if TARGET_OS_OSX
- #include <Security/Security.h>
- #endif
- #endif
- #endif // CPPHTTPLIB_WOLFSSL_SUPPORT
- // Define CPPHTTPLIB_SSL_ENABLED if any SSL backend is available
- #if defined(CPPHTTPLIB_OPENSSL_SUPPORT) || \
- defined(CPPHTTPLIB_MBEDTLS_SUPPORT) || defined(CPPHTTPLIB_WOLFSSL_SUPPORT)
- #define CPPHTTPLIB_SSL_ENABLED
- #endif
- #ifdef CPPHTTPLIB_ZLIB_SUPPORT
- #include <zlib.h>
- #endif
- #ifdef CPPHTTPLIB_BROTLI_SUPPORT
- #include <brotli/decode.h>
- #include <brotli/encode.h>
- #endif
- #ifdef CPPHTTPLIB_ZSTD_SUPPORT
- #include <zstd.h>
- #endif
- /*
- * Declaration
- */
- namespace httplib {
- namespace ws {
- class WebSocket;
- } // namespace ws
- namespace detail {
- /*
- * Backport std::make_unique from C++14.
- *
- * NOTE: This code came up with the following stackoverflow post:
- * https://stackoverflow.com/questions/10149840/c-arrays-and-make-unique
- *
- */
- template <class T, class... Args>
- typename std::enable_if<!std::is_array<T>::value, std::unique_ptr<T>>::type
- make_unique(Args &&...args) {
- return std::unique_ptr<T>(new T(std::forward<Args>(args)...));
- }
- template <class T>
- typename std::enable_if<std::is_array<T>::value, std::unique_ptr<T>>::type
- make_unique(std::size_t n) {
- typedef typename std::remove_extent<T>::type RT;
- return std::unique_ptr<T>(new RT[n]);
- }
- // Locale-independent ASCII character classification. The <cctype>
- // counterparts (std::isalnum, std::isdigit, ...) consult the global C locale,
- // so e.g. std::isalnum(0xC5) can return true once an embedder calls
- // setlocale(). HTTP grammars are defined over ASCII, so raw bytes must be
- // classified without regard to the locale.
- inline bool is_ascii_digit(char c) { return '0' <= c && c <= '9'; }
- inline bool is_ascii_alpha(char c) {
- return ('a' <= c && c <= 'z') || ('A' <= c && c <= 'Z');
- }
- inline bool is_ascii_alnum(char c) {
- return is_ascii_digit(c) || is_ascii_alpha(c);
- }
- namespace case_ignore {
- inline unsigned char to_lower(int c) {
- const static unsigned char table[256] = {
- 0, 1, 2, 3, 4, 5, 6, 7, 8, 9, 10, 11, 12, 13, 14,
- 15, 16, 17, 18, 19, 20, 21, 22, 23, 24, 25, 26, 27, 28, 29,
- 30, 31, 32, 33, 34, 35, 36, 37, 38, 39, 40, 41, 42, 43, 44,
- 45, 46, 47, 48, 49, 50, 51, 52, 53, 54, 55, 56, 57, 58, 59,
- 60, 61, 62, 63, 64, 97, 98, 99, 100, 101, 102, 103, 104, 105, 106,
- 107, 108, 109, 110, 111, 112, 113, 114, 115, 116, 117, 118, 119, 120, 121,
- 122, 91, 92, 93, 94, 95, 96, 97, 98, 99, 100, 101, 102, 103, 104,
- 105, 106, 107, 108, 109, 110, 111, 112, 113, 114, 115, 116, 117, 118, 119,
- 120, 121, 122, 123, 124, 125, 126, 127, 128, 129, 130, 131, 132, 133, 134,
- 135, 136, 137, 138, 139, 140, 141, 142, 143, 144, 145, 146, 147, 148, 149,
- 150, 151, 152, 153, 154, 155, 156, 157, 158, 159, 160, 161, 162, 163, 164,
- 165, 166, 167, 168, 169, 170, 171, 172, 173, 174, 175, 176, 177, 178, 179,
- 180, 181, 182, 183, 184, 185, 186, 187, 188, 189, 190, 191, 224, 225, 226,
- 227, 228, 229, 230, 231, 232, 233, 234, 235, 236, 237, 238, 239, 240, 241,
- 242, 243, 244, 245, 246, 215, 248, 249, 250, 251, 252, 253, 254, 223, 224,
- 225, 226, 227, 228, 229, 230, 231, 232, 233, 234, 235, 236, 237, 238, 239,
- 240, 241, 242, 243, 244, 245, 246, 247, 248, 249, 250, 251, 252, 253, 254,
- 255,
- };
- return table[(unsigned char)(char)c];
- }
- inline std::string to_lower(const std::string &s) {
- std::string result = s;
- std::transform(
- result.begin(), result.end(), result.begin(),
- [](unsigned char c) { return static_cast<char>(to_lower(c)); });
- return result;
- }
- inline bool equal(const std::string &a, const std::string &b) {
- return a.size() == b.size() &&
- std::equal(a.begin(), a.end(), b.begin(), [](char ca, char cb) {
- return to_lower(ca) == to_lower(cb);
- });
- }
- struct equal_to {
- bool operator()(const std::string &a, const std::string &b) const {
- return equal(a, b);
- }
- };
- struct hash {
- size_t operator()(const std::string &key) const {
- return hash_core(key.data(), key.size(), 0);
- }
- size_t hash_core(const char *s, size_t l, size_t h) const {
- return (l == 0) ? h
- : hash_core(s + 1, l - 1,
- // Unsets the 6 high bits of h, therefore no
- // overflow happens
- (((std::numeric_limits<size_t>::max)() >> 6) &
- h * 33) ^
- static_cast<unsigned char>(to_lower(*s)));
- }
- };
- template <typename T>
- using unordered_set = std::unordered_set<T, detail::case_ignore::hash,
- detail::case_ignore::equal_to>;
- } // namespace case_ignore
- // This is based on
- // "http://www.open-std.org/jtc1/sc22/wg21/docs/papers/2014/n4189".
- struct scope_exit {
- explicit scope_exit(std::function<void(void)> &&f)
- : exit_function(std::move(f)), execute_on_destruction{true} {}
- scope_exit(scope_exit &&rhs) noexcept
- : exit_function(std::move(rhs.exit_function)),
- execute_on_destruction{rhs.execute_on_destruction} {
- rhs.release();
- }
- ~scope_exit() {
- if (execute_on_destruction) { this->exit_function(); }
- }
- void release() { this->execute_on_destruction = false; }
- private:
- scope_exit(const scope_exit &) = delete;
- void operator=(const scope_exit &) = delete;
- scope_exit &operator=(scope_exit &&) = delete;
- std::function<void(void)> exit_function;
- bool execute_on_destruction;
- };
- // Simple from_chars implementation for integer and double types (C++17
- // substitute)
- template <typename T> struct from_chars_result {
- const char *ptr;
- std::errc ec;
- };
- template <typename T>
- inline from_chars_result<T> from_chars(const char *first, const char *last,
- T &value, int base = 10) {
- value = 0;
- const char *p = first;
- bool negative = false;
- if (p != last && *p == '-') {
- negative = true;
- ++p;
- }
- if (p == last) { return {first, std::errc::invalid_argument}; }
- T result = 0;
- for (; p != last; ++p) {
- char c = *p;
- int digit = -1;
- if (is_ascii_digit(c)) {
- digit = c - '0';
- } else if ('a' <= c && c <= 'z') {
- digit = c - 'a' + 10;
- } else if ('A' <= c && c <= 'Z') {
- digit = c - 'A' + 10;
- } else {
- break;
- }
- if (digit < 0 || digit >= base) { break; }
- if (result > ((std::numeric_limits<T>::max)() - digit) / base) {
- return {p, std::errc::result_out_of_range};
- }
- result = result * base + digit;
- }
- if (p == first || (negative && p == first + 1)) {
- return {first, std::errc::invalid_argument};
- }
- value = negative ? T(0) - result : result;
- return {p, std::errc{}};
- }
- // from_chars for double (hand-written, locale-independent)
- //
- // The only double consumed by this library is the HTTP quality value, whose
- // grammar is (RFC 9110 12.4.2):
- // qvalue = ( "0" [ "." 0*3DIGIT ] ) / ( "1" [ "." 0*3("0") ] )
- // i.e. a non-negative decimal with no sign, exponent, "inf"/"nan", or wide
- // magnitude. So this parser recognizes exactly 1*DIGIT [ "." *DIGIT ] with
- // '.' always the decimal separator (std::strtod would instead read it from the
- // global C locale, mis-parsing q-values once an embedder calls
- // setlocale(LC_ALL, "") into a comma-decimal locale). The caller range-checks
- // the result to [0, 1], so inputs outside that range need not be distinguished
- // here. Allocation-free, single pass, and free of the overflow/rounding edge
- // cases that exponent and wide-range handling would introduce.
- inline from_chars_result<double> from_chars(const char *first, const char *last,
- double &value) {
- value = 0.0;
- const char *p = first;
- // Each 1eN is exactly representable, so a single final division by the
- // matching entry yields a correctly-rounded result.
- static const double powers_of_ten[] = {
- 1e0, 1e1, 1e2, 1e3, 1e4, 1e5, 1e6, 1e7, 1e8, 1e9,
- 1e10, 1e11, 1e12, 1e13, 1e14, 1e15, 1e16, 1e17, 1e18};
- const int max_frac_digits =
- static_cast<int>(sizeof(powers_of_ten) / sizeof(powers_of_ten[0])) - 1;
- // Accumulate digits into a 64-bit integer and remember how many were
- // fractional. Two independent caps keep this bounded and safe:
- // * accumulation saturates before mantissa could overflow uint64_t, and
- // * frac_digits is capped at max_frac_digits so it is always a valid index
- // into powers_of_ten (without this an input like "0.000...0" would never
- // grow mantissa, so the saturation cap alone would not bound it).
- // Both caps only drop digits far beyond the precision a q-value needs; any
- // value they would change is well outside [0, 1] and rejected by the caller.
- uint64_t mantissa = 0;
- int frac_digits = 0;
- bool seen_digit = false;
- const uint64_t limit = ((std::numeric_limits<uint64_t>::max)() - 9) / 10;
- auto accumulate = [&](char c) {
- if (mantissa <= limit) {
- mantissa = mantissa * 10 + static_cast<uint64_t>(c - '0');
- return true;
- }
- return false;
- };
- for (; p != last && is_ascii_digit(*p); ++p) {
- seen_digit = true;
- accumulate(*p);
- }
- if (p != last && *p == '.') {
- ++p;
- for (; p != last && is_ascii_digit(*p); ++p) {
- seen_digit = true;
- if (frac_digits < max_frac_digits && accumulate(*p)) { ++frac_digits; }
- }
- }
- if (!seen_digit) { return {first, std::errc::invalid_argument}; }
- value = static_cast<double>(mantissa) / powers_of_ten[frac_digits];
- return {p, std::errc{}};
- }
- inline bool parse_port(const char *s, size_t len, int &port) {
- int val = 0;
- auto r = from_chars(s, s + len, val);
- if (r.ec != std::errc{} || val < 1 || val > 65535) { return false; }
- port = val;
- return true;
- }
- inline bool parse_port(const std::string &s, int &port) {
- return parse_port(s.data(), s.size(), port);
- }
- struct UrlComponents {
- std::string scheme;
- std::string host;
- std::string port;
- std::string path;
- std::string query;
- };
- inline bool parse_url(const std::string &url, UrlComponents &uc) {
- uc = {};
- size_t pos = 0;
- auto sep = url.find("://");
- if (sep != std::string::npos) {
- uc.scheme = url.substr(0, sep);
- // Scheme must be [a-z]+ only
- if (uc.scheme.empty()) { return false; }
- for (auto c : uc.scheme) {
- if (c < 'a' || c > 'z') { return false; }
- }
- pos = sep + 3;
- } else if (url.compare(0, 2, "//") == 0) {
- pos = 2;
- }
- auto has_authority_prefix = pos > 0;
- auto has_authority = has_authority_prefix || (!url.empty() && url[0] != '/' &&
- url[0] != '?' && url[0] != '#');
- if (has_authority) {
- if (pos < url.size() && url[pos] == '[') {
- auto close = url.find(']', pos);
- if (close == std::string::npos) { return false; }
- uc.host = url.substr(pos + 1, close - pos - 1);
- // IPv6 host must be [a-fA-F0-9:]+ only
- if (uc.host.empty()) { return false; }
- for (auto c : uc.host) {
- if (!(is_ascii_digit(c) || (c >= 'a' && c <= 'f') ||
- (c >= 'A' && c <= 'F') || c == ':')) {
- return false;
- }
- }
- pos = close + 1;
- } else {
- auto end = url.find_first_of(":/?#", pos);
- if (end == std::string::npos) { end = url.size(); }
- uc.host = url.substr(pos, end - pos);
- pos = end;
- }
- if (pos < url.size() && url[pos] == ':') {
- ++pos;
- auto end = url.find_first_of("/?#", pos);
- if (end == std::string::npos) { end = url.size(); }
- uc.port = url.substr(pos, end - pos);
- pos = end;
- }
- // Without :// or //, the entire input must be consumed as host[:port].
- // If there is leftover (path, query, etc.), this is not a valid
- // host[:port] string — clear and reparse as a plain path.
- if (!has_authority_prefix && pos < url.size()) {
- uc.host.clear();
- uc.port.clear();
- pos = 0;
- }
- }
- if (pos < url.size() && url[pos] != '?' && url[pos] != '#') {
- auto end = url.find_first_of("?#", pos);
- if (end == std::string::npos) { end = url.size(); }
- uc.path = url.substr(pos, end - pos);
- pos = end;
- }
- if (pos < url.size() && url[pos] == '?') {
- auto end = url.find('#', pos);
- if (end == std::string::npos) { end = url.size(); }
- uc.query = url.substr(pos, end - pos);
- }
- return true;
- }
- } // namespace detail
- enum class SSLVerifierResponse {
- // no decision has been made, use the built-in certificate verifier
- NoDecisionMade,
- // connection certificate is verified and accepted
- CertificateAccepted,
- // connection certificate was processed but is rejected
- CertificateRejected
- };
- // System CA loading policy for SSL clients. Auto (the default) loads system
- // CA certs only when no custom CA is configured; enable_system_ca() switches
- // to an explicit policy.
- enum class SystemCAMode { Auto, Enabled, Disabled };
- enum StatusCode {
- // Information responses
- Continue_100 = 100,
- SwitchingProtocol_101 = 101,
- Processing_102 = 102,
- EarlyHints_103 = 103,
- // Successful responses
- OK_200 = 200,
- Created_201 = 201,
- Accepted_202 = 202,
- NonAuthoritativeInformation_203 = 203,
- NoContent_204 = 204,
- ResetContent_205 = 205,
- PartialContent_206 = 206,
- MultiStatus_207 = 207,
- AlreadyReported_208 = 208,
- IMUsed_226 = 226,
- // Redirection messages
- MultipleChoices_300 = 300,
- MovedPermanently_301 = 301,
- Found_302 = 302,
- SeeOther_303 = 303,
- NotModified_304 = 304,
- UseProxy_305 = 305,
- unused_306 = 306,
- TemporaryRedirect_307 = 307,
- PermanentRedirect_308 = 308,
- // Client error responses
- BadRequest_400 = 400,
- Unauthorized_401 = 401,
- PaymentRequired_402 = 402,
- Forbidden_403 = 403,
- NotFound_404 = 404,
- MethodNotAllowed_405 = 405,
- NotAcceptable_406 = 406,
- ProxyAuthenticationRequired_407 = 407,
- RequestTimeout_408 = 408,
- Conflict_409 = 409,
- Gone_410 = 410,
- LengthRequired_411 = 411,
- PreconditionFailed_412 = 412,
- PayloadTooLarge_413 = 413,
- UriTooLong_414 = 414,
- UnsupportedMediaType_415 = 415,
- RangeNotSatisfiable_416 = 416,
- ExpectationFailed_417 = 417,
- ImATeapot_418 = 418,
- MisdirectedRequest_421 = 421,
- UnprocessableContent_422 = 422,
- Locked_423 = 423,
- FailedDependency_424 = 424,
- TooEarly_425 = 425,
- UpgradeRequired_426 = 426,
- PreconditionRequired_428 = 428,
- TooManyRequests_429 = 429,
- RequestHeaderFieldsTooLarge_431 = 431,
- UnavailableForLegalReasons_451 = 451,
- // Server error responses
- InternalServerError_500 = 500,
- NotImplemented_501 = 501,
- BadGateway_502 = 502,
- ServiceUnavailable_503 = 503,
- GatewayTimeout_504 = 504,
- HttpVersionNotSupported_505 = 505,
- VariantAlsoNegotiates_506 = 506,
- InsufficientStorage_507 = 507,
- LoopDetected_508 = 508,
- NotExtended_510 = 510,
- NetworkAuthenticationRequired_511 = 511,
- };
- namespace detail {
- // A multimap that keeps its entries in the order they were inserted.
- //
- // HTTP needs that order in two places. RFC 9110 5.3 makes the order of header
- // fields sharing a field name significant and forbids a proxy from reordering
- // them, and a query string's parameters are meaningful in the order the caller
- // wrote them. Neither standard container expresses it: std::unordered_multimap
- // gives no ordering guarantee at all for equivalent keys (libstdc++ yields
- // reverse insertion order, libc++ insertion order), and std::multimap sorts by
- // key, which would drop control data such as Host behind whatever else the
- // message carries and alphabetise a query string.
- //
- // Entries are therefore kept in a flat vector, in order. Lookup is a linear
- // scan, which beats hashing for the handful of entries a message carries
- // (headers are capped at CPPHTTPLIB_HEADER_MAX_COUNT).
- //
- // KeyEqual compares keys; it is what makes Headers case-insensitive and
- // Params, whose parameter names are case-sensitive, not.
- template <typename Mapped, typename KeyEqual> class insertion_ordered_multimap {
- public:
- using key_type = std::string;
- using mapped_type = Mapped;
- using value_type = std::pair<std::string, Mapped>;
- using size_type = std::size_t;
- using difference_type = std::ptrdiff_t;
- using reference = value_type &;
- using const_reference = const value_type &;
- private:
- static size_type npos() { return static_cast<size_type>(-1); }
- static bool keys_equal(const std::string &a, const std::string &b) {
- return KeyEqual()(a, b);
- }
- // Iterating yields every entry in insertion order, but equal_range() and
- // find() have to walk only the entries sharing one key, which are not
- // adjacent. Both are the same iterator type: key_idx_ selects between the
- // two traversals, and since equality compares only the position, an iterator
- // restricted to one key still compares equal to end().
- template <typename V> class iterator_t {
- public:
- using iterator_category = std::bidirectional_iterator_tag;
- using value_type = insertion_ordered_multimap::value_type;
- using difference_type = insertion_ordered_multimap::difference_type;
- using pointer = V *;
- using reference = V &;
- iterator_t() : data_(nullptr), idx_(0), size_(0), key_idx_(npos()) {}
- template <typename U,
- typename std::enable_if<std::is_convertible<U *, V *>::value,
- int>::type = 0>
- iterator_t(const iterator_t<U> &rhs)
- : data_(rhs.data_), idx_(rhs.idx_), size_(rhs.size_),
- key_idx_(rhs.key_idx_) {}
- reference operator*() const { return data_[idx_]; }
- pointer operator->() const { return data_ + idx_; }
- iterator_t &operator++() {
- // Saturating, so that advancing past the last entry of a key (which
- // get_multimap_value() does when asked for an out-of-range id) stays at
- // end() instead of running off the container.
- if (idx_ >= size_) { return *this; }
- ++idx_;
- if (key_idx_ != npos()) {
- while (idx_ < size_ && !matches(idx_)) {
- ++idx_;
- }
- }
- return *this;
- }
- iterator_t operator++(int) {
- auto tmp = *this;
- ++*this;
- return tmp;
- }
- iterator_t &operator--() {
- if (idx_ == 0) { return *this; }
- --idx_;
- if (key_idx_ != npos()) {
- while (idx_ > 0 && !matches(idx_)) {
- --idx_;
- }
- }
- return *this;
- }
- iterator_t operator--(int) {
- auto tmp = *this;
- --*this;
- return tmp;
- }
- template <typename U> bool operator==(const iterator_t<U> &rhs) const {
- return idx_ == rhs.idx_;
- }
- template <typename U> bool operator!=(const iterator_t<U> &rhs) const {
- return idx_ != rhs.idx_;
- }
- private:
- friend class insertion_ordered_multimap;
- template <typename> friend class iterator_t;
- iterator_t(V *data, size_type idx, size_type size, size_type key_idx)
- : data_(data), idx_(idx), size_(size), key_idx_(key_idx) {}
- bool matches(size_type i) const {
- return keys_equal(data_[i].first, data_[key_idx_].first);
- }
- V *data_;
- size_type idx_;
- size_type size_;
- size_type key_idx_;
- };
- public:
- using iterator = iterator_t<value_type>;
- using const_iterator = iterator_t<const value_type>;
- insertion_ordered_multimap() = default;
- insertion_ordered_multimap(std::initializer_list<value_type> il)
- : entries_(il) {}
- template <typename InputIt>
- insertion_ordered_multimap(InputIt first, InputIt last)
- : entries_(first, last) {}
- iterator begin() { return make_iter(0, npos()); }
- iterator end() { return make_iter(entries_.size(), npos()); }
- const_iterator begin() const { return make_citer(0, npos()); }
- const_iterator end() const { return make_citer(entries_.size(), npos()); }
- const_iterator cbegin() const { return begin(); }
- const_iterator cend() const { return end(); }
- bool empty() const { return entries_.empty(); }
- size_type size() const { return entries_.size(); }
- void clear() { entries_.clear(); }
- void swap(insertion_ordered_multimap &rhs) { entries_.swap(rhs.entries_); }
- iterator insert(const value_type &val) {
- entries_.push_back(val);
- return make_iter(entries_.size() - 1, npos());
- }
- iterator insert(value_type &&val) {
- entries_.push_back(std::move(val));
- return make_iter(entries_.size() - 1, npos());
- }
- template <typename... Args> iterator emplace(Args &&...args) {
- entries_.emplace_back(std::forward<Args>(args)...);
- return make_iter(entries_.size() - 1, npos());
- }
- // For entries that have to lead the message, such as the Host header field
- // (RFC 9110 5.3 recommends sending control data first).
- template <typename... Args> iterator emplace_front(Args &&...args) {
- entries_.emplace(entries_.begin(), std::forward<Args>(args)...);
- return make_iter(0, npos());
- }
- iterator find(const std::string &key) {
- auto i = index_of(key);
- return i == npos() ? end() : make_iter(i, i);
- }
- const_iterator find(const std::string &key) const {
- auto i = index_of(key);
- return i == npos() ? end() : make_citer(i, i);
- }
- size_type count(const std::string &key) const {
- size_type n = 0;
- for (const auto &entry : entries_) {
- if (keys_equal(entry.first, key)) { n++; }
- }
- return n;
- }
- std::pair<iterator, iterator> equal_range(const std::string &key) {
- auto i = index_of(key);
- return i == npos() ? std::make_pair(end(), end())
- : std::make_pair(make_iter(i, i), end());
- }
- std::pair<const_iterator, const_iterator>
- equal_range(const std::string &key) const {
- auto i = index_of(key);
- return i == npos() ? std::make_pair(end(), end())
- : std::make_pair(make_citer(i, i), end());
- }
- size_type erase(const std::string &key) {
- auto before = entries_.size();
- entries_.erase(std::remove_if(entries_.begin(), entries_.end(),
- [&](const value_type &entry) {
- return keys_equal(entry.first, key);
- }),
- entries_.end());
- return before - entries_.size();
- }
- iterator erase(const_iterator pos) {
- entries_.erase(entries_.begin() + static_cast<difference_type>(pos.idx_));
- return make_iter(pos.idx_, npos());
- }
- // Erases what iterating [first, last) would actually visit, so erasing an
- // equal_range() removes only the entries with that key, not everything
- // positioned between them.
- iterator erase(const_iterator first, const_iterator last) {
- auto from = first.idx_;
- auto to = last.idx_;
- if (from >= to) { return make_iter(from, npos()); }
- auto begin_it = entries_.begin();
- auto from_it = begin_it + static_cast<difference_type>(from);
- auto to_it = begin_it + static_cast<difference_type>(to);
- if (first.key_idx_ == npos()) {
- entries_.erase(from_it, to_it);
- } else {
- auto key = entries_[first.key_idx_].first;
- auto keep = from_it;
- for (auto it = from_it; it != to_it; ++it) {
- if (!keys_equal(it->first, key)) {
- if (keep != it) { *keep = std::move(*it); }
- ++keep;
- }
- }
- if (keep != to_it) {
- keep = std::move(to_it, entries_.end(), keep);
- } else {
- keep = entries_.end();
- }
- entries_.erase(keep, entries_.end());
- }
- return make_iter(from, npos());
- }
- friend bool operator==(const insertion_ordered_multimap &lhs,
- const insertion_ordered_multimap &rhs) {
- return lhs.entries_ == rhs.entries_;
- }
- friend bool operator!=(const insertion_ordered_multimap &lhs,
- const insertion_ordered_multimap &rhs) {
- return !(lhs == rhs);
- }
- private:
- size_type index_of(const std::string &key) const {
- for (size_type i = 0; i < entries_.size(); i++) {
- if (keys_equal(entries_[i].first, key)) { return i; }
- }
- return npos();
- }
- iterator make_iter(size_type idx, size_type key_idx) {
- return iterator(entries_.data(), idx, entries_.size(), key_idx);
- }
- const_iterator make_citer(size_type idx, size_type key_idx) const {
- return const_iterator(entries_.data(), idx, entries_.size(), key_idx);
- }
- std::vector<value_type> entries_;
- };
- } // namespace detail
- using Headers =
- detail::insertion_ordered_multimap<std::string,
- detail::case_ignore::equal_to>;
- // Query parameter names are case-sensitive, unlike header field names.
- using Params =
- detail::insertion_ordered_multimap<std::string, std::equal_to<std::string>>;
- using Match = std::smatch;
- using DownloadProgress = std::function<bool(size_t current, size_t total)>;
- using UploadProgress = std::function<bool(size_t current, size_t total)>;
- /*
- * detail: type-erased storage used by UserData.
- * ABI-stable regardless of C++ standard — always uses this custom
- * implementation instead of std::any.
- */
- namespace detail {
- using any_type_id = const void *;
- template <typename T> any_type_id any_typeid() noexcept {
- static const char id = 0;
- return &id;
- }
- struct any_storage {
- virtual ~any_storage() = default;
- virtual std::unique_ptr<any_storage> clone() const = 0;
- virtual any_type_id type_id() const noexcept = 0;
- };
- template <typename T> struct any_value final : any_storage {
- T value;
- template <typename U> explicit any_value(U &&v) : value(std::forward<U>(v)) {}
- std::unique_ptr<any_storage> clone() const override {
- return std::unique_ptr<any_storage>(new any_value<T>(value));
- }
- any_type_id type_id() const noexcept override { return any_typeid<T>(); }
- };
- } // namespace detail
- class UserData {
- public:
- UserData() = default;
- UserData(UserData &&) noexcept = default;
- UserData &operator=(UserData &&) noexcept = default;
- UserData(const UserData &o) {
- for (const auto &e : o.entries_) {
- if (e.second) { entries_[e.first] = e.second->clone(); }
- }
- }
- UserData &operator=(const UserData &o) {
- if (this != &o) {
- entries_.clear();
- for (const auto &e : o.entries_) {
- if (e.second) { entries_[e.first] = e.second->clone(); }
- }
- }
- return *this;
- }
- template <typename T> void set(const std::string &key, T &&value) {
- using D = typename std::decay<T>::type;
- entries_[key].reset(new detail::any_value<D>(std::forward<T>(value)));
- }
- template <typename T> T *get(const std::string &key) noexcept {
- auto it = entries_.find(key);
- if (it == entries_.end() || !it->second) { return nullptr; }
- if (it->second->type_id() != detail::any_typeid<T>()) { return nullptr; }
- return &static_cast<detail::any_value<T> *>(it->second.get())->value;
- }
- template <typename T> const T *get(const std::string &key) const noexcept {
- auto it = entries_.find(key);
- if (it == entries_.end() || !it->second) { return nullptr; }
- if (it->second->type_id() != detail::any_typeid<T>()) { return nullptr; }
- return &static_cast<const detail::any_value<T> *>(it->second.get())->value;
- }
- bool has(const std::string &key) const noexcept {
- return entries_.find(key) != entries_.end();
- }
- void erase(const std::string &key) { entries_.erase(key); }
- void clear() noexcept { entries_.clear(); }
- private:
- std::unordered_map<std::string, std::unique_ptr<detail::any_storage>>
- entries_;
- };
- struct Response;
- using ResponseHandler = std::function<bool(const Response &response)>;
- struct FormData {
- std::string name;
- std::string content;
- std::string filename;
- std::string content_type;
- Headers headers;
- };
- struct FormField {
- std::string name;
- std::string content;
- Headers headers;
- };
- // RFC 7578 5.2: a form processor "SHOULD send back results in order" and
- // "Intermediaries MUST NOT reorder the results", so a handler walking these
- // should see the parts as they were sent. A std::multimap sorts by field name
- // and loses that. Field names are case-sensitive, hence std::equal_to rather
- // than the case-insensitive predicate Headers uses.
- using FormFields =
- detail::insertion_ordered_multimap<FormField, std::equal_to<std::string>>;
- using FormFiles =
- detail::insertion_ordered_multimap<FormData, std::equal_to<std::string>>;
- struct MultipartFormData {
- FormFields fields; // Text fields from multipart
- FormFiles files; // Files from multipart
- // Text field access
- std::string get_field(const std::string &key, size_t id = 0) const;
- std::vector<std::string> get_fields(const std::string &key) const;
- bool has_field(const std::string &key) const;
- size_t get_field_count(const std::string &key) const;
- // File access
- FormData get_file(const std::string &key, size_t id = 0) const;
- std::vector<FormData> get_files(const std::string &key) const;
- bool has_file(const std::string &key) const;
- size_t get_file_count(const std::string &key) const;
- };
- struct UploadFormData {
- std::string name;
- std::string content;
- std::string filename;
- std::string content_type;
- };
- using UploadFormDataItems = std::vector<UploadFormData>;
- class DataSink {
- public:
- DataSink() : os(&sb_), sb_(*this) {}
- DataSink(const DataSink &) = delete;
- DataSink &operator=(const DataSink &) = delete;
- DataSink(DataSink &&) = delete;
- DataSink &operator=(DataSink &&) = delete;
- std::function<bool(const char *data, size_t data_len)> write;
- std::function<bool()> is_writable;
- std::function<void()> done;
- std::function<void(const Headers &trailer)> done_with_trailer;
- std::ostream os;
- private:
- class data_sink_streambuf final : public std::streambuf {
- public:
- explicit data_sink_streambuf(DataSink &sink) : sink_(sink) {}
- protected:
- std::streamsize xsputn(const char *s, std::streamsize n) override {
- if (sink_.write(s, static_cast<size_t>(n))) { return n; }
- return 0;
- }
- private:
- DataSink &sink_;
- };
- data_sink_streambuf sb_;
- };
- using ContentProvider =
- std::function<bool(size_t offset, size_t length, DataSink &sink)>;
- using ContentProviderWithoutLength =
- std::function<bool(size_t offset, DataSink &sink)>;
- using ContentProviderResourceReleaser = std::function<void(bool success)>;
- struct FormDataProvider {
- std::string name;
- ContentProviderWithoutLength provider;
- std::string filename;
- std::string content_type;
- };
- using FormDataProviderItems = std::vector<FormDataProvider>;
- inline FormDataProvider
- make_file_provider(const std::string &name, const std::string &filepath,
- const std::string &filename = std::string(),
- const std::string &content_type = std::string()) {
- FormDataProvider fdp;
- fdp.name = name;
- fdp.filename = filename.empty() ? filepath : filename;
- fdp.content_type = content_type;
- fdp.provider = [filepath](size_t offset, DataSink &sink) -> bool {
- std::ifstream f(filepath, std::ios::binary);
- if (!f) { return false; }
- if (offset > 0) {
- f.seekg(static_cast<std::streamoff>(offset));
- if (!f.good()) {
- sink.done();
- return true;
- }
- }
- char buf[8192];
- f.read(buf, sizeof(buf));
- auto n = static_cast<size_t>(f.gcount());
- if (n > 0) { return sink.write(buf, n); }
- sink.done(); // EOF
- return true;
- };
- return fdp;
- }
- inline std::pair<size_t, ContentProvider>
- make_file_body(const std::string &filepath) {
- size_t size = 0;
- {
- std::ifstream f(filepath, std::ios::binary | std::ios::ate);
- if (!f) { return {0, ContentProvider{}}; }
- size = static_cast<size_t>(f.tellg());
- }
- ContentProvider provider = [filepath](size_t offset, size_t length,
- DataSink &sink) -> bool {
- std::ifstream f(filepath, std::ios::binary);
- if (!f) { return false; }
- f.seekg(static_cast<std::streamoff>(offset));
- if (!f.good()) { return false; }
- char buf[8192];
- while (length > 0) {
- auto to_read = (std::min)(sizeof(buf), length);
- f.read(buf, static_cast<std::streamsize>(to_read));
- auto n = static_cast<size_t>(f.gcount());
- if (n == 0) { break; }
- if (!sink.write(buf, n)) { return false; }
- length -= n;
- }
- return true;
- };
- return {size, std::move(provider)};
- }
- using ContentReceiverWithProgress = std::function<bool(
- const char *data, size_t data_length, size_t offset, size_t total_length)>;
- using ContentReceiver =
- std::function<bool(const char *data, size_t data_length)>;
- using FormDataHeader = std::function<bool(const FormData &file)>;
- class ContentReader {
- public:
- using Reader = std::function<bool(ContentReceiver receiver)>;
- using FormDataReader =
- std::function<bool(FormDataHeader header, ContentReceiver receiver)>;
- ContentReader(Reader reader, FormDataReader multipart_reader)
- : reader_(std::move(reader)),
- formdata_reader_(std::move(multipart_reader)) {}
- bool operator()(FormDataHeader header, ContentReceiver receiver) const {
- return formdata_reader_(std::move(header), std::move(receiver));
- }
- bool operator()(ContentReceiver receiver) const {
- return reader_(std::move(receiver));
- }
- Reader reader_;
- FormDataReader formdata_reader_;
- };
- using Range = std::pair<ssize_t, ssize_t>;
- using Ranges = std::vector<Range>;
- #ifdef CPPHTTPLIB_SSL_ENABLED
- // TLS abstraction layer - public type definitions and API
- namespace tls {
- // Opaque handles (defined as void* for abstraction)
- using ctx_t = void *;
- using session_t = void *;
- using const_session_t = const void *; // For read-only session access
- using cert_t = void *;
- using ca_store_t = void *;
- // TLS versions
- enum class Version {
- TLS1_2 = 0x0303,
- TLS1_3 = 0x0304,
- };
- // Subject Alternative Names (SAN) entry types
- enum class SanType { DNS, IP, EMAIL, URI, OTHER };
- // SAN entry structure
- struct SanEntry {
- SanType type;
- std::string value;
- };
- // Verification context for certificate verification callback
- struct VerifyContext {
- session_t session; // TLS session handle
- cert_t cert; // Current certificate being verified
- int depth; // Certificate chain depth (0 = leaf)
- bool preverify_ok; // OpenSSL/Mbed TLS pre-verification result
- long error_code; // Backend-specific error code (0 = no error)
- const char *error_string; // Human-readable error description
- // Certificate introspection methods
- std::string subject_cn() const;
- std::string issuer_name() const;
- bool check_hostname(const char *hostname) const;
- std::vector<SanEntry> sans() const;
- bool validity(time_t ¬_before, time_t ¬_after) const;
- std::string serial() const;
- };
- using VerifyCallback = std::function<bool(const VerifyContext &ctx)>;
- // TlsError codes for TLS operations (backend-independent)
- enum class ErrorCode : int {
- Success = 0,
- WantRead, // Non-blocking: need to wait for read
- WantWrite, // Non-blocking: need to wait for write
- PeerClosed, // Peer closed the connection
- Fatal, // Unrecoverable error
- SyscallError, // System call error (check sys_errno)
- CertVerifyFailed, // Certificate verification failed
- HostnameMismatch, // Hostname verification failed
- };
- // TLS error information
- struct TlsError {
- ErrorCode code = ErrorCode::Fatal;
- uint64_t backend_code = 0; // OpenSSL: ERR_get_error(), mbedTLS: return value
- int sys_errno = 0; // errno when SyscallError
- // Convert verification error code to human-readable string
- static std::string verify_error_to_string(long error_code);
- };
- // RAII wrapper for peer certificate
- class PeerCert {
- public:
- PeerCert();
- PeerCert(PeerCert &&other) noexcept;
- PeerCert &operator=(PeerCert &&other) noexcept;
- ~PeerCert();
- PeerCert(const PeerCert &) = delete;
- PeerCert &operator=(const PeerCert &) = delete;
- explicit operator bool() const;
- std::string subject_cn() const;
- std::string issuer_name() const;
- bool check_hostname(const char *hostname) const;
- std::vector<SanEntry> sans() const;
- bool validity(time_t ¬_before, time_t ¬_after) const;
- std::string serial() const;
- private:
- explicit PeerCert(cert_t cert);
- cert_t cert_ = nullptr;
- friend PeerCert get_peer_cert_from_session(const_session_t session);
- };
- // Callback for TLS context setup (used by SSLServer constructor)
- using ContextSetupCallback = std::function<bool(ctx_t ctx)>;
- } // namespace tls
- #endif
- struct Request {
- std::string method;
- std::string path;
- std::string matched_route;
- Params params;
- Headers headers;
- Headers trailers;
- std::string body;
- std::string remote_addr;
- int remote_port = -1;
- std::string local_addr;
- int local_port = -1;
- // for server
- std::string version;
- std::string target;
- MultipartFormData form;
- Ranges ranges;
- Match matches;
- std::unordered_map<std::string, std::string> path_params;
- std::function<bool()> is_connection_closed = []() { return true; };
- // for client
- std::vector<std::string> accept_content_types;
- ResponseHandler response_handler;
- ContentReceiverWithProgress content_receiver;
- DownloadProgress download_progress;
- UploadProgress upload_progress;
- bool has_header(const std::string &key) const;
- std::string get_header_value(const std::string &key, const char *def = "",
- size_t id = 0) const;
- size_t get_header_value_u64(const std::string &key, size_t def = 0,
- size_t id = 0) const;
- size_t get_header_value_count(const std::string &key) const;
- void set_header(const std::string &key, const std::string &val);
- bool has_trailer(const std::string &key) const;
- std::string get_trailer_value(const std::string &key, size_t id = 0) const;
- size_t get_trailer_value_count(const std::string &key) const;
- bool has_param(const std::string &key) const;
- std::string get_param_value(const std::string &key, size_t id = 0) const;
- std::vector<std::string> get_param_values(const std::string &key) const;
- size_t get_param_value_count(const std::string &key) const;
- bool is_multipart_form_data() const;
- // private members...
- bool body_consumed_ = false;
- size_t redirect_count_ = CPPHTTPLIB_REDIRECT_MAX_COUNT;
- size_t content_length_ = 0;
- ContentProvider content_provider_;
- bool is_chunked_content_provider_ = false;
- size_t authorization_count_ = 0;
- std::chrono::time_point<std::chrono::steady_clock> start_time_ =
- (std::chrono::steady_clock::time_point::min)();
- #ifdef CPPHTTPLIB_SSL_ENABLED
- tls::const_session_t ssl = nullptr;
- tls::PeerCert peer_cert() const;
- std::string sni() const;
- #endif
- };
- struct Response {
- std::string version;
- int status = -1;
- std::string reason;
- Headers headers;
- Headers trailers;
- std::string body;
- std::string location; // Redirect location
- // User-defined context — set by pre-routing/pre-request handlers and read
- // by route handlers to pass arbitrary data (e.g. decoded auth tokens).
- UserData user_data;
- bool has_header(const std::string &key) const;
- std::string get_header_value(const std::string &key, const char *def = "",
- size_t id = 0) const;
- size_t get_header_value_u64(const std::string &key, size_t def = 0,
- size_t id = 0) const;
- size_t get_header_value_count(const std::string &key) const;
- void set_header(const std::string &key, const std::string &val);
- bool has_trailer(const std::string &key) const;
- std::string get_trailer_value(const std::string &key, size_t id = 0) const;
- size_t get_trailer_value_count(const std::string &key) const;
- void set_redirect(const std::string &url, int status = StatusCode::Found_302);
- void set_content(const char *s, size_t n, const std::string &content_type);
- void set_content(const std::string &s, const std::string &content_type);
- void set_content(std::string &&s, const std::string &content_type);
- void set_content_provider(
- size_t length, const std::string &content_type, ContentProvider provider,
- ContentProviderResourceReleaser resource_releaser = nullptr);
- void set_content_provider(
- const std::string &content_type, ContentProviderWithoutLength provider,
- ContentProviderResourceReleaser resource_releaser = nullptr);
- void set_chunked_content_provider(
- const std::string &content_type, ContentProviderWithoutLength provider,
- ContentProviderResourceReleaser resource_releaser = nullptr);
- void set_file_content(const std::string &path,
- const std::string &content_type);
- void set_file_content(const std::string &path);
- Response() = default;
- Response(const Response &) = default;
- Response &operator=(const Response &) = default;
- Response(Response &&) = default;
- Response &operator=(Response &&) = default;
- ~Response() {
- if (content_provider_resource_releaser_) {
- content_provider_resource_releaser_(content_provider_success_);
- }
- }
- // private members...
- size_t content_length_ = 0;
- ContentProvider content_provider_;
- ContentProviderResourceReleaser content_provider_resource_releaser_;
- bool is_chunked_content_provider_ = false;
- bool content_provider_success_ = false;
- std::string file_content_path_;
- std::string file_content_content_type_;
- };
- enum class Error {
- Success = 0,
- Unknown,
- Connection,
- BindIPAddress,
- Read,
- Write,
- ExceedRedirectCount,
- Canceled,
- SSLConnection,
- SSLLoadingCerts,
- SSLServerVerification,
- SSLServerHostnameVerification,
- UnsupportedMultipartBoundaryChars,
- Compression,
- ConnectionTimeout,
- ProxyConnection,
- ConnectionClosed,
- Timeout,
- ResourceExhaustion,
- TooManyFormDataFiles,
- ExceedMaxPayloadSize,
- ExceedUriMaxLength,
- ExceedMaxSocketDescriptorCount,
- InvalidRequestLine,
- InvalidHTTPMethod,
- InvalidHTTPVersion,
- InvalidHeaders,
- MultipartParsing,
- OpenFile,
- Listen,
- GetSockName,
- UnsupportedAddressFamily,
- HTTPParsing,
- InvalidRangeHeader,
- UnsupportedContentEncoding,
- WebSocketHandshake,
- // For internal use only
- SSLPeerCouldBeClosed_,
- };
- std::string to_string(Error error);
- std::ostream &operator<<(std::ostream &os, const Error &obj);
- class Stream {
- public:
- virtual ~Stream() = default;
- virtual bool is_readable() const = 0;
- virtual bool wait_readable() const = 0;
- virtual bool wait_writable() const = 0;
- virtual bool is_peer_alive() const { return wait_writable(); }
- virtual ssize_t read(char *ptr, size_t size) = 0;
- virtual ssize_t write(const char *ptr, size_t size) = 0;
- virtual void get_remote_ip_and_port(std::string &ip, int &port) const = 0;
- virtual void get_local_ip_and_port(std::string &ip, int &port) const = 0;
- virtual socket_t socket() const = 0;
- virtual time_t duration() const = 0;
- virtual void set_read_timeout(time_t sec, time_t usec = 0) {
- (void)sec;
- (void)usec;
- }
- // Bytes already pulled off the socket and sitting in this stream's own
- // buffer. Exposing them lets a line reader scan for a terminator in one
- // pass instead of asking for a byte at a time. A stream that does no
- // buffering of its own reports none, and readers fall back to read().
- virtual const char *buffered_data(size_t &size) const {
- size = 0;
- return nullptr;
- }
- // Discards `size` bytes previously returned by buffered_data().
- virtual void consume_buffered(size_t size) { (void)size; }
- ssize_t write(const char *ptr);
- ssize_t write(const std::string &s);
- Error get_error() const { return error_; }
- protected:
- Error error_ = Error::Success;
- };
- class TaskQueue {
- public:
- TaskQueue() = default;
- virtual ~TaskQueue() = default;
- virtual bool enqueue(std::function<void()> fn) = 0;
- virtual void shutdown() = 0;
- virtual void on_idle() {}
- };
- class ThreadPool final : public TaskQueue {
- public:
- explicit ThreadPool(
- size_t n, size_t max_n = 0, size_t mqr = 0,
- time_t idle_timeout_sec = CPPHTTPLIB_THREAD_POOL_IDLE_TIMEOUT);
- ThreadPool(const ThreadPool &) = delete;
- ~ThreadPool() override = default;
- bool enqueue(std::function<void()> fn) override;
- void shutdown() override;
- private:
- void worker(bool is_dynamic);
- void move_to_finished(std::thread::id id);
- void cleanup_finished_threads();
- size_t base_thread_count_;
- size_t max_thread_count_;
- size_t max_queued_requests_;
- time_t idle_timeout_sec_;
- size_t idle_thread_count_;
- bool shutdown_;
- std::list<std::function<void()>> jobs_;
- std::vector<std::thread> threads_; // base threads
- std::list<std::thread> dynamic_threads_; // dynamic threads
- std::vector<std::thread>
- finished_threads_; // exited dynamic threads awaiting join
- std::condition_variable cond_;
- std::mutex mutex_;
- };
- using Logger = std::function<void(const Request &, const Response &)>;
- // Forward declaration for Error type
- enum class Error;
- using ErrorLogger = std::function<void(const Error &, const Request *)>;
- using SocketOptions = std::function<void(socket_t sock)>;
- void default_socket_options(socket_t sock);
- bool set_socket_opt(socket_t sock, int level, int optname, int optval);
- const char *status_message(int status);
- std::string to_string(Error error);
- std::ostream &operator<<(std::ostream &os, const Error &obj);
- std::string get_bearer_token_auth(const Request &req);
- namespace detail {
- class MatcherBase {
- public:
- MatcherBase(std::string pattern) : pattern_(std::move(pattern)) {}
- virtual ~MatcherBase() = default;
- const std::string &pattern() const { return pattern_; }
- // Match request path and populate its matches and
- virtual bool match(Request &request) const = 0;
- private:
- std::string pattern_;
- };
- /**
- * Captures parameters in request path and stores them in Request::path_params
- *
- * Capture name is a substring of a pattern from : to /.
- * The rest of the pattern is matched against the request path directly
- * Parameters are captured starting from the next character after
- * the end of the last matched static pattern fragment until the next /.
- *
- * Example pattern:
- * "/path/fragments/:capture/more/fragments/:second_capture"
- * Static fragments:
- * "/path/fragments/", "more/fragments/"
- *
- * Given the following request path:
- * "/path/fragments/:1/more/fragments/:2"
- * the resulting capture will be
- * {{"capture", "1"}, {"second_capture", "2"}}
- */
- class PathParamsMatcher final : public MatcherBase {
- public:
- PathParamsMatcher(const std::string &pattern);
- bool match(Request &request) const override;
- private:
- // Treat segment separators as the end of path parameter capture
- // Does not need to handle query parameters as they are parsed before path
- // matching
- static constexpr char separator = '/';
- // Contains static path fragments to match against, excluding the '/' after
- // path params
- // Fragments are separated by path params
- std::vector<std::string> static_fragments_;
- // Stores the names of the path parameters to be used as keys in the
- // Request::path_params map
- std::vector<std::string> param_names_;
- };
- /**
- * Performs std::regex_match on request path
- * and stores the result in Request::matches
- *
- * Note that regex match is performed directly on the whole request.
- * This means that wildcard patterns may match multiple path segments with /:
- * "/begin/(.*)/end" will match both "/begin/middle/end" and "/begin/1/2/end".
- */
- class RegexMatcher final : public MatcherBase {
- public:
- RegexMatcher(const std::string &pattern)
- : MatcherBase(pattern), regex_(pattern) {}
- bool match(Request &request) const override;
- private:
- std::regex regex_;
- };
- int close_socket(socket_t sock) noexcept;
- ssize_t write_headers(Stream &strm, const Headers &headers);
- bool set_socket_opt_time(socket_t sock, int level, int optname, time_t sec,
- time_t usec);
- size_t get_multipart_content_length(const UploadFormDataItems &items,
- const std::string &boundary);
- ContentProvider
- make_multipart_content_provider(const UploadFormDataItems &items,
- const std::string &boundary);
- } // namespace detail
- bool is_valid_multipart_boundary(const std::string &boundary);
- // Serializer for multipart/form-data request bodies. The boundary is owned
- // by the writer so that per-part framing and the final terminator always
- // agree. Field names and filenames are escaped following the WHATWG HTML
- // standard ('"' -> %22, CR -> %0D, LF -> %0A); CR and LF are also escaped
- // in content types.
- class MultipartFormDataWriter {
- public:
- MultipartFormDataWriter();
- // precondition: is_valid_multipart_boundary(boundary)
- explicit MultipartFormDataWriter(std::string boundary);
- const std::string &boundary() const;
- std::string content_type() const;
- // In-memory items -> whole body (known length)
- std::string serialize(const UploadFormDataItems &items) const;
- size_t content_length(const UploadFormDataItems &items) const;
- // Per-part framing for streaming via a content provider
- std::string item_begin(const UploadFormData &item) const;
- static std::string item_end();
- std::string finish() const;
- private:
- std::string boundary_;
- };
- class Server {
- public:
- using Handler = std::function<void(const Request &, Response &)>;
- using ExceptionHandler =
- std::function<void(const Request &, Response &, std::exception_ptr ep)>;
- enum class HandlerResponse {
- Handled,
- Unhandled,
- };
- using HandlerWithResponse =
- std::function<HandlerResponse(const Request &, Response &)>;
- using HandlerWithContentReader = std::function<void(
- const Request &, Response &, const ContentReader &content_reader)>;
- using Expect100ContinueHandler =
- std::function<int(const Request &, Response &)>;
- using StartHandler = std::function<void()>;
- using WebSocketHandler =
- std::function<void(const Request &, ws::WebSocket &)>;
- using SubProtocolSelector =
- std::function<std::string(const std::vector<std::string> &protocols)>;
- Server();
- virtual ~Server();
- virtual bool is_valid() const;
- Server &Get(const std::string &pattern, Handler handler);
- Server &Post(const std::string &pattern, Handler handler);
- Server &Post(const std::string &pattern, HandlerWithContentReader handler);
- Server &Put(const std::string &pattern, Handler handler);
- Server &Put(const std::string &pattern, HandlerWithContentReader handler);
- Server &Patch(const std::string &pattern, Handler handler);
- Server &Patch(const std::string &pattern, HandlerWithContentReader handler);
- Server &Delete(const std::string &pattern, Handler handler);
- Server &Delete(const std::string &pattern, HandlerWithContentReader handler);
- Server &Options(const std::string &pattern, Handler handler);
- Server &WebSocket(const std::string &pattern, WebSocketHandler handler);
- Server &WebSocket(const std::string &pattern, WebSocketHandler handler,
- SubProtocolSelector sub_protocol_selector);
- bool set_base_dir(const std::string &dir,
- const std::string &mount_point = std::string());
- bool set_mount_point(const std::string &mount_point, const std::string &dir,
- Headers headers = Headers());
- bool remove_mount_point(const std::string &mount_point);
- Server &set_file_extension_and_mimetype_mapping(const std::string &ext,
- const std::string &mime);
- Server &set_default_file_mimetype(const std::string &mime);
- Server &set_file_request_handler(Handler handler);
- template <class ErrorHandlerFunc>
- Server &set_error_handler(ErrorHandlerFunc &&handler) {
- return set_error_handler_core(
- std::forward<ErrorHandlerFunc>(handler),
- std::is_convertible<ErrorHandlerFunc, HandlerWithResponse>{});
- }
- Server &set_exception_handler(ExceptionHandler handler);
- Server &set_pre_routing_handler(HandlerWithResponse handler);
- Server &set_post_routing_handler(Handler handler);
- Server &set_pre_request_handler(HandlerWithResponse handler);
- Server &set_expect_100_continue_handler(Expect100ContinueHandler handler);
- Server &set_start_handler(StartHandler handler);
- Server &set_logger(Logger logger);
- Server &set_pre_compression_logger(Logger logger);
- Server &set_error_logger(ErrorLogger error_logger);
- Server &set_address_family(int family);
- Server &set_tcp_nodelay(bool on);
- Server &set_ipv6_v6only(bool on);
- Server &set_socket_options(SocketOptions socket_options);
- Server &set_default_headers(Headers headers);
- Server &
- set_header_writer(std::function<ssize_t(Stream &, Headers &)> const &writer);
- Server &set_trusted_proxies(const std::vector<std::string> &proxies);
- Server &set_keep_alive_max_count(size_t count);
- Server &set_keep_alive_timeout(time_t sec);
- template <class Rep, class Period>
- Server &
- set_keep_alive_timeout(const std::chrono::duration<Rep, Period> &duration);
- Server &set_read_timeout(time_t sec, time_t usec = 0);
- template <class Rep, class Period>
- Server &set_read_timeout(const std::chrono::duration<Rep, Period> &duration);
- Server &set_write_timeout(time_t sec, time_t usec = 0);
- template <class Rep, class Period>
- Server &set_write_timeout(const std::chrono::duration<Rep, Period> &duration);
- Server &set_idle_interval(time_t sec, time_t usec = 0);
- template <class Rep, class Period>
- Server &set_idle_interval(const std::chrono::duration<Rep, Period> &duration);
- Server &set_payload_max_length(size_t length);
- Server &set_websocket_ping_interval(time_t sec);
- template <class Rep, class Period>
- Server &set_websocket_ping_interval(
- const std::chrono::duration<Rep, Period> &duration);
- Server &set_websocket_max_missed_pongs(int count);
- bool bind_to_port(const std::string &host, int port, int socket_flags = 0);
- int bind_to_any_port(const std::string &host, int socket_flags = 0);
- bool listen_after_bind();
- bool listen(const std::string &host, int port, int socket_flags = 0);
- bool is_running() const;
- void wait_until_ready() const;
- void stop() noexcept;
- void decommission();
- std::function<TaskQueue *(void)> new_task_queue;
- protected:
- bool process_request(Stream &strm, const std::string &remote_addr,
- int remote_port, const std::string &local_addr,
- int local_port, bool close_connection,
- bool &connection_closed,
- const std::function<void(Request &)> &setup_request,
- bool *websocket_upgraded = nullptr);
- std::atomic<socket_t> svr_sock_{INVALID_SOCKET};
- std::vector<std::string> trusted_proxies_;
- size_t keep_alive_max_count_ = CPPHTTPLIB_KEEPALIVE_MAX_COUNT;
- time_t keep_alive_timeout_sec_ = CPPHTTPLIB_KEEPALIVE_TIMEOUT_SECOND;
- time_t read_timeout_sec_ = CPPHTTPLIB_SERVER_READ_TIMEOUT_SECOND;
- time_t read_timeout_usec_ = CPPHTTPLIB_SERVER_READ_TIMEOUT_USECOND;
- time_t write_timeout_sec_ = CPPHTTPLIB_SERVER_WRITE_TIMEOUT_SECOND;
- time_t write_timeout_usec_ = CPPHTTPLIB_SERVER_WRITE_TIMEOUT_USECOND;
- time_t idle_interval_sec_ = CPPHTTPLIB_IDLE_INTERVAL_SECOND;
- time_t idle_interval_usec_ = CPPHTTPLIB_IDLE_INTERVAL_USECOND;
- size_t payload_max_length_ = CPPHTTPLIB_PAYLOAD_MAX_LENGTH;
- time_t websocket_ping_interval_sec_ =
- CPPHTTPLIB_WEBSOCKET_PING_INTERVAL_SECOND;
- int websocket_max_missed_pongs_ = CPPHTTPLIB_WEBSOCKET_MAX_MISSED_PONGS;
- private:
- using Handlers =
- std::vector<std::pair<std::unique_ptr<detail::MatcherBase>, Handler>>;
- using HandlersForContentReader =
- std::vector<std::pair<std::unique_ptr<detail::MatcherBase>,
- HandlerWithContentReader>>;
- static std::unique_ptr<detail::MatcherBase>
- make_matcher(const std::string &pattern);
- template <typename H>
- Server &add_handler(
- std::vector<std::pair<std::unique_ptr<detail::MatcherBase>, H>> &handlers,
- const std::string &pattern, H handler) {
- handlers.emplace_back(make_matcher(pattern), std::move(handler));
- return *this;
- }
- Server &set_error_handler_core(HandlerWithResponse handler, std::true_type);
- Server &set_error_handler_core(Handler handler, std::false_type);
- socket_t create_server_socket(const std::string &host, int port,
- int socket_flags,
- SocketOptions socket_options) const;
- int bind_internal(const std::string &host, int port, int socket_flags);
- bool listen_internal();
- bool routing(Request &req, Response &res, Stream &strm);
- bool handle_file_request(Request &req, Response &res);
- bool check_if_not_modified(const Request &req, Response &res,
- const std::string &etag, time_t mtime) const;
- bool check_if_range(Request &req, const std::string &etag,
- time_t mtime) const;
- bool dispatch_request(Request &req, Response &res, const Handlers &handlers,
- Stream &strm);
- bool dispatch_request_for_content_reader(
- Request &req, Response &res, ContentReader content_reader,
- const HandlersForContentReader &handlers) const;
- bool parse_request_line(const char *s, Request &req) const;
- void apply_ranges(const Request &req, Response &res,
- std::string &content_type, std::string &boundary) const;
- bool write_response(Stream &strm, bool close_connection, Request &req,
- Response &res);
- bool write_response_with_content(Stream &strm, bool close_connection,
- const Request &req, Response &res);
- bool write_response_core(Stream &strm, bool close_connection,
- const Request &req, Response &res,
- bool need_apply_ranges);
- bool write_content_with_provider(Stream &strm, const Request &req,
- Response &res, const std::string &boundary,
- const std::string &content_type);
- bool read_content(Stream &strm, Request &req, Response &res);
- bool read_content_with_content_receiver(Stream &strm, Request &req,
- Response &res,
- ContentReceiver receiver,
- FormDataHeader multipart_header,
- ContentReceiver multipart_receiver);
- bool read_content_core(Stream &strm, Request &req, Response &res,
- ContentReceiver receiver,
- FormDataHeader multipart_header,
- ContentReceiver multipart_receiver) const;
- virtual bool process_and_close_socket(socket_t sock);
- void output_log(const Request &req, const Response &res) const;
- void output_pre_compression_log(const Request &req,
- const Response &res) const;
- void output_error_log(const Error &err, const Request *req) const;
- std::atomic<bool> is_running_{false};
- std::atomic<bool> is_decommissioned{false};
- struct MountPointEntry {
- std::string mount_point;
- std::string base_dir;
- std::string resolved_base_dir;
- Headers headers;
- };
- std::vector<MountPointEntry> base_dirs_;
- std::map<std::string, std::string> file_extension_and_mimetype_map_;
- std::string default_file_mimetype_ = "application/octet-stream";
- Handler file_request_handler_;
- Handlers get_handlers_;
- Handlers post_handlers_;
- HandlersForContentReader post_handlers_for_content_reader_;
- Handlers put_handlers_;
- HandlersForContentReader put_handlers_for_content_reader_;
- Handlers patch_handlers_;
- HandlersForContentReader patch_handlers_for_content_reader_;
- Handlers delete_handlers_;
- HandlersForContentReader delete_handlers_for_content_reader_;
- Handlers options_handlers_;
- struct WebSocketHandlerEntry {
- std::unique_ptr<detail::MatcherBase> matcher;
- WebSocketHandler handler;
- SubProtocolSelector sub_protocol_selector;
- };
- using WebSocketHandlers = std::vector<WebSocketHandlerEntry>;
- WebSocketHandlers websocket_handlers_;
- HandlerWithResponse error_handler_;
- ExceptionHandler exception_handler_;
- HandlerWithResponse pre_routing_handler_;
- Handler post_routing_handler_;
- HandlerWithResponse pre_request_handler_;
- Expect100ContinueHandler expect_100_continue_handler_;
- StartHandler start_handler_;
- mutable std::mutex logger_mutex_;
- Logger logger_;
- Logger pre_compression_logger_;
- ErrorLogger error_logger_;
- int address_family_ = AF_UNSPEC;
- bool tcp_nodelay_ = CPPHTTPLIB_TCP_NODELAY;
- bool ipv6_v6only_ = CPPHTTPLIB_IPV6_V6ONLY;
- SocketOptions socket_options_ = default_socket_options;
- Headers default_headers_;
- std::function<ssize_t(Stream &, Headers &)> header_writer_ =
- detail::write_headers;
- };
- class Result {
- public:
- Result() = default;
- Result(std::unique_ptr<Response> &&res, Error err,
- Headers &&request_headers = Headers{})
- : res_(std::move(res)), err_(err),
- request_headers_(std::move(request_headers)) {}
- // Response
- operator bool() const { return res_ != nullptr; }
- bool operator==(std::nullptr_t) const { return res_ == nullptr; }
- bool operator!=(std::nullptr_t) const { return res_ != nullptr; }
- const Response &value() const { return *res_; }
- Response &value() { return *res_; }
- const Response &operator*() const { return *res_; }
- Response &operator*() { return *res_; }
- const Response *operator->() const { return res_.get(); }
- Response *operator->() { return res_.get(); }
- // Error
- Error error() const { return err_; }
- // Request Headers
- bool has_request_header(const std::string &key) const;
- std::string get_request_header_value(const std::string &key,
- const char *def = "",
- size_t id = 0) const;
- size_t get_request_header_value_u64(const std::string &key, size_t def = 0,
- size_t id = 0) const;
- size_t get_request_header_value_count(const std::string &key) const;
- private:
- std::unique_ptr<Response> res_;
- Error err_ = Error::Unknown;
- Headers request_headers_;
- #ifdef CPPHTTPLIB_SSL_ENABLED
- public:
- Result(std::unique_ptr<Response> &&res, Error err, Headers &&request_headers,
- int ssl_error)
- : res_(std::move(res)), err_(err),
- request_headers_(std::move(request_headers)), ssl_error_(ssl_error) {}
- Result(std::unique_ptr<Response> &&res, Error err, Headers &&request_headers,
- int ssl_error, uint64_t ssl_backend_error)
- : res_(std::move(res)), err_(err),
- request_headers_(std::move(request_headers)), ssl_error_(ssl_error),
- ssl_backend_error_(ssl_backend_error) {}
- int ssl_error() const { return ssl_error_; }
- uint64_t ssl_backend_error() const { return ssl_backend_error_; }
- private:
- int ssl_error_ = 0;
- uint64_t ssl_backend_error_ = 0;
- #endif
- };
- struct ClientConnection {
- socket_t sock = INVALID_SOCKET;
- bool is_open() const { return sock != INVALID_SOCKET; }
- ClientConnection() = default;
- ~ClientConnection();
- ClientConnection(const ClientConnection &) = delete;
- ClientConnection &operator=(const ClientConnection &) = delete;
- ClientConnection(ClientConnection &&other) noexcept
- : sock(other.sock)
- #ifdef CPPHTTPLIB_SSL_ENABLED
- ,
- session(other.session)
- #endif
- {
- other.sock = INVALID_SOCKET;
- #ifdef CPPHTTPLIB_SSL_ENABLED
- other.session = nullptr;
- #endif
- }
- ClientConnection &operator=(ClientConnection &&other) noexcept {
- if (this != &other) {
- sock = other.sock;
- other.sock = INVALID_SOCKET;
- #ifdef CPPHTTPLIB_SSL_ENABLED
- session = other.session;
- other.session = nullptr;
- #endif
- }
- return *this;
- }
- #ifdef CPPHTTPLIB_SSL_ENABLED
- tls::session_t session = nullptr;
- #endif
- };
- namespace detail {
- struct ChunkedDecoder;
- struct BodyReader {
- Stream *stream = nullptr;
- bool has_content_length = false;
- size_t content_length = 0;
- size_t payload_max_length = CPPHTTPLIB_PAYLOAD_MAX_LENGTH;
- size_t bytes_read = 0;
- bool chunked = false;
- bool eof = false;
- std::unique_ptr<ChunkedDecoder> chunked_decoder;
- Error last_error = Error::Success;
- ssize_t read(char *buf, size_t len);
- bool has_error() const { return last_error != Error::Success; }
- };
- inline ssize_t read_body_content(Stream *stream, BodyReader &br, char *buf,
- size_t len) {
- (void)stream;
- return br.read(buf, len);
- }
- class decompressor;
- enum class NoProxyKind {
- Wildcard, // "*"
- HostnameSuffix, // "example.com" or ".example.com"
- IPv4Cidr, // "10.0.0.0/8" (or single IP, treated as /32)
- IPv6Cidr, // "fe80::/10" (or single IP, treated as /128)
- };
- // Unified 16-byte buffer holding either a v4 (first 4 bytes) or v6 address.
- // Lets one CIDR matcher cover both families.
- using IPBytes = std::array<uint8_t, 16>;
- struct NoProxyEntry {
- NoProxyKind kind = NoProxyKind::Wildcard;
- std::string hostname_pattern; // lowercased, leading/trailing dot stripped
- IPBytes net{};
- int prefix_bits = 0;
- };
- struct NormalizedTarget {
- std::string hostname; // lowercase; brackets and trailing dot removed
- bool is_ipv4 = false;
- bool is_ipv6 = false;
- IPBytes ip{};
- };
- } // namespace detail
- class ClientImpl {
- public:
- explicit ClientImpl(const std::string &host);
- explicit ClientImpl(const std::string &host, int port);
- explicit ClientImpl(const std::string &host, int port,
- const std::string &client_cert_path,
- const std::string &client_key_path);
- virtual ~ClientImpl();
- virtual bool is_valid() const;
- struct StreamHandle {
- std::unique_ptr<Response> response;
- Error error = Error::Success;
- StreamHandle() = default;
- StreamHandle(const StreamHandle &) = delete;
- StreamHandle &operator=(const StreamHandle &) = delete;
- StreamHandle(StreamHandle &&) = default;
- StreamHandle &operator=(StreamHandle &&) = default;
- ~StreamHandle() = default;
- bool is_valid() const {
- return response != nullptr && error == Error::Success;
- }
- ssize_t read(char *buf, size_t len);
- void parse_trailers_if_needed();
- Error get_read_error() const { return body_reader_.last_error; }
- bool has_read_error() const { return body_reader_.has_error(); }
- bool trailers_parsed_ = false;
- private:
- friend class ClientImpl;
- ssize_t read_with_decompression(char *buf, size_t len);
- std::unique_ptr<ClientConnection> connection_;
- std::unique_ptr<Stream> socket_stream_;
- Stream *stream_ = nullptr;
- detail::BodyReader body_reader_;
- std::unique_ptr<detail::decompressor> decompressor_;
- std::string decompress_buffer_;
- size_t decompress_offset_ = 0;
- size_t decompressed_bytes_read_ = 0;
- };
- // clang-format off
- Result Get(const std::string &path, DownloadProgress progress = nullptr);
- Result Get(const std::string &path, ContentReceiver content_receiver, DownloadProgress progress = nullptr);
- Result Get(const std::string &path, ResponseHandler response_handler, ContentReceiver content_receiver, DownloadProgress progress = nullptr);
- Result Get(const std::string &path, const Headers &headers, DownloadProgress progress = nullptr);
- Result Get(const std::string &path, const Headers &headers, ContentReceiver content_receiver, DownloadProgress progress = nullptr);
- Result Get(const std::string &path, const Headers &headers, ResponseHandler response_handler, ContentReceiver content_receiver, DownloadProgress progress = nullptr);
- Result Get(const std::string &path, const Params ¶ms, DownloadProgress progress = nullptr);
- Result Get(const std::string &path, const Params ¶ms, const Headers &headers, DownloadProgress progress = nullptr);
- Result Get(const std::string &path, const Params ¶ms, const Headers &headers, ContentReceiver content_receiver, DownloadProgress progress = nullptr);
- Result Get(const std::string &path, const Params ¶ms, const Headers &headers, ResponseHandler response_handler, ContentReceiver content_receiver, DownloadProgress progress = nullptr);
- Result Head(const std::string &path);
- Result Head(const std::string &path, const Headers &headers);
- Result Post(const std::string &path);
- Result Post(const std::string &path, const char *body, size_t content_length, const std::string &content_type, UploadProgress progress = nullptr);
- Result Post(const std::string &path, const std::string &body, const std::string &content_type, UploadProgress progress = nullptr);
- Result Post(const std::string &path, size_t content_length, ContentProvider content_provider, const std::string &content_type, UploadProgress progress = nullptr);
- Result Post(const std::string &path, size_t content_length, ContentProvider content_provider, const std::string &content_type, ContentReceiver content_receiver, UploadProgress progress = nullptr);
- Result Post(const std::string &path, ContentProviderWithoutLength content_provider, const std::string &content_type, UploadProgress progress = nullptr);
- Result Post(const std::string &path, ContentProviderWithoutLength content_provider, const std::string &content_type, ContentReceiver content_receiver, UploadProgress progress = nullptr);
- Result Post(const std::string &path, const Params ¶ms);
- Result Post(const std::string &path, const UploadFormDataItems &items, UploadProgress progress = nullptr);
- Result Post(const std::string &path, const Headers &headers);
- Result Post(const std::string &path, const Headers &headers, const char *body, size_t content_length, const std::string &content_type, UploadProgress progress = nullptr);
- Result Post(const std::string &path, const Headers &headers, const std::string &body, const std::string &content_type, UploadProgress progress = nullptr);
- Result Post(const std::string &path, const Headers &headers, size_t content_length, ContentProvider content_provider, const std::string &content_type, UploadProgress progress = nullptr);
- 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);
- Result Post(const std::string &path, const Headers &headers, ContentProviderWithoutLength content_provider, const std::string &content_type, UploadProgress progress = nullptr);
- Result Post(const std::string &path, const Headers &headers, ContentProviderWithoutLength content_provider, const std::string &content_type, ContentReceiver content_receiver, DownloadProgress progress = nullptr);
- Result Post(const std::string &path, const Headers &headers, const Params ¶ms);
- Result Post(const std::string &path, const Headers &headers, const UploadFormDataItems &items, UploadProgress progress = nullptr);
- Result Post(const std::string &path, const Headers &headers, const UploadFormDataItems &items, const std::string &boundary, UploadProgress progress = nullptr);
- Result Post(const std::string &path, const Headers &headers, const UploadFormDataItems &items, const FormDataProviderItems &provider_items, UploadProgress progress = nullptr);
- Result Post(const std::string &path, const Headers &headers, const std::string &body, const std::string &content_type, ContentReceiver content_receiver, DownloadProgress progress = nullptr);
- Result Put(const std::string &path);
- Result Put(const std::string &path, const char *body, size_t content_length, const std::string &content_type, UploadProgress progress = nullptr);
- Result Put(const std::string &path, const std::string &body, const std::string &content_type, UploadProgress progress = nullptr);
- Result Put(const std::string &path, size_t content_length, ContentProvider content_provider, const std::string &content_type, UploadProgress progress = nullptr);
- Result Put(const std::string &path, size_t content_length, ContentProvider content_provider, const std::string &content_type, ContentReceiver content_receiver, UploadProgress progress = nullptr);
- Result Put(const std::string &path, ContentProviderWithoutLength content_provider, const std::string &content_type, UploadProgress progress = nullptr);
- Result Put(const std::string &path, ContentProviderWithoutLength content_provider, const std::string &content_type, ContentReceiver content_receiver, UploadProgress progress = nullptr);
- Result Put(const std::string &path, const Params ¶ms);
- Result Put(const std::string &path, const UploadFormDataItems &items, UploadProgress progress = nullptr);
- Result Put(const std::string &path, const Headers &headers);
- Result Put(const std::string &path, const Headers &headers, const char *body, size_t content_length, const std::string &content_type, UploadProgress progress = nullptr);
- Result Put(const std::string &path, const Headers &headers, const std::string &body, const std::string &content_type, UploadProgress progress = nullptr);
- Result Put(const std::string &path, const Headers &headers, size_t content_length, ContentProvider content_provider, const std::string &content_type, UploadProgress progress = nullptr);
- 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);
- Result Put(const std::string &path, const Headers &headers, ContentProviderWithoutLength content_provider, const std::string &content_type, UploadProgress progress = nullptr);
- Result Put(const std::string &path, const Headers &headers, ContentProviderWithoutLength content_provider, const std::string &content_type, ContentReceiver content_receiver, UploadProgress progress = nullptr);
- Result Put(const std::string &path, const Headers &headers, const Params ¶ms);
- Result Put(const std::string &path, const Headers &headers, const UploadFormDataItems &items, UploadProgress progress = nullptr);
- Result Put(const std::string &path, const Headers &headers, const UploadFormDataItems &items, const std::string &boundary, UploadProgress progress = nullptr);
- Result Put(const std::string &path, const Headers &headers, const UploadFormDataItems &items, const FormDataProviderItems &provider_items, UploadProgress progress = nullptr);
- Result Put(const std::string &path, const Headers &headers, const std::string &body, const std::string &content_type, ContentReceiver content_receiver, DownloadProgress progress = nullptr);
- Result Patch(const std::string &path);
- Result Patch(const std::string &path, const char *body, size_t content_length, const std::string &content_type, UploadProgress progress = nullptr);
- Result Patch(const std::string &path, const std::string &body, const std::string &content_type, UploadProgress progress = nullptr);
- Result Patch(const std::string &path, size_t content_length, ContentProvider content_provider, const std::string &content_type, UploadProgress progress = nullptr);
- Result Patch(const std::string &path, size_t content_length, ContentProvider content_provider, const std::string &content_type, ContentReceiver content_receiver, UploadProgress progress = nullptr);
- Result Patch(const std::string &path, ContentProviderWithoutLength content_provider, const std::string &content_type, UploadProgress progress = nullptr);
- Result Patch(const std::string &path, ContentProviderWithoutLength content_provider, const std::string &content_type, ContentReceiver content_receiver, UploadProgress progress = nullptr);
- Result Patch(const std::string &path, const Params ¶ms);
- Result Patch(const std::string &path, const UploadFormDataItems &items, UploadProgress progress = nullptr);
- Result Patch(const std::string &path, const Headers &headers, UploadProgress progress = nullptr);
- Result Patch(const std::string &path, const Headers &headers, const char *body, size_t content_length, const std::string &content_type, UploadProgress progress = nullptr);
- Result Patch(const std::string &path, const Headers &headers, const std::string &body, const std::string &content_type, UploadProgress progress = nullptr);
- Result Patch(const std::string &path, const Headers &headers, size_t content_length, ContentProvider content_provider, const std::string &content_type, UploadProgress progress = nullptr);
- 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);
- Result Patch(const std::string &path, const Headers &headers, ContentProviderWithoutLength content_provider, const std::string &content_type, UploadProgress progress = nullptr);
- Result Patch(const std::string &path, const Headers &headers, ContentProviderWithoutLength content_provider, const std::string &content_type, ContentReceiver content_receiver, UploadProgress progress = nullptr);
- Result Patch(const std::string &path, const Headers &headers, const Params ¶ms);
- Result Patch(const std::string &path, const Headers &headers, const UploadFormDataItems &items, UploadProgress progress = nullptr);
- Result Patch(const std::string &path, const Headers &headers, const UploadFormDataItems &items, const std::string &boundary, UploadProgress progress = nullptr);
- Result Patch(const std::string &path, const Headers &headers, const UploadFormDataItems &items, const FormDataProviderItems &provider_items, UploadProgress progress = nullptr);
- Result Patch(const std::string &path, const Headers &headers, const std::string &body, const std::string &content_type, ContentReceiver content_receiver, DownloadProgress progress = nullptr);
- Result Delete(const std::string &path, DownloadProgress progress = nullptr);
- Result Delete(const std::string &path, const char *body, size_t content_length, const std::string &content_type, DownloadProgress progress = nullptr);
- Result Delete(const std::string &path, const std::string &body, const std::string &content_type, DownloadProgress progress = nullptr);
- Result Delete(const std::string &path, const Params ¶ms, DownloadProgress progress = nullptr);
- Result Delete(const std::string &path, const Headers &headers, DownloadProgress progress = nullptr);
- Result Delete(const std::string &path, const Headers &headers, const char *body, size_t content_length, const std::string &content_type, DownloadProgress progress = nullptr);
- Result Delete(const std::string &path, const Headers &headers, const std::string &body, const std::string &content_type, DownloadProgress progress = nullptr);
- Result Delete(const std::string &path, const Headers &headers, const Params ¶ms, DownloadProgress progress = nullptr);
- Result Options(const std::string &path);
- Result Options(const std::string &path, const Headers &headers);
- // clang-format on
- // Streaming API: Open a stream for reading response body incrementally
- // Socket ownership is transferred to StreamHandle for true streaming
- // Supports all HTTP methods (GET, POST, PUT, PATCH, DELETE, etc.)
- StreamHandle open_stream(const std::string &method, const std::string &path,
- const Params ¶ms = {},
- const Headers &headers = {},
- const std::string &body = {},
- const std::string &content_type = {});
- bool send(Request &req, Response &res, Error &error);
- Result send(const Request &req);
- void stop();
- std::string host() const;
- int port() const;
- size_t is_socket_open() const;
- socket_t socket() const;
- void set_hostname_addr_map(std::map<std::string, std::string> addr_map);
- void set_default_headers(Headers headers);
- void
- set_header_writer(std::function<ssize_t(Stream &, Headers &)> const &writer);
- void set_address_family(int family);
- void set_tcp_nodelay(bool on);
- void set_ipv6_v6only(bool on);
- void set_socket_options(SocketOptions socket_options);
- void set_connection_timeout(time_t sec, time_t usec = 0);
- template <class Rep, class Period>
- void
- set_connection_timeout(const std::chrono::duration<Rep, Period> &duration);
- void set_read_timeout(time_t sec, time_t usec = 0);
- template <class Rep, class Period>
- void set_read_timeout(const std::chrono::duration<Rep, Period> &duration);
- void set_write_timeout(time_t sec, time_t usec = 0);
- template <class Rep, class Period>
- void set_write_timeout(const std::chrono::duration<Rep, Period> &duration);
- void set_max_timeout(time_t msec);
- template <class Rep, class Period>
- void set_max_timeout(const std::chrono::duration<Rep, Period> &duration);
- void set_basic_auth(const std::string &username, const std::string &password);
- void set_bearer_token_auth(const std::string &token);
- void set_keep_alive(bool on);
- void set_follow_location(bool on);
- void set_path_encode(bool on);
- void set_compress(bool on);
- void set_decompress(bool on);
- void set_payload_max_length(size_t length);
- void set_interface(const std::string &intf);
- void set_proxy(const std::string &host, int port);
- void set_proxy_basic_auth(const std::string &username,
- const std::string &password);
- void set_proxy_bearer_token_auth(const std::string &token);
- void set_no_proxy(const std::vector<std::string> &patterns);
- void set_logger(Logger logger);
- void set_error_logger(ErrorLogger error_logger);
- protected:
- struct Socket {
- socket_t sock = INVALID_SOCKET;
- // For Mbed TLS compatibility: start_time for request timeout tracking
- std::chrono::time_point<std::chrono::steady_clock> start_time_;
- bool is_open() const { return sock != INVALID_SOCKET; }
- #ifdef CPPHTTPLIB_SSL_ENABLED
- tls::session_t ssl = nullptr;
- #endif
- };
- virtual bool create_and_connect_socket(Socket &socket, Error &error);
- virtual bool ensure_socket_connection(Socket &socket, Error &error);
- virtual bool setup_proxy_connection(
- Socket &socket,
- std::chrono::time_point<std::chrono::steady_clock> start_time,
- Response &res, bool &success, Error &error);
- bool is_proxy_enabled_for_host(const std::string &host) const;
- // All of:
- // shutdown_ssl
- // shutdown_socket
- // close_socket
- // disconnect
- // should ONLY be called when socket_mutex_ is locked, and only when
- // no other thread is using the socket.
- virtual void shutdown_ssl(Socket &socket, bool shutdown_gracefully);
- void shutdown_socket(Socket &socket) const;
- void close_socket(Socket &socket);
- void disconnect(bool gracefully);
- bool process_request(Stream &strm, Request &req, Response &res,
- bool close_connection, Error &error);
- bool write_content_with_provider(Stream &strm, const Request &req,
- Error &error) const;
- void copy_settings(const ClientImpl &rhs);
- void output_log(const Request &req, const Response &res) const;
- void output_error_log(const Error &err, const Request *req) const;
- // Socket endpoint information
- const std::string host_;
- const int port_;
- // Current open socket
- Socket socket_;
- mutable std::mutex socket_mutex_;
- std::recursive_mutex request_mutex_;
- // These are all protected under socket_mutex
- size_t socket_requests_in_flight_ = 0;
- std::thread::id socket_requests_are_from_thread_ = std::thread::id();
- bool socket_should_be_closed_when_request_is_done_ = false;
- // Hostname to connection target map. The value is an IP literal or another
- // hostname; only the connection target changes, never the identity.
- std::map<std::string, std::string> addr_map_;
- // Default headers
- Headers default_headers_;
- // Header writer
- std::function<ssize_t(Stream &, Headers &)> header_writer_ =
- detail::write_headers;
- // Settings
- std::string client_cert_path_;
- std::string client_key_path_;
- time_t connection_timeout_sec_ = CPPHTTPLIB_CONNECTION_TIMEOUT_SECOND;
- time_t connection_timeout_usec_ = CPPHTTPLIB_CONNECTION_TIMEOUT_USECOND;
- time_t read_timeout_sec_ = CPPHTTPLIB_CLIENT_READ_TIMEOUT_SECOND;
- time_t read_timeout_usec_ = CPPHTTPLIB_CLIENT_READ_TIMEOUT_USECOND;
- time_t write_timeout_sec_ = CPPHTTPLIB_CLIENT_WRITE_TIMEOUT_SECOND;
- time_t write_timeout_usec_ = CPPHTTPLIB_CLIENT_WRITE_TIMEOUT_USECOND;
- time_t max_timeout_msec_ = CPPHTTPLIB_CLIENT_MAX_TIMEOUT_MSECOND;
- std::string basic_auth_username_;
- std::string basic_auth_password_;
- std::string bearer_token_auth_token_;
- bool keep_alive_ = false;
- bool follow_location_ = false;
- bool path_encode_ = true;
- int address_family_ = AF_UNSPEC;
- bool tcp_nodelay_ = CPPHTTPLIB_TCP_NODELAY;
- bool ipv6_v6only_ = CPPHTTPLIB_IPV6_V6ONLY;
- SocketOptions socket_options_ = nullptr;
- bool compress_ = false;
- bool decompress_ = true;
- size_t payload_max_length_ = CPPHTTPLIB_PAYLOAD_MAX_LENGTH;
- bool has_payload_max_length_ = false;
- std::string interface_;
- std::string proxy_host_;
- int proxy_port_ = -1;
- std::string proxy_basic_auth_username_;
- std::string proxy_basic_auth_password_;
- std::string proxy_bearer_token_auth_token_;
- std::vector<detail::NoProxyEntry> no_proxy_entries_;
- mutable detail::NormalizedTarget host_normalized_;
- mutable bool host_normalized_valid_ = false;
- mutable std::mutex logger_mutex_;
- Logger logger_;
- ErrorLogger error_logger_;
- private:
- bool send_(Request &req, Response &res, Error &error);
- Result send_(Request &&req);
- socket_t create_client_socket(Error &error) const;
- bool read_response_line(Stream &strm, const Request &req, Response &res,
- bool skip_100_continue = true) const;
- bool write_request(Stream &strm, Request &req, bool close_connection,
- Error &error, bool skip_body = false);
- bool write_request_body(Stream &strm, Request &req, Error &error);
- void prepare_default_headers(Request &r, bool for_stream,
- const std::string &ct);
- bool redirect(Request &req, Response &res, Error &error);
- bool create_redirect_client(const std::string &scheme,
- const std::string &host, int port, Request &req,
- Response &res, const std::string &path,
- const std::string &location, Error &error);
- template <typename ClientType> void setup_redirect_client(ClientType &client);
- bool handle_request(Stream &strm, Request &req, Response &res,
- bool close_connection, Error &error);
- std::unique_ptr<Response> send_with_content_provider_and_receiver(
- Request &req, const char *body, size_t content_length,
- ContentProvider content_provider,
- ContentProviderWithoutLength content_provider_without_length,
- const std::string &content_type, ContentReceiver content_receiver,
- Error &error);
- Result send_with_content_provider_and_receiver(
- const std::string &method, const std::string &path,
- const Headers &headers, const char *body, size_t content_length,
- ContentProvider content_provider,
- ContentProviderWithoutLength content_provider_without_length,
- const std::string &content_type, ContentReceiver content_receiver,
- UploadProgress progress);
- ContentProviderWithoutLength get_multipart_content_provider(
- const std::string &boundary, const UploadFormDataItems &items,
- const FormDataProviderItems &provider_items) const;
- virtual bool
- process_socket(const Socket &socket,
- std::chrono::time_point<std::chrono::steady_clock> start_time,
- std::function<bool(Stream &strm)> callback);
- virtual bool is_ssl() const;
- void transfer_socket_ownership_to_handle(StreamHandle &handle);
- #ifdef CPPHTTPLIB_SSL_ENABLED
- public:
- void set_digest_auth(const std::string &username,
- const std::string &password);
- void set_proxy_digest_auth(const std::string &username,
- const std::string &password);
- void set_ca_cert_path(const std::string &ca_cert_file_path,
- const std::string &ca_cert_dir_path = std::string());
- void enable_server_certificate_verification(bool enabled);
- void enable_server_hostname_verification(bool enabled);
- void enable_system_ca(bool enabled);
- protected:
- std::string digest_auth_username_;
- std::string digest_auth_password_;
- std::string proxy_digest_auth_username_;
- std::string proxy_digest_auth_password_;
- std::string ca_cert_file_path_;
- std::string ca_cert_dir_path_;
- bool server_certificate_verification_ = true;
- bool server_hostname_verification_ = true;
- SystemCAMode system_ca_mode_ = SystemCAMode::Auto;
- std::string ca_cert_pem_; // Store CA cert PEM for redirect transfer
- int last_ssl_error_ = 0;
- uint64_t last_backend_error_ = 0;
- #endif
- };
- class Client {
- public:
- // Universal interface
- explicit Client(const std::string &scheme_host_port);
- explicit Client(const std::string &scheme_host_port,
- const std::string &client_cert_path,
- const std::string &client_key_path);
- // HTTP only interface
- explicit Client(const std::string &host, int port);
- explicit Client(const std::string &host, int port,
- const std::string &client_cert_path,
- const std::string &client_key_path);
- Client(Client &&) = default;
- Client &operator=(Client &&) = default;
- ~Client();
- bool is_valid() const;
- // clang-format off
- Result Get(const std::string &path, DownloadProgress progress = nullptr);
- Result Get(const std::string &path, ContentReceiver content_receiver, DownloadProgress progress = nullptr);
- Result Get(const std::string &path, ResponseHandler response_handler, ContentReceiver content_receiver, DownloadProgress progress = nullptr);
- Result Get(const std::string &path, const Headers &headers, DownloadProgress progress = nullptr);
- Result Get(const std::string &path, const Headers &headers, ContentReceiver content_receiver, DownloadProgress progress = nullptr);
- Result Get(const std::string &path, const Headers &headers, ResponseHandler response_handler, ContentReceiver content_receiver, DownloadProgress progress = nullptr);
- Result Get(const std::string &path, const Params ¶ms, DownloadProgress progress = nullptr);
- Result Get(const std::string &path, const Params ¶ms, const Headers &headers, DownloadProgress progress = nullptr);
- Result Get(const std::string &path, const Params ¶ms, const Headers &headers, ContentReceiver content_receiver, DownloadProgress progress = nullptr);
- Result Get(const std::string &path, const Params ¶ms, const Headers &headers, ResponseHandler response_handler, ContentReceiver content_receiver, DownloadProgress progress = nullptr);
- Result Head(const std::string &path);
- Result Head(const std::string &path, const Headers &headers);
- Result Post(const std::string &path);
- Result Post(const std::string &path, const char *body, size_t content_length, const std::string &content_type, UploadProgress progress = nullptr);
- Result Post(const std::string &path, const std::string &body, const std::string &content_type, UploadProgress progress = nullptr);
- Result Post(const std::string &path, size_t content_length, ContentProvider content_provider, const std::string &content_type, UploadProgress progress = nullptr);
- Result Post(const std::string &path, size_t content_length, ContentProvider content_provider, const std::string &content_type, ContentReceiver content_receiver, UploadProgress progress = nullptr);
- Result Post(const std::string &path, ContentProviderWithoutLength content_provider, const std::string &content_type, UploadProgress progress = nullptr);
- Result Post(const std::string &path, ContentProviderWithoutLength content_provider, const std::string &content_type, ContentReceiver content_receiver, UploadProgress progress = nullptr);
- Result Post(const std::string &path, const Params ¶ms);
- Result Post(const std::string &path, const UploadFormDataItems &items, UploadProgress progress = nullptr);
- Result Post(const std::string &path, const Headers &headers);
- Result Post(const std::string &path, const Headers &headers, const char *body, size_t content_length, const std::string &content_type, UploadProgress progress = nullptr);
- Result Post(const std::string &path, const Headers &headers, const std::string &body, const std::string &content_type, UploadProgress progress = nullptr);
- Result Post(const std::string &path, const Headers &headers, size_t content_length, ContentProvider content_provider, const std::string &content_type, UploadProgress progress = nullptr);
- 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);
- Result Post(const std::string &path, const Headers &headers, ContentProviderWithoutLength content_provider, const std::string &content_type, UploadProgress progress = nullptr);
- Result Post(const std::string &path, const Headers &headers, ContentProviderWithoutLength content_provider, const std::string &content_type, ContentReceiver content_receiver, DownloadProgress progress = nullptr);
- Result Post(const std::string &path, const Headers &headers, const Params ¶ms);
- Result Post(const std::string &path, const Headers &headers, const UploadFormDataItems &items, UploadProgress progress = nullptr);
- Result Post(const std::string &path, const Headers &headers, const UploadFormDataItems &items, const std::string &boundary, UploadProgress progress = nullptr);
- Result Post(const std::string &path, const Headers &headers, const UploadFormDataItems &items, const FormDataProviderItems &provider_items, UploadProgress progress = nullptr);
- Result Post(const std::string &path, const Headers &headers, const std::string &body, const std::string &content_type, ContentReceiver content_receiver, DownloadProgress progress = nullptr);
- Result Put(const std::string &path);
- Result Put(const std::string &path, const char *body, size_t content_length, const std::string &content_type, UploadProgress progress = nullptr);
- Result Put(const std::string &path, const std::string &body, const std::string &content_type, UploadProgress progress = nullptr);
- Result Put(const std::string &path, size_t content_length, ContentProvider content_provider, const std::string &content_type, UploadProgress progress = nullptr);
- Result Put(const std::string &path, size_t content_length, ContentProvider content_provider, const std::string &content_type, ContentReceiver content_receiver, UploadProgress progress = nullptr);
- Result Put(const std::string &path, ContentProviderWithoutLength content_provider, const std::string &content_type, UploadProgress progress = nullptr);
- Result Put(const std::string &path, ContentProviderWithoutLength content_provider, const std::string &content_type, ContentReceiver content_receiver, UploadProgress progress = nullptr);
- Result Put(const std::string &path, const Params ¶ms);
- Result Put(const std::string &path, const UploadFormDataItems &items, UploadProgress progress = nullptr);
- Result Put(const std::string &path, const Headers &headers);
- Result Put(const std::string &path, const Headers &headers, const char *body, size_t content_length, const std::string &content_type, UploadProgress progress = nullptr);
- Result Put(const std::string &path, const Headers &headers, const std::string &body, const std::string &content_type, UploadProgress progress = nullptr);
- Result Put(const std::string &path, const Headers &headers, size_t content_length, ContentProvider content_provider, const std::string &content_type, UploadProgress progress = nullptr);
- 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);
- Result Put(const std::string &path, const Headers &headers, ContentProviderWithoutLength content_provider, const std::string &content_type, UploadProgress progress = nullptr);
- Result Put(const std::string &path, const Headers &headers, ContentProviderWithoutLength content_provider, const std::string &content_type, ContentReceiver content_receiver, UploadProgress progress = nullptr);
- Result Put(const std::string &path, const Headers &headers, const Params ¶ms);
- Result Put(const std::string &path, const Headers &headers, const UploadFormDataItems &items, UploadProgress progress = nullptr);
- Result Put(const std::string &path, const Headers &headers, const UploadFormDataItems &items, const std::string &boundary, UploadProgress progress = nullptr);
- Result Put(const std::string &path, const Headers &headers, const UploadFormDataItems &items, const FormDataProviderItems &provider_items, UploadProgress progress = nullptr);
- Result Put(const std::string &path, const Headers &headers, const std::string &body, const std::string &content_type, ContentReceiver content_receiver, DownloadProgress progress = nullptr);
- Result Patch(const std::string &path);
- Result Patch(const std::string &path, const char *body, size_t content_length, const std::string &content_type, UploadProgress progress = nullptr);
- Result Patch(const std::string &path, const std::string &body, const std::string &content_type, UploadProgress progress = nullptr);
- Result Patch(const std::string &path, size_t content_length, ContentProvider content_provider, const std::string &content_type, UploadProgress progress = nullptr);
- Result Patch(const std::string &path, size_t content_length, ContentProvider content_provider, const std::string &content_type, ContentReceiver content_receiver, UploadProgress progress = nullptr);
- Result Patch(const std::string &path, ContentProviderWithoutLength content_provider, const std::string &content_type, UploadProgress progress = nullptr);
- Result Patch(const std::string &path, ContentProviderWithoutLength content_provider, const std::string &content_type, ContentReceiver content_receiver, UploadProgress progress = nullptr);
- Result Patch(const std::string &path, const Params ¶ms);
- Result Patch(const std::string &path, const UploadFormDataItems &items, UploadProgress progress = nullptr);
- Result Patch(const std::string &path, const Headers &headers);
- Result Patch(const std::string &path, const Headers &headers, const char *body, size_t content_length, const std::string &content_type, UploadProgress progress = nullptr);
- Result Patch(const std::string &path, const Headers &headers, const std::string &body, const std::string &content_type, UploadProgress progress = nullptr);
- Result Patch(const std::string &path, const Headers &headers, size_t content_length, ContentProvider content_provider, const std::string &content_type, UploadProgress progress = nullptr);
- 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);
- Result Patch(const std::string &path, const Headers &headers, ContentProviderWithoutLength content_provider, const std::string &content_type, UploadProgress progress = nullptr);
- Result Patch(const std::string &path, const Headers &headers, ContentProviderWithoutLength content_provider, const std::string &content_type, ContentReceiver content_receiver, UploadProgress progress = nullptr);
- Result Patch(const std::string &path, const Headers &headers, const Params ¶ms);
- Result Patch(const std::string &path, const Headers &headers, const UploadFormDataItems &items, UploadProgress progress = nullptr);
- Result Patch(const std::string &path, const Headers &headers, const UploadFormDataItems &items, const std::string &boundary, UploadProgress progress = nullptr);
- Result Patch(const std::string &path, const Headers &headers, const UploadFormDataItems &items, const FormDataProviderItems &provider_items, UploadProgress progress = nullptr);
- Result Patch(const std::string &path, const Headers &headers, const std::string &body, const std::string &content_type, ContentReceiver content_receiver, DownloadProgress progress = nullptr);
- Result Delete(const std::string &path, DownloadProgress progress = nullptr);
- Result Delete(const std::string &path, const char *body, size_t content_length, const std::string &content_type, DownloadProgress progress = nullptr);
- Result Delete(const std::string &path, const std::string &body, const std::string &content_type, DownloadProgress progress = nullptr);
- Result Delete(const std::string &path, const Params ¶ms, DownloadProgress progress = nullptr);
- Result Delete(const std::string &path, const Headers &headers, DownloadProgress progress = nullptr);
- Result Delete(const std::string &path, const Headers &headers, const char *body, size_t content_length, const std::string &content_type, DownloadProgress progress = nullptr);
- Result Delete(const std::string &path, const Headers &headers, const std::string &body, const std::string &content_type, DownloadProgress progress = nullptr);
- Result Delete(const std::string &path, const Headers &headers, const Params ¶ms, DownloadProgress progress = nullptr);
- Result Options(const std::string &path);
- Result Options(const std::string &path, const Headers &headers);
- // clang-format on
- // Streaming API: Open a stream for reading response body incrementally
- // Socket ownership is transferred to StreamHandle for true streaming
- // Supports all HTTP methods (GET, POST, PUT, PATCH, DELETE, etc.)
- ClientImpl::StreamHandle open_stream(const std::string &method,
- const std::string &path,
- const Params ¶ms = {},
- const Headers &headers = {},
- const std::string &body = {},
- const std::string &content_type = {});
- bool send(Request &req, Response &res, Error &error);
- Result send(const Request &req);
- void stop();
- std::string host() const;
- int port() const;
- size_t is_socket_open() const;
- socket_t socket() const;
- void set_hostname_addr_map(std::map<std::string, std::string> addr_map);
- void set_default_headers(Headers headers);
- void
- set_header_writer(std::function<ssize_t(Stream &, Headers &)> const &writer);
- void set_address_family(int family);
- void set_tcp_nodelay(bool on);
- void set_socket_options(SocketOptions socket_options);
- void set_connection_timeout(time_t sec, time_t usec = 0);
- template <class Rep, class Period>
- void
- set_connection_timeout(const std::chrono::duration<Rep, Period> &duration);
- void set_read_timeout(time_t sec, time_t usec = 0);
- template <class Rep, class Period>
- void set_read_timeout(const std::chrono::duration<Rep, Period> &duration);
- void set_write_timeout(time_t sec, time_t usec = 0);
- template <class Rep, class Period>
- void set_write_timeout(const std::chrono::duration<Rep, Period> &duration);
- void set_max_timeout(time_t msec);
- template <class Rep, class Period>
- void set_max_timeout(const std::chrono::duration<Rep, Period> &duration);
- void set_basic_auth(const std::string &username, const std::string &password);
- void set_bearer_token_auth(const std::string &token);
- void set_keep_alive(bool on);
- void set_follow_location(bool on);
- void set_path_encode(bool on);
- void set_compress(bool on);
- void set_decompress(bool on);
- void set_payload_max_length(size_t length);
- void set_interface(const std::string &intf);
- void set_proxy(const std::string &host, int port);
- void set_proxy_basic_auth(const std::string &username,
- const std::string &password);
- void set_proxy_bearer_token_auth(const std::string &token);
- void set_no_proxy(const std::vector<std::string> &patterns);
- void set_logger(Logger logger);
- void set_error_logger(ErrorLogger error_logger);
- private:
- std::unique_ptr<ClientImpl> cli_;
- #ifdef CPPHTTPLIB_SSL_ENABLED
- public:
- void set_digest_auth(const std::string &username,
- const std::string &password);
- void set_proxy_digest_auth(const std::string &username,
- const std::string &password);
- void enable_server_certificate_verification(bool enabled);
- void enable_server_hostname_verification(bool enabled);
- void enable_system_ca(bool enabled);
- void set_ca_cert_path(const std::string &ca_cert_file_path,
- const std::string &ca_cert_dir_path = std::string());
- void set_ca_cert_store(tls::ca_store_t ca_cert_store);
- void load_ca_cert_store(const char *ca_cert, std::size_t size);
- void set_server_certificate_verifier(tls::VerifyCallback verifier);
- void set_session_verifier(
- std::function<SSLVerifierResponse(tls::session_t)> verifier);
- tls::ctx_t tls_context() const;
- #ifdef CPPHTTPLIB_WINDOWS_AUTOMATIC_ROOT_CERTIFICATES_UPDATE
- void enable_windows_certificate_verification(bool enabled);
- #endif
- private:
- bool is_ssl_ = false;
- #endif
- };
- #ifdef CPPHTTPLIB_SSL_ENABLED
- class SSLServer : public Server {
- public:
- SSLServer(const char *cert_path, const char *private_key_path,
- const char *client_ca_cert_file_path = nullptr,
- const char *client_ca_cert_dir_path = nullptr,
- const char *private_key_password = nullptr);
- struct PemMemory {
- const char *cert_pem;
- size_t cert_pem_len;
- const char *key_pem;
- size_t key_pem_len;
- const char *client_ca_pem;
- size_t client_ca_pem_len;
- const char *private_key_password;
- };
- explicit SSLServer(const PemMemory &pem);
- // The callback receives the ctx_t handle which can be cast to the
- // appropriate backend type (SSL_CTX* for OpenSSL,
- // tls::impl::MbedTlsContext* for Mbed TLS)
- explicit SSLServer(const tls::ContextSetupCallback &setup_callback);
- ~SSLServer() override;
- bool is_valid() const override;
- bool update_certs_pem(const char *cert_pem, const char *key_pem,
- const char *client_ca_pem = nullptr,
- const char *password = nullptr);
- tls::ctx_t tls_context() const { return ctx_; }
- int ssl_last_error() const { return last_ssl_error_; }
- private:
- bool process_and_close_socket(socket_t sock) override;
- tls::ctx_t ctx_ = nullptr;
- std::mutex ctx_mutex_;
- int last_ssl_error_ = 0;
- };
- class SSLClient final : public ClientImpl {
- public:
- explicit SSLClient(const std::string &host);
- explicit SSLClient(const std::string &host, int port);
- explicit SSLClient(const std::string &host, int port,
- const std::string &client_cert_path,
- const std::string &client_key_path,
- const std::string &private_key_password = std::string());
- struct PemMemory {
- const char *cert_pem;
- size_t cert_pem_len;
- const char *key_pem;
- size_t key_pem_len;
- const char *private_key_password;
- };
- explicit SSLClient(const std::string &host, int port, const PemMemory &pem);
- ~SSLClient() override;
- bool is_valid() const override;
- void set_ca_cert_store(tls::ca_store_t ca_cert_store);
- void load_ca_cert_store(const char *ca_cert, std::size_t size);
- void set_server_certificate_verifier(tls::VerifyCallback verifier);
- // Post-handshake session verifier (backend-independent)
- void set_session_verifier(
- std::function<SSLVerifierResponse(tls::session_t)> verifier);
- tls::ctx_t tls_context() const { return ctx_; }
- #ifdef CPPHTTPLIB_WINDOWS_AUTOMATIC_ROOT_CERTIFICATES_UPDATE
- void enable_windows_certificate_verification(bool enabled);
- #endif
- private:
- bool create_and_connect_socket(Socket &socket, Error &error) override;
- bool ensure_socket_connection(Socket &socket, Error &error) override;
- void shutdown_ssl(Socket &socket, bool shutdown_gracefully) override;
- void shutdown_ssl_impl(Socket &socket, bool shutdown_gracefully);
- bool
- process_socket(const Socket &socket,
- std::chrono::time_point<std::chrono::steady_clock> start_time,
- std::function<bool(Stream &strm)> callback) override;
- bool is_ssl() const override;
- bool setup_proxy_connection(
- Socket &socket,
- std::chrono::time_point<std::chrono::steady_clock> start_time,
- Response &res, bool &success, Error &error) override;
- bool connect_with_proxy(
- Socket &sock,
- std::chrono::time_point<std::chrono::steady_clock> start_time,
- Response &res, bool &success, Error &error);
- bool initialize_ssl(Socket &socket, Error &error);
- void init_ctx();
- void reset_ctx_on_error();
- bool load_certs();
- tls::ctx_t ctx_ = nullptr;
- std::mutex ctx_mutex_;
- std::once_flag initialize_cert_;
- // Tracks whether a custom CA store was applied via set_ca_cert_store(),
- // since the store handle itself is owned by ctx_ and leaves no other trace.
- // Used to keep custom CA configuration exclusive with system CA loading.
- bool ca_cert_store_set_ = false;
- std::function<SSLVerifierResponse(tls::session_t)> session_verifier_;
- #ifdef CPPHTTPLIB_WINDOWS_AUTOMATIC_ROOT_CERTIFICATES_UPDATE
- bool enable_windows_cert_verification_ = true;
- #endif
- friend class ClientImpl;
- };
- #endif // CPPHTTPLIB_SSL_ENABLED
- namespace detail {
- template <typename T, typename U>
- inline void duration_to_sec_and_usec(const T &duration, U callback) {
- auto sec = std::chrono::duration_cast<std::chrono::seconds>(duration).count();
- auto usec = std::chrono::duration_cast<std::chrono::microseconds>(
- duration - std::chrono::seconds(sec))
- .count();
- callback(static_cast<time_t>(sec), static_cast<time_t>(usec));
- }
- template <size_t N> inline constexpr size_t str_len(const char (&)[N]) {
- return N - 1;
- }
- inline bool is_numeric(const std::string &str) {
- return !str.empty() && std::all_of(str.cbegin(), str.cend(), is_ascii_digit);
- }
- inline size_t get_header_value_u64(const Headers &headers,
- const std::string &key, size_t def,
- size_t id, bool &is_invalid_value) {
- is_invalid_value = false;
- auto rng = headers.equal_range(key);
- auto it = rng.first;
- std::advance(it, static_cast<ssize_t>(id));
- if (it != rng.second) {
- if (is_numeric(it->second)) {
- // Parse at size_t width so an out-of-range Content-Length is reported
- // rather than silently saturated/truncated (a value above 2^32 would
- // otherwise wrap to a small framing length on 32-bit builds). Flag it
- // and return SIZE_MAX so the existing oversized-value guards reject it.
- size_t val = 0;
- const auto &s = it->second;
- auto r = from_chars(s.data(), s.data() + s.size(), val);
- if (r.ec == std::errc::result_out_of_range) {
- is_invalid_value = true;
- return (std::numeric_limits<size_t>::max)();
- }
- return val;
- } else {
- is_invalid_value = true;
- }
- }
- return def;
- }
- inline size_t get_header_value_u64(const Headers &headers,
- const std::string &key, size_t def,
- size_t id) {
- auto dummy = false;
- return get_header_value_u64(headers, key, def, id, dummy);
- }
- } // namespace detail
- template <class Rep, class Period>
- inline Server &
- Server::set_read_timeout(const std::chrono::duration<Rep, Period> &duration) {
- detail::duration_to_sec_and_usec(
- duration, [&](time_t sec, time_t usec) { set_read_timeout(sec, usec); });
- return *this;
- }
- template <class Rep, class Period>
- inline Server &
- Server::set_write_timeout(const std::chrono::duration<Rep, Period> &duration) {
- detail::duration_to_sec_and_usec(
- duration, [&](time_t sec, time_t usec) { set_write_timeout(sec, usec); });
- return *this;
- }
- template <class Rep, class Period>
- inline Server &
- Server::set_idle_interval(const std::chrono::duration<Rep, Period> &duration) {
- detail::duration_to_sec_and_usec(
- duration, [&](time_t sec, time_t usec) { set_idle_interval(sec, usec); });
- return *this;
- }
- template <class Rep, class Period>
- inline void ClientImpl::set_connection_timeout(
- const std::chrono::duration<Rep, Period> &duration) {
- detail::duration_to_sec_and_usec(duration, [&](time_t sec, time_t usec) {
- set_connection_timeout(sec, usec);
- });
- }
- template <class Rep, class Period>
- inline void ClientImpl::set_read_timeout(
- const std::chrono::duration<Rep, Period> &duration) {
- detail::duration_to_sec_and_usec(
- duration, [&](time_t sec, time_t usec) { set_read_timeout(sec, usec); });
- }
- template <class Rep, class Period>
- inline void ClientImpl::set_write_timeout(
- const std::chrono::duration<Rep, Period> &duration) {
- detail::duration_to_sec_and_usec(
- duration, [&](time_t sec, time_t usec) { set_write_timeout(sec, usec); });
- }
- template <class Rep, class Period>
- inline void ClientImpl::set_max_timeout(
- const std::chrono::duration<Rep, Period> &duration) {
- auto msec =
- std::chrono::duration_cast<std::chrono::milliseconds>(duration).count();
- set_max_timeout(msec);
- }
- template <class Rep, class Period>
- inline void Client::set_connection_timeout(
- const std::chrono::duration<Rep, Period> &duration) {
- cli_->set_connection_timeout(duration);
- }
- template <class Rep, class Period>
- inline void
- Client::set_read_timeout(const std::chrono::duration<Rep, Period> &duration) {
- cli_->set_read_timeout(duration);
- }
- template <class Rep, class Period>
- inline void
- Client::set_write_timeout(const std::chrono::duration<Rep, Period> &duration) {
- cli_->set_write_timeout(duration);
- }
- inline void Client::set_max_timeout(time_t msec) {
- cli_->set_max_timeout(msec);
- }
- template <class Rep, class Period>
- inline void
- Client::set_max_timeout(const std::chrono::duration<Rep, Period> &duration) {
- cli_->set_max_timeout(duration);
- }
- /*
- * Forward declarations and types that will be part of the .h file if split into
- * .h + .cc.
- */
- std::string hosted_at(const std::string &hostname);
- void hosted_at(const std::string &hostname, std::vector<std::string> &addrs);
- // JavaScript-style URL encoding/decoding functions
- std::string encode_uri_component(const std::string &value);
- std::string encode_uri(const std::string &value);
- std::string decode_uri_component(const std::string &value);
- std::string decode_uri(const std::string &value);
- // RFC 3986 compliant URL component encoding/decoding functions
- std::string encode_path_component(const std::string &component);
- std::string decode_path_component(const std::string &component);
- std::string encode_query_component(const std::string &component,
- bool space_as_plus = true);
- std::string decode_query_component(const std::string &component,
- bool plus_as_space = true);
- std::string sanitize_filename(const std::string &filename);
- std::string append_query_params(const std::string &path, const Params ¶ms);
- std::pair<std::string, std::string> make_range_header(const Ranges &ranges);
- std::pair<std::string, std::string>
- make_basic_authentication_header(const std::string &username,
- const std::string &password,
- bool is_proxy = false);
- namespace detail {
- #if defined(_WIN32)
- inline std::wstring u8string_to_wstring(const char *s) {
- if (!s) { return std::wstring(); }
- auto len = static_cast<int>(strlen(s));
- if (!len) { return std::wstring(); }
- auto wlen = ::MultiByteToWideChar(CP_UTF8, 0, s, len, nullptr, 0);
- if (!wlen) { return std::wstring(); }
- std::wstring ws;
- ws.resize(wlen);
- wlen = ::MultiByteToWideChar(
- CP_UTF8, 0, s, len,
- const_cast<LPWSTR>(reinterpret_cast<LPCWSTR>(ws.data())), wlen);
- if (wlen != static_cast<int>(ws.size())) { ws.clear(); }
- return ws;
- }
- #endif
- struct FileStat {
- FileStat(const std::string &path);
- bool is_file() const;
- bool is_dir() const;
- time_t mtime() const;
- size_t size() const;
- private:
- #if defined(_WIN32)
- struct _stat st_;
- #else
- struct stat st_;
- #endif
- int ret_ = -1;
- };
- std::string make_host_and_port_string(const std::string &host, int port,
- bool is_ssl);
- template <typename T>
- bool check_and_write_headers(Stream &strm, Headers &headers, T header_writer,
- Error &error);
- std::string trim_copy(const std::string &s);
- void divide(
- const char *data, std::size_t size, char d,
- std::function<void(const char *, std::size_t, const char *, std::size_t)>
- fn);
- void divide(
- const std::string &str, char d,
- std::function<void(const char *, std::size_t, const char *, std::size_t)>
- fn);
- void split(const char *b, const char *e, char d,
- std::function<void(const char *, const char *)> fn);
- void split(const char *b, const char *e, char d, size_t m,
- std::function<void(const char *, const char *)> fn);
- bool process_client_socket(
- socket_t sock, time_t read_timeout_sec, time_t read_timeout_usec,
- time_t write_timeout_sec, time_t write_timeout_usec,
- time_t max_timeout_msec,
- std::chrono::time_point<std::chrono::steady_clock> start_time,
- std::function<bool(Stream &)> callback);
- socket_t create_client_socket(const std::string &host, const std::string &ip,
- int port, int address_family, bool tcp_nodelay,
- bool ipv6_v6only, SocketOptions socket_options,
- time_t connection_timeout_sec,
- time_t connection_timeout_usec,
- time_t read_timeout_sec, time_t read_timeout_usec,
- time_t write_timeout_sec,
- time_t write_timeout_usec,
- const std::string &intf, Error &error);
- const char *get_header_value(const Headers &headers, const std::string &key,
- const char *def, size_t id);
- std::string params_to_query_str(const Params ¶ms);
- void parse_query_text(const char *data, std::size_t size, Params ¶ms);
- void parse_query_text(const std::string &s, Params ¶ms);
- bool parse_multipart_boundary(const std::string &content_type,
- std::string &boundary);
- bool parse_range_header(const std::string &s, Ranges &ranges);
- bool parse_accept_header(const std::string &s,
- std::vector<std::string> &content_types);
- ssize_t send_socket(socket_t sock, const void *ptr, size_t size, int flags);
- ssize_t read_socket(socket_t sock, void *ptr, size_t size, int flags);
- enum class EncodingType { None = 0, Gzip, Brotli, Zstd };
- EncodingType encoding_type(const Request &req, const Response &res);
- class BufferStream final : public Stream {
- public:
- BufferStream() = default;
- ~BufferStream() override = default;
- bool is_readable() const override;
- bool wait_readable() const override;
- bool wait_writable() const override;
- ssize_t read(char *ptr, size_t size) override;
- ssize_t write(const char *ptr, size_t size) override;
- void get_remote_ip_and_port(std::string &ip, int &port) const override;
- void get_local_ip_and_port(std::string &ip, int &port) const override;
- socket_t socket() const override;
- time_t duration() const override;
- const std::string &get_buffer() const;
- private:
- std::string buffer;
- size_t position = 0;
- };
- class compressor {
- public:
- virtual ~compressor() = default;
- typedef std::function<bool(const char *data, size_t data_len)> Callback;
- virtual bool compress(const char *data, size_t data_length, bool last,
- Callback callback) = 0;
- };
- class decompressor {
- public:
- virtual ~decompressor() = default;
- virtual bool is_valid() const = 0;
- typedef std::function<bool(const char *data, size_t data_len)> Callback;
- virtual bool decompress(const char *data, size_t data_length,
- Callback callback) = 0;
- };
- class nocompressor final : public compressor {
- public:
- ~nocompressor() override = default;
- bool compress(const char *data, size_t data_length, bool /*last*/,
- Callback callback) override;
- };
- #ifdef CPPHTTPLIB_ZLIB_SUPPORT
- class gzip_compressor final : public compressor {
- public:
- gzip_compressor();
- ~gzip_compressor() override;
- bool compress(const char *data, size_t data_length, bool last,
- Callback callback) override;
- private:
- bool is_valid_ = false;
- z_stream strm_;
- };
- class gzip_decompressor final : public decompressor {
- public:
- gzip_decompressor();
- ~gzip_decompressor() override;
- bool is_valid() const override;
- bool decompress(const char *data, size_t data_length,
- Callback callback) override;
- private:
- bool is_valid_ = false;
- z_stream strm_;
- };
- #endif
- #ifdef CPPHTTPLIB_BROTLI_SUPPORT
- class brotli_compressor final : public compressor {
- public:
- brotli_compressor();
- ~brotli_compressor();
- bool compress(const char *data, size_t data_length, bool last,
- Callback callback) override;
- private:
- BrotliEncoderState *state_ = nullptr;
- };
- class brotli_decompressor final : public decompressor {
- public:
- brotli_decompressor();
- ~brotli_decompressor();
- bool is_valid() const override;
- bool decompress(const char *data, size_t data_length,
- Callback callback) override;
- private:
- BrotliDecoderResult decoder_r;
- BrotliDecoderState *decoder_s = nullptr;
- };
- #endif
- #ifdef CPPHTTPLIB_ZSTD_SUPPORT
- class zstd_compressor : public compressor {
- public:
- zstd_compressor();
- ~zstd_compressor();
- bool compress(const char *data, size_t data_length, bool last,
- Callback callback) override;
- private:
- ZSTD_CCtx *ctx_ = nullptr;
- };
- class zstd_decompressor : public decompressor {
- public:
- zstd_decompressor();
- ~zstd_decompressor();
- bool is_valid() const override;
- bool decompress(const char *data, size_t data_length,
- Callback callback) override;
- private:
- ZSTD_DCtx *ctx_ = nullptr;
- };
- #endif
- // NOTE: until the read size reaches `fixed_buffer_size`, use `fixed_buffer`
- // to store data. The call can set memory on stack for performance.
- class stream_line_reader {
- public:
- stream_line_reader(Stream &strm, char *fixed_buffer,
- size_t fixed_buffer_size);
- const char *ptr() const;
- size_t size() const;
- bool end_with_crlf() const;
- bool getline();
- private:
- void append(char c);
- void append(const char *data, size_t size);
- Stream &strm_;
- char *fixed_buffer_;
- const size_t fixed_buffer_size_;
- size_t fixed_buffer_used_size_ = 0;
- std::string growable_buffer_;
- };
- bool parse_trailers(stream_line_reader &line_reader, Headers &dest,
- const Headers &src_headers);
- struct ChunkedDecoder {
- Stream &strm;
- size_t chunk_remaining = 0;
- bool finished = false;
- char line_buf[64];
- size_t last_chunk_total = 0;
- size_t last_chunk_offset = 0;
- explicit ChunkedDecoder(Stream &s);
- ssize_t read_payload(char *buf, size_t len, size_t &out_chunk_offset,
- size_t &out_chunk_total);
- bool parse_trailers_into(Headers &dest, const Headers &src_headers);
- };
- class mmap {
- public:
- mmap(const char *path);
- ~mmap();
- bool open(const char *path);
- void close();
- bool is_open() const;
- size_t size() const;
- const char *data() const;
- private:
- #if defined(_WIN32)
- HANDLE hFile_ = NULL;
- HANDLE hMapping_ = NULL;
- #else
- int fd_ = -1;
- #endif
- size_t size_ = 0;
- void *addr_ = nullptr;
- bool is_open_empty_file = false;
- };
- // NOTE: https://www.rfc-editor.org/rfc/rfc9110#section-5
- namespace fields {
- bool is_token_char(char c);
- bool is_token(const std::string &s);
- bool is_field_name(const std::string &s);
- bool is_vchar(char c);
- bool is_obs_text(char c);
- bool is_field_vchar(char c);
- bool is_field_content(const std::string &s);
- bool is_field_value(const std::string &s);
- bool is_field_valid(const std::string &name, const std::string &value);
- } // namespace fields
- } // namespace detail
- /*
- * TLS Abstraction Layer Declarations
- */
- #ifdef CPPHTTPLIB_SSL_ENABLED
- // TLS abstraction layer - backend-specific type declarations
- #ifdef CPPHTTPLIB_MBEDTLS_SUPPORT
- namespace tls {
- namespace impl {
- // Mbed TLS context wrapper (holds config, entropy, DRBG, CA chain, own
- // cert/key). This struct is accessible via tls::impl for use in SSL context
- // setup callbacks (cast ctx_t to tls::impl::MbedTlsContext*).
- struct MbedTlsContext {
- mbedtls_ssl_config conf;
- #ifndef CPPHTTPLIB_MBEDTLS_V4
- // Mbed TLS 4.x uses PSA Crypto's internal RNG; no explicit entropy/DRBG.
- mbedtls_entropy_context entropy;
- mbedtls_ctr_drbg_context ctr_drbg;
- #endif
- mbedtls_x509_crt ca_chain;
- mbedtls_x509_crt own_cert;
- mbedtls_pk_context own_key;
- bool is_server = false;
- bool verify_client = false;
- bool has_verify_callback = false;
- MbedTlsContext();
- ~MbedTlsContext();
- MbedTlsContext(const MbedTlsContext &) = delete;
- MbedTlsContext &operator=(const MbedTlsContext &) = delete;
- };
- } // namespace impl
- } // namespace tls
- #endif
- #ifdef CPPHTTPLIB_WOLFSSL_SUPPORT
- namespace tls {
- namespace impl {
- // wolfSSL context wrapper (holds WOLFSSL_CTX and related state).
- // This struct is accessible via tls::impl for use in SSL context
- // setup callbacks (cast ctx_t to tls::impl::WolfSSLContext*).
- struct WolfSSLContext {
- WOLFSSL_CTX *ctx = nullptr;
- bool is_server = false;
- bool verify_client = false;
- bool has_verify_callback = false;
- std::string ca_pem_data_; // accumulated PEM for get_ca_names/get_ca_certs
- WolfSSLContext();
- ~WolfSSLContext();
- WolfSSLContext(const WolfSSLContext &) = delete;
- WolfSSLContext &operator=(const WolfSSLContext &) = delete;
- };
- // CA store for wolfSSL: holds raw PEM bytes to allow reloading into any ctx
- struct WolfSSLCAStore {
- std::string pem_data;
- };
- } // namespace impl
- } // namespace tls
- #endif
- #endif // CPPHTTPLIB_SSL_ENABLED
- namespace stream {
- class Result {
- public:
- Result();
- explicit Result(ClientImpl::StreamHandle &&handle, size_t chunk_size = 8192);
- Result(Result &&other) noexcept;
- Result &operator=(Result &&other) noexcept;
- Result(const Result &) = delete;
- Result &operator=(const Result &) = delete;
- // Response info
- bool is_valid() const;
- explicit operator bool() const;
- int status() const;
- const Headers &headers() const;
- std::string get_header_value(const std::string &key,
- const char *def = "") const;
- bool has_header(const std::string &key) const;
- Error error() const;
- Error read_error() const;
- bool has_read_error() const;
- // Stream reading
- bool next();
- const char *data() const;
- size_t size() const;
- std::string read_all();
- private:
- ClientImpl::StreamHandle handle_;
- std::string buffer_;
- size_t current_size_ = 0;
- size_t chunk_size_;
- bool finished_ = false;
- };
- // GET
- template <typename ClientType>
- inline Result Get(ClientType &cli, const std::string &path,
- size_t chunk_size = 8192) {
- return Result{cli.open_stream("GET", path), chunk_size};
- }
- template <typename ClientType>
- inline Result Get(ClientType &cli, const std::string &path,
- const Headers &headers, size_t chunk_size = 8192) {
- return Result{cli.open_stream("GET", path, {}, headers), chunk_size};
- }
- template <typename ClientType>
- inline Result Get(ClientType &cli, const std::string &path,
- const Params ¶ms, size_t chunk_size = 8192) {
- return Result{cli.open_stream("GET", path, params), chunk_size};
- }
- template <typename ClientType>
- inline Result Get(ClientType &cli, const std::string &path,
- const Params ¶ms, const Headers &headers,
- size_t chunk_size = 8192) {
- return Result{cli.open_stream("GET", path, params, headers), chunk_size};
- }
- // POST
- template <typename ClientType>
- inline Result Post(ClientType &cli, const std::string &path,
- const std::string &body, const std::string &content_type,
- size_t chunk_size = 8192) {
- return Result{cli.open_stream("POST", path, {}, {}, body, content_type),
- chunk_size};
- }
- template <typename ClientType>
- inline Result Post(ClientType &cli, const std::string &path,
- const Headers &headers, const std::string &body,
- const std::string &content_type, size_t chunk_size = 8192) {
- return Result{cli.open_stream("POST", path, {}, headers, body, content_type),
- chunk_size};
- }
- template <typename ClientType>
- inline Result Post(ClientType &cli, const std::string &path,
- const Params ¶ms, const std::string &body,
- const std::string &content_type, size_t chunk_size = 8192) {
- return Result{cli.open_stream("POST", path, params, {}, body, content_type),
- chunk_size};
- }
- template <typename ClientType>
- inline Result Post(ClientType &cli, const std::string &path,
- const Params ¶ms, const Headers &headers,
- const std::string &body, const std::string &content_type,
- size_t chunk_size = 8192) {
- return Result{
- cli.open_stream("POST", path, params, headers, body, content_type),
- chunk_size};
- }
- // PUT
- template <typename ClientType>
- inline Result Put(ClientType &cli, const std::string &path,
- const std::string &body, const std::string &content_type,
- size_t chunk_size = 8192) {
- return Result{cli.open_stream("PUT", path, {}, {}, body, content_type),
- chunk_size};
- }
- template <typename ClientType>
- inline Result Put(ClientType &cli, const std::string &path,
- const Headers &headers, const std::string &body,
- const std::string &content_type, size_t chunk_size = 8192) {
- return Result{cli.open_stream("PUT", path, {}, headers, body, content_type),
- chunk_size};
- }
- template <typename ClientType>
- inline Result Put(ClientType &cli, const std::string &path,
- const Params ¶ms, const std::string &body,
- const std::string &content_type, size_t chunk_size = 8192) {
- return Result{cli.open_stream("PUT", path, params, {}, body, content_type),
- chunk_size};
- }
- template <typename ClientType>
- inline Result Put(ClientType &cli, const std::string &path,
- const Params ¶ms, const Headers &headers,
- const std::string &body, const std::string &content_type,
- size_t chunk_size = 8192) {
- return Result{
- cli.open_stream("PUT", path, params, headers, body, content_type),
- chunk_size};
- }
- // PATCH
- template <typename ClientType>
- inline Result Patch(ClientType &cli, const std::string &path,
- const std::string &body, const std::string &content_type,
- size_t chunk_size = 8192) {
- return Result{cli.open_stream("PATCH", path, {}, {}, body, content_type),
- chunk_size};
- }
- template <typename ClientType>
- inline Result Patch(ClientType &cli, const std::string &path,
- const Headers &headers, const std::string &body,
- const std::string &content_type, size_t chunk_size = 8192) {
- return Result{cli.open_stream("PATCH", path, {}, headers, body, content_type),
- chunk_size};
- }
- template <typename ClientType>
- inline Result Patch(ClientType &cli, const std::string &path,
- const Params ¶ms, const std::string &body,
- const std::string &content_type, size_t chunk_size = 8192) {
- return Result{cli.open_stream("PATCH", path, params, {}, body, content_type),
- chunk_size};
- }
- template <typename ClientType>
- inline Result Patch(ClientType &cli, const std::string &path,
- const Params ¶ms, const Headers &headers,
- const std::string &body, const std::string &content_type,
- size_t chunk_size = 8192) {
- return Result{
- cli.open_stream("PATCH", path, params, headers, body, content_type),
- chunk_size};
- }
- // DELETE
- template <typename ClientType>
- inline Result Delete(ClientType &cli, const std::string &path,
- size_t chunk_size = 8192) {
- return Result{cli.open_stream("DELETE", path), chunk_size};
- }
- template <typename ClientType>
- inline Result Delete(ClientType &cli, const std::string &path,
- const Headers &headers, size_t chunk_size = 8192) {
- return Result{cli.open_stream("DELETE", path, {}, headers), chunk_size};
- }
- template <typename ClientType>
- inline Result Delete(ClientType &cli, const std::string &path,
- const std::string &body, const std::string &content_type,
- size_t chunk_size = 8192) {
- return Result{cli.open_stream("DELETE", path, {}, {}, body, content_type),
- chunk_size};
- }
- template <typename ClientType>
- inline Result Delete(ClientType &cli, const std::string &path,
- const Headers &headers, const std::string &body,
- const std::string &content_type,
- size_t chunk_size = 8192) {
- return Result{
- cli.open_stream("DELETE", path, {}, headers, body, content_type),
- chunk_size};
- }
- template <typename ClientType>
- inline Result Delete(ClientType &cli, const std::string &path,
- const Params ¶ms, size_t chunk_size = 8192) {
- return Result{cli.open_stream("DELETE", path, params), chunk_size};
- }
- template <typename ClientType>
- inline Result Delete(ClientType &cli, const std::string &path,
- const Params ¶ms, const Headers &headers,
- size_t chunk_size = 8192) {
- return Result{cli.open_stream("DELETE", path, params, headers), chunk_size};
- }
- template <typename ClientType>
- inline Result Delete(ClientType &cli, const std::string &path,
- const Params ¶ms, const std::string &body,
- const std::string &content_type,
- size_t chunk_size = 8192) {
- return Result{cli.open_stream("DELETE", path, params, {}, body, content_type),
- chunk_size};
- }
- template <typename ClientType>
- inline Result Delete(ClientType &cli, const std::string &path,
- const Params ¶ms, const Headers &headers,
- const std::string &body, const std::string &content_type,
- size_t chunk_size = 8192) {
- return Result{
- cli.open_stream("DELETE", path, params, headers, body, content_type),
- chunk_size};
- }
- // HEAD
- template <typename ClientType>
- inline Result Head(ClientType &cli, const std::string &path,
- size_t chunk_size = 8192) {
- return Result{cli.open_stream("HEAD", path), chunk_size};
- }
- template <typename ClientType>
- inline Result Head(ClientType &cli, const std::string &path,
- const Headers &headers, size_t chunk_size = 8192) {
- return Result{cli.open_stream("HEAD", path, {}, headers), chunk_size};
- }
- template <typename ClientType>
- inline Result Head(ClientType &cli, const std::string &path,
- const Params ¶ms, size_t chunk_size = 8192) {
- return Result{cli.open_stream("HEAD", path, params), chunk_size};
- }
- template <typename ClientType>
- inline Result Head(ClientType &cli, const std::string &path,
- const Params ¶ms, const Headers &headers,
- size_t chunk_size = 8192) {
- return Result{cli.open_stream("HEAD", path, params, headers), chunk_size};
- }
- // OPTIONS
- template <typename ClientType>
- inline Result Options(ClientType &cli, const std::string &path,
- size_t chunk_size = 8192) {
- return Result{cli.open_stream("OPTIONS", path), chunk_size};
- }
- template <typename ClientType>
- inline Result Options(ClientType &cli, const std::string &path,
- const Headers &headers, size_t chunk_size = 8192) {
- return Result{cli.open_stream("OPTIONS", path, {}, headers), chunk_size};
- }
- template <typename ClientType>
- inline Result Options(ClientType &cli, const std::string &path,
- const Params ¶ms, size_t chunk_size = 8192) {
- return Result{cli.open_stream("OPTIONS", path, params), chunk_size};
- }
- template <typename ClientType>
- inline Result Options(ClientType &cli, const std::string &path,
- const Params ¶ms, const Headers &headers,
- size_t chunk_size = 8192) {
- return Result{cli.open_stream("OPTIONS", path, params, headers), chunk_size};
- }
- } // namespace stream
- namespace sse {
- struct SSEMessage {
- std::string event; // Event type (default: "message")
- std::string data; // Event payload
- std::string id; // Event ID for Last-Event-ID header
- SSEMessage();
- void clear();
- };
- class SSEClient {
- public:
- using MessageHandler = std::function<void(const SSEMessage &)>;
- using ErrorHandler = std::function<void(Error)>;
- using OpenHandler = std::function<void()>;
- SSEClient(Client &client, const std::string &path);
- SSEClient(Client &client, const std::string &path, const Headers &headers);
- ~SSEClient();
- SSEClient(const SSEClient &) = delete;
- SSEClient &operator=(const SSEClient &) = delete;
- // Event handlers
- SSEClient &on_message(MessageHandler handler);
- SSEClient &on_event(const std::string &type, MessageHandler handler);
- SSEClient &on_open(OpenHandler handler);
- SSEClient &on_error(ErrorHandler handler);
- SSEClient &set_reconnect_interval(int ms);
- SSEClient &set_max_reconnect_attempts(int n);
- // Update headers (thread-safe)
- SSEClient &set_headers(const Headers &headers);
- // State accessors
- bool is_connected() const;
- const std::string &last_event_id() const;
- // Blocking start - runs event loop with auto-reconnect
- void start();
- // Non-blocking start - runs in background thread
- void start_async();
- // Stop the client (thread-safe)
- void stop();
- private:
- bool parse_sse_line(const std::string &line, SSEMessage &msg, int &retry_ms);
- void run_event_loop();
- void dispatch_event(const SSEMessage &msg);
- bool should_reconnect(int count) const;
- void wait_for_reconnect();
- // Client and path
- Client &client_;
- std::string path_;
- Headers headers_;
- mutable std::mutex headers_mutex_;
- // Callbacks
- MessageHandler on_message_;
- std::map<std::string, MessageHandler> event_handlers_;
- OpenHandler on_open_;
- ErrorHandler on_error_;
- // Configuration
- int reconnect_interval_ms_ = 3000;
- int max_reconnect_attempts_ = 0; // 0 = unlimited
- // State
- std::atomic<bool> running_{false};
- std::atomic<bool> connected_{false};
- std::string last_event_id_;
- // Async support
- std::thread async_thread_;
- };
- } // namespace sse
- namespace ws {
- enum class Opcode : uint8_t {
- Continuation = 0x0,
- Text = 0x1,
- Binary = 0x2,
- Close = 0x8,
- Ping = 0x9,
- Pong = 0xA,
- };
- enum class CloseStatus : uint16_t {
- Normal = 1000,
- GoingAway = 1001,
- ProtocolError = 1002,
- UnsupportedData = 1003,
- NoStatus = 1005,
- Abnormal = 1006,
- InvalidPayload = 1007,
- PolicyViolation = 1008,
- MessageTooBig = 1009,
- MandatoryExtension = 1010,
- InternalError = 1011,
- };
- enum ReadResult : int { Fail = 0, Text = 1, Binary = 2 };
- // Result of WebSocketClient::connect(). Truthy only when the WebSocket
- // upgrade handshake fully succeeded. On failure error() identifies the
- // failing layer; status()/headers() expose the server's upgrade response
- // when one was received (status() is -1 otherwise).
- class Result {
- public:
- Result() = default;
- Result(Error err, int status, Headers &&headers)
- : err_(err), status_(status), headers_(std::move(headers)) {}
- explicit operator bool() const { return err_ == Error::Success; }
- Error error() const { return err_; }
- // Upgrade response info
- int status() const { return status_; }
- const Headers &headers() const { return headers_; }
- std::string get_header_value(const std::string &key,
- const char *def = "") const {
- return detail::get_header_value(headers_, key, def, 0);
- }
- bool has_header(const std::string &key) const {
- return headers_.find(key) != headers_.end();
- }
- #ifdef CPPHTTPLIB_SSL_ENABLED
- Result(Error err, int status, Headers &&headers, int ssl_error,
- uint64_t ssl_backend_error)
- : err_(err), status_(status), headers_(std::move(headers)),
- ssl_error_(ssl_error), ssl_backend_error_(ssl_backend_error) {}
- int ssl_error() const { return ssl_error_; }
- uint64_t ssl_backend_error() const { return ssl_backend_error_; }
- #endif
- private:
- Error err_ = Error::Unknown; // a default-constructed Result is falsy
- int status_ = -1;
- Headers headers_;
- #ifdef CPPHTTPLIB_SSL_ENABLED
- int ssl_error_ = 0;
- uint64_t ssl_backend_error_ = 0;
- #endif
- };
- class WebSocket {
- public:
- WebSocket(const WebSocket &) = delete;
- WebSocket &operator=(const WebSocket &) = delete;
- ~WebSocket();
- ReadResult read(std::string &msg);
- bool send(const std::string &data);
- bool send(const char *data, size_t len);
- void close(CloseStatus status = CloseStatus::Normal,
- const std::string &reason = "");
- const Request &request() const;
- bool is_open() const;
- private:
- friend class httplib::Server;
- friend class WebSocketClient;
- WebSocket(
- Stream &strm, const Request &req, bool is_server,
- time_t ping_interval_sec = CPPHTTPLIB_WEBSOCKET_PING_INTERVAL_SECOND,
- int max_missed_pongs = CPPHTTPLIB_WEBSOCKET_MAX_MISSED_PONGS)
- : strm_(strm), req_(req), is_server_(is_server),
- ping_interval_sec_(ping_interval_sec),
- max_missed_pongs_(max_missed_pongs) {
- start_heartbeat();
- }
- WebSocket(
- std::unique_ptr<Stream> &&owned_strm, const Request &req, bool is_server,
- time_t ping_interval_sec = CPPHTTPLIB_WEBSOCKET_PING_INTERVAL_SECOND,
- int max_missed_pongs = CPPHTTPLIB_WEBSOCKET_MAX_MISSED_PONGS)
- : strm_(*owned_strm), owned_strm_(std::move(owned_strm)), req_(req),
- is_server_(is_server), ping_interval_sec_(ping_interval_sec),
- max_missed_pongs_(max_missed_pongs) {
- start_heartbeat();
- }
- void start_heartbeat();
- bool send_frame(Opcode op, const char *data, size_t len, bool fin = true);
- Stream &strm_;
- std::unique_ptr<Stream> owned_strm_;
- Request req_;
- bool is_server_;
- time_t ping_interval_sec_;
- int max_missed_pongs_;
- int unacked_pings_ = 0;
- std::atomic<bool> closed_{false};
- std::mutex write_mutex_;
- std::thread ping_thread_;
- std::mutex ping_mutex_;
- std::condition_variable ping_cv_;
- };
- class WebSocketClient {
- public:
- explicit WebSocketClient(const std::string &scheme_host_port_path,
- const Headers &headers = {});
- ~WebSocketClient();
- WebSocketClient(const WebSocketClient &) = delete;
- WebSocketClient &operator=(const WebSocketClient &) = delete;
- bool is_valid() const;
- Result connect();
- ReadResult read(std::string &msg);
- bool send(const std::string &data);
- bool send(const char *data, size_t len);
- void close(CloseStatus status = CloseStatus::Normal,
- const std::string &reason = "");
- bool is_open() const;
- const std::string &subprotocol() const;
- void set_read_timeout(time_t sec, time_t usec = 0);
- template <class Rep, class Period>
- void set_read_timeout(const std::chrono::duration<Rep, Period> &duration);
- void set_write_timeout(time_t sec, time_t usec = 0);
- template <class Rep, class Period>
- void set_write_timeout(const std::chrono::duration<Rep, Period> &duration);
- void set_websocket_ping_interval(time_t sec);
- void set_websocket_max_missed_pongs(int count);
- void set_tcp_nodelay(bool on);
- void set_address_family(int family);
- void set_ipv6_v6only(bool on);
- void set_socket_options(SocketOptions socket_options);
- void set_connection_timeout(time_t sec, time_t usec = 0);
- template <class Rep, class Period>
- void
- set_connection_timeout(const std::chrono::duration<Rep, Period> &duration);
- void set_interface(const std::string &intf);
- void set_hostname_addr_map(std::map<std::string, std::string> addr_map);
- #ifdef CPPHTTPLIB_SSL_ENABLED
- struct PemMemory {
- const char *cert_pem;
- size_t cert_pem_len;
- const char *key_pem;
- size_t key_pem_len;
- const char *private_key_password;
- };
- explicit WebSocketClient(const std::string &scheme_host_port_path,
- const PemMemory &pem, const Headers &headers = {});
- void set_ca_cert_path(const std::string &ca_cert_file_path,
- const std::string &ca_cert_dir_path = std::string());
- void set_ca_cert_store(tls::ca_store_t store);
- void load_ca_cert_store(const char *ca_cert, std::size_t size);
- void enable_server_certificate_verification(bool enabled);
- void enable_server_hostname_verification(bool enabled);
- void enable_system_ca(bool enabled);
- #endif
- private:
- void shutdown_and_close();
- bool create_stream(std::unique_ptr<Stream> &strm, Error &error,
- int &ssl_error, uint64_t &ssl_backend_error);
- void prepare_default_headers(Request &req);
- std::string host_;
- int port_;
- std::string path_;
- Headers headers_;
- std::string subprotocol_;
- bool is_valid_ = false;
- socket_t sock_ = INVALID_SOCKET;
- std::unique_ptr<WebSocket> ws_;
- time_t read_timeout_sec_ = CPPHTTPLIB_WEBSOCKET_READ_TIMEOUT_SECOND;
- time_t read_timeout_usec_ = 0;
- time_t write_timeout_sec_ = CPPHTTPLIB_CLIENT_WRITE_TIMEOUT_SECOND;
- time_t write_timeout_usec_ = CPPHTTPLIB_CLIENT_WRITE_TIMEOUT_USECOND;
- time_t websocket_ping_interval_sec_ =
- CPPHTTPLIB_WEBSOCKET_PING_INTERVAL_SECOND;
- int websocket_max_missed_pongs_ = CPPHTTPLIB_WEBSOCKET_MAX_MISSED_PONGS;
- int address_family_ = AF_UNSPEC;
- bool tcp_nodelay_ = CPPHTTPLIB_TCP_NODELAY;
- bool ipv6_v6only_ = CPPHTTPLIB_IPV6_V6ONLY;
- SocketOptions socket_options_ = nullptr;
- time_t connection_timeout_sec_ = CPPHTTPLIB_CONNECTION_TIMEOUT_SECOND;
- time_t connection_timeout_usec_ = CPPHTTPLIB_CONNECTION_TIMEOUT_USECOND;
- std::string interface_;
- // Hostname to connection target map. The value is an IP literal or another
- // hostname; only the connection target changes, never the identity.
- std::map<std::string, std::string> addr_map_;
- #ifdef CPPHTTPLIB_SSL_ENABLED
- bool is_ssl_ = false;
- tls::ctx_t tls_ctx_ = nullptr;
- tls::session_t tls_session_ = nullptr;
- std::string ca_cert_file_path_;
- std::string ca_cert_dir_path_;
- bool custom_ca_loaded_ = false;
- bool certs_loaded_ = false;
- SystemCAMode system_ca_mode_ = SystemCAMode::Auto;
- bool server_certificate_verification_ = true;
- bool server_hostname_verification_ = true;
- #endif
- };
- template <class Rep, class Period>
- inline void WebSocketClient::set_read_timeout(
- const std::chrono::duration<Rep, Period> &duration) {
- detail::duration_to_sec_and_usec(
- duration, [&](time_t sec, time_t usec) { set_read_timeout(sec, usec); });
- }
- template <class Rep, class Period>
- inline void WebSocketClient::set_write_timeout(
- const std::chrono::duration<Rep, Period> &duration) {
- detail::duration_to_sec_and_usec(
- duration, [&](time_t sec, time_t usec) { set_write_timeout(sec, usec); });
- }
- template <class Rep, class Period>
- inline void WebSocketClient::set_connection_timeout(
- const std::chrono::duration<Rep, Period> &duration) {
- detail::duration_to_sec_and_usec(duration, [&](time_t sec, time_t usec) {
- set_connection_timeout(sec, usec);
- });
- }
- namespace impl {
- bool is_valid_utf8(const std::string &s);
- bool read_websocket_frame(Stream &strm, Opcode &opcode, std::string &payload,
- bool &fin, bool expect_masked, size_t max_len);
- } // namespace impl
- } // namespace ws
- // ----------------------------------------------------------------------------
- /*
- * Implementation that will be part of the .cc file if split into .h + .cc.
- */
- namespace stream {
- // stream::Result implementations
- inline Result::Result() : chunk_size_(8192) {}
- inline Result::Result(ClientImpl::StreamHandle &&handle, size_t chunk_size)
- : handle_(std::move(handle)), chunk_size_(chunk_size) {}
- inline Result::Result(Result &&other) noexcept
- : handle_(std::move(other.handle_)), buffer_(std::move(other.buffer_)),
- current_size_(other.current_size_), chunk_size_(other.chunk_size_),
- finished_(other.finished_) {
- other.current_size_ = 0;
- other.finished_ = true;
- }
- inline Result &Result::operator=(Result &&other) noexcept {
- if (this != &other) {
- handle_ = std::move(other.handle_);
- buffer_ = std::move(other.buffer_);
- current_size_ = other.current_size_;
- chunk_size_ = other.chunk_size_;
- finished_ = other.finished_;
- other.current_size_ = 0;
- other.finished_ = true;
- }
- return *this;
- }
- inline bool Result::is_valid() const { return handle_.is_valid(); }
- inline Result::operator bool() const { return is_valid(); }
- inline int Result::status() const {
- return handle_.response ? handle_.response->status : -1;
- }
- inline const Headers &Result::headers() const {
- static const Headers empty_headers;
- return handle_.response ? handle_.response->headers : empty_headers;
- }
- inline std::string Result::get_header_value(const std::string &key,
- const char *def) const {
- return handle_.response ? handle_.response->get_header_value(key, def) : def;
- }
- inline bool Result::has_header(const std::string &key) const {
- return handle_.response ? handle_.response->has_header(key) : false;
- }
- inline Error Result::error() const { return handle_.error; }
- inline Error Result::read_error() const { return handle_.get_read_error(); }
- inline bool Result::has_read_error() const { return handle_.has_read_error(); }
- inline bool Result::next() {
- if (!handle_.is_valid() || finished_) { return false; }
- if (buffer_.size() < chunk_size_) { buffer_.resize(chunk_size_); }
- ssize_t n = handle_.read(&buffer_[0], chunk_size_);
- if (n > 0) {
- current_size_ = static_cast<size_t>(n);
- return true;
- }
- current_size_ = 0;
- finished_ = true;
- return false;
- }
- inline const char *Result::data() const { return buffer_.data(); }
- inline size_t Result::size() const { return current_size_; }
- inline std::string Result::read_all() {
- std::string result;
- while (next()) {
- result.append(data(), size());
- }
- return result;
- }
- } // namespace stream
- namespace sse {
- // SSEMessage implementations
- inline SSEMessage::SSEMessage() : event("message") {}
- inline void SSEMessage::clear() {
- event = "message";
- data.clear();
- id.clear();
- }
- // SSEClient implementations
- inline SSEClient::SSEClient(Client &client, const std::string &path)
- : client_(client), path_(path) {}
- inline SSEClient::SSEClient(Client &client, const std::string &path,
- const Headers &headers)
- : client_(client), path_(path), headers_(headers) {}
- inline SSEClient::~SSEClient() { stop(); }
- inline SSEClient &SSEClient::on_message(MessageHandler handler) {
- on_message_ = std::move(handler);
- return *this;
- }
- inline SSEClient &SSEClient::on_event(const std::string &type,
- MessageHandler handler) {
- event_handlers_[type] = std::move(handler);
- return *this;
- }
- inline SSEClient &SSEClient::on_open(OpenHandler handler) {
- on_open_ = std::move(handler);
- return *this;
- }
- inline SSEClient &SSEClient::on_error(ErrorHandler handler) {
- on_error_ = std::move(handler);
- return *this;
- }
- inline SSEClient &SSEClient::set_reconnect_interval(int ms) {
- reconnect_interval_ms_ = ms;
- return *this;
- }
- inline SSEClient &SSEClient::set_max_reconnect_attempts(int n) {
- max_reconnect_attempts_ = n;
- return *this;
- }
- inline SSEClient &SSEClient::set_headers(const Headers &headers) {
- std::lock_guard<std::mutex> lock(headers_mutex_);
- headers_ = headers;
- return *this;
- }
- inline bool SSEClient::is_connected() const { return connected_.load(); }
- inline const std::string &SSEClient::last_event_id() const {
- return last_event_id_;
- }
- inline void SSEClient::start() {
- running_.store(true);
- run_event_loop();
- }
- inline void SSEClient::start_async() {
- running_.store(true);
- async_thread_ = std::thread([this]() { run_event_loop(); });
- }
- inline void SSEClient::stop() {
- running_.store(false);
- client_.stop(); // Cancel any pending operations
- if (async_thread_.joinable()) { async_thread_.join(); }
- }
- inline bool SSEClient::parse_sse_line(const std::string &line, SSEMessage &msg,
- int &retry_ms) {
- // Blank line signals end of event
- if (line.empty() || line == "\r") { return true; }
- // Lines starting with ':' are comments (ignored)
- if (!line.empty() && line[0] == ':') { return false; }
- // Find the colon separator
- auto colon_pos = line.find(':');
- if (colon_pos == std::string::npos) {
- // Line with no colon is treated as field name with empty value
- return false;
- }
- auto field = line.substr(0, colon_pos);
- std::string value;
- // Value starts after colon, skip optional single space
- if (colon_pos + 1 < line.size()) {
- auto value_start = colon_pos + 1;
- if (line[value_start] == ' ') { value_start++; }
- value = line.substr(value_start);
- // Remove trailing \r if present
- if (!value.empty() && value.back() == '\r') { value.pop_back(); }
- }
- // Handle known fields
- if (field == "event") {
- msg.event = value;
- } else if (field == "data") {
- // Multiple data lines are concatenated with newlines
- if (!msg.data.empty()) { msg.data += "\n"; }
- msg.data += value;
- } else if (field == "id") {
- // Empty id is valid (clears the last event ID)
- msg.id = value;
- } else if (field == "retry") {
- // Parse retry interval in milliseconds
- {
- int v = 0;
- auto res =
- detail::from_chars(value.data(), value.data() + value.size(), v);
- if (res.ec == std::errc{}) { retry_ms = v; }
- }
- }
- // Unknown fields are ignored per SSE spec
- return false;
- }
- inline void SSEClient::run_event_loop() {
- auto reconnect_count = 0;
- while (running_.load()) {
- // Build headers, including Last-Event-ID if we have one
- Headers request_headers;
- {
- std::lock_guard<std::mutex> lock(headers_mutex_);
- request_headers = headers_;
- }
- if (!last_event_id_.empty()) {
- request_headers.emplace("Last-Event-ID", last_event_id_);
- }
- // Open streaming connection
- auto result = stream::Get(client_, path_, request_headers);
- // Connection error handling
- if (!result) {
- connected_.store(false);
- if (on_error_) { on_error_(result.error()); }
- if (!should_reconnect(reconnect_count)) { break; }
- wait_for_reconnect();
- reconnect_count++;
- continue;
- }
- if (result.status() != StatusCode::OK_200) {
- connected_.store(false);
- if (on_error_) { on_error_(Error::Connection); }
- // For certain errors, don't reconnect.
- // Note: 401 is intentionally absent so that handlers can refresh
- // credentials via set_headers() and let the client reconnect.
- if (result.status() == StatusCode::NoContent_204 ||
- result.status() == StatusCode::NotFound_404 ||
- result.status() == StatusCode::Forbidden_403) {
- break;
- }
- if (!should_reconnect(reconnect_count)) { break; }
- wait_for_reconnect();
- reconnect_count++;
- continue;
- }
- // Connection successful
- connected_.store(true);
- reconnect_count = 0;
- if (on_open_) { on_open_(); }
- // Event receiving loop
- std::string buffer;
- SSEMessage current_msg;
- while (running_.load() && result.next()) {
- buffer.append(result.data(), result.size());
- // Process complete lines in the buffer
- size_t line_start = 0;
- size_t newline_pos;
- while ((newline_pos = buffer.find('\n', line_start)) !=
- std::string::npos) {
- auto line = buffer.substr(line_start, newline_pos - line_start);
- line_start = newline_pos + 1;
- // Parse the line and check if event is complete
- auto event_complete =
- parse_sse_line(line, current_msg, reconnect_interval_ms_);
- if (event_complete && !current_msg.data.empty()) {
- // Update last_event_id for reconnection
- if (!current_msg.id.empty()) { last_event_id_ = current_msg.id; }
- // Dispatch event to appropriate handler
- dispatch_event(current_msg);
- current_msg.clear();
- }
- }
- // Keep unprocessed data in buffer
- buffer.erase(0, line_start);
- }
- // Connection ended
- connected_.store(false);
- if (!running_.load()) { break; }
- // Check for read errors
- if (result.has_read_error()) {
- if (on_error_) { on_error_(result.read_error()); }
- }
- if (!should_reconnect(reconnect_count)) { break; }
- wait_for_reconnect();
- reconnect_count++;
- }
- connected_.store(false);
- }
- inline void SSEClient::dispatch_event(const SSEMessage &msg) {
- // Check for specific event type handler first
- auto it = event_handlers_.find(msg.event);
- if (it != event_handlers_.end()) {
- it->second(msg);
- return;
- }
- // Fall back to generic message handler
- if (on_message_) { on_message_(msg); }
- }
- inline bool SSEClient::should_reconnect(int count) const {
- if (!running_.load()) { return false; }
- if (max_reconnect_attempts_ == 0) { return true; } // unlimited
- return count < max_reconnect_attempts_;
- }
- inline void SSEClient::wait_for_reconnect() {
- // Use small increments to check running_ flag frequently
- auto waited = 0;
- while (running_.load() && waited < reconnect_interval_ms_) {
- std::this_thread::sleep_for(std::chrono::milliseconds(100));
- waited += 100;
- }
- }
- } // namespace sse
- #ifdef CPPHTTPLIB_SSL_ENABLED
- /*
- * TLS abstraction layer - internal function declarations
- * These are implementation details and not part of the public API.
- */
- namespace tls {
- // Client context
- ctx_t create_client_context();
- void free_context(ctx_t ctx);
- bool set_min_version(ctx_t ctx, Version version);
- bool load_ca_pem(ctx_t ctx, const char *pem, size_t len);
- bool load_ca_file(ctx_t ctx, const char *file_path);
- bool load_ca_dir(ctx_t ctx, const char *dir_path);
- bool load_system_certs(ctx_t ctx);
- bool set_client_cert_pem(ctx_t ctx, const char *cert, const char *key,
- const char *password);
- bool set_client_cert_file(ctx_t ctx, const char *cert_path,
- const char *key_path, const char *password);
- // Server context
- ctx_t create_server_context();
- bool set_server_cert_pem(ctx_t ctx, const char *cert, const char *key,
- const char *password);
- bool set_server_cert_file(ctx_t ctx, const char *cert_path,
- const char *key_path, const char *password);
- bool set_client_ca_file(ctx_t ctx, const char *ca_file, const char *ca_dir);
- void set_verify_client(ctx_t ctx, bool require);
- // Session management
- session_t create_session(ctx_t ctx, socket_t sock);
- void free_session(session_t session);
- bool set_sni(session_t session, const char *hostname, bool verify_hostname);
- // Handshake (non-blocking capable)
- TlsError connect(session_t session);
- TlsError accept(session_t session);
- // Handshake with timeout (blocking until timeout)
- bool connect_nonblocking(session_t session, socket_t sock, time_t timeout_sec,
- time_t timeout_usec, TlsError *err);
- bool accept_nonblocking(session_t session, socket_t sock, time_t timeout_sec,
- time_t timeout_usec, TlsError *err);
- // I/O (non-blocking capable)
- ssize_t read(session_t session, void *buf, size_t len, TlsError &err);
- ssize_t write(session_t session, const void *buf, size_t len, TlsError &err);
- int pending(const_session_t session);
- void shutdown(session_t session, bool graceful);
- // Connection state
- bool is_peer_closed(session_t session, socket_t sock);
- // Certificate verification
- cert_t get_peer_cert(const_session_t session);
- void free_cert(cert_t cert);
- bool verify_hostname(cert_t cert, const char *hostname);
- uint64_t hostname_mismatch_code();
- long get_verify_result(const_session_t session);
- // Certificate introspection
- std::string get_cert_subject_cn(cert_t cert);
- std::string get_cert_issuer_name(cert_t cert);
- bool get_cert_sans(cert_t cert, std::vector<SanEntry> &sans);
- bool get_cert_validity(cert_t cert, time_t ¬_before, time_t ¬_after);
- std::string get_cert_serial(cert_t cert);
- bool get_cert_der(cert_t cert, std::vector<unsigned char> &der);
- const char *get_sni(const_session_t session);
- // CA store management
- ca_store_t create_ca_store(const char *pem, size_t len);
- void free_ca_store(ca_store_t store);
- bool set_ca_store(ctx_t ctx, ca_store_t store);
- size_t get_ca_certs(ctx_t ctx, std::vector<cert_t> &certs);
- std::vector<std::string> get_ca_names(ctx_t ctx);
- // Dynamic certificate update (for servers)
- bool update_server_cert(ctx_t ctx, const char *cert_pem, const char *key_pem,
- const char *password);
- bool update_server_client_ca(ctx_t ctx, const char *ca_pem);
- // Certificate verification callback
- bool set_verify_callback(ctx_t ctx, VerifyCallback callback);
- long get_verify_error(const_session_t session);
- std::string verify_error_string(long error_code);
- // TlsError information
- uint64_t peek_error();
- uint64_t get_error();
- std::string error_string(uint64_t code);
- } // namespace tls
- #endif // CPPHTTPLIB_SSL_ENABLED
- /*
- * Group 1: detail namespace - Non-SSL utilities
- */
- namespace detail {
- inline bool set_socket_opt_impl(socket_t sock, int level, int optname,
- const void *optval, socklen_t optlen) {
- return setsockopt(sock, level, optname,
- #ifdef _WIN32
- reinterpret_cast<const char *>(optval),
- #else
- optval,
- #endif
- optlen) == 0;
- }
- inline bool set_socket_opt_time(socket_t sock, int level, int optname,
- time_t sec, time_t usec) {
- #ifdef _WIN32
- auto timeout = static_cast<uint32_t>(sec * 1000 + usec / 1000);
- #else
- timeval timeout;
- timeout.tv_sec = static_cast<long>(sec);
- timeout.tv_usec = static_cast<decltype(timeout.tv_usec)>(usec);
- #endif
- return set_socket_opt_impl(sock, level, optname, &timeout, sizeof(timeout));
- }
- inline bool is_hex(char c, int &v) {
- if (is_ascii_digit(c)) {
- v = c - '0';
- return true;
- } else if ('A' <= c && c <= 'F') {
- v = c - 'A' + 10;
- return true;
- } else if ('a' <= c && c <= 'f') {
- v = c - 'a' + 10;
- return true;
- }
- return false;
- }
- inline bool from_hex_to_i(const std::string &s, size_t i, size_t cnt,
- int &val) {
- if (i >= s.size()) { return false; }
- val = 0;
- for (; cnt; i++, cnt--) {
- if (!s[i]) { return false; }
- auto v = 0;
- if (is_hex(s[i], v)) {
- val = val * 16 + v;
- } else {
- return false;
- }
- }
- return true;
- }
- inline std::string from_i_to_hex(size_t n) {
- static const auto charset = "0123456789abcdef";
- std::string ret;
- do {
- ret = charset[n & 15] + ret;
- n >>= 4;
- } while (n > 0);
- return ret;
- }
- inline std::string compute_etag(const FileStat &fs) {
- if (!fs.is_file()) { return std::string(); }
- // If mtime cannot be determined (negative value indicates an error
- // or sentinel), do not generate an ETag. Returning a neutral / fixed
- // value like 0 could collide with a real file that legitimately has
- // mtime == 0 (epoch) and lead to misleading validators.
- auto mtime_raw = fs.mtime();
- if (mtime_raw < 0) { return std::string(); }
- auto mtime = static_cast<size_t>(mtime_raw);
- auto size = fs.size();
- return std::string("W/\"") + from_i_to_hex(mtime) + "-" +
- from_i_to_hex(size) + "\"";
- }
- // Format time_t as HTTP-date (RFC 9110 Section 5.6.7): "Sun, 06 Nov 1994
- // 08:49:37 GMT" This implementation is defensive: it validates `mtime`, checks
- // return values from `gmtime_r`/`gmtime_s`, and ensures `strftime` succeeds.
- inline std::string file_mtime_to_http_date(time_t mtime) {
- if (mtime < 0) { return std::string(); }
- struct tm tm_buf;
- #ifdef _WIN32
- if (gmtime_s(&tm_buf, &mtime) != 0) { return std::string(); }
- #else
- if (gmtime_r(&mtime, &tm_buf) == nullptr) { return std::string(); }
- #endif
- char buf[64];
- if (strftime(buf, sizeof(buf), "%a, %d %b %Y %H:%M:%S GMT", &tm_buf) == 0) {
- return std::string();
- }
- return std::string(buf);
- }
- // Parse HTTP-date (RFC 9110 Section 5.6.7) to time_t. Returns -1 on failure.
- inline time_t parse_http_date(const std::string &date_str) {
- struct tm tm_buf;
- // Create a classic locale object once for all parsing attempts
- const std::locale classic_locale = std::locale::classic();
- // Try to parse using std::get_time (C++11, cross-platform)
- auto try_parse = [&](const char *fmt) -> bool {
- std::istringstream ss(date_str);
- ss.imbue(classic_locale);
- memset(&tm_buf, 0, sizeof(tm_buf));
- ss >> std::get_time(&tm_buf, fmt);
- return !ss.fail();
- };
- // RFC 9110 preferred format (HTTP-date): "Sun, 06 Nov 1994 08:49:37 GMT"
- if (!try_parse("%a, %d %b %Y %H:%M:%S")) {
- // RFC 850 format: "Sunday, 06-Nov-94 08:49:37 GMT"
- if (!try_parse("%A, %d-%b-%y %H:%M:%S")) {
- // asctime format: "Sun Nov 6 08:49:37 1994"
- if (!try_parse("%a %b %d %H:%M:%S %Y")) {
- return static_cast<time_t>(-1);
- }
- }
- }
- #ifdef _WIN32
- return _mkgmtime(&tm_buf);
- #elif defined _AIX
- return mktime(&tm_buf);
- #else
- return timegm(&tm_buf);
- #endif
- }
- inline bool is_weak_etag(const std::string &s) {
- // Check if the string is a weak ETag (starts with 'W/"')
- return s.size() > 3 && s[0] == 'W' && s[1] == '/' && s[2] == '"';
- }
- inline bool is_strong_etag(const std::string &s) {
- // Check if the string is a strong ETag (starts and ends with '"', at least 2
- // chars)
- return s.size() >= 2 && s[0] == '"' && s.back() == '"';
- }
- inline size_t to_utf8(int code, char *buff) {
- if (code < 0x0080) {
- buff[0] = static_cast<char>(code & 0x7F);
- return 1;
- } else if (code < 0x0800) {
- buff[0] = static_cast<char>(0xC0 | ((code >> 6) & 0x1F));
- buff[1] = static_cast<char>(0x80 | (code & 0x3F));
- return 2;
- } else if (code < 0xD800) {
- buff[0] = static_cast<char>(0xE0 | ((code >> 12) & 0xF));
- buff[1] = static_cast<char>(0x80 | ((code >> 6) & 0x3F));
- buff[2] = static_cast<char>(0x80 | (code & 0x3F));
- return 3;
- } else if (code < 0xE000) { // D800 - DFFF is invalid...
- return 0;
- } else if (code < 0x10000) {
- buff[0] = static_cast<char>(0xE0 | ((code >> 12) & 0xF));
- buff[1] = static_cast<char>(0x80 | ((code >> 6) & 0x3F));
- buff[2] = static_cast<char>(0x80 | (code & 0x3F));
- return 3;
- } else if (code < 0x110000) {
- buff[0] = static_cast<char>(0xF0 | ((code >> 18) & 0x7));
- buff[1] = static_cast<char>(0x80 | ((code >> 12) & 0x3F));
- buff[2] = static_cast<char>(0x80 | ((code >> 6) & 0x3F));
- buff[3] = static_cast<char>(0x80 | (code & 0x3F));
- return 4;
- }
- // NOTREACHED
- return 0;
- }
- } // namespace detail
- namespace ws {
- namespace impl {
- inline bool is_valid_utf8(const std::string &s) {
- size_t i = 0;
- auto n = s.size();
- while (i < n) {
- auto c = static_cast<unsigned char>(s[i]);
- size_t len;
- uint32_t cp;
- if (c < 0x80) {
- i++;
- continue;
- } else if ((c & 0xE0) == 0xC0) {
- len = 2;
- cp = c & 0x1F;
- } else if ((c & 0xF0) == 0xE0) {
- len = 3;
- cp = c & 0x0F;
- } else if ((c & 0xF8) == 0xF0) {
- len = 4;
- cp = c & 0x07;
- } else {
- return false;
- }
- if (i + len > n) { return false; }
- for (size_t j = 1; j < len; j++) {
- auto b = static_cast<unsigned char>(s[i + j]);
- if ((b & 0xC0) != 0x80) { return false; }
- cp = (cp << 6) | (b & 0x3F);
- }
- // Overlong encoding check
- if (len == 2 && cp < 0x80) { return false; }
- if (len == 3 && cp < 0x800) { return false; }
- if (len == 4 && cp < 0x10000) { return false; }
- // Surrogate halves (U+D800..U+DFFF) and beyond U+10FFFF are invalid
- if (cp >= 0xD800 && cp <= 0xDFFF) { return false; }
- if (cp > 0x10FFFF) { return false; }
- i += len;
- }
- return true;
- }
- } // namespace impl
- } // namespace ws
- namespace detail {
- // NOTE: This code came up with the following stackoverflow post:
- // https://stackoverflow.com/questions/180947/base64-decode-snippet-in-c
- inline std::string base64_encode(const std::string &in) {
- static const auto lookup =
- "ABCDEFGHIJKLMNOPQRSTUVWXYZabcdefghijklmnopqrstuvwxyz0123456789+/";
- std::string out;
- out.reserve(in.size());
- // Unsigned: the accumulator is never masked, so with a signed int the
- // `val << 8` below overflows once enough bytes are folded in (undefined
- // behaviour before C++20). Only the low bits are ever emitted, so the
- // wrap-around of an unsigned accumulator does not affect the output.
- uint32_t val = 0;
- auto valb = -6;
- for (auto c : in) {
- val = (val << 8) + static_cast<uint8_t>(c);
- valb += 8;
- while (valb >= 0) {
- out.push_back(lookup[(val >> valb) & 0x3F]);
- valb -= 6;
- }
- }
- if (valb > -6) { out.push_back(lookup[((val << 8) >> (valb + 8)) & 0x3F]); }
- while (out.size() % 4) {
- out.push_back('=');
- }
- return out;
- }
- inline std::string sha1(const std::string &input) {
- // RFC 3174 SHA-1 implementation
- auto left_rotate = [](uint32_t x, uint32_t n) -> uint32_t {
- return (x << n) | (x >> (32 - n));
- };
- uint32_t h0 = 0x67452301;
- uint32_t h1 = 0xEFCDAB89;
- uint32_t h2 = 0x98BADCFE;
- uint32_t h3 = 0x10325476;
- uint32_t h4 = 0xC3D2E1F0;
- // Pre-processing: adding padding bits
- std::string msg = input;
- uint64_t original_bit_len = static_cast<uint64_t>(msg.size()) * 8;
- msg.push_back(static_cast<char>(0x80u));
- while (msg.size() % 64 != 56) {
- msg.push_back(0);
- }
- // Append original length in bits as 64-bit big-endian
- for (int i = 56; i >= 0; i -= 8) {
- msg.push_back(static_cast<char>((original_bit_len >> i) & 0xFF));
- }
- // Process each 512-bit chunk
- for (size_t offset = 0; offset < msg.size(); offset += 64) {
- uint32_t w[80];
- for (size_t i = 0; i < 16; i++) {
- w[i] =
- (static_cast<uint32_t>(static_cast<uint8_t>(msg[offset + i * 4]))
- << 24) |
- (static_cast<uint32_t>(static_cast<uint8_t>(msg[offset + i * 4 + 1]))
- << 16) |
- (static_cast<uint32_t>(static_cast<uint8_t>(msg[offset + i * 4 + 2]))
- << 8) |
- (static_cast<uint32_t>(
- static_cast<uint8_t>(msg[offset + i * 4 + 3])));
- }
- for (int i = 16; i < 80; i++) {
- w[i] = left_rotate(w[i - 3] ^ w[i - 8] ^ w[i - 14] ^ w[i - 16], 1);
- }
- uint32_t a = h0, b = h1, c = h2, d = h3, e = h4;
- for (int i = 0; i < 80; i++) {
- uint32_t f, k;
- if (i < 20) {
- f = (b & c) | ((~b) & d);
- k = 0x5A827999;
- } else if (i < 40) {
- f = b ^ c ^ d;
- k = 0x6ED9EBA1;
- } else if (i < 60) {
- f = (b & c) | (b & d) | (c & d);
- k = 0x8F1BBCDC;
- } else {
- f = b ^ c ^ d;
- k = 0xCA62C1D6;
- }
- uint32_t temp = left_rotate(a, 5) + f + e + k + w[i];
- e = d;
- d = c;
- c = left_rotate(b, 30);
- b = a;
- a = temp;
- }
- h0 += a;
- h1 += b;
- h2 += c;
- h3 += d;
- h4 += e;
- }
- // Produce the final hash as a 20-byte binary string
- std::string hash(20, '\0');
- for (size_t i = 0; i < 4; i++) {
- hash[i] = static_cast<char>((h0 >> (24 - i * 8)) & 0xFF);
- hash[4 + i] = static_cast<char>((h1 >> (24 - i * 8)) & 0xFF);
- hash[8 + i] = static_cast<char>((h2 >> (24 - i * 8)) & 0xFF);
- hash[12 + i] = static_cast<char>((h3 >> (24 - i * 8)) & 0xFF);
- hash[16 + i] = static_cast<char>((h4 >> (24 - i * 8)) & 0xFF);
- }
- return hash;
- }
- inline std::string websocket_accept_key(const std::string &client_key) {
- const std::string magic = "258EAFA5-E914-47DA-95CA-C5AB0DC85B11";
- return base64_encode(sha1(client_key + magic));
- }
- inline bool is_websocket_upgrade(const Request &req) {
- if (req.method != "GET") { return false; }
- // Check Upgrade: websocket (case-insensitive)
- auto upgrade_it = req.headers.find("Upgrade");
- if (upgrade_it == req.headers.end()) { return false; }
- auto upgrade_val = case_ignore::to_lower(upgrade_it->second);
- if (upgrade_val != "websocket") { return false; }
- // Check Connection header contains "Upgrade"
- auto connection_it = req.headers.find("Connection");
- if (connection_it == req.headers.end()) { return false; }
- auto connection_val = case_ignore::to_lower(connection_it->second);
- if (connection_val.find("upgrade") == std::string::npos) { return false; }
- // Check Sec-WebSocket-Key is a valid base64-encoded 16-byte value (24 chars)
- // RFC 6455 Section 4.2.1
- auto ws_key = req.get_header_value("Sec-WebSocket-Key");
- if (ws_key.size() != 24 || ws_key[22] != '=' || ws_key[23] != '=') {
- return false;
- }
- static const std::string b64chars =
- "ABCDEFGHIJKLMNOPQRSTUVWXYZabcdefghijklmnopqrstuvwxyz0123456789+/";
- for (size_t i = 0; i < 22; i++) {
- if (b64chars.find(ws_key[i]) == std::string::npos) { return false; }
- }
- // Check Sec-WebSocket-Version: 13
- auto version = req.get_header_value("Sec-WebSocket-Version");
- if (version != "13") { return false; }
- return true;
- }
- inline bool write_websocket_frame(Stream &strm, ws::Opcode opcode,
- const char *data, size_t len, bool fin,
- bool mask) {
- // First byte: FIN + opcode
- uint8_t header[2];
- header[0] = static_cast<uint8_t>((fin ? 0x80 : 0x00) |
- (static_cast<uint8_t>(opcode) & 0x0F));
- // Second byte: MASK + payload length
- if (len < 126) {
- header[1] = static_cast<uint8_t>(len);
- if (mask) { header[1] |= 0x80; }
- if (strm.write(reinterpret_cast<char *>(header), 2) < 0) { return false; }
- } else if (len <= 0xFFFF) {
- header[1] = 126;
- if (mask) { header[1] |= 0x80; }
- if (strm.write(reinterpret_cast<char *>(header), 2) < 0) { return false; }
- uint8_t ext[2];
- ext[0] = static_cast<uint8_t>((len >> 8) & 0xFF);
- ext[1] = static_cast<uint8_t>(len & 0xFF);
- if (strm.write(reinterpret_cast<char *>(ext), 2) < 0) { return false; }
- } else {
- header[1] = 127;
- if (mask) { header[1] |= 0x80; }
- if (strm.write(reinterpret_cast<char *>(header), 2) < 0) { return false; }
- uint8_t ext[8];
- for (int i = 7; i >= 0; i--) {
- ext[7 - i] =
- static_cast<uint8_t>((static_cast<uint64_t>(len) >> (i * 8)) & 0xFF);
- }
- if (strm.write(reinterpret_cast<char *>(ext), 8) < 0) { return false; }
- }
- if (mask) {
- // Generate random mask key
- thread_local std::mt19937 rng(std::random_device{}());
- uint8_t mask_key[4];
- auto r = rng();
- std::memcpy(mask_key, &r, 4);
- if (strm.write(reinterpret_cast<char *>(mask_key), 4) < 0) { return false; }
- // Write masked payload in chunks
- const size_t chunk_size = 4096;
- std::vector<char> buf((std::min)(len, chunk_size));
- for (size_t offset = 0; offset < len; offset += chunk_size) {
- size_t n = (std::min)(chunk_size, len - offset);
- for (size_t i = 0; i < n; i++) {
- buf[i] =
- data[offset + i] ^ static_cast<char>(mask_key[(offset + i) % 4]);
- }
- if (strm.write(buf.data(), n) < 0) { return false; }
- }
- } else {
- if (len > 0) {
- if (strm.write(data, len) < 0) { return false; }
- }
- }
- return true;
- }
- } // namespace detail
- namespace ws {
- namespace impl {
- inline bool read_websocket_frame(Stream &strm, Opcode &opcode,
- std::string &payload, bool &fin,
- bool expect_masked, size_t max_len) {
- // Read first 2 bytes
- uint8_t header[2];
- if (strm.read(reinterpret_cast<char *>(header), 2) != 2) { return false; }
- fin = (header[0] & 0x80) != 0;
- // RSV1, RSV2, RSV3 must be 0 when no extension is negotiated
- if (header[0] & 0x70) { return false; }
- opcode = static_cast<Opcode>(header[0] & 0x0F);
- bool masked = (header[1] & 0x80) != 0;
- uint64_t payload_len = header[1] & 0x7F;
- // RFC 6455 Section 5.5: control frames MUST NOT be fragmented and
- // MUST have a payload length of 125 bytes or less
- bool is_control = (static_cast<uint8_t>(opcode) & 0x08) != 0;
- if (is_control) {
- if (!fin) { return false; }
- if (payload_len > 125) { return false; }
- }
- if (masked != expect_masked) { return false; }
- // Extended payload length
- if (payload_len == 126) {
- uint8_t ext[2];
- if (strm.read(reinterpret_cast<char *>(ext), 2) != 2) { return false; }
- payload_len = (static_cast<uint64_t>(ext[0]) << 8) | ext[1];
- } else if (payload_len == 127) {
- uint8_t ext[8];
- if (strm.read(reinterpret_cast<char *>(ext), 8) != 8) { return false; }
- // RFC 6455 Section 5.2: the most significant bit MUST be 0
- if (ext[0] & 0x80) { return false; }
- payload_len = 0;
- for (int i = 0; i < 8; i++) {
- payload_len = (payload_len << 8) | ext[i];
- }
- }
- if (payload_len > max_len) { return false; }
- // Read mask key if present
- uint8_t mask_key[4] = {0};
- if (masked) {
- if (strm.read(reinterpret_cast<char *>(mask_key), 4) != 4) { return false; }
- }
- // Read payload
- payload.resize(static_cast<size_t>(payload_len));
- if (payload_len > 0) {
- size_t total_read = 0;
- while (total_read < payload_len) {
- auto n = strm.read(&payload[total_read],
- static_cast<size_t>(payload_len - total_read));
- if (n <= 0) { return false; }
- total_read += static_cast<size_t>(n);
- }
- }
- // Unmask if needed
- if (masked) {
- for (size_t i = 0; i < payload.size(); i++) {
- payload[i] ^= static_cast<char>(mask_key[i % 4]);
- }
- }
- return true;
- }
- } // namespace impl
- } // namespace ws
- namespace detail {
- inline bool is_valid_path(const std::string &path) {
- size_t level = 0;
- size_t i = 0;
- // Skip slash
- while (i < path.size() && path[i] == '/') {
- i++;
- }
- while (i < path.size()) {
- // Read component
- auto beg = i;
- while (i < path.size() && path[i] != '/') {
- if (path[i] == '\0') {
- return false;
- } else if (path[i] == '\\') {
- return false;
- }
- i++;
- }
- auto len = i - beg;
- assert(len > 0);
- if (!path.compare(beg, len, ".")) {
- ;
- } else if (!path.compare(beg, len, "..")) {
- if (level == 0) { return false; }
- level--;
- } else {
- level++;
- }
- // Skip slash
- while (i < path.size() && path[i] == '/') {
- i++;
- }
- }
- return true;
- }
- inline bool canonicalize_path(const char *path, std::string &resolved) {
- #if defined(_WIN32)
- char buf[_MAX_PATH];
- if (_fullpath(buf, path, _MAX_PATH) == nullptr) { return false; }
- resolved = buf;
- #elif defined(PATH_MAX)
- char buf[PATH_MAX];
- if (realpath(path, buf) == nullptr) { return false; }
- resolved = buf;
- #else
- auto buf = realpath(path, nullptr);
- auto guard = scope_exit([&]() { std::free(buf); });
- if (buf == nullptr) { return false; }
- resolved = buf;
- #endif
- return true;
- }
- inline bool is_path_within_base(const std::string &resolved_path,
- const std::string &resolved_base) {
- #if defined(_WIN32)
- return _strnicmp(resolved_path.c_str(), resolved_base.c_str(),
- resolved_base.size()) == 0;
- #else
- return strncmp(resolved_path.c_str(), resolved_base.c_str(),
- resolved_base.size()) == 0;
- #endif
- }
- inline FileStat::FileStat(const std::string &path) {
- #if defined(_WIN32)
- auto wpath = u8string_to_wstring(path.c_str());
- ret_ = _wstat(wpath.c_str(), &st_);
- #else
- ret_ = stat(path.c_str(), &st_);
- #endif
- }
- inline bool FileStat::is_file() const {
- return ret_ >= 0 && S_ISREG(st_.st_mode);
- }
- inline bool FileStat::is_dir() const {
- return ret_ >= 0 && S_ISDIR(st_.st_mode);
- }
- inline time_t FileStat::mtime() const {
- return ret_ >= 0 ? static_cast<time_t>(st_.st_mtime)
- : static_cast<time_t>(-1);
- }
- inline size_t FileStat::size() const {
- return ret_ >= 0 ? static_cast<size_t>(st_.st_size) : 0;
- }
- inline std::string encode_path(const std::string &s) {
- std::string result;
- result.reserve(s.size());
- for (size_t i = 0; s[i]; i++) {
- switch (s[i]) {
- case ' ': result += "%20"; break;
- case '+': result += "%2B"; break;
- case '\r': result += "%0D"; break;
- case '\n': result += "%0A"; break;
- case '\'': result += "%27"; break;
- case ',': result += "%2C"; break;
- // case ':': result += "%3A"; break; // ok? probably...
- case ';': result += "%3B"; break;
- default:
- auto c = static_cast<uint8_t>(s[i]);
- if (c >= 0x80) {
- result += '%';
- char hex[4];
- auto len = snprintf(hex, sizeof(hex) - 1, "%02X", c);
- assert(len == 2);
- result.append(hex, static_cast<size_t>(len));
- } else {
- result += s[i];
- }
- break;
- }
- }
- return result;
- }
- inline std::string file_extension(const std::string &path) {
- std::smatch m;
- thread_local auto re = std::regex("\\.([a-zA-Z0-9]+)$");
- if (std::regex_search(path, m, re)) { return m[1].str(); }
- return std::string();
- }
- inline bool is_space_or_tab(char c) { return c == ' ' || c == '\t'; }
- template <typename T>
- inline bool parse_header(const char *beg, const char *end, T fn);
- template <typename T>
- inline bool parse_header(const char *beg, const char *end, T fn) {
- // Skip trailing spaces and tabs.
- while (beg < end && is_space_or_tab(end[-1])) {
- end--;
- }
- auto p = beg;
- while (p < end && *p != ':') {
- p++;
- }
- auto name = std::string(beg, p);
- if (!detail::fields::is_field_name(name)) { return false; }
- if (p == end) { return false; }
- auto key_end = p;
- if (*p++ != ':') { return false; }
- while (p < end && is_space_or_tab(*p)) {
- p++;
- }
- if (p <= end) {
- auto key_len = key_end - beg;
- if (!key_len) { return false; }
- auto key = std::string(beg, key_end);
- auto val = std::string(p, end);
- if (!detail::fields::is_field_value(val)) { return false; }
- // RFC 9110 §5.5: header field values are opaque octets and MUST NOT be
- // percent-decoded by the recipient. Applications that need to interpret a
- // value as a URI component should call httplib::decode_uri_component()
- // (or decode_path_component()) explicitly.
- fn(key, val);
- return true;
- }
- return false;
- }
- inline bool parse_trailers(stream_line_reader &line_reader, Headers &dest,
- const Headers &src_headers) {
- // NOTE: In RFC 9112, '7.1 Chunked Transfer Coding' mentions "The chunked
- // transfer coding is complete when a chunk with a chunk-size of zero is
- // received, possibly followed by a trailer section, and finally terminated by
- // an empty line". https://www.rfc-editor.org/rfc/rfc9112.html#section-7.1
- //
- // In '7.1.3. Decoding Chunked', however, the pseudo-code in the section
- // doesn't care for the existence of the final CRLF. In other words, it seems
- // to be ok whether the final CRLF exists or not in the chunked data.
- // https://www.rfc-editor.org/rfc/rfc9112.html#section-7.1.3
- //
- // According to the reference code in RFC 9112, cpp-httplib now allows
- // chunked transfer coding data without the final CRLF.
- // RFC 7230 Section 4.1.2 - Headers prohibited in trailers
- thread_local case_ignore::unordered_set<std::string> prohibited_trailers = {
- "transfer-encoding",
- "content-length",
- "host",
- "authorization",
- "www-authenticate",
- "proxy-authenticate",
- "proxy-authorization",
- "cookie",
- "set-cookie",
- "cache-control",
- "expect",
- "max-forwards",
- "pragma",
- "range",
- "te",
- "age",
- "expires",
- "date",
- "location",
- "retry-after",
- "vary",
- "warning",
- "content-encoding",
- "content-type",
- "content-range",
- "trailer"};
- case_ignore::unordered_set<std::string> declared_trailers;
- auto trailer_header = get_header_value(src_headers, "Trailer", "", 0);
- if (trailer_header && std::strlen(trailer_header)) {
- auto len = std::strlen(trailer_header);
- split(trailer_header, trailer_header + len, ',',
- [&](const char *b, const char *e) {
- const char *kbeg = b;
- const char *kend = e;
- while (kbeg < kend && (*kbeg == ' ' || *kbeg == '\t')) {
- ++kbeg;
- }
- while (kend > kbeg && (kend[-1] == ' ' || kend[-1] == '\t')) {
- --kend;
- }
- std::string key(kbeg, static_cast<size_t>(kend - kbeg));
- if (!key.empty() &&
- prohibited_trailers.find(key) == prohibited_trailers.end()) {
- declared_trailers.insert(key);
- }
- });
- }
- size_t trailer_header_count = 0;
- while (strcmp(line_reader.ptr(), "\r\n") != 0) {
- if (line_reader.size() > CPPHTTPLIB_HEADER_MAX_LENGTH) { return false; }
- if (trailer_header_count >= CPPHTTPLIB_HEADER_MAX_COUNT) { return false; }
- constexpr auto line_terminator_len = 2;
- auto line_beg = line_reader.ptr();
- auto line_end =
- line_reader.ptr() + line_reader.size() - line_terminator_len;
- if (!parse_header(line_beg, line_end,
- [&](const std::string &key, const std::string &val) {
- if (declared_trailers.find(key) !=
- declared_trailers.end()) {
- dest.emplace(key, val);
- trailer_header_count++;
- }
- })) {
- return false;
- }
- if (!line_reader.getline()) { return false; }
- }
- return true;
- }
- inline std::pair<size_t, size_t> trim(const char *b, const char *e, size_t left,
- size_t right) {
- while (b + left < e && is_space_or_tab(b[left])) {
- left++;
- }
- while (right > 0 && is_space_or_tab(b[right - 1])) {
- right--;
- }
- return std::make_pair(left, right);
- }
- inline std::string trim_copy(const std::string &s) {
- auto r = trim(s.data(), s.data() + s.size(), 0, s.size());
- return s.substr(r.first, r.second - r.first);
- }
- inline std::string trim_double_quotes_copy(const std::string &s) {
- if (s.length() >= 2 && s.front() == '"' && s.back() == '"') {
- return s.substr(1, s.size() - 2);
- }
- return s;
- }
- inline void
- divide(const char *data, std::size_t size, char d,
- std::function<void(const char *, std::size_t, const char *, std::size_t)>
- fn) {
- const auto it = std::find(data, data + size, d);
- const auto found = static_cast<std::size_t>(it != data + size);
- const auto lhs_data = data;
- const auto lhs_size = static_cast<std::size_t>(it - data);
- const auto rhs_data = it + found;
- const auto rhs_size = size - lhs_size - found;
- fn(lhs_data, lhs_size, rhs_data, rhs_size);
- }
- inline void
- divide(const std::string &str, char d,
- std::function<void(const char *, std::size_t, const char *, std::size_t)>
- fn) {
- divide(str.data(), str.size(), d, std::move(fn));
- }
- inline void split(const char *b, const char *e, char d,
- std::function<void(const char *, const char *)> fn) {
- return split(b, e, d, (std::numeric_limits<size_t>::max)(), std::move(fn));
- }
- inline void split(const char *b, const char *e, char d, size_t m,
- std::function<void(const char *, const char *)> fn) {
- size_t i = 0;
- size_t beg = 0;
- size_t count = 1;
- while (e ? (b + i < e) : (b[i] != '\0')) {
- if (b[i] == d && count < m) {
- auto r = trim(b, e, beg, i);
- if (r.first < r.second) { fn(&b[r.first], &b[r.second]); }
- beg = i + 1;
- count++;
- }
- i++;
- }
- if (i) {
- auto r = trim(b, e, beg, i);
- if (r.first < r.second) { fn(&b[r.first], &b[r.second]); }
- }
- }
- inline bool split_find(const char *b, const char *e, char d, size_t m,
- std::function<bool(const char *, const char *)> fn) {
- size_t i = 0;
- size_t beg = 0;
- size_t count = 1;
- while (e ? (b + i < e) : (b[i] != '\0')) {
- if (b[i] == d && count < m) {
- auto r = trim(b, e, beg, i);
- if (r.first < r.second) {
- auto found = fn(&b[r.first], &b[r.second]);
- if (found) { return true; }
- }
- beg = i + 1;
- count++;
- }
- i++;
- }
- if (i) {
- auto r = trim(b, e, beg, i);
- if (r.first < r.second) {
- auto found = fn(&b[r.first], &b[r.second]);
- if (found) { return true; }
- }
- }
- return false;
- }
- inline bool split_find(const char *b, const char *e, char d,
- std::function<bool(const char *, const char *)> fn) {
- return split_find(b, e, d, (std::numeric_limits<size_t>::max)(),
- std::move(fn));
- }
- inline stream_line_reader::stream_line_reader(Stream &strm, char *fixed_buffer,
- size_t fixed_buffer_size)
- : strm_(strm), fixed_buffer_(fixed_buffer),
- fixed_buffer_size_(fixed_buffer_size) {}
- inline const char *stream_line_reader::ptr() const {
- if (growable_buffer_.empty()) {
- return fixed_buffer_;
- } else {
- return growable_buffer_.data();
- }
- }
- inline size_t stream_line_reader::size() const {
- if (growable_buffer_.empty()) {
- return fixed_buffer_used_size_;
- } else {
- return growable_buffer_.size();
- }
- }
- inline bool stream_line_reader::end_with_crlf() const {
- auto end = ptr() + size();
- return size() >= 2 && end[-2] == '\r' && end[-1] == '\n';
- }
- inline bool stream_line_reader::getline() {
- fixed_buffer_used_size_ = 0;
- growable_buffer_.clear();
- #ifndef CPPHTTPLIB_ALLOW_LF_AS_LINE_TERMINATOR
- char prev_byte = 0;
- #endif
- for (size_t i = 0;; i++) {
- // Fast path: whatever the stream has already buffered can be scanned for
- // the terminator in one pass. Asking for a byte at a time costs a virtual
- // call, a bounds check and a one-byte copy per character of the request.
- size_t buffered_size = 0;
- if (auto buffered = strm_.buffered_data(buffered_size)) {
- auto take = buffered_size;
- auto terminated = false;
- for (size_t at = 0; at < buffered_size;) {
- auto nl = static_cast<const char *>(
- memchr(buffered + at, '\n', buffered_size - at));
- if (!nl) { break; }
- auto pos = static_cast<size_t>(nl - buffered);
- #ifdef CPPHTTPLIB_ALLOW_LF_AS_LINE_TERMINATOR
- take = pos + 1;
- terminated = true;
- break;
- #else
- // A bare LF does not end the line; keep looking for CRLF. The CR may
- // be the last byte of an earlier chunk, hence prev_byte.
- if ((pos > 0 ? buffered[pos - 1] : prev_byte) == '\r') {
- take = pos + 1;
- terminated = true;
- break;
- }
- at = pos + 1;
- #endif
- }
- if (size() + take > CPPHTTPLIB_MAX_LINE_LENGTH) { return false; }
- #ifndef CPPHTTPLIB_ALLOW_LF_AS_LINE_TERMINATOR
- prev_byte = buffered[take - 1];
- #endif
- append(buffered, take);
- strm_.consume_buffered(take);
- i += take;
- if (terminated) { return true; }
- continue;
- }
- if (size() >= CPPHTTPLIB_MAX_LINE_LENGTH) {
- // Treat exceptionally long lines as an error to
- // prevent infinite loops/memory exhaustion
- return false;
- }
- char byte;
- auto n = strm_.read(&byte, 1);
- if (n < 0) {
- return false;
- } else if (n == 0) {
- if (i == 0) {
- return false;
- } else {
- break;
- }
- }
- append(byte);
- #ifdef CPPHTTPLIB_ALLOW_LF_AS_LINE_TERMINATOR
- if (byte == '\n') { break; }
- #else
- if (prev_byte == '\r' && byte == '\n') { break; }
- prev_byte = byte;
- #endif
- }
- return true;
- }
- inline void stream_line_reader::append(char c) { append(&c, 1); }
- inline void stream_line_reader::append(const char *data, size_t size) {
- // Once the line has outgrown the fixed buffer everything must keep going to
- // the growable one, even if a later chunk would have fit. Without the
- // emptiness check a short append after a long one would land in the fixed
- // buffer, which ptr() and size() no longer look at, and be lost.
- if (growable_buffer_.empty() &&
- fixed_buffer_used_size_ + size < fixed_buffer_size_) {
- memcpy(fixed_buffer_ + fixed_buffer_used_size_, data, size);
- fixed_buffer_used_size_ += size;
- fixed_buffer_[fixed_buffer_used_size_] = '\0';
- } else {
- // Unlike the per-character overload, this can be the very first append of
- // the line, so the fixed buffer may hold nothing and carry no terminator
- // yet. assign() takes an explicit length and does not need one.
- if (growable_buffer_.empty()) {
- growable_buffer_.assign(fixed_buffer_, fixed_buffer_used_size_);
- }
- growable_buffer_.append(data, size);
- }
- }
- inline mmap::mmap(const char *path) { open(path); }
- inline mmap::~mmap() { close(); }
- inline bool mmap::open(const char *path) {
- close();
- #if defined(_WIN32)
- auto wpath = u8string_to_wstring(path);
- if (wpath.empty()) { return false; }
- hFile_ =
- ::CreateFile2(wpath.c_str(), GENERIC_READ,
- FILE_SHARE_READ | FILE_SHARE_WRITE, OPEN_EXISTING, NULL);
- if (hFile_ == INVALID_HANDLE_VALUE) { return false; }
- LARGE_INTEGER size{};
- if (!::GetFileSizeEx(hFile_, &size)) { return false; }
- // If the following line doesn't compile due to QuadPart, update Windows SDK.
- // See:
- // https://github.com/yhirose/cpp-httplib/issues/1903#issuecomment-2316520721
- if (static_cast<ULONGLONG>(size.QuadPart) >
- (std::numeric_limits<decltype(size_)>::max)()) {
- // `size_t` might be 32-bits, on 32-bits Windows.
- return false;
- }
- size_ = static_cast<size_t>(size.QuadPart);
- hMapping_ =
- ::CreateFileMappingFromApp(hFile_, NULL, PAGE_READONLY, size_, NULL);
- // Special treatment for an empty file...
- if (hMapping_ == NULL && size_ == 0) {
- close();
- is_open_empty_file = true;
- return true;
- }
- if (hMapping_ == NULL) {
- close();
- return false;
- }
- addr_ = ::MapViewOfFileFromApp(hMapping_, FILE_MAP_READ, 0, 0);
- if (addr_ == nullptr) {
- close();
- return false;
- }
- #else
- fd_ = ::open(path, O_RDONLY);
- if (fd_ == -1) { return false; }
- struct stat sb;
- if (fstat(fd_, &sb) == -1) {
- close();
- return false;
- }
- size_ = static_cast<size_t>(sb.st_size);
- addr_ = ::mmap(NULL, size_, PROT_READ, MAP_PRIVATE, fd_, 0);
- // Special treatment for an empty file...
- if (addr_ == MAP_FAILED && size_ == 0) {
- close();
- is_open_empty_file = true;
- return false;
- }
- if (addr_ == MAP_FAILED) {
- // Clear the sentinel before `close()`, since `is_open()` only checks
- // `addr_` against nullptr and `munmap()` must not be called with it.
- addr_ = nullptr;
- close();
- return false;
- }
- #endif
- return true;
- }
- inline bool mmap::is_open() const {
- return is_open_empty_file ? true : addr_ != nullptr;
- }
- inline size_t mmap::size() const { return size_; }
- inline const char *mmap::data() const {
- return is_open_empty_file ? "" : static_cast<const char *>(addr_);
- }
- inline void mmap::close() {
- #if defined(_WIN32)
- if (addr_) {
- ::UnmapViewOfFile(addr_);
- addr_ = nullptr;
- }
- if (hMapping_) {
- ::CloseHandle(hMapping_);
- hMapping_ = NULL;
- }
- if (hFile_ != INVALID_HANDLE_VALUE) {
- ::CloseHandle(hFile_);
- hFile_ = INVALID_HANDLE_VALUE;
- }
- is_open_empty_file = false;
- #else
- if (addr_ != nullptr) {
- munmap(addr_, size_);
- addr_ = nullptr;
- }
- if (fd_ != -1) {
- ::close(fd_);
- fd_ = -1;
- }
- #endif
- size_ = 0;
- }
- inline int close_socket(socket_t sock) noexcept {
- #ifdef _WIN32
- return closesocket(sock);
- #else
- return close(sock);
- #endif
- }
- template <typename T> inline ssize_t handle_EINTR(T fn) {
- ssize_t res = 0;
- while (true) {
- res = fn();
- if (res < 0 && errno == EINTR) {
- std::this_thread::sleep_for(std::chrono::microseconds{1});
- continue;
- }
- break;
- }
- return res;
- }
- inline ssize_t read_socket(socket_t sock, void *ptr, size_t size, int flags) {
- return handle_EINTR([&]() {
- return recv(sock,
- #ifdef _WIN32
- static_cast<char *>(ptr), static_cast<int>(size),
- #else
- ptr, size,
- #endif
- flags);
- });
- }
- inline ssize_t send_socket(socket_t sock, const void *ptr, size_t size,
- int flags) {
- return handle_EINTR([&]() {
- return send(sock,
- #ifdef _WIN32
- static_cast<const char *>(ptr), static_cast<int>(size),
- #else
- ptr, size,
- #endif
- flags);
- });
- }
- inline int poll_wrapper(struct pollfd *fds, nfds_t nfds, int timeout) {
- #ifdef _WIN32
- return ::WSAPoll(fds, nfds, timeout);
- #else
- return ::poll(fds, nfds, timeout);
- #endif
- }
- inline ssize_t select_impl(socket_t sock, short events, time_t sec,
- time_t usec) {
- struct pollfd pfd;
- pfd.fd = sock;
- pfd.events = events;
- pfd.revents = 0;
- auto timeout = static_cast<int>(sec * 1000 + usec / 1000);
- return handle_EINTR([&]() { return poll_wrapper(&pfd, 1, timeout); });
- }
- inline ssize_t select_read(socket_t sock, time_t sec, time_t usec) {
- return select_impl(sock, POLLIN, sec, usec);
- }
- inline ssize_t select_write(socket_t sock, time_t sec, time_t usec) {
- return select_impl(sock, POLLOUT, sec, usec);
- }
- inline Error wait_until_socket_is_ready(socket_t sock, time_t sec,
- time_t usec) {
- struct pollfd pfd_read;
- pfd_read.fd = sock;
- pfd_read.events = POLLIN | POLLOUT;
- pfd_read.revents = 0;
- auto timeout = static_cast<int>(sec * 1000 + usec / 1000);
- auto poll_res =
- handle_EINTR([&]() { return poll_wrapper(&pfd_read, 1, timeout); });
- if (poll_res == 0) { return Error::ConnectionTimeout; }
- if (poll_res > 0 && pfd_read.revents & (POLLIN | POLLOUT)) {
- auto error = 0;
- socklen_t len = sizeof(error);
- auto res = getsockopt(sock, SOL_SOCKET, SO_ERROR,
- reinterpret_cast<char *>(&error), &len);
- auto successful = res >= 0 && !error;
- return successful ? Error::Success : Error::Connection;
- }
- return Error::Connection;
- }
- inline bool is_socket_alive(socket_t sock) {
- const auto val = detail::select_read(sock, 0, 0);
- if (val == 0) {
- return true;
- } else if (val < 0 && errno == EBADF) {
- return false;
- }
- char buf[1];
- return detail::read_socket(sock, &buf[0], sizeof(buf), MSG_PEEK) > 0;
- }
- class SocketStream final : public Stream {
- public:
- SocketStream(socket_t sock, time_t read_timeout_sec, time_t read_timeout_usec,
- time_t write_timeout_sec, time_t write_timeout_usec,
- time_t max_timeout_msec = 0,
- std::chrono::time_point<std::chrono::steady_clock> start_time =
- (std::chrono::steady_clock::time_point::min)());
- ~SocketStream() override;
- bool is_readable() const override;
- bool wait_readable() const override;
- bool wait_writable() const override;
- bool is_peer_alive() const override;
- ssize_t read(char *ptr, size_t size) override;
- ssize_t write(const char *ptr, size_t size) override;
- void get_remote_ip_and_port(std::string &ip, int &port) const override;
- void get_local_ip_and_port(std::string &ip, int &port) const override;
- socket_t socket() const override;
- time_t duration() const override;
- void set_read_timeout(time_t sec, time_t usec = 0) override;
- const char *buffered_data(size_t &size) const override;
- void consume_buffered(size_t size) override;
- // The caller has just seen this socket become readable. Lets the next read
- // skip its own readiness wait, which would otherwise ask the kernel a
- // question that was answered a moment ago. Consumed by that read.
- void set_readable_hint() { readable_hint_ = true; }
- private:
- bool ensure_readable();
- socket_t sock_;
- time_t read_timeout_sec_;
- time_t read_timeout_usec_;
- time_t write_timeout_sec_;
- time_t write_timeout_usec_;
- time_t max_timeout_msec_;
- const std::chrono::time_point<std::chrono::steady_clock> start_time_;
- std::vector<char> read_buff_;
- size_t read_buff_off_ = 0;
- size_t read_buff_content_size_ = 0;
- bool readable_hint_ = false;
- static const size_t read_buff_size_ = 1024l * 4;
- };
- inline bool keep_alive(const std::atomic<socket_t> &svr_sock, socket_t sock,
- time_t keep_alive_timeout_sec) {
- using namespace std::chrono;
- const auto interval_usec =
- CPPHTTPLIB_KEEPALIVE_TIMEOUT_CHECK_INTERVAL_USECOND;
- // Avoid expensive `steady_clock::now()` call for the first time
- if (select_read(sock, 0, interval_usec) > 0) { return true; }
- const auto start = steady_clock::now() - microseconds{interval_usec};
- const auto timeout = seconds{keep_alive_timeout_sec};
- while (true) {
- if (svr_sock == INVALID_SOCKET) {
- break; // Server socket is closed
- }
- auto val = select_read(sock, 0, interval_usec);
- if (val < 0) {
- break; // Ssocket error
- } else if (val == 0) {
- if (steady_clock::now() - start > timeout) {
- break; // Timeout
- }
- } else {
- return true; // Ready for read
- }
- }
- return false;
- }
- template <typename T>
- inline bool
- process_server_socket_core(const std::atomic<socket_t> &svr_sock, socket_t sock,
- size_t keep_alive_max_count,
- time_t keep_alive_timeout_sec, T callback) {
- assert(keep_alive_max_count > 0);
- auto ret = false;
- auto count = keep_alive_max_count;
- while (count > 0 && keep_alive(svr_sock, sock, keep_alive_timeout_sec)) {
- auto close_connection = count == 1;
- auto connection_closed = false;
- ret = callback(close_connection, connection_closed);
- if (!ret || connection_closed) { break; }
- count--;
- }
- return ret;
- }
- template <typename T>
- inline bool
- process_server_socket(const std::atomic<socket_t> &svr_sock, socket_t sock,
- size_t keep_alive_max_count,
- time_t keep_alive_timeout_sec, time_t read_timeout_sec,
- time_t read_timeout_usec, time_t write_timeout_sec,
- time_t write_timeout_usec, T callback) {
- return process_server_socket_core(
- svr_sock, sock, keep_alive_max_count, keep_alive_timeout_sec,
- [&](bool close_connection, bool &connection_closed) {
- SocketStream strm(sock, read_timeout_sec, read_timeout_usec,
- write_timeout_sec, write_timeout_usec);
- // process_server_socket_core() only gets here once keep_alive() has
- // seen the socket go readable.
- strm.set_readable_hint();
- return callback(strm, close_connection, connection_closed);
- });
- }
- inline bool process_client_socket(
- socket_t sock, time_t read_timeout_sec, time_t read_timeout_usec,
- time_t write_timeout_sec, time_t write_timeout_usec,
- time_t max_timeout_msec,
- std::chrono::time_point<std::chrono::steady_clock> start_time,
- std::function<bool(Stream &)> callback) {
- SocketStream strm(sock, read_timeout_sec, read_timeout_usec,
- write_timeout_sec, write_timeout_usec, max_timeout_msec,
- start_time);
- return callback(strm);
- }
- inline int shutdown_socket(socket_t sock) noexcept {
- #ifdef _WIN32
- return shutdown(sock, SD_BOTH);
- #else
- return shutdown(sock, SHUT_RDWR);
- #endif
- }
- inline std::string escape_abstract_namespace_unix_domain(const std::string &s) {
- if (s.size() > 1 && s[0] == '\0') {
- auto ret = s;
- ret[0] = '@';
- return ret;
- }
- return s;
- }
- inline std::string
- unescape_abstract_namespace_unix_domain(const std::string &s) {
- if (s.size() > 1 && s[0] == '@') {
- auto ret = s;
- ret[0] = '\0';
- return ret;
- }
- return s;
- }
- inline int getaddrinfo_with_timeout(const char *node, const char *service,
- const struct addrinfo *hints,
- struct addrinfo **res, time_t timeout_sec) {
- #ifdef CPPHTTPLIB_USE_NON_BLOCKING_GETADDRINFO
- if (timeout_sec <= 0) {
- // No timeout specified, use standard getaddrinfo
- return getaddrinfo(node, service, hints, res);
- }
- #ifdef _WIN32
- // Windows-specific implementation using GetAddrInfoEx with overlapped I/O
- OVERLAPPED overlapped = {};
- HANDLE event = CreateEventW(nullptr, TRUE, FALSE, nullptr);
- if (!event) { return EAI_FAIL; }
- overlapped.hEvent = event;
- PADDRINFOEXW result_addrinfo = nullptr;
- HANDLE cancel_handle = nullptr;
- ADDRINFOEXW hints_ex = {};
- if (hints) {
- hints_ex.ai_flags = hints->ai_flags;
- hints_ex.ai_family = hints->ai_family;
- hints_ex.ai_socktype = hints->ai_socktype;
- hints_ex.ai_protocol = hints->ai_protocol;
- }
- auto wnode = u8string_to_wstring(node);
- auto wservice = u8string_to_wstring(service);
- auto ret = ::GetAddrInfoExW(wnode.data(), wservice.data(), NS_DNS, nullptr,
- hints ? &hints_ex : nullptr, &result_addrinfo,
- nullptr, &overlapped, nullptr, &cancel_handle);
- if (ret == WSA_IO_PENDING) {
- auto wait_result =
- ::WaitForSingleObject(event, static_cast<DWORD>(timeout_sec * 1000));
- if (wait_result == WAIT_TIMEOUT) {
- if (cancel_handle) { ::GetAddrInfoExCancel(&cancel_handle); }
- ::CloseHandle(event);
- return EAI_AGAIN;
- }
- DWORD bytes_returned;
- if (!::GetOverlappedResult((HANDLE)INVALID_SOCKET, &overlapped,
- &bytes_returned, FALSE)) {
- ::CloseHandle(event);
- return ::WSAGetLastError();
- }
- }
- ::CloseHandle(event);
- if (ret == NO_ERROR || ret == WSA_IO_PENDING) {
- *res = reinterpret_cast<struct addrinfo *>(result_addrinfo);
- return 0;
- }
- return ret;
- #elif TARGET_OS_MAC && defined(__clang__)
- if (!node) { return EAI_NONAME; }
- // macOS implementation using CFHost API for asynchronous DNS resolution
- CFStringRef hostname_ref = CFStringCreateWithCString(
- kCFAllocatorDefault, node, kCFStringEncodingUTF8);
- if (!hostname_ref) { return EAI_MEMORY; }
- CFHostRef host_ref = CFHostCreateWithName(kCFAllocatorDefault, hostname_ref);
- CFRelease(hostname_ref);
- if (!host_ref) { return EAI_MEMORY; }
- // Set up context for callback
- struct CFHostContext {
- bool completed = false;
- bool success = false;
- CFArrayRef addresses = nullptr;
- std::mutex mutex;
- std::condition_variable cv;
- } context;
- CFHostClientContext client_context;
- memset(&client_context, 0, sizeof(client_context));
- client_context.info = &context;
- // Set callback
- auto callback = [](CFHostRef theHost, CFHostInfoType /*typeInfo*/,
- const CFStreamError *error, void *info) {
- auto ctx = static_cast<CFHostContext *>(info);
- std::lock_guard<std::mutex> lock(ctx->mutex);
- if (error && error->error != 0) {
- ctx->success = false;
- } else {
- Boolean hasBeenResolved;
- ctx->addresses = CFHostGetAddressing(theHost, &hasBeenResolved);
- if (ctx->addresses && hasBeenResolved) {
- CFRetain(ctx->addresses);
- ctx->success = true;
- } else {
- ctx->success = false;
- }
- }
- ctx->completed = true;
- ctx->cv.notify_one();
- };
- if (!CFHostSetClient(host_ref, callback, &client_context)) {
- CFRelease(host_ref);
- return EAI_SYSTEM;
- }
- // Schedule on run loop
- CFRunLoopRef run_loop = CFRunLoopGetCurrent();
- CFHostScheduleWithRunLoop(host_ref, run_loop, kCFRunLoopDefaultMode);
- // Start resolution
- CFStreamError stream_error;
- if (!CFHostStartInfoResolution(host_ref, kCFHostAddresses, &stream_error)) {
- CFHostUnscheduleFromRunLoop(host_ref, run_loop, kCFRunLoopDefaultMode);
- CFRelease(host_ref);
- return EAI_FAIL;
- }
- // Wait for completion with timeout
- auto timeout_time =
- std::chrono::steady_clock::now() + std::chrono::seconds(timeout_sec);
- bool timed_out = false;
- {
- std::unique_lock<std::mutex> lock(context.mutex);
- while (!context.completed) {
- auto now = std::chrono::steady_clock::now();
- if (now >= timeout_time) {
- timed_out = true;
- break;
- }
- // Run the runloop for a short time
- lock.unlock();
- CFRunLoopRunInMode(kCFRunLoopDefaultMode, 0.1, true);
- lock.lock();
- }
- }
- // Clean up
- CFHostUnscheduleFromRunLoop(host_ref, run_loop, kCFRunLoopDefaultMode);
- CFHostSetClient(host_ref, nullptr, nullptr);
- if (timed_out || !context.completed) {
- CFHostCancelInfoResolution(host_ref, kCFHostAddresses);
- CFRelease(host_ref);
- return EAI_AGAIN;
- }
- if (!context.success || !context.addresses) {
- CFRelease(host_ref);
- return EAI_NODATA;
- }
- // Convert CFArray to addrinfo
- CFIndex count = CFArrayGetCount(context.addresses);
- if (count == 0) {
- CFRelease(context.addresses);
- CFRelease(host_ref);
- return EAI_NODATA;
- }
- struct addrinfo *result_addrinfo = nullptr;
- struct addrinfo **current = &result_addrinfo;
- for (CFIndex i = 0; i < count; i++) {
- CFDataRef addr_data =
- static_cast<CFDataRef>(CFArrayGetValueAtIndex(context.addresses, i));
- if (!addr_data) continue;
- const struct sockaddr *sockaddr_ptr =
- reinterpret_cast<const struct sockaddr *>(CFDataGetBytePtr(addr_data));
- socklen_t sockaddr_len = static_cast<socklen_t>(CFDataGetLength(addr_data));
- // Allocate addrinfo structure
- *current = static_cast<struct addrinfo *>(malloc(sizeof(struct addrinfo)));
- if (!*current) {
- freeaddrinfo(result_addrinfo);
- CFRelease(context.addresses);
- CFRelease(host_ref);
- return EAI_MEMORY;
- }
- memset(*current, 0, sizeof(struct addrinfo));
- // Set up addrinfo fields
- (*current)->ai_family = sockaddr_ptr->sa_family;
- (*current)->ai_socktype = hints ? hints->ai_socktype : SOCK_STREAM;
- (*current)->ai_protocol = hints ? hints->ai_protocol : IPPROTO_TCP;
- (*current)->ai_addrlen = sockaddr_len;
- // Copy sockaddr
- (*current)->ai_addr = static_cast<struct sockaddr *>(malloc(sockaddr_len));
- if (!(*current)->ai_addr) {
- freeaddrinfo(result_addrinfo);
- CFRelease(context.addresses);
- CFRelease(host_ref);
- return EAI_MEMORY;
- }
- memcpy((*current)->ai_addr, sockaddr_ptr, sockaddr_len);
- // Set port if service is specified
- if (service && *service) {
- int port = 0;
- if (parse_port(service, strlen(service), port)) {
- if (sockaddr_ptr->sa_family == AF_INET) {
- reinterpret_cast<struct sockaddr_in *>((*current)->ai_addr)
- ->sin_port = htons(static_cast<uint16_t>(port));
- } else if (sockaddr_ptr->sa_family == AF_INET6) {
- reinterpret_cast<struct sockaddr_in6 *>((*current)->ai_addr)
- ->sin6_port = htons(static_cast<uint16_t>(port));
- }
- }
- }
- current = &((*current)->ai_next);
- }
- CFRelease(context.addresses);
- CFRelease(host_ref);
- *res = result_addrinfo;
- return 0;
- #elif defined(_GNU_SOURCE) && defined(__GLIBC__) && \
- (__GLIBC__ > 2 || (__GLIBC__ == 2 && __GLIBC_MINOR__ >= 2))
- // #2431: gai_cancel() is non-blocking and may return EAI_NOTCANCELED while
- // the resolver worker still references the stack-local gaicb. The cancel
- // path therefore waits (gai_suspend with no timeout) for the worker to
- // actually finish before letting the stack frame go. The trade-off is that
- // a wedged DNS server can hold this thread for the system resolver timeout
- // (~30s by default) past the caller's connection timeout.
- struct gaicb request {};
- struct gaicb *requests[1] = {&request};
- struct sigevent sevp {};
- struct timespec timeout {
- timeout_sec, 0
- };
- request.ar_name = node;
- request.ar_service = service;
- request.ar_request = hints;
- sevp.sigev_notify = SIGEV_NONE;
- int rc = getaddrinfo_a(GAI_NOWAIT, requests, 1, &sevp);
- if (rc != 0) { return rc; }
- auto cleanup = scope_exit([&] {
- if (request.ar_result) { freeaddrinfo(request.ar_result); }
- });
- int wait_result = gai_suspend(requests, 1, &timeout);
- if (wait_result == 0 || wait_result == EAI_ALLDONE) {
- int gai_result = gai_error(&request);
- if (gai_result == 0) {
- *res = request.ar_result;
- request.ar_result = nullptr;
- return 0;
- }
- return gai_result;
- }
- gai_cancel(&request);
- while (gai_error(&request) == EAI_INPROGRESS) {
- gai_suspend(requests, 1, nullptr);
- }
- return wait_result;
- #else
- // Fallback implementation using thread-based timeout for other Unix systems.
- struct GetAddrInfoState {
- ~GetAddrInfoState() {
- if (info) { freeaddrinfo(info); }
- }
- std::mutex mutex;
- std::condition_variable result_cv;
- bool completed = false;
- int result = EAI_SYSTEM;
- std::string node;
- std::string service;
- struct addrinfo hints;
- struct addrinfo *info = nullptr;
- };
- // Allocate on the heap, so the resolver thread can keep using the data.
- auto state = std::make_shared<GetAddrInfoState>();
- if (node) { state->node = node; }
- state->service = service;
- state->hints = *hints;
- std::thread resolve_thread([state]() {
- auto thread_result =
- getaddrinfo(state->node.c_str(), state->service.c_str(), &state->hints,
- &state->info);
- std::lock_guard<std::mutex> lock(state->mutex);
- state->result = thread_result;
- state->completed = true;
- state->result_cv.notify_one();
- });
- // Wait for completion or timeout
- std::unique_lock<std::mutex> lock(state->mutex);
- auto finished =
- state->result_cv.wait_for(lock, std::chrono::seconds(timeout_sec),
- [&] { return state->completed; });
- if (finished) {
- // Operation completed within timeout
- resolve_thread.join();
- *res = state->info;
- state->info = nullptr; // Pass ownership to caller
- return state->result;
- } else {
- // Timeout occurred
- resolve_thread.detach(); // Let the thread finish in background
- return EAI_AGAIN; // Return timeout error
- }
- #endif
- #else
- (void)(timeout_sec); // Unused parameter for non-blocking getaddrinfo
- return getaddrinfo(node, service, hints, res);
- #endif
- }
- template <typename BindOrConnect>
- socket_t create_socket(const std::string &host, const std::string &ip, int port,
- int address_family, int socket_flags, bool tcp_nodelay,
- bool ipv6_v6only, SocketOptions socket_options,
- BindOrConnect bind_or_connect, time_t timeout_sec = 0) {
- // Get address info
- const char *node = nullptr;
- struct addrinfo hints;
- struct addrinfo *result;
- memset(&hints, 0, sizeof(struct addrinfo));
- hints.ai_socktype = SOCK_STREAM;
- hints.ai_protocol = IPPROTO_IP;
- if (!ip.empty()) {
- node = ip.c_str();
- // Ask getaddrinfo to convert IP in c-string to address
- hints.ai_family = AF_UNSPEC;
- hints.ai_flags = AI_NUMERICHOST;
- } else {
- if (!host.empty()) { node = host.c_str(); }
- hints.ai_family = address_family;
- hints.ai_flags = socket_flags;
- }
- #if !defined(_WIN32) || defined(CPPHTTPLIB_HAVE_AFUNIX_H)
- if (hints.ai_family == AF_UNIX) {
- const auto addrlen = host.length();
- if (addrlen > sizeof(sockaddr_un::sun_path)) { return INVALID_SOCKET; }
- #ifdef SOCK_CLOEXEC
- auto sock = socket(hints.ai_family, hints.ai_socktype | SOCK_CLOEXEC,
- hints.ai_protocol);
- #else
- auto sock = socket(hints.ai_family, hints.ai_socktype, hints.ai_protocol);
- #endif
- if (sock != INVALID_SOCKET) {
- sockaddr_un addr{};
- addr.sun_family = AF_UNIX;
- auto unescaped_host = unescape_abstract_namespace_unix_domain(host);
- std::copy(unescaped_host.begin(), unescaped_host.end(), addr.sun_path);
- hints.ai_addr = reinterpret_cast<sockaddr *>(&addr);
- hints.ai_addrlen = static_cast<socklen_t>(
- sizeof(addr) - sizeof(addr.sun_path) + addrlen);
- #ifndef SOCK_CLOEXEC
- #ifndef _WIN32
- fcntl(sock, F_SETFD, FD_CLOEXEC);
- #endif
- #endif
- if (socket_options) { socket_options(sock); }
- #ifdef _WIN32
- // Setting SO_REUSEADDR seems not to work well with AF_UNIX on windows, so
- // remove the option.
- set_socket_opt(sock, SOL_SOCKET, SO_REUSEADDR, 0);
- #endif
- bool dummy;
- if (!bind_or_connect(sock, hints, dummy)) {
- close_socket(sock);
- sock = INVALID_SOCKET;
- }
- }
- return sock;
- }
- #endif
- auto service = std::to_string(port);
- if (getaddrinfo_with_timeout(node, service.c_str(), &hints, &result,
- timeout_sec)) {
- #if defined __linux__ && !defined __ANDROID__
- res_init();
- #endif
- return INVALID_SOCKET;
- }
- auto se = detail::scope_exit([&] { freeaddrinfo(result); });
- for (auto rp = result; rp; rp = rp->ai_next) {
- // Create a socket
- #ifdef _WIN32
- auto sock =
- WSASocketW(rp->ai_family, rp->ai_socktype, rp->ai_protocol, nullptr, 0,
- WSA_FLAG_NO_HANDLE_INHERIT | WSA_FLAG_OVERLAPPED);
- /**
- * Since the WSA_FLAG_NO_HANDLE_INHERIT is only supported on Windows 7 SP1
- * and above the socket creation fails on older Windows Systems.
- *
- * Let's try to create a socket the old way in this case.
- *
- * Reference:
- * https://docs.microsoft.com/en-us/windows/win32/api/winsock2/nf-winsock2-wsasocketa
- *
- * WSA_FLAG_NO_HANDLE_INHERIT:
- * This flag is supported on Windows 7 with SP1, Windows Server 2008 R2 with
- * SP1, and later
- *
- */
- if (sock == INVALID_SOCKET) {
- sock = socket(rp->ai_family, rp->ai_socktype, rp->ai_protocol);
- }
- #else
- #ifdef SOCK_CLOEXEC
- auto sock =
- socket(rp->ai_family, rp->ai_socktype | SOCK_CLOEXEC, rp->ai_protocol);
- #else
- auto sock = socket(rp->ai_family, rp->ai_socktype, rp->ai_protocol);
- #endif
- #endif
- if (sock == INVALID_SOCKET) { continue; }
- #if !defined _WIN32 && !defined SOCK_CLOEXEC
- if (fcntl(sock, F_SETFD, FD_CLOEXEC) == -1) {
- close_socket(sock);
- continue;
- }
- #endif
- if (tcp_nodelay) { set_socket_opt(sock, IPPROTO_TCP, TCP_NODELAY, 1); }
- if (rp->ai_family == AF_INET6) {
- set_socket_opt(sock, IPPROTO_IPV6, IPV6_V6ONLY, ipv6_v6only ? 1 : 0);
- }
- if (socket_options) { socket_options(sock); }
- // bind or connect
- auto quit = false;
- if (bind_or_connect(sock, *rp, quit)) { return sock; }
- close_socket(sock);
- if (quit) { break; }
- }
- return INVALID_SOCKET;
- }
- inline void set_nonblocking(socket_t sock, bool nonblocking) {
- #ifdef _WIN32
- auto flags = nonblocking ? 1UL : 0UL;
- ioctlsocket(sock, FIONBIO, &flags);
- #else
- auto flags = fcntl(sock, F_GETFL, 0);
- fcntl(sock, F_SETFL,
- nonblocking ? (flags | O_NONBLOCK) : (flags & (~O_NONBLOCK)));
- #endif
- }
- inline bool is_connection_error() {
- #ifdef _WIN32
- return WSAGetLastError() != WSAEWOULDBLOCK;
- #else
- return errno != EINPROGRESS;
- #endif
- }
- inline bool bind_ip_address(socket_t sock, const std::string &host) {
- struct addrinfo hints;
- struct addrinfo *result;
- memset(&hints, 0, sizeof(struct addrinfo));
- hints.ai_family = AF_UNSPEC;
- hints.ai_socktype = SOCK_STREAM;
- hints.ai_protocol = 0;
- if (getaddrinfo_with_timeout(host.c_str(), "0", &hints, &result, 0)) {
- return false;
- }
- auto se = detail::scope_exit([&] { freeaddrinfo(result); });
- auto ret = false;
- for (auto rp = result; rp; rp = rp->ai_next) {
- const auto &ai = *rp;
- if (!::bind(sock, ai.ai_addr, static_cast<socklen_t>(ai.ai_addrlen))) {
- ret = true;
- break;
- }
- }
- return ret;
- }
- #if !defined _WIN32 && !defined ANDROID && !defined _AIX && !defined __MVS__
- #define USE_IF2IP
- #endif
- #ifdef USE_IF2IP
- inline std::string if2ip(int address_family, const std::string &ifn) {
- struct ifaddrs *ifap;
- getifaddrs(&ifap);
- auto se = detail::scope_exit([&] { freeifaddrs(ifap); });
- std::string addr_candidate;
- for (auto ifa = ifap; ifa; ifa = ifa->ifa_next) {
- if (ifa->ifa_addr && ifn == ifa->ifa_name &&
- (AF_UNSPEC == address_family ||
- ifa->ifa_addr->sa_family == address_family)) {
- if (ifa->ifa_addr->sa_family == AF_INET) {
- auto sa = reinterpret_cast<struct sockaddr_in *>(ifa->ifa_addr);
- char buf[INET_ADDRSTRLEN];
- if (inet_ntop(AF_INET, &sa->sin_addr, buf, INET_ADDRSTRLEN)) {
- return std::string(buf, INET_ADDRSTRLEN);
- }
- } else if (ifa->ifa_addr->sa_family == AF_INET6) {
- auto sa = reinterpret_cast<struct sockaddr_in6 *>(ifa->ifa_addr);
- if (!IN6_IS_ADDR_LINKLOCAL(&sa->sin6_addr)) {
- char buf[INET6_ADDRSTRLEN] = {};
- if (inet_ntop(AF_INET6, &sa->sin6_addr, buf, INET6_ADDRSTRLEN)) {
- // equivalent to mac's IN6_IS_ADDR_UNIQUE_LOCAL
- auto s6_addr_head = sa->sin6_addr.s6_addr[0];
- if (s6_addr_head == 0xfc || s6_addr_head == 0xfd) {
- addr_candidate = std::string(buf, INET6_ADDRSTRLEN);
- } else {
- return std::string(buf, INET6_ADDRSTRLEN);
- }
- }
- }
- }
- }
- }
- return addr_candidate;
- }
- #endif
- inline socket_t create_client_socket(
- const std::string &host, const std::string &ip, int port,
- int address_family, bool tcp_nodelay, bool ipv6_v6only,
- SocketOptions socket_options, time_t connection_timeout_sec,
- time_t connection_timeout_usec, time_t read_timeout_sec,
- time_t read_timeout_usec, time_t write_timeout_sec,
- time_t write_timeout_usec, const std::string &intf, Error &error) {
- auto sock = create_socket(
- host, ip, port, address_family, 0, tcp_nodelay, ipv6_v6only,
- std::move(socket_options),
- [&](socket_t sock2, struct addrinfo &ai, bool &quit) -> bool {
- if (!intf.empty()) {
- #ifdef USE_IF2IP
- auto ip_from_if = if2ip(address_family, intf);
- if (ip_from_if.empty()) { ip_from_if = intf; }
- if (!bind_ip_address(sock2, ip_from_if)) {
- error = Error::BindIPAddress;
- return false;
- }
- #endif
- }
- set_nonblocking(sock2, true);
- auto ret =
- ::connect(sock2, ai.ai_addr, static_cast<socklen_t>(ai.ai_addrlen));
- if (ret < 0) {
- if (is_connection_error()) {
- error = Error::Connection;
- return false;
- }
- error = wait_until_socket_is_ready(sock2, connection_timeout_sec,
- connection_timeout_usec);
- if (error != Error::Success) {
- if (error == Error::ConnectionTimeout) { quit = true; }
- return false;
- }
- }
- set_nonblocking(sock2, false);
- set_socket_opt_time(sock2, SOL_SOCKET, SO_RCVTIMEO, read_timeout_sec,
- read_timeout_usec);
- set_socket_opt_time(sock2, SOL_SOCKET, SO_SNDTIMEO, write_timeout_sec,
- write_timeout_usec);
- error = Error::Success;
- return true;
- },
- connection_timeout_sec); // Pass DNS timeout
- if (sock != INVALID_SOCKET) {
- error = Error::Success;
- } else {
- if (error == Error::Success) { error = Error::Connection; }
- }
- return sock;
- }
- inline bool get_ip_and_port(const struct sockaddr_storage &addr,
- socklen_t addr_len, std::string &ip, int &port) {
- if (addr.ss_family == AF_INET) {
- port = ntohs(reinterpret_cast<const struct sockaddr_in *>(&addr)->sin_port);
- } else if (addr.ss_family == AF_INET6) {
- port =
- ntohs(reinterpret_cast<const struct sockaddr_in6 *>(&addr)->sin6_port);
- } else {
- return false;
- }
- std::array<char, NI_MAXHOST> ipstr{};
- if (getnameinfo(reinterpret_cast<const struct sockaddr *>(&addr), addr_len,
- ipstr.data(), static_cast<socklen_t>(ipstr.size()), nullptr,
- 0, NI_NUMERICHOST)) {
- return false;
- }
- ip = ipstr.data();
- return true;
- }
- inline void get_local_ip_and_port(socket_t sock, std::string &ip, int &port) {
- struct sockaddr_storage addr;
- socklen_t addr_len = sizeof(addr);
- if (!getsockname(sock, reinterpret_cast<struct sockaddr *>(&addr),
- &addr_len)) {
- get_ip_and_port(addr, addr_len, ip, port);
- }
- }
- inline void get_remote_ip_and_port(socket_t sock, std::string &ip, int &port) {
- struct sockaddr_storage addr;
- socklen_t addr_len = sizeof(addr);
- if (!getpeername(sock, reinterpret_cast<struct sockaddr *>(&addr),
- &addr_len)) {
- #ifndef _WIN32
- if (addr.ss_family == AF_UNIX) {
- #if defined(__linux__)
- struct ucred ucred;
- socklen_t len = sizeof(ucred);
- if (getsockopt(sock, SOL_SOCKET, SO_PEERCRED, &ucred, &len) == 0) {
- port = ucred.pid;
- }
- #elif defined(SOL_LOCAL) && defined(SO_PEERPID)
- pid_t pid;
- socklen_t len = sizeof(pid);
- if (getsockopt(sock, SOL_LOCAL, SO_PEERPID, &pid, &len) == 0) {
- port = pid;
- }
- #endif
- return;
- }
- #endif
- get_ip_and_port(addr, addr_len, ip, port);
- }
- }
- // Recursive form retained so operator""_t below can compute hashes for
- // switch-case labels at compile time (C++11 constexpr forbids loops). Do not
- // call from runtime paths with arbitrary-length inputs — use str2tag()
- // instead, which is iterative and stack-safe.
- inline constexpr unsigned int str2tag_core(const char *s, size_t l,
- unsigned int h) {
- return (l == 0)
- ? h
- : str2tag_core(
- s + 1, l - 1,
- // Unsets the 6 high bits of h, therefore no overflow happens
- (((std::numeric_limits<unsigned int>::max)() >> 6) &
- h * 33) ^
- static_cast<unsigned char>(*s));
- }
- inline unsigned int str2tag(const std::string &s) {
- // Iterative form of str2tag_core: the recursive constexpr version is kept
- // for compile-time UDL evaluation of short string literals, but at runtime
- // we may receive arbitrarily long inputs (e.g. fuzzed Content-Type) that
- // would blow the stack with one frame per character.
- unsigned int h = 0;
- for (auto c : s) {
- h = (((std::numeric_limits<unsigned int>::max)() >> 6) & h * 33) ^
- static_cast<unsigned char>(c);
- }
- return h;
- }
- namespace udl {
- inline constexpr unsigned int operator""_t(const char *s, size_t l) {
- return str2tag_core(s, l, 0);
- }
- } // namespace udl
- inline std::string
- find_content_type(const std::string &path,
- const std::map<std::string, std::string> &user_data,
- const std::string &default_content_type) {
- auto ext = file_extension(path);
- auto it = user_data.find(ext);
- if (it != user_data.end()) { return it->second; }
- using udl::operator""_t;
- switch (str2tag(ext)) {
- default: return default_content_type;
- case "css"_t: return "text/css";
- case "csv"_t: return "text/csv";
- case "htm"_t:
- case "html"_t: return "text/html";
- case "js"_t:
- case "mjs"_t: return "text/javascript";
- case "txt"_t: return "text/plain";
- case "vtt"_t: return "text/vtt";
- case "apng"_t: return "image/apng";
- case "avif"_t: return "image/avif";
- case "bmp"_t: return "image/bmp";
- case "gif"_t: return "image/gif";
- case "png"_t: return "image/png";
- case "svg"_t: return "image/svg+xml";
- case "webp"_t: return "image/webp";
- case "ico"_t: return "image/x-icon";
- case "tif"_t: return "image/tiff";
- case "tiff"_t: return "image/tiff";
- case "jpg"_t:
- case "jpeg"_t: return "image/jpeg";
- case "mp4"_t: return "video/mp4";
- case "mpeg"_t: return "video/mpeg";
- case "webm"_t: return "video/webm";
- case "mp3"_t: return "audio/mp3";
- case "mpga"_t: return "audio/mpeg";
- case "weba"_t: return "audio/webm";
- case "wav"_t: return "audio/wave";
- case "otf"_t: return "font/otf";
- case "ttf"_t: return "font/ttf";
- case "woff"_t: return "font/woff";
- case "woff2"_t: return "font/woff2";
- case "7z"_t: return "application/x-7z-compressed";
- case "atom"_t: return "application/atom+xml";
- case "pdf"_t: return "application/pdf";
- case "json"_t: return "application/json";
- case "rss"_t: return "application/rss+xml";
- case "tar"_t: return "application/x-tar";
- case "xht"_t:
- case "xhtml"_t: return "application/xhtml+xml";
- case "xslt"_t: return "application/xslt+xml";
- case "xml"_t: return "application/xml";
- case "gz"_t: return "application/gzip";
- case "zip"_t: return "application/zip";
- case "wasm"_t: return "application/wasm";
- }
- }
- inline std::string
- extract_media_type(const std::string &content_type,
- std::map<std::string, std::string> *params = nullptr) {
- // Extract type/subtype from Content-Type value (RFC 2045)
- // e.g. "application/json; charset=utf-8" -> "application/json"
- auto media_type = content_type;
- auto semicolon_pos = media_type.find(';');
- if (semicolon_pos != std::string::npos) {
- auto param_str = media_type.substr(semicolon_pos + 1);
- media_type = media_type.substr(0, semicolon_pos);
- if (params) {
- // Parse parameters: key=value pairs separated by ';'
- split(param_str.data(), param_str.data() + param_str.size(), ';',
- [&](const char *b, const char *e) {
- std::string key;
- std::string val;
- split(b, e, '=', [&](const char *b2, const char *e2) {
- if (key.empty()) {
- key.assign(b2, e2);
- } else {
- val.assign(b2, e2);
- }
- });
- if (!key.empty()) {
- params->emplace(trim_copy(key), trim_double_quotes_copy(val));
- }
- });
- }
- }
- // Trim whitespace from media type
- return trim_copy(media_type);
- }
- inline bool can_compress_content_type(const std::string &content_type) {
- using udl::operator""_t;
- auto mime_type = extract_media_type(content_type);
- auto tag = str2tag(mime_type);
- switch (tag) {
- case "image/svg+xml"_t:
- case "application/javascript"_t:
- case "application/x-javascript"_t:
- case "application/json"_t:
- case "application/ld+json"_t:
- case "application/xml"_t:
- case "application/xhtml+xml"_t:
- case "application/rss+xml"_t:
- case "application/atom+xml"_t:
- case "application/xslt+xml"_t:
- case "application/protobuf"_t: return true;
- case "text/event-stream"_t: return false;
- default: return !mime_type.rfind("text/", 0);
- }
- }
- inline bool parse_quality(const char *b, const char *e, std::string &token,
- double &quality) {
- quality = 1.0;
- token.clear();
- // Split on first ';': left = token name, right = parameters
- const char *params_b = nullptr;
- std::size_t params_len = 0;
- divide(
- b, static_cast<std::size_t>(e - b), ';',
- [&](const char *lb, std::size_t llen, const char *rb, std::size_t rlen) {
- auto r = trim(lb, lb + llen, 0, llen);
- if (r.first < r.second) { token.assign(lb + r.first, lb + r.second); }
- params_b = rb;
- params_len = rlen;
- });
- if (token.empty()) { return false; }
- if (params_len == 0) { return true; }
- // Scan parameters for q= (stops on first match)
- bool invalid = false;
- split_find(params_b, params_b + params_len, ';',
- (std::numeric_limits<size_t>::max)(),
- [&](const char *pb, const char *pe) -> bool {
- // Match exactly "q=" or "Q=" (not "query=" etc.)
- auto len = static_cast<size_t>(pe - pb);
- if (len < 2) { return false; }
- if ((pb[0] != 'q' && pb[0] != 'Q') || pb[1] != '=') {
- return false;
- }
- // Trim the value portion
- auto r = trim(pb, pe, 2, len);
- if (r.first >= r.second) {
- invalid = true;
- return true;
- }
- double v = 0.0;
- auto res = from_chars(pb + r.first, pb + r.second, v);
- if (res.ec != std::errc{} || v < 0.0 || v > 1.0) {
- invalid = true;
- return true;
- }
- quality = v;
- return true;
- });
- return !invalid;
- }
- inline EncodingType encoding_type(const Request &req, const Response &res) {
- if (!can_compress_content_type(res.get_header_value("Content-Type"))) {
- return EncodingType::None;
- }
- const auto &s = req.get_header_value("Accept-Encoding");
- if (s.empty()) { return EncodingType::None; }
- // Single-pass: iterate tokens and track the best supported encoding.
- // Server preference breaks ties (br > gzip > zstd).
- EncodingType best = EncodingType::None;
- double best_q = 0.0; // q=0 means "not acceptable"
- // Server preference: Brotli > Gzip > Zstd (lower = more preferred)
- auto priority = [](EncodingType t) -> int {
- switch (t) {
- case EncodingType::Brotli: return 0;
- case EncodingType::Gzip: return 1;
- case EncodingType::Zstd: return 2;
- default: return 3;
- }
- };
- std::string name;
- split(s.data(), s.data() + s.size(), ',', [&](const char *b, const char *e) {
- double quality = 1.0;
- if (!parse_quality(b, e, name, quality)) { return; }
- if (quality <= 0.0) { return; }
- EncodingType type = EncodingType::None;
- #ifdef CPPHTTPLIB_BROTLI_SUPPORT
- if (case_ignore::equal(name, "br")) { type = EncodingType::Brotli; }
- #endif
- #ifdef CPPHTTPLIB_ZLIB_SUPPORT
- if (type == EncodingType::None && case_ignore::equal(name, "gzip")) {
- type = EncodingType::Gzip;
- }
- #endif
- #ifdef CPPHTTPLIB_ZSTD_SUPPORT
- if (type == EncodingType::None && case_ignore::equal(name, "zstd")) {
- type = EncodingType::Zstd;
- }
- #endif
- if (type == EncodingType::None) { return; }
- // Higher q-value wins; for equal q, server preference breaks ties
- if (quality > best_q ||
- (quality == best_q && priority(type) < priority(best))) {
- best_q = quality;
- best = type;
- }
- });
- return best;
- }
- inline std::unique_ptr<compressor> make_compressor(EncodingType type) {
- #ifdef CPPHTTPLIB_ZLIB_SUPPORT
- if (type == EncodingType::Gzip) {
- return detail::make_unique<gzip_compressor>();
- }
- #endif
- #ifdef CPPHTTPLIB_BROTLI_SUPPORT
- if (type == EncodingType::Brotli) {
- return detail::make_unique<brotli_compressor>();
- }
- #endif
- #ifdef CPPHTTPLIB_ZSTD_SUPPORT
- if (type == EncodingType::Zstd) {
- return detail::make_unique<zstd_compressor>();
- }
- #endif
- (void)type;
- return nullptr;
- }
- inline const char *encoding_name(EncodingType type) {
- switch (type) {
- case EncodingType::Gzip: return "gzip";
- case EncodingType::Brotli: return "br";
- case EncodingType::Zstd: return "zstd";
- default: return "";
- }
- }
- inline bool nocompressor::compress(const char *data, size_t data_length,
- bool /*last*/, Callback callback) {
- if (!data_length) { return true; }
- return callback(data, data_length);
- }
- #ifdef CPPHTTPLIB_ZLIB_SUPPORT
- inline gzip_compressor::gzip_compressor() {
- std::memset(&strm_, 0, sizeof(strm_));
- strm_.zalloc = Z_NULL;
- strm_.zfree = Z_NULL;
- strm_.opaque = Z_NULL;
- is_valid_ = deflateInit2(&strm_, Z_DEFAULT_COMPRESSION, Z_DEFLATED, 31, 8,
- Z_DEFAULT_STRATEGY) == Z_OK;
- }
- inline gzip_compressor::~gzip_compressor() { deflateEnd(&strm_); }
- inline bool gzip_compressor::compress(const char *data, size_t data_length,
- bool last, Callback callback) {
- assert(is_valid_);
- do {
- constexpr size_t max_avail_in =
- (std::numeric_limits<decltype(strm_.avail_in)>::max)();
- strm_.avail_in = static_cast<decltype(strm_.avail_in)>(
- (std::min)(data_length, max_avail_in));
- strm_.next_in = const_cast<Bytef *>(reinterpret_cast<const Bytef *>(data));
- data_length -= strm_.avail_in;
- data += strm_.avail_in;
- auto flush = (last && data_length == 0) ? Z_FINISH : Z_NO_FLUSH;
- auto ret = Z_OK;
- std::array<char, CPPHTTPLIB_COMPRESSION_BUFSIZ> buff{};
- do {
- strm_.avail_out = static_cast<uInt>(buff.size());
- strm_.next_out = reinterpret_cast<Bytef *>(buff.data());
- ret = deflate(&strm_, flush);
- if (ret == Z_STREAM_ERROR) { return false; }
- if (!callback(buff.data(), buff.size() - strm_.avail_out)) {
- return false;
- }
- } while (strm_.avail_out == 0);
- assert((flush == Z_FINISH && ret == Z_STREAM_END) ||
- (flush == Z_NO_FLUSH && ret == Z_OK));
- assert(strm_.avail_in == 0);
- } while (data_length > 0);
- return true;
- }
- inline gzip_decompressor::gzip_decompressor() {
- std::memset(&strm_, 0, sizeof(strm_));
- strm_.zalloc = Z_NULL;
- strm_.zfree = Z_NULL;
- strm_.opaque = Z_NULL;
- // 15 is the value of wbits, which should be at the maximum possible value
- // to ensure that any gzip stream can be decoded. The offset of 32 specifies
- // that the stream type should be automatically detected either gzip or
- // deflate.
- is_valid_ = inflateInit2(&strm_, 32 + 15) == Z_OK;
- }
- inline gzip_decompressor::~gzip_decompressor() { inflateEnd(&strm_); }
- inline bool gzip_decompressor::is_valid() const { return is_valid_; }
- inline bool gzip_decompressor::decompress(const char *data, size_t data_length,
- Callback callback) {
- assert(is_valid_);
- auto ret = Z_OK;
- do {
- constexpr size_t max_avail_in =
- (std::numeric_limits<decltype(strm_.avail_in)>::max)();
- strm_.avail_in = static_cast<decltype(strm_.avail_in)>(
- (std::min)(data_length, max_avail_in));
- strm_.next_in = const_cast<Bytef *>(reinterpret_cast<const Bytef *>(data));
- data_length -= strm_.avail_in;
- data += strm_.avail_in;
- std::array<char, CPPHTTPLIB_COMPRESSION_BUFSIZ> buff{};
- while (strm_.avail_in > 0 && ret == Z_OK) {
- strm_.avail_out = static_cast<uInt>(buff.size());
- strm_.next_out = reinterpret_cast<Bytef *>(buff.data());
- ret = inflate(&strm_, Z_NO_FLUSH);
- assert(ret != Z_STREAM_ERROR);
- switch (ret) {
- case Z_NEED_DICT:
- case Z_DATA_ERROR:
- case Z_MEM_ERROR: inflateEnd(&strm_); return false;
- }
- if (!callback(buff.data(), buff.size() - strm_.avail_out)) {
- return false;
- }
- }
- if (ret != Z_OK && ret != Z_STREAM_END) { return false; }
- } while (data_length > 0);
- return true;
- }
- #endif
- #ifdef CPPHTTPLIB_BROTLI_SUPPORT
- inline brotli_compressor::brotli_compressor() {
- state_ = BrotliEncoderCreateInstance(nullptr, nullptr, nullptr);
- }
- inline brotli_compressor::~brotli_compressor() {
- BrotliEncoderDestroyInstance(state_);
- }
- inline bool brotli_compressor::compress(const char *data, size_t data_length,
- bool last, Callback callback) {
- std::array<uint8_t, CPPHTTPLIB_COMPRESSION_BUFSIZ> buff{};
- auto operation = last ? BROTLI_OPERATION_FINISH : BROTLI_OPERATION_PROCESS;
- auto available_in = data_length;
- auto next_in = reinterpret_cast<const uint8_t *>(data);
- for (;;) {
- if (last) {
- if (BrotliEncoderIsFinished(state_)) { break; }
- } else {
- if (!available_in) { break; }
- }
- auto available_out = buff.size();
- auto next_out = buff.data();
- if (!BrotliEncoderCompressStream(state_, operation, &available_in, &next_in,
- &available_out, &next_out, nullptr)) {
- return false;
- }
- auto output_bytes = buff.size() - available_out;
- if (output_bytes) {
- callback(reinterpret_cast<const char *>(buff.data()), output_bytes);
- }
- }
- return true;
- }
- inline brotli_decompressor::brotli_decompressor() {
- decoder_s = BrotliDecoderCreateInstance(0, 0, 0);
- decoder_r = decoder_s ? BROTLI_DECODER_RESULT_NEEDS_MORE_INPUT
- : BROTLI_DECODER_RESULT_ERROR;
- }
- inline brotli_decompressor::~brotli_decompressor() {
- if (decoder_s) { BrotliDecoderDestroyInstance(decoder_s); }
- }
- inline bool brotli_decompressor::is_valid() const { return decoder_s; }
- inline bool brotli_decompressor::decompress(const char *data,
- size_t data_length,
- Callback callback) {
- if (decoder_r == BROTLI_DECODER_RESULT_SUCCESS ||
- decoder_r == BROTLI_DECODER_RESULT_ERROR) {
- return 0;
- }
- auto next_in = reinterpret_cast<const uint8_t *>(data);
- size_t avail_in = data_length;
- size_t total_out;
- decoder_r = BROTLI_DECODER_RESULT_NEEDS_MORE_OUTPUT;
- std::array<char, CPPHTTPLIB_COMPRESSION_BUFSIZ> buff{};
- while (decoder_r == BROTLI_DECODER_RESULT_NEEDS_MORE_OUTPUT) {
- char *next_out = buff.data();
- size_t avail_out = buff.size();
- decoder_r = BrotliDecoderDecompressStream(
- decoder_s, &avail_in, &next_in, &avail_out,
- reinterpret_cast<uint8_t **>(&next_out), &total_out);
- if (decoder_r == BROTLI_DECODER_RESULT_ERROR) { return false; }
- if (!callback(buff.data(), buff.size() - avail_out)) { return false; }
- }
- return decoder_r == BROTLI_DECODER_RESULT_SUCCESS ||
- decoder_r == BROTLI_DECODER_RESULT_NEEDS_MORE_INPUT;
- }
- #endif
- #ifdef CPPHTTPLIB_ZSTD_SUPPORT
- inline zstd_compressor::zstd_compressor() {
- ctx_ = ZSTD_createCCtx();
- ZSTD_CCtx_setParameter(ctx_, ZSTD_c_compressionLevel, ZSTD_fast);
- }
- inline zstd_compressor::~zstd_compressor() { ZSTD_freeCCtx(ctx_); }
- inline bool zstd_compressor::compress(const char *data, size_t data_length,
- bool last, Callback callback) {
- std::array<char, CPPHTTPLIB_COMPRESSION_BUFSIZ> buff{};
- ZSTD_EndDirective mode = last ? ZSTD_e_end : ZSTD_e_continue;
- ZSTD_inBuffer input = {data, data_length, 0};
- bool finished;
- do {
- ZSTD_outBuffer output = {buff.data(), CPPHTTPLIB_COMPRESSION_BUFSIZ, 0};
- size_t const remaining = ZSTD_compressStream2(ctx_, &output, &input, mode);
- if (ZSTD_isError(remaining)) { return false; }
- if (!callback(buff.data(), output.pos)) { return false; }
- finished = last ? (remaining == 0) : (input.pos == input.size);
- } while (!finished);
- return true;
- }
- inline zstd_decompressor::zstd_decompressor() { ctx_ = ZSTD_createDCtx(); }
- inline zstd_decompressor::~zstd_decompressor() { ZSTD_freeDCtx(ctx_); }
- inline bool zstd_decompressor::is_valid() const { return ctx_ != nullptr; }
- inline bool zstd_decompressor::decompress(const char *data, size_t data_length,
- Callback callback) {
- std::array<char, CPPHTTPLIB_COMPRESSION_BUFSIZ> buff{};
- ZSTD_inBuffer input = {data, data_length, 0};
- while (input.pos < input.size) {
- ZSTD_outBuffer output = {buff.data(), CPPHTTPLIB_COMPRESSION_BUFSIZ, 0};
- size_t const remaining = ZSTD_decompressStream(ctx_, &output, &input);
- if (ZSTD_isError(remaining)) { return false; }
- if (!callback(buff.data(), output.pos)) { return false; }
- }
- return true;
- }
- #endif
- inline bool contains_case_ignore(const std::string &s, const char *token) {
- auto token_end = token + std::strlen(token);
- return std::search(s.begin(), s.end(), token, token_end, [](char a, char b) {
- return case_ignore::to_lower(a) == case_ignore::to_lower(b);
- }) != s.end();
- }
- // Content codings are case-insensitive (RFC 9110 8.4.1). Matching them
- // case-sensitively would make a response labeled e.g. "GZIP" look like an
- // unknown coding, and its payload would be handed back still compressed.
- inline bool is_zlib_encoding(const std::string &encoding) {
- return case_ignore::equal(encoding, "gzip") ||
- case_ignore::equal(encoding, "deflate");
- }
- inline bool is_brotli_encoding(const std::string &encoding) {
- return contains_case_ignore(encoding, "br");
- }
- inline bool is_zstd_encoding(const std::string &encoding) {
- return contains_case_ignore(encoding, "zstd");
- }
- // Returns true if the content coding is one cpp-httplib is able to decompress
- // when the corresponding support is compiled in.
- inline bool is_known_content_encoding(const std::string &encoding) {
- return is_zlib_encoding(encoding) || is_brotli_encoding(encoding) ||
- is_zstd_encoding(encoding);
- }
- inline std::unique_ptr<decompressor>
- create_decompressor(const std::string &encoding) {
- std::unique_ptr<decompressor> decompressor;
- if (is_zlib_encoding(encoding)) {
- #ifdef CPPHTTPLIB_ZLIB_SUPPORT
- decompressor = detail::make_unique<gzip_decompressor>();
- #endif
- } else if (is_brotli_encoding(encoding)) {
- #ifdef CPPHTTPLIB_BROTLI_SUPPORT
- decompressor = detail::make_unique<brotli_decompressor>();
- #endif
- } else if (is_zstd_encoding(encoding)) {
- #ifdef CPPHTTPLIB_ZSTD_SUPPORT
- decompressor = detail::make_unique<zstd_decompressor>();
- #endif
- }
- return decompressor;
- }
- // Returns the best available compressor and its Content-Encoding name.
- // Priority: Brotli > Gzip > Zstd (matches server-side preference).
- inline std::pair<std::unique_ptr<compressor>, const char *>
- create_compressor() {
- #ifdef CPPHTTPLIB_BROTLI_SUPPORT
- return {detail::make_unique<brotli_compressor>(), "br"};
- #elif defined(CPPHTTPLIB_ZLIB_SUPPORT)
- return {detail::make_unique<gzip_compressor>(), "gzip"};
- #elif defined(CPPHTTPLIB_ZSTD_SUPPORT)
- return {detail::make_unique<zstd_compressor>(), "zstd"};
- #else
- return {nullptr, nullptr};
- #endif
- }
- inline bool is_prohibited_header_name(const std::string &name) {
- using udl::operator""_t;
- switch (str2tag(name)) {
- case "REMOTE_ADDR"_t:
- case "REMOTE_PORT"_t:
- case "LOCAL_ADDR"_t:
- case "LOCAL_PORT"_t: return true;
- default: return false;
- }
- }
- inline bool has_header(const Headers &headers, const std::string &key) {
- if (is_prohibited_header_name(key)) { return false; }
- return headers.find(key) != headers.end();
- }
- inline const char *get_header_value(const Headers &headers,
- const std::string &key, const char *def,
- size_t id) {
- if (is_prohibited_header_name(key)) {
- #ifndef CPPHTTPLIB_NO_EXCEPTIONS
- std::string msg = "Prohibited header name '" + key + "' is specified.";
- throw std::invalid_argument(msg);
- #else
- return "";
- #endif
- }
- auto rng = headers.equal_range(key);
- auto it = rng.first;
- std::advance(it, static_cast<ssize_t>(id));
- if (it != rng.second) { return it->second.c_str(); }
- return def;
- }
- inline size_t get_header_value_count(const Headers &headers,
- const std::string &key) {
- return headers.count(key);
- }
- template <typename Map>
- inline typename Map::mapped_type
- get_multimap_value(const Map &m, const std::string &key, size_t id) {
- auto rng = m.equal_range(key);
- auto it = rng.first;
- std::advance(it, static_cast<ssize_t>(id));
- if (it != rng.second) { return it->second; }
- return typename Map::mapped_type();
- }
- inline void set_header(Headers &headers, const std::string &key,
- const std::string &val) {
- if (fields::is_field_valid(key, val)) { headers.emplace(key, val); }
- }
- inline bool read_headers(Stream &strm, Headers &headers) {
- const auto bufsiz = 2048;
- char buf[bufsiz];
- stream_line_reader line_reader(strm, buf, bufsiz);
- size_t header_count = 0;
- for (;;) {
- if (!line_reader.getline()) { return false; }
- // Check if the line ends with CRLF.
- auto line_terminator_len = 2;
- if (line_reader.end_with_crlf()) {
- // Blank line indicates end of headers.
- if (line_reader.size() == 2) { break; }
- } else {
- #ifdef CPPHTTPLIB_ALLOW_LF_AS_LINE_TERMINATOR
- // Blank line indicates end of headers.
- if (line_reader.size() == 1) { break; }
- line_terminator_len = 1;
- #else
- continue; // Skip invalid line.
- #endif
- }
- if (line_reader.size() > CPPHTTPLIB_HEADER_MAX_LENGTH) { return false; }
- // Check header count limit
- if (header_count >= CPPHTTPLIB_HEADER_MAX_COUNT) { return false; }
- // Exclude line terminator
- auto end = line_reader.ptr() + line_reader.size() - line_terminator_len;
- if (!parse_header(line_reader.ptr(), end,
- [&](const std::string &key, const std::string &val) {
- headers.emplace(key, val);
- })) {
- return false;
- }
- header_count++;
- }
- // RFC 9110 Section 8.6: Reject requests with multiple Content-Length
- // headers that have different values to prevent request smuggling.
- auto cl_range = headers.equal_range("Content-Length");
- if (cl_range.first != cl_range.second) {
- const auto &first_val = cl_range.first->second;
- for (auto it = std::next(cl_range.first); it != cl_range.second; ++it) {
- if (it->second != first_val) { return false; }
- }
- }
- return true;
- }
- inline bool parse_status_line(const char *line, std::string &version,
- int &status, std::string &reason) {
- #ifdef CPPHTTPLIB_ALLOW_LF_AS_LINE_TERMINATOR
- thread_local const std::regex re("(HTTP/1\\.[01]) (\\d{3})(?: (.*?))?\r?\n");
- #else
- thread_local const std::regex re("(HTTP/1\\.[01]) (\\d{3})(?: (.*?))?\r\n");
- #endif
- std::cmatch m;
- if (!std::regex_match(line, m, re)) { return false; }
- version = std::string(m[1]);
- status = std::stoi(std::string(m[2]));
- reason = std::string(m[3]);
- return true;
- }
- // Everything WebSocketClient::connect() reports about the upgrade exchange.
- // status stays -1 until a status line is parsed, mirroring stream::Result.
- struct WebSocketUpgradeResponse {
- Error error = Error::Success;
- int status = -1;
- Headers headers;
- std::string selected_subprotocol;
- };
- inline bool read_websocket_upgrade_response(Stream &strm,
- const std::string &expected_accept,
- WebSocketUpgradeResponse &upgrade) {
- // Read status line
- const auto bufsiz = 2048;
- char buf[bufsiz];
- stream_line_reader line_reader(strm, buf, bufsiz);
- if (!line_reader.getline()) {
- upgrade.error = Error::Read;
- return false;
- }
- std::string version;
- std::string reason;
- if (!parse_status_line(line_reader.ptr(), version, upgrade.status, reason)) {
- upgrade.error = Error::WebSocketHandshake;
- return false;
- }
- // Read the headers even for a rejection so the caller can see why the
- // server refused the upgrade. A non-101 response may carry a body; it is
- // deliberately left unread since the caller closes the socket right away.
- if (!read_headers(strm, upgrade.headers)) {
- upgrade.error = Error::Read;
- return false;
- }
- const auto &headers = upgrade.headers;
- if (upgrade.status != StatusCode::SwitchingProtocol_101) {
- upgrade.error = Error::WebSocketHandshake;
- return false;
- }
- // Verify Upgrade: websocket (case-insensitive)
- auto upgrade_it = headers.find("Upgrade");
- if (upgrade_it == headers.end() ||
- case_ignore::to_lower(upgrade_it->second) != "websocket") {
- upgrade.error = Error::WebSocketHandshake;
- return false;
- }
- // Verify Connection header contains "Upgrade" (case-insensitive)
- auto connection_it = headers.find("Connection");
- if (connection_it == headers.end() ||
- case_ignore::to_lower(connection_it->second).find("upgrade") ==
- std::string::npos) {
- upgrade.error = Error::WebSocketHandshake;
- return false;
- }
- // Verify Sec-WebSocket-Accept header value
- auto it = headers.find("Sec-WebSocket-Accept");
- if (it == headers.end() || it->second != expected_accept) {
- upgrade.error = Error::WebSocketHandshake;
- return false;
- }
- // Extract negotiated subprotocol
- auto proto_it = headers.find("Sec-WebSocket-Protocol");
- if (proto_it != headers.end()) {
- upgrade.selected_subprotocol = proto_it->second;
- }
- return true;
- }
- enum class ReadContentResult {
- Success, // Successfully read the content
- PayloadTooLarge, // The content exceeds the specified payload limit
- Error // An error occurred while reading the content
- };
- inline ReadContentResult read_content_with_length(
- Stream &strm, size_t len, DownloadProgress progress,
- ContentReceiverWithProgress out,
- size_t payload_max_length = (std::numeric_limits<size_t>::max)()) {
- char buf[CPPHTTPLIB_RECV_BUFSIZ];
- detail::BodyReader br;
- br.stream = &strm;
- br.has_content_length = true;
- br.content_length = len;
- br.payload_max_length = payload_max_length;
- br.chunked = false;
- br.bytes_read = 0;
- br.last_error = Error::Success;
- size_t r = 0;
- while (r < len) {
- auto read_len = static_cast<size_t>(len - r);
- auto to_read = (std::min)(read_len, CPPHTTPLIB_RECV_BUFSIZ);
- auto n = detail::read_body_content(&strm, br, buf, to_read);
- if (n <= 0) {
- // Check if it was a payload size error
- if (br.last_error == Error::ExceedMaxPayloadSize) {
- return ReadContentResult::PayloadTooLarge;
- }
- return ReadContentResult::Error;
- }
- if (!out(buf, static_cast<size_t>(n), r, len)) {
- return ReadContentResult::Error;
- }
- r += static_cast<size_t>(n);
- if (progress) {
- if (!progress(r, len)) { return ReadContentResult::Error; }
- }
- }
- return ReadContentResult::Success;
- }
- inline ReadContentResult
- read_content_without_length(Stream &strm, size_t payload_max_length,
- ContentReceiverWithProgress out) {
- char buf[CPPHTTPLIB_RECV_BUFSIZ];
- size_t r = 0;
- for (;;) {
- auto n = strm.read(buf, CPPHTTPLIB_RECV_BUFSIZ);
- if (n == 0) { return ReadContentResult::Success; }
- if (n < 0) { return ReadContentResult::Error; }
- // Check if adding this data would exceed the payload limit
- if (r > payload_max_length ||
- payload_max_length - r < static_cast<size_t>(n)) {
- return ReadContentResult::PayloadTooLarge;
- }
- if (!out(buf, static_cast<size_t>(n), r, 0)) {
- return ReadContentResult::Error;
- }
- r += static_cast<size_t>(n);
- }
- return ReadContentResult::Success;
- }
- template <typename T>
- inline ReadContentResult read_content_chunked(Stream &strm, T &x,
- size_t payload_max_length,
- ContentReceiverWithProgress out) {
- detail::ChunkedDecoder dec(strm);
- char buf[CPPHTTPLIB_RECV_BUFSIZ];
- size_t total_len = 0;
- for (;;) {
- size_t chunk_offset = 0;
- size_t chunk_total = 0;
- auto n = dec.read_payload(buf, sizeof(buf), chunk_offset, chunk_total);
- if (n < 0) { return ReadContentResult::Error; }
- if (n == 0) {
- if (!dec.parse_trailers_into(x.trailers, x.headers)) {
- return ReadContentResult::Error;
- }
- return ReadContentResult::Success;
- }
- if (total_len > payload_max_length ||
- payload_max_length - total_len < static_cast<size_t>(n)) {
- return ReadContentResult::PayloadTooLarge;
- }
- if (!out(buf, static_cast<size_t>(n), chunk_offset, chunk_total)) {
- return ReadContentResult::Error;
- }
- total_len += static_cast<size_t>(n);
- }
- }
- inline bool is_chunked_transfer_encoding(const Headers &headers) {
- // RFC 9112 6.1: a message is framed with the chunked coding when "chunked"
- // is the final transfer coding. A single field value may list several
- // codings ("gzip, chunked"), and RFC 9110 5.3 lets that list be split across
- // several Transfer-Encoding lines, which combine into one comma-separated
- // list in the order the lines were received. Headers preserves that order,
- // so the final coding is the last token of the last line. Match it
- // case-insensitively rather than comparing the whole value against
- // "chunked".
- //
- // Security: reading a chunked message as unframed leaves its body in the
- // socket, where a keep-alive connection parses it as a smuggled request.
- // Server::process_request() answers 400 and closes when the final coding is
- // not chunked, so a request whose framing cannot be determined never
- // reaches the "no body" path.
- auto rng = headers.equal_range("Transfer-Encoding");
- if (rng.first == rng.second) { return false; }
- // Cleared per line, so a trailing line carrying no coding at all leaves the
- // combined list ending in nothing rather than inheriting the line before it.
- std::string last_coding;
- for (auto it = rng.first; it != rng.second; ++it) {
- const auto &value = it->second;
- last_coding.clear();
- split(value.data(), value.data() + value.size(), ',',
- [&](const char *b, const char *e) { last_coding.assign(b, e); });
- }
- return case_ignore::equal(last_coding, "chunked");
- }
- template <typename T, typename U>
- bool prepare_content_receiver(T &x, int &status,
- ContentReceiverWithProgress receiver,
- bool decompress, size_t payload_max_length,
- bool &exceed_payload_max_length, U callback) {
- if (decompress) {
- std::string encoding = x.get_header_value("Content-Encoding");
- std::unique_ptr<decompressor> decompressor;
- if (!encoding.empty()) {
- // A coding we know about but were not built with is an error. An
- // unrecognized coding (including "identity") is left alone and the
- // payload is passed through as-is, since some servers misuse the header,
- // e.g. by sending a character set such as "Content-Encoding: UTF-8".
- decompressor = detail::create_decompressor(encoding);
- if (!decompressor && detail::is_known_content_encoding(encoding)) {
- status = StatusCode::UnsupportedMediaType_415;
- return false;
- }
- }
- if (decompressor) {
- if (decompressor->is_valid()) {
- size_t decompressed_size = 0;
- ContentReceiverWithProgress out = [&](const char *buf, size_t n,
- size_t off, size_t len) {
- return decompressor->decompress(
- buf, n, [&](const char *buf2, size_t n2) {
- // Guard against zip-bomb: check
- // decompressed size against limit.
- if (payload_max_length > 0 &&
- (decompressed_size >= payload_max_length ||
- n2 > payload_max_length - decompressed_size)) {
- exceed_payload_max_length = true;
- return false;
- }
- decompressed_size += n2;
- return receiver(buf2, n2, off, len);
- });
- };
- return callback(std::move(out));
- } else {
- status = StatusCode::InternalServerError_500;
- return false;
- }
- }
- }
- ContentReceiverWithProgress out = [&](const char *buf, size_t n, size_t off,
- size_t len) {
- return receiver(buf, n, off, len);
- };
- return callback(std::move(out));
- }
- template <typename T>
- bool read_content(Stream &strm, T &x, size_t payload_max_length, int &status,
- DownloadProgress progress,
- ContentReceiverWithProgress receiver, bool decompress) {
- bool exceed_payload_max_length = false;
- return prepare_content_receiver(
- x, status, std::move(receiver), decompress, payload_max_length,
- exceed_payload_max_length, [&](const ContentReceiverWithProgress &out) {
- auto ret = true;
- // Note: exceed_payload_max_length may also be set by the decompressor
- // wrapper in prepare_content_receiver when the decompressed payload
- // size exceeds the limit.
- if (is_chunked_transfer_encoding(x.headers)) {
- auto result = read_content_chunked(strm, x, payload_max_length, out);
- if (result == ReadContentResult::Success) {
- ret = true;
- } else if (result == ReadContentResult::PayloadTooLarge) {
- exceed_payload_max_length = true;
- ret = false;
- } else {
- ret = false;
- }
- } else if (!has_header(x.headers, "Content-Length")) {
- auto result =
- read_content_without_length(strm, payload_max_length, out);
- if (result == ReadContentResult::Success) {
- ret = true;
- } else if (result == ReadContentResult::PayloadTooLarge) {
- exceed_payload_max_length = true;
- ret = false;
- } else {
- ret = false;
- }
- } else {
- auto is_invalid_value = false;
- auto len = get_header_value_u64(x.headers, "Content-Length",
- (std::numeric_limits<size_t>::max)(),
- 0, is_invalid_value);
- if (is_invalid_value) {
- ret = false;
- } else if (len > 0) {
- auto result = read_content_with_length(
- strm, len, std::move(progress), out, payload_max_length);
- ret = (result == ReadContentResult::Success);
- if (result == ReadContentResult::PayloadTooLarge) {
- exceed_payload_max_length = true;
- }
- }
- }
- if (!ret) {
- status = exceed_payload_max_length ? StatusCode::PayloadTooLarge_413
- : StatusCode::BadRequest_400;
- }
- return ret;
- });
- }
- inline ssize_t write_request_line(Stream &strm, const std::string &method,
- const std::string &path) {
- // A request target must not carry CR/LF (or other control octets); otherwise
- // a value smuggled into it splits the request line and injects headers or a
- // whole request. The same field-value check already guards header values in
- // check_and_write_headers and the request target in
- // perform_websocket_handshake; apply it here too.
- if (!fields::is_field_value(path)) { return -1; }
- std::string s = method;
- s += ' ';
- s += path;
- s += " HTTP/1.1\r\n";
- return strm.write(s.data(), s.size());
- }
- inline ssize_t write_response_line(Stream &strm, int status) {
- std::string s = "HTTP/1.1 ";
- s += std::to_string(status);
- s += ' ';
- s += httplib::status_message(status);
- s += "\r\n";
- return strm.write(s.data(), s.size());
- }
- inline ssize_t write_headers(Stream &strm, const Headers &headers) {
- ssize_t write_len = 0;
- for (const auto &x : headers) {
- // Skip fields with invalid names or values to prevent response splitting
- // via CR/LF injection, matching set_header(). The client validates request
- // headers up front in check_and_write_headers, but the server passes
- // res.headers straight to this writer, and res.headers is a public field
- // an application can populate directly with request-derived values.
- if (!fields::is_field_valid(x.first, x.second)) { continue; }
- std::string s;
- s = x.first;
- s += ": ";
- s += x.second;
- s += "\r\n";
- auto len = strm.write(s.data(), s.size());
- if (len < 0) { return len; }
- write_len += len;
- }
- auto len = strm.write("\r\n");
- if (len < 0) { return len; }
- write_len += len;
- return write_len;
- }
- inline bool write_data(Stream &strm, const char *d, size_t l) {
- size_t offset = 0;
- while (offset < l) {
- auto length = strm.write(d + offset, l - offset);
- if (length < 0) { return false; }
- offset += static_cast<size_t>(length);
- }
- return true;
- }
- template <typename T>
- inline bool write_content_with_progress(Stream &strm,
- const ContentProvider &content_provider,
- size_t offset, size_t length,
- T is_shutting_down,
- const UploadProgress &upload_progress,
- Error &error) {
- size_t end_offset = offset + length;
- size_t start_offset = offset;
- auto ok = true;
- DataSink data_sink;
- data_sink.write = [&](const char *d, size_t l) -> bool {
- if (ok) {
- if (write_data(strm, d, l)) {
- offset += l;
- if (upload_progress && length > 0) {
- size_t current_written = offset - start_offset;
- if (!upload_progress(current_written, length)) {
- ok = false;
- return false;
- }
- }
- } else {
- ok = false;
- }
- }
- return ok;
- };
- data_sink.is_writable = [&]() -> bool { return strm.is_peer_alive(); };
- while (offset < end_offset && !is_shutting_down()) {
- if (!strm.wait_writable() || !strm.is_peer_alive()) {
- error = Error::Write;
- return false;
- } else if (!content_provider(offset, end_offset - offset, data_sink)) {
- error = Error::Canceled;
- return false;
- } else if (!ok) {
- error = Error::Write;
- return false;
- }
- }
- if (offset < end_offset) { // exited due to is_shutting_down(), not completion
- error = Error::Write;
- return false;
- }
- error = Error::Success;
- return true;
- }
- template <typename T>
- inline bool write_content(Stream &strm, const ContentProvider &content_provider,
- size_t offset, size_t length, T is_shutting_down,
- Error &error) {
- return write_content_with_progress<T>(strm, content_provider, offset, length,
- is_shutting_down, nullptr, error);
- }
- template <typename T>
- inline bool write_content(Stream &strm, const ContentProvider &content_provider,
- size_t offset, size_t length,
- const T &is_shutting_down) {
- auto error = Error::Success;
- return write_content(strm, content_provider, offset, length, is_shutting_down,
- error);
- }
- template <typename T>
- inline bool
- write_content_without_length(Stream &strm,
- const ContentProvider &content_provider,
- const T &is_shutting_down) {
- size_t offset = 0;
- auto data_available = true;
- auto ok = true;
- DataSink data_sink;
- data_sink.write = [&](const char *d, size_t l) -> bool {
- if (ok) {
- offset += l;
- if (!write_data(strm, d, l)) { ok = false; }
- }
- return ok;
- };
- data_sink.is_writable = [&]() -> bool { return strm.is_peer_alive(); };
- data_sink.done = [&](void) { data_available = false; };
- while (data_available && !is_shutting_down()) {
- if (!strm.wait_writable() || !strm.is_peer_alive()) {
- return false;
- } else if (!content_provider(offset, 0, data_sink)) {
- return false;
- } else if (!ok) {
- return false;
- }
- }
- return !data_available; // true only if done() was called, false if shutting
- // down
- }
- template <typename T, typename U>
- inline bool
- write_content_chunked(Stream &strm, const ContentProvider &content_provider,
- const T &is_shutting_down, U &compressor, Error &error) {
- size_t offset = 0;
- auto data_available = true;
- auto ok = true;
- DataSink data_sink;
- data_sink.write = [&](const char *d, size_t l) -> bool {
- if (ok) {
- data_available = l > 0;
- offset += l;
- std::string payload;
- if (compressor.compress(d, l, false,
- [&](const char *data, size_t data_len) {
- payload.append(data, data_len);
- return true;
- })) {
- if (!payload.empty()) {
- // Emit chunked response header and footer for each chunk
- auto chunk =
- from_i_to_hex(payload.size()) + "\r\n" + payload + "\r\n";
- if (!write_data(strm, chunk.data(), chunk.size())) { ok = false; }
- }
- } else {
- ok = false;
- }
- }
- return ok;
- };
- data_sink.is_writable = [&]() -> bool { return strm.is_peer_alive(); };
- auto done_with_trailer = [&](const Headers *trailer) {
- if (!ok) { return; }
- data_available = false;
- std::string payload;
- if (!compressor.compress(nullptr, 0, true,
- [&](const char *data, size_t data_len) {
- payload.append(data, data_len);
- return true;
- })) {
- ok = false;
- return;
- }
- if (!payload.empty()) {
- // Emit chunked response header and footer for each chunk
- auto chunk = from_i_to_hex(payload.size()) + "\r\n" + payload + "\r\n";
- if (!write_data(strm, chunk.data(), chunk.size())) {
- ok = false;
- return;
- }
- }
- constexpr const char done_marker[] = "0\r\n";
- if (!write_data(strm, done_marker, str_len(done_marker))) { ok = false; }
- // Trailer
- if (trailer) {
- for (const auto &kv : *trailer) {
- // Skip fields with invalid names or values to prevent response
- // splitting via CR/LF injection, matching set_header().
- if (!fields::is_field_valid(kv.first, kv.second)) { continue; }
- std::string field_line = kv.first + ": " + kv.second + "\r\n";
- if (!write_data(strm, field_line.data(), field_line.size())) {
- ok = false;
- }
- }
- }
- constexpr const char crlf[] = "\r\n";
- if (!write_data(strm, crlf, str_len(crlf))) { ok = false; }
- };
- data_sink.done = [&](void) { done_with_trailer(nullptr); };
- data_sink.done_with_trailer = [&](const Headers &trailer) {
- done_with_trailer(&trailer);
- };
- while (data_available && !is_shutting_down()) {
- if (!strm.wait_writable() || !strm.is_peer_alive()) {
- error = Error::Write;
- return false;
- } else if (!content_provider(offset, 0, data_sink)) {
- error = Error::Canceled;
- return false;
- } else if (!ok) {
- error = Error::Write;
- return false;
- }
- }
- if (data_available) { // exited due to is_shutting_down(), not done()
- error = Error::Write;
- return false;
- }
- error = Error::Success;
- return true;
- }
- template <typename T, typename U>
- inline bool write_content_chunked(Stream &strm,
- const ContentProvider &content_provider,
- const T &is_shutting_down, U &compressor) {
- auto error = Error::Success;
- return write_content_chunked(strm, content_provider, is_shutting_down,
- compressor, error);
- }
- template <typename T>
- inline bool redirect(T &cli, Request &req, Response &res,
- const std::string &path, const std::string &location,
- Error &error) {
- Request new_req = req;
- new_req.path = path;
- new_req.redirect_count_ -= 1;
- if (res.status == StatusCode::SeeOther_303 &&
- (req.method != "GET" && req.method != "HEAD")) {
- new_req.method = "GET";
- new_req.body.clear();
- new_req.headers.clear();
- }
- Response new_res;
- auto ret = cli.send(new_req, new_res, error);
- if (ret) {
- req = std::move(new_req);
- res = std::move(new_res);
- if (res.location.empty()) { res.location = location; }
- }
- return ret;
- }
- inline std::string params_to_query_str(const Params ¶ms) {
- std::string query;
- for (auto it = params.begin(); it != params.end(); ++it) {
- if (it != params.begin()) { query += '&'; }
- query += encode_query_component(it->first);
- query += '=';
- query += encode_query_component(it->second);
- }
- return query;
- }
- // Splits one "key=value" span of a query string at its first '='. A span with
- // no '=' at all lands entirely in key, leaving val empty, which is how a bare
- // "?flag" keeps its name.
- inline void divide_query_pair(const char *b, const char *e, std::string &key,
- std::string &val) {
- divide(b, static_cast<std::size_t>(e - b), '=',
- [&](const char *lhs_data, std::size_t lhs_size, const char *rhs_data,
- std::size_t rhs_size) {
- key.assign(lhs_data, lhs_size);
- val.assign(rhs_data, rhs_size);
- });
- }
- inline void parse_query_text(const char *data, std::size_t size,
- Params ¶ms) {
- std::set<std::string> cache;
- split(data, data + size, '&', [&](const char *b, const char *e) {
- std::string kv(b, e);
- if (cache.find(kv) != cache.end()) { return; }
- cache.insert(std::move(kv));
- std::string key;
- std::string val;
- divide_query_pair(b, e, key, val);
- if (!key.empty()) {
- params.emplace(decode_query_component(key), decode_query_component(val));
- }
- });
- }
- inline void parse_query_text(const std::string &s, Params ¶ms) {
- parse_query_text(s.data(), s.size(), params);
- }
- // Normalize a query string by decoding and re-encoding each key/value pair
- // while preserving the original parameter order. This avoids double-encoding
- // and ensures consistent encoding. It works on the raw string rather than
- // parsing into Params and re-serializing, because that round trip cannot
- // reproduce the input: params_to_query_str() always emits '=', so a bare
- // "flag" would come back as "flag=", and parse_query_text() drops exactly
- // duplicated pairs.
- inline std::string normalize_query_string(const std::string &query) {
- std::string result;
- split(query.data(), query.data() + query.size(), '&',
- [&](const char *b, const char *e) {
- std::string key;
- std::string val;
- divide_query_pair(b, e, key, val);
- if (!key.empty()) {
- auto dec_key = decode_query_component(key);
- auto dec_val = decode_query_component(val);
- if (!result.empty()) { result += '&'; }
- result += encode_query_component(dec_key);
- if (!val.empty() || std::find(b, e, '=') != e) {
- result += '=';
- result += encode_query_component(dec_val);
- }
- }
- });
- return result;
- }
- // Build the request target that goes on the wire from a caller-supplied path.
- // Shared by the buffered send path and the streaming API so that both put the
- // same bytes in the request line for the same input.
- inline std::string encode_request_target(const std::string &target,
- bool path_encode) {
- // `substr(0, npos)` yields the whole string, which is what the no-query
- // case needs.
- auto query_pos = target.find('?');
- auto path_part = target.substr(0, query_pos);
- std::string query_part;
- if (query_pos != std::string::npos) {
- query_part = target.substr(query_pos + 1);
- }
- auto result = path_encode ? encode_path(path_part) : std::move(path_part);
- if (!query_part.empty()) {
- // When path encoding is disabled the caller has supplied an already-encoded
- // target and expects the exact bytes to be sent on the wire, so skip
- // normalization for the query too. Normalizing would decode-then-re-encode
- // it and corrupt pre-encoded binary payloads (e.g. turning `%20` into `+`,
- // which a strict RFC 3986 server decodes back as `+`, not a space).
- if (path_encode) {
- auto normalized = normalize_query_string(query_part);
- if (!normalized.empty()) {
- result += '?';
- result += normalized;
- }
- } else {
- result += '?';
- result += query_part;
- }
- }
- return result;
- }
- inline bool parse_multipart_boundary(const std::string &content_type,
- std::string &boundary) {
- std::map<std::string, std::string> params;
- extract_media_type(content_type, ¶ms);
- auto it = params.find("boundary");
- if (it == params.end()) { return false; }
- boundary = it->second;
- return !boundary.empty();
- }
- inline void parse_disposition_params(const std::string &s, Params ¶ms) {
- std::set<std::string> cache;
- split(s.data(), s.data() + s.size(), ';', [&](const char *b, const char *e) {
- std::string kv(b, e);
- if (cache.find(kv) != cache.end()) { return; }
- cache.insert(kv);
- std::string key;
- std::string val;
- split(b, e, '=', [&](const char *b2, const char *e2) {
- if (key.empty()) {
- key.assign(b2, e2);
- } else {
- val.assign(b2, e2);
- }
- });
- if (!key.empty()) {
- params.emplace(trim_double_quotes_copy((key)),
- trim_double_quotes_copy((val)));
- }
- });
- }
- #ifdef CPPHTTPLIB_NO_EXCEPTIONS
- inline bool parse_range_header(const std::string &s, Ranges &ranges) {
- #else
- inline bool parse_range_header(const std::string &s, Ranges &ranges) try {
- #endif
- auto is_valid = [](const std::string &str) {
- return std::all_of(str.cbegin(), str.cend(), is_ascii_digit);
- };
- if (s.size() > 7 && s.compare(0, 6, "bytes=") == 0) {
- const auto pos = static_cast<size_t>(6);
- const auto len = static_cast<size_t>(s.size() - 6);
- auto all_valid_ranges = true;
- split(&s[pos], &s[pos + len], ',', [&](const char *b, const char *e) {
- if (!all_valid_ranges) { return; }
- const auto it = std::find(b, e, '-');
- if (it == e) {
- all_valid_ranges = false;
- return;
- }
- const auto lhs = std::string(b, it);
- const auto rhs = std::string(it + 1, e);
- if (!is_valid(lhs) || !is_valid(rhs)) {
- all_valid_ranges = false;
- return;
- }
- ssize_t first = -1;
- if (!lhs.empty()) {
- ssize_t v;
- auto res = detail::from_chars(lhs.data(), lhs.data() + lhs.size(), v);
- if (res.ec == std::errc{}) { first = v; }
- }
- ssize_t last = -1;
- if (!rhs.empty()) {
- ssize_t v;
- auto res = detail::from_chars(rhs.data(), rhs.data() + rhs.size(), v);
- if (res.ec == std::errc{}) { last = v; }
- }
- if ((first == -1 && last == -1) ||
- (first != -1 && last != -1 && first > last)) {
- all_valid_ranges = false;
- return;
- }
- ranges.emplace_back(first, last);
- });
- return all_valid_ranges && !ranges.empty();
- }
- return false;
- #ifdef CPPHTTPLIB_NO_EXCEPTIONS
- }
- #else
- } catch (...) { return false; }
- #endif
- inline bool parse_accept_header(const std::string &s,
- std::vector<std::string> &content_types) {
- content_types.clear();
- // Empty string is considered valid (no preference)
- if (s.empty()) { return true; }
- // Check for invalid patterns: leading/trailing commas or consecutive commas
- if (s.front() == ',' || s.back() == ',' ||
- s.find(",,") != std::string::npos) {
- return false;
- }
- struct AcceptEntry {
- std::string media_type;
- double quality;
- int order;
- };
- std::vector<AcceptEntry> entries;
- int order = 0;
- bool has_invalid_entry = false;
- // Split by comma and parse each entry
- split(s.data(), s.data() + s.size(), ',', [&](const char *b, const char *e) {
- std::string entry(b, e);
- entry = trim_copy(entry);
- if (entry.empty()) {
- has_invalid_entry = true;
- return;
- }
- AcceptEntry accept_entry;
- accept_entry.order = order++;
- if (!parse_quality(entry.data(), entry.data() + entry.size(),
- accept_entry.media_type, accept_entry.quality)) {
- has_invalid_entry = true;
- return;
- }
- // Remove additional parameters from media type
- accept_entry.media_type = extract_media_type(accept_entry.media_type);
- // Basic validation of media type format
- if (accept_entry.media_type.empty()) {
- has_invalid_entry = true;
- return;
- }
- // Check for basic media type format (should contain '/' or be '*')
- if (accept_entry.media_type != "*" &&
- accept_entry.media_type.find('/') == std::string::npos) {
- has_invalid_entry = true;
- return;
- }
- entries.push_back(std::move(accept_entry));
- });
- // Return false if any invalid entry was found
- if (has_invalid_entry) { return false; }
- // Sort by quality (descending), then by original order (ascending)
- std::sort(entries.begin(), entries.end(),
- [](const AcceptEntry &a, const AcceptEntry &b) {
- if (a.quality != b.quality) {
- return a.quality > b.quality; // Higher quality first
- }
- return a.order < b.order; // Earlier order first for same quality
- });
- // Extract sorted media types
- content_types.reserve(entries.size());
- for (auto &entry : entries) {
- content_types.push_back(std::move(entry.media_type));
- }
- return true;
- }
- class FormDataParser {
- public:
- FormDataParser() = default;
- void set_boundary(std::string &&boundary) {
- boundary_ = std::move(boundary);
- dash_boundary_crlf_ = dash_ + boundary_ + crlf_;
- crlf_dash_boundary_ = crlf_ + dash_ + boundary_;
- }
- bool is_valid() const { return is_valid_; }
- bool parse(const char *buf, size_t n, const FormDataHeader &header_callback,
- const ContentReceiver &content_callback) {
- buf_append(buf, n);
- while (buf_size() > 0) {
- switch (state_) {
- case 0: { // Initial boundary
- auto pos = buf_find(dash_boundary_crlf_);
- if (pos == buf_size()) { return true; }
- buf_erase(pos + dash_boundary_crlf_.size());
- state_ = 1;
- break;
- }
- case 1: { // New entry
- clear_file_info();
- state_ = 2;
- break;
- }
- case 2: { // Headers
- auto pos = buf_find(crlf_);
- if (pos > CPPHTTPLIB_HEADER_MAX_LENGTH) { return false; }
- while (pos < buf_size()) {
- // Empty line
- if (pos == 0) {
- if (!header_callback(file_)) {
- is_valid_ = false;
- return false;
- }
- buf_erase(crlf_.size());
- state_ = 3;
- break;
- }
- // Check header count limit
- if (header_count_ >= CPPHTTPLIB_HEADER_MAX_COUNT) {
- is_valid_ = false;
- return false;
- }
- header_count_++;
- const auto header = buf_head(pos);
- if (!parse_header(header.data(), header.data() + header.size(),
- [&](const std::string &, const std::string &) {})) {
- is_valid_ = false;
- return false;
- }
- // Parse and emplace space trimmed headers into a map
- if (!parse_header(
- header.data(), header.data() + header.size(),
- [&](const std::string &key, const std::string &val) {
- file_.headers.emplace(key, val);
- })) {
- is_valid_ = false;
- return false;
- }
- constexpr const char header_content_type[] = "Content-Type:";
- if (start_with_case_ignore(header, header_content_type)) {
- file_.content_type =
- trim_copy(header.substr(str_len(header_content_type)));
- } else {
- std::string disposition_params;
- if (parse_content_disposition(header, disposition_params)) {
- Params params;
- parse_disposition_params(disposition_params, params);
- auto it = params.find("name");
- if (it != params.end()) {
- file_.name = it->second;
- } else {
- is_valid_ = false;
- return false;
- }
- it = params.find("filename");
- if (it != params.end()) { file_.filename = it->second; }
- it = params.find("filename*");
- if (it != params.end()) {
- // RFC 5987: only UTF-8 encoding is allowed
- const auto &val = it->second;
- constexpr const char utf8_prefix[] = "UTF-8''";
- constexpr size_t prefix_len = str_len(utf8_prefix);
- if (val.size() > prefix_len &&
- start_with_case_ignore(val, utf8_prefix)) {
- file_.filename = decode_path_component(
- val.substr(prefix_len)); // override...
- } else {
- is_valid_ = false;
- return false;
- }
- }
- }
- }
- buf_erase(pos + crlf_.size());
- pos = buf_find(crlf_);
- }
- if (state_ != 3) { return true; }
- break;
- }
- case 3: { // Body
- if (crlf_dash_boundary_.size() > buf_size()) { return true; }
- auto pos = buf_find(crlf_dash_boundary_);
- if (pos < buf_size()) {
- if (!content_callback(buf_data(), pos)) {
- is_valid_ = false;
- return false;
- }
- buf_erase(pos + crlf_dash_boundary_.size());
- state_ = 4;
- } else {
- auto len = buf_size() - crlf_dash_boundary_.size();
- if (len > 0) {
- if (!content_callback(buf_data(), len)) {
- is_valid_ = false;
- return false;
- }
- buf_erase(len);
- }
- return true;
- }
- break;
- }
- case 4: { // Boundary
- if (crlf_.size() > buf_size()) { return true; }
- if (buf_start_with(crlf_)) {
- buf_erase(crlf_.size());
- state_ = 1;
- } else {
- if (dash_.size() > buf_size()) { return true; }
- if (buf_start_with(dash_)) {
- buf_erase(dash_.size());
- is_valid_ = true;
- buf_erase(buf_size()); // Remove epilogue
- } else {
- return true;
- }
- }
- break;
- }
- }
- }
- return true;
- }
- private:
- void clear_file_info() {
- file_.name.clear();
- file_.filename.clear();
- file_.content_type.clear();
- file_.headers.clear();
- header_count_ = 0;
- }
- bool start_with_case_ignore(const std::string &a, const char *b,
- size_t offset = 0) const {
- const auto b_len = strlen(b);
- if (a.size() < offset + b_len) { return false; }
- for (size_t i = 0; i < b_len; i++) {
- if (case_ignore::to_lower(a[offset + i]) != case_ignore::to_lower(b[i])) {
- return false;
- }
- }
- return true;
- }
- // Parses "Content-Disposition: form-data; <params>" without std::regex.
- // Returns true if header matches, with the params portion in `params_out`.
- bool parse_content_disposition(const std::string &header,
- std::string ¶ms_out) const {
- constexpr const char prefix[] = "Content-Disposition:";
- constexpr size_t prefix_len = str_len(prefix);
- if (!start_with_case_ignore(header, prefix)) { return false; }
- // Skip whitespace after "Content-Disposition:"
- auto pos = prefix_len;
- while (pos < header.size() && (header[pos] == ' ' || header[pos] == '\t')) {
- pos++;
- }
- // Match "form-data;" (case-insensitive)
- constexpr const char form_data[] = "form-data;";
- constexpr size_t form_data_len = str_len(form_data);
- if (!start_with_case_ignore(header, form_data, pos)) { return false; }
- pos += form_data_len;
- // Skip whitespace after "form-data;"
- while (pos < header.size() && (header[pos] == ' ' || header[pos] == '\t')) {
- pos++;
- }
- params_out = header.substr(pos);
- return true;
- }
- const std::string dash_ = "--";
- const std::string crlf_ = "\r\n";
- std::string boundary_;
- std::string dash_boundary_crlf_;
- std::string crlf_dash_boundary_;
- size_t state_ = 0;
- bool is_valid_ = false;
- FormData file_;
- size_t header_count_ = 0;
- // Buffer
- bool start_with(const std::string &a, size_t spos, size_t epos,
- const std::string &b) const {
- if (epos - spos < b.size()) { return false; }
- for (size_t i = 0; i < b.size(); i++) {
- if (a[i + spos] != b[i]) { return false; }
- }
- return true;
- }
- size_t buf_size() const { return buf_epos_ - buf_spos_; }
- const char *buf_data() const { return &buf_[buf_spos_]; }
- std::string buf_head(size_t l) const { return buf_.substr(buf_spos_, l); }
- bool buf_start_with(const std::string &s) const {
- return start_with(buf_, buf_spos_, buf_epos_, s);
- }
- size_t buf_find(const std::string &s) const {
- auto c = s.front();
- size_t off = buf_spos_;
- while (off < buf_epos_) {
- auto pos = off;
- while (true) {
- if (pos == buf_epos_) { return buf_size(); }
- if (buf_[pos] == c) { break; }
- pos++;
- }
- auto remaining_size = buf_epos_ - pos;
- if (s.size() > remaining_size) { return buf_size(); }
- if (start_with(buf_, pos, buf_epos_, s)) { return pos - buf_spos_; }
- off = pos + 1;
- }
- return buf_size();
- }
- void buf_append(const char *data, size_t n) {
- auto remaining_size = buf_size();
- if (remaining_size > 0 && buf_spos_ > 0) {
- for (size_t i = 0; i < remaining_size; i++) {
- buf_[i] = buf_[buf_spos_ + i];
- }
- }
- buf_spos_ = 0;
- buf_epos_ = remaining_size;
- if (remaining_size + n > buf_.size()) { buf_.resize(remaining_size + n); }
- for (size_t i = 0; i < n; i++) {
- buf_[buf_epos_ + i] = data[i];
- }
- buf_epos_ += n;
- }
- void buf_erase(size_t size) { buf_spos_ += size; }
- std::string buf_;
- size_t buf_spos_ = 0;
- size_t buf_epos_ = 0;
- };
- inline std::string random_string(size_t length) {
- constexpr const char data[] =
- "0123456789ABCDEFGHIJKLMNOPQRSTUVWXYZabcdefghijklmnopqrstuvwxyz";
- thread_local auto engine([]() {
- // std::random_device might actually be deterministic on some
- // platforms, but due to lack of support in the c++ standard library,
- // doing better requires either some ugly hacks or breaking portability.
- std::random_device seed_gen;
- // Request 128 bits of entropy for initialization
- std::seed_seq seed_sequence{seed_gen(), seed_gen(), seed_gen(), seed_gen()};
- return std::mt19937(seed_sequence);
- }());
- std::string result;
- for (size_t i = 0; i < length; i++) {
- result += data[engine() % (sizeof(data) - 1)];
- }
- return result;
- }
- inline std::string make_multipart_data_boundary() {
- return "--cpp-httplib-multipart-data-" + detail::random_string(16);
- }
- inline bool is_multipart_boundary_chars_valid(const std::string &boundary) {
- auto valid = true;
- for (size_t i = 0; i < boundary.size(); i++) {
- auto c = boundary[i];
- if (!is_ascii_alnum(c) && c != '-' && c != '_') {
- valid = false;
- break;
- }
- }
- return valid;
- }
- // Escape a multipart field name/filename following the WHATWG HTML standard
- // ("escape a multipart form-data name"), which is what browsers send:
- // '"' -> %22, CR -> %0D, LF -> %0A
- // With escape_quote = false, only CR and LF are escaped; this is for header
- // values outside a quoted-string (e.g. Content-Type), where '"' is legal.
- inline std::string escape_multipart_field(const std::string &s,
- bool escape_quote = true) {
- std::string result;
- result.reserve(s.size());
- for (auto c : s) {
- switch (c) {
- case '"':
- if (escape_quote) {
- result += "%22";
- } else {
- result += c;
- }
- break;
- case '\r': result += "%0D"; break;
- case '\n': result += "%0A"; break;
- default: result += c; break;
- }
- }
- return result;
- }
- template <typename T>
- inline std::string
- serialize_multipart_formdata_item_begin(const T &item,
- const std::string &boundary) {
- std::string body = "--" + boundary + "\r\n";
- body += "Content-Disposition: form-data; name=\"" +
- escape_multipart_field(item.name) + "\"";
- if (!item.filename.empty()) {
- body += "; filename=\"" + escape_multipart_field(item.filename) + "\"";
- }
- body += "\r\n";
- if (!item.content_type.empty()) {
- body +=
- "Content-Type: " + escape_multipart_field(item.content_type, false) +
- "\r\n";
- }
- body += "\r\n";
- return body;
- }
- inline std::string serialize_multipart_formdata_item_end() { return "\r\n"; }
- inline std::string
- serialize_multipart_formdata_finish(const std::string &boundary) {
- return "--" + boundary + "--\r\n";
- }
- inline std::string
- serialize_multipart_formdata_get_content_type(const std::string &boundary) {
- return "multipart/form-data; boundary=" + boundary;
- }
- inline std::string
- serialize_multipart_formdata(const UploadFormDataItems &items,
- const std::string &boundary, bool finish = true) {
- std::string body;
- for (const auto &item : items) {
- body += serialize_multipart_formdata_item_begin(item, boundary);
- body += item.content + serialize_multipart_formdata_item_end();
- }
- if (finish) { body += serialize_multipart_formdata_finish(boundary); }
- return body;
- }
- inline size_t get_multipart_content_length(const UploadFormDataItems &items,
- const std::string &boundary) {
- size_t total = 0;
- for (const auto &item : items) {
- total += serialize_multipart_formdata_item_begin(item, boundary).size();
- total += item.content.size();
- total += serialize_multipart_formdata_item_end().size();
- }
- total += serialize_multipart_formdata_finish(boundary).size();
- return total;
- }
- struct MultipartSegment {
- const char *data;
- size_t size;
- };
- // NOTE: items must outlive the returned ContentProvider
- // (safe for synchronous use inside Post/Put/Patch)
- inline ContentProvider
- make_multipart_content_provider(const UploadFormDataItems &items,
- const std::string &boundary) {
- // Own the per-item header strings and the finish string
- std::vector<std::string> owned;
- owned.reserve(items.size() + 1);
- for (const auto &item : items)
- owned.push_back(serialize_multipart_formdata_item_begin(item, boundary));
- owned.push_back(serialize_multipart_formdata_finish(boundary));
- // Flat segment list: [header, content, "\r\n"] * N + [finish]
- std::vector<MultipartSegment> segs;
- segs.reserve(items.size() * 3 + 1);
- static const char crlf[] = "\r\n";
- for (size_t i = 0; i < items.size(); i++) {
- segs.push_back({owned[i].data(), owned[i].size()});
- segs.push_back({items[i].content.data(), items[i].content.size()});
- segs.push_back({crlf, 2});
- }
- segs.push_back({owned.back().data(), owned.back().size()});
- struct MultipartState {
- std::vector<std::string> owned;
- std::vector<MultipartSegment> segs;
- std::vector<char> buf = std::vector<char>(CPPHTTPLIB_SEND_BUFSIZ);
- };
- auto state = std::make_shared<MultipartState>();
- state->owned = std::move(owned);
- // `segs` holds raw pointers into owned strings; std::string move preserves
- // the data pointer, so these pointers remain valid after the move above.
- state->segs = std::move(segs);
- return [state](size_t offset, size_t length, DataSink &sink) -> bool {
- // Buffer multiple small segments into fewer, larger writes to avoid
- // excessive TCP packets when there are many form data items (#2410)
- auto &buf = state->buf;
- auto buf_size = buf.size();
- size_t buf_len = 0;
- size_t remaining = length;
- // Find the first segment containing 'offset'
- size_t pos = 0;
- size_t seg_idx = 0;
- for (; seg_idx < state->segs.size(); seg_idx++) {
- const auto &seg = state->segs[seg_idx];
- if (seg.size > 0 && offset - pos < seg.size) { break; }
- pos += seg.size;
- }
- size_t seg_offset = (seg_idx < state->segs.size()) ? offset - pos : 0;
- for (; seg_idx < state->segs.size() && remaining > 0; seg_idx++) {
- const auto &seg = state->segs[seg_idx];
- size_t available = seg.size - seg_offset;
- size_t to_copy = (std::min)(available, remaining);
- const char *src = seg.data + seg_offset;
- seg_offset = 0; // only the first segment has a non-zero offset
- while (to_copy > 0) {
- size_t space = buf_size - buf_len;
- size_t chunk = (std::min)(to_copy, space);
- std::memcpy(buf.data() + buf_len, src, chunk);
- buf_len += chunk;
- src += chunk;
- to_copy -= chunk;
- remaining -= chunk;
- if (buf_len == buf_size) {
- if (!sink.write(buf.data(), buf_len)) { return false; }
- buf_len = 0;
- }
- }
- }
- if (buf_len > 0) { return sink.write(buf.data(), buf_len); }
- return true;
- };
- }
- inline void coalesce_ranges(Ranges &ranges, size_t content_length) {
- if (ranges.size() <= 1) return;
- // Sort ranges by start position
- std::sort(ranges.begin(), ranges.end(),
- [](const Range &a, const Range &b) { return a.first < b.first; });
- Ranges coalesced;
- coalesced.reserve(ranges.size());
- for (auto &r : ranges) {
- auto first_pos = r.first;
- auto last_pos = r.second;
- // Handle special cases like in range_error
- if (first_pos == -1 && last_pos == -1) {
- first_pos = 0;
- last_pos = static_cast<ssize_t>(content_length);
- }
- if (first_pos == -1) {
- first_pos = static_cast<ssize_t>(content_length) - last_pos;
- last_pos = static_cast<ssize_t>(content_length) - 1;
- }
- if (last_pos == -1 || last_pos >= static_cast<ssize_t>(content_length)) {
- last_pos = static_cast<ssize_t>(content_length) - 1;
- }
- // Skip invalid ranges
- if (!(0 <= first_pos && first_pos <= last_pos &&
- last_pos < static_cast<ssize_t>(content_length))) {
- continue;
- }
- // Coalesce with previous range if overlapping or adjacent (but not
- // identical)
- if (!coalesced.empty()) {
- auto &prev = coalesced.back();
- // Check if current range overlaps or is adjacent to previous range
- // but don't coalesce identical ranges (allow duplicates)
- if (first_pos <= prev.second + 1 &&
- !(first_pos == prev.first && last_pos == prev.second)) {
- // Extend the previous range
- prev.second = (std::max)(prev.second, last_pos);
- continue;
- }
- }
- // Add new range
- coalesced.emplace_back(first_pos, last_pos);
- }
- ranges = std::move(coalesced);
- }
- inline bool range_error(Request &req, Response &res) {
- if (!req.ranges.empty() && 200 <= res.status && res.status < 300) {
- if (res.body.empty() && res.content_provider_ && res.content_length_ == 0) {
- req.ranges.clear();
- if (res.status == StatusCode::PartialContent_206) {
- res.status = StatusCode::OK_200;
- }
- return false;
- }
- ssize_t content_len = static_cast<ssize_t>(
- res.content_length_ ? res.content_length_ : res.body.size());
- std::vector<std::pair<ssize_t, ssize_t>> processed_ranges;
- size_t overwrapping_count = 0;
- // NOTE: The following Range check is based on '14.2. Range' in RFC 9110
- // 'HTTP Semantics' to avoid potential denial-of-service attacks.
- // https://www.rfc-editor.org/rfc/rfc9110#section-14.2
- // Too many ranges
- if (req.ranges.size() > CPPHTTPLIB_RANGE_MAX_COUNT) { return true; }
- for (auto &r : req.ranges) {
- auto &first_pos = r.first;
- auto &last_pos = r.second;
- if (first_pos == -1 && last_pos == -1) {
- first_pos = 0;
- last_pos = content_len;
- }
- if (first_pos == -1) {
- first_pos = content_len - last_pos;
- last_pos = content_len - 1;
- }
- // NOTE: RFC-9110 '14.1.2. Byte Ranges':
- // A client can limit the number of bytes requested without knowing the
- // size of the selected representation. If the last-pos value is absent,
- // or if the value is greater than or equal to the current length of the
- // representation data, the byte range is interpreted as the remainder of
- // the representation (i.e., the server replaces the value of last-pos
- // with a value that is one less than the current length of the selected
- // representation).
- // https://www.rfc-editor.org/rfc/rfc9110.html#section-14.1.2-6
- if (last_pos == -1 || last_pos >= content_len) {
- last_pos = content_len - 1;
- }
- // Range must be within content length
- if (!(0 <= first_pos && first_pos <= last_pos &&
- last_pos <= content_len - 1)) {
- return true;
- }
- // Request must not have more than two overlapping ranges
- for (const auto &processed_range : processed_ranges) {
- if (!(last_pos < processed_range.first ||
- first_pos > processed_range.second)) {
- overwrapping_count++;
- if (overwrapping_count > 2) { return true; }
- break; // Only count once per range
- }
- }
- processed_ranges.emplace_back(first_pos, last_pos);
- }
- // After validation, coalesce overlapping ranges as per RFC 9110
- coalesce_ranges(req.ranges, static_cast<size_t>(content_len));
- }
- return false;
- }
- inline std::pair<size_t, size_t>
- get_range_offset_and_length(Range r, size_t content_length) {
- assert(r.first != -1 && r.second != -1);
- assert(0 <= r.first && r.first < static_cast<ssize_t>(content_length));
- assert(r.first <= r.second &&
- r.second < static_cast<ssize_t>(content_length));
- (void)(content_length);
- return std::make_pair(static_cast<size_t>(r.first),
- static_cast<size_t>(r.second - r.first) + 1);
- }
- inline std::string make_content_range_header_field(
- const std::pair<size_t, size_t> &offset_and_length, size_t content_length) {
- auto st = offset_and_length.first;
- auto ed = st + offset_and_length.second - 1;
- std::string field = "bytes ";
- field += std::to_string(st);
- field += '-';
- field += std::to_string(ed);
- field += '/';
- field += std::to_string(content_length);
- return field;
- }
- template <typename SToken, typename CToken, typename Content>
- bool process_multipart_ranges_data(const Request &req,
- const std::string &boundary,
- const std::string &content_type,
- size_t content_length, SToken stoken,
- CToken ctoken, Content content) {
- for (size_t i = 0; i < req.ranges.size(); i++) {
- ctoken("--");
- stoken(boundary);
- ctoken("\r\n");
- if (!content_type.empty()) {
- ctoken("Content-Type: ");
- stoken(content_type);
- ctoken("\r\n");
- }
- auto offset_and_length =
- get_range_offset_and_length(req.ranges[i], content_length);
- ctoken("Content-Range: ");
- stoken(make_content_range_header_field(offset_and_length, content_length));
- ctoken("\r\n");
- ctoken("\r\n");
- if (!content(offset_and_length.first, offset_and_length.second)) {
- return false;
- }
- ctoken("\r\n");
- }
- ctoken("--");
- stoken(boundary);
- ctoken("--");
- return true;
- }
- inline void make_multipart_ranges_data(const Request &req, Response &res,
- const std::string &boundary,
- const std::string &content_type,
- size_t content_length,
- std::string &data) {
- process_multipart_ranges_data(
- req, boundary, content_type, content_length,
- [&](const std::string &token) { data += token; },
- [&](const std::string &token) { data += token; },
- [&](size_t offset, size_t length) {
- assert(offset + length <= content_length);
- data += res.body.substr(offset, length);
- return true;
- });
- }
- inline size_t get_multipart_ranges_data_length(const Request &req,
- const std::string &boundary,
- const std::string &content_type,
- size_t content_length) {
- size_t data_length = 0;
- process_multipart_ranges_data(
- req, boundary, content_type, content_length,
- [&](const std::string &token) { data_length += token.size(); },
- [&](const std::string &token) { data_length += token.size(); },
- [&](size_t /*offset*/, size_t length) {
- data_length += length;
- return true;
- });
- return data_length;
- }
- template <typename T>
- inline bool
- write_multipart_ranges_data(Stream &strm, const Request &req, Response &res,
- const std::string &boundary,
- const std::string &content_type,
- size_t content_length, const T &is_shutting_down) {
- return process_multipart_ranges_data(
- req, boundary, content_type, content_length,
- [&](const std::string &token) { strm.write(token); },
- [&](const std::string &token) { strm.write(token); },
- [&](size_t offset, size_t length) {
- return write_content(strm, res.content_provider_, offset, length,
- is_shutting_down);
- });
- }
- inline bool has_framed_body(const Request &req) {
- return is_chunked_transfer_encoding(req.headers) ||
- req.get_header_value_u64("Content-Length") > 0;
- }
- inline bool is_connection_persistent(const Request &req) {
- auto conn = req.get_header_value("Connection");
- if (conn == "close") { return false; }
- if (req.version == "HTTP/1.0" && conn != "Keep-Alive") { return false; }
- return true;
- }
- inline bool expect_content(const Request &req) {
- if (req.method == "POST" || req.method == "PUT" || req.method == "PATCH" ||
- req.method == "DELETE") {
- return true;
- }
- return has_framed_body(req);
- }
- #ifdef _WIN32
- class WSInit {
- public:
- WSInit() {
- WSADATA wsaData;
- if (WSAStartup(0x0002, &wsaData) == 0) is_valid_ = true;
- }
- ~WSInit() {
- if (is_valid_) WSACleanup();
- }
- bool is_valid_ = false;
- };
- static WSInit wsinit_;
- #endif
- inline bool parse_www_authenticate(const Response &res,
- std::map<std::string, std::string> &auth,
- bool is_proxy) {
- auto auth_key = is_proxy ? "Proxy-Authenticate" : "WWW-Authenticate";
- if (res.has_header(auth_key)) {
- thread_local auto re =
- std::regex(R"~((?:(?:,\s*)?(.+?)=(?:"(.*?)"|([^,]*))))~");
- auto s = res.get_header_value(auth_key);
- auto pos = s.find(' ');
- if (pos != std::string::npos) {
- auto type = s.substr(0, pos);
- if (type == "Basic") {
- return false;
- } else if (type == "Digest") {
- s = s.substr(pos + 1);
- auto beg = std::sregex_iterator(s.begin(), s.end(), re);
- for (auto i = beg; i != std::sregex_iterator(); ++i) {
- const auto &m = *i;
- auto key = s.substr(static_cast<size_t>(m.position(1)),
- static_cast<size_t>(m.length(1)));
- auto val = m.length(2) > 0
- ? s.substr(static_cast<size_t>(m.position(2)),
- static_cast<size_t>(m.length(2)))
- : s.substr(static_cast<size_t>(m.position(3)),
- static_cast<size_t>(m.length(3)));
- auth[std::move(key)] = std::move(val);
- }
- return true;
- }
- }
- }
- return false;
- }
- class ContentProviderAdapter {
- public:
- explicit ContentProviderAdapter(
- ContentProviderWithoutLength &&content_provider)
- : content_provider_(std::move(content_provider)) {}
- bool operator()(size_t offset, size_t, DataSink &sink) {
- return content_provider_(offset, sink);
- }
- private:
- ContentProviderWithoutLength content_provider_;
- };
- // NOTE: https://www.rfc-editor.org/rfc/rfc9110#section-5
- namespace fields {
- inline bool is_token_char(char c) {
- return is_ascii_alnum(c) || c == '!' || c == '#' || c == '$' || c == '%' ||
- c == '&' || c == '\'' || c == '*' || c == '+' || c == '-' ||
- c == '.' || c == '^' || c == '_' || c == '`' || c == '|' || c == '~';
- }
- inline bool is_token(const std::string &s) {
- if (s.empty()) { return false; }
- for (auto c : s) {
- if (!is_token_char(c)) { return false; }
- }
- return true;
- }
- inline bool is_field_name(const std::string &s) { return is_token(s); }
- inline bool is_vchar(char c) { return c >= 33 && c <= 126; }
- inline bool is_obs_text(char c) { return 128 <= static_cast<unsigned char>(c); }
- inline bool is_field_vchar(char c) { return is_vchar(c) || is_obs_text(c); }
- inline bool is_field_content(const std::string &s) {
- if (s.empty()) { return true; }
- if (s.size() == 1) {
- return is_field_vchar(s[0]);
- } else if (s.size() == 2) {
- return is_field_vchar(s[0]) && is_field_vchar(s[1]);
- } else {
- size_t i = 0;
- if (!is_field_vchar(s[i])) { return false; }
- i++;
- while (i < s.size() - 1) {
- auto c = s[i++];
- if (c == ' ' || c == '\t' || is_field_vchar(c)) {
- } else {
- return false;
- }
- }
- return is_field_vchar(s[i]);
- }
- }
- inline bool is_field_value(const std::string &s) { return is_field_content(s); }
- inline bool is_field_valid(const std::string &name, const std::string &value) {
- return is_field_name(name) && is_field_value(value);
- }
- } // namespace fields
- inline bool perform_websocket_handshake(Stream &strm, Request &req,
- WebSocketUpgradeResponse &upgrade) {
- // Generate random Sec-WebSocket-Key
- thread_local std::mt19937 rng(std::random_device{}());
- std::string key_bytes(16, '\0');
- for (size_t i = 0; i < 16; i += 4) {
- auto r = rng();
- std::memcpy(&key_bytes[i], &r, (std::min)(size_t(4), size_t(16 - i)));
- }
- auto client_key = base64_encode(key_bytes);
- req.headers.erase("Upgrade");
- req.headers.erase("Connection");
- req.headers.erase("Sec-WebSocket-Key");
- req.headers.erase("Sec-WebSocket-Version");
- req.headers.emplace("Upgrade", "websocket");
- req.headers.emplace("Connection", "Upgrade");
- req.headers.emplace("Sec-WebSocket-Key", client_key);
- req.headers.emplace("Sec-WebSocket-Version", "13");
- // Build the request in memory first, like ClientImpl::write_request does.
- // Writing straight to the socket would leak a request line onto the wire
- // before check_and_write_headers gets a chance to reject an invalid header,
- // and would emit one small write per header.
- BufferStream bstrm;
- if (write_request_line(bstrm, req.method, req.path) < 0) {
- upgrade.error = Error::Write;
- return false;
- }
- auto error = Error::Success;
- if (!check_and_write_headers(bstrm, req.headers, write_headers, error)) {
- upgrade.error = error;
- return false;
- }
- const auto &data = bstrm.get_buffer();
- if (!write_data(strm, data.data(), data.size())) {
- upgrade.error = Error::Write;
- return false;
- }
- // Verify 101 response and Sec-WebSocket-Accept header
- auto expected_accept = websocket_accept_key(client_key);
- return read_websocket_upgrade_response(strm, expected_accept, upgrade);
- }
- inline bool is_ip_address(const std::string &host) {
- struct in_addr addr4;
- struct in6_addr addr6;
- return inet_pton(AF_INET, host.c_str(), &addr4) == 1 ||
- inet_pton(AF_INET6, host.c_str(), &addr6) == 1;
- }
- // Resolve where a client should connect for `host`, honoring a user-supplied
- // hostname-to-address map. `host` itself is never rewritten, so it keeps
- // supplying the Host header and SNI; only the connection target changes.
- //
- // A mapped IP literal goes to `ip`, which keeps create_socket's AI_NUMERICHOST
- // path. Anything else goes to `connect_host`, which create_socket resolves as
- // a name, or uses as the socket path when the address family is AF_UNIX. An
- // absent or empty mapping leaves `host` as the connection target; without the
- // empty check the value would reach getaddrinfo as a null node and silently
- // resolve to loopback.
- inline void apply_addr_map(const std::map<std::string, std::string> &addr_map,
- const std::string &host, std::string &connect_host,
- std::string &ip) {
- connect_host = host;
- ip.clear();
- auto it = addr_map.find(host);
- if (it == addr_map.end() || it->second.empty()) { return; }
- if (is_ip_address(it->second)) {
- ip = it->second;
- } else {
- connect_host = it->second;
- }
- }
- } // namespace detail
- /*
- * Group 2: detail namespace - SSL common utilities
- */
- #ifdef CPPHTTPLIB_SSL_ENABLED
- namespace detail {
- class SSLSocketStream final : public Stream {
- public:
- SSLSocketStream(
- socket_t sock, tls::session_t session, time_t read_timeout_sec,
- time_t read_timeout_usec, time_t write_timeout_sec,
- time_t write_timeout_usec, time_t max_timeout_msec = 0,
- std::chrono::time_point<std::chrono::steady_clock> start_time =
- (std::chrono::steady_clock::time_point::min)());
- ~SSLSocketStream() override;
- bool is_readable() const override;
- bool wait_readable() const override;
- bool wait_writable() const override;
- bool is_peer_alive() const override;
- ssize_t read(char *ptr, size_t size) override;
- ssize_t write(const char *ptr, size_t size) override;
- void get_remote_ip_and_port(std::string &ip, int &port) const override;
- void get_local_ip_and_port(std::string &ip, int &port) const override;
- socket_t socket() const override;
- time_t duration() const override;
- void set_read_timeout(time_t sec, time_t usec = 0) override;
- // See SocketStream::set_readable_hint().
- void set_readable_hint() { readable_hint_ = true; }
- private:
- bool ensure_readable();
- socket_t sock_;
- tls::session_t session_;
- time_t read_timeout_sec_;
- time_t read_timeout_usec_;
- time_t write_timeout_sec_;
- time_t write_timeout_usec_;
- time_t max_timeout_msec_;
- const std::chrono::time_point<std::chrono::steady_clock> start_time_;
- bool readable_hint_ = false;
- };
- #ifdef CPPHTTPLIB_OPENSSL_SUPPORT
- inline std::string message_digest(const std::string &s, const EVP_MD *algo) {
- auto context = std::unique_ptr<EVP_MD_CTX, decltype(&EVP_MD_CTX_free)>(
- EVP_MD_CTX_new(), EVP_MD_CTX_free);
- unsigned int hash_length = 0;
- unsigned char hash[EVP_MAX_MD_SIZE];
- EVP_DigestInit_ex(context.get(), algo, nullptr);
- EVP_DigestUpdate(context.get(), s.c_str(), s.size());
- EVP_DigestFinal_ex(context.get(), hash, &hash_length);
- std::stringstream ss;
- for (auto i = 0u; i < hash_length; ++i) {
- ss << std::hex << std::setw(2) << std::setfill('0')
- << static_cast<unsigned int>(hash[i]);
- }
- return ss.str();
- }
- inline std::string MD5(const std::string &s) {
- return message_digest(s, EVP_md5());
- }
- inline std::string SHA_256(const std::string &s) {
- return message_digest(s, EVP_sha256());
- }
- inline std::string SHA_512(const std::string &s) {
- return message_digest(s, EVP_sha512());
- }
- #elif defined(CPPHTTPLIB_MBEDTLS_SUPPORT)
- namespace {
- template <size_t N>
- inline std::string hash_to_hex(const unsigned char (&hash)[N]) {
- std::stringstream ss;
- for (size_t i = 0; i < N; ++i) {
- ss << std::hex << std::setw(2) << std::setfill('0')
- << static_cast<unsigned int>(hash[i]);
- }
- return ss.str();
- }
- } // namespace
- #ifdef CPPHTTPLIB_MBEDTLS_V4
- // Mbed TLS 4.x provides hashing (and TLS RNG) via PSA Crypto, which must be
- // initialized once. PSA state is process-global; do not free it.
- inline bool ensure_mbedtls_psa_crypto() {
- static std::once_flag once;
- static bool ok = false;
- std::call_once(once, []() { ok = (psa_crypto_init() == PSA_SUCCESS); });
- return ok;
- }
- inline bool psa_hash(psa_algorithm_t alg, const std::string &s,
- unsigned char *out, size_t out_size) {
- if (!ensure_mbedtls_psa_crypto()) { return false; }
- size_t olen = 0;
- return psa_hash_compute(alg, reinterpret_cast<const uint8_t *>(s.data()),
- s.size(), out, out_size, &olen) == PSA_SUCCESS &&
- olen == out_size;
- }
- #endif
- inline std::string MD5(const std::string &s) {
- unsigned char hash[16];
- #ifdef CPPHTTPLIB_MBEDTLS_V4
- if (!psa_hash(PSA_ALG_MD5, s, hash, sizeof(hash))) { return {}; }
- #elif defined(CPPHTTPLIB_MBEDTLS_V3)
- mbedtls_md5(reinterpret_cast<const unsigned char *>(s.c_str()), s.size(),
- hash);
- #else
- mbedtls_md5_ret(reinterpret_cast<const unsigned char *>(s.c_str()), s.size(),
- hash);
- #endif
- return hash_to_hex(hash);
- }
- inline std::string SHA_256(const std::string &s) {
- unsigned char hash[32];
- #ifdef CPPHTTPLIB_MBEDTLS_V4
- if (!psa_hash(PSA_ALG_SHA_256, s, hash, sizeof(hash))) { return {}; }
- #elif defined(CPPHTTPLIB_MBEDTLS_V3)
- mbedtls_sha256(reinterpret_cast<const unsigned char *>(s.c_str()), s.size(),
- hash, 0);
- #else
- mbedtls_sha256_ret(reinterpret_cast<const unsigned char *>(s.c_str()),
- s.size(), hash, 0);
- #endif
- return hash_to_hex(hash);
- }
- inline std::string SHA_512(const std::string &s) {
- unsigned char hash[64];
- #ifdef CPPHTTPLIB_MBEDTLS_V4
- if (!psa_hash(PSA_ALG_SHA_512, s, hash, sizeof(hash))) { return {}; }
- #elif defined(CPPHTTPLIB_MBEDTLS_V3)
- mbedtls_sha512(reinterpret_cast<const unsigned char *>(s.c_str()), s.size(),
- hash, 0);
- #else
- mbedtls_sha512_ret(reinterpret_cast<const unsigned char *>(s.c_str()),
- s.size(), hash, 0);
- #endif
- return hash_to_hex(hash);
- }
- #elif defined(CPPHTTPLIB_WOLFSSL_SUPPORT)
- namespace {
- template <size_t N>
- inline std::string hash_to_hex(const unsigned char (&hash)[N]) {
- std::stringstream ss;
- for (size_t i = 0; i < N; ++i) {
- ss << std::hex << std::setw(2) << std::setfill('0')
- << static_cast<unsigned int>(hash[i]);
- }
- return ss.str();
- }
- } // namespace
- inline std::string MD5(const std::string &s) {
- unsigned char hash[WC_MD5_DIGEST_SIZE];
- wc_Md5Hash(reinterpret_cast<const unsigned char *>(s.c_str()),
- static_cast<word32>(s.size()), hash);
- return hash_to_hex(hash);
- }
- inline std::string SHA_256(const std::string &s) {
- unsigned char hash[WC_SHA256_DIGEST_SIZE];
- wc_Sha256Hash(reinterpret_cast<const unsigned char *>(s.c_str()),
- static_cast<word32>(s.size()), hash);
- return hash_to_hex(hash);
- }
- inline std::string SHA_512(const std::string &s) {
- unsigned char hash[WC_SHA512_DIGEST_SIZE];
- wc_Sha512Hash(reinterpret_cast<const unsigned char *>(s.c_str()),
- static_cast<word32>(s.size()), hash);
- return hash_to_hex(hash);
- }
- #endif
- template <typename T>
- inline bool process_server_socket_ssl(
- const std::atomic<socket_t> &svr_sock, tls::session_t session,
- socket_t sock, size_t keep_alive_max_count, time_t keep_alive_timeout_sec,
- time_t read_timeout_sec, time_t read_timeout_usec, time_t write_timeout_sec,
- time_t write_timeout_usec, T callback) {
- return process_server_socket_core(
- svr_sock, sock, keep_alive_max_count, keep_alive_timeout_sec,
- [&](bool close_connection, bool &connection_closed) {
- SSLSocketStream strm(sock, session, read_timeout_sec, read_timeout_usec,
- write_timeout_sec, write_timeout_usec);
- // See the non-TLS path in process_server_socket().
- strm.set_readable_hint();
- return callback(strm, close_connection, connection_closed);
- });
- }
- template <typename T>
- inline bool process_client_socket_ssl(
- tls::session_t session, socket_t sock, time_t read_timeout_sec,
- time_t read_timeout_usec, time_t write_timeout_sec,
- time_t write_timeout_usec, time_t max_timeout_msec,
- std::chrono::time_point<std::chrono::steady_clock> start_time, T callback) {
- SSLSocketStream strm(sock, session, read_timeout_sec, read_timeout_usec,
- write_timeout_sec, write_timeout_usec, max_timeout_msec,
- start_time);
- return callback(strm);
- }
- inline std::pair<std::string, std::string> make_digest_authentication_header(
- const Request &req, const std::map<std::string, std::string> &auth,
- size_t cnonce_count, const std::string &cnonce, const std::string &username,
- const std::string &password, bool is_proxy = false) {
- std::string nc;
- {
- std::stringstream ss;
- ss << std::setfill('0') << std::setw(8) << std::hex << cnonce_count;
- nc = ss.str();
- }
- std::string qop;
- if (auth.find("qop") != auth.end()) {
- qop = auth.at("qop");
- if (qop.find("auth-int") != std::string::npos) {
- qop = "auth-int";
- } else if (qop.find("auth") != std::string::npos) {
- qop = "auth";
- } else {
- qop.clear();
- }
- }
- std::string algo = "MD5";
- if (auth.find("algorithm") != auth.end()) { algo = auth.at("algorithm"); }
- std::string response;
- {
- auto H = algo == "SHA-256" ? detail::SHA_256
- : algo == "SHA-512" ? detail::SHA_512
- : detail::MD5;
- auto A1 = username + ":" + auth.at("realm") + ":" + password;
- auto A2 = req.method + ":" + req.path;
- if (qop == "auth-int") { A2 += ":" + H(req.body); }
- if (qop.empty()) {
- response = H(H(A1) + ":" + auth.at("nonce") + ":" + H(A2));
- } else {
- response = H(H(A1) + ":" + auth.at("nonce") + ":" + nc + ":" + cnonce +
- ":" + qop + ":" + H(A2));
- }
- }
- auto opaque = (auth.find("opaque") != auth.end()) ? auth.at("opaque") : "";
- auto field = "Digest username=\"" + username + "\", realm=\"" +
- auth.at("realm") + "\", nonce=\"" + auth.at("nonce") +
- "\", uri=\"" + req.path + "\", algorithm=" + algo +
- (qop.empty() ? ", response=\""
- : ", qop=" + qop + ", nc=" + nc + ", cnonce=\"" +
- cnonce + "\", response=\"") +
- response + "\"" +
- (opaque.empty() ? "" : ", opaque=\"" + opaque + "\"");
- auto key = is_proxy ? "Proxy-Authorization" : "Authorization";
- return std::make_pair(key, field);
- }
- inline bool match_hostname(const std::string &pattern,
- const std::string &hostname) {
- // Exact match (case-insensitive)
- if (detail::case_ignore::equal(hostname, pattern)) { return true; }
- // Split both pattern and hostname into components by '.'
- std::vector<std::string> pattern_components;
- if (!pattern.empty()) {
- split(pattern.data(), pattern.data() + pattern.size(), '.',
- [&](const char *b, const char *e) {
- pattern_components.emplace_back(b, e);
- });
- }
- std::vector<std::string> host_components;
- if (!hostname.empty()) {
- split(hostname.data(), hostname.data() + hostname.size(), '.',
- [&](const char *b, const char *e) {
- host_components.emplace_back(b, e);
- });
- }
- // Component count must match
- if (host_components.size() != pattern_components.size()) { return false; }
- // Compare each component with wildcard support
- // Supports: "*" (full wildcard), "prefix*" (partial wildcard)
- // https://bugs.launchpad.net/ubuntu/+source/firefox-3.0/+bug/376484
- auto itr = pattern_components.begin();
- for (const auto &h : host_components) {
- auto &p = *itr;
- if (!detail::case_ignore::equal(p, h) && p != "*") {
- bool partial_match = false;
- if (!p.empty() && p[p.size() - 1] == '*') {
- const auto prefix_length = p.size() - 1;
- if (prefix_length == 0) {
- partial_match = true;
- } else if (h.size() >= prefix_length) {
- partial_match =
- std::equal(p.begin(),
- p.begin() + static_cast<std::string::difference_type>(
- prefix_length),
- h.begin(), [](const char ca, const char cb) {
- return detail::case_ignore::to_lower(ca) ==
- detail::case_ignore::to_lower(cb);
- });
- }
- }
- if (!partial_match) { return false; }
- }
- ++itr;
- }
- return true;
- }
- #ifdef _WIN32
- // Verify certificate using Windows CertGetCertificateChain API.
- // This provides real-time certificate validation with Windows Update
- // integration, independent of the TLS backend (OpenSSL or MbedTLS).
- inline bool
- verify_cert_with_windows_schannel(const std::vector<unsigned char> &der_cert,
- const std::string &hostname,
- bool verify_hostname, uint64_t &out_error) {
- if (der_cert.empty()) { return false; }
- out_error = 0;
- // Create Windows certificate context from DER data
- auto cert_context = CertCreateCertificateContext(
- X509_ASN_ENCODING | PKCS_7_ASN_ENCODING, der_cert.data(),
- static_cast<DWORD>(der_cert.size()));
- if (!cert_context) {
- out_error = GetLastError();
- return false;
- }
- auto cert_guard =
- scope_exit([&] { CertFreeCertificateContext(cert_context); });
- // Setup chain parameters
- CERT_CHAIN_PARA chain_para = {};
- chain_para.cbSize = sizeof(chain_para);
- // Build certificate chain with revocation checking
- PCCERT_CHAIN_CONTEXT chain_context = nullptr;
- auto chain_result = CertGetCertificateChain(
- nullptr, cert_context, nullptr, cert_context->hCertStore, &chain_para,
- CERT_CHAIN_CACHE_END_CERT | CERT_CHAIN_REVOCATION_CHECK_END_CERT |
- CERT_CHAIN_REVOCATION_ACCUMULATIVE_TIMEOUT,
- nullptr, &chain_context);
- if (!chain_result || !chain_context) {
- out_error = GetLastError();
- return false;
- }
- auto chain_guard =
- scope_exit([&] { CertFreeCertificateChain(chain_context); });
- // Check if chain has errors
- if (chain_context->TrustStatus.dwErrorStatus != CERT_TRUST_NO_ERROR) {
- out_error = chain_context->TrustStatus.dwErrorStatus;
- return false;
- }
- // Verify SSL policy
- SSL_EXTRA_CERT_CHAIN_POLICY_PARA extra_policy_para = {};
- extra_policy_para.cbSize = sizeof(extra_policy_para);
- #ifdef AUTHTYPE_SERVER
- extra_policy_para.dwAuthType = AUTHTYPE_SERVER;
- #endif
- std::wstring whost;
- if (verify_hostname) {
- whost = u8string_to_wstring(hostname.c_str());
- extra_policy_para.pwszServerName = const_cast<wchar_t *>(whost.c_str());
- }
- CERT_CHAIN_POLICY_PARA policy_para = {};
- policy_para.cbSize = sizeof(policy_para);
- #ifdef CERT_CHAIN_POLICY_IGNORE_ALL_REV_UNKNOWN_FLAGS
- policy_para.dwFlags = CERT_CHAIN_POLICY_IGNORE_ALL_REV_UNKNOWN_FLAGS;
- #else
- policy_para.dwFlags = 0;
- #endif
- policy_para.pvExtraPolicyPara = &extra_policy_para;
- CERT_CHAIN_POLICY_STATUS policy_status = {};
- policy_status.cbSize = sizeof(policy_status);
- if (!CertVerifyCertificateChainPolicy(CERT_CHAIN_POLICY_SSL, chain_context,
- &policy_para, &policy_status)) {
- out_error = GetLastError();
- return false;
- }
- if (policy_status.dwError != 0) {
- out_error = policy_status.dwError;
- return false;
- }
- return true;
- }
- #endif // _WIN32
- // Loads CA file/dir configuration and applies the system CA policy to a
- // client TLS context. PEM data and native stores are applied to the context
- // directly at set time; has_custom_store reflects them for the Auto policy
- // decision.
- inline bool load_client_ca_config(tls::ctx_t ctx,
- const std::string &ca_cert_file_path,
- const std::string &ca_cert_dir_path,
- bool has_custom_store, SystemCAMode mode,
- uint64_t &backend_error) {
- auto ret = true;
- if (!ca_cert_file_path.empty()) {
- if (!tls::load_ca_file(ctx, ca_cert_file_path.c_str())) {
- backend_error = tls::get_error();
- ret = false;
- }
- } else if (!ca_cert_dir_path.empty()) {
- if (!tls::load_ca_dir(ctx, ca_cert_dir_path.c_str())) {
- backend_error = tls::get_error();
- ret = false;
- }
- }
- auto has_custom_ca = !ca_cert_file_path.empty() ||
- !ca_cert_dir_path.empty() || has_custom_store;
- if (mode == SystemCAMode::Enabled ||
- (mode == SystemCAMode::Auto && !has_custom_ca)) {
- if (!tls::load_system_certs(ctx)) { backend_error = tls::get_error(); }
- }
- return ret;
- }
- // The parts of session setup that only SSLClient needs, plus the handful
- // WebSocketClient also exposes; everything else takes the defaults, which is
- // what keeps the two clients on one implementation.
- struct ClientTlsSessionOptions {
- // Both SSLClient and WebSocketClient expose this independently of
- // certificate verification.
- bool server_hostname_verification = true;
- std::function<SSLVerifierResponse(tls::session_t)> session_verifier;
- // When non-null, guards session creation against concurrent use of the
- // context. A WebSocketClient is not safe to use from several threads to
- // begin with, so it passes nothing.
- std::mutex *ctx_mutex = nullptr;
- #ifdef CPPHTTPLIB_WINDOWS_AUTOMATIC_ROOT_CERTIFICATES_UPDATE
- // The caller decides whether Schannel has anything to say about this
- // connection; see SSLClient::initialize_ssl().
- bool windows_cert_verification = false;
- #endif
- };
- // Filled in on failure for callers that report error details.
- struct ClientTlsSessionError {
- Error error = Error::Success;
- int ssl_error = 0;
- uint64_t backend_error = 0;
- };
- // Establishes a client TLS session on an already connected socket. On failure
- // the session is left for the caller to free: SSLClient frees it right away,
- // WebSocketClient keeps it in a member that shutdown_and_close() cleans up.
- inline bool setup_client_tls_session(
- const std::string &host, tls::ctx_t ctx, tls::session_t &session,
- socket_t sock, bool server_certificate_verification, time_t timeout_sec,
- time_t timeout_usec, ClientTlsSessionError *out_error = nullptr,
- const ClientTlsSessionOptions &options = ClientTlsSessionOptions()) {
- using namespace tls;
- auto fail = [&](Error error, int ssl_error, uint64_t backend_error) {
- if (out_error) {
- out_error->error = error;
- out_error->ssl_error = ssl_error;
- out_error->backend_error = backend_error;
- }
- return false;
- };
- if (!ctx) {
- session = nullptr;
- return fail(Error::SSLConnection, 0, 0);
- }
- #if defined(CPPHTTPLIB_MBEDTLS_SUPPORT) || defined(CPPHTTPLIB_WOLFSSL_SUPPORT)
- // Mbed TLS and wolfSSL need the verification mode set explicitly; OpenSSL
- // uses SSL_VERIFY_NONE and does all verification post-handshake. Chain
- // verification happens during the handshake even for IP hosts; the
- // certificate identity is verified post-handshake via verify_hostname().
- set_verify_client(ctx, server_certificate_verification);
- #endif
- {
- std::unique_lock<std::mutex> guard;
- if (options.ctx_mutex) {
- guard = std::unique_lock<std::mutex>(*options.ctx_mutex);
- }
- session = create_session(ctx, sock);
- }
- if (!session) { return fail(Error::SSLConnection, 0, get_error()); }
- // RFC 6066: SNI must not be set for IP addresses; skip it for IP hosts, so
- // their identity is checked post-handshake below instead. On Mbed TLS and
- // wolfSSL, set_sni also drives handshake-time hostname verification, so
- // options.server_hostname_verification is threaded through here.
- if (!is_ip_address(host)) {
- if (!set_sni(session, host.c_str(), options.server_hostname_verification)) {
- return fail(Error::SSLConnection, 0, get_error());
- }
- }
- TlsError tls_err;
- if (!connect_nonblocking(session, sock, timeout_sec, timeout_usec,
- &tls_err)) {
- auto error = Error::SSLConnection;
- if (tls_err.code == ErrorCode::CertVerifyFailed) {
- error = Error::SSLServerVerification;
- } else if (tls_err.code == ErrorCode::HostnameMismatch) {
- error = Error::SSLServerHostnameVerification;
- }
- return fail(error, static_cast<int>(tls_err.code), tls_err.backend_code);
- }
- auto verification_status = SSLVerifierResponse::NoDecisionMade;
- if (options.session_verifier) {
- verification_status = options.session_verifier(session);
- }
- if (verification_status == SSLVerifierResponse::CertificateRejected) {
- return fail(Error::SSLServerVerification, 0, get_error());
- }
- if (verification_status == SSLVerifierResponse::NoDecisionMade &&
- server_certificate_verification) {
- auto verify_result = get_verify_result(session);
- if (verify_result != 0) {
- return fail(Error::SSLServerVerification, 0,
- static_cast<uint64_t>(verify_result));
- }
- auto server_cert = get_peer_cert(session);
- if (!server_cert) {
- return fail(Error::SSLServerVerification, 0, get_error());
- }
- auto cert_guard = detail::scope_exit([&] { free_cert(server_cert); });
- // Identity check against the peer certificate, post-handshake for all
- // backends. For IP hosts this is the only identity verification, since no
- // hostname is bound during the handshake.
- if (options.server_hostname_verification) {
- if (!verify_hostname(server_cert, host.c_str())) {
- return fail(Error::SSLServerHostnameVerification, 0,
- hostname_mismatch_code());
- }
- }
- #ifdef CPPHTTPLIB_WINDOWS_AUTOMATIC_ROOT_CERTIFICATES_UPDATE
- // Additional Windows Schannel verification.
- // This provides real-time certificate validation with Windows Update
- // integration, working with both OpenSSL and MbedTLS backends.
- if (options.windows_cert_verification) {
- std::vector<unsigned char> der;
- if (get_cert_der(server_cert, der)) {
- uint64_t wincrypt_error = 0;
- if (!verify_cert_with_windows_schannel(
- der, host, options.server_hostname_verification,
- wincrypt_error)) {
- return fail(Error::SSLServerVerification, 0, wincrypt_error);
- }
- }
- }
- #endif
- }
- return true;
- }
- } // namespace detail
- #endif // CPPHTTPLIB_SSL_ENABLED
- /*
- * Group 3: httplib namespace - Non-SSL public API implementations
- */
- inline void default_socket_options(socket_t sock) {
- set_socket_opt(sock, SOL_SOCKET,
- #ifdef SO_REUSEPORT
- SO_REUSEPORT,
- #else
- SO_REUSEADDR,
- #endif
- 1);
- }
- inline bool set_socket_opt(socket_t sock, int level, int optname, int optval) {
- return detail::set_socket_opt_impl(sock, level, optname, &optval,
- sizeof(optval));
- }
- inline std::string get_bearer_token_auth(const Request &req) {
- if (req.has_header("Authorization")) {
- constexpr auto bearer_header_prefix_len = detail::str_len("Bearer ");
- return req.get_header_value("Authorization")
- .substr(bearer_header_prefix_len);
- }
- return "";
- }
- inline const char *status_message(int status) {
- switch (status) {
- case StatusCode::Continue_100: return "Continue";
- case StatusCode::SwitchingProtocol_101: return "Switching Protocol";
- case StatusCode::Processing_102: return "Processing";
- case StatusCode::EarlyHints_103: return "Early Hints";
- case StatusCode::OK_200: return "OK";
- case StatusCode::Created_201: return "Created";
- case StatusCode::Accepted_202: return "Accepted";
- case StatusCode::NonAuthoritativeInformation_203:
- return "Non-Authoritative Information";
- case StatusCode::NoContent_204: return "No Content";
- case StatusCode::ResetContent_205: return "Reset Content";
- case StatusCode::PartialContent_206: return "Partial Content";
- case StatusCode::MultiStatus_207: return "Multi-Status";
- case StatusCode::AlreadyReported_208: return "Already Reported";
- case StatusCode::IMUsed_226: return "IM Used";
- case StatusCode::MultipleChoices_300: return "Multiple Choices";
- case StatusCode::MovedPermanently_301: return "Moved Permanently";
- case StatusCode::Found_302: return "Found";
- case StatusCode::SeeOther_303: return "See Other";
- case StatusCode::NotModified_304: return "Not Modified";
- case StatusCode::UseProxy_305: return "Use Proxy";
- case StatusCode::unused_306: return "unused";
- case StatusCode::TemporaryRedirect_307: return "Temporary Redirect";
- case StatusCode::PermanentRedirect_308: return "Permanent Redirect";
- case StatusCode::BadRequest_400: return "Bad Request";
- case StatusCode::Unauthorized_401: return "Unauthorized";
- case StatusCode::PaymentRequired_402: return "Payment Required";
- case StatusCode::Forbidden_403: return "Forbidden";
- case StatusCode::NotFound_404: return "Not Found";
- case StatusCode::MethodNotAllowed_405: return "Method Not Allowed";
- case StatusCode::NotAcceptable_406: return "Not Acceptable";
- case StatusCode::ProxyAuthenticationRequired_407:
- return "Proxy Authentication Required";
- case StatusCode::RequestTimeout_408: return "Request Timeout";
- case StatusCode::Conflict_409: return "Conflict";
- case StatusCode::Gone_410: return "Gone";
- case StatusCode::LengthRequired_411: return "Length Required";
- case StatusCode::PreconditionFailed_412: return "Precondition Failed";
- case StatusCode::PayloadTooLarge_413: return "Payload Too Large";
- case StatusCode::UriTooLong_414: return "URI Too Long";
- case StatusCode::UnsupportedMediaType_415: return "Unsupported Media Type";
- case StatusCode::RangeNotSatisfiable_416: return "Range Not Satisfiable";
- case StatusCode::ExpectationFailed_417: return "Expectation Failed";
- case StatusCode::ImATeapot_418: return "I'm a teapot";
- case StatusCode::MisdirectedRequest_421: return "Misdirected Request";
- case StatusCode::UnprocessableContent_422: return "Unprocessable Content";
- case StatusCode::Locked_423: return "Locked";
- case StatusCode::FailedDependency_424: return "Failed Dependency";
- case StatusCode::TooEarly_425: return "Too Early";
- case StatusCode::UpgradeRequired_426: return "Upgrade Required";
- case StatusCode::PreconditionRequired_428: return "Precondition Required";
- case StatusCode::TooManyRequests_429: return "Too Many Requests";
- case StatusCode::RequestHeaderFieldsTooLarge_431:
- return "Request Header Fields Too Large";
- case StatusCode::UnavailableForLegalReasons_451:
- return "Unavailable For Legal Reasons";
- case StatusCode::NotImplemented_501: return "Not Implemented";
- case StatusCode::BadGateway_502: return "Bad Gateway";
- case StatusCode::ServiceUnavailable_503: return "Service Unavailable";
- case StatusCode::GatewayTimeout_504: return "Gateway Timeout";
- case StatusCode::HttpVersionNotSupported_505:
- return "HTTP Version Not Supported";
- case StatusCode::VariantAlsoNegotiates_506: return "Variant Also Negotiates";
- case StatusCode::InsufficientStorage_507: return "Insufficient Storage";
- case StatusCode::LoopDetected_508: return "Loop Detected";
- case StatusCode::NotExtended_510: return "Not Extended";
- case StatusCode::NetworkAuthenticationRequired_511:
- return "Network Authentication Required";
- default:
- case StatusCode::InternalServerError_500: return "Internal Server Error";
- }
- }
- inline std::string to_string(const Error error) {
- switch (error) {
- case Error::Success: return "Success (no error)";
- case Error::Unknown: return "Unknown";
- case Error::Connection: return "Could not establish connection";
- case Error::BindIPAddress: return "Failed to bind IP address";
- case Error::Read: return "Failed to read connection";
- case Error::Write: return "Failed to write connection";
- case Error::ExceedRedirectCount: return "Maximum redirect count exceeded";
- case Error::Canceled: return "Connection handling canceled";
- case Error::SSLConnection: return "SSL connection failed";
- case Error::SSLLoadingCerts: return "SSL certificate loading failed";
- case Error::SSLServerVerification: return "SSL server verification failed";
- case Error::SSLServerHostnameVerification:
- return "SSL server hostname verification failed";
- case Error::UnsupportedMultipartBoundaryChars:
- return "Unsupported HTTP multipart boundary characters";
- case Error::Compression: return "Compression failed";
- case Error::ConnectionTimeout: return "Connection timed out";
- case Error::ProxyConnection: return "Proxy connection failed";
- case Error::ConnectionClosed: return "Connection closed by server";
- case Error::Timeout: return "Read timeout";
- case Error::ResourceExhaustion: return "Resource exhaustion";
- case Error::TooManyFormDataFiles: return "Too many form data files";
- case Error::ExceedMaxPayloadSize: return "Exceeded maximum payload size";
- case Error::ExceedUriMaxLength: return "Exceeded maximum URI length";
- case Error::ExceedMaxSocketDescriptorCount:
- return "Exceeded maximum socket descriptor count";
- case Error::InvalidRequestLine: return "Invalid request line";
- case Error::InvalidHTTPMethod: return "Invalid HTTP method";
- case Error::InvalidHTTPVersion: return "Invalid HTTP version";
- case Error::InvalidHeaders: return "Invalid headers";
- case Error::MultipartParsing: return "Multipart parsing failed";
- case Error::OpenFile: return "Failed to open file";
- case Error::Listen: return "Failed to listen on socket";
- case Error::GetSockName: return "Failed to get socket name";
- case Error::UnsupportedAddressFamily: return "Unsupported address family";
- case Error::HTTPParsing: return "HTTP parsing failed";
- case Error::InvalidRangeHeader: return "Invalid Range header";
- case Error::UnsupportedContentEncoding: return "Unsupported Content-Encoding";
- case Error::WebSocketHandshake: return "WebSocket handshake failed";
- default: break;
- }
- return "Invalid";
- }
- inline std::ostream &operator<<(std::ostream &os, const Error &obj) {
- os << to_string(obj);
- os << " (" << static_cast<std::underlying_type<Error>::type>(obj) << ')';
- return os;
- }
- inline std::string hosted_at(const std::string &hostname) {
- std::vector<std::string> addrs;
- hosted_at(hostname, addrs);
- if (addrs.empty()) { return std::string(); }
- return addrs[0];
- }
- inline void hosted_at(const std::string &hostname,
- std::vector<std::string> &addrs) {
- struct addrinfo hints;
- struct addrinfo *result;
- memset(&hints, 0, sizeof(struct addrinfo));
- hints.ai_family = AF_UNSPEC;
- hints.ai_socktype = SOCK_STREAM;
- hints.ai_protocol = 0;
- if (detail::getaddrinfo_with_timeout(hostname.c_str(), nullptr, &hints,
- &result, 0)) {
- #if defined __linux__ && !defined __ANDROID__
- res_init();
- #endif
- return;
- }
- auto se = detail::scope_exit([&] { freeaddrinfo(result); });
- for (auto rp = result; rp; rp = rp->ai_next) {
- const auto &addr =
- *reinterpret_cast<struct sockaddr_storage *>(rp->ai_addr);
- std::string ip;
- auto dummy = -1;
- if (detail::get_ip_and_port(addr, sizeof(struct sockaddr_storage), ip,
- dummy)) {
- addrs.emplace_back(std::move(ip));
- }
- }
- }
- inline std::string encode_uri_component(const std::string &value) {
- std::ostringstream escaped;
- escaped.fill('0');
- escaped << std::hex;
- for (auto c : value) {
- if (detail::is_ascii_alnum(c) || c == '-' || c == '_' || c == '.' ||
- c == '!' || c == '~' || c == '*' || c == '\'' || c == '(' || c == ')') {
- escaped << c;
- } else {
- escaped << std::uppercase;
- escaped << '%' << std::setw(2)
- << static_cast<int>(static_cast<unsigned char>(c));
- escaped << std::nouppercase;
- }
- }
- return escaped.str();
- }
- inline std::string encode_uri(const std::string &value) {
- std::ostringstream escaped;
- escaped.fill('0');
- escaped << std::hex;
- for (auto c : value) {
- if (detail::is_ascii_alnum(c) || c == '-' || c == '_' || c == '.' ||
- c == '!' || c == '~' || c == '*' || c == '\'' || c == '(' || c == ')' ||
- c == ';' || c == '/' || c == '?' || c == ':' || c == '@' || c == '&' ||
- c == '=' || c == '+' || c == '$' || c == ',' || c == '#') {
- escaped << c;
- } else {
- escaped << std::uppercase;
- escaped << '%' << std::setw(2)
- << static_cast<int>(static_cast<unsigned char>(c));
- escaped << std::nouppercase;
- }
- }
- return escaped.str();
- }
- inline std::string decode_uri_component(const std::string &value) {
- std::string result;
- for (size_t i = 0; i < value.size(); i++) {
- if (value[i] == '%' && i + 2 < value.size()) {
- auto val = 0;
- if (detail::from_hex_to_i(value, i + 1, 2, val)) {
- result += static_cast<char>(val);
- i += 2;
- } else {
- result += value[i];
- }
- } else {
- result += value[i];
- }
- }
- return result;
- }
- inline std::string decode_uri(const std::string &value) {
- std::string result;
- for (size_t i = 0; i < value.size(); i++) {
- if (value[i] == '%' && i + 2 < value.size()) {
- auto val = 0;
- if (detail::from_hex_to_i(value, i + 1, 2, val)) {
- result += static_cast<char>(val);
- i += 2;
- } else {
- result += value[i];
- }
- } else {
- result += value[i];
- }
- }
- return result;
- }
- inline std::string encode_path_component(const std::string &component) {
- std::string result;
- result.reserve(component.size() * 3);
- for (size_t i = 0; i < component.size(); i++) {
- auto c = static_cast<unsigned char>(component[i]);
- // Unreserved characters per RFC 3986: ALPHA / DIGIT / "-" / "." / "_" / "~"
- if (detail::is_ascii_alnum(static_cast<char>(c)) || c == '-' || c == '.' ||
- c == '_' || c == '~') {
- result += static_cast<char>(c);
- }
- // Path-safe sub-delimiters: "!" / "$" / "&" / "'" / "(" / ")" / "*" / "+" /
- // "," / ";" / "="
- else if (c == '!' || c == '$' || c == '&' || c == '\'' || c == '(' ||
- c == ')' || c == '*' || c == '+' || c == ',' || c == ';' ||
- c == '=') {
- result += static_cast<char>(c);
- }
- // Colon is allowed in path segments except first segment
- else if (c == ':') {
- result += static_cast<char>(c);
- }
- // @ is allowed in path
- else if (c == '@') {
- result += static_cast<char>(c);
- } else {
- result += '%';
- char hex[3];
- snprintf(hex, sizeof(hex), "%02X", c);
- result.append(hex, 2);
- }
- }
- return result;
- }
- inline std::string decode_path_component(const std::string &component) {
- std::string result;
- result.reserve(component.size());
- for (size_t i = 0; i < component.size(); i++) {
- if (component[i] == '%' && i + 1 < component.size()) {
- if (component[i + 1] == 'u') {
- // Unicode %uXXXX encoding
- auto val = 0;
- if (detail::from_hex_to_i(component, i + 2, 4, val)) {
- // 4 digits Unicode codes: val is 0x0000-0xFFFF (from 4 hex digits),
- // so to_utf8 writes at most 3 bytes. buff[4] is safe.
- char buff[4];
- size_t len = detail::to_utf8(val, buff);
- if (len > 0) { result.append(buff, len); }
- i += 5; // 'u0000'
- } else {
- result += component[i];
- }
- } else {
- // Standard %XX encoding
- auto val = 0;
- if (detail::from_hex_to_i(component, i + 1, 2, val)) {
- // 2 digits hex codes
- result += static_cast<char>(val);
- i += 2; // 'XX'
- } else {
- result += component[i];
- }
- }
- } else {
- result += component[i];
- }
- }
- return result;
- }
- inline std::string encode_query_component(const std::string &component,
- bool space_as_plus) {
- std::string result;
- result.reserve(component.size() * 3);
- for (size_t i = 0; i < component.size(); i++) {
- auto c = static_cast<unsigned char>(component[i]);
- // Unreserved characters per RFC 3986
- if (detail::is_ascii_alnum(static_cast<char>(c)) || c == '-' || c == '.' ||
- c == '_' || c == '~') {
- result += static_cast<char>(c);
- }
- // Space handling
- else if (c == ' ') {
- if (space_as_plus) {
- result += '+';
- } else {
- result += "%20";
- }
- }
- // Plus sign handling
- else if (c == '+') {
- if (space_as_plus) {
- result += "%2B";
- } else {
- result += static_cast<char>(c);
- }
- }
- // Query-safe sub-delimiters (excluding & and = which are query delimiters)
- else if (c == '!' || c == '$' || c == '\'' || c == '(' || c == ')' ||
- c == '*' || c == ',' || c == ';') {
- result += static_cast<char>(c);
- }
- // Colon and @ are allowed in query
- else if (c == ':' || c == '@') {
- result += static_cast<char>(c);
- }
- // Forward slash is allowed in query values
- else if (c == '/') {
- result += static_cast<char>(c);
- }
- // Question mark is allowed in query values (after first ?)
- else if (c == '?') {
- result += static_cast<char>(c);
- } else {
- result += '%';
- char hex[3];
- snprintf(hex, sizeof(hex), "%02X", c);
- result.append(hex, 2);
- }
- }
- return result;
- }
- inline std::string decode_query_component(const std::string &component,
- bool plus_as_space) {
- std::string result;
- result.reserve(component.size());
- for (size_t i = 0; i < component.size(); i++) {
- if (component[i] == '%' && i + 2 < component.size()) {
- auto val = 0;
- if (detail::from_hex_to_i(component, i + 1, 2, val)) {
- result += static_cast<char>(val);
- i += 2;
- } else {
- result += component[i];
- }
- } else if (component[i] == '+' && plus_as_space) {
- result += ' '; // + becomes space in form-urlencoded
- } else {
- result += component[i];
- }
- }
- return result;
- }
- inline std::string sanitize_filename(const std::string &filename) {
- // Extract basename: find the last path separator (/ or \)
- auto pos = filename.find_last_of("/\\");
- auto result =
- (pos != std::string::npos) ? filename.substr(pos + 1) : filename;
- // Strip null bytes
- result.erase(std::remove(result.begin(), result.end(), '\0'), result.end());
- // Trim whitespace
- {
- auto start = result.find_first_not_of(" \t");
- auto end = result.find_last_not_of(" \t");
- result = (start == std::string::npos)
- ? ""
- : result.substr(start, end - start + 1);
- }
- // Reject . and ..
- if (result == "." || result == "..") { return ""; }
- return result;
- }
- inline std::string append_query_params(const std::string &path,
- const Params ¶ms) {
- std::string path_with_query = path;
- thread_local const std::regex re("[^?]+\\?.*");
- auto delm = std::regex_match(path, re) ? '&' : '?';
- path_with_query += delm + detail::params_to_query_str(params);
- return path_with_query;
- }
- // Header utilities
- inline std::pair<std::string, std::string>
- make_range_header(const Ranges &ranges) {
- std::string field = "bytes=";
- auto i = 0;
- for (const auto &r : ranges) {
- if (i != 0) { field += ", "; }
- if (r.first != -1) { field += std::to_string(r.first); }
- field += '-';
- if (r.second != -1) { field += std::to_string(r.second); }
- i++;
- }
- return std::make_pair("Range", std::move(field));
- }
- inline std::pair<std::string, std::string>
- make_basic_authentication_header(const std::string &username,
- const std::string &password, bool is_proxy) {
- auto field = "Basic " + detail::base64_encode(username + ":" + password);
- auto key = is_proxy ? "Proxy-Authorization" : "Authorization";
- return std::make_pair(key, std::move(field));
- }
- inline std::pair<std::string, std::string>
- make_bearer_token_authentication_header(const std::string &token,
- bool is_proxy = false) {
- auto field = "Bearer " + token;
- auto key = is_proxy ? "Proxy-Authorization" : "Authorization";
- return std::make_pair(key, std::move(field));
- }
- // Request implementation
- inline size_t Request::get_header_value_u64(const std::string &key, size_t def,
- size_t id) const {
- return detail::get_header_value_u64(headers, key, def, id);
- }
- inline bool Request::has_header(const std::string &key) const {
- return detail::has_header(headers, key);
- }
- inline std::string Request::get_header_value(const std::string &key,
- const char *def, size_t id) const {
- return detail::get_header_value(headers, key, def, id);
- }
- inline size_t Request::get_header_value_count(const std::string &key) const {
- return detail::get_header_value_count(headers, key);
- }
- inline void Request::set_header(const std::string &key,
- const std::string &val) {
- detail::set_header(headers, key, val);
- }
- inline bool Request::has_trailer(const std::string &key) const {
- return trailers.find(key) != trailers.end();
- }
- inline std::string Request::get_trailer_value(const std::string &key,
- size_t id) const {
- return detail::get_multimap_value(trailers, key, id);
- }
- inline size_t Request::get_trailer_value_count(const std::string &key) const {
- return trailers.count(key);
- }
- inline bool Request::has_param(const std::string &key) const {
- return params.find(key) != params.end();
- }
- inline std::string Request::get_param_value(const std::string &key,
- size_t id) const {
- return detail::get_multimap_value(params, key, id);
- }
- inline std::vector<std::string>
- Request::get_param_values(const std::string &key) const {
- auto rng = params.equal_range(key);
- std::vector<std::string> values;
- values.reserve(static_cast<size_t>(std::distance(rng.first, rng.second)));
- for (auto it = rng.first; it != rng.second; ++it) {
- values.push_back(it->second);
- }
- return values;
- }
- inline size_t Request::get_param_value_count(const std::string &key) const {
- return params.count(key);
- }
- inline bool Request::is_multipart_form_data() const {
- const auto &content_type = get_header_value("Content-Type");
- return detail::extract_media_type(content_type) == "multipart/form-data";
- }
- // Multipart FormData implementation
- inline std::string MultipartFormData::get_field(const std::string &key,
- size_t id) const {
- auto rng = fields.equal_range(key);
- auto it = rng.first;
- std::advance(it, static_cast<ssize_t>(id));
- if (it != rng.second) { return it->second.content; }
- return std::string();
- }
- inline std::vector<std::string>
- MultipartFormData::get_fields(const std::string &key) const {
- std::vector<std::string> values;
- auto rng = fields.equal_range(key);
- for (auto it = rng.first; it != rng.second; it++) {
- values.push_back(it->second.content);
- }
- return values;
- }
- inline bool MultipartFormData::has_field(const std::string &key) const {
- return fields.find(key) != fields.end();
- }
- inline size_t MultipartFormData::get_field_count(const std::string &key) const {
- return fields.count(key);
- }
- inline FormData MultipartFormData::get_file(const std::string &key,
- size_t id) const {
- return detail::get_multimap_value(files, key, id);
- }
- inline std::vector<FormData>
- MultipartFormData::get_files(const std::string &key) const {
- std::vector<FormData> values;
- auto rng = files.equal_range(key);
- for (auto it = rng.first; it != rng.second; it++) {
- values.push_back(it->second);
- }
- return values;
- }
- inline bool MultipartFormData::has_file(const std::string &key) const {
- return files.find(key) != files.end();
- }
- inline size_t MultipartFormData::get_file_count(const std::string &key) const {
- return files.count(key);
- }
- // Multipart FormData writer implementation
- inline bool is_valid_multipart_boundary(const std::string &boundary) {
- return detail::is_multipart_boundary_chars_valid(boundary);
- }
- inline MultipartFormDataWriter::MultipartFormDataWriter()
- : boundary_(detail::make_multipart_data_boundary()) {}
- inline MultipartFormDataWriter::MultipartFormDataWriter(std::string boundary)
- : boundary_(std::move(boundary)) {}
- inline const std::string &MultipartFormDataWriter::boundary() const {
- return boundary_;
- }
- inline std::string MultipartFormDataWriter::content_type() const {
- return detail::serialize_multipart_formdata_get_content_type(boundary_);
- }
- inline std::string
- MultipartFormDataWriter::serialize(const UploadFormDataItems &items) const {
- return detail::serialize_multipart_formdata(items, boundary_);
- }
- inline size_t MultipartFormDataWriter::content_length(
- const UploadFormDataItems &items) const {
- return detail::get_multipart_content_length(items, boundary_);
- }
- inline std::string
- MultipartFormDataWriter::item_begin(const UploadFormData &item) const {
- return detail::serialize_multipart_formdata_item_begin(item, boundary_);
- }
- inline std::string MultipartFormDataWriter::item_end() {
- return detail::serialize_multipart_formdata_item_end();
- }
- inline std::string MultipartFormDataWriter::finish() const {
- return detail::serialize_multipart_formdata_finish(boundary_);
- }
- // Response implementation
- inline size_t Response::get_header_value_u64(const std::string &key, size_t def,
- size_t id) const {
- return detail::get_header_value_u64(headers, key, def, id);
- }
- inline bool Response::has_header(const std::string &key) const {
- return headers.find(key) != headers.end();
- }
- inline std::string Response::get_header_value(const std::string &key,
- const char *def,
- size_t id) const {
- return detail::get_header_value(headers, key, def, id);
- }
- inline size_t Response::get_header_value_count(const std::string &key) const {
- return detail::get_header_value_count(headers, key);
- }
- inline void Response::set_header(const std::string &key,
- const std::string &val) {
- detail::set_header(headers, key, val);
- }
- inline bool Response::has_trailer(const std::string &key) const {
- return trailers.find(key) != trailers.end();
- }
- inline std::string Response::get_trailer_value(const std::string &key,
- size_t id) const {
- return detail::get_multimap_value(trailers, key, id);
- }
- inline size_t Response::get_trailer_value_count(const std::string &key) const {
- return trailers.count(key);
- }
- inline void Response::set_redirect(const std::string &url, int stat) {
- if (detail::fields::is_field_value(url)) {
- set_header("Location", url);
- if (300 <= stat && stat < 400) {
- this->status = stat;
- } else {
- this->status = StatusCode::Found_302;
- }
- }
- }
- inline void Response::set_content(const char *s, size_t n,
- const std::string &content_type) {
- body.assign(s, n);
- auto rng = headers.equal_range("Content-Type");
- headers.erase(rng.first, rng.second);
- set_header("Content-Type", content_type);
- }
- inline void Response::set_content(const std::string &s,
- const std::string &content_type) {
- set_content(s.data(), s.size(), content_type);
- }
- inline void Response::set_content(std::string &&s,
- const std::string &content_type) {
- body = std::move(s);
- auto rng = headers.equal_range("Content-Type");
- headers.erase(rng.first, rng.second);
- set_header("Content-Type", content_type);
- }
- inline void Response::set_content_provider(
- size_t in_length, const std::string &content_type, ContentProvider provider,
- ContentProviderResourceReleaser resource_releaser) {
- set_header("Content-Type", content_type);
- content_length_ = in_length;
- if (in_length > 0) { content_provider_ = std::move(provider); }
- content_provider_resource_releaser_ = std::move(resource_releaser);
- is_chunked_content_provider_ = false;
- }
- inline void Response::set_content_provider(
- const std::string &content_type, ContentProviderWithoutLength provider,
- ContentProviderResourceReleaser resource_releaser) {
- set_header("Content-Type", content_type);
- content_length_ = 0;
- content_provider_ = detail::ContentProviderAdapter(std::move(provider));
- content_provider_resource_releaser_ = std::move(resource_releaser);
- is_chunked_content_provider_ = false;
- }
- inline void Response::set_chunked_content_provider(
- const std::string &content_type, ContentProviderWithoutLength provider,
- ContentProviderResourceReleaser resource_releaser) {
- set_header("Content-Type", content_type);
- content_length_ = 0;
- content_provider_ = detail::ContentProviderAdapter(std::move(provider));
- content_provider_resource_releaser_ = std::move(resource_releaser);
- is_chunked_content_provider_ = true;
- }
- inline void Response::set_file_content(const std::string &path,
- const std::string &content_type) {
- file_content_path_ = path;
- file_content_content_type_ = content_type;
- }
- inline void Response::set_file_content(const std::string &path) {
- file_content_path_ = path;
- }
- // Result implementation
- inline size_t Result::get_request_header_value_u64(const std::string &key,
- size_t def,
- size_t id) const {
- return detail::get_header_value_u64(request_headers_, key, def, id);
- }
- inline bool Result::has_request_header(const std::string &key) const {
- return request_headers_.find(key) != request_headers_.end();
- }
- inline std::string Result::get_request_header_value(const std::string &key,
- const char *def,
- size_t id) const {
- return detail::get_header_value(request_headers_, key, def, id);
- }
- inline size_t
- Result::get_request_header_value_count(const std::string &key) const {
- return request_headers_.count(key);
- }
- // Stream implementation
- inline ssize_t Stream::write(const char *ptr) {
- return write(ptr, strlen(ptr));
- }
- inline ssize_t Stream::write(const std::string &s) {
- return write(s.data(), s.size());
- }
- // BodyReader implementation
- inline ssize_t detail::BodyReader::read(char *buf, size_t len) {
- if (!stream) {
- last_error = Error::Connection;
- return -1;
- }
- if (eof) { return 0; }
- if (!chunked) {
- // Content-Length based reading
- if (has_content_length && bytes_read >= content_length) {
- eof = true;
- return 0;
- }
- auto to_read = len;
- if (has_content_length) {
- auto remaining = content_length - bytes_read;
- to_read = (std::min)(len, remaining);
- }
- auto n = stream->read(buf, to_read);
- if (n < 0) {
- last_error = stream->get_error();
- if (last_error == Error::Success) { last_error = Error::Read; }
- eof = true;
- return n;
- }
- if (n == 0) {
- // Unexpected EOF before content_length
- last_error = stream->get_error();
- if (last_error == Error::Success) { last_error = Error::Read; }
- eof = true;
- return 0;
- }
- bytes_read += static_cast<size_t>(n);
- if (has_content_length && bytes_read >= content_length) { eof = true; }
- if (payload_max_length > 0 && bytes_read > payload_max_length) {
- last_error = Error::ExceedMaxPayloadSize;
- eof = true;
- return -1;
- }
- return n;
- }
- // Chunked transfer encoding: delegate to shared decoder instance.
- if (!chunked_decoder) { chunked_decoder.reset(new ChunkedDecoder(*stream)); }
- size_t chunk_offset = 0;
- size_t chunk_total = 0;
- auto n = chunked_decoder->read_payload(buf, len, chunk_offset, chunk_total);
- if (n < 0) {
- last_error = stream->get_error();
- if (last_error == Error::Success) { last_error = Error::Read; }
- eof = true;
- return n;
- }
- if (n == 0) {
- // Final chunk observed. Leave trailer parsing to the caller (StreamHandle).
- eof = true;
- return 0;
- }
- bytes_read += static_cast<size_t>(n);
- if (payload_max_length > 0 && bytes_read > payload_max_length) {
- last_error = Error::ExceedMaxPayloadSize;
- eof = true;
- return -1;
- }
- return n;
- }
- // ThreadPool implementation
- inline ThreadPool::ThreadPool(size_t n, size_t max_n, size_t mqr,
- time_t idle_timeout_sec)
- : base_thread_count_(n), max_queued_requests_(mqr),
- idle_timeout_sec_(idle_timeout_sec), idle_thread_count_(0),
- shutdown_(false) {
- #ifndef CPPHTTPLIB_NO_EXCEPTIONS
- if (max_n != 0 && max_n < n) {
- std::string msg = "max_threads must be >= base_threads";
- throw std::invalid_argument(msg);
- }
- #endif
- max_thread_count_ = max_n == 0 ? n : max_n;
- threads_.reserve(base_thread_count_);
- #ifndef CPPHTTPLIB_NO_EXCEPTIONS
- try {
- #endif
- for (size_t i = 0; i < base_thread_count_; i++) {
- threads_.emplace_back(std::thread([this]() { worker(false); }));
- }
- #ifndef CPPHTTPLIB_NO_EXCEPTIONS
- } catch (...) {
- // If thread creation fails partway (e.g., pthread_create returns EAGAIN),
- // signal the workers we already spawned to exit and join them so the
- // vector destructor does not see joinable threads (which would call
- // std::terminate). Then rethrow so the caller learns of the failure.
- {
- std::unique_lock<std::mutex> lock(mutex_);
- shutdown_ = true;
- }
- cond_.notify_all();
- for (auto &t : threads_) {
- if (t.joinable()) { t.join(); }
- }
- throw;
- }
- #endif
- }
- inline bool ThreadPool::enqueue(std::function<void()> fn) {
- {
- std::unique_lock<std::mutex> lock(mutex_);
- if (shutdown_) { return false; }
- if (max_queued_requests_ > 0 && jobs_.size() >= max_queued_requests_) {
- return false;
- }
- jobs_.push_back(std::move(fn));
- // Spawn a dynamic thread if no idle threads and under max
- if (idle_thread_count_ == 0 &&
- threads_.size() + dynamic_threads_.size() < max_thread_count_) {
- cleanup_finished_threads();
- dynamic_threads_.emplace_back(std::thread([this]() { worker(true); }));
- }
- }
- cond_.notify_one();
- return true;
- }
- inline void ThreadPool::shutdown() {
- {
- std::unique_lock<std::mutex> lock(mutex_);
- shutdown_ = true;
- }
- cond_.notify_all();
- for (auto &t : threads_) {
- if (t.joinable()) { t.join(); }
- }
- // Move dynamic_threads_ to a local list under the lock to avoid racing
- // with worker threads that call move_to_finished() concurrently.
- std::list<std::thread> remaining_dynamic;
- {
- std::unique_lock<std::mutex> lock(mutex_);
- remaining_dynamic = std::move(dynamic_threads_);
- }
- for (auto &t : remaining_dynamic) {
- if (t.joinable()) { t.join(); }
- }
- std::unique_lock<std::mutex> lock(mutex_);
- cleanup_finished_threads();
- }
- inline void ThreadPool::move_to_finished(std::thread::id id) {
- // Must be called with mutex_ held
- for (auto it = dynamic_threads_.begin(); it != dynamic_threads_.end(); ++it) {
- if (it->get_id() == id) {
- finished_threads_.push_back(std::move(*it));
- dynamic_threads_.erase(it);
- return;
- }
- }
- }
- inline void ThreadPool::cleanup_finished_threads() {
- // Must be called with mutex_ held
- for (auto &t : finished_threads_) {
- if (t.joinable()) { t.join(); }
- }
- finished_threads_.clear();
- }
- inline void ThreadPool::worker(bool is_dynamic) {
- for (;;) {
- std::function<void()> fn;
- {
- std::unique_lock<std::mutex> lock(mutex_);
- idle_thread_count_++;
- if (is_dynamic) {
- auto has_work =
- cond_.wait_for(lock, std::chrono::seconds(idle_timeout_sec_),
- [&] { return !jobs_.empty() || shutdown_; });
- if (!has_work) {
- // Timed out with no work - exit this dynamic thread
- idle_thread_count_--;
- move_to_finished(std::this_thread::get_id());
- break;
- }
- } else {
- cond_.wait(lock, [&] { return !jobs_.empty() || shutdown_; });
- }
- idle_thread_count_--;
- if (shutdown_ && jobs_.empty()) { break; }
- fn = std::move(jobs_.front());
- jobs_.pop_front();
- }
- assert(true == static_cast<bool>(fn));
- fn();
- }
- #if defined(CPPHTTPLIB_OPENSSL_SUPPORT) && !defined(OPENSSL_IS_BORINGSSL) && \
- !defined(LIBRESSL_VERSION_NUMBER)
- OPENSSL_thread_stop();
- #endif
- }
- /*
- * Group 1 (continued): detail namespace - Stream implementations
- */
- namespace detail {
- inline void calc_actual_timeout(time_t max_timeout_msec, time_t duration_msec,
- time_t timeout_sec, time_t timeout_usec,
- time_t &actual_timeout_sec,
- time_t &actual_timeout_usec) {
- auto timeout_msec = (timeout_sec * 1000) + (timeout_usec / 1000);
- auto actual_timeout_msec =
- (std::min)(max_timeout_msec - duration_msec, timeout_msec);
- if (actual_timeout_msec < 0) { actual_timeout_msec = 0; }
- actual_timeout_sec = actual_timeout_msec / 1000;
- actual_timeout_usec = (actual_timeout_msec % 1000) * 1000;
- }
- // Socket stream implementation
- inline SocketStream::SocketStream(
- socket_t sock, time_t read_timeout_sec, time_t read_timeout_usec,
- time_t write_timeout_sec, time_t write_timeout_usec,
- time_t max_timeout_msec,
- std::chrono::time_point<std::chrono::steady_clock> start_time)
- : sock_(sock), read_timeout_sec_(read_timeout_sec),
- read_timeout_usec_(read_timeout_usec),
- write_timeout_sec_(write_timeout_sec),
- write_timeout_usec_(write_timeout_usec),
- max_timeout_msec_(max_timeout_msec), start_time_(start_time),
- read_buff_(read_buff_size_, 0) {}
- inline SocketStream::~SocketStream() = default;
- inline bool SocketStream::is_readable() const {
- return read_buff_off_ < read_buff_content_size_;
- }
- inline bool SocketStream::wait_readable() const {
- if (max_timeout_msec_ <= 0) {
- return select_read(sock_, read_timeout_sec_, read_timeout_usec_) > 0;
- }
- time_t read_timeout_sec;
- time_t read_timeout_usec;
- calc_actual_timeout(max_timeout_msec_, duration(), read_timeout_sec_,
- read_timeout_usec_, read_timeout_sec, read_timeout_usec);
- return select_read(sock_, read_timeout_sec, read_timeout_usec) > 0;
- }
- inline bool SocketStream::wait_writable() const {
- return select_write(sock_, write_timeout_sec_, write_timeout_usec_) > 0;
- }
- inline bool SocketStream::ensure_readable() {
- if (readable_hint_) {
- readable_hint_ = false;
- return true;
- }
- return wait_readable();
- }
- inline const char *SocketStream::buffered_data(size_t &size) const {
- size = read_buff_content_size_ - read_buff_off_;
- return size ? read_buff_.data() + read_buff_off_ : nullptr;
- }
- inline void SocketStream::consume_buffered(size_t size) {
- assert(size <= read_buff_content_size_ - read_buff_off_);
- read_buff_off_ += size;
- }
- inline bool SocketStream::is_peer_alive() const {
- return detail::is_socket_alive(sock_);
- }
- inline ssize_t SocketStream::read(char *ptr, size_t size) {
- #ifdef _WIN32
- size =
- (std::min)(size, static_cast<size_t>((std::numeric_limits<int>::max)()));
- #else
- size = (std::min)(size,
- static_cast<size_t>((std::numeric_limits<ssize_t>::max)()));
- #endif
- if (read_buff_off_ < read_buff_content_size_) {
- auto remaining_size = read_buff_content_size_ - read_buff_off_;
- if (size <= remaining_size) {
- memcpy(ptr, read_buff_.data() + read_buff_off_, size);
- read_buff_off_ += size;
- return static_cast<ssize_t>(size);
- } else {
- memcpy(ptr, read_buff_.data() + read_buff_off_, remaining_size);
- read_buff_off_ += remaining_size;
- return static_cast<ssize_t>(remaining_size);
- }
- }
- if (!ensure_readable()) {
- error_ = Error::Timeout;
- return -1;
- }
- read_buff_off_ = 0;
- read_buff_content_size_ = 0;
- if (size < read_buff_size_) {
- auto n = read_socket(sock_, read_buff_.data(), read_buff_size_,
- CPPHTTPLIB_RECV_FLAGS);
- if (n <= 0) {
- if (n == 0) {
- error_ = Error::ConnectionClosed;
- } else {
- error_ = Error::Read;
- }
- return n;
- } else if (n <= static_cast<ssize_t>(size)) {
- memcpy(ptr, read_buff_.data(), static_cast<size_t>(n));
- return n;
- } else {
- memcpy(ptr, read_buff_.data(), size);
- read_buff_off_ = size;
- read_buff_content_size_ = static_cast<size_t>(n);
- return static_cast<ssize_t>(size);
- }
- } else {
- auto n = read_socket(sock_, ptr, size, CPPHTTPLIB_RECV_FLAGS);
- if (n <= 0) {
- if (n == 0) {
- error_ = Error::ConnectionClosed;
- } else {
- error_ = Error::Read;
- }
- }
- return n;
- }
- }
- inline ssize_t SocketStream::write(const char *ptr, size_t size) {
- if (!wait_writable()) { return -1; }
- #if defined(_WIN32) && !defined(_WIN64)
- size =
- (std::min)(size, static_cast<size_t>((std::numeric_limits<int>::max)()));
- #endif
- return send_socket(sock_, ptr, size, CPPHTTPLIB_SEND_FLAGS);
- }
- inline void SocketStream::get_remote_ip_and_port(std::string &ip,
- int &port) const {
- return detail::get_remote_ip_and_port(sock_, ip, port);
- }
- inline void SocketStream::get_local_ip_and_port(std::string &ip,
- int &port) const {
- return detail::get_local_ip_and_port(sock_, ip, port);
- }
- inline socket_t SocketStream::socket() const { return sock_; }
- inline time_t SocketStream::duration() const {
- return std::chrono::duration_cast<std::chrono::milliseconds>(
- std::chrono::steady_clock::now() - start_time_)
- .count();
- }
- inline void SocketStream::set_read_timeout(time_t sec, time_t usec) {
- read_timeout_sec_ = sec;
- read_timeout_usec_ = usec;
- }
- // Buffer stream implementation
- inline bool BufferStream::is_readable() const { return true; }
- inline bool BufferStream::wait_readable() const { return true; }
- inline bool BufferStream::wait_writable() const { return true; }
- inline ssize_t BufferStream::read(char *ptr, size_t size) {
- #if defined(_MSC_VER) && _MSC_VER < 1910
- auto len_read = buffer._Copy_s(ptr, size, size, position);
- #else
- auto len_read = buffer.copy(ptr, size, position);
- #endif
- position += static_cast<size_t>(len_read);
- return static_cast<ssize_t>(len_read);
- }
- inline ssize_t BufferStream::write(const char *ptr, size_t size) {
- buffer.append(ptr, size);
- return static_cast<ssize_t>(size);
- }
- inline void BufferStream::get_remote_ip_and_port(std::string & /*ip*/,
- int & /*port*/) const {}
- inline void BufferStream::get_local_ip_and_port(std::string & /*ip*/,
- int & /*port*/) const {}
- inline socket_t BufferStream::socket() const { return 0; }
- inline time_t BufferStream::duration() const { return 0; }
- inline const std::string &BufferStream::get_buffer() const { return buffer; }
- inline PathParamsMatcher::PathParamsMatcher(const std::string &pattern)
- : MatcherBase(pattern) {
- constexpr const char marker[] = "/:";
- // One past the last ending position of a path param substring
- std::size_t last_param_end = 0;
- #ifndef CPPHTTPLIB_NO_EXCEPTIONS
- // Needed to ensure that parameter names are unique during matcher
- // construction
- // If exceptions are disabled, only last duplicate path
- // parameter will be set
- std::unordered_set<std::string> param_name_set;
- #endif
- while (true) {
- const auto marker_pos = pattern.find(
- marker, last_param_end == 0 ? last_param_end : last_param_end - 1);
- if (marker_pos == std::string::npos) { break; }
- static_fragments_.push_back(
- pattern.substr(last_param_end, marker_pos - last_param_end + 1));
- const auto param_name_start = marker_pos + str_len(marker);
- auto sep_pos = pattern.find(separator, param_name_start);
- if (sep_pos == std::string::npos) { sep_pos = pattern.length(); }
- auto param_name =
- pattern.substr(param_name_start, sep_pos - param_name_start);
- #ifndef CPPHTTPLIB_NO_EXCEPTIONS
- if (param_name_set.find(param_name) != param_name_set.cend()) {
- std::string msg = "Encountered path parameter '" + param_name +
- "' multiple times in route pattern '" + pattern + "'.";
- throw std::invalid_argument(msg);
- }
- #endif
- param_names_.push_back(std::move(param_name));
- last_param_end = sep_pos + 1;
- }
- if (last_param_end < pattern.length()) {
- static_fragments_.push_back(pattern.substr(last_param_end));
- }
- }
- inline bool PathParamsMatcher::match(Request &request) const {
- request.matches = std::smatch();
- request.path_params.clear();
- request.path_params.reserve(param_names_.size());
- // One past the position at which the path matched the pattern last time
- std::size_t starting_pos = 0;
- for (size_t i = 0; i < static_fragments_.size(); ++i) {
- const auto &fragment = static_fragments_[i];
- if (starting_pos + fragment.length() > request.path.length()) {
- return false;
- }
- // Avoid unnecessary allocation by using strncmp instead of substr +
- // comparison
- if (std::strncmp(request.path.c_str() + starting_pos, fragment.c_str(),
- fragment.length()) != 0) {
- return false;
- }
- starting_pos += fragment.length();
- // Should only happen when we have a static fragment after a param
- // Example: '/users/:id/subscriptions'
- // The 'subscriptions' fragment here does not have a corresponding param
- if (i >= param_names_.size()) { continue; }
- auto sep_pos = request.path.find(separator, starting_pos);
- if (sep_pos == std::string::npos) { sep_pos = request.path.length(); }
- const auto ¶m_name = param_names_[i];
- request.path_params.emplace(
- param_name, request.path.substr(starting_pos, sep_pos - starting_pos));
- // Mark everything up to '/' as matched
- starting_pos = sep_pos + 1;
- }
- // Returns false if the path is longer than the pattern
- return starting_pos >= request.path.length();
- }
- inline bool RegexMatcher::match(Request &request) const {
- request.path_params.clear();
- return std::regex_match(request.path, request.matches, regex_);
- }
- // Enclose IPv6 address in brackets if needed
- inline std::string prepare_host_string(const std::string &host) {
- // Enclose IPv6 address in brackets (but not if already enclosed)
- if (host.find(':') == std::string::npos ||
- (!host.empty() && host[0] == '[')) {
- // IPv4, hostname, or already bracketed IPv6
- return host;
- } else {
- // IPv6 address without brackets
- return "[" + host + "]";
- }
- }
- inline std::string make_host_and_port_string(const std::string &host, int port,
- bool is_ssl) {
- auto result = prepare_host_string(host);
- // Append port if not default
- if ((!is_ssl && port == 80) || (is_ssl && port == 443)) {
- ; // do nothing
- } else {
- result += ":" + std::to_string(port);
- }
- return result;
- }
- // Create "host:port" string always including port number (for CONNECT method)
- inline std::string
- make_host_and_port_string_always_port(const std::string &host, int port) {
- return prepare_host_string(host) + ":" + std::to_string(port);
- }
- // Value for the Host header a client sends when the caller supplied none.
- // Only the value: callers decide where in their header list it goes.
- inline std::string make_default_host_header_value(const std::string &host,
- int port, bool is_ssl,
- int address_family) {
- if (address_family == AF_UNIX) { return "localhost"; }
- return make_host_and_port_string(host, port, is_ssl);
- }
- inline void add_default_user_agent_header(Request &req) {
- #ifndef CPPHTTPLIB_NO_DEFAULT_USER_AGENT
- if (!req.has_header("User-Agent")) {
- req.set_header("User-Agent",
- std::string("cpp-httplib/") + CPPHTTPLIB_VERSION);
- }
- #else
- (void)req;
- #endif
- }
- bool parse_no_proxy_entry(const std::string &token, NoProxyEntry &out);
- NormalizedTarget normalize_target(const std::string &host);
- bool ip_in_cidr(const IPBytes &ip, const IPBytes &net, int prefix_bits);
- bool host_matches_no_proxy(const NormalizedTarget &target,
- const std::vector<NoProxyEntry> &entries);
- inline bool ip_in_cidr(const IPBytes &ip, const IPBytes &net, int prefix_bits) {
- if (prefix_bits < 0 || prefix_bits > 128) { return false; }
- if (prefix_bits == 0) { return true; }
- int full_bytes = prefix_bits / 8;
- int rem_bits = prefix_bits % 8;
- if (full_bytes > 0 && std::memcmp(ip.data(), net.data(),
- static_cast<size_t>(full_bytes)) != 0) {
- return false;
- }
- if (rem_bits == 0) { return true; }
- auto i = static_cast<size_t>(full_bytes);
- auto mask = static_cast<uint8_t>(0xFFu << (8 - rem_bits));
- return (ip[i] & mask) == (net[i] & mask);
- }
- inline bool parse_no_proxy_entry(const std::string &token, NoProxyEntry &out) {
- if (token.empty()) { return false; }
- if (token == "*") {
- out.kind = NoProxyKind::Wildcard;
- return true;
- }
- auto slash = token.find('/');
- std::string addr_part =
- (slash == std::string::npos) ? token : token.substr(0, slash);
- std::string prefix_part =
- (slash == std::string::npos) ? std::string() : token.substr(slash + 1);
- // A bare slash or trailing-slash CIDR like "10.0.0.0/" is malformed;
- // don't silently treat it as a /32 (or /128).
- if (slash != std::string::npos && prefix_part.empty()) { return false; }
- // Accept the bracketed IPv6 form ("[::1]", "[fe80::]/10") as well as the
- // bare form. Brackets have no meaning for IPv4, so skip the IPv4 attempt
- // when brackets are present.
- bool bracketed = addr_part.size() >= 2 && addr_part.front() == '[' &&
- addr_part.back() == ']';
- if (bracketed) { addr_part = addr_part.substr(1, addr_part.size() - 2); }
- if (!bracketed) {
- struct in_addr v4;
- if (inet_pton(AF_INET, addr_part.c_str(), &v4) == 1) {
- int prefix = 32;
- if (!prefix_part.empty()) {
- auto r = from_chars(prefix_part.data(),
- prefix_part.data() + prefix_part.size(), prefix);
- if (r.ec != std::errc{} ||
- r.ptr != prefix_part.data() + prefix_part.size()) {
- return false;
- }
- if (prefix < 0 || prefix > 32) { return false; }
- }
- out.kind = NoProxyKind::IPv4Cidr;
- std::memcpy(out.net.data(), &v4, sizeof(v4));
- out.prefix_bits = prefix;
- return true;
- }
- }
- struct in6_addr v6;
- if (inet_pton(AF_INET6, addr_part.c_str(), &v6) == 1) {
- int prefix = 128;
- if (!prefix_part.empty()) {
- auto r = from_chars(prefix_part.data(),
- prefix_part.data() + prefix_part.size(), prefix);
- if (r.ec != std::errc{} ||
- r.ptr != prefix_part.data() + prefix_part.size()) {
- return false;
- }
- if (prefix < 0 || prefix > 128) { return false; }
- }
- out.kind = NoProxyKind::IPv6Cidr;
- std::memcpy(out.net.data(), &v6, sizeof(v6));
- out.prefix_bits = prefix;
- return true;
- }
- // Bracketed entries can only be IPv6. If the IPv6 parse above failed,
- // the entry is malformed — don't fall through to the hostname branch.
- if (bracketed) { return false; }
- // A '/' on a non-IP token means a CIDR prefix without an address. Reject.
- if (slash != std::string::npos) { return false; }
- // Port-specific entries (host:port) are not supported.
- if (token.find(':') != std::string::npos) { return false; }
- std::string hostname = case_ignore::to_lower(token);
- while (!hostname.empty() && hostname.front() == '.') {
- hostname.erase(hostname.begin());
- }
- while (!hostname.empty() && hostname.back() == '.') {
- hostname.pop_back();
- }
- if (hostname.empty()) { return false; }
- out.kind = NoProxyKind::HostnameSuffix;
- out.hostname_pattern = std::move(hostname);
- return true;
- }
- inline NormalizedTarget normalize_target(const std::string &host) {
- NormalizedTarget t;
- std::string h = host;
- if (h.size() >= 2 && h.front() == '[' && h.back() == ']') {
- h = h.substr(1, h.size() - 2);
- }
- // Strip a single trailing dot so "example.com." canonicalizes to
- // "example.com".
- if (!h.empty() && h.back() == '.') { h.pop_back(); }
- t.hostname = case_ignore::to_lower(h);
- if (!t.hostname.empty()) {
- struct in_addr v4;
- struct in6_addr v6;
- if (inet_pton(AF_INET, t.hostname.c_str(), &v4) == 1) {
- t.is_ipv4 = true;
- std::memcpy(t.ip.data(), &v4, sizeof(v4));
- } else if (inet_pton(AF_INET6, t.hostname.c_str(), &v6) == 1) {
- t.is_ipv6 = true;
- std::memcpy(t.ip.data(), &v6, sizeof(v6));
- }
- }
- return t;
- }
- inline bool host_matches_no_proxy(const NormalizedTarget &target,
- const std::vector<NoProxyEntry> &entries) {
- if (target.hostname.empty()) { return false; }
- for (const auto &e : entries) {
- switch (e.kind) {
- case NoProxyKind::Wildcard: return true;
- case NoProxyKind::IPv4Cidr:
- if (target.is_ipv4 && ip_in_cidr(target.ip, e.net, e.prefix_bits)) {
- return true;
- }
- break;
- case NoProxyKind::IPv6Cidr:
- if (target.is_ipv6 && ip_in_cidr(target.ip, e.net, e.prefix_bits)) {
- return true;
- }
- break;
- case NoProxyKind::HostnameSuffix:
- if (target.is_ipv4 || target.is_ipv6) { break; }
- if (target.hostname == e.hostname_pattern) { return true; }
- // Dot-boundary suffix match: prevents "evilexample.com" from matching
- // an entry of "example.com".
- if (target.hostname.size() > e.hostname_pattern.size() + 1) {
- auto offset = target.hostname.size() - e.hostname_pattern.size();
- if (target.hostname[offset - 1] == '.' &&
- target.hostname.compare(offset, e.hostname_pattern.size(),
- e.hostname_pattern) == 0) {
- return true;
- }
- }
- break;
- }
- }
- return false;
- }
- template <typename T>
- inline bool check_and_write_headers(Stream &strm, Headers &headers,
- T header_writer, Error &error) {
- for (const auto &h : headers) {
- if (!detail::fields::is_field_valid(h.first, h.second)) {
- error = Error::InvalidHeaders;
- return false;
- }
- }
- if (header_writer(strm, headers) <= 0) {
- error = Error::Write;
- return false;
- }
- return true;
- }
- } // namespace detail
- /*
- * Group 2 (continued): detail namespace - SSLSocketStream implementation
- */
- #ifdef CPPHTTPLIB_SSL_ENABLED
- namespace detail {
- // SSL socket stream implementation
- inline SSLSocketStream::SSLSocketStream(
- socket_t sock, tls::session_t session, time_t read_timeout_sec,
- time_t read_timeout_usec, time_t write_timeout_sec,
- time_t write_timeout_usec, time_t max_timeout_msec,
- std::chrono::time_point<std::chrono::steady_clock> start_time)
- : sock_(sock), session_(session), read_timeout_sec_(read_timeout_sec),
- read_timeout_usec_(read_timeout_usec),
- write_timeout_sec_(write_timeout_sec),
- write_timeout_usec_(write_timeout_usec),
- max_timeout_msec_(max_timeout_msec), start_time_(start_time) {
- #ifdef CPPHTTPLIB_OPENSSL_SUPPORT
- // Clear AUTO_RETRY for proper non-blocking I/O timeout handling
- // Note: create_session() also clears this, but SSLClient currently
- // uses ssl_new() which does not. Until full TLS API migration is complete,
- // we need to ensure AUTO_RETRY is cleared here regardless of how the
- // SSL session was created.
- SSL_clear_mode(static_cast<SSL *>(session), SSL_MODE_AUTO_RETRY);
- #endif
- }
- inline SSLSocketStream::~SSLSocketStream() = default;
- inline bool SSLSocketStream::is_readable() const {
- return tls::pending(session_) > 0;
- }
- inline bool SSLSocketStream::wait_readable() const {
- if (max_timeout_msec_ <= 0) {
- return select_read(sock_, read_timeout_sec_, read_timeout_usec_) > 0;
- }
- time_t read_timeout_sec;
- time_t read_timeout_usec;
- calc_actual_timeout(max_timeout_msec_, duration(), read_timeout_sec_,
- read_timeout_usec_, read_timeout_sec, read_timeout_usec);
- return select_read(sock_, read_timeout_sec, read_timeout_usec) > 0;
- }
- inline bool SSLSocketStream::wait_writable() const {
- return select_write(sock_, write_timeout_sec_, write_timeout_usec_) > 0 &&
- !tls::is_peer_closed(session_, sock_);
- }
- inline bool SSLSocketStream::ensure_readable() {
- if (readable_hint_) {
- readable_hint_ = false;
- return true;
- }
- return wait_readable();
- }
- inline bool SSLSocketStream::is_peer_alive() const {
- return !tls::is_peer_closed(session_, sock_);
- }
- inline ssize_t SSLSocketStream::read(char *ptr, size_t size) {
- if (tls::pending(session_) > 0) {
- tls::TlsError err;
- auto ret = tls::read(session_, ptr, size, err);
- if (ret == 0 || err.code == tls::ErrorCode::PeerClosed) {
- error_ = Error::ConnectionClosed;
- }
- return ret;
- } else if (ensure_readable()) {
- tls::TlsError err;
- auto ret = tls::read(session_, ptr, size, err);
- if (ret < 0) {
- auto n = 1000;
- #ifdef _WIN32
- while (--n >= 0 && (err.code == tls::ErrorCode::WantRead ||
- (err.code == tls::ErrorCode::SyscallError &&
- WSAGetLastError() == WSAETIMEDOUT))) {
- #else
- while (--n >= 0 && err.code == tls::ErrorCode::WantRead) {
- #endif
- if (tls::pending(session_) > 0) {
- return tls::read(session_, ptr, size, err);
- } else if (wait_readable()) {
- std::this_thread::sleep_for(std::chrono::microseconds{10});
- ret = tls::read(session_, ptr, size, err);
- if (ret >= 0) { return ret; }
- } else {
- break;
- }
- }
- assert(ret < 0);
- } else if (ret == 0 || err.code == tls::ErrorCode::PeerClosed) {
- error_ = Error::ConnectionClosed;
- }
- return ret;
- } else {
- error_ = Error::Timeout;
- return -1;
- }
- }
- inline ssize_t SSLSocketStream::write(const char *ptr, size_t size) {
- if (wait_writable()) {
- auto handle_size =
- std::min<size_t>(size, (std::numeric_limits<int>::max)());
- tls::TlsError err;
- auto ret = tls::write(session_, ptr, handle_size, err);
- if (ret < 0) {
- auto n = 1000;
- #ifdef _WIN32
- while (--n >= 0 && (err.code == tls::ErrorCode::WantWrite ||
- (err.code == tls::ErrorCode::SyscallError &&
- WSAGetLastError() == WSAETIMEDOUT))) {
- #else
- while (--n >= 0 && err.code == tls::ErrorCode::WantWrite) {
- #endif
- if (wait_writable()) {
- std::this_thread::sleep_for(std::chrono::microseconds{10});
- ret = tls::write(session_, ptr, handle_size, err);
- if (ret >= 0) { return ret; }
- } else {
- break;
- }
- }
- assert(ret < 0);
- }
- return ret;
- }
- return -1;
- }
- inline void SSLSocketStream::get_remote_ip_and_port(std::string &ip,
- int &port) const {
- detail::get_remote_ip_and_port(sock_, ip, port);
- }
- inline void SSLSocketStream::get_local_ip_and_port(std::string &ip,
- int &port) const {
- detail::get_local_ip_and_port(sock_, ip, port);
- }
- inline socket_t SSLSocketStream::socket() const { return sock_; }
- inline time_t SSLSocketStream::duration() const {
- return std::chrono::duration_cast<std::chrono::milliseconds>(
- std::chrono::steady_clock::now() - start_time_)
- .count();
- }
- inline void SSLSocketStream::set_read_timeout(time_t sec, time_t usec) {
- read_timeout_sec_ = sec;
- read_timeout_usec_ = usec;
- }
- } // namespace detail
- #endif // CPPHTTPLIB_SSL_ENABLED
- /*
- * Group 4: Server implementation
- */
- // HTTP server implementation
- inline Server::Server()
- : new_task_queue([] {
- return new ThreadPool(CPPHTTPLIB_THREAD_POOL_COUNT,
- CPPHTTPLIB_THREAD_POOL_MAX_COUNT);
- }) {
- #ifndef _WIN32
- signal(SIGPIPE, SIG_IGN);
- #endif
- }
- inline Server::~Server() = default;
- inline std::unique_ptr<detail::MatcherBase>
- Server::make_matcher(const std::string &pattern) {
- if (pattern.find("/:") != std::string::npos) {
- return detail::make_unique<detail::PathParamsMatcher>(pattern);
- } else {
- return detail::make_unique<detail::RegexMatcher>(pattern);
- }
- }
- inline Server &Server::Get(const std::string &pattern, Handler handler) {
- return add_handler(get_handlers_, pattern, std::move(handler));
- }
- inline Server &Server::Post(const std::string &pattern, Handler handler) {
- return add_handler(post_handlers_, pattern, std::move(handler));
- }
- inline Server &Server::Post(const std::string &pattern,
- HandlerWithContentReader handler) {
- return add_handler(post_handlers_for_content_reader_, pattern,
- std::move(handler));
- }
- inline Server &Server::Put(const std::string &pattern, Handler handler) {
- return add_handler(put_handlers_, pattern, std::move(handler));
- }
- inline Server &Server::Put(const std::string &pattern,
- HandlerWithContentReader handler) {
- return add_handler(put_handlers_for_content_reader_, pattern,
- std::move(handler));
- }
- inline Server &Server::Patch(const std::string &pattern, Handler handler) {
- return add_handler(patch_handlers_, pattern, std::move(handler));
- }
- inline Server &Server::Patch(const std::string &pattern,
- HandlerWithContentReader handler) {
- return add_handler(patch_handlers_for_content_reader_, pattern,
- std::move(handler));
- }
- inline Server &Server::Delete(const std::string &pattern, Handler handler) {
- return add_handler(delete_handlers_, pattern, std::move(handler));
- }
- inline Server &Server::Delete(const std::string &pattern,
- HandlerWithContentReader handler) {
- return add_handler(delete_handlers_for_content_reader_, pattern,
- std::move(handler));
- }
- inline Server &Server::Options(const std::string &pattern, Handler handler) {
- return add_handler(options_handlers_, pattern, std::move(handler));
- }
- inline Server &Server::WebSocket(const std::string &pattern,
- WebSocketHandler handler) {
- websocket_handlers_.push_back(
- {make_matcher(pattern), std::move(handler), nullptr});
- return *this;
- }
- inline Server &Server::WebSocket(const std::string &pattern,
- WebSocketHandler handler,
- SubProtocolSelector sub_protocol_selector) {
- websocket_handlers_.push_back({make_matcher(pattern), std::move(handler),
- std::move(sub_protocol_selector)});
- return *this;
- }
- inline bool Server::set_base_dir(const std::string &dir,
- const std::string &mount_point) {
- return set_mount_point(mount_point, dir);
- }
- inline bool Server::set_mount_point(const std::string &mount_point,
- const std::string &dir, Headers headers) {
- detail::FileStat stat(dir);
- if (stat.is_dir()) {
- std::string mnt = !mount_point.empty() ? mount_point : "/";
- if (!mnt.empty() && mnt[0] == '/') {
- std::string resolved_base;
- if (detail::canonicalize_path(dir.c_str(), resolved_base)) {
- #if defined(_WIN32)
- if (resolved_base.back() != '\\' && resolved_base.back() != '/') {
- resolved_base += '\\';
- }
- #else
- if (resolved_base.back() != '/') { resolved_base += '/'; }
- #endif
- }
- base_dirs_.push_back(
- {std::move(mnt), dir, std::move(resolved_base), std::move(headers)});
- return true;
- }
- }
- return false;
- }
- inline bool Server::remove_mount_point(const std::string &mount_point) {
- for (auto it = base_dirs_.begin(); it != base_dirs_.end(); ++it) {
- if (it->mount_point == mount_point) {
- base_dirs_.erase(it);
- return true;
- }
- }
- return false;
- }
- inline Server &
- Server::set_file_extension_and_mimetype_mapping(const std::string &ext,
- const std::string &mime) {
- file_extension_and_mimetype_map_[ext] = mime;
- return *this;
- }
- inline Server &Server::set_default_file_mimetype(const std::string &mime) {
- default_file_mimetype_ = mime;
- return *this;
- }
- inline Server &Server::set_file_request_handler(Handler handler) {
- file_request_handler_ = std::move(handler);
- return *this;
- }
- inline Server &Server::set_error_handler_core(HandlerWithResponse handler,
- std::true_type) {
- error_handler_ = std::move(handler);
- return *this;
- }
- inline Server &Server::set_error_handler_core(Handler handler,
- std::false_type) {
- error_handler_ = [handler](const Request &req, Response &res) {
- handler(req, res);
- return HandlerResponse::Handled;
- };
- return *this;
- }
- inline Server &Server::set_exception_handler(ExceptionHandler handler) {
- exception_handler_ = std::move(handler);
- return *this;
- }
- inline Server &Server::set_pre_routing_handler(HandlerWithResponse handler) {
- pre_routing_handler_ = std::move(handler);
- return *this;
- }
- inline Server &Server::set_post_routing_handler(Handler handler) {
- post_routing_handler_ = std::move(handler);
- return *this;
- }
- inline Server &Server::set_pre_request_handler(HandlerWithResponse handler) {
- pre_request_handler_ = std::move(handler);
- return *this;
- }
- inline Server &Server::set_logger(Logger logger) {
- logger_ = std::move(logger);
- return *this;
- }
- inline Server &Server::set_error_logger(ErrorLogger error_logger) {
- error_logger_ = std::move(error_logger);
- return *this;
- }
- inline Server &Server::set_pre_compression_logger(Logger logger) {
- pre_compression_logger_ = std::move(logger);
- return *this;
- }
- inline Server &
- Server::set_expect_100_continue_handler(Expect100ContinueHandler handler) {
- expect_100_continue_handler_ = std::move(handler);
- return *this;
- }
- inline Server &Server::set_start_handler(StartHandler handler) {
- start_handler_ = std::move(handler);
- return *this;
- }
- inline Server &Server::set_address_family(int family) {
- address_family_ = family;
- return *this;
- }
- inline Server &Server::set_tcp_nodelay(bool on) {
- tcp_nodelay_ = on;
- return *this;
- }
- inline Server &Server::set_ipv6_v6only(bool on) {
- ipv6_v6only_ = on;
- return *this;
- }
- inline Server &Server::set_socket_options(SocketOptions socket_options) {
- socket_options_ = std::move(socket_options);
- return *this;
- }
- inline Server &Server::set_default_headers(Headers headers) {
- default_headers_ = std::move(headers);
- return *this;
- }
- inline Server &Server::set_header_writer(
- std::function<ssize_t(Stream &, Headers &)> const &writer) {
- header_writer_ = writer;
- return *this;
- }
- inline Server &
- Server::set_trusted_proxies(const std::vector<std::string> &proxies) {
- trusted_proxies_ = proxies;
- return *this;
- }
- inline Server &Server::set_keep_alive_max_count(size_t count) {
- keep_alive_max_count_ = count;
- return *this;
- }
- inline Server &Server::set_keep_alive_timeout(time_t sec) {
- keep_alive_timeout_sec_ = sec;
- return *this;
- }
- template <class Rep, class Period>
- inline Server &Server::set_keep_alive_timeout(
- const std::chrono::duration<Rep, Period> &duration) {
- detail::duration_to_sec_and_usec(duration, [&](time_t sec, time_t /*usec*/) {
- set_keep_alive_timeout(sec);
- });
- return *this;
- }
- inline Server &Server::set_read_timeout(time_t sec, time_t usec) {
- read_timeout_sec_ = sec;
- read_timeout_usec_ = usec;
- return *this;
- }
- inline Server &Server::set_write_timeout(time_t sec, time_t usec) {
- write_timeout_sec_ = sec;
- write_timeout_usec_ = usec;
- return *this;
- }
- inline Server &Server::set_idle_interval(time_t sec, time_t usec) {
- idle_interval_sec_ = sec;
- idle_interval_usec_ = usec;
- return *this;
- }
- inline Server &Server::set_payload_max_length(size_t length) {
- payload_max_length_ = length;
- return *this;
- }
- inline Server &Server::set_websocket_max_missed_pongs(int count) {
- websocket_max_missed_pongs_ = count;
- return *this;
- }
- inline Server &Server::set_websocket_ping_interval(time_t sec) {
- websocket_ping_interval_sec_ = sec;
- return *this;
- }
- template <class Rep, class Period>
- inline Server &Server::set_websocket_ping_interval(
- const std::chrono::duration<Rep, Period> &duration) {
- detail::duration_to_sec_and_usec(duration, [&](time_t sec, time_t /*usec*/) {
- set_websocket_ping_interval(sec);
- });
- return *this;
- }
- inline bool Server::bind_to_port(const std::string &host, int port,
- int socket_flags) {
- auto ret = bind_internal(host, port, socket_flags);
- if (ret == -1) { is_decommissioned = true; }
- return ret >= 0;
- }
- inline int Server::bind_to_any_port(const std::string &host, int socket_flags) {
- auto ret = bind_internal(host, 0, socket_flags);
- if (ret == -1) { is_decommissioned = true; }
- return ret;
- }
- inline bool Server::listen_after_bind() { return listen_internal(); }
- inline bool Server::listen(const std::string &host, int port,
- int socket_flags) {
- return bind_to_port(host, port, socket_flags) && listen_internal();
- }
- inline bool Server::is_running() const { return is_running_; }
- inline void Server::wait_until_ready() const {
- while (!is_running_ && !is_decommissioned) {
- std::this_thread::sleep_for(std::chrono::milliseconds{1});
- }
- }
- inline void Server::stop() noexcept {
- // Release the listening socket whether or not the accept loop is running:
- // bind_to_port() without listen_after_bind() still owns the descriptor. The
- // exchange is what makes this safe to call concurrently with the accept loop.
- socket_t sock = svr_sock_.exchange(INVALID_SOCKET);
- if (sock != INVALID_SOCKET) {
- detail::shutdown_socket(sock);
- detail::close_socket(sock);
- }
- is_decommissioned = false;
- }
- inline void Server::decommission() { is_decommissioned = true; }
- inline bool Server::parse_request_line(const char *s, Request &req) const {
- auto len = strlen(s);
- if (len < 2 || s[len - 2] != '\r' || s[len - 1] != '\n') { return false; }
- len -= 2;
- {
- size_t count = 0;
- detail::split(s, s + len, ' ', [&](const char *b, const char *e) {
- switch (count) {
- case 0: req.method = std::string(b, e); break;
- case 1: req.target = std::string(b, e); break;
- case 2: req.version = std::string(b, e); break;
- default: break;
- }
- count++;
- });
- if (count != 3) { return false; }
- }
- thread_local const std::set<std::string> methods{
- "GET", "HEAD", "POST", "PUT", "DELETE",
- "CONNECT", "OPTIONS", "TRACE", "PATCH", "PRI"};
- if (methods.find(req.method) == methods.end()) {
- output_error_log(Error::InvalidHTTPMethod, &req);
- return false;
- }
- if (req.version != "HTTP/1.1" && req.version != "HTTP/1.0") {
- output_error_log(Error::InvalidHTTPVersion, &req);
- return false;
- }
- {
- // Skip URL fragment
- for (size_t i = 0; i < req.target.size(); i++) {
- if (req.target[i] == '#') {
- req.target.erase(i);
- break;
- }
- }
- detail::divide(req.target, '?',
- [&](const char *lhs_data, std::size_t lhs_size,
- const char *rhs_data, std::size_t rhs_size) {
- req.path =
- decode_path_component(std::string(lhs_data, lhs_size));
- detail::parse_query_text(rhs_data, rhs_size, req.params);
- });
- }
- return true;
- }
- inline bool Server::write_response(Stream &strm, bool close_connection,
- Request &req, Response &res) {
- // NOTE: `req.ranges` should be empty, otherwise it will be applied
- // incorrectly to the error content.
- req.ranges.clear();
- return write_response_core(strm, close_connection, req, res, false);
- }
- inline bool Server::write_response_with_content(Stream &strm,
- bool close_connection,
- const Request &req,
- Response &res) {
- return write_response_core(strm, close_connection, req, res, true);
- }
- inline bool Server::write_response_core(Stream &strm, bool close_connection,
- const Request &req, Response &res,
- bool need_apply_ranges) {
- assert(res.status != -1);
- if (400 <= res.status && error_handler_ &&
- error_handler_(req, res) == HandlerResponse::Handled) {
- need_apply_ranges = true;
- }
- std::string content_type;
- std::string boundary;
- if (need_apply_ranges) { apply_ranges(req, res, content_type, boundary); }
- // Prepare additional headers
- if (close_connection || req.get_header_value("Connection") == "close" ||
- 400 <= res.status) { // Don't leave connections open after errors
- res.set_header("Connection", "close");
- } else {
- std::string s = "timeout=";
- s += std::to_string(keep_alive_timeout_sec_);
- s += ", max=";
- s += std::to_string(keep_alive_max_count_);
- res.set_header("Keep-Alive", s);
- }
- if ((!res.body.empty() || res.content_length_ > 0 || res.content_provider_) &&
- !res.has_header("Content-Type")) {
- res.set_header("Content-Type", "text/plain");
- }
- if (res.body.empty() && !res.content_length_ && !res.content_provider_ &&
- !res.has_header("Content-Length")) {
- res.set_header("Content-Length", "0");
- }
- if (req.method == "HEAD" && !res.has_header("Accept-Ranges")) {
- res.set_header("Accept-Ranges", "bytes");
- }
- if (post_routing_handler_) { post_routing_handler_(req, res); }
- // Response line and headers
- detail::BufferStream bstrm;
- if (!detail::write_response_line(bstrm, res.status)) { return false; }
- if (header_writer_(bstrm, res.headers) <= 0) { return false; }
- // Combine small body with headers to reduce write syscalls
- if (req.method != "HEAD" && !res.body.empty() && !res.content_provider_) {
- bstrm.write(res.body.data(), res.body.size());
- }
- // Log before writing to avoid race condition with client-side code that
- // accesses logger-captured data immediately after receiving the response.
- output_log(req, res);
- // Flush buffer
- auto &data = bstrm.get_buffer();
- if (!detail::write_data(strm, data.data(), data.size())) { return false; }
- // Streaming body
- auto ret = true;
- if (req.method != "HEAD" && res.content_provider_) {
- if (write_content_with_provider(strm, req, res, boundary, content_type)) {
- res.content_provider_success_ = true;
- } else {
- ret = false;
- }
- }
- return ret;
- }
- inline bool
- Server::write_content_with_provider(Stream &strm, const Request &req,
- Response &res, const std::string &boundary,
- const std::string &content_type) {
- auto is_shutting_down = [this]() {
- return this->svr_sock_ == INVALID_SOCKET;
- };
- if (res.content_length_ > 0) {
- // Only a 206 response is served as a partial representation, matching the
- // condition `apply_ranges()` used to decide the Content-Length and the
- // multipart boundary. Since `detail::range_error()` validates `req.ranges`
- // only for a 2xx status, slicing under any other status would write a body
- // that disagrees with the header already sent, from an unchecked offset.
- auto is_partial =
- !req.ranges.empty() && res.status == StatusCode::PartialContent_206;
- if (!is_partial) {
- return detail::write_content(strm, res.content_provider_, 0,
- res.content_length_, is_shutting_down);
- } else if (req.ranges.size() == 1) {
- auto offset_and_length = detail::get_range_offset_and_length(
- req.ranges[0], res.content_length_);
- return detail::write_content(strm, res.content_provider_,
- offset_and_length.first,
- offset_and_length.second, is_shutting_down);
- } else {
- return detail::write_multipart_ranges_data(
- strm, req, res, boundary, content_type, res.content_length_,
- is_shutting_down);
- }
- } else {
- if (res.is_chunked_content_provider_) {
- auto type = detail::encoding_type(req, res);
- auto compressor = detail::make_compressor(type);
- if (!compressor) {
- compressor = detail::make_unique<detail::nocompressor>();
- }
- return detail::write_content_chunked(strm, res.content_provider_,
- is_shutting_down, *compressor);
- } else {
- return detail::write_content_without_length(strm, res.content_provider_,
- is_shutting_down);
- }
- }
- }
- inline bool Server::read_content(Stream &strm, Request &req, Response &res) {
- FormFields::iterator cur_field;
- FormFiles::iterator cur_file;
- auto is_text_field = false;
- size_t count = 0;
- if (read_content_core(
- strm, req, res,
- // Regular
- [&](const char *buf, size_t n) {
- // Prevent arithmetic overflow when checking sizes.
- // Avoid computing (req.body.size() + n) directly because
- // adding two unsigned `size_t` values can wrap around and
- // produce a small result instead of indicating overflow.
- // Instead, check using subtraction: ensure `n` does not
- // exceed the remaining capacity `max_size() - size()`.
- if (req.body.size() >= req.body.max_size() ||
- n > req.body.max_size() - req.body.size()) {
- return false;
- }
- // Limit decompressed body size to payload_max_length_ to protect
- // against "zip bomb" attacks where a small compressed payload
- // decompresses to a massive size.
- if (payload_max_length_ > 0 &&
- (req.body.size() >= payload_max_length_ ||
- n > payload_max_length_ - req.body.size())) {
- return false;
- }
- req.body.append(buf, n);
- return true;
- },
- // Multipart FormData
- [&](const FormData &file) {
- if (count++ == CPPHTTPLIB_MULTIPART_FORM_DATA_FILE_MAX_COUNT) {
- output_error_log(Error::TooManyFormDataFiles, &req);
- return false;
- }
- if (file.filename.empty()) {
- cur_field = req.form.fields.emplace(
- file.name, FormField{file.name, file.content, file.headers});
- is_text_field = true;
- } else {
- cur_file = req.form.files.emplace(file.name, file);
- is_text_field = false;
- }
- return true;
- },
- [&](const char *buf, size_t n) {
- if (is_text_field) {
- auto &content = cur_field->second.content;
- if (content.size() + n > content.max_size()) { return false; }
- content.append(buf, n);
- } else {
- auto &content = cur_file->second.content;
- if (content.size() + n > content.max_size()) { return false; }
- content.append(buf, n);
- }
- return true;
- })) {
- const auto &content_type = req.get_header_value("Content-Type");
- if (detail::extract_media_type(content_type) ==
- "application/x-www-form-urlencoded") {
- if (req.body.size() > CPPHTTPLIB_FORM_URL_ENCODED_PAYLOAD_MAX_LENGTH) {
- res.status = StatusCode::PayloadTooLarge_413; // NOTE: should be 414?
- output_error_log(Error::ExceedMaxPayloadSize, &req);
- return false;
- }
- detail::parse_query_text(req.body, req.params);
- }
- return true;
- }
- return false;
- }
- inline bool Server::read_content_with_content_receiver(
- Stream &strm, Request &req, Response &res, ContentReceiver receiver,
- FormDataHeader multipart_header, ContentReceiver multipart_receiver) {
- return read_content_core(strm, req, res, std::move(receiver),
- std::move(multipart_header),
- std::move(multipart_receiver));
- }
- inline bool Server::read_content_core(
- Stream &strm, Request &req, Response &res, ContentReceiver receiver,
- FormDataHeader multipart_header, ContentReceiver multipart_receiver) const {
- detail::FormDataParser multipart_form_data_parser;
- ContentReceiverWithProgress out;
- if (req.is_multipart_form_data()) {
- const auto &content_type = req.get_header_value("Content-Type");
- std::string boundary;
- if (!detail::parse_multipart_boundary(content_type, boundary)) {
- res.status = StatusCode::BadRequest_400;
- output_error_log(Error::MultipartParsing, &req);
- return false;
- }
- multipart_form_data_parser.set_boundary(std::move(boundary));
- out = [&](const char *buf, size_t n, size_t /*off*/, size_t /*len*/) {
- return multipart_form_data_parser.parse(buf, n, multipart_header,
- multipart_receiver);
- };
- } else {
- out = [receiver](const char *buf, size_t n, size_t /*off*/,
- size_t /*len*/) { return receiver(buf, n); };
- }
- // RFC 9112 §6: no Transfer-Encoding and no Content-Length means no body.
- // For non-SSL builds we still scan non-persistent connections for stray
- // body bytes so the payload limit is enforced (413). On keep-alive,
- // pending bytes may be the next request (issue #2450), so skip.
- #if !defined(CPPHTTPLIB_SSL_ENABLED)
- if (!req.has_header("Content-Length") &&
- !detail::is_chunked_transfer_encoding(req.headers)) {
- if (!detail::is_connection_persistent(req) && payload_max_length_ > 0 &&
- payload_max_length_ < (std::numeric_limits<size_t>::max)()) {
- auto has_data = strm.is_readable();
- if (!has_data) {
- auto s = strm.socket();
- if (s != INVALID_SOCKET) {
- has_data = detail::select_read(s, 0, 0) > 0;
- }
- }
- if (has_data) {
- auto result =
- detail::read_content_without_length(strm, payload_max_length_, out);
- if (result == detail::ReadContentResult::PayloadTooLarge) {
- res.status = StatusCode::PayloadTooLarge_413;
- return false;
- } else if (result != detail::ReadContentResult::Success) {
- return false;
- }
- return true;
- }
- }
- return true;
- }
- #else
- if (!req.has_header("Content-Length") &&
- !detail::is_chunked_transfer_encoding(req.headers)) {
- return true;
- }
- #endif
- if (!detail::read_content(strm, req, payload_max_length_, res.status, nullptr,
- out, true)) {
- return false;
- }
- req.body_consumed_ = true;
- if (req.is_multipart_form_data()) {
- if (!multipart_form_data_parser.is_valid()) {
- res.status = StatusCode::BadRequest_400;
- output_error_log(Error::MultipartParsing, &req);
- return false;
- }
- }
- return true;
- }
- inline bool Server::handle_file_request(Request &req, Response &res) {
- for (const auto &entry : base_dirs_) {
- // Prefix match, on a path segment boundary. A mount point of "/mount"
- // covers "/mount" and "/mount/...", but must not swallow "/mountdir/...".
- // One that already ends in '/' (the root mount among them) carries its own
- // boundary; set_mount_point() guarantees the mount point is not empty.
- if (!req.path.compare(0, entry.mount_point.size(), entry.mount_point) &&
- (entry.mount_point.back() == '/' ||
- req.path.size() == entry.mount_point.size() ||
- req.path[entry.mount_point.size()] == '/')) {
- std::string sub_path = "/" + req.path.substr(entry.mount_point.size());
- if (detail::is_valid_path(sub_path)) {
- auto path = entry.base_dir + sub_path;
- if (path.back() == '/') { path += "index.html"; }
- // Defense-in-depth: is_valid_path blocks ".." traversal in the URL,
- // but symlinks/junctions can still escape the base directory.
- if (!entry.resolved_base_dir.empty()) {
- std::string resolved_path;
- if (detail::canonicalize_path(path.c_str(), resolved_path) &&
- !detail::is_path_within_base(resolved_path,
- entry.resolved_base_dir)) {
- res.status = StatusCode::Forbidden_403;
- return true;
- }
- }
- detail::FileStat stat(path);
- if (stat.is_dir()) {
- res.set_redirect(sub_path + "/", StatusCode::MovedPermanently_301);
- return true;
- }
- if (stat.is_file()) {
- for (const auto &kv : entry.headers) {
- res.set_header(kv.first, kv.second);
- }
- auto etag = detail::compute_etag(stat);
- if (!etag.empty()) { res.set_header("ETag", etag); }
- auto mtime = stat.mtime();
- auto last_modified = detail::file_mtime_to_http_date(mtime);
- if (!last_modified.empty()) {
- res.set_header("Last-Modified", last_modified);
- }
- if (check_if_not_modified(req, res, etag, mtime)) { return true; }
- check_if_range(req, etag, mtime);
- auto mm = std::make_shared<detail::mmap>(path.c_str());
- if (!mm->is_open()) {
- output_error_log(Error::OpenFile, &req);
- return false;
- }
- res.set_content_provider(
- mm->size(),
- detail::find_content_type(path, file_extension_and_mimetype_map_,
- default_file_mimetype_),
- [mm](size_t offset, size_t length, DataSink &sink) -> bool {
- sink.write(mm->data() + offset, length);
- return true;
- });
- if (req.method != "HEAD" && file_request_handler_) {
- file_request_handler_(req, res);
- }
- return true;
- } else {
- output_error_log(Error::OpenFile, &req);
- }
- }
- }
- }
- return false;
- }
- inline bool Server::check_if_not_modified(const Request &req, Response &res,
- const std::string &etag,
- time_t mtime) const {
- // Handle conditional GET:
- // 1. If-None-Match takes precedence (RFC 9110 Section 13.1.2)
- // 2. If-Modified-Since is checked only when If-None-Match is absent
- if (req.has_header("If-None-Match")) {
- if (!etag.empty()) {
- auto val = req.get_header_value("If-None-Match");
- // NOTE: We use exact string matching here. This works correctly
- // because our server always generates weak ETags (W/"..."), and
- // clients typically send back the same ETag they received.
- // RFC 9110 Section 8.8.3.2 allows weak comparison for
- // If-None-Match, where W/"x" and "x" would match, but this
- // simplified implementation requires exact matches.
- auto ret = detail::split_find(val.data(), val.data() + val.size(), ',',
- [&](const char *b, const char *e) {
- auto seg_len = static_cast<size_t>(e - b);
- return (seg_len == 1 && *b == '*') ||
- (seg_len == etag.size() &&
- std::equal(b, e, etag.begin()));
- });
- if (ret) {
- res.status = StatusCode::NotModified_304;
- return true;
- }
- }
- } else if (req.has_header("If-Modified-Since")) {
- auto val = req.get_header_value("If-Modified-Since");
- auto t = detail::parse_http_date(val);
- if (t != static_cast<time_t>(-1) && mtime <= t) {
- res.status = StatusCode::NotModified_304;
- return true;
- }
- }
- return false;
- }
- inline bool Server::check_if_range(Request &req, const std::string &etag,
- time_t mtime) const {
- // Handle If-Range for partial content requests (RFC 9110
- // Section 13.1.5). If-Range is only evaluated when Range header is
- // present. If the validator matches, serve partial content; otherwise
- // serve full content.
- if (!req.ranges.empty() && req.has_header("If-Range")) {
- auto val = req.get_header_value("If-Range");
- auto is_valid_range = [&]() {
- if (detail::is_strong_etag(val)) {
- // RFC 9110 Section 13.1.5: If-Range requires strong ETag
- // comparison.
- return (!etag.empty() && val == etag);
- } else if (detail::is_weak_etag(val)) {
- // Weak ETags are not valid for If-Range (RFC 9110 Section 13.1.5)
- return false;
- } else {
- // HTTP-date comparison
- auto t = detail::parse_http_date(val);
- return (t != static_cast<time_t>(-1) && mtime <= t);
- }
- };
- if (!is_valid_range()) {
- // Validator doesn't match: ignore Range and serve full content
- req.ranges.clear();
- return false;
- }
- }
- return true;
- }
- inline socket_t
- Server::create_server_socket(const std::string &host, int port,
- int socket_flags,
- SocketOptions socket_options) const {
- return detail::create_socket(
- host, std::string(), port, address_family_, socket_flags, tcp_nodelay_,
- ipv6_v6only_, std::move(socket_options),
- [&](socket_t sock, struct addrinfo &ai, bool & /*quit*/) -> bool {
- if (::bind(sock, ai.ai_addr, static_cast<socklen_t>(ai.ai_addrlen))) {
- output_error_log(Error::BindIPAddress, nullptr);
- return false;
- }
- if (::listen(sock, CPPHTTPLIB_LISTEN_BACKLOG)) {
- output_error_log(Error::Listen, nullptr);
- return false;
- }
- return true;
- });
- }
- inline int Server::bind_internal(const std::string &host, int port,
- int socket_flags) {
- if (is_decommissioned) { return -1; }
- if (!is_valid()) { return -1; }
- svr_sock_ = create_server_socket(host, port, socket_flags, socket_options_);
- if (svr_sock_ == INVALID_SOCKET) { return -1; }
- if (port == 0) {
- struct sockaddr_storage addr;
- socklen_t addr_len = sizeof(addr);
- if (getsockname(svr_sock_, reinterpret_cast<struct sockaddr *>(&addr),
- &addr_len) == -1) {
- output_error_log(Error::GetSockName, nullptr);
- return -1;
- }
- if (addr.ss_family == AF_INET) {
- return ntohs(reinterpret_cast<struct sockaddr_in *>(&addr)->sin_port);
- } else if (addr.ss_family == AF_INET6) {
- return ntohs(reinterpret_cast<struct sockaddr_in6 *>(&addr)->sin6_port);
- } else {
- output_error_log(Error::UnsupportedAddressFamily, nullptr);
- return -1;
- }
- } else {
- return port;
- }
- }
- inline bool Server::listen_internal() {
- // A stop() between bind and listen leaves nothing to accept on. Report
- // failure instead of returning success without ever serving, and mark the
- // server decommissioned the way any failed listen does so that a concurrent
- // wait_until_ready() wakes up instead of spinning forever.
- if (is_decommissioned || svr_sock_ == INVALID_SOCKET) {
- is_decommissioned = true;
- return false;
- }
- auto ret = true;
- is_running_ = true;
- auto se = detail::scope_exit([&]() { is_running_ = false; });
- if (start_handler_) { start_handler_(); }
- {
- std::unique_ptr<TaskQueue> task_queue(new_task_queue());
- while (svr_sock_ != INVALID_SOCKET) {
- #ifndef _WIN32
- if (idle_interval_sec_ > 0 || idle_interval_usec_ > 0) {
- #endif
- auto val = detail::select_read(svr_sock_, idle_interval_sec_,
- idle_interval_usec_);
- if (val == 0) { // Timeout
- task_queue->on_idle();
- continue;
- }
- #ifndef _WIN32
- }
- #endif
- #if defined _WIN32
- // sockets connected via WASAccept inherit flags NO_HANDLE_INHERIT,
- // OVERLAPPED
- socket_t sock = WSAAccept(svr_sock_, nullptr, nullptr, nullptr, 0);
- #elif defined SOCK_CLOEXEC
- socket_t sock = accept4(svr_sock_, nullptr, nullptr, SOCK_CLOEXEC);
- #else
- socket_t sock = accept(svr_sock_, nullptr, nullptr);
- #endif
- if (sock == INVALID_SOCKET) {
- if (errno == EMFILE) {
- // The per-process limit of open file descriptors has been reached.
- // Try to accept new connections after a short sleep.
- std::this_thread::sleep_for(std::chrono::microseconds{1});
- continue;
- } else if (errno == EINTR || errno == EAGAIN) {
- continue;
- }
- if (svr_sock_ != INVALID_SOCKET) {
- detail::close_socket(svr_sock_);
- ret = false;
- output_error_log(Error::Connection, nullptr);
- } else {
- ; // The server socket was closed by user.
- }
- break;
- }
- detail::set_socket_opt_time(sock, SOL_SOCKET, SO_RCVTIMEO,
- read_timeout_sec_, read_timeout_usec_);
- detail::set_socket_opt_time(sock, SOL_SOCKET, SO_SNDTIMEO,
- write_timeout_sec_, write_timeout_usec_);
- if (tcp_nodelay_) { set_socket_opt(sock, IPPROTO_TCP, TCP_NODELAY, 1); }
- if (!task_queue->enqueue(
- [this, sock]() { process_and_close_socket(sock); })) {
- output_error_log(Error::ResourceExhaustion, nullptr);
- detail::shutdown_socket(sock);
- detail::close_socket(sock);
- }
- }
- task_queue->shutdown();
- }
- is_decommissioned = !ret;
- return ret;
- }
- inline bool Server::routing(Request &req, Response &res, Stream &strm) {
- if (pre_routing_handler_ &&
- pre_routing_handler_(req, res) == HandlerResponse::Handled) {
- return true;
- }
- // File handler
- if ((req.method == "GET" || req.method == "HEAD") &&
- handle_file_request(req, res)) {
- return true;
- }
- if (detail::expect_content(req)) {
- // Content reader handler
- {
- // Track whether the ContentReader was aborted due to the decompressed
- // payload exceeding `payload_max_length_`.
- // The user handler runs after the lambda returns, so we must restore the
- // 413 status if the handler overwrites it.
- bool content_reader_payload_too_large = false;
- ContentReader reader(
- [&](ContentReceiver receiver) {
- auto result = read_content_with_content_receiver(
- strm, req, res, std::move(receiver), nullptr, nullptr);
- if (!result) {
- output_error_log(Error::Read, &req);
- if (res.status == StatusCode::PayloadTooLarge_413) {
- content_reader_payload_too_large = true;
- }
- }
- return result;
- },
- [&](FormDataHeader header, ContentReceiver receiver) {
- auto result = read_content_with_content_receiver(
- strm, req, res, nullptr, std::move(header),
- std::move(receiver));
- if (!result) {
- output_error_log(Error::Read, &req);
- if (res.status == StatusCode::PayloadTooLarge_413) {
- content_reader_payload_too_large = true;
- }
- }
- return result;
- });
- bool dispatched = false;
- if (req.method == "POST") {
- dispatched = dispatch_request_for_content_reader(
- req, res, std::move(reader), post_handlers_for_content_reader_);
- } else if (req.method == "PUT") {
- dispatched = dispatch_request_for_content_reader(
- req, res, std::move(reader), put_handlers_for_content_reader_);
- } else if (req.method == "PATCH") {
- dispatched = dispatch_request_for_content_reader(
- req, res, std::move(reader), patch_handlers_for_content_reader_);
- } else if (req.method == "DELETE") {
- dispatched = dispatch_request_for_content_reader(
- req, res, std::move(reader), delete_handlers_for_content_reader_);
- }
- if (dispatched) {
- if (content_reader_payload_too_large) {
- // Enforce the limit: override any status the handler may have set
- // and return false so the error path sends a plain 413 response.
- res.status = StatusCode::PayloadTooLarge_413;
- res.body.clear();
- res.content_length_ = 0;
- res.content_provider_ = nullptr;
- return false;
- }
- return true;
- }
- }
- // NOTE: `req.body` is not read here. For a regular handler the body is
- // read inside dispatch_request(), after the route has matched and the
- // pre-request handler has approved the request, so that a rejected
- // request (e.g. failed authentication) never forces us to buffer a
- // potentially large body.
- }
- // Regular handler
- if (req.method == "GET" || req.method == "HEAD") {
- return dispatch_request(req, res, get_handlers_, strm);
- } else if (req.method == "POST") {
- return dispatch_request(req, res, post_handlers_, strm);
- } else if (req.method == "PUT") {
- return dispatch_request(req, res, put_handlers_, strm);
- } else if (req.method == "DELETE") {
- return dispatch_request(req, res, delete_handlers_, strm);
- } else if (req.method == "OPTIONS") {
- return dispatch_request(req, res, options_handlers_, strm);
- } else if (req.method == "PATCH") {
- return dispatch_request(req, res, patch_handlers_, strm);
- }
- res.status = StatusCode::BadRequest_400;
- return false;
- }
- inline bool Server::dispatch_request(Request &req, Response &res,
- const Handlers &handlers, Stream &strm) {
- for (const auto &x : handlers) {
- const auto &matcher = x.first;
- const auto &handler = x.second;
- if (matcher->match(req)) {
- req.matched_route = matcher->pattern();
- // Run the pre-request handler before reading the body so a rejected
- // request (e.g. failed authentication) never forces us to buffer a
- // potentially large body. `req.matched_route` is available here.
- if (pre_request_handler_ &&
- pre_request_handler_(req, res) == HandlerResponse::Handled) {
- return true;
- }
- // The route matched and the request was approved; read the body now.
- if (detail::expect_content(req) && !read_content(strm, req, res)) {
- output_error_log(Error::Read, &req);
- return false;
- }
- handler(req, res);
- return true;
- }
- }
- return false;
- }
- inline void Server::apply_ranges(const Request &req, Response &res,
- std::string &content_type,
- std::string &boundary) const {
- if (req.ranges.size() > 1 && res.status == StatusCode::PartialContent_206) {
- auto it = res.headers.find("Content-Type");
- if (it != res.headers.end()) {
- content_type = it->second;
- res.headers.erase(it);
- }
- boundary = detail::make_multipart_data_boundary();
- res.set_header("Content-Type",
- "multipart/byteranges; boundary=" + boundary);
- }
- auto type = detail::encoding_type(req, res);
- if (res.body.empty()) {
- if (res.content_length_ > 0) {
- size_t length = 0;
- if (req.ranges.empty() || res.status != StatusCode::PartialContent_206) {
- length = res.content_length_;
- } else if (req.ranges.size() == 1) {
- auto offset_and_length = detail::get_range_offset_and_length(
- req.ranges[0], res.content_length_);
- length = offset_and_length.second;
- auto content_range = detail::make_content_range_header_field(
- offset_and_length, res.content_length_);
- res.set_header("Content-Range", content_range);
- } else {
- length = detail::get_multipart_ranges_data_length(
- req, boundary, content_type, res.content_length_);
- }
- res.set_header("Content-Length", std::to_string(length));
- } else {
- if (res.content_provider_) {
- if (res.is_chunked_content_provider_) {
- res.set_header("Transfer-Encoding", "chunked");
- if (type != detail::EncodingType::None) {
- res.set_header("Content-Encoding", detail::encoding_name(type));
- res.set_header("Vary", "Accept-Encoding");
- }
- }
- }
- }
- } else {
- if (req.ranges.empty() || res.status != StatusCode::PartialContent_206) {
- ;
- } else if (req.ranges.size() == 1) {
- auto offset_and_length =
- detail::get_range_offset_and_length(req.ranges[0], res.body.size());
- auto offset = offset_and_length.first;
- auto length = offset_and_length.second;
- auto content_range = detail::make_content_range_header_field(
- offset_and_length, res.body.size());
- res.set_header("Content-Range", content_range);
- assert(offset + length <= res.body.size());
- res.body = res.body.substr(offset, length);
- } else {
- std::string data;
- detail::make_multipart_ranges_data(req, res, boundary, content_type,
- res.body.size(), data);
- res.body.swap(data);
- }
- if (type != detail::EncodingType::None) {
- output_pre_compression_log(req, res);
- if (auto compressor = detail::make_compressor(type)) {
- std::string compressed;
- if (compressor->compress(res.body.data(), res.body.size(), true,
- [&](const char *data, size_t data_len) {
- compressed.append(data, data_len);
- return true;
- })) {
- res.body.swap(compressed);
- res.set_header("Content-Encoding", detail::encoding_name(type));
- res.set_header("Vary", "Accept-Encoding");
- }
- }
- }
- res.content_length_ = res.body.size();
- res.set_header("Content-Length", std::to_string(res.content_length_));
- }
- }
- inline bool Server::dispatch_request_for_content_reader(
- Request &req, Response &res, ContentReader content_reader,
- const HandlersForContentReader &handlers) const {
- for (const auto &x : handlers) {
- const auto &matcher = x.first;
- const auto &handler = x.second;
- if (matcher->match(req)) {
- req.matched_route = matcher->pattern();
- if (!pre_request_handler_ ||
- pre_request_handler_(req, res) != HandlerResponse::Handled) {
- handler(req, res, content_reader);
- }
- return true;
- }
- }
- return false;
- }
- inline std::string
- get_client_ip(const std::string &x_forwarded_for,
- const std::vector<std::string> &trusted_proxies) {
- // X-Forwarded-For is a comma-separated list per RFC 7239
- std::vector<std::string> ip_list;
- detail::split(x_forwarded_for.data(),
- x_forwarded_for.data() + x_forwarded_for.size(), ',',
- [&](const char *b, const char *e) {
- auto r = detail::trim(b, e, 0, static_cast<size_t>(e - b));
- ip_list.emplace_back(std::string(b + r.first, b + r.second));
- });
- // A malformed X-Forwarded-For (empty, comma-only, whitespace-only) yields
- // no segments. Signal "no client IP derived" with an empty string so the
- // caller can fall back to the connection-level remote address.
- if (ip_list.empty()) { return std::string(); }
- // Each hop appends the address it received the request from, so the rightmost
- // entries are the ones written by our own infrastructure while the leftmost
- // are whatever the original client chose to send. Walk from the right and
- // skip trusted proxies; the first address that is not a trusted proxy is the
- // furthest point still attributable to a real hop, i.e. the client. Scanning
- // from the left instead lets a client forge an arbitrary address by following
- // it with a trusted proxy's address, which the left-to-right scan then
- // returned as the client.
- for (size_t i = ip_list.size(); i-- > 0;) {
- const auto &ip = ip_list[i];
- auto is_trusted_proxy =
- std::any_of(trusted_proxies.begin(), trusted_proxies.end(),
- [&](const std::string &proxy) { return ip == proxy; });
- if (!is_trusted_proxy) { return ip; }
- }
- // Every hop was a trusted proxy; fall back to the first entry.
- return ip_list.front();
- }
- inline bool
- Server::process_request(Stream &strm, const std::string &remote_addr,
- int remote_port, const std::string &local_addr,
- int local_port, bool close_connection,
- bool &connection_closed,
- const std::function<void(Request &)> &setup_request,
- bool *websocket_upgraded) {
- std::array<char, 2048> buf{};
- detail::stream_line_reader line_reader(strm, buf.data(), buf.size());
- // Connection has been closed on client
- if (!line_reader.getline()) { return false; }
- Request req;
- req.start_time_ = std::chrono::steady_clock::now();
- req.remote_addr = remote_addr;
- req.remote_port = remote_port;
- req.local_addr = local_addr;
- req.local_port = local_port;
- Response res;
- res.version = "HTTP/1.1";
- res.headers = default_headers_;
- // Request line and headers
- if (!parse_request_line(line_reader.ptr(), req)) {
- res.status = StatusCode::BadRequest_400;
- output_error_log(Error::InvalidRequestLine, &req);
- return write_response(strm, close_connection, req, res);
- }
- // Request headers
- if (!detail::read_headers(strm, req.headers)) {
- res.status = StatusCode::BadRequest_400;
- output_error_log(Error::InvalidHeaders, &req);
- return write_response(strm, close_connection, req, res);
- }
- // RFC 9112 §6.3: Reject requests whose framing is ambiguous, which would
- // otherwise let an intermediary and this parser disagree on where the body
- // ends and enable request smuggling. Two cases: a non-zero Content-Length
- // alongside any Transfer-Encoding (Content-Length: 0 is tolerated for
- // compatibility with existing clients), and a Transfer-Encoding whose final
- // coding is not chunked, which leaves the body length undeterminable. The
- // latter must not fall through to the "no body" path, or the body bytes are
- // parsed as the next request on a persistent connection.
- if (req.has_header("Transfer-Encoding") &&
- (req.get_header_value_u64("Content-Length") > 0 ||
- !detail::is_chunked_transfer_encoding(req.headers))) {
- connection_closed = true;
- res.status = StatusCode::BadRequest_400;
- return write_response(strm, close_connection, req, res);
- }
- // Check if the request URI doesn't exceed the limit
- if (req.target.size() > CPPHTTPLIB_REQUEST_URI_MAX_LENGTH) {
- connection_closed = true;
- res.status = StatusCode::UriTooLong_414;
- output_error_log(Error::ExceedUriMaxLength, &req);
- return write_response(strm, close_connection, req, res);
- }
- if (req.get_header_value("Connection") == "close") {
- connection_closed = true;
- }
- if (req.version == "HTTP/1.0" &&
- req.get_header_value("Connection") != "Keep-Alive") {
- connection_closed = true;
- }
- // Only honor X-Forwarded-For if the peer on the actual TCP connection is
- // itself a trusted proxy. Otherwise any direct client could spoof
- // remote_addr simply by sending an arbitrary X-Forwarded-For header.
- auto is_trusted_peer = std::any_of(
- trusted_proxies_.begin(), trusted_proxies_.end(),
- [&](const std::string &proxy) { return proxy == remote_addr; });
- if (is_trusted_peer && req.has_header("X-Forwarded-For")) {
- auto x_forwarded_for = req.get_header_value("X-Forwarded-For");
- auto derived = get_client_ip(x_forwarded_for, trusted_proxies_);
- req.remote_addr = derived.empty() ? remote_addr : derived;
- } else {
- req.remote_addr = remote_addr;
- }
- req.remote_port = remote_port;
- req.local_addr = local_addr;
- req.local_port = local_port;
- if (req.has_header("Accept")) {
- const auto &accept_header = req.get_header_value("Accept");
- if (!detail::parse_accept_header(accept_header, req.accept_content_types)) {
- connection_closed = true;
- res.status = StatusCode::BadRequest_400;
- output_error_log(Error::HTTPParsing, &req);
- return write_response(strm, close_connection, req, res);
- }
- }
- if (req.has_header("Range")) {
- const auto &range_header_value = req.get_header_value("Range");
- if (!detail::parse_range_header(range_header_value, req.ranges)) {
- connection_closed = true;
- res.status = StatusCode::RangeNotSatisfiable_416;
- output_error_log(Error::InvalidRangeHeader, &req);
- return write_response(strm, close_connection, req, res);
- }
- }
- if (setup_request) { setup_request(req); }
- if (req.get_header_value("Expect") == "100-continue") {
- int status = StatusCode::Continue_100;
- if (expect_100_continue_handler_) {
- status = expect_100_continue_handler_(req, res);
- }
- switch (status) {
- case StatusCode::Continue_100:
- case StatusCode::ExpectationFailed_417:
- detail::write_response_line(strm, status);
- strm.write("\r\n");
- break;
- default:
- connection_closed = true;
- return write_response(strm, true, req, res);
- }
- }
- // Setup `is_connection_closed` method
- auto sock = strm.socket();
- req.is_connection_closed = [sock]() {
- return !detail::is_socket_alive(sock);
- };
- // WebSocket upgrade
- // Check pre_routing_handler_ before upgrading so that authentication
- // and other middleware can reject the request with an HTTP response
- // (e.g., 401) before the protocol switches.
- if (detail::is_websocket_upgrade(req)) {
- if (pre_routing_handler_ &&
- pre_routing_handler_(req, res) == HandlerResponse::Handled) {
- if (res.status == -1) { res.status = StatusCode::OK_200; }
- return write_response(strm, close_connection, req, res);
- }
- // Find matching WebSocket handler
- for (const auto &entry : websocket_handlers_) {
- if (entry.matcher->match(req)) {
- // Compute accept key
- auto client_key = req.get_header_value("Sec-WebSocket-Key");
- auto accept_key = detail::websocket_accept_key(client_key);
- // Negotiate subprotocol
- std::string selected_subprotocol;
- if (entry.sub_protocol_selector) {
- auto protocol_header = req.get_header_value("Sec-WebSocket-Protocol");
- if (!protocol_header.empty()) {
- std::vector<std::string> protocols;
- std::istringstream iss(protocol_header);
- std::string token;
- while (std::getline(iss, token, ',')) {
- // Trim whitespace
- auto start = token.find_first_not_of(' ');
- auto end = token.find_last_not_of(' ');
- if (start != std::string::npos) {
- protocols.push_back(token.substr(start, end - start + 1));
- }
- }
- selected_subprotocol = entry.sub_protocol_selector(protocols);
- }
- }
- // Send 101 Switching Protocols
- std::string handshake_response = "HTTP/1.1 101 Switching Protocols\r\n"
- "Upgrade: websocket\r\n"
- "Connection: Upgrade\r\n"
- "Sec-WebSocket-Accept: " +
- accept_key + "\r\n";
- if (!selected_subprotocol.empty()) {
- if (!detail::fields::is_field_value(selected_subprotocol)) {
- return false;
- }
- handshake_response +=
- "Sec-WebSocket-Protocol: " + selected_subprotocol + "\r\n";
- }
- handshake_response += "\r\n";
- if (strm.write(handshake_response.data(), handshake_response.size()) <
- 0) {
- return false;
- }
- connection_closed = true;
- if (websocket_upgraded) { *websocket_upgraded = true; }
- {
- // Use WebSocket-specific read timeout instead of HTTP timeout
- strm.set_read_timeout(CPPHTTPLIB_WEBSOCKET_READ_TIMEOUT_SECOND, 0);
- ws::WebSocket ws(strm, req, true, websocket_ping_interval_sec_,
- websocket_max_missed_pongs_);
- entry.handler(req, ws);
- }
- return true;
- }
- }
- // No matching handler - fall through to 404
- }
- // Routing
- auto routed = false;
- #ifdef CPPHTTPLIB_NO_EXCEPTIONS
- routed = routing(req, res, strm);
- #else
- try {
- routed = routing(req, res, strm);
- } catch (std::exception &) {
- if (exception_handler_) {
- auto ep = std::current_exception();
- exception_handler_(req, res, ep);
- routed = true;
- } else {
- res.status = StatusCode::InternalServerError_500;
- }
- } catch (...) {
- if (exception_handler_) {
- auto ep = std::current_exception();
- exception_handler_(req, res, ep);
- routed = true;
- } else {
- res.status = StatusCode::InternalServerError_500;
- }
- }
- #endif
- auto ret = false;
- if (routed) {
- if (res.status == -1) {
- res.status = req.ranges.empty() ? StatusCode::OK_200
- : StatusCode::PartialContent_206;
- }
- // Serve file content by using a content provider
- auto file_open_error = false;
- if (!res.file_content_path_.empty()) {
- const auto &path = res.file_content_path_;
- auto mm = std::make_shared<detail::mmap>(path.c_str());
- if (!mm->is_open()) {
- res.body.clear();
- res.content_length_ = 0;
- res.content_provider_ = nullptr;
- res.status = StatusCode::NotFound_404;
- output_error_log(Error::OpenFile, &req);
- file_open_error = true;
- } else {
- auto content_type = res.file_content_content_type_;
- if (content_type.empty()) {
- content_type = detail::find_content_type(
- path, file_extension_and_mimetype_map_, default_file_mimetype_);
- }
- res.set_content_provider(
- mm->size(), content_type,
- [mm](size_t offset, size_t length, DataSink &sink) -> bool {
- sink.write(mm->data() + offset, length);
- return true;
- });
- }
- }
- if (file_open_error) {
- ret = write_response(strm, close_connection, req, res);
- } else if (detail::range_error(req, res)) {
- res.body.clear();
- res.content_length_ = 0;
- res.content_provider_ = nullptr;
- res.status = StatusCode::RangeNotSatisfiable_416;
- ret = write_response(strm, close_connection, req, res);
- } else {
- ret = write_response_with_content(strm, close_connection, req, res);
- }
- } else {
- if (res.status == -1) { res.status = StatusCode::NotFound_404; }
- ret = write_response(strm, close_connection, req, res);
- }
- // Drain any unconsumed framed body to prevent request smuggling on
- // keep-alive. Without framing there is no body to drain — reading would
- // consume the next request (issue #2450). If the response has committed the
- // connection to close, there is no next request to protect.
- if (!req.body_consumed_ && detail::has_framed_body(req)) {
- if (res.get_header_value("Connection") == "close") {
- connection_closed = true;
- } else {
- int dummy_status;
- if (!detail::read_content(
- strm, req, payload_max_length_, dummy_status, nullptr,
- [](const char *, size_t, size_t, size_t) { return true; },
- false)) {
- connection_closed = true;
- }
- }
- }
- return ret;
- }
- inline bool Server::is_valid() const { return true; }
- inline bool Server::process_and_close_socket(socket_t sock) {
- std::string remote_addr;
- int remote_port = 0;
- detail::get_remote_ip_and_port(sock, remote_addr, remote_port);
- std::string local_addr;
- int local_port = 0;
- detail::get_local_ip_and_port(sock, local_addr, local_port);
- bool websocket_upgraded = false;
- auto ret = detail::process_server_socket(
- svr_sock_, sock, keep_alive_max_count_, keep_alive_timeout_sec_,
- read_timeout_sec_, read_timeout_usec_, write_timeout_sec_,
- write_timeout_usec_,
- [&](Stream &strm, bool close_connection, bool &connection_closed) {
- return process_request(strm, remote_addr, remote_port, local_addr,
- local_port, close_connection, connection_closed,
- nullptr, &websocket_upgraded);
- });
- detail::shutdown_socket(sock);
- detail::close_socket(sock);
- return ret;
- }
- inline void Server::output_log(const Request &req, const Response &res) const {
- if (logger_) {
- std::lock_guard<std::mutex> guard(logger_mutex_);
- logger_(req, res);
- }
- }
- inline void Server::output_pre_compression_log(const Request &req,
- const Response &res) const {
- if (pre_compression_logger_) {
- std::lock_guard<std::mutex> guard(logger_mutex_);
- pre_compression_logger_(req, res);
- }
- }
- inline void Server::output_error_log(const Error &err,
- const Request *req) const {
- if (error_logger_) {
- std::lock_guard<std::mutex> guard(logger_mutex_);
- error_logger_(err, req);
- }
- }
- /*
- * Group 5: ClientImpl and Client (Universal) implementation
- */
- // HTTP client implementation
- inline ClientImpl::ClientImpl(const std::string &host)
- : ClientImpl(host, 80, std::string(), std::string()) {}
- inline ClientImpl::ClientImpl(const std::string &host, int port)
- : ClientImpl(host, port, std::string(), std::string()) {}
- inline ClientImpl::ClientImpl(const std::string &host, int port,
- const std::string &client_cert_path,
- const std::string &client_key_path)
- : host_(detail::escape_abstract_namespace_unix_domain(host)), port_(port),
- client_cert_path_(client_cert_path), client_key_path_(client_key_path) {}
- inline ClientImpl::~ClientImpl() {
- // Wait until all the requests in flight are handled.
- size_t retry_count = 10;
- while (retry_count-- > 0) {
- {
- std::lock_guard<std::mutex> guard(socket_mutex_);
- if (socket_requests_in_flight_ == 0) { break; }
- }
- std::this_thread::sleep_for(std::chrono::milliseconds{1});
- }
- std::lock_guard<std::mutex> guard(socket_mutex_);
- shutdown_socket(socket_);
- close_socket(socket_);
- }
- inline bool ClientImpl::is_valid() const { return true; }
- inline void ClientImpl::copy_settings(const ClientImpl &rhs) {
- client_cert_path_ = rhs.client_cert_path_;
- client_key_path_ = rhs.client_key_path_;
- connection_timeout_sec_ = rhs.connection_timeout_sec_;
- read_timeout_sec_ = rhs.read_timeout_sec_;
- read_timeout_usec_ = rhs.read_timeout_usec_;
- write_timeout_sec_ = rhs.write_timeout_sec_;
- write_timeout_usec_ = rhs.write_timeout_usec_;
- max_timeout_msec_ = rhs.max_timeout_msec_;
- basic_auth_username_ = rhs.basic_auth_username_;
- basic_auth_password_ = rhs.basic_auth_password_;
- bearer_token_auth_token_ = rhs.bearer_token_auth_token_;
- keep_alive_ = rhs.keep_alive_;
- follow_location_ = rhs.follow_location_;
- path_encode_ = rhs.path_encode_;
- address_family_ = rhs.address_family_;
- tcp_nodelay_ = rhs.tcp_nodelay_;
- ipv6_v6only_ = rhs.ipv6_v6only_;
- socket_options_ = rhs.socket_options_;
- compress_ = rhs.compress_;
- decompress_ = rhs.decompress_;
- payload_max_length_ = rhs.payload_max_length_;
- has_payload_max_length_ = rhs.has_payload_max_length_;
- interface_ = rhs.interface_;
- proxy_host_ = rhs.proxy_host_;
- proxy_port_ = rhs.proxy_port_;
- proxy_basic_auth_username_ = rhs.proxy_basic_auth_username_;
- proxy_basic_auth_password_ = rhs.proxy_basic_auth_password_;
- proxy_bearer_token_auth_token_ = rhs.proxy_bearer_token_auth_token_;
- no_proxy_entries_ = rhs.no_proxy_entries_;
- logger_ = rhs.logger_;
- error_logger_ = rhs.error_logger_;
- #ifdef CPPHTTPLIB_SSL_ENABLED
- digest_auth_username_ = rhs.digest_auth_username_;
- digest_auth_password_ = rhs.digest_auth_password_;
- proxy_digest_auth_username_ = rhs.proxy_digest_auth_username_;
- proxy_digest_auth_password_ = rhs.proxy_digest_auth_password_;
- ca_cert_file_path_ = rhs.ca_cert_file_path_;
- ca_cert_dir_path_ = rhs.ca_cert_dir_path_;
- server_certificate_verification_ = rhs.server_certificate_verification_;
- server_hostname_verification_ = rhs.server_hostname_verification_;
- system_ca_mode_ = rhs.system_ca_mode_;
- #endif
- }
- inline bool
- ClientImpl::is_proxy_enabled_for_host(const std::string &host) const {
- if (proxy_host_.empty() || proxy_port_ == -1) { return false; }
- if (no_proxy_entries_.empty()) { return true; }
- // host_ is const so its normalized form is invariant; cache it. The
- // cross-host path (setup_redirect_client passing next_host) re-normalizes.
- if (host == host_) {
- if (!host_normalized_valid_) {
- host_normalized_ = detail::normalize_target(host_);
- host_normalized_valid_ = true;
- }
- return !detail::host_matches_no_proxy(host_normalized_, no_proxy_entries_);
- }
- auto target = detail::normalize_target(host);
- return !detail::host_matches_no_proxy(target, no_proxy_entries_);
- }
- inline socket_t ClientImpl::create_client_socket(Error &error) const {
- if (is_proxy_enabled_for_host(host_)) {
- return detail::create_client_socket(
- proxy_host_, std::string(), proxy_port_, address_family_, tcp_nodelay_,
- ipv6_v6only_, socket_options_, connection_timeout_sec_,
- connection_timeout_usec_, read_timeout_sec_, read_timeout_usec_,
- write_timeout_sec_, write_timeout_usec_, interface_, error);
- }
- // Check is custom IP or hostname specified for host_
- std::string connect_host;
- std::string ip;
- detail::apply_addr_map(addr_map_, host_, connect_host, ip);
- return detail::create_client_socket(
- connect_host, ip, port_, address_family_, tcp_nodelay_, ipv6_v6only_,
- socket_options_, connection_timeout_sec_, connection_timeout_usec_,
- read_timeout_sec_, read_timeout_usec_, write_timeout_sec_,
- write_timeout_usec_, interface_, error);
- }
- inline bool ClientImpl::create_and_connect_socket(Socket &socket,
- Error &error) {
- auto sock = create_client_socket(error);
- if (sock == INVALID_SOCKET) { return false; }
- socket.sock = sock;
- return true;
- }
- inline bool ClientImpl::ensure_socket_connection(Socket &socket, Error &error) {
- return create_and_connect_socket(socket, error);
- }
- inline bool ClientImpl::setup_proxy_connection(
- Socket & /*socket*/,
- std::chrono::time_point<std::chrono::steady_clock> /*start_time*/,
- Response & /*res*/, bool & /*success*/, Error & /*error*/) {
- return true;
- }
- inline void ClientImpl::shutdown_ssl(Socket & /*socket*/,
- bool /*shutdown_gracefully*/) {
- // If there are any requests in flight from threads other than us, then it's
- // a thread-unsafe race because individual ssl* objects are not thread-safe.
- assert(socket_requests_in_flight_ == 0 ||
- socket_requests_are_from_thread_ == std::this_thread::get_id());
- }
- inline void ClientImpl::shutdown_socket(Socket &socket) const {
- if (socket.sock == INVALID_SOCKET) { return; }
- detail::shutdown_socket(socket.sock);
- }
- inline void ClientImpl::close_socket(Socket &socket) {
- // If there are requests in flight in another thread, usually closing
- // the socket will be fine and they will simply receive an error when
- // using the closed socket, but it is still a bug since rarely the OS
- // may reassign the socket id to be used for a new socket, and then
- // suddenly they will be operating on a live socket that is different
- // than the one they intended!
- assert(socket_requests_in_flight_ == 0 ||
- socket_requests_are_from_thread_ == std::this_thread::get_id());
- // It is also a bug if this happens while SSL is still active
- #ifdef CPPHTTPLIB_SSL_ENABLED
- assert(socket.ssl == nullptr);
- #endif
- if (socket.sock == INVALID_SOCKET) { return; }
- detail::close_socket(socket.sock);
- socket.sock = INVALID_SOCKET;
- }
- inline void ClientImpl::disconnect(bool gracefully) {
- shutdown_ssl(socket_, gracefully);
- shutdown_socket(socket_);
- close_socket(socket_);
- }
- inline bool ClientImpl::read_response_line(Stream &strm, const Request &req,
- Response &res,
- bool skip_100_continue) const {
- std::array<char, 2048> buf{};
- detail::stream_line_reader line_reader(strm, buf.data(), buf.size());
- if (!line_reader.getline()) { return false; }
- if (!detail::parse_status_line(line_reader.ptr(), res.version, res.status,
- res.reason)) {
- return req.method == "CONNECT";
- }
- // Ignore '100 Continue' (only when not using Expect: 100-continue explicitly)
- while (skip_100_continue && res.status == StatusCode::Continue_100) {
- if (!line_reader.getline()) { return false; } // CRLF
- if (!line_reader.getline()) { return false; } // next response line
- if (!detail::parse_status_line(line_reader.ptr(), res.version, res.status,
- res.reason)) {
- return false;
- }
- }
- return true;
- }
- inline bool ClientImpl::send(Request &req, Response &res, Error &error) {
- std::lock_guard<std::recursive_mutex> request_mutex_guard(request_mutex_);
- auto ret = send_(req, res, error);
- if (error == Error::SSLPeerCouldBeClosed_) {
- assert(!ret);
- ret = send_(req, res, error);
- // If still failing with SSLPeerCouldBeClosed_, convert to Read error
- if (error == Error::SSLPeerCouldBeClosed_) { error = Error::Read; }
- }
- return ret;
- }
- inline bool ClientImpl::send_(Request &req, Response &res, Error &error) {
- {
- std::lock_guard<std::mutex> guard(socket_mutex_);
- // Set this to false immediately - if it ever gets set to true by the end
- // of the request, we know another thread instructed us to close the
- // socket.
- socket_should_be_closed_when_request_is_done_ = false;
- auto is_alive = false;
- if (socket_.is_open()) {
- is_alive = detail::is_socket_alive(socket_.sock);
- #ifdef CPPHTTPLIB_SSL_ENABLED
- if (is_alive && is_ssl()) {
- if (tls::is_peer_closed(socket_.ssl, socket_.sock)) {
- is_alive = false;
- }
- }
- #endif
- if (!is_alive) {
- // Peer seems gone — non-graceful shutdown to avoid SIGPIPE.
- disconnect(/*gracefully=*/false);
- }
- }
- if (!is_alive) {
- if (!ensure_socket_connection(socket_, error)) {
- output_error_log(error, &req);
- return false;
- }
- {
- auto success = true;
- if (!setup_proxy_connection(socket_, req.start_time_, res, success,
- error)) {
- if (!success) { output_error_log(error, &req); }
- return success;
- }
- }
- }
- // Mark the current socket as being in use so that it cannot be closed by
- // anyone else while this request is ongoing, even though we will be
- // releasing the mutex.
- if (socket_requests_in_flight_ > 1) {
- assert(socket_requests_are_from_thread_ == std::this_thread::get_id());
- }
- socket_requests_in_flight_ += 1;
- socket_requests_are_from_thread_ = std::this_thread::get_id();
- }
- for (const auto &header : default_headers_) {
- if (req.headers.find(header.first) == req.headers.end()) {
- req.headers.insert(header);
- }
- }
- auto ret = false;
- auto close_connection = !keep_alive_;
- auto se = detail::scope_exit([&]() {
- // Briefly lock mutex in order to mark that a request is no longer ongoing
- std::lock_guard<std::mutex> guard(socket_mutex_);
- socket_requests_in_flight_ -= 1;
- if (socket_requests_in_flight_ <= 0) {
- assert(socket_requests_in_flight_ == 0);
- socket_requests_are_from_thread_ = std::thread::id();
- }
- if (socket_should_be_closed_when_request_is_done_ || close_connection ||
- !ret) {
- disconnect(/*gracefully=*/true);
- }
- });
- ret = process_socket(socket_, req.start_time_, [&](Stream &strm) {
- return handle_request(strm, req, res, close_connection, error);
- });
- if (!ret) {
- if (error == Error::Success) {
- error = Error::Unknown;
- output_error_log(error, &req);
- }
- }
- return ret;
- }
- inline Result ClientImpl::send(const Request &req) {
- auto req2 = req;
- return send_(std::move(req2));
- }
- inline Result ClientImpl::send_(Request &&req) {
- auto res = detail::make_unique<Response>();
- auto error = Error::Success;
- auto ret = send(req, *res, error);
- #ifdef CPPHTTPLIB_SSL_ENABLED
- return Result{ret ? std::move(res) : nullptr, error, std::move(req.headers),
- last_ssl_error_, last_backend_error_};
- #else
- return Result{ret ? std::move(res) : nullptr, error, std::move(req.headers)};
- #endif
- }
- inline void ClientImpl::prepare_default_headers(Request &r, bool for_stream,
- const std::string &ct) {
- (void)for_stream;
- for (const auto &header : default_headers_) {
- if (!r.has_header(header.first)) { r.headers.insert(header); }
- }
- // RFC 9110 5.3 recommends sending control data such as Host first, so
- // prepend it rather than appending it after the caller's own fields.
- if (!r.has_header("Host")) {
- r.headers.emplace_front(
- "Host", detail::make_default_host_header_value(host_, port_, is_ssl(),
- address_family_));
- }
- if (!r.has_header("Accept")) { r.headers.emplace("Accept", "*/*"); }
- if (!r.content_receiver) {
- if (!r.has_header("Accept-Encoding")) {
- std::string accept_encoding;
- #ifdef CPPHTTPLIB_BROTLI_SUPPORT
- accept_encoding = "br";
- #endif
- #ifdef CPPHTTPLIB_ZLIB_SUPPORT
- if (!accept_encoding.empty()) { accept_encoding += ", "; }
- accept_encoding += "gzip, deflate";
- #endif
- #ifdef CPPHTTPLIB_ZSTD_SUPPORT
- if (!accept_encoding.empty()) { accept_encoding += ", "; }
- accept_encoding += "zstd";
- #endif
- r.set_header("Accept-Encoding", accept_encoding);
- }
- detail::add_default_user_agent_header(r);
- }
- if (!r.body.empty()) {
- if (!ct.empty() && !r.has_header("Content-Type")) {
- r.headers.emplace("Content-Type", ct);
- }
- if (!r.has_header("Content-Length")) {
- r.headers.emplace("Content-Length", std::to_string(r.body.size()));
- }
- }
- }
- inline ClientImpl::StreamHandle
- ClientImpl::open_stream(const std::string &method, const std::string &path,
- const Params ¶ms, const Headers &headers,
- const std::string &body,
- const std::string &content_type) {
- StreamHandle handle;
- handle.response = detail::make_unique<Response>();
- handle.error = Error::Success;
- // Encode the target exactly like the buffered send path does, so that the
- // same `path` produces the same request line through either API.
- auto raw_query_path =
- params.empty() ? path : append_query_params(path, params);
- auto query_path = detail::encode_request_target(raw_query_path, path_encode_);
- handle.connection_ = detail::make_unique<ClientConnection>();
- {
- std::lock_guard<std::mutex> guard(socket_mutex_);
- auto is_alive = false;
- if (socket_.is_open()) {
- is_alive = detail::is_socket_alive(socket_.sock);
- #ifdef CPPHTTPLIB_SSL_ENABLED
- if (is_alive && is_ssl()) {
- if (tls::is_peer_closed(socket_.ssl, socket_.sock)) {
- is_alive = false;
- }
- }
- #endif
- if (!is_alive) { disconnect(/*gracefully=*/false); }
- }
- if (!is_alive) {
- if (!ensure_socket_connection(socket_, handle.error)) {
- handle.response.reset();
- return handle;
- }
- {
- auto success = true;
- auto start_time = std::chrono::steady_clock::now();
- if (!setup_proxy_connection(socket_, start_time, *handle.response,
- success, handle.error)) {
- if (!success) { handle.response.reset(); }
- return handle;
- }
- }
- }
- transfer_socket_ownership_to_handle(handle);
- }
- #ifdef CPPHTTPLIB_SSL_ENABLED
- if (is_ssl() && handle.connection_->session) {
- handle.socket_stream_ = detail::make_unique<detail::SSLSocketStream>(
- handle.connection_->sock, handle.connection_->session,
- read_timeout_sec_, read_timeout_usec_, write_timeout_sec_,
- write_timeout_usec_);
- } else {
- handle.socket_stream_ = detail::make_unique<detail::SocketStream>(
- handle.connection_->sock, read_timeout_sec_, read_timeout_usec_,
- write_timeout_sec_, write_timeout_usec_);
- }
- #else
- handle.socket_stream_ = detail::make_unique<detail::SocketStream>(
- handle.connection_->sock, read_timeout_sec_, read_timeout_usec_,
- write_timeout_sec_, write_timeout_usec_);
- #endif
- handle.stream_ = handle.socket_stream_.get();
- Request req;
- req.method = method;
- req.path = query_path;
- req.headers = headers;
- req.body = body;
- prepare_default_headers(req, true, content_type);
- auto &strm = *handle.stream_;
- if (detail::write_request_line(strm, req.method, req.path) < 0) {
- handle.error = Error::Write;
- handle.response.reset();
- return handle;
- }
- if (!detail::check_and_write_headers(strm, req.headers, header_writer_,
- handle.error)) {
- handle.response.reset();
- return handle;
- }
- if (!body.empty()) {
- if (strm.write(body.data(), body.size()) < 0) {
- handle.error = Error::Write;
- handle.response.reset();
- return handle;
- }
- }
- if (!read_response_line(strm, req, *handle.response) ||
- !detail::read_headers(strm, handle.response->headers)) {
- handle.error = Error::Read;
- handle.response.reset();
- return handle;
- }
- handle.body_reader_.stream = handle.stream_;
- handle.body_reader_.payload_max_length = payload_max_length_;
- if (handle.response->has_header("Content-Length")) {
- bool is_invalid = false;
- auto content_length = detail::get_header_value_u64(
- handle.response->headers, "Content-Length", 0, 0, is_invalid);
- if (is_invalid) {
- handle.error = Error::Read;
- handle.response.reset();
- return handle;
- }
- handle.body_reader_.has_content_length = true;
- handle.body_reader_.content_length = content_length;
- }
- handle.body_reader_.chunked =
- detail::is_chunked_transfer_encoding(handle.response->headers);
- auto content_encoding = handle.response->get_header_value("Content-Encoding");
- if (!content_encoding.empty()) {
- // Same policy as prepare_content_receiver(): reject a coding we know about
- // but were not built with, pass an unrecognized one through as-is.
- handle.decompressor_ = detail::create_decompressor(content_encoding);
- if (!handle.decompressor_) {
- if (detail::is_known_content_encoding(content_encoding)) {
- handle.error = Error::UnsupportedContentEncoding;
- handle.response.reset();
- return handle;
- }
- } else if (!handle.decompressor_->is_valid()) {
- handle.error = Error::Compression;
- handle.response.reset();
- return handle;
- }
- }
- return handle;
- }
- inline ssize_t ClientImpl::StreamHandle::read(char *buf, size_t len) {
- if (!is_valid() || !response) { return -1; }
- if (decompressor_) { return read_with_decompression(buf, len); }
- auto n = detail::read_body_content(stream_, body_reader_, buf, len);
- if (n <= 0 && body_reader_.chunked && !trailers_parsed_ && stream_) {
- trailers_parsed_ = true;
- if (body_reader_.chunked_decoder) {
- if (!body_reader_.chunked_decoder->parse_trailers_into(
- response->trailers, response->headers)) {
- return n;
- }
- } else {
- detail::ChunkedDecoder dec(*stream_);
- if (!dec.parse_trailers_into(response->trailers, response->headers)) {
- return n;
- }
- }
- }
- return n;
- }
- inline ssize_t ClientImpl::StreamHandle::read_with_decompression(char *buf,
- size_t len) {
- if (decompress_offset_ < decompress_buffer_.size()) {
- auto available = decompress_buffer_.size() - decompress_offset_;
- auto to_copy = (std::min)(len, available);
- std::memcpy(buf, decompress_buffer_.data() + decompress_offset_, to_copy);
- decompress_offset_ += to_copy;
- decompressed_bytes_read_ += to_copy;
- return static_cast<ssize_t>(to_copy);
- }
- decompress_buffer_.clear();
- decompress_offset_ = 0;
- constexpr size_t kDecompressionBufferSize = 8192;
- char compressed_buf[kDecompressionBufferSize];
- while (true) {
- auto n = detail::read_body_content(stream_, body_reader_, compressed_buf,
- sizeof(compressed_buf));
- if (n <= 0) { return n; }
- bool decompress_ok = decompressor_->decompress(
- compressed_buf, static_cast<size_t>(n),
- [this](const char *data, size_t data_len) {
- decompress_buffer_.append(data, data_len);
- auto limit = body_reader_.payload_max_length;
- if (decompressed_bytes_read_ + decompress_buffer_.size() > limit) {
- return false;
- }
- return true;
- });
- if (!decompress_ok) {
- body_reader_.last_error = Error::Read;
- return -1;
- }
- if (!decompress_buffer_.empty()) { break; }
- }
- auto to_copy = (std::min)(len, decompress_buffer_.size());
- std::memcpy(buf, decompress_buffer_.data(), to_copy);
- decompress_offset_ = to_copy;
- decompressed_bytes_read_ += to_copy;
- return static_cast<ssize_t>(to_copy);
- }
- inline void ClientImpl::StreamHandle::parse_trailers_if_needed() {
- if (!response || !stream_ || !body_reader_.chunked || trailers_parsed_) {
- return;
- }
- trailers_parsed_ = true;
- const auto bufsiz = 128;
- char line_buf[bufsiz];
- detail::stream_line_reader line_reader(*stream_, line_buf, bufsiz);
- if (!line_reader.getline()) { return; }
- if (!detail::parse_trailers(line_reader, response->trailers,
- response->headers)) {
- return;
- }
- }
- namespace detail {
- inline ChunkedDecoder::ChunkedDecoder(Stream &s) : strm(s) {}
- inline ssize_t ChunkedDecoder::read_payload(char *buf, size_t len,
- size_t &out_chunk_offset,
- size_t &out_chunk_total) {
- if (finished) { return 0; }
- if (chunk_remaining == 0) {
- stream_line_reader lr(strm, line_buf, sizeof(line_buf));
- if (!lr.getline()) { return -1; }
- // RFC 9112 §7.1: chunk-size = 1*HEXDIG
- const char *p = lr.ptr();
- int v = 0;
- if (!is_hex(*p, v)) { return -1; }
- size_t chunk_len = 0;
- constexpr size_t chunk_len_max = (std::numeric_limits<size_t>::max)();
- for (; is_hex(*p, v); ++p) {
- if (chunk_len > (chunk_len_max >> 4)) { return -1; }
- chunk_len = (chunk_len << 4) | static_cast<size_t>(v);
- }
- while (is_space_or_tab(*p)) {
- ++p;
- }
- if (*p != '\0' && *p != ';' && *p != '\r' && *p != '\n') { return -1; }
- if (chunk_len == 0) {
- chunk_remaining = 0;
- finished = true;
- out_chunk_offset = 0;
- out_chunk_total = 0;
- return 0;
- }
- chunk_remaining = chunk_len;
- last_chunk_total = chunk_remaining;
- last_chunk_offset = 0;
- }
- auto to_read = (std::min)(chunk_remaining, len);
- auto n = strm.read(buf, to_read);
- if (n <= 0) { return -1; }
- auto offset_before = last_chunk_offset;
- last_chunk_offset += static_cast<size_t>(n);
- chunk_remaining -= static_cast<size_t>(n);
- out_chunk_offset = offset_before;
- out_chunk_total = last_chunk_total;
- if (chunk_remaining == 0) {
- stream_line_reader lr(strm, line_buf, sizeof(line_buf));
- if (!lr.getline()) { return -1; }
- if (std::strcmp(lr.ptr(), "\r\n") != 0) { return -1; }
- }
- return n;
- }
- inline bool ChunkedDecoder::parse_trailers_into(Headers &dest,
- const Headers &src_headers) {
- stream_line_reader lr(strm, line_buf, sizeof(line_buf));
- if (!lr.getline()) { return false; }
- return parse_trailers(lr, dest, src_headers);
- }
- } // namespace detail
- inline void
- ClientImpl::transfer_socket_ownership_to_handle(StreamHandle &handle) {
- handle.connection_->sock = socket_.sock;
- #ifdef CPPHTTPLIB_SSL_ENABLED
- handle.connection_->session = socket_.ssl;
- socket_.ssl = nullptr;
- #endif
- socket_.sock = INVALID_SOCKET;
- }
- inline bool ClientImpl::handle_request(Stream &strm, Request &req,
- Response &res, bool close_connection,
- Error &error) {
- if (req.path.empty()) {
- error = Error::Connection;
- output_error_log(error, &req);
- return false;
- }
- auto req_save = req;
- bool ret;
- if (!is_ssl() && is_proxy_enabled_for_host(host_)) {
- auto req2 = req;
- req2.path = "http://" +
- detail::make_host_and_port_string(host_, port_, false) +
- req.path;
- ret = process_request(strm, req2, res, close_connection, error);
- req = std::move(req2);
- req.path = req_save.path;
- } else {
- ret = process_request(strm, req, res, close_connection, error);
- }
- if (!ret) { return false; }
- if (res.get_header_value("Connection") == "close" ||
- (res.version == "HTTP/1.0" && res.reason != "Connection established")) {
- // NOTE: this requires a not-entirely-obvious chain of calls to be correct
- // for this to be safe.
- // This is safe to call because handle_request is only called by send_
- // which locks the request mutex during the process. It would be a bug
- // to call it from a different thread since it's a thread-safety issue
- // to do these things to the socket if another thread is using the socket.
- std::lock_guard<std::mutex> guard(socket_mutex_);
- disconnect(/*gracefully=*/true);
- }
- if (300 < res.status && res.status < 400 && follow_location_) {
- req = std::move(req_save);
- ret = redirect(req, res, error);
- }
- #ifdef CPPHTTPLIB_SSL_ENABLED
- if ((res.status == StatusCode::Unauthorized_401 ||
- res.status == StatusCode::ProxyAuthenticationRequired_407) &&
- req.authorization_count_ < 5) {
- auto is_proxy = res.status == StatusCode::ProxyAuthenticationRequired_407;
- // Only retry when the 407 actually came from a proxy hop: plain HTTP
- // through an enabled proxy. HTTPS via CONNECT tunnels the 407 from the
- // origin (#2457); direct/bypassed origins have no proxy hop at all.
- if (is_proxy && !(!is_ssl() && is_proxy_enabled_for_host(host_))) {
- return ret;
- }
- const auto &username =
- is_proxy ? proxy_digest_auth_username_ : digest_auth_username_;
- const auto &password =
- is_proxy ? proxy_digest_auth_password_ : digest_auth_password_;
- if (!username.empty() && !password.empty()) {
- std::map<std::string, std::string> auth;
- if (detail::parse_www_authenticate(res, auth, is_proxy)) {
- Request new_req = req;
- new_req.authorization_count_ += 1;
- new_req.headers.erase(is_proxy ? "Proxy-Authorization"
- : "Authorization");
- new_req.headers.insert(detail::make_digest_authentication_header(
- req, auth, new_req.authorization_count_, detail::random_string(10),
- username, password, is_proxy));
- Response new_res;
- ret = send(new_req, new_res, error);
- if (ret) { res = std::move(new_res); }
- }
- }
- }
- #endif
- return ret;
- }
- inline bool ClientImpl::redirect(Request &req, Response &res, Error &error) {
- if (req.redirect_count_ == 0) {
- error = Error::ExceedRedirectCount;
- output_error_log(error, &req);
- return false;
- }
- auto location = res.get_header_value("location");
- if (location.empty()) { return false; }
- detail::UrlComponents uc;
- if (!detail::parse_url(location, uc)) { return false; }
- // Only follow http/https redirects
- if (!uc.scheme.empty() && uc.scheme != "http" && uc.scheme != "https") {
- return false;
- }
- auto scheme = is_ssl() ? "https" : "http";
- auto next_scheme = std::move(uc.scheme);
- auto next_host = std::move(uc.host);
- auto port_str = std::move(uc.port);
- auto next_path = std::move(uc.path);
- auto next_query = std::move(uc.query);
- auto next_port = port_;
- if (!port_str.empty()) {
- if (!detail::parse_port(port_str, next_port)) { return false; }
- } else if (!next_scheme.empty()) {
- next_port = next_scheme == "https" ? 443 : 80;
- }
- if (next_scheme.empty()) { next_scheme = scheme; }
- if (next_host.empty()) { next_host = host_; }
- if (next_path.empty()) { next_path = "/"; }
- auto path = decode_path_component(next_path) + next_query;
- // Same host redirect - use current client
- if (next_scheme == scheme && next_host == host_ && next_port == port_) {
- return detail::redirect(*this, req, res, path, location, error);
- }
- // Cross-host/scheme redirect - create new client with robust setup
- return create_redirect_client(next_scheme, next_host, next_port, req, res,
- path, location, error);
- }
- // New method for robust redirect client creation
- inline bool ClientImpl::create_redirect_client(
- const std::string &scheme, const std::string &host, int port, Request &req,
- Response &res, const std::string &path, const std::string &location,
- Error &error) {
- // Determine if we need SSL
- auto need_ssl = (scheme == "https");
- // Clean up request headers that are host/client specific
- // Remove headers that should not be carried over to new host
- auto headers_to_remove = std::vector<std::string>{
- "Host", "Proxy-Authorization", "Authorization", "Cookie", "Cookie2"};
- for (const auto &header_name : headers_to_remove) {
- auto it = req.headers.find(header_name);
- while (it != req.headers.end()) {
- it = req.headers.erase(it);
- it = req.headers.find(header_name);
- }
- }
- // Create appropriate client type and handle redirect
- if (need_ssl) {
- #ifdef CPPHTTPLIB_SSL_ENABLED
- // Create SSL client for HTTPS redirect
- SSLClient redirect_client(host, port);
- // Setup basic client configuration first
- setup_redirect_client(redirect_client);
- redirect_client.enable_server_certificate_verification(
- server_certificate_verification_);
- redirect_client.enable_server_hostname_verification(
- server_hostname_verification_);
- redirect_client.system_ca_mode_ = system_ca_mode_;
- // Transfer CA certificate to redirect client
- if (!ca_cert_pem_.empty()) {
- redirect_client.load_ca_cert_store(ca_cert_pem_.c_str(),
- ca_cert_pem_.size());
- }
- if (!ca_cert_file_path_.empty()) {
- redirect_client.set_ca_cert_path(ca_cert_file_path_, ca_cert_dir_path_);
- }
- // Client certificates are set through constructor for SSLClient
- // NOTE: SSLClient constructor already takes client_cert_path and
- // client_key_path so we need to create it properly if client certs are
- // needed
- // Execute the redirect
- return detail::redirect(redirect_client, req, res, path, location, error);
- #else
- // SSL not supported - set appropriate error
- error = Error::SSLConnection;
- output_error_log(error, &req);
- return false;
- #endif
- } else {
- // HTTP redirect
- ClientImpl redirect_client(host, port);
- // Setup client with robust configuration
- setup_redirect_client(redirect_client);
- // Execute the redirect
- return detail::redirect(redirect_client, req, res, path, location, error);
- }
- }
- // New method for robust client setup (based on basic_manual_redirect.cpp
- // logic)
- template <typename ClientType>
- inline void ClientImpl::setup_redirect_client(ClientType &client) {
- // Copy basic settings first
- client.set_connection_timeout(connection_timeout_sec_);
- client.set_read_timeout(read_timeout_sec_, read_timeout_usec_);
- client.set_write_timeout(write_timeout_sec_, write_timeout_usec_);
- client.set_keep_alive(keep_alive_);
- client.set_follow_location(
- true); // Enable redirects to handle multi-step redirects
- client.set_path_encode(path_encode_);
- client.set_compress(compress_);
- client.set_decompress(decompress_);
- // NOTE: Authentication credentials (basic auth, bearer token, digest auth)
- // are intentionally NOT copied to the redirect client. Per RFC 9110 Section
- // 15.4, credentials must not be forwarded when redirecting to a different
- // host. This function is only called for cross-host redirects; same-host
- // redirects are handled directly in ClientImpl::redirect().
- // Copy the proxy configuration unconditionally; the per-target bypass is
- // re-evaluated at send time, so a later hop to a non-bypassed host can
- // still use the proxy.
- client.no_proxy_entries_ = no_proxy_entries_;
- if (!proxy_host_.empty() && proxy_port_ != -1) {
- client.set_proxy(proxy_host_, proxy_port_);
- if (!proxy_basic_auth_username_.empty()) {
- client.set_proxy_basic_auth(proxy_basic_auth_username_,
- proxy_basic_auth_password_);
- }
- if (!proxy_bearer_token_auth_token_.empty()) {
- client.set_proxy_bearer_token_auth(proxy_bearer_token_auth_token_);
- }
- #ifdef CPPHTTPLIB_SSL_ENABLED
- if (!proxy_digest_auth_username_.empty()) {
- client.set_proxy_digest_auth(proxy_digest_auth_username_,
- proxy_digest_auth_password_);
- }
- #endif
- }
- // Copy network and socket settings
- client.set_address_family(address_family_);
- client.set_tcp_nodelay(tcp_nodelay_);
- client.set_ipv6_v6only(ipv6_v6only_);
- if (socket_options_) { client.set_socket_options(socket_options_); }
- if (!interface_.empty()) { client.set_interface(interface_); }
- // Copy logging and headers
- if (logger_) { client.set_logger(logger_); }
- if (error_logger_) { client.set_error_logger(error_logger_); }
- // NOTE: DO NOT copy default_headers_ as they may contain stale Host headers
- // Each new client should generate its own headers based on its target host
- }
- inline bool ClientImpl::write_content_with_provider(Stream &strm,
- const Request &req,
- Error &error) const {
- auto is_shutting_down = []() { return false; };
- if (req.is_chunked_content_provider_) {
- auto compressor = compress_ ? detail::create_compressor().first
- : std::unique_ptr<detail::compressor>();
- if (!compressor) {
- compressor = detail::make_unique<detail::nocompressor>();
- }
- return detail::write_content_chunked(strm, req.content_provider_,
- is_shutting_down, *compressor, error);
- } else {
- return detail::write_content_with_progress(
- strm, req.content_provider_, 0, req.content_length_, is_shutting_down,
- req.upload_progress, error);
- }
- }
- inline bool ClientImpl::write_request(Stream &strm, Request &req,
- bool close_connection, Error &error,
- bool skip_body) {
- // Prepare additional headers
- if (close_connection) {
- if (!req.has_header("Connection")) {
- req.set_header("Connection", "close");
- }
- }
- std::string ct_for_defaults;
- if (!req.has_header("Content-Type") && !req.body.empty()) {
- ct_for_defaults = "text/plain";
- }
- prepare_default_headers(req, false, ct_for_defaults);
- if (req.body.empty()) {
- if (req.content_provider_) {
- if (!req.is_chunked_content_provider_) {
- if (!req.has_header("Content-Length")) {
- auto length = std::to_string(req.content_length_);
- req.set_header("Content-Length", length);
- }
- }
- } else {
- if (req.method == "POST" || req.method == "PUT" ||
- req.method == "PATCH") {
- req.set_header("Content-Length", "0");
- }
- }
- }
- if (!basic_auth_password_.empty() || !basic_auth_username_.empty()) {
- if (!req.has_header("Authorization")) {
- req.headers.insert(make_basic_authentication_header(
- basic_auth_username_, basic_auth_password_, false));
- }
- }
- if (!bearer_token_auth_token_.empty()) {
- if (!req.has_header("Authorization")) {
- req.headers.insert(make_bearer_token_authentication_header(
- bearer_token_auth_token_, false));
- }
- }
- // Proxy-Authorization is only sent when the proxy is actually used for
- // this target — otherwise NO_PROXY-matched requests would leak proxy
- // credentials directly to the destination server.
- if (is_proxy_enabled_for_host(host_)) {
- if (!proxy_basic_auth_username_.empty() &&
- !proxy_basic_auth_password_.empty() &&
- !req.has_header("Proxy-Authorization")) {
- req.headers.insert(make_basic_authentication_header(
- proxy_basic_auth_username_, proxy_basic_auth_password_, true));
- }
- if (!proxy_bearer_token_auth_token_.empty() &&
- !req.has_header("Proxy-Authorization")) {
- req.headers.insert(make_bearer_token_authentication_header(
- proxy_bearer_token_auth_token_, true));
- }
- }
- // Request line and headers
- {
- detail::BufferStream bstrm;
- // Extract the query from req.path. The encoding itself is delegated to
- // `encode_request_target`; the raw query is still needed here to decide
- // between populating `req.params` from it and falling back to building a
- // query out of caller-supplied `req.params`.
- auto query_pos = req.path.find('?');
- auto query_part = query_pos == std::string::npos
- ? std::string()
- : req.path.substr(query_pos + 1);
- auto path_with_query =
- detail::encode_request_target(req.path, path_encode_);
- if (!query_part.empty()) {
- // The query already came in through `req.path`; still populate
- // `req.params` for handlers/users who read them.
- detail::parse_query_text(query_part, req.params);
- } else if (!req.params.empty()) {
- // No query in `req.path`; build one from `req.params` so existing
- // callers that pass `Params` separately continue to work.
- path_with_query = append_query_params(path_with_query, req.params);
- }
- // Write request line and headers
- if (detail::write_request_line(bstrm, req.method, path_with_query) < 0) {
- // A rejected target (e.g. CR/LF smuggled in via a decoded redirect
- // Location under set_path_encode(false)) must fail the request cleanly
- // instead of emitting a request-line-less, header-injecting request.
- error = Error::Write;
- output_error_log(error, &req);
- return false;
- }
- if (!detail::check_and_write_headers(bstrm, req.headers, header_writer_,
- error)) {
- output_error_log(error, &req);
- return false;
- }
- // Flush buffer
- auto &data = bstrm.get_buffer();
- if (!detail::write_data(strm, data.data(), data.size())) {
- error = Error::Write;
- output_error_log(error, &req);
- return false;
- }
- }
- // After sending request line and headers, wait briefly for an early server
- // response (e.g. 4xx) and avoid sending a potentially large request body
- // unnecessarily. This workaround is only enabled on Windows because Unix
- // platforms surface write errors (EPIPE) earlier; on Windows kernel send
- // buffering can accept large writes even when the peer already responded.
- // Check the stream first (which covers SSL via `is_readable()`), then
- // fall back to select on the socket. Only perform the wait for very large
- // request bodies to avoid interfering with normal small requests and
- // reduce side-effects. Poll briefly (up to 50ms as default) for an early
- // response. Skip this check when using Expect: 100-continue, as the protocol
- // handles early responses properly.
- #if defined(_WIN32)
- if (!skip_body &&
- req.body.size() > CPPHTTPLIB_WAIT_EARLY_SERVER_RESPONSE_THRESHOLD &&
- req.path.size() > CPPHTTPLIB_REQUEST_URI_MAX_LENGTH) {
- auto start = std::chrono::high_resolution_clock::now();
- for (;;) {
- // Prefer socket-level readiness to avoid SSL_pending() false-positives
- // from SSL internals. If the underlying socket is readable, assume an
- // early response may be present.
- auto sock = strm.socket();
- if (sock != INVALID_SOCKET && detail::select_read(sock, 0, 0) > 0) {
- return false;
- }
- // Fallback to stream-level check for non-socket streams or when the
- // socket isn't reporting readable. Avoid using `is_readable()` for
- // SSL, since `SSL_pending()` may report buffered records that do not
- // indicate a complete application-level response yet.
- if (!is_ssl() && strm.is_readable()) { return false; }
- auto now = std::chrono::high_resolution_clock::now();
- auto elapsed =
- std::chrono::duration_cast<std::chrono::milliseconds>(now - start)
- .count();
- if (elapsed >= CPPHTTPLIB_WAIT_EARLY_SERVER_RESPONSE_TIMEOUT_MSECOND) {
- break;
- }
- std::this_thread::sleep_for(std::chrono::milliseconds(1));
- }
- }
- #endif
- // Body
- if (skip_body) { return true; }
- return write_request_body(strm, req, error);
- }
- inline bool ClientImpl::write_request_body(Stream &strm, Request &req,
- Error &error) {
- if (req.body.empty()) {
- return write_content_with_provider(strm, req, error);
- }
- if (req.upload_progress) {
- auto body_size = req.body.size();
- size_t written = 0;
- auto data = req.body.data();
- while (written < body_size) {
- size_t to_write = (std::min)(CPPHTTPLIB_SEND_BUFSIZ, body_size - written);
- if (!detail::write_data(strm, data + written, to_write)) {
- error = Error::Write;
- output_error_log(error, &req);
- return false;
- }
- written += to_write;
- if (!req.upload_progress(written, body_size)) {
- error = Error::Canceled;
- output_error_log(error, &req);
- return false;
- }
- }
- } else {
- if (!detail::write_data(strm, req.body.data(), req.body.size())) {
- error = Error::Write;
- output_error_log(error, &req);
- return false;
- }
- }
- return true;
- }
- inline std::unique_ptr<Response>
- ClientImpl::send_with_content_provider_and_receiver(
- Request &req, const char *body, size_t content_length,
- ContentProvider content_provider,
- ContentProviderWithoutLength content_provider_without_length,
- const std::string &content_type, ContentReceiver content_receiver,
- Error &error) {
- if (!content_type.empty()) { req.set_header("Content-Type", content_type); }
- auto enc = compress_
- ? detail::create_compressor()
- : std::pair<std::unique_ptr<detail::compressor>, const char *>(
- nullptr, nullptr);
- if (enc.second) { req.set_header("Content-Encoding", enc.second); }
- if (enc.first && !content_provider_without_length) {
- auto &compressor = enc.first;
- if (content_provider) {
- auto ok = true;
- size_t offset = 0;
- DataSink data_sink;
- data_sink.write = [&](const char *data, size_t data_len) -> bool {
- if (ok) {
- auto last = offset + data_len == content_length;
- auto ret = compressor->compress(
- data, data_len, last,
- [&](const char *compressed_data, size_t compressed_data_len) {
- req.body.append(compressed_data, compressed_data_len);
- return true;
- });
- if (ret) {
- offset += data_len;
- } else {
- ok = false;
- }
- }
- return ok;
- };
- while (ok && offset < content_length) {
- if (!content_provider(offset, content_length - offset, data_sink)) {
- error = Error::Canceled;
- output_error_log(error, &req);
- return nullptr;
- }
- }
- } else {
- if (!compressor->compress(body, content_length, true,
- [&](const char *data, size_t data_len) {
- req.body.append(data, data_len);
- return true;
- })) {
- error = Error::Compression;
- output_error_log(error, &req);
- return nullptr;
- }
- }
- } else {
- if (content_provider) {
- req.content_length_ = content_length;
- req.content_provider_ = std::move(content_provider);
- req.is_chunked_content_provider_ = false;
- } else if (content_provider_without_length) {
- req.content_length_ = 0;
- req.content_provider_ = detail::ContentProviderAdapter(
- std::move(content_provider_without_length));
- req.is_chunked_content_provider_ = true;
- req.set_header("Transfer-Encoding", "chunked");
- } else {
- req.body.assign(body, content_length);
- }
- }
- if (content_receiver) {
- req.content_receiver =
- [content_receiver](const char *data, size_t data_length,
- size_t /*offset*/, size_t /*total_length*/) {
- return content_receiver(data, data_length);
- };
- }
- auto res = detail::make_unique<Response>();
- return send(req, *res, error) ? std::move(res) : nullptr;
- }
- inline Result ClientImpl::send_with_content_provider_and_receiver(
- const std::string &method, const std::string &path, const Headers &headers,
- const char *body, size_t content_length, ContentProvider content_provider,
- ContentProviderWithoutLength content_provider_without_length,
- const std::string &content_type, ContentReceiver content_receiver,
- UploadProgress progress) {
- Request req;
- req.method = method;
- req.headers = headers;
- req.path = path;
- req.upload_progress = std::move(progress);
- if (max_timeout_msec_ > 0) {
- req.start_time_ = std::chrono::steady_clock::now();
- }
- auto error = Error::Success;
- auto res = send_with_content_provider_and_receiver(
- req, body, content_length, std::move(content_provider),
- std::move(content_provider_without_length), content_type,
- std::move(content_receiver), error);
- #ifdef CPPHTTPLIB_SSL_ENABLED
- return Result{std::move(res), error, std::move(req.headers), last_ssl_error_,
- last_backend_error_};
- #else
- return Result{std::move(res), error, std::move(req.headers)};
- #endif
- }
- inline void ClientImpl::output_log(const Request &req,
- const Response &res) const {
- if (logger_) {
- std::lock_guard<std::mutex> guard(logger_mutex_);
- logger_(req, res);
- }
- }
- inline void ClientImpl::output_error_log(const Error &err,
- const Request *req) const {
- if (error_logger_) {
- std::lock_guard<std::mutex> guard(logger_mutex_);
- error_logger_(err, req);
- }
- }
- inline bool ClientImpl::process_request(Stream &strm, Request &req,
- Response &res, bool close_connection,
- Error &error) {
- // Auto-add Expect: 100-continue for large bodies
- if (CPPHTTPLIB_EXPECT_100_THRESHOLD > 0 && !req.has_header("Expect")) {
- auto body_size = req.body.empty() ? req.content_length_ : req.body.size();
- if (body_size >= CPPHTTPLIB_EXPECT_100_THRESHOLD) {
- req.set_header("Expect", "100-continue");
- }
- }
- // Check for Expect: 100-continue
- auto expect_100_continue = req.get_header_value("Expect") == "100-continue";
- // Send request (skip body if using Expect: 100-continue)
- auto write_request_success =
- write_request(strm, req, close_connection, error, expect_100_continue);
- #ifdef CPPHTTPLIB_SSL_ENABLED
- if (is_ssl() && !expect_100_continue) {
- auto is_proxy_enabled = is_proxy_enabled_for_host(host_);
- if (!is_proxy_enabled) {
- if (tls::is_peer_closed(socket_.ssl, socket_.sock)) {
- error = Error::SSLPeerCouldBeClosed_;
- output_error_log(error, &req);
- return false;
- }
- }
- }
- #endif
- // Handle Expect: 100-continue.
- //
- // Wait for an interim/early response by attempting to read the status line
- // under a short timeout, instead of trusting raw socket readability. Over
- // TLS, post-handshake records (e.g. session tickets) make the socket
- // readable without any HTTP response being available; relying on
- // `select_read` there caused the body to be withheld forever and the
- // request to fail with `Read` (#2458). If no status line arrives within the
- // timeout, send the body anyway (matching curl's behavior).
- auto status_line_read = false;
- if (expect_100_continue && write_request_success) {
- if (CPPHTTPLIB_EXPECT_100_TIMEOUT_MSECOND > 0) {
- time_t sec = CPPHTTPLIB_EXPECT_100_TIMEOUT_MSECOND / 1000;
- time_t usec = (CPPHTTPLIB_EXPECT_100_TIMEOUT_MSECOND % 1000) * 1000;
- strm.set_read_timeout(sec, usec);
- status_line_read = read_response_line(strm, req, res, false);
- strm.set_read_timeout(read_timeout_sec_, read_timeout_usec_);
- }
- if (!status_line_read) {
- // No interim response within the timeout: send the body and handle the
- // response as usual.
- if (!write_request_body(strm, req, error)) { return false; }
- expect_100_continue = false; // Switch to normal response handling
- }
- }
- // Receive response and headers
- // When using Expect: 100-continue, don't auto-skip `100 Continue` response
- if ((!status_line_read &&
- !read_response_line(strm, req, res, !expect_100_continue)) ||
- !detail::read_headers(strm, res.headers)) {
- if (write_request_success) { error = Error::Read; }
- output_error_log(error, &req);
- return false;
- }
- if (!write_request_success) { return false; }
- // Handle Expect: 100-continue response
- if (expect_100_continue) {
- if (res.status == StatusCode::Continue_100) {
- // Server accepted, send the body
- if (!write_request_body(strm, req, error)) { return false; }
- // Read the actual response
- res.headers.clear();
- res.body.clear();
- if (!read_response_line(strm, req, res) ||
- !detail::read_headers(strm, res.headers)) {
- error = Error::Read;
- output_error_log(error, &req);
- return false;
- }
- }
- // If not 100 Continue, server returned an error; proceed with that response
- }
- // Body
- if ((res.status != StatusCode::NoContent_204) && req.method != "HEAD" &&
- req.method != "CONNECT") {
- auto redirect = 300 < res.status && res.status < 400 &&
- res.status != StatusCode::NotModified_304 &&
- follow_location_;
- if (req.response_handler && !redirect) {
- if (!req.response_handler(res)) {
- error = Error::Canceled;
- output_error_log(error, &req);
- return false;
- }
- }
- auto out =
- req.content_receiver
- ? static_cast<ContentReceiverWithProgress>(
- [&](const char *buf, size_t n, size_t off, size_t len) {
- if (redirect) { return true; }
- auto ret = req.content_receiver(buf, n, off, len);
- if (!ret) {
- error = Error::Canceled;
- output_error_log(error, &req);
- }
- return ret;
- })
- : static_cast<ContentReceiverWithProgress>(
- [&](const char *buf, size_t n, size_t /*off*/,
- size_t /*len*/) {
- assert(res.body.size() + n <= res.body.max_size());
- if (payload_max_length_ > 0 &&
- (res.body.size() >= payload_max_length_ ||
- n > payload_max_length_ - res.body.size())) {
- return false;
- }
- res.body.append(buf, n);
- return true;
- });
- auto progress = [&](size_t current, size_t total) {
- if (!req.download_progress || redirect) { return true; }
- auto ret = req.download_progress(current, total);
- if (!ret) {
- error = Error::Canceled;
- output_error_log(error, &req);
- }
- return ret;
- };
- if (res.has_header("Content-Length")) {
- if (!req.content_receiver) {
- auto len = res.get_header_value_u64("Content-Length");
- if (len > res.body.max_size()) {
- error = Error::Read;
- output_error_log(error, &req);
- return false;
- }
- // Cap the reservation by payload_max_length_ to avoid OOM when a
- // hostile or malformed server sends an enormous Content-Length.
- // The actual body read below is bounded by payload_max_length_,
- // so reserving more than that is never useful.
- auto reserve_len = static_cast<size_t>(len);
- if (payload_max_length_ > 0 && reserve_len > payload_max_length_) {
- reserve_len = payload_max_length_;
- }
- res.body.reserve(reserve_len);
- }
- }
- if (res.status != StatusCode::NotModified_304) {
- auto content_status = 0;
- auto max_length = (!has_payload_max_length_ && req.content_receiver)
- ? (std::numeric_limits<size_t>::max)()
- : payload_max_length_;
- if (!detail::read_content(strm, res, max_length, content_status,
- std::move(progress), std::move(out),
- decompress_)) {
- if (error != Error::Canceled) {
- // Tell the caller apart from a plain read failure when the body could
- // not be decoded because of its Content-Encoding.
- switch (content_status) {
- case StatusCode::UnsupportedMediaType_415:
- error = Error::UnsupportedContentEncoding;
- break;
- case StatusCode::InternalServerError_500:
- error = Error::Compression;
- break;
- default: error = Error::Read; break;
- }
- }
- output_error_log(error, &req);
- return false;
- }
- }
- }
- // Log
- output_log(req, res);
- return true;
- }
- inline ContentProviderWithoutLength ClientImpl::get_multipart_content_provider(
- const std::string &boundary, const UploadFormDataItems &items,
- const FormDataProviderItems &provider_items) const {
- size_t cur_item = 0;
- size_t cur_start = 0;
- // cur_item and cur_start are copied to within the std::function and
- // maintain state between successive calls
- return [&, cur_item, cur_start](size_t offset,
- DataSink &sink) mutable -> bool {
- if (!offset && !items.empty()) {
- sink.os << detail::serialize_multipart_formdata(items, boundary, false);
- return true;
- } else if (cur_item < provider_items.size()) {
- if (!cur_start) {
- const auto &begin = detail::serialize_multipart_formdata_item_begin(
- provider_items[cur_item], boundary);
- offset += begin.size();
- cur_start = offset;
- sink.os << begin;
- }
- DataSink cur_sink;
- auto has_data = true;
- cur_sink.write = sink.write;
- cur_sink.done = [&]() { has_data = false; };
- if (!provider_items[cur_item].provider(offset - cur_start, cur_sink)) {
- return false;
- }
- if (!has_data) {
- sink.os << detail::serialize_multipart_formdata_item_end();
- cur_item++;
- cur_start = 0;
- }
- return true;
- } else {
- sink.os << detail::serialize_multipart_formdata_finish(boundary);
- sink.done();
- return true;
- }
- };
- }
- inline bool ClientImpl::process_socket(
- const Socket &socket,
- std::chrono::time_point<std::chrono::steady_clock> start_time,
- std::function<bool(Stream &strm)> callback) {
- return detail::process_client_socket(
- socket.sock, read_timeout_sec_, read_timeout_usec_, write_timeout_sec_,
- write_timeout_usec_, max_timeout_msec_, start_time, std::move(callback));
- }
- inline bool ClientImpl::is_ssl() const { return false; }
- inline Result ClientImpl::Get(const std::string &path,
- DownloadProgress progress) {
- return Get(path, Headers(), std::move(progress));
- }
- inline Result ClientImpl::Get(const std::string &path, const Params ¶ms,
- DownloadProgress progress) {
- return Get(path, params, Headers(), std::move(progress));
- }
- inline Result ClientImpl::Get(const std::string &path, const Params ¶ms,
- const Headers &headers,
- DownloadProgress progress) {
- if (params.empty()) { return Get(path, headers); }
- std::string path_with_query = append_query_params(path, params);
- return Get(path_with_query, headers, std::move(progress));
- }
- inline Result ClientImpl::Get(const std::string &path, const Headers &headers,
- DownloadProgress progress) {
- Request req;
- req.method = "GET";
- req.path = path;
- req.headers = headers;
- req.download_progress = std::move(progress);
- if (max_timeout_msec_ > 0) {
- req.start_time_ = std::chrono::steady_clock::now();
- }
- return send_(std::move(req));
- }
- inline Result ClientImpl::Get(const std::string &path,
- ContentReceiver content_receiver,
- DownloadProgress progress) {
- return Get(path, Headers(), nullptr, std::move(content_receiver),
- std::move(progress));
- }
- inline Result ClientImpl::Get(const std::string &path, const Headers &headers,
- ContentReceiver content_receiver,
- DownloadProgress progress) {
- return Get(path, headers, nullptr, std::move(content_receiver),
- std::move(progress));
- }
- inline Result ClientImpl::Get(const std::string &path,
- ResponseHandler response_handler,
- ContentReceiver content_receiver,
- DownloadProgress progress) {
- return Get(path, Headers(), std::move(response_handler),
- std::move(content_receiver), std::move(progress));
- }
- inline Result ClientImpl::Get(const std::string &path, const Headers &headers,
- ResponseHandler response_handler,
- ContentReceiver content_receiver,
- DownloadProgress progress) {
- Request req;
- req.method = "GET";
- req.path = path;
- req.headers = headers;
- req.response_handler = std::move(response_handler);
- req.content_receiver =
- [content_receiver](const char *data, size_t data_length,
- size_t /*offset*/, size_t /*total_length*/) {
- return content_receiver(data, data_length);
- };
- req.download_progress = std::move(progress);
- if (max_timeout_msec_ > 0) {
- req.start_time_ = std::chrono::steady_clock::now();
- }
- return send_(std::move(req));
- }
- inline Result ClientImpl::Get(const std::string &path, const Params ¶ms,
- const Headers &headers,
- ContentReceiver content_receiver,
- DownloadProgress progress) {
- return Get(path, params, headers, nullptr, std::move(content_receiver),
- std::move(progress));
- }
- inline Result ClientImpl::Get(const std::string &path, const Params ¶ms,
- const Headers &headers,
- ResponseHandler response_handler,
- ContentReceiver content_receiver,
- DownloadProgress progress) {
- if (params.empty()) {
- return Get(path, headers, std::move(response_handler),
- std::move(content_receiver), std::move(progress));
- }
- std::string path_with_query = append_query_params(path, params);
- return Get(path_with_query, headers, std::move(response_handler),
- std::move(content_receiver), std::move(progress));
- }
- inline Result ClientImpl::Head(const std::string &path) {
- return Head(path, Headers());
- }
- inline Result ClientImpl::Head(const std::string &path,
- const Headers &headers) {
- Request req;
- req.method = "HEAD";
- req.headers = headers;
- req.path = path;
- if (max_timeout_msec_ > 0) {
- req.start_time_ = std::chrono::steady_clock::now();
- }
- return send_(std::move(req));
- }
- inline Result ClientImpl::Post(const std::string &path) {
- return Post(path, std::string(), std::string());
- }
- inline Result ClientImpl::Post(const std::string &path,
- const Headers &headers) {
- return Post(path, headers, nullptr, 0, std::string());
- }
- inline Result ClientImpl::Post(const std::string &path, const char *body,
- size_t content_length,
- const std::string &content_type,
- UploadProgress progress) {
- return Post(path, Headers(), body, content_length, content_type, progress);
- }
- inline Result ClientImpl::Post(const std::string &path, const std::string &body,
- const std::string &content_type,
- UploadProgress progress) {
- return Post(path, Headers(), body, content_type, progress);
- }
- inline Result ClientImpl::Post(const std::string &path, const Params ¶ms) {
- return Post(path, Headers(), params);
- }
- inline Result ClientImpl::Post(const std::string &path, size_t content_length,
- ContentProvider content_provider,
- const std::string &content_type,
- UploadProgress progress) {
- return Post(path, Headers(), content_length, std::move(content_provider),
- content_type, progress);
- }
- inline Result ClientImpl::Post(const std::string &path, size_t content_length,
- ContentProvider content_provider,
- const std::string &content_type,
- ContentReceiver content_receiver,
- UploadProgress progress) {
- return Post(path, Headers(), content_length, std::move(content_provider),
- content_type, std::move(content_receiver), progress);
- }
- inline Result ClientImpl::Post(const std::string &path,
- ContentProviderWithoutLength content_provider,
- const std::string &content_type,
- UploadProgress progress) {
- return Post(path, Headers(), std::move(content_provider), content_type,
- progress);
- }
- inline Result ClientImpl::Post(const std::string &path,
- ContentProviderWithoutLength content_provider,
- const std::string &content_type,
- ContentReceiver content_receiver,
- UploadProgress progress) {
- return Post(path, Headers(), std::move(content_provider), content_type,
- std::move(content_receiver), progress);
- }
- inline Result ClientImpl::Post(const std::string &path, const Headers &headers,
- const Params ¶ms) {
- auto query = detail::params_to_query_str(params);
- return Post(path, headers, query, "application/x-www-form-urlencoded");
- }
- inline Result ClientImpl::Post(const std::string &path,
- const UploadFormDataItems &items,
- UploadProgress progress) {
- return Post(path, Headers(), items, progress);
- }
- inline Result ClientImpl::Post(const std::string &path, const Headers &headers,
- const UploadFormDataItems &items,
- UploadProgress progress) {
- const auto &boundary = detail::make_multipart_data_boundary();
- const auto &content_type =
- detail::serialize_multipart_formdata_get_content_type(boundary);
- auto content_length = detail::get_multipart_content_length(items, boundary);
- return Post(path, headers, content_length,
- detail::make_multipart_content_provider(items, boundary),
- content_type, progress);
- }
- inline Result ClientImpl::Post(const std::string &path, const Headers &headers,
- const UploadFormDataItems &items,
- const std::string &boundary,
- UploadProgress progress) {
- if (!detail::is_multipart_boundary_chars_valid(boundary)) {
- return Result{nullptr, Error::UnsupportedMultipartBoundaryChars};
- }
- const auto &content_type =
- detail::serialize_multipart_formdata_get_content_type(boundary);
- auto content_length = detail::get_multipart_content_length(items, boundary);
- return Post(path, headers, content_length,
- detail::make_multipart_content_provider(items, boundary),
- content_type, progress);
- }
- inline Result ClientImpl::Post(const std::string &path, const Headers &headers,
- const char *body, size_t content_length,
- const std::string &content_type,
- UploadProgress progress) {
- return send_with_content_provider_and_receiver(
- "POST", path, headers, body, content_length, nullptr, nullptr,
- content_type, nullptr, progress);
- }
- inline Result ClientImpl::Post(const std::string &path, const Headers &headers,
- const std::string &body,
- const std::string &content_type,
- UploadProgress progress) {
- return send_with_content_provider_and_receiver(
- "POST", path, headers, body.data(), body.size(), nullptr, nullptr,
- content_type, nullptr, progress);
- }
- inline Result ClientImpl::Post(const std::string &path, const Headers &headers,
- size_t content_length,
- ContentProvider content_provider,
- const std::string &content_type,
- UploadProgress progress) {
- return send_with_content_provider_and_receiver(
- "POST", path, headers, nullptr, content_length,
- std::move(content_provider), nullptr, content_type, nullptr, progress);
- }
- inline Result ClientImpl::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) {
- return send_with_content_provider_and_receiver(
- "POST", path, headers, nullptr, content_length,
- std::move(content_provider), nullptr, content_type,
- std::move(content_receiver), std::move(progress));
- }
- inline Result ClientImpl::Post(const std::string &path, const Headers &headers,
- ContentProviderWithoutLength content_provider,
- const std::string &content_type,
- UploadProgress progress) {
- return send_with_content_provider_and_receiver(
- "POST", path, headers, nullptr, 0, nullptr, std::move(content_provider),
- content_type, nullptr, progress);
- }
- inline Result ClientImpl::Post(const std::string &path, const Headers &headers,
- ContentProviderWithoutLength content_provider,
- const std::string &content_type,
- ContentReceiver content_receiver,
- DownloadProgress progress) {
- return send_with_content_provider_and_receiver(
- "POST", path, headers, nullptr, 0, nullptr, std::move(content_provider),
- content_type, std::move(content_receiver), std::move(progress));
- }
- inline Result ClientImpl::Post(const std::string &path, const Headers &headers,
- const UploadFormDataItems &items,
- const FormDataProviderItems &provider_items,
- UploadProgress progress) {
- const auto &boundary = detail::make_multipart_data_boundary();
- const auto &content_type =
- detail::serialize_multipart_formdata_get_content_type(boundary);
- return send_with_content_provider_and_receiver(
- "POST", path, headers, nullptr, 0, nullptr,
- get_multipart_content_provider(boundary, items, provider_items),
- content_type, nullptr, progress);
- }
- inline Result ClientImpl::Post(const std::string &path, const Headers &headers,
- const std::string &body,
- const std::string &content_type,
- ContentReceiver content_receiver,
- DownloadProgress progress) {
- Request req;
- req.method = "POST";
- req.path = path;
- req.headers = headers;
- req.body = body;
- req.content_receiver =
- [content_receiver](const char *data, size_t data_length,
- size_t /*offset*/, size_t /*total_length*/) {
- return content_receiver(data, data_length);
- };
- req.download_progress = std::move(progress);
- if (max_timeout_msec_ > 0) {
- req.start_time_ = std::chrono::steady_clock::now();
- }
- if (!content_type.empty()) { req.set_header("Content-Type", content_type); }
- return send_(std::move(req));
- }
- inline Result ClientImpl::Put(const std::string &path) {
- return Put(path, std::string(), std::string());
- }
- inline Result ClientImpl::Put(const std::string &path, const Headers &headers) {
- return Put(path, headers, nullptr, 0, std::string());
- }
- inline Result ClientImpl::Put(const std::string &path, const char *body,
- size_t content_length,
- const std::string &content_type,
- UploadProgress progress) {
- return Put(path, Headers(), body, content_length, content_type, progress);
- }
- inline Result ClientImpl::Put(const std::string &path, const std::string &body,
- const std::string &content_type,
- UploadProgress progress) {
- return Put(path, Headers(), body, content_type, progress);
- }
- inline Result ClientImpl::Put(const std::string &path, const Params ¶ms) {
- return Put(path, Headers(), params);
- }
- inline Result ClientImpl::Put(const std::string &path, size_t content_length,
- ContentProvider content_provider,
- const std::string &content_type,
- UploadProgress progress) {
- return Put(path, Headers(), content_length, std::move(content_provider),
- content_type, progress);
- }
- inline Result ClientImpl::Put(const std::string &path, size_t content_length,
- ContentProvider content_provider,
- const std::string &content_type,
- ContentReceiver content_receiver,
- UploadProgress progress) {
- return Put(path, Headers(), content_length, std::move(content_provider),
- content_type, std::move(content_receiver), progress);
- }
- inline Result ClientImpl::Put(const std::string &path,
- ContentProviderWithoutLength content_provider,
- const std::string &content_type,
- UploadProgress progress) {
- return Put(path, Headers(), std::move(content_provider), content_type,
- progress);
- }
- inline Result ClientImpl::Put(const std::string &path,
- ContentProviderWithoutLength content_provider,
- const std::string &content_type,
- ContentReceiver content_receiver,
- UploadProgress progress) {
- return Put(path, Headers(), std::move(content_provider), content_type,
- std::move(content_receiver), progress);
- }
- inline Result ClientImpl::Put(const std::string &path, const Headers &headers,
- const Params ¶ms) {
- auto query = detail::params_to_query_str(params);
- return Put(path, headers, query, "application/x-www-form-urlencoded");
- }
- inline Result ClientImpl::Put(const std::string &path,
- const UploadFormDataItems &items,
- UploadProgress progress) {
- return Put(path, Headers(), items, progress);
- }
- inline Result ClientImpl::Put(const std::string &path, const Headers &headers,
- const UploadFormDataItems &items,
- UploadProgress progress) {
- const auto &boundary = detail::make_multipart_data_boundary();
- const auto &content_type =
- detail::serialize_multipart_formdata_get_content_type(boundary);
- auto content_length = detail::get_multipart_content_length(items, boundary);
- return Put(path, headers, content_length,
- detail::make_multipart_content_provider(items, boundary),
- content_type, progress);
- }
- inline Result ClientImpl::Put(const std::string &path, const Headers &headers,
- const UploadFormDataItems &items,
- const std::string &boundary,
- UploadProgress progress) {
- if (!detail::is_multipart_boundary_chars_valid(boundary)) {
- return Result{nullptr, Error::UnsupportedMultipartBoundaryChars};
- }
- const auto &content_type =
- detail::serialize_multipart_formdata_get_content_type(boundary);
- auto content_length = detail::get_multipart_content_length(items, boundary);
- return Put(path, headers, content_length,
- detail::make_multipart_content_provider(items, boundary),
- content_type, progress);
- }
- inline Result ClientImpl::Put(const std::string &path, const Headers &headers,
- const char *body, size_t content_length,
- const std::string &content_type,
- UploadProgress progress) {
- return send_with_content_provider_and_receiver(
- "PUT", path, headers, body, content_length, nullptr, nullptr,
- content_type, nullptr, progress);
- }
- inline Result ClientImpl::Put(const std::string &path, const Headers &headers,
- const std::string &body,
- const std::string &content_type,
- UploadProgress progress) {
- return send_with_content_provider_and_receiver(
- "PUT", path, headers, body.data(), body.size(), nullptr, nullptr,
- content_type, nullptr, progress);
- }
- inline Result ClientImpl::Put(const std::string &path, const Headers &headers,
- size_t content_length,
- ContentProvider content_provider,
- const std::string &content_type,
- UploadProgress progress) {
- return send_with_content_provider_and_receiver(
- "PUT", path, headers, nullptr, content_length,
- std::move(content_provider), nullptr, content_type, nullptr, progress);
- }
- inline Result ClientImpl::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) {
- return send_with_content_provider_and_receiver(
- "PUT", path, headers, nullptr, content_length,
- std::move(content_provider), nullptr, content_type,
- std::move(content_receiver), progress);
- }
- inline Result ClientImpl::Put(const std::string &path, const Headers &headers,
- ContentProviderWithoutLength content_provider,
- const std::string &content_type,
- UploadProgress progress) {
- return send_with_content_provider_and_receiver(
- "PUT", path, headers, nullptr, 0, nullptr, std::move(content_provider),
- content_type, nullptr, progress);
- }
- inline Result ClientImpl::Put(const std::string &path, const Headers &headers,
- ContentProviderWithoutLength content_provider,
- const std::string &content_type,
- ContentReceiver content_receiver,
- UploadProgress progress) {
- return send_with_content_provider_and_receiver(
- "PUT", path, headers, nullptr, 0, nullptr, std::move(content_provider),
- content_type, std::move(content_receiver), progress);
- }
- inline Result ClientImpl::Put(const std::string &path, const Headers &headers,
- const UploadFormDataItems &items,
- const FormDataProviderItems &provider_items,
- UploadProgress progress) {
- const auto &boundary = detail::make_multipart_data_boundary();
- const auto &content_type =
- detail::serialize_multipart_formdata_get_content_type(boundary);
- return send_with_content_provider_and_receiver(
- "PUT", path, headers, nullptr, 0, nullptr,
- get_multipart_content_provider(boundary, items, provider_items),
- content_type, nullptr, progress);
- }
- inline Result ClientImpl::Put(const std::string &path, const Headers &headers,
- const std::string &body,
- const std::string &content_type,
- ContentReceiver content_receiver,
- DownloadProgress progress) {
- Request req;
- req.method = "PUT";
- req.path = path;
- req.headers = headers;
- req.body = body;
- req.content_receiver =
- [content_receiver](const char *data, size_t data_length,
- size_t /*offset*/, size_t /*total_length*/) {
- return content_receiver(data, data_length);
- };
- req.download_progress = std::move(progress);
- if (max_timeout_msec_ > 0) {
- req.start_time_ = std::chrono::steady_clock::now();
- }
- if (!content_type.empty()) { req.set_header("Content-Type", content_type); }
- return send_(std::move(req));
- }
- inline Result ClientImpl::Patch(const std::string &path) {
- return Patch(path, std::string(), std::string());
- }
- inline Result ClientImpl::Patch(const std::string &path, const Headers &headers,
- UploadProgress progress) {
- return Patch(path, headers, nullptr, 0, std::string(), progress);
- }
- inline Result ClientImpl::Patch(const std::string &path, const char *body,
- size_t content_length,
- const std::string &content_type,
- UploadProgress progress) {
- return Patch(path, Headers(), body, content_length, content_type, progress);
- }
- inline Result ClientImpl::Patch(const std::string &path,
- const std::string &body,
- const std::string &content_type,
- UploadProgress progress) {
- return Patch(path, Headers(), body, content_type, progress);
- }
- inline Result ClientImpl::Patch(const std::string &path, const Params ¶ms) {
- return Patch(path, Headers(), params);
- }
- inline Result ClientImpl::Patch(const std::string &path, size_t content_length,
- ContentProvider content_provider,
- const std::string &content_type,
- UploadProgress progress) {
- return Patch(path, Headers(), content_length, std::move(content_provider),
- content_type, progress);
- }
- inline Result ClientImpl::Patch(const std::string &path, size_t content_length,
- ContentProvider content_provider,
- const std::string &content_type,
- ContentReceiver content_receiver,
- UploadProgress progress) {
- return Patch(path, Headers(), content_length, std::move(content_provider),
- content_type, std::move(content_receiver), progress);
- }
- inline Result ClientImpl::Patch(const std::string &path,
- ContentProviderWithoutLength content_provider,
- const std::string &content_type,
- UploadProgress progress) {
- return Patch(path, Headers(), std::move(content_provider), content_type,
- progress);
- }
- inline Result ClientImpl::Patch(const std::string &path,
- ContentProviderWithoutLength content_provider,
- const std::string &content_type,
- ContentReceiver content_receiver,
- UploadProgress progress) {
- return Patch(path, Headers(), std::move(content_provider), content_type,
- std::move(content_receiver), progress);
- }
- inline Result ClientImpl::Patch(const std::string &path, const Headers &headers,
- const Params ¶ms) {
- auto query = detail::params_to_query_str(params);
- return Patch(path, headers, query, "application/x-www-form-urlencoded");
- }
- inline Result ClientImpl::Patch(const std::string &path,
- const UploadFormDataItems &items,
- UploadProgress progress) {
- return Patch(path, Headers(), items, progress);
- }
- inline Result ClientImpl::Patch(const std::string &path, const Headers &headers,
- const UploadFormDataItems &items,
- UploadProgress progress) {
- const auto &boundary = detail::make_multipart_data_boundary();
- const auto &content_type =
- detail::serialize_multipart_formdata_get_content_type(boundary);
- auto content_length = detail::get_multipart_content_length(items, boundary);
- return Patch(path, headers, content_length,
- detail::make_multipart_content_provider(items, boundary),
- content_type, progress);
- }
- inline Result ClientImpl::Patch(const std::string &path, const Headers &headers,
- const UploadFormDataItems &items,
- const std::string &boundary,
- UploadProgress progress) {
- if (!detail::is_multipart_boundary_chars_valid(boundary)) {
- return Result{nullptr, Error::UnsupportedMultipartBoundaryChars};
- }
- const auto &content_type =
- detail::serialize_multipart_formdata_get_content_type(boundary);
- auto content_length = detail::get_multipart_content_length(items, boundary);
- return Patch(path, headers, content_length,
- detail::make_multipart_content_provider(items, boundary),
- content_type, progress);
- }
- inline Result ClientImpl::Patch(const std::string &path, const Headers &headers,
- const char *body, size_t content_length,
- const std::string &content_type,
- UploadProgress progress) {
- return send_with_content_provider_and_receiver(
- "PATCH", path, headers, body, content_length, nullptr, nullptr,
- content_type, nullptr, progress);
- }
- inline Result ClientImpl::Patch(const std::string &path, const Headers &headers,
- const std::string &body,
- const std::string &content_type,
- UploadProgress progress) {
- return send_with_content_provider_and_receiver(
- "PATCH", path, headers, body.data(), body.size(), nullptr, nullptr,
- content_type, nullptr, progress);
- }
- inline Result ClientImpl::Patch(const std::string &path, const Headers &headers,
- size_t content_length,
- ContentProvider content_provider,
- const std::string &content_type,
- UploadProgress progress) {
- return send_with_content_provider_and_receiver(
- "PATCH", path, headers, nullptr, content_length,
- std::move(content_provider), nullptr, content_type, nullptr, progress);
- }
- inline Result ClientImpl::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) {
- return send_with_content_provider_and_receiver(
- "PATCH", path, headers, nullptr, content_length,
- std::move(content_provider), nullptr, content_type,
- std::move(content_receiver), progress);
- }
- inline Result ClientImpl::Patch(const std::string &path, const Headers &headers,
- ContentProviderWithoutLength content_provider,
- const std::string &content_type,
- UploadProgress progress) {
- return send_with_content_provider_and_receiver(
- "PATCH", path, headers, nullptr, 0, nullptr, std::move(content_provider),
- content_type, nullptr, progress);
- }
- inline Result ClientImpl::Patch(const std::string &path, const Headers &headers,
- ContentProviderWithoutLength content_provider,
- const std::string &content_type,
- ContentReceiver content_receiver,
- UploadProgress progress) {
- return send_with_content_provider_and_receiver(
- "PATCH", path, headers, nullptr, 0, nullptr, std::move(content_provider),
- content_type, std::move(content_receiver), progress);
- }
- inline Result ClientImpl::Patch(const std::string &path, const Headers &headers,
- const UploadFormDataItems &items,
- const FormDataProviderItems &provider_items,
- UploadProgress progress) {
- const auto &boundary = detail::make_multipart_data_boundary();
- const auto &content_type =
- detail::serialize_multipart_formdata_get_content_type(boundary);
- return send_with_content_provider_and_receiver(
- "PATCH", path, headers, nullptr, 0, nullptr,
- get_multipart_content_provider(boundary, items, provider_items),
- content_type, nullptr, progress);
- }
- inline Result ClientImpl::Patch(const std::string &path, const Headers &headers,
- const std::string &body,
- const std::string &content_type,
- ContentReceiver content_receiver,
- DownloadProgress progress) {
- Request req;
- req.method = "PATCH";
- req.path = path;
- req.headers = headers;
- req.body = body;
- req.content_receiver =
- [content_receiver](const char *data, size_t data_length,
- size_t /*offset*/, size_t /*total_length*/) {
- return content_receiver(data, data_length);
- };
- req.download_progress = std::move(progress);
- if (max_timeout_msec_ > 0) {
- req.start_time_ = std::chrono::steady_clock::now();
- }
- if (!content_type.empty()) { req.set_header("Content-Type", content_type); }
- return send_(std::move(req));
- }
- inline Result ClientImpl::Delete(const std::string &path,
- DownloadProgress progress) {
- return Delete(path, Headers(), std::string(), std::string(), progress);
- }
- inline Result ClientImpl::Delete(const std::string &path,
- const Headers &headers,
- DownloadProgress progress) {
- return Delete(path, headers, std::string(), std::string(), progress);
- }
- inline Result ClientImpl::Delete(const std::string &path, const char *body,
- size_t content_length,
- const std::string &content_type,
- DownloadProgress progress) {
- return Delete(path, Headers(), body, content_length, content_type, progress);
- }
- inline Result ClientImpl::Delete(const std::string &path,
- const std::string &body,
- const std::string &content_type,
- DownloadProgress progress) {
- return Delete(path, Headers(), body.data(), body.size(), content_type,
- progress);
- }
- inline Result ClientImpl::Delete(const std::string &path,
- const Headers &headers,
- const std::string &body,
- const std::string &content_type,
- DownloadProgress progress) {
- return Delete(path, headers, body.data(), body.size(), content_type,
- progress);
- }
- inline Result ClientImpl::Delete(const std::string &path, const Params ¶ms,
- DownloadProgress progress) {
- return Delete(path, Headers(), params, progress);
- }
- inline Result ClientImpl::Delete(const std::string &path,
- const Headers &headers, const Params ¶ms,
- DownloadProgress progress) {
- auto query = detail::params_to_query_str(params);
- return Delete(path, headers, query, "application/x-www-form-urlencoded",
- progress);
- }
- inline Result ClientImpl::Delete(const std::string &path,
- const Headers &headers, const char *body,
- size_t content_length,
- const std::string &content_type,
- DownloadProgress progress) {
- Request req;
- req.method = "DELETE";
- req.headers = headers;
- req.path = path;
- req.download_progress = std::move(progress);
- if (max_timeout_msec_ > 0) {
- req.start_time_ = std::chrono::steady_clock::now();
- }
- if (!content_type.empty()) { req.set_header("Content-Type", content_type); }
- req.body.assign(body, content_length);
- return send_(std::move(req));
- }
- inline Result ClientImpl::Options(const std::string &path) {
- return Options(path, Headers());
- }
- inline Result ClientImpl::Options(const std::string &path,
- const Headers &headers) {
- Request req;
- req.method = "OPTIONS";
- req.headers = headers;
- req.path = path;
- if (max_timeout_msec_ > 0) {
- req.start_time_ = std::chrono::steady_clock::now();
- }
- return send_(std::move(req));
- }
- inline void ClientImpl::stop() {
- std::lock_guard<std::mutex> guard(socket_mutex_);
- // If there is anything ongoing right now, the ONLY thread-safe thing we can
- // do is to shutdown_socket, so that threads using this socket suddenly
- // discover they can't read/write any more and error out. Everything else
- // (closing the socket, shutting ssl down) is unsafe because these actions
- // are not thread-safe.
- if (socket_requests_in_flight_ > 0) {
- shutdown_socket(socket_);
- // Aside from that, we set a flag for the socket to be closed when we're
- // done.
- socket_should_be_closed_when_request_is_done_ = true;
- return;
- }
- disconnect(/*gracefully=*/true);
- }
- inline std::string ClientImpl::host() const { return host_; }
- inline int ClientImpl::port() const { return port_; }
- inline size_t ClientImpl::is_socket_open() const {
- std::lock_guard<std::mutex> guard(socket_mutex_);
- return socket_.is_open();
- }
- inline socket_t ClientImpl::socket() const { return socket_.sock; }
- inline void ClientImpl::set_connection_timeout(time_t sec, time_t usec) {
- connection_timeout_sec_ = sec;
- connection_timeout_usec_ = usec;
- }
- inline void ClientImpl::set_read_timeout(time_t sec, time_t usec) {
- read_timeout_sec_ = sec;
- read_timeout_usec_ = usec;
- }
- inline void ClientImpl::set_write_timeout(time_t sec, time_t usec) {
- write_timeout_sec_ = sec;
- write_timeout_usec_ = usec;
- }
- inline void ClientImpl::set_max_timeout(time_t msec) {
- max_timeout_msec_ = msec;
- }
- inline void ClientImpl::set_basic_auth(const std::string &username,
- const std::string &password) {
- basic_auth_username_ = username;
- basic_auth_password_ = password;
- }
- inline void ClientImpl::set_bearer_token_auth(const std::string &token) {
- bearer_token_auth_token_ = token;
- }
- inline void ClientImpl::set_keep_alive(bool on) { keep_alive_ = on; }
- inline void ClientImpl::set_follow_location(bool on) { follow_location_ = on; }
- inline void ClientImpl::set_path_encode(bool on) { path_encode_ = on; }
- inline void
- ClientImpl::set_hostname_addr_map(std::map<std::string, std::string> addr_map) {
- addr_map_ = std::move(addr_map);
- }
- inline void ClientImpl::set_default_headers(Headers headers) {
- default_headers_ = std::move(headers);
- }
- inline void ClientImpl::set_header_writer(
- std::function<ssize_t(Stream &, Headers &)> const &writer) {
- header_writer_ = writer;
- }
- inline void ClientImpl::set_address_family(int family) {
- address_family_ = family;
- }
- inline void ClientImpl::set_tcp_nodelay(bool on) { tcp_nodelay_ = on; }
- inline void ClientImpl::set_ipv6_v6only(bool on) { ipv6_v6only_ = on; }
- inline void ClientImpl::set_socket_options(SocketOptions socket_options) {
- socket_options_ = std::move(socket_options);
- }
- inline void ClientImpl::set_compress(bool on) { compress_ = on; }
- inline void ClientImpl::set_decompress(bool on) { decompress_ = on; }
- inline void ClientImpl::set_payload_max_length(size_t length) {
- payload_max_length_ = length;
- has_payload_max_length_ = true;
- }
- inline void ClientImpl::set_interface(const std::string &intf) {
- interface_ = intf;
- }
- inline void ClientImpl::set_proxy(const std::string &host, int port) {
- proxy_host_ = host;
- proxy_port_ = port;
- std::lock_guard<std::mutex> guard(socket_mutex_);
- disconnect(/*gracefully=*/true);
- }
- inline void ClientImpl::set_proxy_basic_auth(const std::string &username,
- const std::string &password) {
- proxy_basic_auth_username_ = username;
- proxy_basic_auth_password_ = password;
- }
- inline void ClientImpl::set_proxy_bearer_token_auth(const std::string &token) {
- proxy_bearer_token_auth_token_ = token;
- }
- inline void ClientImpl::set_no_proxy(const std::vector<std::string> &patterns) {
- std::vector<detail::NoProxyEntry> parsed;
- parsed.reserve(patterns.size());
- for (const auto &p : patterns) {
- auto trimmed = detail::trim_copy(p);
- if (trimmed.empty()) { continue; }
- detail::NoProxyEntry entry;
- if (detail::parse_no_proxy_entry(trimmed, entry)) {
- parsed.push_back(std::move(entry));
- }
- }
- no_proxy_entries_ = std::move(parsed);
- std::lock_guard<std::mutex> guard(socket_mutex_);
- disconnect(/*gracefully=*/true);
- }
- #ifdef CPPHTTPLIB_SSL_ENABLED
- inline void ClientImpl::set_digest_auth(const std::string &username,
- const std::string &password) {
- digest_auth_username_ = username;
- digest_auth_password_ = password;
- }
- inline void ClientImpl::set_ca_cert_path(const std::string &ca_cert_file_path,
- const std::string &ca_cert_dir_path) {
- ca_cert_file_path_ = ca_cert_file_path;
- ca_cert_dir_path_ = ca_cert_dir_path;
- }
- inline void ClientImpl::set_proxy_digest_auth(const std::string &username,
- const std::string &password) {
- proxy_digest_auth_username_ = username;
- proxy_digest_auth_password_ = password;
- }
- inline void ClientImpl::enable_server_certificate_verification(bool enabled) {
- server_certificate_verification_ = enabled;
- }
- inline void ClientImpl::enable_server_hostname_verification(bool enabled) {
- server_hostname_verification_ = enabled;
- }
- inline void ClientImpl::enable_system_ca(bool enabled) {
- system_ca_mode_ = enabled ? SystemCAMode::Enabled : SystemCAMode::Disabled;
- }
- #endif
- inline void ClientImpl::set_logger(Logger logger) {
- logger_ = std::move(logger);
- }
- inline void ClientImpl::set_error_logger(ErrorLogger error_logger) {
- error_logger_ = std::move(error_logger);
- }
- /*
- * SSL/TLS Common Implementation
- */
- inline ClientConnection::~ClientConnection() {
- #ifdef CPPHTTPLIB_SSL_ENABLED
- if (session) {
- tls::shutdown(session, true);
- tls::free_session(session);
- session = nullptr;
- }
- #endif
- if (sock != INVALID_SOCKET) {
- detail::close_socket(sock);
- sock = INVALID_SOCKET;
- }
- }
- // Universal client implementation
- inline Client::Client(const std::string &scheme_host_port)
- : Client(scheme_host_port, std::string(), std::string()) {}
- inline Client::Client(const std::string &scheme_host_port,
- const std::string &client_cert_path,
- const std::string &client_key_path) {
- detail::UrlComponents uc;
- if (detail::parse_url(scheme_host_port, uc) && !uc.host.empty()) {
- auto &scheme = uc.scheme;
- #ifdef CPPHTTPLIB_SSL_ENABLED
- if (!scheme.empty() && (scheme != "http" && scheme != "https")) {
- #else
- if (!scheme.empty() && scheme != "http") {
- #endif
- #ifndef CPPHTTPLIB_NO_EXCEPTIONS
- std::string msg = "'" + scheme + "' scheme is not supported.";
- throw std::invalid_argument(msg);
- #endif
- return;
- }
- auto is_ssl = scheme == "https";
- auto host = std::move(uc.host);
- auto port = is_ssl ? 443 : 80;
- if (!uc.port.empty() && !detail::parse_port(uc.port, port)) { return; }
- if (is_ssl) {
- #ifdef CPPHTTPLIB_SSL_ENABLED
- cli_ = detail::make_unique<SSLClient>(host, port, client_cert_path,
- client_key_path);
- is_ssl_ = is_ssl;
- #endif
- } else {
- cli_ = detail::make_unique<ClientImpl>(host, port, client_cert_path,
- client_key_path);
- }
- } else {
- // NOTE: Update TEST(UniversalClientImplTest, Ipv6LiteralAddress)
- // if port param below changes.
- cli_ = detail::make_unique<ClientImpl>(scheme_host_port, 80,
- client_cert_path, client_key_path);
- }
- }
- inline Client::Client(const std::string &host, int port)
- : Client(host, port, std::string(), std::string()) {}
- inline Client::Client(const std::string &host, int port,
- const std::string &client_cert_path,
- const std::string &client_key_path)
- : cli_(detail::make_unique<ClientImpl>(host, port, client_cert_path,
- client_key_path)) {}
- inline Client::~Client() = default;
- inline bool Client::is_valid() const {
- return cli_ != nullptr && cli_->is_valid();
- }
- inline Result Client::Get(const std::string &path, DownloadProgress progress) {
- return cli_->Get(path, std::move(progress));
- }
- inline Result Client::Get(const std::string &path, const Headers &headers,
- DownloadProgress progress) {
- return cli_->Get(path, headers, std::move(progress));
- }
- inline Result Client::Get(const std::string &path,
- ContentReceiver content_receiver,
- DownloadProgress progress) {
- return cli_->Get(path, std::move(content_receiver), std::move(progress));
- }
- inline Result Client::Get(const std::string &path, const Headers &headers,
- ContentReceiver content_receiver,
- DownloadProgress progress) {
- return cli_->Get(path, headers, std::move(content_receiver),
- std::move(progress));
- }
- inline Result Client::Get(const std::string &path,
- ResponseHandler response_handler,
- ContentReceiver content_receiver,
- DownloadProgress progress) {
- return cli_->Get(path, std::move(response_handler),
- std::move(content_receiver), std::move(progress));
- }
- inline Result Client::Get(const std::string &path, const Headers &headers,
- ResponseHandler response_handler,
- ContentReceiver content_receiver,
- DownloadProgress progress) {
- return cli_->Get(path, headers, std::move(response_handler),
- std::move(content_receiver), std::move(progress));
- }
- inline Result Client::Get(const std::string &path, const Params ¶ms,
- DownloadProgress progress) {
- return cli_->Get(path, params, std::move(progress));
- }
- inline Result Client::Get(const std::string &path, const Params ¶ms,
- const Headers &headers, DownloadProgress progress) {
- return cli_->Get(path, params, headers, std::move(progress));
- }
- inline Result Client::Get(const std::string &path, const Params ¶ms,
- const Headers &headers,
- ContentReceiver content_receiver,
- DownloadProgress progress) {
- return cli_->Get(path, params, headers, std::move(content_receiver),
- std::move(progress));
- }
- inline Result Client::Get(const std::string &path, const Params ¶ms,
- const Headers &headers,
- ResponseHandler response_handler,
- ContentReceiver content_receiver,
- DownloadProgress progress) {
- return cli_->Get(path, params, headers, std::move(response_handler),
- std::move(content_receiver), std::move(progress));
- }
- inline Result Client::Head(const std::string &path) { return cli_->Head(path); }
- inline Result Client::Head(const std::string &path, const Headers &headers) {
- return cli_->Head(path, headers);
- }
- inline Result Client::Post(const std::string &path) { return cli_->Post(path); }
- inline Result Client::Post(const std::string &path, const Headers &headers) {
- return cli_->Post(path, headers);
- }
- inline Result Client::Post(const std::string &path, const char *body,
- size_t content_length,
- const std::string &content_type,
- UploadProgress progress) {
- return cli_->Post(path, body, content_length, content_type, progress);
- }
- inline Result Client::Post(const std::string &path, const Headers &headers,
- const char *body, size_t content_length,
- const std::string &content_type,
- UploadProgress progress) {
- return cli_->Post(path, headers, body, content_length, content_type,
- progress);
- }
- inline Result Client::Post(const std::string &path, const std::string &body,
- const std::string &content_type,
- UploadProgress progress) {
- return cli_->Post(path, body, content_type, progress);
- }
- inline Result Client::Post(const std::string &path, const Headers &headers,
- const std::string &body,
- const std::string &content_type,
- UploadProgress progress) {
- return cli_->Post(path, headers, body, content_type, progress);
- }
- inline Result Client::Post(const std::string &path, size_t content_length,
- ContentProvider content_provider,
- const std::string &content_type,
- UploadProgress progress) {
- return cli_->Post(path, content_length, std::move(content_provider),
- content_type, progress);
- }
- inline Result Client::Post(const std::string &path, size_t content_length,
- ContentProvider content_provider,
- const std::string &content_type,
- ContentReceiver content_receiver,
- UploadProgress progress) {
- return cli_->Post(path, content_length, std::move(content_provider),
- content_type, std::move(content_receiver), progress);
- }
- inline Result Client::Post(const std::string &path,
- ContentProviderWithoutLength content_provider,
- const std::string &content_type,
- UploadProgress progress) {
- return cli_->Post(path, std::move(content_provider), content_type, progress);
- }
- inline Result Client::Post(const std::string &path,
- ContentProviderWithoutLength content_provider,
- const std::string &content_type,
- ContentReceiver content_receiver,
- UploadProgress progress) {
- return cli_->Post(path, std::move(content_provider), content_type,
- std::move(content_receiver), progress);
- }
- inline Result Client::Post(const std::string &path, const Headers &headers,
- size_t content_length,
- ContentProvider content_provider,
- const std::string &content_type,
- UploadProgress progress) {
- return cli_->Post(path, headers, content_length, std::move(content_provider),
- content_type, progress);
- }
- inline Result Client::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) {
- return cli_->Post(path, headers, content_length, std::move(content_provider),
- content_type, std::move(content_receiver), progress);
- }
- inline Result Client::Post(const std::string &path, const Headers &headers,
- ContentProviderWithoutLength content_provider,
- const std::string &content_type,
- UploadProgress progress) {
- return cli_->Post(path, headers, std::move(content_provider), content_type,
- progress);
- }
- inline Result Client::Post(const std::string &path, const Headers &headers,
- ContentProviderWithoutLength content_provider,
- const std::string &content_type,
- ContentReceiver content_receiver,
- DownloadProgress progress) {
- return cli_->Post(path, headers, std::move(content_provider), content_type,
- std::move(content_receiver), progress);
- }
- inline Result Client::Post(const std::string &path, const Params ¶ms) {
- return cli_->Post(path, params);
- }
- inline Result Client::Post(const std::string &path, const Headers &headers,
- const Params ¶ms) {
- return cli_->Post(path, headers, params);
- }
- inline Result Client::Post(const std::string &path,
- const UploadFormDataItems &items,
- UploadProgress progress) {
- return cli_->Post(path, items, progress);
- }
- inline Result Client::Post(const std::string &path, const Headers &headers,
- const UploadFormDataItems &items,
- UploadProgress progress) {
- return cli_->Post(path, headers, items, progress);
- }
- inline Result Client::Post(const std::string &path, const Headers &headers,
- const UploadFormDataItems &items,
- const std::string &boundary,
- UploadProgress progress) {
- return cli_->Post(path, headers, items, boundary, progress);
- }
- inline Result Client::Post(const std::string &path, const Headers &headers,
- const UploadFormDataItems &items,
- const FormDataProviderItems &provider_items,
- UploadProgress progress) {
- return cli_->Post(path, headers, items, provider_items, progress);
- }
- inline Result Client::Post(const std::string &path, const Headers &headers,
- const std::string &body,
- const std::string &content_type,
- ContentReceiver content_receiver,
- DownloadProgress progress) {
- return cli_->Post(path, headers, body, content_type,
- std::move(content_receiver), progress);
- }
- inline Result Client::Put(const std::string &path) { return cli_->Put(path); }
- inline Result Client::Put(const std::string &path, const Headers &headers) {
- return cli_->Put(path, headers);
- }
- inline Result Client::Put(const std::string &path, const char *body,
- size_t content_length,
- const std::string &content_type,
- UploadProgress progress) {
- return cli_->Put(path, body, content_length, content_type, progress);
- }
- inline Result Client::Put(const std::string &path, const Headers &headers,
- const char *body, size_t content_length,
- const std::string &content_type,
- UploadProgress progress) {
- return cli_->Put(path, headers, body, content_length, content_type, progress);
- }
- inline Result Client::Put(const std::string &path, const std::string &body,
- const std::string &content_type,
- UploadProgress progress) {
- return cli_->Put(path, body, content_type, progress);
- }
- inline Result Client::Put(const std::string &path, const Headers &headers,
- const std::string &body,
- const std::string &content_type,
- UploadProgress progress) {
- return cli_->Put(path, headers, body, content_type, progress);
- }
- inline Result Client::Put(const std::string &path, size_t content_length,
- ContentProvider content_provider,
- const std::string &content_type,
- UploadProgress progress) {
- return cli_->Put(path, content_length, std::move(content_provider),
- content_type, progress);
- }
- inline Result Client::Put(const std::string &path, size_t content_length,
- ContentProvider content_provider,
- const std::string &content_type,
- ContentReceiver content_receiver,
- UploadProgress progress) {
- return cli_->Put(path, content_length, std::move(content_provider),
- content_type, std::move(content_receiver), progress);
- }
- inline Result Client::Put(const std::string &path,
- ContentProviderWithoutLength content_provider,
- const std::string &content_type,
- UploadProgress progress) {
- return cli_->Put(path, std::move(content_provider), content_type, progress);
- }
- inline Result Client::Put(const std::string &path,
- ContentProviderWithoutLength content_provider,
- const std::string &content_type,
- ContentReceiver content_receiver,
- UploadProgress progress) {
- return cli_->Put(path, std::move(content_provider), content_type,
- std::move(content_receiver), progress);
- }
- inline Result Client::Put(const std::string &path, const Headers &headers,
- size_t content_length,
- ContentProvider content_provider,
- const std::string &content_type,
- UploadProgress progress) {
- return cli_->Put(path, headers, content_length, std::move(content_provider),
- content_type, progress);
- }
- inline Result Client::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) {
- return cli_->Put(path, headers, content_length, std::move(content_provider),
- content_type, std::move(content_receiver), progress);
- }
- inline Result Client::Put(const std::string &path, const Headers &headers,
- ContentProviderWithoutLength content_provider,
- const std::string &content_type,
- UploadProgress progress) {
- return cli_->Put(path, headers, std::move(content_provider), content_type,
- progress);
- }
- inline Result Client::Put(const std::string &path, const Headers &headers,
- ContentProviderWithoutLength content_provider,
- const std::string &content_type,
- ContentReceiver content_receiver,
- UploadProgress progress) {
- return cli_->Put(path, headers, std::move(content_provider), content_type,
- std::move(content_receiver), progress);
- }
- inline Result Client::Put(const std::string &path, const Params ¶ms) {
- return cli_->Put(path, params);
- }
- inline Result Client::Put(const std::string &path, const Headers &headers,
- const Params ¶ms) {
- return cli_->Put(path, headers, params);
- }
- inline Result Client::Put(const std::string &path,
- const UploadFormDataItems &items,
- UploadProgress progress) {
- return cli_->Put(path, items, progress);
- }
- inline Result Client::Put(const std::string &path, const Headers &headers,
- const UploadFormDataItems &items,
- UploadProgress progress) {
- return cli_->Put(path, headers, items, progress);
- }
- inline Result Client::Put(const std::string &path, const Headers &headers,
- const UploadFormDataItems &items,
- const std::string &boundary,
- UploadProgress progress) {
- return cli_->Put(path, headers, items, boundary, progress);
- }
- inline Result Client::Put(const std::string &path, const Headers &headers,
- const UploadFormDataItems &items,
- const FormDataProviderItems &provider_items,
- UploadProgress progress) {
- return cli_->Put(path, headers, items, provider_items, progress);
- }
- inline Result Client::Put(const std::string &path, const Headers &headers,
- const std::string &body,
- const std::string &content_type,
- ContentReceiver content_receiver,
- DownloadProgress progress) {
- return cli_->Put(path, headers, body, content_type, content_receiver,
- progress);
- }
- inline Result Client::Patch(const std::string &path) {
- return cli_->Patch(path);
- }
- inline Result Client::Patch(const std::string &path, const Headers &headers) {
- return cli_->Patch(path, headers);
- }
- inline Result Client::Patch(const std::string &path, const char *body,
- size_t content_length,
- const std::string &content_type,
- UploadProgress progress) {
- return cli_->Patch(path, body, content_length, content_type, progress);
- }
- inline Result Client::Patch(const std::string &path, const Headers &headers,
- const char *body, size_t content_length,
- const std::string &content_type,
- UploadProgress progress) {
- return cli_->Patch(path, headers, body, content_length, content_type,
- progress);
- }
- inline Result Client::Patch(const std::string &path, const std::string &body,
- const std::string &content_type,
- UploadProgress progress) {
- return cli_->Patch(path, body, content_type, progress);
- }
- inline Result Client::Patch(const std::string &path, const Headers &headers,
- const std::string &body,
- const std::string &content_type,
- UploadProgress progress) {
- return cli_->Patch(path, headers, body, content_type, progress);
- }
- inline Result Client::Patch(const std::string &path, size_t content_length,
- ContentProvider content_provider,
- const std::string &content_type,
- UploadProgress progress) {
- return cli_->Patch(path, content_length, std::move(content_provider),
- content_type, progress);
- }
- inline Result Client::Patch(const std::string &path, size_t content_length,
- ContentProvider content_provider,
- const std::string &content_type,
- ContentReceiver content_receiver,
- UploadProgress progress) {
- return cli_->Patch(path, content_length, std::move(content_provider),
- content_type, std::move(content_receiver), progress);
- }
- inline Result Client::Patch(const std::string &path,
- ContentProviderWithoutLength content_provider,
- const std::string &content_type,
- UploadProgress progress) {
- return cli_->Patch(path, std::move(content_provider), content_type, progress);
- }
- inline Result Client::Patch(const std::string &path,
- ContentProviderWithoutLength content_provider,
- const std::string &content_type,
- ContentReceiver content_receiver,
- UploadProgress progress) {
- return cli_->Patch(path, std::move(content_provider), content_type,
- std::move(content_receiver), progress);
- }
- inline Result Client::Patch(const std::string &path, const Headers &headers,
- size_t content_length,
- ContentProvider content_provider,
- const std::string &content_type,
- UploadProgress progress) {
- return cli_->Patch(path, headers, content_length, std::move(content_provider),
- content_type, progress);
- }
- inline Result Client::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) {
- return cli_->Patch(path, headers, content_length, std::move(content_provider),
- content_type, std::move(content_receiver), progress);
- }
- inline Result Client::Patch(const std::string &path, const Headers &headers,
- ContentProviderWithoutLength content_provider,
- const std::string &content_type,
- UploadProgress progress) {
- return cli_->Patch(path, headers, std::move(content_provider), content_type,
- progress);
- }
- inline Result Client::Patch(const std::string &path, const Headers &headers,
- ContentProviderWithoutLength content_provider,
- const std::string &content_type,
- ContentReceiver content_receiver,
- UploadProgress progress) {
- return cli_->Patch(path, headers, std::move(content_provider), content_type,
- std::move(content_receiver), progress);
- }
- inline Result Client::Patch(const std::string &path, const Params ¶ms) {
- return cli_->Patch(path, params);
- }
- inline Result Client::Patch(const std::string &path, const Headers &headers,
- const Params ¶ms) {
- return cli_->Patch(path, headers, params);
- }
- inline Result Client::Patch(const std::string &path,
- const UploadFormDataItems &items,
- UploadProgress progress) {
- return cli_->Patch(path, items, progress);
- }
- inline Result Client::Patch(const std::string &path, const Headers &headers,
- const UploadFormDataItems &items,
- UploadProgress progress) {
- return cli_->Patch(path, headers, items, progress);
- }
- inline Result Client::Patch(const std::string &path, const Headers &headers,
- const UploadFormDataItems &items,
- const std::string &boundary,
- UploadProgress progress) {
- return cli_->Patch(path, headers, items, boundary, progress);
- }
- inline Result Client::Patch(const std::string &path, const Headers &headers,
- const UploadFormDataItems &items,
- const FormDataProviderItems &provider_items,
- UploadProgress progress) {
- return cli_->Patch(path, headers, items, provider_items, progress);
- }
- inline Result Client::Patch(const std::string &path, const Headers &headers,
- const std::string &body,
- const std::string &content_type,
- ContentReceiver content_receiver,
- DownloadProgress progress) {
- return cli_->Patch(path, headers, body, content_type, content_receiver,
- progress);
- }
- inline Result Client::Delete(const std::string &path,
- DownloadProgress progress) {
- return cli_->Delete(path, progress);
- }
- inline Result Client::Delete(const std::string &path, const Headers &headers,
- DownloadProgress progress) {
- return cli_->Delete(path, headers, progress);
- }
- inline Result Client::Delete(const std::string &path, const char *body,
- size_t content_length,
- const std::string &content_type,
- DownloadProgress progress) {
- return cli_->Delete(path, body, content_length, content_type, progress);
- }
- inline Result Client::Delete(const std::string &path, const Headers &headers,
- const char *body, size_t content_length,
- const std::string &content_type,
- DownloadProgress progress) {
- return cli_->Delete(path, headers, body, content_length, content_type,
- progress);
- }
- inline Result Client::Delete(const std::string &path, const std::string &body,
- const std::string &content_type,
- DownloadProgress progress) {
- return cli_->Delete(path, body, content_type, progress);
- }
- inline Result Client::Delete(const std::string &path, const Headers &headers,
- const std::string &body,
- const std::string &content_type,
- DownloadProgress progress) {
- return cli_->Delete(path, headers, body, content_type, progress);
- }
- inline Result Client::Delete(const std::string &path, const Params ¶ms,
- DownloadProgress progress) {
- return cli_->Delete(path, params, progress);
- }
- inline Result Client::Delete(const std::string &path, const Headers &headers,
- const Params ¶ms, DownloadProgress progress) {
- return cli_->Delete(path, headers, params, progress);
- }
- inline Result Client::Options(const std::string &path) {
- return cli_->Options(path);
- }
- inline Result Client::Options(const std::string &path, const Headers &headers) {
- return cli_->Options(path, headers);
- }
- inline ClientImpl::StreamHandle
- Client::open_stream(const std::string &method, const std::string &path,
- const Params ¶ms, const Headers &headers,
- const std::string &body, const std::string &content_type) {
- return cli_->open_stream(method, path, params, headers, body, content_type);
- }
- inline bool Client::send(Request &req, Response &res, Error &error) {
- return cli_->send(req, res, error);
- }
- inline Result Client::send(const Request &req) { return cli_->send(req); }
- inline void Client::stop() { cli_->stop(); }
- inline std::string Client::host() const { return cli_->host(); }
- inline int Client::port() const { return cli_->port(); }
- inline size_t Client::is_socket_open() const { return cli_->is_socket_open(); }
- inline socket_t Client::socket() const { return cli_->socket(); }
- inline void
- Client::set_hostname_addr_map(std::map<std::string, std::string> addr_map) {
- cli_->set_hostname_addr_map(std::move(addr_map));
- }
- inline void Client::set_default_headers(Headers headers) {
- cli_->set_default_headers(std::move(headers));
- }
- inline void Client::set_header_writer(
- std::function<ssize_t(Stream &, Headers &)> const &writer) {
- cli_->set_header_writer(writer);
- }
- inline void Client::set_address_family(int family) {
- cli_->set_address_family(family);
- }
- inline void Client::set_tcp_nodelay(bool on) { cli_->set_tcp_nodelay(on); }
- inline void Client::set_socket_options(SocketOptions socket_options) {
- cli_->set_socket_options(std::move(socket_options));
- }
- inline void Client::set_connection_timeout(time_t sec, time_t usec) {
- cli_->set_connection_timeout(sec, usec);
- }
- inline void Client::set_read_timeout(time_t sec, time_t usec) {
- cli_->set_read_timeout(sec, usec);
- }
- inline void Client::set_write_timeout(time_t sec, time_t usec) {
- cli_->set_write_timeout(sec, usec);
- }
- inline void Client::set_basic_auth(const std::string &username,
- const std::string &password) {
- cli_->set_basic_auth(username, password);
- }
- inline void Client::set_bearer_token_auth(const std::string &token) {
- cli_->set_bearer_token_auth(token);
- }
- inline void Client::set_keep_alive(bool on) { cli_->set_keep_alive(on); }
- inline void Client::set_follow_location(bool on) {
- cli_->set_follow_location(on);
- }
- inline void Client::set_path_encode(bool on) { cli_->set_path_encode(on); }
- inline void Client::set_compress(bool on) { cli_->set_compress(on); }
- inline void Client::set_decompress(bool on) { cli_->set_decompress(on); }
- inline void Client::set_payload_max_length(size_t length) {
- cli_->set_payload_max_length(length);
- }
- inline void Client::set_interface(const std::string &intf) {
- cli_->set_interface(intf);
- }
- inline void Client::set_proxy(const std::string &host, int port) {
- cli_->set_proxy(host, port);
- }
- inline void Client::set_proxy_basic_auth(const std::string &username,
- const std::string &password) {
- cli_->set_proxy_basic_auth(username, password);
- }
- inline void Client::set_proxy_bearer_token_auth(const std::string &token) {
- cli_->set_proxy_bearer_token_auth(token);
- }
- inline void Client::set_no_proxy(const std::vector<std::string> &patterns) {
- cli_->set_no_proxy(patterns);
- }
- inline void Client::set_logger(Logger logger) {
- cli_->set_logger(std::move(logger));
- }
- inline void Client::set_error_logger(ErrorLogger error_logger) {
- cli_->set_error_logger(std::move(error_logger));
- }
- /*
- * Group 6: SSL Server and Client implementation
- */
- #ifdef CPPHTTPLIB_SSL_ENABLED
- // SSL HTTP server implementation
- inline SSLServer::SSLServer(const char *cert_path, const char *private_key_path,
- const char *client_ca_cert_file_path,
- const char *client_ca_cert_dir_path,
- const char *private_key_password) {
- using namespace tls;
- ctx_ = create_server_context();
- if (!ctx_) { return; }
- // Load server certificate and private key
- if (!set_server_cert_file(ctx_, cert_path, private_key_path,
- private_key_password)) {
- last_ssl_error_ = static_cast<int>(get_error());
- free_context(ctx_);
- ctx_ = nullptr;
- return;
- }
- // Load client CA certificates for client authentication
- if (client_ca_cert_file_path || client_ca_cert_dir_path) {
- if (!set_client_ca_file(ctx_, client_ca_cert_file_path,
- client_ca_cert_dir_path)) {
- last_ssl_error_ = static_cast<int>(get_error());
- free_context(ctx_);
- ctx_ = nullptr;
- return;
- }
- // Enable client certificate verification
- set_verify_client(ctx_, true);
- }
- }
- inline SSLServer::SSLServer(const PemMemory &pem) {
- using namespace tls;
- ctx_ = create_server_context();
- if (ctx_) {
- if (!set_server_cert_pem(ctx_, pem.cert_pem, pem.key_pem,
- pem.private_key_password)) {
- last_ssl_error_ = static_cast<int>(get_error());
- free_context(ctx_);
- ctx_ = nullptr;
- } else if (pem.client_ca_pem && pem.client_ca_pem_len > 0) {
- if (!load_ca_pem(ctx_, pem.client_ca_pem, pem.client_ca_pem_len)) {
- last_ssl_error_ = static_cast<int>(get_error());
- free_context(ctx_);
- ctx_ = nullptr;
- } else {
- set_verify_client(ctx_, true);
- }
- }
- }
- }
- inline SSLServer::SSLServer(const tls::ContextSetupCallback &setup_callback) {
- using namespace tls;
- ctx_ = create_server_context();
- if (ctx_) {
- if (!setup_callback(ctx_)) {
- free_context(ctx_);
- ctx_ = nullptr;
- }
- }
- }
- inline SSLServer::~SSLServer() {
- if (ctx_) { tls::free_context(ctx_); }
- }
- inline bool SSLServer::is_valid() const { return ctx_ != nullptr; }
- inline bool SSLServer::process_and_close_socket(socket_t sock) {
- using namespace tls;
- // Create TLS session with mutex protection
- session_t session = nullptr;
- {
- std::lock_guard<std::mutex> guard(ctx_mutex_);
- session = create_session(static_cast<ctx_t>(ctx_), sock);
- }
- if (!session) {
- last_ssl_error_ = static_cast<int>(get_error());
- detail::shutdown_socket(sock);
- detail::close_socket(sock);
- return false;
- }
- // Use scope_exit to ensure cleanup on all paths (including exceptions)
- bool handshake_done = false;
- bool ret = false;
- bool websocket_upgraded = false;
- auto cleanup = detail::scope_exit([&] {
- if (handshake_done) { shutdown(session, !websocket_upgraded && ret); }
- free_session(session);
- detail::shutdown_socket(sock);
- detail::close_socket(sock);
- });
- // Perform TLS accept handshake with timeout
- TlsError tls_err;
- if (!accept_nonblocking(session, sock, read_timeout_sec_, read_timeout_usec_,
- &tls_err)) {
- #ifdef CPPHTTPLIB_OPENSSL_SUPPORT
- // Map TlsError to legacy ssl_error for backward compatibility
- if (tls_err.code == ErrorCode::WantRead) {
- last_ssl_error_ = SSL_ERROR_WANT_READ;
- } else if (tls_err.code == ErrorCode::WantWrite) {
- last_ssl_error_ = SSL_ERROR_WANT_WRITE;
- } else {
- last_ssl_error_ = SSL_ERROR_SSL;
- }
- #else
- last_ssl_error_ = static_cast<int>(get_error());
- #endif
- return false;
- }
- handshake_done = true;
- std::string remote_addr;
- int remote_port = 0;
- detail::get_remote_ip_and_port(sock, remote_addr, remote_port);
- std::string local_addr;
- int local_port = 0;
- detail::get_local_ip_and_port(sock, local_addr, local_port);
- ret = detail::process_server_socket_ssl(
- svr_sock_, session, sock, keep_alive_max_count_, keep_alive_timeout_sec_,
- read_timeout_sec_, read_timeout_usec_, write_timeout_sec_,
- write_timeout_usec_,
- [&](Stream &strm, bool close_connection, bool &connection_closed) {
- return process_request(
- strm, remote_addr, remote_port, local_addr, local_port,
- close_connection, connection_closed,
- [&](Request &req) { req.ssl = session; }, &websocket_upgraded);
- });
- return ret;
- }
- inline bool SSLServer::update_certs_pem(const char *cert_pem,
- const char *key_pem,
- const char *client_ca_pem,
- const char *password) {
- if (!ctx_) { return false; }
- std::lock_guard<std::mutex> guard(ctx_mutex_);
- if (!tls::update_server_cert(ctx_, cert_pem, key_pem, password)) {
- return false;
- }
- if (client_ca_pem) {
- return tls::update_server_client_ca(ctx_, client_ca_pem);
- }
- return true;
- }
- // SSL HTTP client implementation
- inline SSLClient::~SSLClient() {
- // Make sure to shut down SSL since shutdown_ssl will resolve to the
- // base function rather than the derived function once we get to the
- // base class destructor, and won't free the SSL (causing a leak).
- // This must happen before the context is freed below: some backends
- // (e.g. mbedTLS) have the SSL session borrow a raw pointer into the
- // context, so freeing the context first leaves close_notify reading
- // freed memory.
- shutdown_ssl_impl(socket_, true);
- if (ctx_) {
- tls::free_context(ctx_);
- ctx_ = nullptr;
- }
- }
- inline bool SSLClient::is_valid() const { return ctx_ != nullptr; }
- inline void SSLClient::shutdown_ssl(Socket &socket, bool shutdown_gracefully) {
- shutdown_ssl_impl(socket, shutdown_gracefully);
- }
- inline void SSLClient::shutdown_ssl_impl(Socket &socket,
- bool shutdown_gracefully) {
- if (socket.sock == INVALID_SOCKET) {
- assert(socket.ssl == nullptr);
- return;
- }
- if (socket.ssl) {
- tls::shutdown(socket.ssl, shutdown_gracefully);
- {
- std::lock_guard<std::mutex> guard(ctx_mutex_);
- tls::free_session(socket.ssl);
- }
- socket.ssl = nullptr;
- }
- assert(socket.ssl == nullptr);
- }
- inline bool SSLClient::process_socket(
- const Socket &socket,
- std::chrono::time_point<std::chrono::steady_clock> start_time,
- std::function<bool(Stream &strm)> callback) {
- assert(socket.ssl);
- return detail::process_client_socket_ssl(
- socket.ssl, socket.sock, read_timeout_sec_, read_timeout_usec_,
- write_timeout_sec_, write_timeout_usec_, max_timeout_msec_, start_time,
- std::move(callback));
- }
- inline bool SSLClient::is_ssl() const { return true; }
- inline bool SSLClient::create_and_connect_socket(Socket &socket, Error &error) {
- if (!is_valid()) {
- error = Error::SSLConnection;
- return false;
- }
- return ClientImpl::create_and_connect_socket(socket, error);
- }
- inline bool SSLClient::setup_proxy_connection(
- Socket &socket,
- std::chrono::time_point<std::chrono::steady_clock> start_time,
- Response &res, bool &success, Error &error) {
- if (!is_proxy_enabled_for_host(host_)) { return true; }
- if (!connect_with_proxy(socket, start_time, res, success, error)) {
- return false;
- }
- if (!initialize_ssl(socket, error)) {
- success = false;
- return false;
- }
- return true;
- }
- // Assumes that socket_mutex_ is locked and that there are no requests in
- // flight
- inline bool SSLClient::connect_with_proxy(
- Socket &socket,
- std::chrono::time_point<std::chrono::steady_clock> start_time,
- Response &res, bool &success, Error &error) {
- success = true;
- Response proxy_res;
- if (!detail::process_client_socket(
- socket.sock, read_timeout_sec_, read_timeout_usec_,
- write_timeout_sec_, write_timeout_usec_, max_timeout_msec_,
- start_time, [&](Stream &strm) {
- Request req2;
- req2.method = "CONNECT";
- req2.path =
- detail::make_host_and_port_string_always_port(host_, port_);
- if (max_timeout_msec_ > 0) {
- req2.start_time_ = std::chrono::steady_clock::now();
- }
- return process_request(strm, req2, proxy_res, false, error);
- })) {
- // Thread-safe to close everything because we are assuming there are no
- // requests in flight
- shutdown_ssl(socket, true);
- shutdown_socket(socket);
- close_socket(socket);
- success = false;
- return false;
- }
- if (proxy_res.status == StatusCode::ProxyAuthenticationRequired_407) {
- if (!proxy_digest_auth_username_.empty() &&
- !proxy_digest_auth_password_.empty()) {
- std::map<std::string, std::string> auth;
- if (detail::parse_www_authenticate(proxy_res, auth, true)) {
- // Close the current socket and create a new one for the authenticated
- // request
- shutdown_ssl(socket, true);
- shutdown_socket(socket);
- close_socket(socket);
- // Create a new socket for the authenticated CONNECT request
- if (!ensure_socket_connection(socket, error)) {
- success = false;
- output_error_log(error, nullptr);
- return false;
- }
- proxy_res = Response();
- if (!detail::process_client_socket(
- socket.sock, read_timeout_sec_, read_timeout_usec_,
- write_timeout_sec_, write_timeout_usec_, max_timeout_msec_,
- start_time, [&](Stream &strm) {
- Request req3;
- req3.method = "CONNECT";
- req3.path = detail::make_host_and_port_string_always_port(
- host_, port_);
- req3.headers.insert(detail::make_digest_authentication_header(
- req3, auth, 1, detail::random_string(10),
- proxy_digest_auth_username_, proxy_digest_auth_password_,
- true));
- if (max_timeout_msec_ > 0) {
- req3.start_time_ = std::chrono::steady_clock::now();
- }
- return process_request(strm, req3, proxy_res, false, error);
- })) {
- // Thread-safe to close everything because we are assuming there are
- // no requests in flight
- shutdown_ssl(socket, true);
- shutdown_socket(socket);
- close_socket(socket);
- success = false;
- return false;
- }
- }
- }
- }
- // If status code is not 200, proxy request is failed.
- // Set error to ProxyConnection and return proxy response
- // as the response of the request
- if (proxy_res.status != StatusCode::OK_200) {
- error = Error::ProxyConnection;
- output_error_log(error, nullptr);
- res = std::move(proxy_res);
- // Thread-safe to close everything because we are assuming there are
- // no requests in flight
- shutdown_ssl(socket, true);
- shutdown_socket(socket);
- close_socket(socket);
- return false;
- }
- return true;
- }
- inline bool SSLClient::ensure_socket_connection(Socket &socket, Error &error) {
- if (!ClientImpl::ensure_socket_connection(socket, error)) { return false; }
- if (is_proxy_enabled_for_host(host_)) { return true; }
- if (!initialize_ssl(socket, error)) {
- shutdown_socket(socket);
- close_socket(socket);
- return false;
- }
- return true;
- }
- // SSL HTTP client implementation
- inline SSLClient::SSLClient(const std::string &host)
- : SSLClient(host, 443, std::string(), std::string()) {}
- inline SSLClient::SSLClient(const std::string &host, int port)
- : SSLClient(host, port, std::string(), std::string()) {}
- inline void SSLClient::init_ctx() {
- ctx_ = tls::create_client_context();
- if (ctx_) { tls::set_min_version(ctx_, tls::Version::TLS1_2); }
- }
- inline void SSLClient::reset_ctx_on_error() {
- last_backend_error_ = tls::get_error();
- tls::free_context(ctx_);
- ctx_ = nullptr;
- }
- inline SSLClient::SSLClient(const std::string &host, int port,
- const std::string &client_cert_path,
- const std::string &client_key_path,
- const std::string &private_key_password)
- : ClientImpl(host, port, client_cert_path, client_key_path) {
- init_ctx();
- if (!ctx_) { return; }
- if (!client_cert_path.empty() && !client_key_path.empty()) {
- const char *password =
- private_key_password.empty() ? nullptr : private_key_password.c_str();
- if (!tls::set_client_cert_file(ctx_, client_cert_path.c_str(),
- client_key_path.c_str(), password)) {
- reset_ctx_on_error();
- }
- }
- }
- inline SSLClient::SSLClient(const std::string &host, int port,
- const PemMemory &pem)
- : ClientImpl(host, port) {
- init_ctx();
- if (!ctx_) { return; }
- if (pem.cert_pem && pem.key_pem) {
- if (!tls::set_client_cert_pem(ctx_, pem.cert_pem, pem.key_pem,
- pem.private_key_password)) {
- reset_ctx_on_error();
- }
- }
- }
- inline void SSLClient::set_ca_cert_store(tls::ca_store_t ca_cert_store) {
- if (ca_cert_store && ctx_) {
- // set_ca_store takes ownership of ca_cert_store
- tls::set_ca_store(ctx_, ca_cert_store);
- ca_cert_store_set_ = true;
- } else if (ca_cert_store) {
- tls::free_ca_store(ca_cert_store);
- }
- }
- inline void
- SSLClient::set_server_certificate_verifier(tls::VerifyCallback verifier) {
- if (!ctx_) { return; }
- tls::set_verify_callback(ctx_, verifier);
- }
- inline void SSLClient::set_session_verifier(
- std::function<SSLVerifierResponse(tls::session_t)> verifier) {
- session_verifier_ = std::move(verifier);
- }
- #ifdef CPPHTTPLIB_WINDOWS_AUTOMATIC_ROOT_CERTIFICATES_UPDATE
- inline void SSLClient::enable_windows_certificate_verification(bool enabled) {
- enable_windows_cert_verification_ = enabled;
- }
- #endif
- inline void SSLClient::load_ca_cert_store(const char *ca_cert,
- std::size_t size) {
- if (ctx_ && ca_cert && size > 0) {
- ca_cert_pem_.assign(ca_cert, size); // Store for redirect transfer
- tls::load_ca_pem(ctx_, ca_cert, size);
- }
- }
- inline bool SSLClient::load_certs() {
- auto ret = true;
- // call_once rather than the plain flag WebSocketClient::create_stream() uses:
- // one client is shared across concurrent requests here.
- std::call_once(initialize_cert_, [&]() {
- std::lock_guard<std::mutex> guard(ctx_mutex_);
- ret = detail::load_client_ca_config(
- ctx_, ca_cert_file_path_, ca_cert_dir_path_,
- !ca_cert_pem_.empty() || ca_cert_store_set_, system_ca_mode_,
- last_backend_error_);
- });
- return ret;
- }
- inline bool SSLClient::initialize_ssl(Socket &socket, Error &error) {
- // Load CA certificates if server verification is enabled
- if (server_certificate_verification_) {
- if (!load_certs()) {
- error = Error::SSLLoadingCerts;
- output_error_log(error, nullptr);
- return false;
- }
- }
- detail::ClientTlsSessionOptions options;
- options.server_hostname_verification = server_hostname_verification_;
- options.session_verifier = session_verifier_;
- options.ctx_mutex = &ctx_mutex_;
- #ifdef CPPHTTPLIB_WINDOWS_AUTOMATIC_ROOT_CERTIFICATES_UPDATE
- // Skip Schannel when a custom CA cert is specified, as the Windows
- // certificate store would not know about user-provided CA certificates.
- // Also skip when system CA trust is explicitly disabled.
- options.windows_cert_verification =
- enable_windows_cert_verification_ &&
- system_ca_mode_ != SystemCAMode::Disabled && ca_cert_file_path_.empty() &&
- ca_cert_dir_path_.empty() && ca_cert_pem_.empty() && !ca_cert_store_set_;
- #endif
- tls::session_t session = nullptr;
- // Use scope_exit to ensure session is freed on error paths
- bool success = false;
- auto session_guard = detail::scope_exit([&] {
- if (!success) { tls::free_session(session); }
- });
- detail::ClientTlsSessionError tls_error;
- if (!detail::setup_client_tls_session(
- host_, ctx_, session, socket.sock, server_certificate_verification_,
- connection_timeout_sec_, connection_timeout_usec_, &tls_error,
- options)) {
- error = tls_error.error;
- last_ssl_error_ = tls_error.ssl_error;
- last_backend_error_ = tls_error.backend_error;
- output_error_log(error, nullptr);
- return false;
- }
- success = true;
- socket.ssl = session;
- return true;
- }
- inline void Client::set_digest_auth(const std::string &username,
- const std::string &password) {
- cli_->set_digest_auth(username, password);
- }
- inline void Client::set_proxy_digest_auth(const std::string &username,
- const std::string &password) {
- cli_->set_proxy_digest_auth(username, password);
- }
- inline void Client::enable_server_certificate_verification(bool enabled) {
- cli_->enable_server_certificate_verification(enabled);
- }
- inline void Client::enable_server_hostname_verification(bool enabled) {
- cli_->enable_server_hostname_verification(enabled);
- }
- inline void Client::enable_system_ca(bool enabled) {
- cli_->enable_system_ca(enabled);
- }
- #ifdef CPPHTTPLIB_WINDOWS_AUTOMATIC_ROOT_CERTIFICATES_UPDATE
- inline void Client::enable_windows_certificate_verification(bool enabled) {
- if (is_ssl_) {
- static_cast<SSLClient &>(*cli_).enable_windows_certificate_verification(
- enabled);
- }
- }
- #endif
- inline void Client::set_ca_cert_path(const std::string &ca_cert_file_path,
- const std::string &ca_cert_dir_path) {
- cli_->set_ca_cert_path(ca_cert_file_path, ca_cert_dir_path);
- }
- inline void Client::set_ca_cert_store(tls::ca_store_t ca_cert_store) {
- if (is_ssl_) {
- static_cast<SSLClient &>(*cli_).set_ca_cert_store(ca_cert_store);
- } else if (ca_cert_store) {
- tls::free_ca_store(ca_cert_store);
- }
- }
- inline void Client::load_ca_cert_store(const char *ca_cert, std::size_t size) {
- if (is_ssl_) {
- // Use the PEM-based path so the CA data is retained for redirect transfer
- static_cast<SSLClient &>(*cli_).load_ca_cert_store(ca_cert, size);
- }
- }
- inline void
- Client::set_server_certificate_verifier(tls::VerifyCallback verifier) {
- if (is_ssl_) {
- static_cast<SSLClient &>(*cli_).set_server_certificate_verifier(
- std::move(verifier));
- }
- }
- inline void Client::set_session_verifier(
- std::function<SSLVerifierResponse(tls::session_t)> verifier) {
- if (is_ssl_) {
- static_cast<SSLClient &>(*cli_).set_session_verifier(std::move(verifier));
- }
- }
- inline tls::ctx_t Client::tls_context() const {
- if (is_ssl_) { return static_cast<SSLClient &>(*cli_).tls_context(); }
- return nullptr;
- }
- #endif // CPPHTTPLIB_SSL_ENABLED
- /*
- * Group 7: TLS abstraction layer - Common API
- */
- #ifdef CPPHTTPLIB_SSL_ENABLED
- namespace tls {
- // Helper for PeerCert construction
- inline PeerCert get_peer_cert_from_session(const_session_t session) {
- return PeerCert(get_peer_cert(session));
- }
- namespace impl {
- inline VerifyCallback &get_verify_callback() {
- static thread_local VerifyCallback callback;
- return callback;
- }
- inline VerifyCallback &get_mbedtls_verify_callback() {
- static thread_local VerifyCallback callback;
- return callback;
- }
- // Check if a string is an IPv4 address
- inline bool is_ipv4_address(const std::string &str) {
- int dots = 0;
- for (char c : str) {
- if (c == '.') {
- dots++;
- } else if (!detail::is_ascii_digit(c)) {
- return false;
- }
- }
- return dots == 3;
- }
- // Parse IPv4 address string to bytes
- inline bool parse_ipv4(const std::string &str, unsigned char *out) {
- const char *p = str.c_str();
- for (int i = 0; i < 4; i++) {
- if (i > 0) {
- if (*p != '.') { return false; }
- p++;
- }
- int val = 0;
- int digits = 0;
- while (detail::is_ascii_digit(*p)) {
- val = val * 10 + (*p - '0');
- if (val > 255) { return false; }
- p++;
- digits++;
- }
- if (digits == 0) { return false; }
- // Reject leading zeros (e.g., "01.002.03.04") to prevent ambiguity
- if (digits > 1 && *(p - digits) == '0') { return false; }
- out[i] = static_cast<unsigned char>(val);
- }
- return *p == '\0';
- }
- // Parse an IP literal (IPv4 or IPv6) into raw network-order bytes.
- // `out` must have room for at least 16 bytes. Returns the address length
- // (4 for IPv4, 16 for IPv6) on success, or 0 if the string is not an IP
- // literal. Used to match a host against iPAddress SANs the same way the
- // OpenSSL backend does via X509_check_ip.
- inline size_t parse_ip_address(const std::string &str, unsigned char *out) {
- if (is_ipv4_address(str)) { return parse_ipv4(str, out) ? 4 : 0; }
- struct in6_addr addr6 = {};
- if (inet_pton(AF_INET6, str.c_str(), &addr6) == 1) {
- memcpy(out, &addr6, 16);
- return 16;
- }
- return 0;
- }
- #ifdef _WIN32
- // Enumerate Windows system certificates and call callback with DER data
- template <typename Callback>
- inline bool enumerate_windows_system_certs(Callback cb) {
- bool loaded = false;
- static const wchar_t *store_names[] = {L"ROOT", L"CA"};
- for (auto store_name : store_names) {
- HCERTSTORE hStore = CertOpenSystemStoreW(0, store_name);
- if (hStore) {
- PCCERT_CONTEXT pContext = nullptr;
- while ((pContext = CertEnumCertificatesInStore(hStore, pContext)) !=
- nullptr) {
- if (cb(pContext->pbCertEncoded, pContext->cbCertEncoded)) {
- loaded = true;
- }
- }
- CertCloseStore(hStore, 0);
- }
- }
- return loaded;
- }
- #endif
- #ifdef CPPHTTPLIB_USE_CERTS_FROM_MACOSX_KEYCHAIN
- // Enumerate macOS Keychain certificates and call callback with DER data
- template <typename Callback>
- inline bool enumerate_macos_keychain_certs(Callback cb) {
- bool loaded = false;
- const SecTrustSettingsDomain domains[] = {
- kSecTrustSettingsDomainSystem,
- kSecTrustSettingsDomainAdmin,
- kSecTrustSettingsDomainUser,
- };
- for (auto domain : domains) {
- CFArrayRef certs = nullptr;
- OSStatus status = SecTrustSettingsCopyCertificates(domain, &certs);
- if (status != errSecSuccess || !certs) {
- if (certs) CFRelease(certs);
- continue;
- }
- CFIndex count = CFArrayGetCount(certs);
- for (CFIndex i = 0; i < count; i++) {
- SecCertificateRef cert =
- (SecCertificateRef)CFArrayGetValueAtIndex(certs, i);
- CFDataRef data = SecCertificateCopyData(cert);
- if (data) {
- if (cb(CFDataGetBytePtr(data),
- static_cast<size_t>(CFDataGetLength(data)))) {
- loaded = true;
- }
- CFRelease(data);
- }
- }
- CFRelease(certs);
- }
- return loaded;
- }
- #endif
- #if !defined(_WIN32) && !(defined(__APPLE__) && \
- defined(CPPHTTPLIB_USE_CERTS_FROM_MACOSX_KEYCHAIN))
- // Common CA certificate file paths on Linux/Unix
- inline const char **system_ca_paths() {
- static const char *paths[] = {
- "/etc/ssl/certs/ca-certificates.crt", // Debian/Ubuntu
- "/etc/pki/tls/certs/ca-bundle.crt", // RHEL/CentOS
- "/etc/ssl/ca-bundle.pem", // OpenSUSE
- "/etc/pki/tls/cacert.pem", // OpenELEC
- "/etc/ssl/cert.pem", // Alpine, FreeBSD
- nullptr};
- return paths;
- }
- // Common CA certificate directory paths on Linux/Unix
- inline const char **system_ca_dirs() {
- static const char *dirs[] = {"/etc/ssl/certs", // Debian/Ubuntu
- "/etc/pki/tls/certs", // RHEL/CentOS
- "/usr/share/ca-certificates", // Other
- nullptr};
- return dirs;
- }
- #endif
- } // namespace impl
- inline bool set_client_ca_file(ctx_t ctx, const char *ca_file,
- const char *ca_dir) {
- if (!ctx) { return false; }
- bool success = true;
- if (ca_file && *ca_file) {
- if (!load_ca_file(ctx, ca_file)) { success = false; }
- }
- if (ca_dir && *ca_dir) {
- if (!load_ca_dir(ctx, ca_dir)) { success = false; }
- }
- #ifdef CPPHTTPLIB_OPENSSL_SUPPORT
- // Set CA list for client certificate request (CertificateRequest message)
- if (ca_file && *ca_file) {
- auto list = SSL_load_client_CA_file(ca_file);
- if (list) { SSL_CTX_set_client_CA_list(static_cast<SSL_CTX *>(ctx), list); }
- }
- #endif
- return success;
- }
- inline bool set_server_cert_pem(ctx_t ctx, const char *cert, const char *key,
- const char *password) {
- return set_client_cert_pem(ctx, cert, key, password);
- }
- inline bool set_server_cert_file(ctx_t ctx, const char *cert_path,
- const char *key_path, const char *password) {
- return set_client_cert_file(ctx, cert_path, key_path, password);
- }
- // PeerCert implementation
- inline PeerCert::PeerCert() = default;
- inline PeerCert::PeerCert(cert_t cert) : cert_(cert) {}
- inline PeerCert::PeerCert(PeerCert &&other) noexcept : cert_(other.cert_) {
- other.cert_ = nullptr;
- }
- inline PeerCert &PeerCert::operator=(PeerCert &&other) noexcept {
- if (this != &other) {
- if (cert_) { free_cert(cert_); }
- cert_ = other.cert_;
- other.cert_ = nullptr;
- }
- return *this;
- }
- inline PeerCert::~PeerCert() {
- if (cert_) { free_cert(cert_); }
- }
- inline PeerCert::operator bool() const { return cert_ != nullptr; }
- inline std::string PeerCert::subject_cn() const {
- return cert_ ? get_cert_subject_cn(cert_) : std::string();
- }
- inline std::string PeerCert::issuer_name() const {
- return cert_ ? get_cert_issuer_name(cert_) : std::string();
- }
- inline bool PeerCert::check_hostname(const char *hostname) const {
- return cert_ ? verify_hostname(cert_, hostname) : false;
- }
- inline std::vector<SanEntry> PeerCert::sans() const {
- std::vector<SanEntry> result;
- if (cert_) { get_cert_sans(cert_, result); }
- return result;
- }
- inline bool PeerCert::validity(time_t ¬_before, time_t ¬_after) const {
- return cert_ ? get_cert_validity(cert_, not_before, not_after) : false;
- }
- inline std::string PeerCert::serial() const {
- return cert_ ? get_cert_serial(cert_) : std::string();
- }
- // VerifyContext method implementations
- inline std::string VerifyContext::subject_cn() const {
- return cert ? get_cert_subject_cn(cert) : std::string();
- }
- inline std::string VerifyContext::issuer_name() const {
- return cert ? get_cert_issuer_name(cert) : std::string();
- }
- inline bool VerifyContext::check_hostname(const char *hostname) const {
- return cert ? verify_hostname(cert, hostname) : false;
- }
- inline std::vector<SanEntry> VerifyContext::sans() const {
- std::vector<SanEntry> result;
- if (cert) { get_cert_sans(cert, result); }
- return result;
- }
- inline bool VerifyContext::validity(time_t ¬_before,
- time_t ¬_after) const {
- return cert ? get_cert_validity(cert, not_before, not_after) : false;
- }
- inline std::string VerifyContext::serial() const {
- return cert ? get_cert_serial(cert) : std::string();
- }
- // TlsError static method implementation
- inline std::string TlsError::verify_error_to_string(long error_code) {
- return verify_error_string(error_code);
- }
- } // namespace tls
- // Request::peer_cert() implementation
- inline tls::PeerCert Request::peer_cert() const {
- return tls::get_peer_cert_from_session(ssl);
- }
- // Request::sni() implementation
- inline std::string Request::sni() const {
- if (!ssl) { return std::string(); }
- const char *s = tls::get_sni(ssl);
- return s ? std::string(s) : std::string();
- }
- #endif // CPPHTTPLIB_SSL_ENABLED
- /*
- * Group 8: TLS abstraction layer - OpenSSL backend
- */
- /*
- * OpenSSL Backend Implementation
- */
- #ifdef CPPHTTPLIB_OPENSSL_SUPPORT
- namespace tls {
- namespace impl {
- // Helper to map OpenSSL SSL_get_error to ErrorCode
- inline ErrorCode map_ssl_error(int ssl_error, int &out_errno) {
- switch (ssl_error) {
- case SSL_ERROR_NONE: return ErrorCode::Success;
- case SSL_ERROR_WANT_READ: return ErrorCode::WantRead;
- case SSL_ERROR_WANT_WRITE: return ErrorCode::WantWrite;
- case SSL_ERROR_ZERO_RETURN: return ErrorCode::PeerClosed;
- case SSL_ERROR_SYSCALL: out_errno = errno; return ErrorCode::SyscallError;
- case SSL_ERROR_SSL:
- default: return ErrorCode::Fatal;
- }
- }
- // Helper: Create client CA list from PEM string
- // Returns a new STACK_OF(X509_NAME)* or nullptr on failure
- // Caller takes ownership of returned list
- inline STACK_OF(X509_NAME) *
- create_client_ca_list_from_pem(const char *ca_pem) {
- if (!ca_pem) { return nullptr; }
- auto ca_list = sk_X509_NAME_new_null();
- if (!ca_list) { return nullptr; }
- BIO *bio = BIO_new_mem_buf(ca_pem, -1);
- if (!bio) {
- sk_X509_NAME_pop_free(ca_list, X509_NAME_free);
- return nullptr;
- }
- X509 *cert = nullptr;
- while ((cert = PEM_read_bio_X509(bio, nullptr, nullptr, nullptr)) !=
- nullptr) {
- const X509_NAME *name = X509_get_subject_name(cert);
- if (name) {
- sk_X509_NAME_push(ca_list, X509_NAME_dup(const_cast<X509_NAME *>(name)));
- }
- X509_free(cert);
- }
- BIO_free(bio);
- return ca_list;
- }
- // OpenSSL verify callback wrapper
- inline int openssl_verify_callback(int preverify_ok, X509_STORE_CTX *ctx) {
- auto &callback = get_verify_callback();
- if (!callback) { return preverify_ok; }
- // Get SSL object from X509_STORE_CTX
- auto ssl = static_cast<SSL *>(
- X509_STORE_CTX_get_ex_data(ctx, SSL_get_ex_data_X509_STORE_CTX_idx()));
- if (!ssl) { return preverify_ok; }
- // Get current certificate and depth
- auto cert = X509_STORE_CTX_get_current_cert(ctx);
- int depth = X509_STORE_CTX_get_error_depth(ctx);
- int error = X509_STORE_CTX_get_error(ctx);
- // Build context
- VerifyContext verify_ctx;
- verify_ctx.session = static_cast<session_t>(ssl);
- verify_ctx.cert = static_cast<cert_t>(cert);
- verify_ctx.depth = depth;
- verify_ctx.preverify_ok = (preverify_ok != 0);
- verify_ctx.error_code = error;
- verify_ctx.error_string =
- (error != X509_V_OK) ? X509_verify_cert_error_string(error) : nullptr;
- return callback(verify_ctx) ? 1 : 0;
- }
- // X509_STORE_get0_objects is deprecated since OpenSSL 4.0 because it is not
- // thread-safe; X509_STORE_get1_objects (OpenSSL 3.3+) returns a snapshot
- // that must be released with release_store_objects
- #if !defined(OPENSSL_IS_BORINGSSL) && !defined(LIBRESSL_VERSION_NUMBER) && \
- OPENSSL_VERSION_NUMBER >= 0x30300000L
- #define CPPHTTPLIB_HAS_X509_STORE_GET1_OBJECTS
- #endif
- inline STACK_OF(X509_OBJECT) * get_store_objects(X509_STORE *store) {
- #ifdef CPPHTTPLIB_HAS_X509_STORE_GET1_OBJECTS
- return X509_STORE_get1_objects(store);
- #else
- return X509_STORE_get0_objects(store);
- #endif
- }
- inline void release_store_objects(STACK_OF(X509_OBJECT) * objs) {
- #ifdef CPPHTTPLIB_HAS_X509_STORE_GET1_OBJECTS
- sk_X509_OBJECT_pop_free(objs, X509_OBJECT_free);
- #else
- (void)objs; // get0 variant returns an internal pointer; nothing to free
- #endif
- }
- } // namespace impl
- inline ctx_t create_client_context() {
- SSL_CTX *ctx = SSL_CTX_new(TLS_client_method());
- if (ctx) {
- // Disable auto-retry to properly handle non-blocking I/O
- SSL_CTX_clear_mode(ctx, SSL_MODE_AUTO_RETRY);
- // Set minimum TLS version
- SSL_CTX_set_min_proto_version(ctx, TLS1_2_VERSION);
- }
- return static_cast<ctx_t>(ctx);
- }
- inline void free_context(ctx_t ctx) {
- if (ctx) { SSL_CTX_free(static_cast<SSL_CTX *>(ctx)); }
- }
- inline bool set_min_version(ctx_t ctx, Version version) {
- if (!ctx) return false;
- return SSL_CTX_set_min_proto_version(static_cast<SSL_CTX *>(ctx),
- static_cast<int>(version)) == 1;
- }
- inline bool load_ca_pem(ctx_t ctx, const char *pem, size_t len) {
- if (!ctx || !pem || len == 0) return false;
- auto ssl_ctx = static_cast<SSL_CTX *>(ctx);
- auto store = SSL_CTX_get_cert_store(ssl_ctx);
- if (!store) return false;
- auto bio = BIO_new_mem_buf(pem, static_cast<int>(len));
- if (!bio) return false;
- bool ok = true;
- X509 *cert = nullptr;
- while ((cert = PEM_read_bio_X509(bio, nullptr, nullptr, nullptr)) !=
- nullptr) {
- if (X509_STORE_add_cert(store, cert) != 1) {
- // Ignore duplicate errors
- auto err = ERR_peek_last_error();
- if (ERR_GET_REASON(err) != X509_R_CERT_ALREADY_IN_HASH_TABLE) {
- ok = false;
- }
- }
- X509_free(cert);
- if (!ok) break;
- }
- BIO_free(bio);
- // Clear any "no more certificates" errors
- ERR_clear_error();
- return ok;
- }
- inline bool load_ca_file(ctx_t ctx, const char *file_path) {
- if (!ctx || !file_path) return false;
- return SSL_CTX_load_verify_locations(static_cast<SSL_CTX *>(ctx), file_path,
- nullptr) == 1;
- }
- inline bool load_ca_dir(ctx_t ctx, const char *dir_path) {
- if (!ctx || !dir_path) return false;
- return SSL_CTX_load_verify_locations(static_cast<SSL_CTX *>(ctx), nullptr,
- dir_path) == 1;
- }
- inline bool load_system_certs(ctx_t ctx) {
- if (!ctx) return false;
- auto ssl_ctx = static_cast<SSL_CTX *>(ctx);
- #ifdef _WIN32
- // Windows: Load from system certificate store (ROOT and CA)
- auto store = SSL_CTX_get_cert_store(ssl_ctx);
- if (!store) return false;
- bool loaded_any = false;
- static const wchar_t *store_names[] = {L"ROOT", L"CA"};
- for (auto store_name : store_names) {
- auto hStore = CertOpenSystemStoreW(NULL, store_name);
- if (!hStore) continue;
- PCCERT_CONTEXT pContext = nullptr;
- while ((pContext = CertEnumCertificatesInStore(hStore, pContext)) !=
- nullptr) {
- const unsigned char *data = pContext->pbCertEncoded;
- auto x509 = d2i_X509(nullptr, &data, pContext->cbCertEncoded);
- if (x509) {
- if (X509_STORE_add_cert(store, x509) == 1) { loaded_any = true; }
- X509_free(x509);
- }
- }
- CertCloseStore(hStore, 0);
- }
- return loaded_any;
- #elif defined(__APPLE__)
- #ifdef CPPHTTPLIB_USE_CERTS_FROM_MACOSX_KEYCHAIN
- // macOS: Load from Keychain
- auto store = SSL_CTX_get_cert_store(ssl_ctx);
- if (!store) return false;
- bool loaded_any = false;
- const SecTrustSettingsDomain domains[] = {
- kSecTrustSettingsDomainSystem,
- kSecTrustSettingsDomainAdmin,
- kSecTrustSettingsDomainUser,
- };
- for (auto domain : domains) {
- CFArrayRef certs = nullptr;
- if (SecTrustSettingsCopyCertificates(domain, &certs) != errSecSuccess ||
- !certs) {
- if (certs) CFRelease(certs);
- continue;
- }
- auto count = CFArrayGetCount(certs);
- for (CFIndex i = 0; i < count; i++) {
- auto cert = reinterpret_cast<SecCertificateRef>(
- const_cast<void *>(CFArrayGetValueAtIndex(certs, i)));
- CFDataRef der = SecCertificateCopyData(cert);
- if (der) {
- const unsigned char *data = CFDataGetBytePtr(der);
- auto x509 = d2i_X509(nullptr, &data, CFDataGetLength(der));
- if (x509) {
- if (X509_STORE_add_cert(store, x509) == 1) { loaded_any = true; }
- X509_free(x509);
- }
- CFRelease(der);
- }
- }
- CFRelease(certs);
- }
- return loaded_any || SSL_CTX_set_default_verify_paths(ssl_ctx) == 1;
- #else
- return SSL_CTX_set_default_verify_paths(ssl_ctx) == 1;
- #endif
- #else
- // Other Unix: use default verify paths
- return SSL_CTX_set_default_verify_paths(ssl_ctx) == 1;
- #endif
- }
- inline bool set_client_cert_pem(ctx_t ctx, const char *cert, const char *key,
- const char *password) {
- if (!ctx || !cert || !key) return false;
- auto ssl_ctx = static_cast<SSL_CTX *>(ctx);
- // Load certificate
- auto cert_bio = BIO_new_mem_buf(cert, -1);
- if (!cert_bio) return false;
- auto x509 = PEM_read_bio_X509(cert_bio, nullptr, nullptr, nullptr);
- BIO_free(cert_bio);
- if (!x509) return false;
- auto cert_ok = SSL_CTX_use_certificate(ssl_ctx, x509) == 1;
- X509_free(x509);
- if (!cert_ok) return false;
- // Load private key
- auto key_bio = BIO_new_mem_buf(key, -1);
- if (!key_bio) return false;
- auto pkey = PEM_read_bio_PrivateKey(key_bio, nullptr, nullptr,
- password ? const_cast<char *>(password)
- : nullptr);
- BIO_free(key_bio);
- if (!pkey) return false;
- auto key_ok = SSL_CTX_use_PrivateKey(ssl_ctx, pkey) == 1;
- EVP_PKEY_free(pkey);
- return key_ok && SSL_CTX_check_private_key(ssl_ctx) == 1;
- }
- inline bool set_client_cert_file(ctx_t ctx, const char *cert_path,
- const char *key_path, const char *password) {
- if (!ctx || !cert_path || !key_path) return false;
- auto ssl_ctx = static_cast<SSL_CTX *>(ctx);
- if (password && password[0] != '\0') {
- SSL_CTX_set_default_passwd_cb_userdata(
- ssl_ctx, reinterpret_cast<void *>(const_cast<char *>(password)));
- }
- return SSL_CTX_use_certificate_chain_file(ssl_ctx, cert_path) == 1 &&
- SSL_CTX_use_PrivateKey_file(ssl_ctx, key_path, SSL_FILETYPE_PEM) == 1;
- }
- inline ctx_t create_server_context() {
- SSL_CTX *ctx = SSL_CTX_new(TLS_server_method());
- if (ctx) {
- SSL_CTX_set_options(ctx, SSL_OP_NO_COMPRESSION |
- SSL_OP_NO_SESSION_RESUMPTION_ON_RENEGOTIATION);
- SSL_CTX_set_min_proto_version(ctx, TLS1_2_VERSION);
- }
- return static_cast<ctx_t>(ctx);
- }
- inline void set_verify_client(ctx_t ctx, bool require) {
- if (!ctx) return;
- SSL_CTX_set_verify(static_cast<SSL_CTX *>(ctx),
- require
- ? (SSL_VERIFY_PEER | SSL_VERIFY_FAIL_IF_NO_PEER_CERT)
- : SSL_VERIFY_NONE,
- nullptr);
- }
- inline session_t create_session(ctx_t ctx, socket_t sock) {
- if (!ctx || sock == INVALID_SOCKET) return nullptr;
- auto ssl_ctx = static_cast<SSL_CTX *>(ctx);
- SSL *ssl = SSL_new(ssl_ctx);
- if (!ssl) return nullptr;
- // Disable auto-retry for proper non-blocking I/O handling
- SSL_clear_mode(ssl, SSL_MODE_AUTO_RETRY);
- auto bio = BIO_new_socket(static_cast<int>(sock), BIO_NOCLOSE);
- if (!bio) {
- SSL_free(ssl);
- return nullptr;
- }
- SSL_set_bio(ssl, bio, bio);
- return static_cast<session_t>(ssl);
- }
- inline void free_session(session_t session) {
- if (session) { SSL_free(static_cast<SSL *>(session)); }
- }
- inline bool set_sni(session_t session, const char *hostname,
- bool /*verify_hostname*/) {
- if (!session || !hostname) return false;
- auto ssl = static_cast<SSL *>(session);
- // Set SNI (Server Name Indication) only - does not enable verification.
- // OpenSSL never binds identity checking to SNI (that happens post-
- // handshake in setup_client_tls_session()), so verify_hostname is unused.
- #if defined(OPENSSL_IS_BORINGSSL)
- return SSL_set_tlsext_host_name(ssl, hostname) == 1;
- #else
- // Direct call instead of macro to suppress -Wold-style-cast warning
- return SSL_ctrl(ssl, SSL_CTRL_SET_TLSEXT_HOSTNAME, TLSEXT_NAMETYPE_host_name,
- static_cast<void *>(const_cast<char *>(hostname))) == 1;
- #endif
- }
- inline TlsError connect(session_t session) {
- if (!session) { return TlsError(); }
- auto ssl = static_cast<SSL *>(session);
- auto ret = SSL_connect(ssl);
- TlsError err;
- if (ret == 1) {
- err.code = ErrorCode::Success;
- } else {
- auto ssl_err = SSL_get_error(ssl, ret);
- err.code = impl::map_ssl_error(ssl_err, err.sys_errno);
- err.backend_code = ERR_get_error();
- }
- return err;
- }
- inline TlsError accept(session_t session) {
- if (!session) { return TlsError(); }
- auto ssl = static_cast<SSL *>(session);
- auto ret = SSL_accept(ssl);
- TlsError err;
- if (ret == 1) {
- err.code = ErrorCode::Success;
- } else {
- auto ssl_err = SSL_get_error(ssl, ret);
- err.code = impl::map_ssl_error(ssl_err, err.sys_errno);
- err.backend_code = ERR_get_error();
- }
- return err;
- }
- inline bool connect_nonblocking(session_t session, socket_t sock,
- time_t timeout_sec, time_t timeout_usec,
- TlsError *err) {
- if (!session) {
- if (err) { err->code = ErrorCode::Fatal; }
- return false;
- }
- auto ssl = static_cast<SSL *>(session);
- auto bio = SSL_get_rbio(ssl);
- // Set non-blocking mode for handshake
- detail::set_nonblocking(sock, true);
- if (bio) { BIO_set_nbio(bio, 1); }
- auto cleanup = detail::scope_exit([&]() {
- // Restore blocking mode after handshake
- if (bio) { BIO_set_nbio(bio, 0); }
- detail::set_nonblocking(sock, false);
- });
- auto res = 0;
- while ((res = SSL_connect(ssl)) != 1) {
- auto ssl_err = SSL_get_error(ssl, res);
- switch (ssl_err) {
- case SSL_ERROR_WANT_READ:
- if (detail::select_read(sock, timeout_sec, timeout_usec) > 0) {
- continue;
- }
- break;
- case SSL_ERROR_WANT_WRITE:
- if (detail::select_write(sock, timeout_sec, timeout_usec) > 0) {
- continue;
- }
- break;
- default: break;
- }
- if (err) {
- err->code = impl::map_ssl_error(ssl_err, err->sys_errno);
- err->backend_code = ERR_get_error();
- }
- return false;
- }
- if (err) { err->code = ErrorCode::Success; }
- return true;
- }
- inline bool accept_nonblocking(session_t session, socket_t sock,
- time_t timeout_sec, time_t timeout_usec,
- TlsError *err) {
- if (!session) {
- if (err) { err->code = ErrorCode::Fatal; }
- return false;
- }
- auto ssl = static_cast<SSL *>(session);
- auto bio = SSL_get_rbio(ssl);
- // Set non-blocking mode for handshake
- detail::set_nonblocking(sock, true);
- if (bio) { BIO_set_nbio(bio, 1); }
- auto cleanup = detail::scope_exit([&]() {
- // Restore blocking mode after handshake
- if (bio) { BIO_set_nbio(bio, 0); }
- detail::set_nonblocking(sock, false);
- });
- auto res = 0;
- while ((res = SSL_accept(ssl)) != 1) {
- auto ssl_err = SSL_get_error(ssl, res);
- switch (ssl_err) {
- case SSL_ERROR_WANT_READ:
- if (detail::select_read(sock, timeout_sec, timeout_usec) > 0) {
- continue;
- }
- break;
- case SSL_ERROR_WANT_WRITE:
- if (detail::select_write(sock, timeout_sec, timeout_usec) > 0) {
- continue;
- }
- break;
- default: break;
- }
- if (err) {
- err->code = impl::map_ssl_error(ssl_err, err->sys_errno);
- err->backend_code = ERR_get_error();
- }
- return false;
- }
- if (err) { err->code = ErrorCode::Success; }
- return true;
- }
- inline ssize_t read(session_t session, void *buf, size_t len, TlsError &err) {
- if (!session || !buf) {
- err.code = ErrorCode::Fatal;
- return -1;
- }
- auto ssl = static_cast<SSL *>(session);
- constexpr auto max_len =
- static_cast<size_t>((std::numeric_limits<int>::max)());
- if (len > max_len) { len = max_len; }
- auto ret = SSL_read(ssl, buf, static_cast<int>(len));
- if (ret > 0) {
- err.code = ErrorCode::Success;
- return ret;
- }
- auto ssl_err = SSL_get_error(ssl, ret);
- err.code = impl::map_ssl_error(ssl_err, err.sys_errno);
- if (err.code == ErrorCode::PeerClosed) {
- return 0;
- } // Gracefully handle the peer closed state.
- if (err.code == ErrorCode::Fatal) { err.backend_code = ERR_get_error(); }
- return -1;
- }
- inline ssize_t write(session_t session, const void *buf, size_t len,
- TlsError &err) {
- if (!session || !buf) {
- err.code = ErrorCode::Fatal;
- return -1;
- }
- auto ssl = static_cast<SSL *>(session);
- auto ret = SSL_write(ssl, buf, static_cast<int>(len));
- if (ret > 0) {
- err.code = ErrorCode::Success;
- return ret;
- }
- auto ssl_err = SSL_get_error(ssl, ret);
- err.code = impl::map_ssl_error(ssl_err, err.sys_errno);
- if (err.code == ErrorCode::Fatal) { err.backend_code = ERR_get_error(); }
- return -1;
- }
- inline int pending(const_session_t session) {
- if (!session) return 0;
- return SSL_pending(static_cast<SSL *>(const_cast<void *>(session)));
- }
- inline void shutdown(session_t session, bool graceful) {
- if (!session) return;
- auto ssl = static_cast<SSL *>(session);
- if (graceful) {
- // First call sends close_notify
- if (SSL_shutdown(ssl) == 0) {
- // Second call waits for peer's close_notify
- SSL_shutdown(ssl);
- }
- }
- }
- inline bool is_peer_closed(session_t session, socket_t sock) {
- if (!session) return true;
- // Temporarily set socket to non-blocking to avoid blocking on SSL_peek
- detail::set_nonblocking(sock, true);
- auto se = detail::scope_exit([&]() { detail::set_nonblocking(sock, false); });
- auto ssl = static_cast<SSL *>(session);
- char buf;
- auto ret = SSL_peek(ssl, &buf, 1);
- if (ret > 0) return false;
- auto err = SSL_get_error(ssl, ret);
- return err == SSL_ERROR_ZERO_RETURN;
- }
- inline cert_t get_peer_cert(const_session_t session) {
- if (!session) return nullptr;
- return static_cast<cert_t>(SSL_get1_peer_certificate(
- static_cast<SSL *>(const_cast<void *>(session))));
- }
- inline void free_cert(cert_t cert) {
- if (cert) { X509_free(static_cast<X509 *>(cert)); }
- }
- inline bool verify_hostname(cert_t cert, const char *hostname) {
- if (!cert || !hostname) return false;
- auto x509 = static_cast<X509 *>(cert);
- // Use X509_check_ip_asc for IP addresses, X509_check_host for DNS names
- if (detail::is_ip_address(hostname)) {
- return X509_check_ip_asc(x509, hostname, 0) == 1;
- }
- return X509_check_host(x509, hostname, strlen(hostname), 0, nullptr) == 1;
- }
- inline uint64_t hostname_mismatch_code() {
- return static_cast<uint64_t>(X509_V_ERR_HOSTNAME_MISMATCH);
- }
- inline long get_verify_result(const_session_t session) {
- if (!session) return X509_V_ERR_UNSPECIFIED;
- return SSL_get_verify_result(static_cast<SSL *>(const_cast<void *>(session)));
- }
- inline std::string get_cert_subject_cn(cert_t cert) {
- if (!cert) return "";
- auto x509 = static_cast<X509 *>(cert);
- auto subject_name = X509_get_subject_name(x509);
- if (!subject_name) return "";
- // X509_NAME_get_text_by_NID is deprecated since OpenSSL 4.0
- auto idx = X509_NAME_get_index_by_NID(subject_name, NID_commonName, -1);
- if (idx < 0) return "";
- auto entry = X509_NAME_get_entry(subject_name, idx);
- if (!entry) return "";
- auto data = X509_NAME_ENTRY_get_data(entry);
- if (!data) return "";
- return std::string(
- reinterpret_cast<const char *>(ASN1_STRING_get0_data(data)),
- static_cast<size_t>(ASN1_STRING_length(data)));
- }
- inline std::string get_cert_issuer_name(cert_t cert) {
- if (!cert) return "";
- auto x509 = static_cast<X509 *>(cert);
- auto issuer_name = X509_get_issuer_name(x509);
- if (!issuer_name) return "";
- char buf[256];
- X509_NAME_oneline(issuer_name, buf, sizeof(buf));
- return std::string(buf);
- }
- inline bool get_cert_sans(cert_t cert, std::vector<SanEntry> &sans) {
- sans.clear();
- if (!cert) return false;
- auto x509 = static_cast<X509 *>(cert);
- auto names = static_cast<GENERAL_NAMES *>(
- X509_get_ext_d2i(x509, NID_subject_alt_name, nullptr, nullptr));
- if (!names) return true; // No SANs is valid
- auto count = sk_GENERAL_NAME_num(names);
- for (decltype(count) i = 0; i < count; i++) {
- auto gen = sk_GENERAL_NAME_value(names, i);
- if (!gen) continue;
- SanEntry entry;
- switch (gen->type) {
- case GEN_DNS:
- entry.type = SanType::DNS;
- if (gen->d.dNSName) {
- entry.value = std::string(
- reinterpret_cast<const char *>(
- ASN1_STRING_get0_data(gen->d.dNSName)),
- static_cast<size_t>(ASN1_STRING_length(gen->d.dNSName)));
- }
- break;
- case GEN_IPADD:
- entry.type = SanType::IP;
- if (gen->d.iPAddress) {
- auto data = ASN1_STRING_get0_data(gen->d.iPAddress);
- auto len = ASN1_STRING_length(gen->d.iPAddress);
- if (len == 4) {
- // IPv4
- char buf[INET_ADDRSTRLEN];
- inet_ntop(AF_INET, data, buf, sizeof(buf));
- entry.value = buf;
- } else if (len == 16) {
- // IPv6
- char buf[INET6_ADDRSTRLEN];
- inet_ntop(AF_INET6, data, buf, sizeof(buf));
- entry.value = buf;
- }
- }
- break;
- case GEN_EMAIL:
- entry.type = SanType::EMAIL;
- if (gen->d.rfc822Name) {
- entry.value = std::string(
- reinterpret_cast<const char *>(
- ASN1_STRING_get0_data(gen->d.rfc822Name)),
- static_cast<size_t>(ASN1_STRING_length(gen->d.rfc822Name)));
- }
- break;
- case GEN_URI:
- entry.type = SanType::URI;
- if (gen->d.uniformResourceIdentifier) {
- entry.value = std::string(
- reinterpret_cast<const char *>(
- ASN1_STRING_get0_data(gen->d.uniformResourceIdentifier)),
- static_cast<size_t>(
- ASN1_STRING_length(gen->d.uniformResourceIdentifier)));
- }
- break;
- default: entry.type = SanType::OTHER; break;
- }
- if (!entry.value.empty()) { sans.push_back(std::move(entry)); }
- }
- GENERAL_NAMES_free(names);
- return true;
- }
- inline bool get_cert_validity(cert_t cert, time_t ¬_before,
- time_t ¬_after) {
- if (!cert) return false;
- auto x509 = static_cast<X509 *>(cert);
- auto nb = X509_get0_notBefore(x509);
- auto na = X509_get0_notAfter(x509);
- if (!nb || !na) return false;
- ASN1_TIME *epoch = ASN1_TIME_new();
- if (!epoch) return false;
- auto se = detail::scope_exit([&] { ASN1_TIME_free(epoch); });
- if (!ASN1_TIME_set(epoch, 0)) return false;
- int pday, psec;
- if (!ASN1_TIME_diff(&pday, &psec, epoch, nb)) return false;
- not_before = 86400 * (time_t)pday + psec;
- if (!ASN1_TIME_diff(&pday, &psec, epoch, na)) return false;
- not_after = 86400 * (time_t)pday + psec;
- return true;
- }
- inline std::string get_cert_serial(cert_t cert) {
- if (!cert) return "";
- auto x509 = static_cast<X509 *>(cert);
- auto serial = X509_get_serialNumber(x509);
- if (!serial) return "";
- auto bn = ASN1_INTEGER_to_BN(serial, nullptr);
- if (!bn) return "";
- auto hex = BN_bn2hex(bn);
- BN_free(bn);
- if (!hex) return "";
- std::string result(hex);
- OPENSSL_free(hex);
- return result;
- }
- inline bool get_cert_der(cert_t cert, std::vector<unsigned char> &der) {
- if (!cert) return false;
- auto x509 = static_cast<X509 *>(cert);
- auto len = i2d_X509(x509, nullptr);
- if (len < 0) return false;
- der.resize(static_cast<size_t>(len));
- auto p = der.data();
- i2d_X509(x509, &p);
- return true;
- }
- inline const char *get_sni(const_session_t session) {
- if (!session) return nullptr;
- auto ssl = static_cast<SSL *>(const_cast<void *>(session));
- return SSL_get_servername(ssl, TLSEXT_NAMETYPE_host_name);
- }
- inline uint64_t peek_error() { return ERR_peek_last_error(); }
- inline uint64_t get_error() { return ERR_get_error(); }
- inline std::string error_string(uint64_t code) {
- char buf[256];
- ERR_error_string_n(static_cast<unsigned long>(code), buf, sizeof(buf));
- return std::string(buf);
- }
- inline ca_store_t create_ca_store(const char *pem, size_t len) {
- auto mem = BIO_new_mem_buf(pem, static_cast<int>(len));
- if (!mem) { return nullptr; }
- auto mem_guard = detail::scope_exit([&] { BIO_free_all(mem); });
- auto inf = PEM_X509_INFO_read_bio(mem, nullptr, nullptr, nullptr);
- if (!inf) { return nullptr; }
- auto store = X509_STORE_new();
- if (store) {
- for (auto i = 0; i < static_cast<int>(sk_X509_INFO_num(inf)); i++) {
- auto itmp = sk_X509_INFO_value(inf, i);
- if (!itmp) { continue; }
- if (itmp->x509) { X509_STORE_add_cert(store, itmp->x509); }
- if (itmp->crl) { X509_STORE_add_crl(store, itmp->crl); }
- }
- }
- sk_X509_INFO_pop_free(inf, X509_INFO_free);
- return static_cast<ca_store_t>(store);
- }
- inline void free_ca_store(ca_store_t store) {
- if (store) { X509_STORE_free(static_cast<X509_STORE *>(store)); }
- }
- inline bool set_ca_store(ctx_t ctx, ca_store_t store) {
- if (!ctx || !store) { return false; }
- auto ssl_ctx = static_cast<SSL_CTX *>(ctx);
- auto x509_store = static_cast<X509_STORE *>(store);
- // Check if same store is already set
- if (SSL_CTX_get_cert_store(ssl_ctx) == x509_store) { return true; }
- // SSL_CTX_set_cert_store takes ownership and frees the old store
- SSL_CTX_set_cert_store(ssl_ctx, x509_store);
- return true;
- }
- inline size_t get_ca_certs(ctx_t ctx, std::vector<cert_t> &certs) {
- certs.clear();
- if (!ctx) { return 0; }
- auto ssl_ctx = static_cast<SSL_CTX *>(ctx);
- auto store = SSL_CTX_get_cert_store(ssl_ctx);
- if (!store) { return 0; }
- auto objs = impl::get_store_objects(store);
- if (!objs) { return 0; }
- auto se = detail::scope_exit([&] { impl::release_store_objects(objs); });
- auto count = sk_X509_OBJECT_num(objs);
- for (decltype(count) i = 0; i < count; i++) {
- auto obj = sk_X509_OBJECT_value(objs, i);
- if (!obj) { continue; }
- if (X509_OBJECT_get_type(obj) == X509_LU_X509) {
- auto x509 = X509_OBJECT_get0_X509(obj);
- if (x509) {
- // Increment reference count so caller can free it
- X509_up_ref(x509);
- certs.push_back(static_cast<cert_t>(x509));
- }
- }
- }
- return certs.size();
- }
- inline std::vector<std::string> get_ca_names(ctx_t ctx) {
- std::vector<std::string> names;
- if (!ctx) { return names; }
- auto ssl_ctx = static_cast<SSL_CTX *>(ctx);
- auto store = SSL_CTX_get_cert_store(ssl_ctx);
- if (!store) { return names; }
- auto objs = impl::get_store_objects(store);
- if (!objs) { return names; }
- auto se = detail::scope_exit([&] { impl::release_store_objects(objs); });
- auto count = sk_X509_OBJECT_num(objs);
- for (decltype(count) i = 0; i < count; i++) {
- auto obj = sk_X509_OBJECT_value(objs, i);
- if (!obj) { continue; }
- if (X509_OBJECT_get_type(obj) == X509_LU_X509) {
- auto x509 = X509_OBJECT_get0_X509(obj);
- if (x509) {
- auto subject = X509_get_subject_name(x509);
- if (subject) {
- char buf[512];
- X509_NAME_oneline(subject, buf, sizeof(buf));
- names.push_back(buf);
- }
- }
- }
- }
- return names;
- }
- inline bool update_server_cert(ctx_t ctx, const char *cert_pem,
- const char *key_pem, const char *password) {
- if (!ctx || !cert_pem || !key_pem) { return false; }
- auto ssl_ctx = static_cast<SSL_CTX *>(ctx);
- // Load certificate from PEM
- auto cert_bio = BIO_new_mem_buf(cert_pem, -1);
- if (!cert_bio) { return false; }
- auto cert = PEM_read_bio_X509(cert_bio, nullptr, nullptr, nullptr);
- BIO_free(cert_bio);
- if (!cert) { return false; }
- // Load private key from PEM
- auto key_bio = BIO_new_mem_buf(key_pem, -1);
- if (!key_bio) {
- X509_free(cert);
- return false;
- }
- auto key = PEM_read_bio_PrivateKey(key_bio, nullptr, nullptr,
- password ? const_cast<char *>(password)
- : nullptr);
- BIO_free(key_bio);
- if (!key) {
- X509_free(cert);
- return false;
- }
- // Update certificate and key
- auto ret = SSL_CTX_use_certificate(ssl_ctx, cert) == 1 &&
- SSL_CTX_use_PrivateKey(ssl_ctx, key) == 1;
- X509_free(cert);
- EVP_PKEY_free(key);
- return ret;
- }
- inline bool update_server_client_ca(ctx_t ctx, const char *ca_pem) {
- if (!ctx || !ca_pem) { return false; }
- auto ssl_ctx = static_cast<SSL_CTX *>(ctx);
- // Create new X509_STORE from PEM
- auto store = create_ca_store(ca_pem, strlen(ca_pem));
- if (!store) { return false; }
- // SSL_CTX_set_cert_store takes ownership
- SSL_CTX_set_cert_store(ssl_ctx, static_cast<X509_STORE *>(store));
- // Set client CA list for client certificate request
- auto ca_list = impl::create_client_ca_list_from_pem(ca_pem);
- if (ca_list) {
- // SSL_CTX_set_client_CA_list takes ownership of ca_list
- SSL_CTX_set_client_CA_list(ssl_ctx, ca_list);
- }
- return true;
- }
- inline bool set_verify_callback(ctx_t ctx, VerifyCallback callback) {
- if (!ctx) { return false; }
- auto ssl_ctx = static_cast<SSL_CTX *>(ctx);
- impl::get_verify_callback() = std::move(callback);
- if (impl::get_verify_callback()) {
- SSL_CTX_set_verify(ssl_ctx, SSL_VERIFY_PEER, impl::openssl_verify_callback);
- } else {
- SSL_CTX_set_verify(ssl_ctx, SSL_VERIFY_PEER, nullptr);
- }
- return true;
- }
- inline long get_verify_error(const_session_t session) {
- if (!session) { return -1; }
- auto ssl = static_cast<SSL *>(const_cast<void *>(session));
- return SSL_get_verify_result(ssl);
- }
- inline std::string verify_error_string(long error_code) {
- if (error_code == X509_V_OK) { return ""; }
- const char *str = X509_verify_cert_error_string(static_cast<int>(error_code));
- return str ? str : "unknown error";
- }
- } // namespace tls
- #endif // CPPHTTPLIB_OPENSSL_SUPPORT
- /*
- * Group 9: TLS abstraction layer - Mbed TLS backend
- */
- /*
- * Mbed TLS Backend Implementation
- */
- #ifdef CPPHTTPLIB_MBEDTLS_SUPPORT
- namespace tls {
- namespace impl {
- // Mbed TLS session wrapper
- struct MbedTlsSession {
- mbedtls_ssl_context ssl;
- socket_t sock = INVALID_SOCKET;
- std::string hostname; // For client: set via set_sni
- std::string sni_hostname; // For server: received from client via SNI callback
- // Mbed TLS has no SSL_peek() equivalent, so is_peer_closed() must probe with
- // a real 1-byte mbedtls_ssl_read(). If that probe lands on application data
- // (e.g. a response that arrived while this side was still in its post-write
- // check), the byte is pushed back here and served by the next read().
- unsigned char peeked_byte = 0;
- bool has_peeked_byte = false;
- // Set by set_sni() when the caller disabled hostname verification, so the
- // verify callback can clear the CN/SAN mismatch flag while still enforcing
- // the rest of the chain (Mbed TLS ties SNI and identity checking together;
- // OpenSSL and wolfSSL keep them independent).
- bool suppress_hostname_mismatch = false;
- // Copied from the owning MbedTlsContext at creation. set_sni() uses this to
- // decide which verify callback to install when hostname verification is
- // disabled: mbedtls_verify_callback() when a user callback is genuinely
- // wired for this context, or a self-contained one otherwise, so a session
- // that never opted into a callback never consults the process-wide
- // set_verify_callback() slot (which some other, unrelated client may have
- // populated).
- bool has_verify_callback = false;
- MbedTlsSession() { mbedtls_ssl_init(&ssl); }
- ~MbedTlsSession() { mbedtls_ssl_free(&ssl); }
- MbedTlsSession(const MbedTlsSession &) = delete;
- MbedTlsSession &operator=(const MbedTlsSession &) = delete;
- };
- // Thread-local error code accessor for Mbed TLS (since it doesn't have an error
- // queue)
- inline int &mbedtls_last_error() {
- static thread_local int err = 0;
- return err;
- }
- // Helper to map Mbed TLS error to ErrorCode
- inline ErrorCode map_mbedtls_error(int ret, int &out_errno,
- uint32_t verify_flags) {
- if (ret == 0) { return ErrorCode::Success; }
- if (ret == MBEDTLS_ERR_SSL_WANT_READ) { return ErrorCode::WantRead; }
- if (ret == MBEDTLS_ERR_SSL_WANT_WRITE) { return ErrorCode::WantWrite; }
- if (ret == MBEDTLS_ERR_SSL_PEER_CLOSE_NOTIFY) {
- return ErrorCode::PeerClosed;
- }
- if (ret == MBEDTLS_ERR_NET_CONN_RESET || ret == MBEDTLS_ERR_NET_SEND_FAILED ||
- ret == MBEDTLS_ERR_NET_RECV_FAILED) {
- out_errno = errno;
- return ErrorCode::SyscallError;
- }
- if (ret == MBEDTLS_ERR_X509_CERT_VERIFY_FAILED) {
- // Unlike OpenSSL/wolfSSL, Mbed TLS folds the CN/SAN identity check into
- // the handshake's chain verification (see set_sni()); a mismatch there
- // is reported the same way as any other verify_flags bit. Report it as
- // HostnameMismatch, matching the other backends and the post-handshake
- // identity check below, but only when naming is the sole problem -
- // if the chain itself is also untrusted/expired/etc., that takes
- // priority over the naming detail.
- if (verify_flags == static_cast<uint32_t>(hostname_mismatch_code())) {
- return ErrorCode::HostnameMismatch;
- }
- return ErrorCode::CertVerifyFailed;
- }
- return ErrorCode::Fatal;
- }
- // Populates a TlsError from a failed (non-zero) mbedtls_ssl_handshake()
- // return value, including the verify-flags-dependent HostnameMismatch
- // mapping; shared by connect() and connect_nonblocking() so the
- // backend_code policy for that mapping only lives in one place.
- inline void fill_mbedtls_tls_error(TlsError &err, mbedtls_ssl_context &ssl,
- int ret) {
- auto verify_flags = mbedtls_ssl_get_verify_result(&ssl);
- err.code = map_mbedtls_error(ret, err.sys_errno, verify_flags);
- err.backend_code = err.code == ErrorCode::HostnameMismatch
- ? static_cast<uint64_t>(verify_flags)
- : static_cast<uint64_t>(-ret);
- }
- // A TLS 1.3 NewSessionTicket (signaled by default on Mbed TLS 4.x) is a
- // non-fatal notification delivered between records, not an error and not
- // application data, so I/O calls that see it should just be retried. Kept in
- // one helper so the retry loops keep an intact "do { } while (...)" instead of
- // splitting the closing brace across an #if.
- inline bool mbedtls_is_session_ticket(int ret) {
- #if defined(MBEDTLS_ERR_SSL_RECEIVED_NEW_SESSION_TICKET)
- return ret == MBEDTLS_ERR_SSL_RECEIVED_NEW_SESSION_TICKET;
- #else
- (void)ret;
- return false;
- #endif
- }
- // BIO-like send callback for Mbed TLS
- inline int mbedtls_net_send_cb(void *ctx, const unsigned char *buf,
- size_t len) {
- auto sock = *static_cast<socket_t *>(ctx);
- #ifdef _WIN32
- auto ret =
- send(sock, reinterpret_cast<const char *>(buf), static_cast<int>(len), 0);
- if (ret == SOCKET_ERROR) {
- int err = WSAGetLastError();
- if (err == WSAEWOULDBLOCK) { return MBEDTLS_ERR_SSL_WANT_WRITE; }
- return MBEDTLS_ERR_NET_SEND_FAILED;
- }
- #else
- auto ret = send(sock, buf, len, 0);
- if (ret < 0) {
- if (errno == EAGAIN || errno == EWOULDBLOCK) {
- return MBEDTLS_ERR_SSL_WANT_WRITE;
- }
- return MBEDTLS_ERR_NET_SEND_FAILED;
- }
- #endif
- return static_cast<int>(ret);
- }
- // BIO-like recv callback for Mbed TLS
- inline int mbedtls_net_recv_cb(void *ctx, unsigned char *buf, size_t len) {
- auto sock = *static_cast<socket_t *>(ctx);
- #ifdef _WIN32
- auto ret =
- recv(sock, reinterpret_cast<char *>(buf), static_cast<int>(len), 0);
- if (ret == SOCKET_ERROR) {
- int err = WSAGetLastError();
- if (err == WSAEWOULDBLOCK) { return MBEDTLS_ERR_SSL_WANT_READ; }
- return MBEDTLS_ERR_NET_RECV_FAILED;
- }
- #else
- auto ret = recv(sock, buf, len, 0);
- if (ret < 0) {
- if (errno == EAGAIN || errno == EWOULDBLOCK) {
- return MBEDTLS_ERR_SSL_WANT_READ;
- }
- return MBEDTLS_ERR_NET_RECV_FAILED;
- }
- #endif
- if (ret == 0) { return MBEDTLS_ERR_SSL_PEER_CLOSE_NOTIFY; }
- return static_cast<int>(ret);
- }
- // MbedTlsContext constructor/destructor implementations
- inline MbedTlsContext::MbedTlsContext() {
- mbedtls_ssl_config_init(&conf);
- #ifndef CPPHTTPLIB_MBEDTLS_V4
- mbedtls_entropy_init(&entropy);
- mbedtls_ctr_drbg_init(&ctr_drbg);
- #endif
- mbedtls_x509_crt_init(&ca_chain);
- mbedtls_x509_crt_init(&own_cert);
- mbedtls_pk_init(&own_key);
- }
- inline MbedTlsContext::~MbedTlsContext() {
- mbedtls_pk_free(&own_key);
- mbedtls_x509_crt_free(&own_cert);
- mbedtls_x509_crt_free(&ca_chain);
- #ifndef CPPHTTPLIB_MBEDTLS_V4
- mbedtls_ctr_drbg_free(&ctr_drbg);
- mbedtls_entropy_free(&entropy);
- #endif
- mbedtls_ssl_config_free(&conf);
- }
- // Thread-local storage for SNI captured during handshake
- // This is needed because the SNI callback doesn't have a way to pass
- // session-specific data before the session is fully set up
- inline std::string &mbedpending_sni() {
- static thread_local std::string sni;
- return sni;
- }
- // SNI callback for Mbed TLS server to capture client's SNI hostname
- inline int mbedtls_sni_callback(void *p_ctx, mbedtls_ssl_context *ssl,
- const unsigned char *name, size_t name_len) {
- (void)p_ctx;
- (void)ssl;
- // Store SNI name in thread-local storage
- // It will be retrieved and stored in the session after handshake
- if (name && name_len > 0) {
- mbedpending_sni().assign(reinterpret_cast<const char *>(name), name_len);
- } else {
- mbedpending_sni().clear();
- }
- return 0; // Accept any SNI
- }
- inline void mbedtls_clear_cn_mismatch(uint32_t *flags) {
- *flags &= ~static_cast<uint32_t>(hostname_mismatch_code());
- }
- // Verify callback used when hostname verification is disabled for a session
- // that has no user-supplied verify callback of its own (MbedTlsSession::
- // has_verify_callback is false). Deliberately does not consult
- // get_verify_callback(): that slot is process-wide, so reading it here would
- // pick up whatever another, unrelated client last installed there.
- inline int mbedtls_mask_hostname_mismatch_callback(void *data,
- mbedtls_x509_crt *, int,
- uint32_t *flags) {
- (void)data;
- mbedtls_clear_cn_mismatch(flags);
- return 0;
- }
- inline int mbedtls_verify_callback(void *data, mbedtls_x509_crt *crt,
- int cert_depth, uint32_t *flags);
- // MbedTLS verify callback wrapper
- inline int mbedtls_verify_callback(void *data, mbedtls_x509_crt *crt,
- int cert_depth, uint32_t *flags) {
- // data points to the MbedTlsSession
- auto *session = static_cast<MbedTlsSession *>(data);
- // set_sni() disabled hostname verification for this session: drop the
- // CN/SAN mismatch flag so it doesn't fail the chain check below, mirroring
- // the OpenSSL/wolfSSL backends where identity checking is independent of
- // SNI. The final pass/fail decision still comes from the remaining flags
- // (or, below, from the user's own verify callback).
- if (session && session->suppress_hostname_mismatch) {
- mbedtls_clear_cn_mismatch(flags);
- }
- auto &callback = get_verify_callback();
- if (!callback) { return 0; } // Continue with default verification
- // Build context
- VerifyContext verify_ctx;
- verify_ctx.session = static_cast<session_t>(session);
- verify_ctx.cert = static_cast<cert_t>(crt);
- verify_ctx.depth = cert_depth;
- verify_ctx.preverify_ok = (*flags == 0);
- verify_ctx.error_code = static_cast<long>(*flags);
- // Convert Mbed TLS flags to error string
- static thread_local char error_buf[256];
- if (*flags != 0) {
- mbedtls_x509_crt_verify_info(error_buf, sizeof(error_buf), "", *flags);
- verify_ctx.error_string = error_buf;
- } else {
- verify_ctx.error_string = nullptr;
- }
- bool accepted = callback(verify_ctx);
- if (accepted) {
- *flags = 0; // Clear all error flags
- return 0;
- }
- return MBEDTLS_ERR_X509_CERT_VERIFY_FAILED;
- }
- } // namespace impl
- inline ctx_t create_client_context() {
- auto ctx = new (std::nothrow) impl::MbedTlsContext();
- if (!ctx) { return nullptr; }
- ctx->is_server = false;
- #ifdef CPPHTTPLIB_MBEDTLS_V4
- // Mbed TLS 4.x draws randomness from PSA Crypto; just ensure it is ready.
- if (!detail::ensure_mbedtls_psa_crypto()) {
- delete ctx;
- return nullptr;
- }
- int ret;
- #else
- // Seed the random number generator
- const char *pers = "httplib_client";
- int ret = mbedtls_ctr_drbg_seed(
- &ctx->ctr_drbg, mbedtls_entropy_func, &ctx->entropy,
- reinterpret_cast<const unsigned char *>(pers), strlen(pers));
- if (ret != 0) {
- impl::mbedtls_last_error() = ret;
- delete ctx;
- return nullptr;
- }
- #endif
- // Set up SSL config for client
- ret = mbedtls_ssl_config_defaults(&ctx->conf, MBEDTLS_SSL_IS_CLIENT,
- MBEDTLS_SSL_TRANSPORT_STREAM,
- MBEDTLS_SSL_PRESET_DEFAULT);
- if (ret != 0) {
- impl::mbedtls_last_error() = ret;
- delete ctx;
- return nullptr;
- }
- #ifndef CPPHTTPLIB_MBEDTLS_V4
- // Set random number generator (Mbed TLS 4.x uses the PSA RNG implicitly)
- mbedtls_ssl_conf_rng(&ctx->conf, mbedtls_ctr_drbg_random, &ctx->ctr_drbg);
- #endif
- // Default: verify peer certificate
- mbedtls_ssl_conf_authmode(&ctx->conf, MBEDTLS_SSL_VERIFY_REQUIRED);
- // Set minimum TLS version to 1.2
- #ifdef CPPHTTPLIB_MBEDTLS_V3
- mbedtls_ssl_conf_min_tls_version(&ctx->conf, MBEDTLS_SSL_VERSION_TLS1_2);
- #else
- mbedtls_ssl_conf_min_version(&ctx->conf, MBEDTLS_SSL_MAJOR_VERSION_3,
- MBEDTLS_SSL_MINOR_VERSION_3);
- #endif
- return static_cast<ctx_t>(ctx);
- }
- inline ctx_t create_server_context() {
- auto ctx = new (std::nothrow) impl::MbedTlsContext();
- if (!ctx) { return nullptr; }
- ctx->is_server = true;
- #ifdef CPPHTTPLIB_MBEDTLS_V4
- // Mbed TLS 4.x draws randomness from PSA Crypto; just ensure it is ready.
- if (!detail::ensure_mbedtls_psa_crypto()) {
- delete ctx;
- return nullptr;
- }
- int ret;
- #else
- // Seed the random number generator
- const char *pers = "httplib_server";
- int ret = mbedtls_ctr_drbg_seed(
- &ctx->ctr_drbg, mbedtls_entropy_func, &ctx->entropy,
- reinterpret_cast<const unsigned char *>(pers), strlen(pers));
- if (ret != 0) {
- impl::mbedtls_last_error() = ret;
- delete ctx;
- return nullptr;
- }
- #endif
- // Set up SSL config for server
- ret = mbedtls_ssl_config_defaults(&ctx->conf, MBEDTLS_SSL_IS_SERVER,
- MBEDTLS_SSL_TRANSPORT_STREAM,
- MBEDTLS_SSL_PRESET_DEFAULT);
- if (ret != 0) {
- impl::mbedtls_last_error() = ret;
- delete ctx;
- return nullptr;
- }
- #ifndef CPPHTTPLIB_MBEDTLS_V4
- // Set random number generator (Mbed TLS 4.x uses the PSA RNG implicitly)
- mbedtls_ssl_conf_rng(&ctx->conf, mbedtls_ctr_drbg_random, &ctx->ctr_drbg);
- #endif
- // Default: don't verify client
- mbedtls_ssl_conf_authmode(&ctx->conf, MBEDTLS_SSL_VERIFY_NONE);
- // Set minimum TLS version to 1.2
- #ifdef CPPHTTPLIB_MBEDTLS_V3
- mbedtls_ssl_conf_min_tls_version(&ctx->conf, MBEDTLS_SSL_VERSION_TLS1_2);
- #else
- mbedtls_ssl_conf_min_version(&ctx->conf, MBEDTLS_SSL_MAJOR_VERSION_3,
- MBEDTLS_SSL_MINOR_VERSION_3);
- #endif
- // Set SNI callback to capture client's SNI hostname
- mbedtls_ssl_conf_sni(&ctx->conf, impl::mbedtls_sni_callback, nullptr);
- return static_cast<ctx_t>(ctx);
- }
- inline void free_context(ctx_t ctx) {
- if (ctx) { delete static_cast<impl::MbedTlsContext *>(ctx); }
- }
- inline bool set_min_version(ctx_t ctx, Version version) {
- if (!ctx) { return false; }
- auto mctx = static_cast<impl::MbedTlsContext *>(ctx);
- #ifdef CPPHTTPLIB_MBEDTLS_V3
- // Mbed TLS 3.x uses mbedtls_ssl_protocol_version enum
- mbedtls_ssl_protocol_version min_ver = MBEDTLS_SSL_VERSION_TLS1_2;
- if (version >= Version::TLS1_3) {
- #if defined(MBEDTLS_SSL_PROTO_TLS1_3)
- min_ver = MBEDTLS_SSL_VERSION_TLS1_3;
- #endif
- }
- mbedtls_ssl_conf_min_tls_version(&mctx->conf, min_ver);
- #else
- // Mbed TLS 2.x uses major/minor version numbers
- int major = MBEDTLS_SSL_MAJOR_VERSION_3;
- int minor = MBEDTLS_SSL_MINOR_VERSION_3; // TLS 1.2
- if (version >= Version::TLS1_3) {
- #if defined(MBEDTLS_SSL_PROTO_TLS1_3)
- minor = MBEDTLS_SSL_MINOR_VERSION_4; // TLS 1.3
- #else
- minor = MBEDTLS_SSL_MINOR_VERSION_3; // Fall back to TLS 1.2
- #endif
- }
- mbedtls_ssl_conf_min_version(&mctx->conf, major, minor);
- #endif
- return true;
- }
- inline bool load_ca_pem(ctx_t ctx, const char *pem, size_t len) {
- if (!ctx || !pem) { return false; }
- auto mctx = static_cast<impl::MbedTlsContext *>(ctx);
- // mbedtls_x509_crt_parse expects null-terminated string for PEM
- // Add null terminator if not present
- std::string pem_str(pem, len);
- int ret = mbedtls_x509_crt_parse(
- &mctx->ca_chain, reinterpret_cast<const unsigned char *>(pem_str.c_str()),
- pem_str.size() + 1);
- if (ret != 0) {
- impl::mbedtls_last_error() = ret;
- return false;
- }
- mbedtls_ssl_conf_ca_chain(&mctx->conf, &mctx->ca_chain, nullptr);
- return true;
- }
- inline bool load_ca_file(ctx_t ctx, const char *file_path) {
- if (!ctx || !file_path) { return false; }
- auto mctx = static_cast<impl::MbedTlsContext *>(ctx);
- int ret = mbedtls_x509_crt_parse_file(&mctx->ca_chain, file_path);
- if (ret != 0) {
- impl::mbedtls_last_error() = ret;
- return false;
- }
- mbedtls_ssl_conf_ca_chain(&mctx->conf, &mctx->ca_chain, nullptr);
- return true;
- }
- inline bool load_ca_dir(ctx_t ctx, const char *dir_path) {
- if (!ctx || !dir_path) { return false; }
- auto mctx = static_cast<impl::MbedTlsContext *>(ctx);
- int ret = mbedtls_x509_crt_parse_path(&mctx->ca_chain, dir_path);
- if (ret < 0) { // Returns number of certs on success, negative on error
- impl::mbedtls_last_error() = ret;
- return false;
- }
- mbedtls_ssl_conf_ca_chain(&mctx->conf, &mctx->ca_chain, nullptr);
- return true;
- }
- inline bool load_system_certs(ctx_t ctx) {
- if (!ctx) { return false; }
- auto mctx = static_cast<impl::MbedTlsContext *>(ctx);
- bool loaded = false;
- #ifdef _WIN32
- loaded = impl::enumerate_windows_system_certs(
- [&](const unsigned char *data, size_t len) {
- return mbedtls_x509_crt_parse_der(&mctx->ca_chain, data, len) == 0;
- });
- #elif defined(__APPLE__) && defined(CPPHTTPLIB_USE_CERTS_FROM_MACOSX_KEYCHAIN)
- loaded = impl::enumerate_macos_keychain_certs(
- [&](const unsigned char *data, size_t len) {
- return mbedtls_x509_crt_parse_der(&mctx->ca_chain, data, len) == 0;
- });
- #else
- for (auto path = impl::system_ca_paths(); *path; ++path) {
- if (mbedtls_x509_crt_parse_file(&mctx->ca_chain, *path) >= 0) {
- loaded = true;
- break;
- }
- }
- if (!loaded) {
- for (auto dir = impl::system_ca_dirs(); *dir; ++dir) {
- if (mbedtls_x509_crt_parse_path(&mctx->ca_chain, *dir) >= 0) {
- loaded = true;
- break;
- }
- }
- }
- #endif
- if (loaded) {
- mbedtls_ssl_conf_ca_chain(&mctx->conf, &mctx->ca_chain, nullptr);
- }
- return loaded;
- }
- inline bool set_client_cert_pem(ctx_t ctx, const char *cert, const char *key,
- const char *password) {
- if (!ctx || !cert || !key) { return false; }
- auto mctx = static_cast<impl::MbedTlsContext *>(ctx);
- // Parse certificate
- std::string cert_str(cert);
- int ret = mbedtls_x509_crt_parse(
- &mctx->own_cert,
- reinterpret_cast<const unsigned char *>(cert_str.c_str()),
- cert_str.size() + 1);
- if (ret != 0) {
- impl::mbedtls_last_error() = ret;
- return false;
- }
- // Parse private key
- std::string key_str(key);
- const unsigned char *pwd =
- password ? reinterpret_cast<const unsigned char *>(password) : nullptr;
- size_t pwd_len = password ? strlen(password) : 0;
- #if defined(CPPHTTPLIB_MBEDTLS_V3) && !defined(CPPHTTPLIB_MBEDTLS_V4)
- ret = mbedtls_pk_parse_key(
- &mctx->own_key, reinterpret_cast<const unsigned char *>(key_str.c_str()),
- key_str.size() + 1, pwd, pwd_len, mbedtls_ctr_drbg_random,
- &mctx->ctr_drbg);
- #else
- ret = mbedtls_pk_parse_key(
- &mctx->own_key, reinterpret_cast<const unsigned char *>(key_str.c_str()),
- key_str.size() + 1, pwd, pwd_len);
- #endif
- if (ret != 0) {
- impl::mbedtls_last_error() = ret;
- return false;
- }
- // Verify that the certificate and private key match.
- // Mbed TLS 4.x: mbedtls_pk_check_pair() reports a spurious mismatch for
- // PSA-backed keys, so skip it and let the handshake surface a real mismatch.
- #ifndef CPPHTTPLIB_MBEDTLS_V4
- #ifdef CPPHTTPLIB_MBEDTLS_V3
- ret = mbedtls_pk_check_pair(&mctx->own_cert.pk, &mctx->own_key,
- mbedtls_ctr_drbg_random, &mctx->ctr_drbg);
- #else
- ret = mbedtls_pk_check_pair(&mctx->own_cert.pk, &mctx->own_key);
- #endif
- if (ret != 0) {
- impl::mbedtls_last_error() = ret;
- return false;
- }
- #endif
- ret = mbedtls_ssl_conf_own_cert(&mctx->conf, &mctx->own_cert, &mctx->own_key);
- if (ret != 0) {
- impl::mbedtls_last_error() = ret;
- return false;
- }
- return true;
- }
- inline bool set_client_cert_file(ctx_t ctx, const char *cert_path,
- const char *key_path, const char *password) {
- if (!ctx || !cert_path || !key_path) { return false; }
- auto mctx = static_cast<impl::MbedTlsContext *>(ctx);
- // Parse certificate file
- int ret = mbedtls_x509_crt_parse_file(&mctx->own_cert, cert_path);
- if (ret != 0) {
- impl::mbedtls_last_error() = ret;
- return false;
- }
- // Parse private key file
- #if defined(CPPHTTPLIB_MBEDTLS_V3) && !defined(CPPHTTPLIB_MBEDTLS_V4)
- ret = mbedtls_pk_parse_keyfile(&mctx->own_key, key_path, password,
- mbedtls_ctr_drbg_random, &mctx->ctr_drbg);
- #else
- ret = mbedtls_pk_parse_keyfile(&mctx->own_key, key_path, password);
- #endif
- if (ret != 0) {
- impl::mbedtls_last_error() = ret;
- return false;
- }
- // Verify that the certificate and private key match.
- // Mbed TLS 4.x: see set_client_cert() — skip the spurious check_pair.
- #ifndef CPPHTTPLIB_MBEDTLS_V4
- #ifdef CPPHTTPLIB_MBEDTLS_V3
- ret = mbedtls_pk_check_pair(&mctx->own_cert.pk, &mctx->own_key,
- mbedtls_ctr_drbg_random, &mctx->ctr_drbg);
- #else
- ret = mbedtls_pk_check_pair(&mctx->own_cert.pk, &mctx->own_key);
- #endif
- if (ret != 0) {
- impl::mbedtls_last_error() = ret;
- return false;
- }
- #endif
- ret = mbedtls_ssl_conf_own_cert(&mctx->conf, &mctx->own_cert, &mctx->own_key);
- if (ret != 0) {
- impl::mbedtls_last_error() = ret;
- return false;
- }
- return true;
- }
- inline void set_verify_client(ctx_t ctx, bool require) {
- if (!ctx) { return; }
- auto mctx = static_cast<impl::MbedTlsContext *>(ctx);
- mctx->verify_client = require;
- if (require) {
- mbedtls_ssl_conf_authmode(&mctx->conf, MBEDTLS_SSL_VERIFY_REQUIRED);
- } else {
- // If a verify callback is set, use OPTIONAL mode to ensure the callback
- // is called (matching OpenSSL behavior). Otherwise use NONE.
- mbedtls_ssl_conf_authmode(&mctx->conf, mctx->has_verify_callback
- ? MBEDTLS_SSL_VERIFY_OPTIONAL
- : MBEDTLS_SSL_VERIFY_NONE);
- }
- }
- inline session_t create_session(ctx_t ctx, socket_t sock) {
- if (!ctx || sock == INVALID_SOCKET) { return nullptr; }
- auto mctx = static_cast<impl::MbedTlsContext *>(ctx);
- auto session = new (std::nothrow) impl::MbedTlsSession();
- if (!session) { return nullptr; }
- session->sock = sock;
- int ret = mbedtls_ssl_setup(&session->ssl, &mctx->conf);
- if (ret != 0) {
- impl::mbedtls_last_error() = ret;
- delete session;
- return nullptr;
- }
- // Explicitly opt out of in-handshake hostname verification by default;
- // since Mbed TLS 3.6.4 a client handshake with certificate verification
- // fails outright when no hostname was set. set_sni() installs the real
- // hostname for DNS hosts; for IP hosts (where SNI must not be set) the
- // caller verifies the certificate identity post-handshake via
- // verify_hostname().
- mbedtls_ssl_set_hostname(&session->ssl, nullptr);
- // Set BIO callbacks
- mbedtls_ssl_set_bio(&session->ssl, &session->sock, impl::mbedtls_net_send_cb,
- impl::mbedtls_net_recv_cb, nullptr);
- // Set per-session verify callback with session pointer if callback is
- // registered
- session->has_verify_callback = mctx->has_verify_callback;
- if (mctx->has_verify_callback) {
- mbedtls_ssl_set_verify(&session->ssl, impl::mbedtls_verify_callback,
- session);
- }
- return static_cast<session_t>(session);
- }
- inline void free_session(session_t session) {
- if (session) { delete static_cast<impl::MbedTlsSession *>(session); }
- }
- inline bool set_sni(session_t session, const char *hostname,
- bool verify_hostname) {
- if (!session || !hostname) { return false; }
- auto msession = static_cast<impl::MbedTlsSession *>(session);
- // mbedtls_ssl_set_hostname() both sends the SNI extension and binds the
- // handshake-time CN/SAN check to `hostname`; the two can't be requested
- // independently, so a disabled hostname check is handled below by masking
- // the resulting mismatch flag instead of skipping this call.
- int ret = mbedtls_ssl_set_hostname(&msession->ssl, hostname);
- if (ret != 0) {
- impl::mbedtls_last_error() = ret;
- return false;
- }
- msession->hostname = hostname;
- if (!verify_hostname) {
- msession->suppress_hostname_mismatch = true;
- // If a user verify callback is already wired for this session,
- // mbedtls_verify_callback() masks the mismatch flag itself before
- // consulting it (see suppress_hostname_mismatch above) - reinstalling it
- // here would be redundant. Otherwise install the self-contained masking
- // callback, which never touches the process-wide callback slot.
- if (!msession->has_verify_callback) {
- mbedtls_ssl_set_verify(&msession->ssl,
- impl::mbedtls_mask_hostname_mismatch_callback,
- msession);
- }
- }
- return true;
- }
- inline TlsError connect(session_t session) {
- TlsError err;
- if (!session) {
- err.code = ErrorCode::Fatal;
- return err;
- }
- auto msession = static_cast<impl::MbedTlsSession *>(session);
- int ret;
- do {
- ret = mbedtls_ssl_handshake(&msession->ssl);
- } while (impl::mbedtls_is_session_ticket(ret));
- if (ret == 0) {
- err.code = ErrorCode::Success;
- } else {
- impl::fill_mbedtls_tls_error(err, msession->ssl, ret);
- impl::mbedtls_last_error() = ret;
- }
- return err;
- }
- inline TlsError accept(session_t session) {
- // Same as connect for Mbed TLS - handshake works for both client and server
- auto result = connect(session);
- // After successful handshake, capture SNI from thread-local storage
- if (result.code == ErrorCode::Success && session) {
- auto msession = static_cast<impl::MbedTlsSession *>(session);
- msession->sni_hostname = std::move(impl::mbedpending_sni());
- impl::mbedpending_sni().clear();
- }
- return result;
- }
- inline bool connect_nonblocking(session_t session, socket_t sock,
- time_t timeout_sec, time_t timeout_usec,
- TlsError *err) {
- if (!session) {
- if (err) { err->code = ErrorCode::Fatal; }
- return false;
- }
- auto msession = static_cast<impl::MbedTlsSession *>(session);
- // Set socket to non-blocking mode
- detail::set_nonblocking(sock, true);
- auto cleanup =
- detail::scope_exit([&]() { detail::set_nonblocking(sock, false); });
- int ret;
- while ((ret = mbedtls_ssl_handshake(&msession->ssl)) != 0) {
- // Non-fatal TLS 1.3 ticket; retry immediately.
- if (impl::mbedtls_is_session_ticket(ret)) { continue; }
- if (ret == MBEDTLS_ERR_SSL_WANT_READ) {
- if (detail::select_read(sock, timeout_sec, timeout_usec) > 0) {
- continue;
- }
- } else if (ret == MBEDTLS_ERR_SSL_WANT_WRITE) {
- if (detail::select_write(sock, timeout_sec, timeout_usec) > 0) {
- continue;
- }
- }
- // TlsError or timeout
- if (err) { impl::fill_mbedtls_tls_error(*err, msession->ssl, ret); }
- impl::mbedtls_last_error() = ret;
- return false;
- }
- if (err) { err->code = ErrorCode::Success; }
- return true;
- }
- inline bool accept_nonblocking(session_t session, socket_t sock,
- time_t timeout_sec, time_t timeout_usec,
- TlsError *err) {
- // Same implementation as connect for Mbed TLS
- bool result =
- connect_nonblocking(session, sock, timeout_sec, timeout_usec, err);
- // After successful handshake, capture SNI from thread-local storage
- if (result && session) {
- auto msession = static_cast<impl::MbedTlsSession *>(session);
- msession->sni_hostname = std::move(impl::mbedpending_sni());
- impl::mbedpending_sni().clear();
- }
- return result;
- }
- inline ssize_t read(session_t session, void *buf, size_t len, TlsError &err) {
- if (!session || !buf) {
- err.code = ErrorCode::Fatal;
- return -1;
- }
- auto msession = static_cast<impl::MbedTlsSession *>(session);
- // Serve a byte consumed by the is_peer_closed() probe before reading more.
- if (msession->has_peeked_byte) {
- if (len == 0) { return 0; }
- auto p = static_cast<unsigned char *>(buf);
- p[0] = msession->peeked_byte;
- msession->has_peeked_byte = false;
- size_t n = 1;
- // Top up with any already-decrypted bytes without risking a block.
- if (len > 1 && mbedtls_ssl_get_bytes_avail(&msession->ssl) > 0) {
- int extra = mbedtls_ssl_read(&msession->ssl, p + 1, len - 1);
- if (extra > 0) { n += static_cast<size_t>(extra); }
- }
- err.code = ErrorCode::Success;
- return static_cast<ssize_t>(n);
- }
- int ret;
- do {
- ret = mbedtls_ssl_read(&msession->ssl, static_cast<unsigned char *>(buf),
- len);
- } while (impl::mbedtls_is_session_ticket(ret));
- if (ret > 0) {
- err.code = ErrorCode::Success;
- return static_cast<ssize_t>(ret);
- }
- if (ret == 0) {
- err.code = ErrorCode::PeerClosed;
- return 0;
- }
- err.code = impl::map_mbedtls_error(ret, err.sys_errno, 0);
- err.backend_code = static_cast<uint64_t>(-ret);
- impl::mbedtls_last_error() = ret;
- // mbedTLS signals a clean close_notify via a negative error code rather
- // than 0; surface it as a clean EOF the way OpenSSL/wolfSSL do.
- if (err.code == ErrorCode::PeerClosed) { return 0; }
- return -1;
- }
- inline ssize_t write(session_t session, const void *buf, size_t len,
- TlsError &err) {
- if (!session || !buf) {
- err.code = ErrorCode::Fatal;
- return -1;
- }
- auto msession = static_cast<impl::MbedTlsSession *>(session);
- int ret;
- do {
- ret = mbedtls_ssl_write(&msession->ssl,
- static_cast<const unsigned char *>(buf), len);
- } while (impl::mbedtls_is_session_ticket(ret));
- if (ret > 0) {
- err.code = ErrorCode::Success;
- return static_cast<ssize_t>(ret);
- }
- if (ret == 0) {
- err.code = ErrorCode::PeerClosed;
- return 0;
- }
- err.code = impl::map_mbedtls_error(ret, err.sys_errno, 0);
- err.backend_code = static_cast<uint64_t>(-ret);
- impl::mbedtls_last_error() = ret;
- return -1;
- }
- inline int pending(const_session_t session) {
- if (!session) { return 0; }
- auto msession =
- static_cast<impl::MbedTlsSession *>(const_cast<void *>(session));
- return static_cast<int>(mbedtls_ssl_get_bytes_avail(&msession->ssl)) +
- (msession->has_peeked_byte ? 1 : 0);
- }
- inline void shutdown(session_t session, bool graceful) {
- if (!session) { return; }
- auto msession = static_cast<impl::MbedTlsSession *>(session);
- if (graceful) {
- // Try to send close_notify, but don't block forever
- int ret;
- int attempts = 0;
- while ((ret = mbedtls_ssl_close_notify(&msession->ssl)) != 0 &&
- attempts < 3) {
- if (ret != MBEDTLS_ERR_SSL_WANT_READ &&
- ret != MBEDTLS_ERR_SSL_WANT_WRITE) {
- break;
- }
- attempts++;
- }
- }
- }
- inline bool is_peer_closed(session_t session, socket_t sock) {
- if (!session || sock == INVALID_SOCKET) { return true; }
- auto msession = static_cast<impl::MbedTlsSession *>(session);
- // Check if there's already decrypted or pushed-back data available.
- // If so, the connection is definitely alive.
- if (msession->has_peeked_byte ||
- mbedtls_ssl_get_bytes_avail(&msession->ssl) > 0) {
- return false;
- }
- // Set socket to non-blocking to avoid blocking on read
- detail::set_nonblocking(sock, true);
- auto cleanup =
- detail::scope_exit([&]() { detail::set_nonblocking(sock, false); });
- // Probe with a 1-byte read (Mbed TLS has no peek API). If the probe lands
- // on application data — e.g. a response that already arrived — push the
- // byte back so the next read() delivers it instead of losing it.
- unsigned char buf;
- int ret;
- do {
- ret = mbedtls_ssl_read(&msession->ssl, &buf, 1);
- } while (impl::mbedtls_is_session_ticket(ret));
- // If we got data or WANT_READ (would block), connection is alive
- if (ret > 0) {
- msession->peeked_byte = buf;
- msession->has_peeked_byte = true;
- return false;
- }
- if (ret == MBEDTLS_ERR_SSL_WANT_READ) { return false; }
- // If we get a peer close notify or a connection reset, the peer is closed
- return ret == MBEDTLS_ERR_SSL_PEER_CLOSE_NOTIFY ||
- ret == MBEDTLS_ERR_NET_CONN_RESET || ret == 0;
- }
- inline cert_t get_peer_cert(const_session_t session) {
- if (!session) { return nullptr; }
- auto msession =
- static_cast<impl::MbedTlsSession *>(const_cast<void *>(session));
- // Mbed TLS returns a pointer to the internal peer cert chain.
- // WARNING: This pointer is only valid while the session is active.
- // Do not use the certificate after calling free_session().
- const mbedtls_x509_crt *cert = mbedtls_ssl_get_peer_cert(&msession->ssl);
- return const_cast<mbedtls_x509_crt *>(cert);
- }
- inline void free_cert(cert_t cert) {
- // Mbed TLS: peer certificate is owned by the SSL context.
- // No-op here, but callers should still call this for cross-backend
- // portability.
- (void)cert;
- }
- inline bool verify_hostname(cert_t cert, const char *hostname) {
- if (!cert || !hostname) { return false; }
- auto mcert = static_cast<const mbedtls_x509_crt *>(cert);
- std::string host_str(hostname);
- // Check if hostname is an IP address (IPv4 or IPv6)
- unsigned char ip_bytes[16];
- auto ip_len = impl::parse_ip_address(host_str, ip_bytes);
- auto is_ip = ip_len > 0;
- // Check Subject Alternative Names (SAN)
- // In Mbed TLS 3.x, subject_alt_names contains raw values without ASN.1 tags
- // - DNS names: raw string bytes
- // - IP addresses: raw IP bytes (4 for IPv4, 16 for IPv6)
- const mbedtls_x509_sequence *san = &mcert->subject_alt_names;
- while (san != nullptr && san->buf.p != nullptr && san->buf.len > 0) {
- const unsigned char *p = san->buf.p;
- size_t len = san->buf.len;
- if (is_ip) {
- // For an IP host, only a matching iPAddress SAN of the same family
- // (4 bytes for IPv4, 16 bytes for IPv6) may authenticate it.
- if (len == ip_len && memcmp(p, ip_bytes, ip_len) == 0) { return true; }
- } else {
- // Check if this SAN is a DNS name (printable ASCII string)
- bool is_dns = len > 0;
- for (size_t i = 0; i < len && is_dns; i++) {
- if (p[i] < 32 || p[i] > 126) { is_dns = false; }
- }
- if (is_dns) {
- std::string san_name(reinterpret_cast<const char *>(p), len);
- if (detail::match_hostname(san_name, host_str)) { return true; }
- }
- }
- san = san->next;
- }
- // Fallback: Check Common Name (CN) in subject. Skipped for IP-literal hosts:
- // an IP identity is only valid via an iPAddress SAN, never the CN (RFC 9110;
- // the OpenSSL backend's X509_check_ip behaves the same way).
- if (!is_ip) {
- char cn[256];
- int ret = mbedtls_x509_dn_gets(cn, sizeof(cn), &mcert->subject);
- if (ret > 0) {
- std::string cn_str(cn);
- // Look for "CN=" in the DN string
- size_t cn_pos = cn_str.find("CN=");
- if (cn_pos != std::string::npos) {
- size_t start = cn_pos + 3;
- size_t end = cn_str.find(',', start);
- std::string cn_value =
- cn_str.substr(start, end == std::string::npos ? end : end - start);
- if (detail::match_hostname(cn_value, host_str)) { return true; }
- }
- }
- }
- return false;
- }
- inline uint64_t hostname_mismatch_code() {
- return static_cast<uint64_t>(MBEDTLS_X509_BADCERT_CN_MISMATCH);
- }
- inline long get_verify_result(const_session_t session) {
- if (!session) { return -1; }
- auto msession =
- static_cast<impl::MbedTlsSession *>(const_cast<void *>(session));
- uint32_t flags = mbedtls_ssl_get_verify_result(&msession->ssl);
- // Return 0 (X509_V_OK equivalent) if verification passed
- return flags == 0 ? 0 : static_cast<long>(flags);
- }
- inline std::string get_cert_subject_cn(cert_t cert) {
- if (!cert) return "";
- auto x509 = static_cast<mbedtls_x509_crt *>(cert);
- // Find the CN in the subject
- const mbedtls_x509_name *name = &x509->subject;
- while (name != nullptr) {
- if (MBEDTLS_OID_CMP(MBEDTLS_OID_AT_CN, &name->oid) == 0) {
- return std::string(reinterpret_cast<const char *>(name->val.p),
- name->val.len);
- }
- name = name->next;
- }
- return "";
- }
- inline std::string get_cert_issuer_name(cert_t cert) {
- if (!cert) return "";
- auto x509 = static_cast<mbedtls_x509_crt *>(cert);
- // Build a human-readable issuer name string
- char buf[512];
- int ret = mbedtls_x509_dn_gets(buf, sizeof(buf), &x509->issuer);
- if (ret < 0) return "";
- return std::string(buf);
- }
- inline bool get_cert_sans(cert_t cert, std::vector<SanEntry> &sans) {
- sans.clear();
- if (!cert) return false;
- auto x509 = static_cast<mbedtls_x509_crt *>(cert);
- // Parse the Subject Alternative Name extension
- const mbedtls_x509_sequence *cur = &x509->subject_alt_names;
- while (cur != nullptr) {
- if (cur->buf.len > 0) {
- // Mbed TLS stores SAN as ASN.1 sequences
- // The tag byte indicates the type
- const unsigned char *p = cur->buf.p;
- size_t len = cur->buf.len;
- // First byte is the tag
- unsigned char tag = *p;
- p++;
- len--;
- // Parse length (simple single-byte length assumed)
- if (len > 0 && *p < 0x80) {
- size_t value_len = *p;
- p++;
- len--;
- if (value_len <= len) {
- SanEntry entry;
- // ASN.1 context tags for GeneralName
- switch (tag & 0x1F) {
- case 2: // dNSName
- entry.type = SanType::DNS;
- entry.value =
- std::string(reinterpret_cast<const char *>(p), value_len);
- break;
- case 7: // iPAddress
- entry.type = SanType::IP;
- if (value_len == 4) {
- // IPv4
- char buf[16];
- snprintf(buf, sizeof(buf), "%d.%d.%d.%d", p[0], p[1], p[2], p[3]);
- entry.value = buf;
- } else if (value_len == 16) {
- // IPv6
- char buf[64];
- snprintf(buf, sizeof(buf),
- "%02x%02x:%02x%02x:%02x%02x:%02x%02x:"
- "%02x%02x:%02x%02x:%02x%02x:%02x%02x",
- p[0], p[1], p[2], p[3], p[4], p[5], p[6], p[7], p[8],
- p[9], p[10], p[11], p[12], p[13], p[14], p[15]);
- entry.value = buf;
- }
- break;
- case 1: // rfc822Name (email)
- entry.type = SanType::EMAIL;
- entry.value =
- std::string(reinterpret_cast<const char *>(p), value_len);
- break;
- case 6: // uniformResourceIdentifier
- entry.type = SanType::URI;
- entry.value =
- std::string(reinterpret_cast<const char *>(p), value_len);
- break;
- default: entry.type = SanType::OTHER; break;
- }
- if (!entry.value.empty()) { sans.push_back(std::move(entry)); }
- }
- }
- }
- cur = cur->next;
- }
- return true;
- }
- inline bool get_cert_validity(cert_t cert, time_t ¬_before,
- time_t ¬_after) {
- if (!cert) return false;
- auto x509 = static_cast<mbedtls_x509_crt *>(cert);
- // Convert mbedtls_x509_time to time_t
- auto to_time_t = [](const mbedtls_x509_time &t) -> time_t {
- struct tm tm_time = {};
- tm_time.tm_year = t.year - 1900;
- tm_time.tm_mon = t.mon - 1;
- tm_time.tm_mday = t.day;
- tm_time.tm_hour = t.hour;
- tm_time.tm_min = t.min;
- tm_time.tm_sec = t.sec;
- #ifdef _WIN32
- return _mkgmtime(&tm_time);
- #else
- return timegm(&tm_time);
- #endif
- };
- not_before = to_time_t(x509->valid_from);
- not_after = to_time_t(x509->valid_to);
- return true;
- }
- inline std::string get_cert_serial(cert_t cert) {
- if (!cert) return "";
- auto x509 = static_cast<mbedtls_x509_crt *>(cert);
- // Convert serial number to hex string
- std::string result;
- result.reserve(x509->serial.len * 2);
- for (size_t i = 0; i < x509->serial.len; i++) {
- char hex[3];
- snprintf(hex, sizeof(hex), "%02X", x509->serial.p[i]);
- result += hex;
- }
- return result;
- }
- inline bool get_cert_der(cert_t cert, std::vector<unsigned char> &der) {
- if (!cert) return false;
- auto crt = static_cast<mbedtls_x509_crt *>(cert);
- if (!crt->raw.p || crt->raw.len == 0) return false;
- der.assign(crt->raw.p, crt->raw.p + crt->raw.len);
- return true;
- }
- inline const char *get_sni(const_session_t session) {
- if (!session) return nullptr;
- auto msession = static_cast<const impl::MbedTlsSession *>(session);
- // For server: return SNI received from client during handshake
- if (!msession->sni_hostname.empty()) {
- return msession->sni_hostname.c_str();
- }
- // For client: return the hostname set via set_sni
- if (!msession->hostname.empty()) { return msession->hostname.c_str(); }
- return nullptr;
- }
- inline uint64_t peek_error() {
- // Mbed TLS doesn't have an error queue, return the last error
- return static_cast<uint64_t>(-impl::mbedtls_last_error());
- }
- inline uint64_t get_error() {
- // Mbed TLS doesn't have an error queue, return and clear the last error
- uint64_t err = static_cast<uint64_t>(-impl::mbedtls_last_error());
- impl::mbedtls_last_error() = 0;
- return err;
- }
- inline std::string error_string(uint64_t code) {
- char buf[256];
- mbedtls_strerror(-static_cast<int>(code), buf, sizeof(buf));
- return std::string(buf);
- }
- inline ca_store_t create_ca_store(const char *pem, size_t len) {
- auto *ca_chain = new (std::nothrow) mbedtls_x509_crt;
- if (!ca_chain) { return nullptr; }
- mbedtls_x509_crt_init(ca_chain);
- // mbedtls_x509_crt_parse expects null-terminated PEM
- int ret = mbedtls_x509_crt_parse(ca_chain,
- reinterpret_cast<const unsigned char *>(pem),
- len + 1); // +1 for null terminator
- if (ret != 0) {
- // Try without +1 in case PEM is already null-terminated
- ret = mbedtls_x509_crt_parse(
- ca_chain, reinterpret_cast<const unsigned char *>(pem), len);
- if (ret != 0) {
- mbedtls_x509_crt_free(ca_chain);
- delete ca_chain;
- return nullptr;
- }
- }
- return static_cast<ca_store_t>(ca_chain);
- }
- inline void free_ca_store(ca_store_t store) {
- if (store) {
- auto *ca_chain = static_cast<mbedtls_x509_crt *>(store);
- mbedtls_x509_crt_free(ca_chain);
- delete ca_chain;
- }
- }
- inline bool set_ca_store(ctx_t ctx, ca_store_t store) {
- if (!ctx || !store) { return false; }
- auto *mbed_ctx = static_cast<impl::MbedTlsContext *>(ctx);
- auto *ca_chain = static_cast<mbedtls_x509_crt *>(store);
- // Free existing CA chain
- mbedtls_x509_crt_free(&mbed_ctx->ca_chain);
- mbedtls_x509_crt_init(&mbed_ctx->ca_chain);
- // Copy the CA chain (deep copy)
- // Parse from the raw data of the source cert
- mbedtls_x509_crt *src = ca_chain;
- while (src != nullptr) {
- int ret = mbedtls_x509_crt_parse_der(&mbed_ctx->ca_chain, src->raw.p,
- src->raw.len);
- if (ret != 0) {
- free_ca_store(store);
- return false;
- }
- src = src->next;
- }
- // This function takes ownership of the store; the chain was deep-copied
- // above, so release the source
- free_ca_store(store);
- // Update the SSL config to use the new CA chain
- mbedtls_ssl_conf_ca_chain(&mbed_ctx->conf, &mbed_ctx->ca_chain, nullptr);
- return true;
- }
- inline size_t get_ca_certs(ctx_t ctx, std::vector<cert_t> &certs) {
- certs.clear();
- if (!ctx) { return 0; }
- auto *mbed_ctx = static_cast<impl::MbedTlsContext *>(ctx);
- // Iterate through the CA chain
- mbedtls_x509_crt *cert = &mbed_ctx->ca_chain;
- while (cert != nullptr && cert->raw.len > 0) {
- // Create a copy of the certificate for the caller
- auto *copy = new mbedtls_x509_crt;
- mbedtls_x509_crt_init(copy);
- int ret = mbedtls_x509_crt_parse_der(copy, cert->raw.p, cert->raw.len);
- if (ret == 0) {
- certs.push_back(static_cast<cert_t>(copy));
- } else {
- mbedtls_x509_crt_free(copy);
- delete copy;
- }
- cert = cert->next;
- }
- return certs.size();
- }
- inline std::vector<std::string> get_ca_names(ctx_t ctx) {
- std::vector<std::string> names;
- if (!ctx) { return names; }
- auto *mbed_ctx = static_cast<impl::MbedTlsContext *>(ctx);
- // Iterate through the CA chain
- mbedtls_x509_crt *cert = &mbed_ctx->ca_chain;
- while (cert != nullptr && cert->raw.len > 0) {
- char buf[512];
- int ret = mbedtls_x509_dn_gets(buf, sizeof(buf), &cert->subject);
- if (ret > 0) { names.push_back(buf); }
- cert = cert->next;
- }
- return names;
- }
- inline bool update_server_cert(ctx_t ctx, const char *cert_pem,
- const char *key_pem, const char *password) {
- if (!ctx || !cert_pem || !key_pem) { return false; }
- auto *mbed_ctx = static_cast<impl::MbedTlsContext *>(ctx);
- // Free existing certificate and key
- mbedtls_x509_crt_free(&mbed_ctx->own_cert);
- mbedtls_pk_free(&mbed_ctx->own_key);
- mbedtls_x509_crt_init(&mbed_ctx->own_cert);
- mbedtls_pk_init(&mbed_ctx->own_key);
- // Parse certificate PEM
- int ret = mbedtls_x509_crt_parse(
- &mbed_ctx->own_cert, reinterpret_cast<const unsigned char *>(cert_pem),
- strlen(cert_pem) + 1);
- if (ret != 0) {
- impl::mbedtls_last_error() = ret;
- return false;
- }
- // Parse private key PEM
- #if defined(CPPHTTPLIB_MBEDTLS_V3) && !defined(CPPHTTPLIB_MBEDTLS_V4)
- ret = mbedtls_pk_parse_key(
- &mbed_ctx->own_key, reinterpret_cast<const unsigned char *>(key_pem),
- strlen(key_pem) + 1,
- password ? reinterpret_cast<const unsigned char *>(password) : nullptr,
- password ? strlen(password) : 0, mbedtls_ctr_drbg_random,
- &mbed_ctx->ctr_drbg);
- #else
- ret = mbedtls_pk_parse_key(
- &mbed_ctx->own_key, reinterpret_cast<const unsigned char *>(key_pem),
- strlen(key_pem) + 1,
- password ? reinterpret_cast<const unsigned char *>(password) : nullptr,
- password ? strlen(password) : 0);
- #endif
- if (ret != 0) {
- impl::mbedtls_last_error() = ret;
- return false;
- }
- // Configure SSL to use the new certificate and key
- ret = mbedtls_ssl_conf_own_cert(&mbed_ctx->conf, &mbed_ctx->own_cert,
- &mbed_ctx->own_key);
- if (ret != 0) {
- impl::mbedtls_last_error() = ret;
- return false;
- }
- return true;
- }
- inline bool update_server_client_ca(ctx_t ctx, const char *ca_pem) {
- if (!ctx || !ca_pem) { return false; }
- auto *mbed_ctx = static_cast<impl::MbedTlsContext *>(ctx);
- // Free existing CA chain
- mbedtls_x509_crt_free(&mbed_ctx->ca_chain);
- mbedtls_x509_crt_init(&mbed_ctx->ca_chain);
- // Parse CA PEM
- int ret = mbedtls_x509_crt_parse(
- &mbed_ctx->ca_chain, reinterpret_cast<const unsigned char *>(ca_pem),
- strlen(ca_pem) + 1);
- if (ret != 0) {
- impl::mbedtls_last_error() = ret;
- return false;
- }
- // Update SSL config to use new CA chain
- mbedtls_ssl_conf_ca_chain(&mbed_ctx->conf, &mbed_ctx->ca_chain, nullptr);
- return true;
- }
- inline bool set_verify_callback(ctx_t ctx, VerifyCallback callback) {
- if (!ctx) { return false; }
- auto *mbed_ctx = static_cast<impl::MbedTlsContext *>(ctx);
- impl::get_verify_callback() = std::move(callback);
- mbed_ctx->has_verify_callback =
- static_cast<bool>(impl::get_verify_callback());
- if (mbed_ctx->has_verify_callback) {
- // Set OPTIONAL mode to ensure callback is called even when verification
- // is disabled (matching OpenSSL behavior where SSL_VERIFY_PEER is set)
- mbedtls_ssl_conf_authmode(&mbed_ctx->conf, MBEDTLS_SSL_VERIFY_OPTIONAL);
- mbedtls_ssl_conf_verify(&mbed_ctx->conf, impl::mbedtls_verify_callback,
- nullptr);
- } else {
- mbedtls_ssl_conf_verify(&mbed_ctx->conf, nullptr, nullptr);
- }
- return true;
- }
- inline long get_verify_error(const_session_t session) {
- if (!session) { return -1; }
- auto *msession =
- static_cast<impl::MbedTlsSession *>(const_cast<void *>(session));
- return static_cast<long>(mbedtls_ssl_get_verify_result(&msession->ssl));
- }
- inline std::string verify_error_string(long error_code) {
- if (error_code == 0) { return ""; }
- char buf[256];
- mbedtls_x509_crt_verify_info(buf, sizeof(buf), "",
- static_cast<uint32_t>(error_code));
- // Remove trailing newline if present
- std::string result(buf);
- while (!result.empty() && (result.back() == '\n' || result.back() == ' ')) {
- result.pop_back();
- }
- return result;
- }
- } // namespace tls
- #endif // CPPHTTPLIB_MBEDTLS_SUPPORT
- /*
- * Group 10: TLS abstraction layer - wolfSSL backend
- */
- /*
- * wolfSSL Backend Implementation
- */
- #ifdef CPPHTTPLIB_WOLFSSL_SUPPORT
- namespace tls {
- namespace impl {
- // wolfSSL session wrapper
- struct WolfSSLSession {
- WOLFSSL *ssl = nullptr;
- socket_t sock = INVALID_SOCKET;
- std::string hostname; // For client: set via set_sni
- std::string sni_hostname; // For server: received from client via SNI callback
- WolfSSLSession() = default;
- ~WolfSSLSession() {
- if (ssl) { wolfSSL_free(ssl); }
- }
- WolfSSLSession(const WolfSSLSession &) = delete;
- WolfSSLSession &operator=(const WolfSSLSession &) = delete;
- };
- // Thread-local error code accessor for wolfSSL
- inline uint64_t &wolfssl_last_error() {
- static thread_local uint64_t err = 0;
- return err;
- }
- // Helper to map wolfSSL error to ErrorCode.
- // ssl_error is the value from wolfSSL_get_error().
- // raw_ret is the raw return value from the wolfSSL call (for low-level error).
- inline ErrorCode map_wolfssl_error(WOLFSSL *ssl, int ssl_error,
- int &out_errno) {
- switch (ssl_error) {
- case SSL_ERROR_NONE: return ErrorCode::Success;
- case SSL_ERROR_WANT_READ: return ErrorCode::WantRead;
- case SSL_ERROR_WANT_WRITE: return ErrorCode::WantWrite;
- case SSL_ERROR_ZERO_RETURN: return ErrorCode::PeerClosed;
- case SSL_ERROR_SYSCALL: out_errno = errno; return ErrorCode::SyscallError;
- default:
- if (ssl) {
- // wolfSSL stores the low-level error code as a negative value.
- // DOMAIN_NAME_MISMATCH (-322) indicates hostname verification failure.
- int low_err = ssl_error; // wolfSSL_get_error returns the low-level code
- if (low_err == DOMAIN_NAME_MISMATCH) {
- return ErrorCode::HostnameMismatch;
- }
- // Check verify result to distinguish cert verification from generic SSL
- // errors.
- long vr = wolfSSL_get_verify_result(ssl);
- if (vr != 0) { return ErrorCode::CertVerifyFailed; }
- }
- return ErrorCode::Fatal;
- }
- }
- // WolfSSLContext constructor/destructor implementations
- inline WolfSSLContext::WolfSSLContext() { wolfSSL_Init(); }
- inline WolfSSLContext::~WolfSSLContext() {
- if (ctx) { wolfSSL_CTX_free(ctx); }
- }
- // Thread-local storage for SNI captured during handshake
- inline std::string &wolfssl_pending_sni() {
- static thread_local std::string sni;
- return sni;
- }
- // SNI callback for wolfSSL server to capture client's SNI hostname
- inline int wolfssl_sni_callback(WOLFSSL *ssl, int *ret, void *exArg) {
- (void)ret;
- (void)exArg;
- void *name_data = nullptr;
- unsigned short name_len =
- wolfSSL_SNI_GetRequest(ssl, WOLFSSL_SNI_HOST_NAME, &name_data);
- if (name_data && name_len > 0) {
- wolfssl_pending_sni().assign(static_cast<const char *>(name_data),
- name_len);
- } else {
- wolfssl_pending_sni().clear();
- }
- return 0; // Continue regardless
- }
- // wolfSSL verify callback wrapper
- inline int wolfssl_verify_callback(int preverify_ok,
- WOLFSSL_X509_STORE_CTX *x509_ctx) {
- auto &callback = get_verify_callback();
- if (!callback) { return preverify_ok; }
- WOLFSSL_X509 *cert = wolfSSL_X509_STORE_CTX_get_current_cert(x509_ctx);
- int depth = wolfSSL_X509_STORE_CTX_get_error_depth(x509_ctx);
- int err = wolfSSL_X509_STORE_CTX_get_error(x509_ctx);
- // Get the WOLFSSL object from the X509_STORE_CTX
- WOLFSSL *ssl = static_cast<WOLFSSL *>(wolfSSL_X509_STORE_CTX_get_ex_data(
- x509_ctx, wolfSSL_get_ex_data_X509_STORE_CTX_idx()));
- VerifyContext verify_ctx;
- verify_ctx.session = static_cast<session_t>(ssl);
- verify_ctx.cert = static_cast<cert_t>(cert);
- verify_ctx.depth = depth;
- verify_ctx.preverify_ok = (preverify_ok != 0);
- verify_ctx.error_code = static_cast<long>(err);
- if (err != 0) {
- verify_ctx.error_string = wolfSSL_X509_verify_cert_error_string(err);
- } else {
- verify_ctx.error_string = nullptr;
- }
- bool accepted = callback(verify_ctx);
- return accepted ? 1 : 0;
- }
- inline void set_wolfssl_password_cb(WOLFSSL_CTX *ctx, const char *password) {
- wolfSSL_CTX_set_default_passwd_cb_userdata(ctx, const_cast<char *>(password));
- wolfSSL_CTX_set_default_passwd_cb(
- ctx, [](char *buf, int size, int /*rwflag*/, void *userdata) -> int {
- auto *pwd = static_cast<const char *>(userdata);
- if (!pwd) return 0;
- auto len = static_cast<int>(strlen(pwd));
- if (len > size) len = size;
- memcpy(buf, pwd, static_cast<size_t>(len));
- return len;
- });
- }
- } // namespace impl
- inline ctx_t create_client_context() {
- auto ctx = new (std::nothrow) impl::WolfSSLContext();
- if (!ctx) { return nullptr; }
- ctx->is_server = false;
- WOLFSSL_METHOD *method = wolfTLSv1_2_client_method();
- if (!method) {
- delete ctx;
- return nullptr;
- }
- ctx->ctx = wolfSSL_CTX_new(method);
- if (!ctx->ctx) {
- delete ctx;
- return nullptr;
- }
- // Default: verify peer certificate
- wolfSSL_CTX_set_verify(ctx->ctx, SSL_VERIFY_PEER, nullptr);
- return static_cast<ctx_t>(ctx);
- }
- inline ctx_t create_server_context() {
- auto ctx = new (std::nothrow) impl::WolfSSLContext();
- if (!ctx) { return nullptr; }
- ctx->is_server = true;
- WOLFSSL_METHOD *method = wolfTLSv1_2_server_method();
- if (!method) {
- delete ctx;
- return nullptr;
- }
- ctx->ctx = wolfSSL_CTX_new(method);
- if (!ctx->ctx) {
- delete ctx;
- return nullptr;
- }
- // Default: don't verify client
- wolfSSL_CTX_set_verify(ctx->ctx, SSL_VERIFY_NONE, nullptr);
- // Enable SNI on server
- wolfSSL_CTX_SNI_SetOptions(ctx->ctx, WOLFSSL_SNI_HOST_NAME,
- WOLFSSL_SNI_CONTINUE_ON_MISMATCH);
- wolfSSL_CTX_set_servername_callback(ctx->ctx, impl::wolfssl_sni_callback);
- return static_cast<ctx_t>(ctx);
- }
- inline void free_context(ctx_t ctx) {
- if (ctx) { delete static_cast<impl::WolfSSLContext *>(ctx); }
- }
- inline bool set_min_version(ctx_t ctx, Version version) {
- if (!ctx) { return false; }
- auto wctx = static_cast<impl::WolfSSLContext *>(ctx);
- int min_ver = WOLFSSL_TLSV1_2;
- if (version >= Version::TLS1_3) { min_ver = WOLFSSL_TLSV1_3; }
- return wolfSSL_CTX_SetMinVersion(wctx->ctx, min_ver) == WOLFSSL_SUCCESS;
- }
- inline bool load_ca_pem(ctx_t ctx, const char *pem, size_t len) {
- if (!ctx || !pem) { return false; }
- auto wctx = static_cast<impl::WolfSSLContext *>(ctx);
- int ret = wolfSSL_CTX_load_verify_buffer(
- wctx->ctx, reinterpret_cast<const unsigned char *>(pem),
- static_cast<long>(len), SSL_FILETYPE_PEM);
- if (ret != SSL_SUCCESS) {
- impl::wolfssl_last_error() =
- static_cast<uint64_t>(wolfSSL_ERR_peek_last_error());
- return false;
- }
- wctx->ca_pem_data_.append(pem, len);
- return true;
- }
- inline bool load_ca_file(ctx_t ctx, const char *file_path) {
- if (!ctx || !file_path) { return false; }
- auto wctx = static_cast<impl::WolfSSLContext *>(ctx);
- int ret = wolfSSL_CTX_load_verify_locations(wctx->ctx, file_path, nullptr);
- if (ret != SSL_SUCCESS) {
- impl::wolfssl_last_error() =
- static_cast<uint64_t>(wolfSSL_ERR_peek_last_error());
- return false;
- }
- return true;
- }
- inline bool load_ca_dir(ctx_t ctx, const char *dir_path) {
- if (!ctx || !dir_path) { return false; }
- auto wctx = static_cast<impl::WolfSSLContext *>(ctx);
- int ret = wolfSSL_CTX_load_verify_locations(wctx->ctx, nullptr, dir_path);
- // wolfSSL may fail if the directory doesn't contain properly hashed certs.
- // Unlike OpenSSL which lazily loads certs from directories, wolfSSL scans
- // immediately. Return true even on failure since the CA file may have
- // already been loaded, matching OpenSSL's lenient behavior.
- (void)ret;
- return true;
- }
- inline bool load_system_certs(ctx_t ctx) {
- if (!ctx) { return false; }
- auto wctx = static_cast<impl::WolfSSLContext *>(ctx);
- bool loaded = false;
- #ifdef _WIN32
- loaded = impl::enumerate_windows_system_certs(
- [&](const unsigned char *data, size_t len) {
- return wolfSSL_CTX_load_verify_buffer(wctx->ctx, data,
- static_cast<long>(len),
- SSL_FILETYPE_ASN1) == SSL_SUCCESS;
- });
- #elif defined(__APPLE__) && defined(CPPHTTPLIB_USE_CERTS_FROM_MACOSX_KEYCHAIN)
- loaded = impl::enumerate_macos_keychain_certs(
- [&](const unsigned char *data, size_t len) {
- return wolfSSL_CTX_load_verify_buffer(wctx->ctx, data,
- static_cast<long>(len),
- SSL_FILETYPE_ASN1) == SSL_SUCCESS;
- });
- #else
- for (auto path = impl::system_ca_paths(); *path; ++path) {
- if (wolfSSL_CTX_load_verify_locations(wctx->ctx, *path, nullptr) ==
- SSL_SUCCESS) {
- loaded = true;
- break;
- }
- }
- if (!loaded) {
- for (auto dir = impl::system_ca_dirs(); *dir; ++dir) {
- if (wolfSSL_CTX_load_verify_locations(wctx->ctx, nullptr, *dir) ==
- SSL_SUCCESS) {
- loaded = true;
- break;
- }
- }
- }
- #endif
- return loaded;
- }
- inline bool set_client_cert_pem(ctx_t ctx, const char *cert, const char *key,
- const char *password) {
- if (!ctx || !cert || !key) { return false; }
- auto wctx = static_cast<impl::WolfSSLContext *>(ctx);
- // Load certificate
- int ret = wolfSSL_CTX_use_certificate_buffer(
- wctx->ctx, reinterpret_cast<const unsigned char *>(cert),
- static_cast<long>(strlen(cert)), SSL_FILETYPE_PEM);
- if (ret != SSL_SUCCESS) {
- impl::wolfssl_last_error() =
- static_cast<uint64_t>(wolfSSL_ERR_peek_last_error());
- return false;
- }
- // Set password callback if password is provided
- if (password) { impl::set_wolfssl_password_cb(wctx->ctx, password); }
- // Load private key
- ret = wolfSSL_CTX_use_PrivateKey_buffer(
- wctx->ctx, reinterpret_cast<const unsigned char *>(key),
- static_cast<long>(strlen(key)), SSL_FILETYPE_PEM);
- if (ret != SSL_SUCCESS) {
- impl::wolfssl_last_error() =
- static_cast<uint64_t>(wolfSSL_ERR_peek_last_error());
- return false;
- }
- // Verify that the certificate and private key match
- return wolfSSL_CTX_check_private_key(wctx->ctx) == SSL_SUCCESS;
- }
- inline bool set_client_cert_file(ctx_t ctx, const char *cert_path,
- const char *key_path, const char *password) {
- if (!ctx || !cert_path || !key_path) { return false; }
- auto wctx = static_cast<impl::WolfSSLContext *>(ctx);
- // Load certificate file
- int ret =
- wolfSSL_CTX_use_certificate_file(wctx->ctx, cert_path, SSL_FILETYPE_PEM);
- if (ret != SSL_SUCCESS) {
- impl::wolfssl_last_error() =
- static_cast<uint64_t>(wolfSSL_ERR_peek_last_error());
- return false;
- }
- // Set password callback if password is provided
- if (password) { impl::set_wolfssl_password_cb(wctx->ctx, password); }
- // Load private key file
- ret = wolfSSL_CTX_use_PrivateKey_file(wctx->ctx, key_path, SSL_FILETYPE_PEM);
- if (ret != SSL_SUCCESS) {
- impl::wolfssl_last_error() =
- static_cast<uint64_t>(wolfSSL_ERR_peek_last_error());
- return false;
- }
- // Verify that the certificate and private key match
- return wolfSSL_CTX_check_private_key(wctx->ctx) == SSL_SUCCESS;
- }
- inline void set_verify_client(ctx_t ctx, bool require) {
- if (!ctx) { return; }
- auto wctx = static_cast<impl::WolfSSLContext *>(ctx);
- wctx->verify_client = require;
- if (require) {
- wolfSSL_CTX_set_verify(
- wctx->ctx, SSL_VERIFY_PEER | SSL_VERIFY_FAIL_IF_NO_PEER_CERT,
- wctx->has_verify_callback ? impl::wolfssl_verify_callback : nullptr);
- } else {
- if (wctx->has_verify_callback) {
- wolfSSL_CTX_set_verify(wctx->ctx, SSL_VERIFY_PEER,
- impl::wolfssl_verify_callback);
- } else {
- wolfSSL_CTX_set_verify(wctx->ctx, SSL_VERIFY_NONE, nullptr);
- }
- }
- }
- inline session_t create_session(ctx_t ctx, socket_t sock) {
- if (!ctx || sock == INVALID_SOCKET) { return nullptr; }
- auto wctx = static_cast<impl::WolfSSLContext *>(ctx);
- auto session = new (std::nothrow) impl::WolfSSLSession();
- if (!session) { return nullptr; }
- session->sock = sock;
- session->ssl = wolfSSL_new(wctx->ctx);
- if (!session->ssl) {
- impl::wolfssl_last_error() =
- static_cast<uint64_t>(wolfSSL_ERR_peek_last_error());
- delete session;
- return nullptr;
- }
- wolfSSL_set_fd(session->ssl, static_cast<int>(sock));
- return static_cast<session_t>(session);
- }
- inline void free_session(session_t session) {
- if (session) { delete static_cast<impl::WolfSSLSession *>(session); }
- }
- inline bool set_sni(session_t session, const char *hostname,
- bool verify_hostname) {
- if (!session || !hostname) { return false; }
- auto wsession = static_cast<impl::WolfSSLSession *>(session);
- int ret = wolfSSL_UseSNI(wsession->ssl, WOLFSSL_SNI_HOST_NAME, hostname,
- static_cast<word16>(strlen(hostname)));
- if (ret != WOLFSSL_SUCCESS) {
- impl::wolfssl_last_error() =
- static_cast<uint64_t>(wolfSSL_ERR_peek_last_error());
- return false;
- }
- // wolfSSL_check_domain_name binds identity checking to the handshake,
- // separately from the SNI extension sent above; skip it when hostname
- // verification is disabled so only the chain is checked, matching OpenSSL.
- if (verify_hostname) { wolfSSL_check_domain_name(wsession->ssl, hostname); }
- wsession->hostname = hostname;
- return true;
- }
- inline TlsError connect(session_t session) {
- TlsError err;
- if (!session) {
- err.code = ErrorCode::Fatal;
- return err;
- }
- auto wsession = static_cast<impl::WolfSSLSession *>(session);
- int ret = wolfSSL_connect(wsession->ssl);
- if (ret == SSL_SUCCESS) {
- err.code = ErrorCode::Success;
- } else {
- int ssl_error = wolfSSL_get_error(wsession->ssl, ret);
- err.code = impl::map_wolfssl_error(wsession->ssl, ssl_error, err.sys_errno);
- err.backend_code = static_cast<uint64_t>(ssl_error);
- impl::wolfssl_last_error() = err.backend_code;
- }
- return err;
- }
- inline TlsError accept(session_t session) {
- TlsError err;
- if (!session) {
- err.code = ErrorCode::Fatal;
- return err;
- }
- auto wsession = static_cast<impl::WolfSSLSession *>(session);
- int ret = wolfSSL_accept(wsession->ssl);
- if (ret == SSL_SUCCESS) {
- err.code = ErrorCode::Success;
- // Capture SNI from thread-local storage after successful handshake
- wsession->sni_hostname = std::move(impl::wolfssl_pending_sni());
- impl::wolfssl_pending_sni().clear();
- } else {
- int ssl_error = wolfSSL_get_error(wsession->ssl, ret);
- err.code = impl::map_wolfssl_error(wsession->ssl, ssl_error, err.sys_errno);
- err.backend_code = static_cast<uint64_t>(ssl_error);
- impl::wolfssl_last_error() = err.backend_code;
- }
- return err;
- }
- inline bool connect_nonblocking(session_t session, socket_t sock,
- time_t timeout_sec, time_t timeout_usec,
- TlsError *err) {
- if (!session) {
- if (err) { err->code = ErrorCode::Fatal; }
- return false;
- }
- auto wsession = static_cast<impl::WolfSSLSession *>(session);
- // Set socket to non-blocking mode
- detail::set_nonblocking(sock, true);
- auto cleanup =
- detail::scope_exit([&]() { detail::set_nonblocking(sock, false); });
- int ret;
- while ((ret = wolfSSL_connect(wsession->ssl)) != SSL_SUCCESS) {
- int ssl_error = wolfSSL_get_error(wsession->ssl, ret);
- if (ssl_error == SSL_ERROR_WANT_READ) {
- if (detail::select_read(sock, timeout_sec, timeout_usec) > 0) {
- continue;
- }
- } else if (ssl_error == SSL_ERROR_WANT_WRITE) {
- if (detail::select_write(sock, timeout_sec, timeout_usec) > 0) {
- continue;
- }
- }
- // Error or timeout
- if (err) {
- err->code =
- impl::map_wolfssl_error(wsession->ssl, ssl_error, err->sys_errno);
- err->backend_code = static_cast<uint64_t>(ssl_error);
- }
- impl::wolfssl_last_error() = static_cast<uint64_t>(ssl_error);
- return false;
- }
- if (err) { err->code = ErrorCode::Success; }
- return true;
- }
- inline bool accept_nonblocking(session_t session, socket_t sock,
- time_t timeout_sec, time_t timeout_usec,
- TlsError *err) {
- if (!session) {
- if (err) { err->code = ErrorCode::Fatal; }
- return false;
- }
- auto wsession = static_cast<impl::WolfSSLSession *>(session);
- // Set socket to non-blocking mode
- detail::set_nonblocking(sock, true);
- auto cleanup =
- detail::scope_exit([&]() { detail::set_nonblocking(sock, false); });
- int ret;
- while ((ret = wolfSSL_accept(wsession->ssl)) != SSL_SUCCESS) {
- int ssl_error = wolfSSL_get_error(wsession->ssl, ret);
- if (ssl_error == SSL_ERROR_WANT_READ) {
- if (detail::select_read(sock, timeout_sec, timeout_usec) > 0) {
- continue;
- }
- } else if (ssl_error == SSL_ERROR_WANT_WRITE) {
- if (detail::select_write(sock, timeout_sec, timeout_usec) > 0) {
- continue;
- }
- }
- // Error or timeout
- if (err) {
- err->code =
- impl::map_wolfssl_error(wsession->ssl, ssl_error, err->sys_errno);
- err->backend_code = static_cast<uint64_t>(ssl_error);
- }
- impl::wolfssl_last_error() = static_cast<uint64_t>(ssl_error);
- return false;
- }
- if (err) { err->code = ErrorCode::Success; }
- // Capture SNI from thread-local storage after successful handshake
- wsession->sni_hostname = std::move(impl::wolfssl_pending_sni());
- impl::wolfssl_pending_sni().clear();
- return true;
- }
- inline ssize_t read(session_t session, void *buf, size_t len, TlsError &err) {
- if (!session || !buf) {
- err.code = ErrorCode::Fatal;
- return -1;
- }
- auto wsession = static_cast<impl::WolfSSLSession *>(session);
- int ret = wolfSSL_read(wsession->ssl, buf, static_cast<int>(len));
- if (ret > 0) {
- err.code = ErrorCode::Success;
- return static_cast<ssize_t>(ret);
- }
- if (ret == 0) {
- err.code = ErrorCode::PeerClosed;
- return 0;
- }
- int ssl_error = wolfSSL_get_error(wsession->ssl, ret);
- err.code = impl::map_wolfssl_error(wsession->ssl, ssl_error, err.sys_errno);
- err.backend_code = static_cast<uint64_t>(ssl_error);
- impl::wolfssl_last_error() = err.backend_code;
- return -1;
- }
- inline ssize_t write(session_t session, const void *buf, size_t len,
- TlsError &err) {
- if (!session || !buf) {
- err.code = ErrorCode::Fatal;
- return -1;
- }
- auto wsession = static_cast<impl::WolfSSLSession *>(session);
- int ret = wolfSSL_write(wsession->ssl, buf, static_cast<int>(len));
- if (ret > 0) {
- err.code = ErrorCode::Success;
- return static_cast<ssize_t>(ret);
- }
- // wolfSSL_write returns 0 when the peer has sent a close_notify.
- // Treat this as an error (return -1) so callers don't spin in a
- // write loop adding zero to the offset.
- if (ret == 0) {
- err.code = ErrorCode::PeerClosed;
- return -1;
- }
- int ssl_error = wolfSSL_get_error(wsession->ssl, ret);
- err.code = impl::map_wolfssl_error(wsession->ssl, ssl_error, err.sys_errno);
- err.backend_code = static_cast<uint64_t>(ssl_error);
- impl::wolfssl_last_error() = err.backend_code;
- return -1;
- }
- inline int pending(const_session_t session) {
- if (!session) { return 0; }
- auto wsession =
- static_cast<impl::WolfSSLSession *>(const_cast<void *>(session));
- return wolfSSL_pending(wsession->ssl);
- }
- inline void shutdown(session_t session, bool graceful) {
- if (!session) { return; }
- auto wsession = static_cast<impl::WolfSSLSession *>(session);
- if (graceful) {
- int ret;
- int attempts = 0;
- while ((ret = wolfSSL_shutdown(wsession->ssl)) != SSL_SUCCESS &&
- attempts < 3) {
- int ssl_error = wolfSSL_get_error(wsession->ssl, ret);
- if (ssl_error != SSL_ERROR_WANT_READ &&
- ssl_error != SSL_ERROR_WANT_WRITE) {
- break;
- }
- attempts++;
- }
- } else {
- wolfSSL_shutdown(wsession->ssl);
- }
- }
- inline bool is_peer_closed(session_t session, socket_t sock) {
- if (!session || sock == INVALID_SOCKET) { return true; }
- auto wsession = static_cast<impl::WolfSSLSession *>(session);
- // Check if there's already decrypted data available
- if (wolfSSL_pending(wsession->ssl) > 0) { return false; }
- // Set socket to non-blocking to avoid blocking on read
- detail::set_nonblocking(sock, true);
- auto cleanup =
- detail::scope_exit([&]() { detail::set_nonblocking(sock, false); });
- // Peek 1 byte to check connection status without consuming data
- unsigned char buf;
- int ret = wolfSSL_peek(wsession->ssl, &buf, 1);
- // If we got data or WANT_READ (would block), connection is alive
- if (ret > 0) { return false; }
- int ssl_error = wolfSSL_get_error(wsession->ssl, ret);
- if (ssl_error == SSL_ERROR_WANT_READ) { return false; }
- return ssl_error == SSL_ERROR_ZERO_RETURN || ssl_error == SSL_ERROR_SYSCALL ||
- ret == 0;
- }
- inline cert_t get_peer_cert(const_session_t session) {
- if (!session) { return nullptr; }
- auto wsession =
- static_cast<impl::WolfSSLSession *>(const_cast<void *>(session));
- WOLFSSL_X509 *cert = wolfSSL_get_peer_certificate(wsession->ssl);
- return static_cast<cert_t>(cert);
- }
- inline void free_cert(cert_t cert) {
- if (cert) { wolfSSL_X509_free(static_cast<WOLFSSL_X509 *>(cert)); }
- }
- inline bool verify_hostname(cert_t cert, const char *hostname) {
- if (!cert || !hostname) { return false; }
- auto x509 = static_cast<WOLFSSL_X509 *>(cert);
- std::string host_str(hostname);
- // Check if hostname is an IP address (IPv4 or IPv6)
- unsigned char ip_bytes[16];
- auto ip_len = impl::parse_ip_address(host_str, ip_bytes);
- auto is_ip = ip_len > 0;
- // Check Subject Alternative Names
- auto *san_names = static_cast<WOLF_STACK_OF(WOLFSSL_GENERAL_NAME) *>(
- wolfSSL_X509_get_ext_d2i(x509, NID_subject_alt_name, nullptr, nullptr));
- if (san_names) {
- int san_count = wolfSSL_sk_num(san_names);
- for (int i = 0; i < san_count; i++) {
- auto *names =
- static_cast<WOLFSSL_GENERAL_NAME *>(wolfSSL_sk_value(san_names, i));
- if (!names) continue;
- if (!is_ip && names->type == WOLFSSL_GEN_DNS) {
- // DNS name
- unsigned char *dns_name = nullptr;
- int dns_len = wolfSSL_ASN1_STRING_to_UTF8(&dns_name, names->d.dNSName);
- if (dns_name && dns_len > 0) {
- std::string san_name(reinterpret_cast<char *>(dns_name),
- static_cast<size_t>(dns_len));
- XFREE(dns_name, nullptr, DYNAMIC_TYPE_OPENSSL);
- if (detail::match_hostname(san_name, host_str)) {
- wolfSSL_sk_free(san_names);
- return true;
- }
- }
- } else if (is_ip && names->type == WOLFSSL_GEN_IPADD) {
- // IP address: only an iPAddress SAN of the same family (4 bytes for
- // IPv4, 16 bytes for IPv6) may authenticate the host.
- unsigned char *ip_data = wolfSSL_ASN1_STRING_data(names->d.iPAddress);
- auto san_ip_len = wolfSSL_ASN1_STRING_length(names->d.iPAddress);
- if (ip_data && san_ip_len == static_cast<int>(ip_len) &&
- memcmp(ip_data, ip_bytes, ip_len) == 0) {
- wolfSSL_sk_free(san_names);
- return true;
- }
- }
- }
- wolfSSL_sk_free(san_names);
- }
- // Fallback: Check Common Name (CN) in subject. Skipped for IP-literal hosts:
- // an IP identity is only valid via an iPAddress SAN, never the CN (RFC 9110;
- // the OpenSSL backend's X509_check_ip behaves the same way).
- auto subject = is_ip ? nullptr : wolfSSL_X509_get_subject_name(x509);
- if (subject) {
- char cn[256] = {};
- int cn_len = wolfSSL_X509_NAME_get_text_by_NID(subject, NID_commonName, cn,
- sizeof(cn));
- if (cn_len > 0) {
- std::string cn_str(cn, static_cast<size_t>(cn_len));
- if (detail::match_hostname(cn_str, host_str)) { return true; }
- }
- }
- return false;
- }
- inline uint64_t hostname_mismatch_code() {
- return static_cast<uint64_t>(DOMAIN_NAME_MISMATCH);
- }
- inline long get_verify_result(const_session_t session) {
- if (!session) { return -1; }
- auto wsession =
- static_cast<impl::WolfSSLSession *>(const_cast<void *>(session));
- long result = wolfSSL_get_verify_result(wsession->ssl);
- return result;
- }
- inline std::string get_cert_subject_cn(cert_t cert) {
- if (!cert) return "";
- auto x509 = static_cast<WOLFSSL_X509 *>(cert);
- WOLFSSL_X509_NAME *subject = wolfSSL_X509_get_subject_name(x509);
- if (!subject) return "";
- char cn[256] = {};
- int cn_len = wolfSSL_X509_NAME_get_text_by_NID(subject, NID_commonName, cn,
- sizeof(cn));
- if (cn_len <= 0) return "";
- return std::string(cn, static_cast<size_t>(cn_len));
- }
- inline std::string get_cert_issuer_name(cert_t cert) {
- if (!cert) return "";
- auto x509 = static_cast<WOLFSSL_X509 *>(cert);
- WOLFSSL_X509_NAME *issuer = wolfSSL_X509_get_issuer_name(x509);
- if (!issuer) return "";
- char *name_str = wolfSSL_X509_NAME_oneline(issuer, nullptr, 0);
- if (!name_str) return "";
- std::string result(name_str);
- XFREE(name_str, nullptr, DYNAMIC_TYPE_OPENSSL);
- return result;
- }
- inline bool get_cert_sans(cert_t cert, std::vector<SanEntry> &sans) {
- sans.clear();
- if (!cert) return false;
- auto x509 = static_cast<WOLFSSL_X509 *>(cert);
- auto *san_names = static_cast<WOLF_STACK_OF(WOLFSSL_GENERAL_NAME) *>(
- wolfSSL_X509_get_ext_d2i(x509, NID_subject_alt_name, nullptr, nullptr));
- if (!san_names) return true; // No SANs is not an error
- int count = wolfSSL_sk_num(san_names);
- for (int i = 0; i < count; i++) {
- auto *name =
- static_cast<WOLFSSL_GENERAL_NAME *>(wolfSSL_sk_value(san_names, i));
- if (!name) continue;
- SanEntry entry;
- switch (name->type) {
- case WOLFSSL_GEN_DNS: {
- entry.type = SanType::DNS;
- unsigned char *dns_name = nullptr;
- int dns_len = wolfSSL_ASN1_STRING_to_UTF8(&dns_name, name->d.dNSName);
- if (dns_name && dns_len > 0) {
- entry.value = std::string(reinterpret_cast<char *>(dns_name),
- static_cast<size_t>(dns_len));
- XFREE(dns_name, nullptr, DYNAMIC_TYPE_OPENSSL);
- }
- break;
- }
- case WOLFSSL_GEN_IPADD: {
- entry.type = SanType::IP;
- unsigned char *ip_data = wolfSSL_ASN1_STRING_data(name->d.iPAddress);
- int ip_len = wolfSSL_ASN1_STRING_length(name->d.iPAddress);
- if (ip_data && ip_len == 4) {
- char buf[16];
- snprintf(buf, sizeof(buf), "%d.%d.%d.%d", ip_data[0], ip_data[1],
- ip_data[2], ip_data[3]);
- entry.value = buf;
- } else if (ip_data && ip_len == 16) {
- char buf[64];
- snprintf(buf, sizeof(buf),
- "%02x%02x:%02x%02x:%02x%02x:%02x%02x:"
- "%02x%02x:%02x%02x:%02x%02x:%02x%02x",
- ip_data[0], ip_data[1], ip_data[2], ip_data[3], ip_data[4],
- ip_data[5], ip_data[6], ip_data[7], ip_data[8], ip_data[9],
- ip_data[10], ip_data[11], ip_data[12], ip_data[13],
- ip_data[14], ip_data[15]);
- entry.value = buf;
- }
- break;
- }
- case WOLFSSL_GEN_EMAIL:
- entry.type = SanType::EMAIL;
- {
- unsigned char *email = nullptr;
- int email_len = wolfSSL_ASN1_STRING_to_UTF8(&email, name->d.rfc822Name);
- if (email && email_len > 0) {
- entry.value = std::string(reinterpret_cast<char *>(email),
- static_cast<size_t>(email_len));
- XFREE(email, nullptr, DYNAMIC_TYPE_OPENSSL);
- }
- }
- break;
- case WOLFSSL_GEN_URI:
- entry.type = SanType::URI;
- {
- unsigned char *uri = nullptr;
- int uri_len = wolfSSL_ASN1_STRING_to_UTF8(
- &uri, name->d.uniformResourceIdentifier);
- if (uri && uri_len > 0) {
- entry.value = std::string(reinterpret_cast<char *>(uri),
- static_cast<size_t>(uri_len));
- XFREE(uri, nullptr, DYNAMIC_TYPE_OPENSSL);
- }
- }
- break;
- default: entry.type = SanType::OTHER; break;
- }
- if (!entry.value.empty()) { sans.push_back(std::move(entry)); }
- }
- wolfSSL_sk_free(san_names);
- return true;
- }
- inline bool get_cert_validity(cert_t cert, time_t ¬_before,
- time_t ¬_after) {
- if (!cert) return false;
- auto x509 = static_cast<WOLFSSL_X509 *>(cert);
- const WOLFSSL_ASN1_TIME *nb = wolfSSL_X509_get_notBefore(x509);
- const WOLFSSL_ASN1_TIME *na = wolfSSL_X509_get_notAfter(x509);
- if (!nb || !na) return false;
- // wolfSSL_ASN1_TIME_to_tm is available
- struct tm tm_nb = {}, tm_na = {};
- if (wolfSSL_ASN1_TIME_to_tm(nb, &tm_nb) != WOLFSSL_SUCCESS) return false;
- if (wolfSSL_ASN1_TIME_to_tm(na, &tm_na) != WOLFSSL_SUCCESS) return false;
- #ifdef _WIN32
- not_before = _mkgmtime(&tm_nb);
- not_after = _mkgmtime(&tm_na);
- #else
- not_before = timegm(&tm_nb);
- not_after = timegm(&tm_na);
- #endif
- return true;
- }
- inline std::string get_cert_serial(cert_t cert) {
- if (!cert) return "";
- auto x509 = static_cast<WOLFSSL_X509 *>(cert);
- WOLFSSL_ASN1_INTEGER *serial_asn1 = wolfSSL_X509_get_serialNumber(x509);
- if (!serial_asn1) return "";
- // Get the serial number data
- int len = serial_asn1->length;
- unsigned char *data = serial_asn1->data;
- if (!data || len <= 0) return "";
- std::string result;
- result.reserve(static_cast<size_t>(len) * 2);
- for (int i = 0; i < len; i++) {
- char hex[3];
- snprintf(hex, sizeof(hex), "%02X", data[i]);
- result += hex;
- }
- return result;
- }
- inline bool get_cert_der(cert_t cert, std::vector<unsigned char> &der) {
- if (!cert) return false;
- auto x509 = static_cast<WOLFSSL_X509 *>(cert);
- int der_len = 0;
- const unsigned char *der_data = wolfSSL_X509_get_der(x509, &der_len);
- if (!der_data || der_len <= 0) return false;
- der.assign(der_data, der_data + der_len);
- return true;
- }
- inline const char *get_sni(const_session_t session) {
- if (!session) return nullptr;
- auto wsession = static_cast<const impl::WolfSSLSession *>(session);
- // For server: return SNI received from client during handshake
- if (!wsession->sni_hostname.empty()) {
- return wsession->sni_hostname.c_str();
- }
- // For client: return the hostname set via set_sni
- if (!wsession->hostname.empty()) { return wsession->hostname.c_str(); }
- return nullptr;
- }
- inline uint64_t peek_error() {
- return static_cast<uint64_t>(wolfSSL_ERR_peek_last_error());
- }
- inline uint64_t get_error() {
- uint64_t err = impl::wolfssl_last_error();
- impl::wolfssl_last_error() = 0;
- return err;
- }
- inline std::string error_string(uint64_t code) {
- char buf[256];
- wolfSSL_ERR_error_string(static_cast<unsigned long>(code), buf);
- return std::string(buf);
- }
- inline ca_store_t create_ca_store(const char *pem, size_t len) {
- if (!pem || len == 0) { return nullptr; }
- // Validate by attempting to load into a temporary ctx
- WOLFSSL_CTX *tmp_ctx = wolfSSL_CTX_new(wolfTLSv1_2_client_method());
- if (!tmp_ctx) { return nullptr; }
- int ret = wolfSSL_CTX_load_verify_buffer(
- tmp_ctx, reinterpret_cast<const unsigned char *>(pem),
- static_cast<long>(len), SSL_FILETYPE_PEM);
- wolfSSL_CTX_free(tmp_ctx);
- if (ret != SSL_SUCCESS) { return nullptr; }
- return static_cast<ca_store_t>(
- new impl::WolfSSLCAStore{std::string(pem, len)});
- }
- inline void free_ca_store(ca_store_t store) {
- delete static_cast<impl::WolfSSLCAStore *>(store);
- }
- inline bool set_ca_store(ctx_t ctx, ca_store_t store) {
- if (!ctx || !store) { return false; }
- auto *wctx = static_cast<impl::WolfSSLContext *>(ctx);
- auto *ca = static_cast<impl::WolfSSLCAStore *>(store);
- int ret = wolfSSL_CTX_load_verify_buffer(
- wctx->ctx, reinterpret_cast<const unsigned char *>(ca->pem_data.data()),
- static_cast<long>(ca->pem_data.size()), SSL_FILETYPE_PEM);
- if (ret == SSL_SUCCESS) { wctx->ca_pem_data_ += ca->pem_data; }
- // This function takes ownership of the store; the PEM data was copied into
- // the context, so release the source
- free_ca_store(store);
- return ret == SSL_SUCCESS;
- }
- inline size_t get_ca_certs(ctx_t ctx, std::vector<cert_t> &certs) {
- certs.clear();
- if (!ctx) { return 0; }
- auto *wctx = static_cast<impl::WolfSSLContext *>(ctx);
- if (wctx->ca_pem_data_.empty()) { return 0; }
- const std::string &pem = wctx->ca_pem_data_;
- const std::string begin_marker = "-----BEGIN CERTIFICATE-----";
- const std::string end_marker = "-----END CERTIFICATE-----";
- size_t pos = 0;
- while ((pos = pem.find(begin_marker, pos)) != std::string::npos) {
- size_t end_pos = pem.find(end_marker, pos);
- if (end_pos == std::string::npos) { break; }
- end_pos += end_marker.size();
- std::string cert_pem = pem.substr(pos, end_pos - pos);
- WOLFSSL_X509 *x509 = wolfSSL_X509_load_certificate_buffer(
- reinterpret_cast<const unsigned char *>(cert_pem.data()),
- static_cast<int>(cert_pem.size()), WOLFSSL_FILETYPE_PEM);
- if (x509) { certs.push_back(static_cast<cert_t>(x509)); }
- pos = end_pos;
- }
- return certs.size();
- }
- inline std::vector<std::string> get_ca_names(ctx_t ctx) {
- std::vector<std::string> names;
- if (!ctx) { return names; }
- auto *wctx = static_cast<impl::WolfSSLContext *>(ctx);
- if (wctx->ca_pem_data_.empty()) { return names; }
- const std::string &pem = wctx->ca_pem_data_;
- const std::string begin_marker = "-----BEGIN CERTIFICATE-----";
- const std::string end_marker = "-----END CERTIFICATE-----";
- size_t pos = 0;
- while ((pos = pem.find(begin_marker, pos)) != std::string::npos) {
- size_t end_pos = pem.find(end_marker, pos);
- if (end_pos == std::string::npos) { break; }
- end_pos += end_marker.size();
- std::string cert_pem = pem.substr(pos, end_pos - pos);
- WOLFSSL_X509 *x509 = wolfSSL_X509_load_certificate_buffer(
- reinterpret_cast<const unsigned char *>(cert_pem.data()),
- static_cast<int>(cert_pem.size()), WOLFSSL_FILETYPE_PEM);
- if (x509) {
- WOLFSSL_X509_NAME *subject = wolfSSL_X509_get_subject_name(x509);
- if (subject) {
- char *name_str = wolfSSL_X509_NAME_oneline(subject, nullptr, 0);
- if (name_str) {
- names.push_back(name_str);
- XFREE(name_str, nullptr, DYNAMIC_TYPE_OPENSSL);
- }
- }
- wolfSSL_X509_free(x509);
- }
- pos = end_pos;
- }
- return names;
- }
- inline bool update_server_cert(ctx_t ctx, const char *cert_pem,
- const char *key_pem, const char *password) {
- if (!ctx || !cert_pem || !key_pem) { return false; }
- auto *wctx = static_cast<impl::WolfSSLContext *>(ctx);
- // Load new certificate
- int ret = wolfSSL_CTX_use_certificate_buffer(
- wctx->ctx, reinterpret_cast<const unsigned char *>(cert_pem),
- static_cast<long>(strlen(cert_pem)), SSL_FILETYPE_PEM);
- if (ret != SSL_SUCCESS) {
- impl::wolfssl_last_error() =
- static_cast<uint64_t>(wolfSSL_ERR_peek_last_error());
- return false;
- }
- // Set password if provided
- if (password) { impl::set_wolfssl_password_cb(wctx->ctx, password); }
- // Load new private key
- ret = wolfSSL_CTX_use_PrivateKey_buffer(
- wctx->ctx, reinterpret_cast<const unsigned char *>(key_pem),
- static_cast<long>(strlen(key_pem)), SSL_FILETYPE_PEM);
- if (ret != SSL_SUCCESS) {
- impl::wolfssl_last_error() =
- static_cast<uint64_t>(wolfSSL_ERR_peek_last_error());
- return false;
- }
- return true;
- }
- inline bool update_server_client_ca(ctx_t ctx, const char *ca_pem) {
- if (!ctx || !ca_pem) { return false; }
- auto *wctx = static_cast<impl::WolfSSLContext *>(ctx);
- int ret = wolfSSL_CTX_load_verify_buffer(
- wctx->ctx, reinterpret_cast<const unsigned char *>(ca_pem),
- static_cast<long>(strlen(ca_pem)), SSL_FILETYPE_PEM);
- if (ret != SSL_SUCCESS) {
- impl::wolfssl_last_error() =
- static_cast<uint64_t>(wolfSSL_ERR_peek_last_error());
- return false;
- }
- return true;
- }
- inline bool set_verify_callback(ctx_t ctx, VerifyCallback callback) {
- if (!ctx) { return false; }
- auto *wctx = static_cast<impl::WolfSSLContext *>(ctx);
- impl::get_verify_callback() = std::move(callback);
- wctx->has_verify_callback = static_cast<bool>(impl::get_verify_callback());
- if (wctx->has_verify_callback) {
- wolfSSL_CTX_set_verify(wctx->ctx, SSL_VERIFY_PEER,
- impl::wolfssl_verify_callback);
- } else {
- wolfSSL_CTX_set_verify(
- wctx->ctx,
- wctx->verify_client
- ? (SSL_VERIFY_PEER | SSL_VERIFY_FAIL_IF_NO_PEER_CERT)
- : SSL_VERIFY_NONE,
- nullptr);
- }
- return true;
- }
- inline long get_verify_error(const_session_t session) {
- if (!session) { return -1; }
- auto *wsession =
- static_cast<impl::WolfSSLSession *>(const_cast<void *>(session));
- return wolfSSL_get_verify_result(wsession->ssl);
- }
- inline std::string verify_error_string(long error_code) {
- if (error_code == 0) { return ""; }
- const char *str =
- wolfSSL_X509_verify_cert_error_string(static_cast<int>(error_code));
- return str ? std::string(str) : std::string();
- }
- } // namespace tls
- #endif // CPPHTTPLIB_WOLFSSL_SUPPORT
- // WebSocket implementation
- namespace ws {
- inline bool WebSocket::send_frame(Opcode op, const char *data, size_t len,
- bool fin) {
- std::lock_guard<std::mutex> lock(write_mutex_);
- if (closed_) { return false; }
- return detail::write_websocket_frame(strm_, op, data, len, fin, !is_server_);
- }
- inline ReadResult WebSocket::read(std::string &msg) {
- while (!closed_) {
- Opcode opcode;
- std::string payload;
- bool fin;
- if (!impl::read_websocket_frame(strm_, opcode, payload, fin, is_server_,
- CPPHTTPLIB_WEBSOCKET_MAX_PAYLOAD_LENGTH)) {
- closed_ = true;
- return Fail;
- }
- switch (opcode) {
- case Opcode::Ping: {
- std::lock_guard<std::mutex> lock(write_mutex_);
- detail::write_websocket_frame(strm_, Opcode::Pong, payload.data(),
- payload.size(), true, !is_server_);
- continue;
- }
- case Opcode::Pong: {
- std::lock_guard<std::mutex> lock(ping_mutex_);
- unacked_pings_ = 0;
- continue;
- }
- case Opcode::Close: {
- if (!closed_.exchange(true)) {
- // Echo close frame back
- std::lock_guard<std::mutex> lock(write_mutex_);
- detail::write_websocket_frame(strm_, Opcode::Close, payload.data(),
- payload.size(), true, !is_server_);
- }
- return Fail;
- }
- case Opcode::Text:
- case Opcode::Binary: {
- auto result = opcode == Opcode::Text ? Text : Binary;
- msg = std::move(payload);
- // Handle fragmentation
- if (!fin) {
- while (true) {
- Opcode cont_opcode;
- std::string cont_payload;
- bool cont_fin;
- if (!impl::read_websocket_frame(
- strm_, cont_opcode, cont_payload, cont_fin, is_server_,
- CPPHTTPLIB_WEBSOCKET_MAX_PAYLOAD_LENGTH)) {
- closed_ = true;
- return Fail;
- }
- if (cont_opcode == Opcode::Ping) {
- std::lock_guard<std::mutex> lock(write_mutex_);
- detail::write_websocket_frame(
- strm_, Opcode::Pong, cont_payload.data(), cont_payload.size(),
- true, !is_server_);
- continue;
- }
- if (cont_opcode == Opcode::Pong) {
- std::lock_guard<std::mutex> lock(ping_mutex_);
- unacked_pings_ = 0;
- continue;
- }
- if (cont_opcode == Opcode::Close) {
- if (!closed_.exchange(true)) {
- std::lock_guard<std::mutex> lock(write_mutex_);
- detail::write_websocket_frame(
- strm_, Opcode::Close, cont_payload.data(),
- cont_payload.size(), true, !is_server_);
- }
- return Fail;
- }
- // RFC 6455: continuation frames must use opcode 0x0
- if (cont_opcode != Opcode::Continuation) {
- closed_ = true;
- return Fail;
- }
- msg += cont_payload;
- if (msg.size() > CPPHTTPLIB_WEBSOCKET_MAX_PAYLOAD_LENGTH) {
- closed_ = true;
- return Fail;
- }
- if (cont_fin) { break; }
- }
- }
- // RFC 6455 Section 5.6: text frames must contain valid UTF-8
- if (result == Text && !impl::is_valid_utf8(msg)) {
- close(CloseStatus::InvalidPayload, "invalid UTF-8");
- return Fail;
- }
- return result;
- }
- default: closed_ = true; return Fail;
- }
- }
- return Fail;
- }
- inline bool WebSocket::send(const std::string &data) {
- return send_frame(Opcode::Text, data.data(), data.size());
- }
- inline bool WebSocket::send(const char *data, size_t len) {
- return send_frame(Opcode::Binary, data, len);
- }
- inline void WebSocket::close(CloseStatus status, const std::string &reason) {
- if (closed_.exchange(true)) { return; }
- ping_cv_.notify_all();
- std::string payload;
- auto code = static_cast<uint16_t>(status);
- payload.push_back(static_cast<char>((code >> 8) & 0xFF));
- payload.push_back(static_cast<char>(code & 0xFF));
- // RFC 6455 Section 5.5: control frame payload must not exceed 125 bytes
- // Close frame has 2-byte status code, so reason is limited to 123 bytes
- payload += reason.substr(0, 123);
- {
- std::lock_guard<std::mutex> lock(write_mutex_);
- detail::write_websocket_frame(strm_, Opcode::Close, payload.data(),
- payload.size(), true, !is_server_);
- }
- // RFC 6455 Section 7.1.1: after sending a Close frame, wait for the peer's
- // Close response before closing the TCP connection. Use a short timeout to
- // avoid hanging if the peer doesn't respond.
- strm_.set_read_timeout(CPPHTTPLIB_WEBSOCKET_CLOSE_TIMEOUT_SECOND, 0);
- Opcode op;
- std::string resp;
- bool fin;
- while (impl::read_websocket_frame(strm_, op, resp, fin, is_server_, 125)) {
- if (op == Opcode::Close) { break; }
- }
- }
- inline WebSocket::~WebSocket() {
- {
- std::lock_guard<std::mutex> lock(ping_mutex_);
- closed_ = true;
- }
- ping_cv_.notify_all();
- if (ping_thread_.joinable()) { ping_thread_.join(); }
- }
- inline void WebSocket::start_heartbeat() {
- if (ping_interval_sec_ == 0) { return; }
- ping_thread_ = std::thread([this]() {
- std::unique_lock<std::mutex> lock(ping_mutex_);
- while (!closed_) {
- ping_cv_.wait_for(lock, std::chrono::seconds(ping_interval_sec_));
- if (closed_) { break; }
- // If the peer has failed to respond to the previous pings, give up.
- // RFC 6455 does not define a pong-timeout mechanism; this is an
- // opt-in liveness check controlled by max_missed_pongs_.
- if (max_missed_pongs_ > 0 && unacked_pings_ >= max_missed_pongs_) {
- lock.unlock();
- close(CloseStatus::GoingAway, "pong timeout");
- return;
- }
- lock.unlock();
- if (!send_frame(Opcode::Ping, nullptr, 0)) {
- lock.lock();
- closed_ = true;
- break;
- }
- lock.lock();
- unacked_pings_++;
- }
- });
- }
- inline const Request &WebSocket::request() const { return req_; }
- inline bool WebSocket::is_open() const { return !closed_; }
- // WebSocketClient implementation
- inline WebSocketClient::WebSocketClient(
- const std::string &scheme_host_port_path, const Headers &headers)
- : headers_(headers) {
- detail::UrlComponents uc;
- if (detail::parse_url(scheme_host_port_path, uc) && !uc.scheme.empty() &&
- !uc.host.empty() && !uc.path.empty()) {
- auto &scheme = uc.scheme;
- #ifdef CPPHTTPLIB_SSL_ENABLED
- if (scheme != "ws" && scheme != "wss") {
- #else
- if (scheme != "ws") {
- #endif
- #ifndef CPPHTTPLIB_NO_EXCEPTIONS
- std::string msg = "'" + scheme + "' scheme is not supported.";
- throw std::invalid_argument(msg);
- #endif
- return;
- }
- auto is_ssl = scheme == "wss";
- host_ = std::move(uc.host);
- port_ = is_ssl ? 443 : 80;
- if (!uc.port.empty() && !detail::parse_port(uc.port, port_)) { return; }
- path_ = std::move(uc.path);
- if (!uc.query.empty()) { path_ += uc.query; }
- #ifdef CPPHTTPLIB_SSL_ENABLED
- is_ssl_ = is_ssl;
- if (is_ssl_) {
- // The context lives as long as the client so that CA configuration
- // survives reconnects; sessions are created per connection.
- tls_ctx_ = tls::create_client_context();
- if (!tls_ctx_) { return; }
- }
- #else
- if (is_ssl) { return; }
- #endif
- is_valid_ = true;
- }
- }
- #ifdef CPPHTTPLIB_SSL_ENABLED
- inline WebSocketClient::WebSocketClient(
- const std::string &scheme_host_port_path, const PemMemory &pem,
- const Headers &headers)
- : WebSocketClient(scheme_host_port_path, headers) {
- // For ws:// URLs the client certificate is silently ignored, consistent
- // with the TLS-only setters such as set_ca_cert_path().
- if (is_valid_ && is_ssl_ && pem.cert_pem && pem.key_pem) {
- if (!tls::set_client_cert_pem(tls_ctx_, pem.cert_pem, pem.key_pem,
- pem.private_key_password)) {
- tls::free_context(tls_ctx_);
- tls_ctx_ = nullptr;
- is_valid_ = false;
- }
- }
- }
- #endif
- inline WebSocketClient::~WebSocketClient() {
- shutdown_and_close();
- #ifdef CPPHTTPLIB_SSL_ENABLED
- if (tls_ctx_) {
- tls::free_context(tls_ctx_);
- tls_ctx_ = nullptr;
- }
- #endif
- }
- inline bool WebSocketClient::is_valid() const { return is_valid_; }
- inline void WebSocketClient::shutdown_and_close() {
- // Send the close frame while the TLS session is still alive: ws_ holds an
- // SSLSocketStream that keeps a raw pointer to tls_session_, so the session
- // must outlive ws_->close() and ws_.reset() to avoid a use-after-free.
- if (ws_ && ws_->is_open()) { ws_->close(); }
- ws_.reset();
- #ifdef CPPHTTPLIB_SSL_ENABLED
- if (is_ssl_) {
- if (tls_session_) {
- tls::shutdown(tls_session_, true);
- tls::free_session(tls_session_);
- tls_session_ = nullptr;
- }
- }
- #endif
- if (sock_ != INVALID_SOCKET) {
- detail::shutdown_socket(sock_);
- detail::close_socket(sock_);
- sock_ = INVALID_SOCKET;
- }
- }
- inline bool WebSocketClient::create_stream(std::unique_ptr<Stream> &strm,
- Error &error, int &ssl_error,
- uint64_t &ssl_backend_error) {
- #ifdef CPPHTTPLIB_SSL_ENABLED
- if (is_ssl_) {
- // A plain flag rather than SSLClient::load_certs()'s call_once: connect()
- // is not safe to call concurrently on one client to begin with, since
- // nothing else here is guarded either.
- if (server_certificate_verification_ && !certs_loaded_) {
- uint64_t backend_error = 0;
- detail::load_client_ca_config(tls_ctx_, ca_cert_file_path_,
- ca_cert_dir_path_, custom_ca_loaded_,
- system_ca_mode_, backend_error);
- certs_loaded_ = true;
- }
- detail::ClientTlsSessionOptions options;
- options.server_hostname_verification = server_hostname_verification_;
- detail::ClientTlsSessionError tls_error;
- if (!detail::setup_client_tls_session(host_, tls_ctx_, tls_session_, sock_,
- server_certificate_verification_,
- read_timeout_sec_, read_timeout_usec_,
- &tls_error, options)) {
- error = tls_error.error;
- ssl_error = tls_error.ssl_error;
- ssl_backend_error = tls_error.backend_error;
- return false;
- }
- strm = std::unique_ptr<Stream>(new detail::SSLSocketStream(
- sock_, tls_session_, read_timeout_sec_, read_timeout_usec_,
- write_timeout_sec_, write_timeout_usec_));
- return true;
- }
- #else
- (void)error;
- (void)ssl_error;
- (void)ssl_backend_error;
- #endif
- strm = std::unique_ptr<Stream>(
- new detail::SocketStream(sock_, read_timeout_sec_, read_timeout_usec_,
- write_timeout_sec_, write_timeout_usec_));
- return true;
- }
- inline void WebSocketClient::prepare_default_headers(Request &req) {
- #ifdef CPPHTTPLIB_SSL_ENABLED
- auto is_ssl = is_ssl_;
- #else
- auto is_ssl = false;
- #endif
- if (!req.has_header("Host")) {
- req.headers.emplace("Host", detail::make_default_host_header_value(
- host_, port_, is_ssl, address_family_));
- }
- detail::add_default_user_agent_header(req);
- }
- inline Result WebSocketClient::connect() {
- if (!is_valid_) { return Result{Error::Connection, -1, Headers{}}; }
- shutdown_and_close();
- // Check is custom IP or hostname specified for host_
- std::string connect_host;
- std::string ip;
- detail::apply_addr_map(addr_map_, host_, connect_host, ip);
- auto error = Error::Success;
- sock_ = detail::create_client_socket(
- connect_host, ip, port_, address_family_, tcp_nodelay_, ipv6_v6only_,
- socket_options_, connection_timeout_sec_, connection_timeout_usec_,
- read_timeout_sec_, read_timeout_usec_, write_timeout_sec_,
- write_timeout_usec_, interface_, error);
- if (sock_ == INVALID_SOCKET) {
- if (error == Error::Success) { error = Error::Connection; }
- return Result{error, -1, Headers{}};
- }
- std::unique_ptr<Stream> strm;
- auto stream_error = Error::SSLConnection;
- int ssl_error = 0;
- uint64_t ssl_backend_error = 0;
- if (!create_stream(strm, stream_error, ssl_error, ssl_backend_error)) {
- shutdown_and_close();
- #ifdef CPPHTTPLIB_SSL_ENABLED
- return Result{stream_error, -1, Headers{}, ssl_error, ssl_backend_error};
- #else
- return Result{stream_error, -1, Headers{}};
- #endif
- }
- Request req;
- req.method = "GET";
- req.path = path_;
- req.headers = headers_;
- prepare_default_headers(req);
- detail::WebSocketUpgradeResponse upgrade;
- if (!detail::perform_websocket_handshake(*strm, req, upgrade)) {
- shutdown_and_close();
- return Result{upgrade.error, upgrade.status, std::move(upgrade.headers)};
- }
- subprotocol_ = std::move(upgrade.selected_subprotocol);
- ws_ = std::unique_ptr<WebSocket>(new WebSocket(std::move(strm), req, false,
- websocket_ping_interval_sec_,
- websocket_max_missed_pongs_));
- return Result{Error::Success, upgrade.status, std::move(upgrade.headers)};
- }
- inline ReadResult WebSocketClient::read(std::string &msg) {
- if (!ws_) { return Fail; }
- return ws_->read(msg);
- }
- inline bool WebSocketClient::send(const std::string &data) {
- if (!ws_) { return false; }
- return ws_->send(data);
- }
- inline bool WebSocketClient::send(const char *data, size_t len) {
- if (!ws_) { return false; }
- return ws_->send(data, len);
- }
- inline void WebSocketClient::close(CloseStatus status,
- const std::string &reason) {
- if (ws_) { ws_->close(status, reason); }
- }
- inline bool WebSocketClient::is_open() const { return ws_ && ws_->is_open(); }
- inline const std::string &WebSocketClient::subprotocol() const {
- return subprotocol_;
- }
- inline void WebSocketClient::set_read_timeout(time_t sec, time_t usec) {
- read_timeout_sec_ = sec;
- read_timeout_usec_ = usec;
- }
- inline void WebSocketClient::set_write_timeout(time_t sec, time_t usec) {
- write_timeout_sec_ = sec;
- write_timeout_usec_ = usec;
- }
- inline void WebSocketClient::set_websocket_ping_interval(time_t sec) {
- websocket_ping_interval_sec_ = sec;
- }
- inline void WebSocketClient::set_websocket_max_missed_pongs(int count) {
- websocket_max_missed_pongs_ = count;
- }
- inline void WebSocketClient::set_tcp_nodelay(bool on) { tcp_nodelay_ = on; }
- inline void WebSocketClient::set_address_family(int family) {
- address_family_ = family;
- }
- inline void WebSocketClient::set_ipv6_v6only(bool on) { ipv6_v6only_ = on; }
- inline void WebSocketClient::set_socket_options(SocketOptions socket_options) {
- socket_options_ = std::move(socket_options);
- }
- inline void WebSocketClient::set_connection_timeout(time_t sec, time_t usec) {
- connection_timeout_sec_ = sec;
- connection_timeout_usec_ = usec;
- }
- inline void WebSocketClient::set_interface(const std::string &intf) {
- interface_ = intf;
- }
- inline void WebSocketClient::set_hostname_addr_map(
- std::map<std::string, std::string> addr_map) {
- addr_map_ = std::move(addr_map);
- }
- #ifdef CPPHTTPLIB_SSL_ENABLED
- inline void
- WebSocketClient::set_ca_cert_path(const std::string &ca_cert_file_path,
- const std::string &ca_cert_dir_path) {
- ca_cert_file_path_ = ca_cert_file_path;
- ca_cert_dir_path_ = ca_cert_dir_path;
- }
- inline void WebSocketClient::set_ca_cert_store(tls::ca_store_t store) {
- if (store && tls_ctx_) {
- // set_ca_store takes ownership of store
- tls::set_ca_store(tls_ctx_, store);
- custom_ca_loaded_ = true;
- } else if (store) {
- tls::free_ca_store(store);
- }
- }
- inline void WebSocketClient::load_ca_cert_store(const char *ca_cert,
- std::size_t size) {
- if (tls_ctx_ && ca_cert && size > 0) {
- tls::load_ca_pem(tls_ctx_, ca_cert, size);
- custom_ca_loaded_ = true;
- }
- }
- inline void
- WebSocketClient::enable_server_certificate_verification(bool enabled) {
- server_certificate_verification_ = enabled;
- }
- inline void WebSocketClient::enable_server_hostname_verification(bool enabled) {
- server_hostname_verification_ = enabled;
- }
- inline void WebSocketClient::enable_system_ca(bool enabled) {
- system_ca_mode_ = enabled ? SystemCAMode::Enabled : SystemCAMode::Disabled;
- }
- #endif // CPPHTTPLIB_SSL_ENABLED
- } // namespace ws
- // ----------------------------------------------------------------------------
- } // namespace httplib
- #endif // CPPHTTPLIB_HTTPLIB_H
|