test.cc 889 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283284285286287288289290291292293294295296297298299300301302303304305306307308309310311312313314315316317318319320321322323324325326327328329330331332333334335336337338339340341342343344345346347348349350351352353354355356357358359360361362363364365366367368369370371372373374375376377378379380381382383384385386387388389390391392393394395396397398399400401402403404405406407408409410411412413414415416417418419420421422423424425426427428429430431432433434435436437438439440441442443444445446447448449450451452453454455456457458459460461462463464465466467468469470471472473474475476477478479480481482483484485486487488489490491492493494495496497498499500501502503504505506507508509510511512513514515516517518519520521522523524525526527528529530531532533534535536537538539540541542543544545546547548549550551552553554555556557558559560561562563564565566567568569570571572573574575576577578579580581582583584585586587588589590591592593594595596597598599600601602603604605606607608609610611612613614615616617618619620621622623624625626627628629630631632633634635636637638639640641642643644645646647648649650651652653654655656657658659660661662663664665666667668669670671672673674675676677678679680681682683684685686687688689690691692693694695696697698699700701702703704705706707708709710711712713714715716717718719720721722723724725726727728729730731732733734735736737738739740741742743744745746747748749750751752753754755756757758759760761762763764765766767768769770771772773774775776777778779780781782783784785786787788789790791792793794795796797798799800801802803804805806807808809810811812813814815816817818819820821822823824825826827828829830831832833834835836837838839840841842843844845846847848849850851852853854855856857858859860861862863864865866867868869870871872873874875876877878879880881882883884885886887888889890891892893894895896897898899900901902903904905906907908909910911912913914915916917918919920921922923924925926927928929930931932933934935936937938939940941942943944945946947948949950951952953954955956957958959960961962963964965966967968969970971972973974975976977978979980981982983984985986987988989990991992993994995996997998999100010011002100310041005100610071008100910101011101210131014101510161017101810191020102110221023102410251026102710281029103010311032103310341035103610371038103910401041104210431044104510461047104810491050105110521053105410551056105710581059106010611062106310641065106610671068106910701071107210731074107510761077107810791080108110821083108410851086108710881089109010911092109310941095109610971098109911001101110211031104110511061107110811091110111111121113111411151116111711181119112011211122112311241125112611271128112911301131113211331134113511361137113811391140114111421143114411451146114711481149115011511152115311541155115611571158115911601161116211631164116511661167116811691170117111721173117411751176117711781179118011811182118311841185118611871188118911901191119211931194119511961197119811991200120112021203120412051206120712081209121012111212121312141215121612171218121912201221122212231224122512261227122812291230123112321233123412351236123712381239124012411242124312441245124612471248124912501251125212531254125512561257125812591260126112621263126412651266126712681269127012711272127312741275127612771278127912801281128212831284128512861287128812891290129112921293129412951296129712981299130013011302130313041305130613071308130913101311131213131314131513161317131813191320132113221323132413251326132713281329133013311332133313341335133613371338133913401341134213431344134513461347134813491350135113521353135413551356135713581359136013611362136313641365136613671368136913701371137213731374137513761377137813791380138113821383138413851386138713881389139013911392139313941395139613971398139914001401140214031404140514061407140814091410141114121413141414151416141714181419142014211422142314241425142614271428142914301431143214331434143514361437143814391440144114421443144414451446144714481449145014511452145314541455145614571458145914601461146214631464146514661467146814691470147114721473147414751476147714781479148014811482148314841485148614871488148914901491149214931494149514961497149814991500150115021503150415051506150715081509151015111512151315141515151615171518151915201521152215231524152515261527152815291530153115321533153415351536153715381539154015411542154315441545154615471548154915501551155215531554155515561557155815591560156115621563156415651566156715681569157015711572157315741575157615771578157915801581158215831584158515861587158815891590159115921593159415951596159715981599160016011602160316041605160616071608160916101611161216131614161516161617161816191620162116221623162416251626162716281629163016311632163316341635163616371638163916401641164216431644164516461647164816491650165116521653165416551656165716581659166016611662166316641665166616671668166916701671167216731674167516761677167816791680168116821683168416851686168716881689169016911692169316941695169616971698169917001701170217031704170517061707170817091710171117121713171417151716171717181719172017211722172317241725172617271728172917301731173217331734173517361737173817391740174117421743174417451746174717481749175017511752175317541755175617571758175917601761176217631764176517661767176817691770177117721773177417751776177717781779178017811782178317841785178617871788178917901791179217931794179517961797179817991800180118021803180418051806180718081809181018111812181318141815181618171818181918201821182218231824182518261827182818291830183118321833183418351836183718381839184018411842184318441845184618471848184918501851185218531854185518561857185818591860186118621863186418651866186718681869187018711872187318741875187618771878187918801881188218831884188518861887188818891890189118921893189418951896189718981899190019011902190319041905190619071908190919101911191219131914191519161917191819191920192119221923192419251926192719281929193019311932193319341935193619371938193919401941194219431944194519461947194819491950195119521953195419551956195719581959196019611962196319641965196619671968196919701971197219731974197519761977197819791980198119821983198419851986198719881989199019911992199319941995199619971998199920002001200220032004200520062007200820092010201120122013201420152016201720182019202020212022202320242025202620272028202920302031203220332034203520362037203820392040204120422043204420452046204720482049205020512052205320542055205620572058205920602061206220632064206520662067206820692070207120722073207420752076207720782079208020812082208320842085208620872088208920902091209220932094209520962097209820992100210121022103210421052106210721082109211021112112211321142115211621172118211921202121212221232124212521262127212821292130213121322133213421352136213721382139214021412142214321442145214621472148214921502151215221532154215521562157215821592160216121622163216421652166216721682169217021712172217321742175217621772178217921802181218221832184218521862187218821892190219121922193219421952196219721982199220022012202220322042205220622072208220922102211221222132214221522162217221822192220222122222223222422252226222722282229223022312232223322342235223622372238223922402241224222432244224522462247224822492250225122522253225422552256225722582259226022612262226322642265226622672268226922702271227222732274227522762277227822792280228122822283228422852286228722882289229022912292229322942295229622972298229923002301230223032304230523062307230823092310231123122313231423152316231723182319232023212322232323242325232623272328232923302331233223332334233523362337233823392340234123422343234423452346234723482349235023512352235323542355235623572358235923602361236223632364236523662367236823692370237123722373237423752376237723782379238023812382238323842385238623872388238923902391239223932394239523962397239823992400240124022403240424052406240724082409241024112412241324142415241624172418241924202421242224232424242524262427242824292430243124322433243424352436243724382439244024412442244324442445244624472448244924502451245224532454245524562457245824592460246124622463246424652466246724682469247024712472247324742475247624772478247924802481248224832484248524862487248824892490249124922493249424952496249724982499250025012502250325042505250625072508250925102511251225132514251525162517251825192520252125222523252425252526252725282529253025312532253325342535253625372538253925402541254225432544254525462547254825492550255125522553255425552556255725582559256025612562256325642565256625672568256925702571257225732574257525762577257825792580258125822583258425852586258725882589259025912592259325942595259625972598259926002601260226032604260526062607260826092610261126122613261426152616261726182619262026212622262326242625262626272628262926302631263226332634263526362637263826392640264126422643264426452646264726482649265026512652265326542655265626572658265926602661266226632664266526662667266826692670267126722673267426752676267726782679268026812682268326842685268626872688268926902691269226932694269526962697269826992700270127022703270427052706270727082709271027112712271327142715271627172718271927202721272227232724272527262727272827292730273127322733273427352736273727382739274027412742274327442745274627472748274927502751275227532754275527562757275827592760276127622763276427652766276727682769277027712772277327742775277627772778277927802781278227832784278527862787278827892790279127922793279427952796279727982799280028012802280328042805280628072808280928102811281228132814281528162817281828192820282128222823282428252826282728282829283028312832283328342835283628372838283928402841284228432844284528462847284828492850285128522853285428552856285728582859286028612862286328642865286628672868286928702871287228732874287528762877287828792880288128822883288428852886288728882889289028912892289328942895289628972898289929002901290229032904290529062907290829092910291129122913291429152916291729182919292029212922292329242925292629272928292929302931293229332934293529362937293829392940294129422943294429452946294729482949295029512952295329542955295629572958295929602961296229632964296529662967296829692970297129722973297429752976297729782979298029812982298329842985298629872988298929902991299229932994299529962997299829993000300130023003300430053006300730083009301030113012301330143015301630173018301930203021302230233024302530263027302830293030303130323033303430353036303730383039304030413042304330443045304630473048304930503051305230533054305530563057305830593060306130623063306430653066306730683069307030713072307330743075307630773078307930803081308230833084308530863087308830893090309130923093309430953096309730983099310031013102310331043105310631073108310931103111311231133114311531163117311831193120312131223123312431253126312731283129313031313132313331343135313631373138313931403141314231433144314531463147314831493150315131523153315431553156315731583159316031613162316331643165316631673168316931703171317231733174317531763177317831793180318131823183318431853186318731883189319031913192319331943195319631973198319932003201320232033204320532063207320832093210321132123213321432153216321732183219322032213222322332243225322632273228322932303231323232333234323532363237323832393240324132423243324432453246324732483249325032513252325332543255325632573258325932603261326232633264326532663267326832693270327132723273327432753276327732783279328032813282328332843285328632873288328932903291329232933294329532963297329832993300330133023303330433053306330733083309331033113312331333143315331633173318331933203321332233233324332533263327332833293330333133323333333433353336333733383339334033413342334333443345334633473348334933503351335233533354335533563357335833593360336133623363336433653366336733683369337033713372337333743375337633773378337933803381338233833384338533863387338833893390339133923393339433953396339733983399340034013402340334043405340634073408340934103411341234133414341534163417341834193420342134223423342434253426342734283429343034313432343334343435343634373438343934403441344234433444344534463447344834493450345134523453345434553456345734583459346034613462346334643465346634673468346934703471347234733474347534763477347834793480348134823483348434853486348734883489349034913492349334943495349634973498349935003501350235033504350535063507350835093510351135123513351435153516351735183519352035213522352335243525352635273528352935303531353235333534353535363537353835393540354135423543354435453546354735483549355035513552355335543555355635573558355935603561356235633564356535663567356835693570357135723573357435753576357735783579358035813582358335843585358635873588358935903591359235933594359535963597359835993600360136023603360436053606360736083609361036113612361336143615361636173618361936203621362236233624362536263627362836293630363136323633363436353636363736383639364036413642364336443645364636473648364936503651365236533654365536563657365836593660366136623663366436653666366736683669367036713672367336743675367636773678367936803681368236833684368536863687368836893690369136923693369436953696369736983699370037013702370337043705370637073708370937103711371237133714371537163717371837193720372137223723372437253726372737283729373037313732373337343735373637373738373937403741374237433744374537463747374837493750375137523753375437553756375737583759376037613762376337643765376637673768376937703771377237733774377537763777377837793780378137823783378437853786378737883789379037913792379337943795379637973798379938003801380238033804380538063807380838093810381138123813381438153816381738183819382038213822382338243825382638273828382938303831383238333834383538363837383838393840384138423843384438453846384738483849385038513852385338543855385638573858385938603861386238633864386538663867386838693870387138723873387438753876387738783879388038813882388338843885388638873888388938903891389238933894389538963897389838993900390139023903390439053906390739083909391039113912391339143915391639173918391939203921392239233924392539263927392839293930393139323933393439353936393739383939394039413942394339443945394639473948394939503951395239533954395539563957395839593960396139623963396439653966396739683969397039713972397339743975397639773978397939803981398239833984398539863987398839893990399139923993399439953996399739983999400040014002400340044005400640074008400940104011401240134014401540164017401840194020402140224023402440254026402740284029403040314032403340344035403640374038403940404041404240434044404540464047404840494050405140524053405440554056405740584059406040614062406340644065406640674068406940704071407240734074407540764077407840794080408140824083408440854086408740884089409040914092409340944095409640974098409941004101410241034104410541064107410841094110411141124113411441154116411741184119412041214122412341244125412641274128412941304131413241334134413541364137413841394140414141424143414441454146414741484149415041514152415341544155415641574158415941604161416241634164416541664167416841694170417141724173417441754176417741784179418041814182418341844185418641874188418941904191419241934194419541964197419841994200420142024203420442054206420742084209421042114212421342144215421642174218421942204221422242234224422542264227422842294230423142324233423442354236423742384239424042414242424342444245424642474248424942504251425242534254425542564257425842594260426142624263426442654266426742684269427042714272427342744275427642774278427942804281428242834284428542864287428842894290429142924293429442954296429742984299430043014302430343044305430643074308430943104311431243134314431543164317431843194320432143224323432443254326432743284329433043314332433343344335433643374338433943404341434243434344434543464347434843494350435143524353435443554356435743584359436043614362436343644365436643674368436943704371437243734374437543764377437843794380438143824383438443854386438743884389439043914392439343944395439643974398439944004401440244034404440544064407440844094410441144124413441444154416441744184419442044214422442344244425442644274428442944304431443244334434443544364437443844394440444144424443444444454446444744484449445044514452445344544455445644574458445944604461446244634464446544664467446844694470447144724473447444754476447744784479448044814482448344844485448644874488448944904491449244934494449544964497449844994500450145024503450445054506450745084509451045114512451345144515451645174518451945204521452245234524452545264527452845294530453145324533453445354536453745384539454045414542454345444545454645474548454945504551455245534554455545564557455845594560456145624563456445654566456745684569457045714572457345744575457645774578457945804581458245834584458545864587458845894590459145924593459445954596459745984599460046014602460346044605460646074608460946104611461246134614461546164617461846194620462146224623462446254626462746284629463046314632463346344635463646374638463946404641464246434644464546464647464846494650465146524653465446554656465746584659466046614662466346644665466646674668466946704671467246734674467546764677467846794680468146824683468446854686468746884689469046914692469346944695469646974698469947004701470247034704470547064707470847094710471147124713471447154716471747184719472047214722472347244725472647274728472947304731473247334734473547364737473847394740474147424743474447454746474747484749475047514752475347544755475647574758475947604761476247634764476547664767476847694770477147724773477447754776477747784779478047814782478347844785478647874788478947904791479247934794479547964797479847994800480148024803480448054806480748084809481048114812481348144815481648174818481948204821482248234824482548264827482848294830483148324833483448354836483748384839484048414842484348444845484648474848484948504851485248534854485548564857485848594860486148624863486448654866486748684869487048714872487348744875487648774878487948804881488248834884488548864887488848894890489148924893489448954896489748984899490049014902490349044905490649074908490949104911491249134914491549164917491849194920492149224923492449254926492749284929493049314932493349344935493649374938493949404941494249434944494549464947494849494950495149524953495449554956495749584959496049614962496349644965496649674968496949704971497249734974497549764977497849794980498149824983498449854986498749884989499049914992499349944995499649974998499950005001500250035004500550065007500850095010501150125013501450155016501750185019502050215022502350245025502650275028502950305031503250335034503550365037503850395040504150425043504450455046504750485049505050515052505350545055505650575058505950605061506250635064506550665067506850695070507150725073507450755076507750785079508050815082508350845085508650875088508950905091509250935094509550965097509850995100510151025103510451055106510751085109511051115112511351145115511651175118511951205121512251235124512551265127512851295130513151325133513451355136513751385139514051415142514351445145514651475148514951505151515251535154515551565157515851595160516151625163516451655166516751685169517051715172517351745175517651775178517951805181518251835184518551865187518851895190519151925193519451955196519751985199520052015202520352045205520652075208520952105211521252135214521552165217521852195220522152225223522452255226522752285229523052315232523352345235523652375238523952405241524252435244524552465247524852495250525152525253525452555256525752585259526052615262526352645265526652675268526952705271527252735274527552765277527852795280528152825283528452855286528752885289529052915292529352945295529652975298529953005301530253035304530553065307530853095310531153125313531453155316531753185319532053215322532353245325532653275328532953305331533253335334533553365337533853395340534153425343534453455346534753485349535053515352535353545355535653575358535953605361536253635364536553665367536853695370537153725373537453755376537753785379538053815382538353845385538653875388538953905391539253935394539553965397539853995400540154025403540454055406540754085409541054115412541354145415541654175418541954205421542254235424542554265427542854295430543154325433543454355436543754385439544054415442544354445445544654475448544954505451545254535454545554565457545854595460546154625463546454655466546754685469547054715472547354745475547654775478547954805481548254835484548554865487548854895490549154925493549454955496549754985499550055015502550355045505550655075508550955105511551255135514551555165517551855195520552155225523552455255526552755285529553055315532553355345535553655375538553955405541554255435544554555465547554855495550555155525553555455555556555755585559556055615562556355645565556655675568556955705571557255735574557555765577557855795580558155825583558455855586558755885589559055915592559355945595559655975598559956005601560256035604560556065607560856095610561156125613561456155616561756185619562056215622562356245625562656275628562956305631563256335634563556365637563856395640564156425643564456455646564756485649565056515652565356545655565656575658565956605661566256635664566556665667566856695670567156725673567456755676567756785679568056815682568356845685568656875688568956905691569256935694569556965697569856995700570157025703570457055706570757085709571057115712571357145715571657175718571957205721572257235724572557265727572857295730573157325733573457355736573757385739574057415742574357445745574657475748574957505751575257535754575557565757575857595760576157625763576457655766576757685769577057715772577357745775577657775778577957805781578257835784578557865787578857895790579157925793579457955796579757985799580058015802580358045805580658075808580958105811581258135814581558165817581858195820582158225823582458255826582758285829583058315832583358345835583658375838583958405841584258435844584558465847584858495850585158525853585458555856585758585859586058615862586358645865586658675868586958705871587258735874587558765877587858795880588158825883588458855886588758885889589058915892589358945895589658975898589959005901590259035904590559065907590859095910591159125913591459155916591759185919592059215922592359245925592659275928592959305931593259335934593559365937593859395940594159425943594459455946594759485949595059515952595359545955595659575958595959605961596259635964596559665967596859695970597159725973597459755976597759785979598059815982598359845985598659875988598959905991599259935994599559965997599859996000600160026003600460056006600760086009601060116012601360146015601660176018601960206021602260236024602560266027602860296030603160326033603460356036603760386039604060416042604360446045604660476048604960506051605260536054605560566057605860596060606160626063606460656066606760686069607060716072607360746075607660776078607960806081608260836084608560866087608860896090609160926093609460956096609760986099610061016102610361046105610661076108610961106111611261136114611561166117611861196120612161226123612461256126612761286129613061316132613361346135613661376138613961406141614261436144614561466147614861496150615161526153615461556156615761586159616061616162616361646165616661676168616961706171617261736174617561766177617861796180618161826183618461856186618761886189619061916192619361946195619661976198619962006201620262036204620562066207620862096210621162126213621462156216621762186219622062216222622362246225622662276228622962306231623262336234623562366237623862396240624162426243624462456246624762486249625062516252625362546255625662576258625962606261626262636264626562666267626862696270627162726273627462756276627762786279628062816282628362846285628662876288628962906291629262936294629562966297629862996300630163026303630463056306630763086309631063116312631363146315631663176318631963206321632263236324632563266327632863296330633163326333633463356336633763386339634063416342634363446345634663476348634963506351635263536354635563566357635863596360636163626363636463656366636763686369637063716372637363746375637663776378637963806381638263836384638563866387638863896390639163926393639463956396639763986399640064016402640364046405640664076408640964106411641264136414641564166417641864196420642164226423642464256426642764286429643064316432643364346435643664376438643964406441644264436444644564466447644864496450645164526453645464556456645764586459646064616462646364646465646664676468646964706471647264736474647564766477647864796480648164826483648464856486648764886489649064916492649364946495649664976498649965006501650265036504650565066507650865096510651165126513651465156516651765186519652065216522652365246525652665276528652965306531653265336534653565366537653865396540654165426543654465456546654765486549655065516552655365546555655665576558655965606561656265636564656565666567656865696570657165726573657465756576657765786579658065816582658365846585658665876588658965906591659265936594659565966597659865996600660166026603660466056606660766086609661066116612661366146615661666176618661966206621662266236624662566266627662866296630663166326633663466356636663766386639664066416642664366446645664666476648664966506651665266536654665566566657665866596660666166626663666466656666666766686669667066716672667366746675667666776678667966806681668266836684668566866687668866896690669166926693669466956696669766986699670067016702670367046705670667076708670967106711671267136714671567166717671867196720672167226723672467256726672767286729673067316732673367346735673667376738673967406741674267436744674567466747674867496750675167526753675467556756675767586759676067616762676367646765676667676768676967706771677267736774677567766777677867796780678167826783678467856786678767886789679067916792679367946795679667976798679968006801680268036804680568066807680868096810681168126813681468156816681768186819682068216822682368246825682668276828682968306831683268336834683568366837683868396840684168426843684468456846684768486849685068516852685368546855685668576858685968606861686268636864686568666867686868696870687168726873687468756876687768786879688068816882688368846885688668876888688968906891689268936894689568966897689868996900690169026903690469056906690769086909691069116912691369146915691669176918691969206921692269236924692569266927692869296930693169326933693469356936693769386939694069416942694369446945694669476948694969506951695269536954695569566957695869596960696169626963696469656966696769686969697069716972697369746975697669776978697969806981698269836984698569866987698869896990699169926993699469956996699769986999700070017002700370047005700670077008700970107011701270137014701570167017701870197020702170227023702470257026702770287029703070317032703370347035703670377038703970407041704270437044704570467047704870497050705170527053705470557056705770587059706070617062706370647065706670677068706970707071707270737074707570767077707870797080708170827083708470857086708770887089709070917092709370947095709670977098709971007101710271037104710571067107710871097110711171127113711471157116711771187119712071217122712371247125712671277128712971307131713271337134713571367137713871397140714171427143714471457146714771487149715071517152715371547155715671577158715971607161716271637164716571667167716871697170717171727173717471757176717771787179718071817182718371847185718671877188718971907191719271937194719571967197719871997200720172027203720472057206720772087209721072117212721372147215721672177218721972207221722272237224722572267227722872297230723172327233723472357236723772387239724072417242724372447245724672477248724972507251725272537254725572567257725872597260726172627263726472657266726772687269727072717272727372747275727672777278727972807281728272837284728572867287728872897290729172927293729472957296729772987299730073017302730373047305730673077308730973107311731273137314731573167317731873197320732173227323732473257326732773287329733073317332733373347335733673377338733973407341734273437344734573467347734873497350735173527353735473557356735773587359736073617362736373647365736673677368736973707371737273737374737573767377737873797380738173827383738473857386738773887389739073917392739373947395739673977398739974007401740274037404740574067407740874097410741174127413741474157416741774187419742074217422742374247425742674277428742974307431743274337434743574367437743874397440744174427443744474457446744774487449745074517452745374547455745674577458745974607461746274637464746574667467746874697470747174727473747474757476747774787479748074817482748374847485748674877488748974907491749274937494749574967497749874997500750175027503750475057506750775087509751075117512751375147515751675177518751975207521752275237524752575267527752875297530753175327533753475357536753775387539754075417542754375447545754675477548754975507551755275537554755575567557755875597560756175627563756475657566756775687569757075717572757375747575757675777578757975807581758275837584758575867587758875897590759175927593759475957596759775987599760076017602760376047605760676077608760976107611761276137614761576167617761876197620762176227623762476257626762776287629763076317632763376347635763676377638763976407641764276437644764576467647764876497650765176527653765476557656765776587659766076617662766376647665766676677668766976707671767276737674767576767677767876797680768176827683768476857686768776887689769076917692769376947695769676977698769977007701770277037704770577067707770877097710771177127713771477157716771777187719772077217722772377247725772677277728772977307731773277337734773577367737773877397740774177427743774477457746774777487749775077517752775377547755775677577758775977607761776277637764776577667767776877697770777177727773777477757776777777787779778077817782778377847785778677877788778977907791779277937794779577967797779877997800780178027803780478057806780778087809781078117812781378147815781678177818781978207821782278237824782578267827782878297830783178327833783478357836783778387839784078417842784378447845784678477848784978507851785278537854785578567857785878597860786178627863786478657866786778687869787078717872787378747875787678777878787978807881788278837884788578867887788878897890789178927893789478957896789778987899790079017902790379047905790679077908790979107911791279137914791579167917791879197920792179227923792479257926792779287929793079317932793379347935793679377938793979407941794279437944794579467947794879497950795179527953795479557956795779587959796079617962796379647965796679677968796979707971797279737974797579767977797879797980798179827983798479857986798779887989799079917992799379947995799679977998799980008001800280038004800580068007800880098010801180128013801480158016801780188019802080218022802380248025802680278028802980308031803280338034803580368037803880398040804180428043804480458046804780488049805080518052805380548055805680578058805980608061806280638064806580668067806880698070807180728073807480758076807780788079808080818082808380848085808680878088808980908091809280938094809580968097809880998100810181028103810481058106810781088109811081118112811381148115811681178118811981208121812281238124812581268127812881298130813181328133813481358136813781388139814081418142814381448145814681478148814981508151815281538154815581568157815881598160816181628163816481658166816781688169817081718172817381748175817681778178817981808181818281838184818581868187818881898190819181928193819481958196819781988199820082018202820382048205820682078208820982108211821282138214821582168217821882198220822182228223822482258226822782288229823082318232823382348235823682378238823982408241824282438244824582468247824882498250825182528253825482558256825782588259826082618262826382648265826682678268826982708271827282738274827582768277827882798280828182828283828482858286828782888289829082918292829382948295829682978298829983008301830283038304830583068307830883098310831183128313831483158316831783188319832083218322832383248325832683278328832983308331833283338334833583368337833883398340834183428343834483458346834783488349835083518352835383548355835683578358835983608361836283638364836583668367836883698370837183728373837483758376837783788379838083818382838383848385838683878388838983908391839283938394839583968397839883998400840184028403840484058406840784088409841084118412841384148415841684178418841984208421842284238424842584268427842884298430843184328433843484358436843784388439844084418442844384448445844684478448844984508451845284538454845584568457845884598460846184628463846484658466846784688469847084718472847384748475847684778478847984808481848284838484848584868487848884898490849184928493849484958496849784988499850085018502850385048505850685078508850985108511851285138514851585168517851885198520852185228523852485258526852785288529853085318532853385348535853685378538853985408541854285438544854585468547854885498550855185528553855485558556855785588559856085618562856385648565856685678568856985708571857285738574857585768577857885798580858185828583858485858586858785888589859085918592859385948595859685978598859986008601860286038604860586068607860886098610861186128613861486158616861786188619862086218622862386248625862686278628862986308631863286338634863586368637863886398640864186428643864486458646864786488649865086518652865386548655865686578658865986608661866286638664866586668667866886698670867186728673867486758676867786788679868086818682868386848685868686878688868986908691869286938694869586968697869886998700870187028703870487058706870787088709871087118712871387148715871687178718871987208721872287238724872587268727872887298730873187328733873487358736873787388739874087418742874387448745874687478748874987508751875287538754875587568757875887598760876187628763876487658766876787688769877087718772877387748775877687778778877987808781878287838784878587868787878887898790879187928793879487958796879787988799880088018802880388048805880688078808880988108811881288138814881588168817881888198820882188228823882488258826882788288829883088318832883388348835883688378838883988408841884288438844884588468847884888498850885188528853885488558856885788588859886088618862886388648865886688678868886988708871887288738874887588768877887888798880888188828883888488858886888788888889889088918892889388948895889688978898889989008901890289038904890589068907890889098910891189128913891489158916891789188919892089218922892389248925892689278928892989308931893289338934893589368937893889398940894189428943894489458946894789488949895089518952895389548955895689578958895989608961896289638964896589668967896889698970897189728973897489758976897789788979898089818982898389848985898689878988898989908991899289938994899589968997899889999000900190029003900490059006900790089009901090119012901390149015901690179018901990209021902290239024902590269027902890299030903190329033903490359036903790389039904090419042904390449045904690479048904990509051905290539054905590569057905890599060906190629063906490659066906790689069907090719072907390749075907690779078907990809081908290839084908590869087908890899090909190929093909490959096909790989099910091019102910391049105910691079108910991109111911291139114911591169117911891199120912191229123912491259126912791289129913091319132913391349135913691379138913991409141914291439144914591469147914891499150915191529153915491559156915791589159916091619162916391649165916691679168916991709171917291739174917591769177917891799180918191829183918491859186918791889189919091919192919391949195919691979198919992009201920292039204920592069207920892099210921192129213921492159216921792189219922092219222922392249225922692279228922992309231923292339234923592369237923892399240924192429243924492459246924792489249925092519252925392549255925692579258925992609261926292639264926592669267926892699270927192729273927492759276927792789279928092819282928392849285928692879288928992909291929292939294929592969297929892999300930193029303930493059306930793089309931093119312931393149315931693179318931993209321932293239324932593269327932893299330933193329333933493359336933793389339934093419342934393449345934693479348934993509351935293539354935593569357935893599360936193629363936493659366936793689369937093719372937393749375937693779378937993809381938293839384938593869387938893899390939193929393939493959396939793989399940094019402940394049405940694079408940994109411941294139414941594169417941894199420942194229423942494259426942794289429943094319432943394349435943694379438943994409441944294439444944594469447944894499450945194529453945494559456945794589459946094619462946394649465946694679468946994709471947294739474947594769477947894799480948194829483948494859486948794889489949094919492949394949495949694979498949995009501950295039504950595069507950895099510951195129513951495159516951795189519952095219522952395249525952695279528952995309531953295339534953595369537953895399540954195429543954495459546954795489549955095519552955395549555955695579558955995609561956295639564956595669567956895699570957195729573957495759576957795789579958095819582958395849585958695879588958995909591959295939594959595969597959895999600960196029603960496059606960796089609961096119612961396149615961696179618961996209621962296239624962596269627962896299630963196329633963496359636963796389639964096419642964396449645964696479648964996509651965296539654965596569657965896599660966196629663966496659666966796689669967096719672967396749675967696779678967996809681968296839684968596869687968896899690969196929693969496959696969796989699970097019702970397049705970697079708970997109711971297139714971597169717971897199720972197229723972497259726972797289729973097319732973397349735973697379738973997409741974297439744974597469747974897499750975197529753975497559756975797589759976097619762976397649765976697679768976997709771977297739774977597769777977897799780978197829783978497859786978797889789979097919792979397949795979697979798979998009801980298039804980598069807980898099810981198129813981498159816981798189819982098219822982398249825982698279828982998309831983298339834983598369837983898399840984198429843984498459846984798489849985098519852985398549855985698579858985998609861986298639864986598669867986898699870987198729873987498759876987798789879988098819882988398849885988698879888988998909891989298939894989598969897989898999900990199029903990499059906990799089909991099119912991399149915991699179918991999209921992299239924992599269927992899299930993199329933993499359936993799389939994099419942994399449945994699479948994999509951995299539954995599569957995899599960996199629963996499659966996799689969997099719972997399749975997699779978997999809981998299839984998599869987998899899990999199929993999499959996999799989999100001000110002100031000410005100061000710008100091001010011100121001310014100151001610017100181001910020100211002210023100241002510026100271002810029100301003110032100331003410035100361003710038100391004010041100421004310044100451004610047100481004910050100511005210053100541005510056100571005810059100601006110062100631006410065100661006710068100691007010071100721007310074100751007610077100781007910080100811008210083100841008510086100871008810089100901009110092100931009410095100961009710098100991010010101101021010310104101051010610107101081010910110101111011210113101141011510116101171011810119101201012110122101231012410125101261012710128101291013010131101321013310134101351013610137101381013910140101411014210143101441014510146101471014810149101501015110152101531015410155101561015710158101591016010161101621016310164101651016610167101681016910170101711017210173101741017510176101771017810179101801018110182101831018410185101861018710188101891019010191101921019310194101951019610197101981019910200102011020210203102041020510206102071020810209102101021110212102131021410215102161021710218102191022010221102221022310224102251022610227102281022910230102311023210233102341023510236102371023810239102401024110242102431024410245102461024710248102491025010251102521025310254102551025610257102581025910260102611026210263102641026510266102671026810269102701027110272102731027410275102761027710278102791028010281102821028310284102851028610287102881028910290102911029210293102941029510296102971029810299103001030110302103031030410305103061030710308103091031010311103121031310314103151031610317103181031910320103211032210323103241032510326103271032810329103301033110332103331033410335103361033710338103391034010341103421034310344103451034610347103481034910350103511035210353103541035510356103571035810359103601036110362103631036410365103661036710368103691037010371103721037310374103751037610377103781037910380103811038210383103841038510386103871038810389103901039110392103931039410395103961039710398103991040010401104021040310404104051040610407104081040910410104111041210413104141041510416104171041810419104201042110422104231042410425104261042710428104291043010431104321043310434104351043610437104381043910440104411044210443104441044510446104471044810449104501045110452104531045410455104561045710458104591046010461104621046310464104651046610467104681046910470104711047210473104741047510476104771047810479104801048110482104831048410485104861048710488104891049010491104921049310494104951049610497104981049910500105011050210503105041050510506105071050810509105101051110512105131051410515105161051710518105191052010521105221052310524105251052610527105281052910530105311053210533105341053510536105371053810539105401054110542105431054410545105461054710548105491055010551105521055310554105551055610557105581055910560105611056210563105641056510566105671056810569105701057110572105731057410575105761057710578105791058010581105821058310584105851058610587105881058910590105911059210593105941059510596105971059810599106001060110602106031060410605106061060710608106091061010611106121061310614106151061610617106181061910620106211062210623106241062510626106271062810629106301063110632106331063410635106361063710638106391064010641106421064310644106451064610647106481064910650106511065210653106541065510656106571065810659106601066110662106631066410665106661066710668106691067010671106721067310674106751067610677106781067910680106811068210683106841068510686106871068810689106901069110692106931069410695106961069710698106991070010701107021070310704107051070610707107081070910710107111071210713107141071510716107171071810719107201072110722107231072410725107261072710728107291073010731107321073310734107351073610737107381073910740107411074210743107441074510746107471074810749107501075110752107531075410755107561075710758107591076010761107621076310764107651076610767107681076910770107711077210773107741077510776107771077810779107801078110782107831078410785107861078710788107891079010791107921079310794107951079610797107981079910800108011080210803108041080510806108071080810809108101081110812108131081410815108161081710818108191082010821108221082310824108251082610827108281082910830108311083210833108341083510836108371083810839108401084110842108431084410845108461084710848108491085010851108521085310854108551085610857108581085910860108611086210863108641086510866108671086810869108701087110872108731087410875108761087710878108791088010881108821088310884108851088610887108881088910890108911089210893108941089510896108971089810899109001090110902109031090410905109061090710908109091091010911109121091310914109151091610917109181091910920109211092210923109241092510926109271092810929109301093110932109331093410935109361093710938109391094010941109421094310944109451094610947109481094910950109511095210953109541095510956109571095810959109601096110962109631096410965109661096710968109691097010971109721097310974109751097610977109781097910980109811098210983109841098510986109871098810989109901099110992109931099410995109961099710998109991100011001110021100311004110051100611007110081100911010110111101211013110141101511016110171101811019110201102111022110231102411025110261102711028110291103011031110321103311034110351103611037110381103911040110411104211043110441104511046110471104811049110501105111052110531105411055110561105711058110591106011061110621106311064110651106611067110681106911070110711107211073110741107511076110771107811079110801108111082110831108411085110861108711088110891109011091110921109311094110951109611097110981109911100111011110211103111041110511106111071110811109111101111111112111131111411115111161111711118111191112011121111221112311124111251112611127111281112911130111311113211133111341113511136111371113811139111401114111142111431114411145111461114711148111491115011151111521115311154111551115611157111581115911160111611116211163111641116511166111671116811169111701117111172111731117411175111761117711178111791118011181111821118311184111851118611187111881118911190111911119211193111941119511196111971119811199112001120111202112031120411205112061120711208112091121011211112121121311214112151121611217112181121911220112211122211223112241122511226112271122811229112301123111232112331123411235112361123711238112391124011241112421124311244112451124611247112481124911250112511125211253112541125511256112571125811259112601126111262112631126411265112661126711268112691127011271112721127311274112751127611277112781127911280112811128211283112841128511286112871128811289112901129111292112931129411295112961129711298112991130011301113021130311304113051130611307113081130911310113111131211313113141131511316113171131811319113201132111322113231132411325113261132711328113291133011331113321133311334113351133611337113381133911340113411134211343113441134511346113471134811349113501135111352113531135411355113561135711358113591136011361113621136311364113651136611367113681136911370113711137211373113741137511376113771137811379113801138111382113831138411385113861138711388113891139011391113921139311394113951139611397113981139911400114011140211403114041140511406114071140811409114101141111412114131141411415114161141711418114191142011421114221142311424114251142611427114281142911430114311143211433114341143511436114371143811439114401144111442114431144411445114461144711448114491145011451114521145311454114551145611457114581145911460114611146211463114641146511466114671146811469114701147111472114731147411475114761147711478114791148011481114821148311484114851148611487114881148911490114911149211493114941149511496114971149811499115001150111502115031150411505115061150711508115091151011511115121151311514115151151611517115181151911520115211152211523115241152511526115271152811529115301153111532115331153411535115361153711538115391154011541115421154311544115451154611547115481154911550115511155211553115541155511556115571155811559115601156111562115631156411565115661156711568115691157011571115721157311574115751157611577115781157911580115811158211583115841158511586115871158811589115901159111592115931159411595115961159711598115991160011601116021160311604116051160611607116081160911610116111161211613116141161511616116171161811619116201162111622116231162411625116261162711628116291163011631116321163311634116351163611637116381163911640116411164211643116441164511646116471164811649116501165111652116531165411655116561165711658116591166011661116621166311664116651166611667116681166911670116711167211673116741167511676116771167811679116801168111682116831168411685116861168711688116891169011691116921169311694116951169611697116981169911700117011170211703117041170511706117071170811709117101171111712117131171411715117161171711718117191172011721117221172311724117251172611727117281172911730117311173211733117341173511736117371173811739117401174111742117431174411745117461174711748117491175011751117521175311754117551175611757117581175911760117611176211763117641176511766117671176811769117701177111772117731177411775117761177711778117791178011781117821178311784117851178611787117881178911790117911179211793117941179511796117971179811799118001180111802118031180411805118061180711808118091181011811118121181311814118151181611817118181181911820118211182211823118241182511826118271182811829118301183111832118331183411835118361183711838118391184011841118421184311844118451184611847118481184911850118511185211853118541185511856118571185811859118601186111862118631186411865118661186711868118691187011871118721187311874118751187611877118781187911880118811188211883118841188511886118871188811889118901189111892118931189411895118961189711898118991190011901119021190311904119051190611907119081190911910119111191211913119141191511916119171191811919119201192111922119231192411925119261192711928119291193011931119321193311934119351193611937119381193911940119411194211943119441194511946119471194811949119501195111952119531195411955119561195711958119591196011961119621196311964119651196611967119681196911970119711197211973119741197511976119771197811979119801198111982119831198411985119861198711988119891199011991119921199311994119951199611997119981199912000120011200212003120041200512006120071200812009120101201112012120131201412015120161201712018120191202012021120221202312024120251202612027120281202912030120311203212033120341203512036120371203812039120401204112042120431204412045120461204712048120491205012051120521205312054120551205612057120581205912060120611206212063120641206512066120671206812069120701207112072120731207412075120761207712078120791208012081120821208312084120851208612087120881208912090120911209212093120941209512096120971209812099121001210112102121031210412105121061210712108121091211012111121121211312114121151211612117121181211912120121211212212123121241212512126121271212812129121301213112132121331213412135121361213712138121391214012141121421214312144121451214612147121481214912150121511215212153121541215512156121571215812159121601216112162121631216412165121661216712168121691217012171121721217312174121751217612177121781217912180121811218212183121841218512186121871218812189121901219112192121931219412195121961219712198121991220012201122021220312204122051220612207122081220912210122111221212213122141221512216122171221812219122201222112222122231222412225122261222712228122291223012231122321223312234122351223612237122381223912240122411224212243122441224512246122471224812249122501225112252122531225412255122561225712258122591226012261122621226312264122651226612267122681226912270122711227212273122741227512276122771227812279122801228112282122831228412285122861228712288122891229012291122921229312294122951229612297122981229912300123011230212303123041230512306123071230812309123101231112312123131231412315123161231712318123191232012321123221232312324123251232612327123281232912330123311233212333123341233512336123371233812339123401234112342123431234412345123461234712348123491235012351123521235312354123551235612357123581235912360123611236212363123641236512366123671236812369123701237112372123731237412375123761237712378123791238012381123821238312384123851238612387123881238912390123911239212393123941239512396123971239812399124001240112402124031240412405124061240712408124091241012411124121241312414124151241612417124181241912420124211242212423124241242512426124271242812429124301243112432124331243412435124361243712438124391244012441124421244312444124451244612447124481244912450124511245212453124541245512456124571245812459124601246112462124631246412465124661246712468124691247012471124721247312474124751247612477124781247912480124811248212483124841248512486124871248812489124901249112492124931249412495124961249712498124991250012501125021250312504125051250612507125081250912510125111251212513125141251512516125171251812519125201252112522125231252412525125261252712528125291253012531125321253312534125351253612537125381253912540125411254212543125441254512546125471254812549125501255112552125531255412555125561255712558125591256012561125621256312564125651256612567125681256912570125711257212573125741257512576125771257812579125801258112582125831258412585125861258712588125891259012591125921259312594125951259612597125981259912600126011260212603126041260512606126071260812609126101261112612126131261412615126161261712618126191262012621126221262312624126251262612627126281262912630126311263212633126341263512636126371263812639126401264112642126431264412645126461264712648126491265012651126521265312654126551265612657126581265912660126611266212663126641266512666126671266812669126701267112672126731267412675126761267712678126791268012681126821268312684126851268612687126881268912690126911269212693126941269512696126971269812699127001270112702127031270412705127061270712708127091271012711127121271312714127151271612717127181271912720127211272212723127241272512726127271272812729127301273112732127331273412735127361273712738127391274012741127421274312744127451274612747127481274912750127511275212753127541275512756127571275812759127601276112762127631276412765127661276712768127691277012771127721277312774127751277612777127781277912780127811278212783127841278512786127871278812789127901279112792127931279412795127961279712798127991280012801128021280312804128051280612807128081280912810128111281212813128141281512816128171281812819128201282112822128231282412825128261282712828128291283012831128321283312834128351283612837128381283912840128411284212843128441284512846128471284812849128501285112852128531285412855128561285712858128591286012861128621286312864128651286612867128681286912870128711287212873128741287512876128771287812879128801288112882128831288412885128861288712888128891289012891128921289312894128951289612897128981289912900129011290212903129041290512906129071290812909129101291112912129131291412915129161291712918129191292012921129221292312924129251292612927129281292912930129311293212933129341293512936129371293812939129401294112942129431294412945129461294712948129491295012951129521295312954129551295612957129581295912960129611296212963129641296512966129671296812969129701297112972129731297412975129761297712978129791298012981129821298312984129851298612987129881298912990129911299212993129941299512996129971299812999130001300113002130031300413005130061300713008130091301013011130121301313014130151301613017130181301913020130211302213023130241302513026130271302813029130301303113032130331303413035130361303713038130391304013041130421304313044130451304613047130481304913050130511305213053130541305513056130571305813059130601306113062130631306413065130661306713068130691307013071130721307313074130751307613077130781307913080130811308213083130841308513086130871308813089130901309113092130931309413095130961309713098130991310013101131021310313104131051310613107131081310913110131111311213113131141311513116131171311813119131201312113122131231312413125131261312713128131291313013131131321313313134131351313613137131381313913140131411314213143131441314513146131471314813149131501315113152131531315413155131561315713158131591316013161131621316313164131651316613167131681316913170131711317213173131741317513176131771317813179131801318113182131831318413185131861318713188131891319013191131921319313194131951319613197131981319913200132011320213203132041320513206132071320813209132101321113212132131321413215132161321713218132191322013221132221322313224132251322613227132281322913230132311323213233132341323513236132371323813239132401324113242132431324413245132461324713248132491325013251132521325313254132551325613257132581325913260132611326213263132641326513266132671326813269132701327113272132731327413275132761327713278132791328013281132821328313284132851328613287132881328913290132911329213293132941329513296132971329813299133001330113302133031330413305133061330713308133091331013311133121331313314133151331613317133181331913320133211332213323133241332513326133271332813329133301333113332133331333413335133361333713338133391334013341133421334313344133451334613347133481334913350133511335213353133541335513356133571335813359133601336113362133631336413365133661336713368133691337013371133721337313374133751337613377133781337913380133811338213383133841338513386133871338813389133901339113392133931339413395133961339713398133991340013401134021340313404134051340613407134081340913410134111341213413134141341513416134171341813419134201342113422134231342413425134261342713428134291343013431134321343313434134351343613437134381343913440134411344213443134441344513446134471344813449134501345113452134531345413455134561345713458134591346013461134621346313464134651346613467134681346913470134711347213473134741347513476134771347813479134801348113482134831348413485134861348713488134891349013491134921349313494134951349613497134981349913500135011350213503135041350513506135071350813509135101351113512135131351413515135161351713518135191352013521135221352313524135251352613527135281352913530135311353213533135341353513536135371353813539135401354113542135431354413545135461354713548135491355013551135521355313554135551355613557135581355913560135611356213563135641356513566135671356813569135701357113572135731357413575135761357713578135791358013581135821358313584135851358613587135881358913590135911359213593135941359513596135971359813599136001360113602136031360413605136061360713608136091361013611136121361313614136151361613617136181361913620136211362213623136241362513626136271362813629136301363113632136331363413635136361363713638136391364013641136421364313644136451364613647136481364913650136511365213653136541365513656136571365813659136601366113662136631366413665136661366713668136691367013671136721367313674136751367613677136781367913680136811368213683136841368513686136871368813689136901369113692136931369413695136961369713698136991370013701137021370313704137051370613707137081370913710137111371213713137141371513716137171371813719137201372113722137231372413725137261372713728137291373013731137321373313734137351373613737137381373913740137411374213743137441374513746137471374813749137501375113752137531375413755137561375713758137591376013761137621376313764137651376613767137681376913770137711377213773137741377513776137771377813779137801378113782137831378413785137861378713788137891379013791137921379313794137951379613797137981379913800138011380213803138041380513806138071380813809138101381113812138131381413815138161381713818138191382013821138221382313824138251382613827138281382913830138311383213833138341383513836138371383813839138401384113842138431384413845138461384713848138491385013851138521385313854138551385613857138581385913860138611386213863138641386513866138671386813869138701387113872138731387413875138761387713878138791388013881138821388313884138851388613887138881388913890138911389213893138941389513896138971389813899139001390113902139031390413905139061390713908139091391013911139121391313914139151391613917139181391913920139211392213923139241392513926139271392813929139301393113932139331393413935139361393713938139391394013941139421394313944139451394613947139481394913950139511395213953139541395513956139571395813959139601396113962139631396413965139661396713968139691397013971139721397313974139751397613977139781397913980139811398213983139841398513986139871398813989139901399113992139931399413995139961399713998139991400014001140021400314004140051400614007140081400914010140111401214013140141401514016140171401814019140201402114022140231402414025140261402714028140291403014031140321403314034140351403614037140381403914040140411404214043140441404514046140471404814049140501405114052140531405414055140561405714058140591406014061140621406314064140651406614067140681406914070140711407214073140741407514076140771407814079140801408114082140831408414085140861408714088140891409014091140921409314094140951409614097140981409914100141011410214103141041410514106141071410814109141101411114112141131411414115141161411714118141191412014121141221412314124141251412614127141281412914130141311413214133141341413514136141371413814139141401414114142141431414414145141461414714148141491415014151141521415314154141551415614157141581415914160141611416214163141641416514166141671416814169141701417114172141731417414175141761417714178141791418014181141821418314184141851418614187141881418914190141911419214193141941419514196141971419814199142001420114202142031420414205142061420714208142091421014211142121421314214142151421614217142181421914220142211422214223142241422514226142271422814229142301423114232142331423414235142361423714238142391424014241142421424314244142451424614247142481424914250142511425214253142541425514256142571425814259142601426114262142631426414265142661426714268142691427014271142721427314274142751427614277142781427914280142811428214283142841428514286142871428814289142901429114292142931429414295142961429714298142991430014301143021430314304143051430614307143081430914310143111431214313143141431514316143171431814319143201432114322143231432414325143261432714328143291433014331143321433314334143351433614337143381433914340143411434214343143441434514346143471434814349143501435114352143531435414355143561435714358143591436014361143621436314364143651436614367143681436914370143711437214373143741437514376143771437814379143801438114382143831438414385143861438714388143891439014391143921439314394143951439614397143981439914400144011440214403144041440514406144071440814409144101441114412144131441414415144161441714418144191442014421144221442314424144251442614427144281442914430144311443214433144341443514436144371443814439144401444114442144431444414445144461444714448144491445014451144521445314454144551445614457144581445914460144611446214463144641446514466144671446814469144701447114472144731447414475144761447714478144791448014481144821448314484144851448614487144881448914490144911449214493144941449514496144971449814499145001450114502145031450414505145061450714508145091451014511145121451314514145151451614517145181451914520145211452214523145241452514526145271452814529145301453114532145331453414535145361453714538145391454014541145421454314544145451454614547145481454914550145511455214553145541455514556145571455814559145601456114562145631456414565145661456714568145691457014571145721457314574145751457614577145781457914580145811458214583145841458514586145871458814589145901459114592145931459414595145961459714598145991460014601146021460314604146051460614607146081460914610146111461214613146141461514616146171461814619146201462114622146231462414625146261462714628146291463014631146321463314634146351463614637146381463914640146411464214643146441464514646146471464814649146501465114652146531465414655146561465714658146591466014661146621466314664146651466614667146681466914670146711467214673146741467514676146771467814679146801468114682146831468414685146861468714688146891469014691146921469314694146951469614697146981469914700147011470214703147041470514706147071470814709147101471114712147131471414715147161471714718147191472014721147221472314724147251472614727147281472914730147311473214733147341473514736147371473814739147401474114742147431474414745147461474714748147491475014751147521475314754147551475614757147581475914760147611476214763147641476514766147671476814769147701477114772147731477414775147761477714778147791478014781147821478314784147851478614787147881478914790147911479214793147941479514796147971479814799148001480114802148031480414805148061480714808148091481014811148121481314814148151481614817148181481914820148211482214823148241482514826148271482814829148301483114832148331483414835148361483714838148391484014841148421484314844148451484614847148481484914850148511485214853148541485514856148571485814859148601486114862148631486414865148661486714868148691487014871148721487314874148751487614877148781487914880148811488214883148841488514886148871488814889148901489114892148931489414895148961489714898148991490014901149021490314904149051490614907149081490914910149111491214913149141491514916149171491814919149201492114922149231492414925149261492714928149291493014931149321493314934149351493614937149381493914940149411494214943149441494514946149471494814949149501495114952149531495414955149561495714958149591496014961149621496314964149651496614967149681496914970149711497214973149741497514976149771497814979149801498114982149831498414985149861498714988149891499014991149921499314994149951499614997149981499915000150011500215003150041500515006150071500815009150101501115012150131501415015150161501715018150191502015021150221502315024150251502615027150281502915030150311503215033150341503515036150371503815039150401504115042150431504415045150461504715048150491505015051150521505315054150551505615057150581505915060150611506215063150641506515066150671506815069150701507115072150731507415075150761507715078150791508015081150821508315084150851508615087150881508915090150911509215093150941509515096150971509815099151001510115102151031510415105151061510715108151091511015111151121511315114151151511615117151181511915120151211512215123151241512515126151271512815129151301513115132151331513415135151361513715138151391514015141151421514315144151451514615147151481514915150151511515215153151541515515156151571515815159151601516115162151631516415165151661516715168151691517015171151721517315174151751517615177151781517915180151811518215183151841518515186151871518815189151901519115192151931519415195151961519715198151991520015201152021520315204152051520615207152081520915210152111521215213152141521515216152171521815219152201522115222152231522415225152261522715228152291523015231152321523315234152351523615237152381523915240152411524215243152441524515246152471524815249152501525115252152531525415255152561525715258152591526015261152621526315264152651526615267152681526915270152711527215273152741527515276152771527815279152801528115282152831528415285152861528715288152891529015291152921529315294152951529615297152981529915300153011530215303153041530515306153071530815309153101531115312153131531415315153161531715318153191532015321153221532315324153251532615327153281532915330153311533215333153341533515336153371533815339153401534115342153431534415345153461534715348153491535015351153521535315354153551535615357153581535915360153611536215363153641536515366153671536815369153701537115372153731537415375153761537715378153791538015381153821538315384153851538615387153881538915390153911539215393153941539515396153971539815399154001540115402154031540415405154061540715408154091541015411154121541315414154151541615417154181541915420154211542215423154241542515426154271542815429154301543115432154331543415435154361543715438154391544015441154421544315444154451544615447154481544915450154511545215453154541545515456154571545815459154601546115462154631546415465154661546715468154691547015471154721547315474154751547615477154781547915480154811548215483154841548515486154871548815489154901549115492154931549415495154961549715498154991550015501155021550315504155051550615507155081550915510155111551215513155141551515516155171551815519155201552115522155231552415525155261552715528155291553015531155321553315534155351553615537155381553915540155411554215543155441554515546155471554815549155501555115552155531555415555155561555715558155591556015561155621556315564155651556615567155681556915570155711557215573155741557515576155771557815579155801558115582155831558415585155861558715588155891559015591155921559315594155951559615597155981559915600156011560215603156041560515606156071560815609156101561115612156131561415615156161561715618156191562015621156221562315624156251562615627156281562915630156311563215633156341563515636156371563815639156401564115642156431564415645156461564715648156491565015651156521565315654156551565615657156581565915660156611566215663156641566515666156671566815669156701567115672156731567415675156761567715678156791568015681156821568315684156851568615687156881568915690156911569215693156941569515696156971569815699157001570115702157031570415705157061570715708157091571015711157121571315714157151571615717157181571915720157211572215723157241572515726157271572815729157301573115732157331573415735157361573715738157391574015741157421574315744157451574615747157481574915750157511575215753157541575515756157571575815759157601576115762157631576415765157661576715768157691577015771157721577315774157751577615777157781577915780157811578215783157841578515786157871578815789157901579115792157931579415795157961579715798157991580015801158021580315804158051580615807158081580915810158111581215813158141581515816158171581815819158201582115822158231582415825158261582715828158291583015831158321583315834158351583615837158381583915840158411584215843158441584515846158471584815849158501585115852158531585415855158561585715858158591586015861158621586315864158651586615867158681586915870158711587215873158741587515876158771587815879158801588115882158831588415885158861588715888158891589015891158921589315894158951589615897158981589915900159011590215903159041590515906159071590815909159101591115912159131591415915159161591715918159191592015921159221592315924159251592615927159281592915930159311593215933159341593515936159371593815939159401594115942159431594415945159461594715948159491595015951159521595315954159551595615957159581595915960159611596215963159641596515966159671596815969159701597115972159731597415975159761597715978159791598015981159821598315984159851598615987159881598915990159911599215993159941599515996159971599815999160001600116002160031600416005160061600716008160091601016011160121601316014160151601616017160181601916020160211602216023160241602516026160271602816029160301603116032160331603416035160361603716038160391604016041160421604316044160451604616047160481604916050160511605216053160541605516056160571605816059160601606116062160631606416065160661606716068160691607016071160721607316074160751607616077160781607916080160811608216083160841608516086160871608816089160901609116092160931609416095160961609716098160991610016101161021610316104161051610616107161081610916110161111611216113161141611516116161171611816119161201612116122161231612416125161261612716128161291613016131161321613316134161351613616137161381613916140161411614216143161441614516146161471614816149161501615116152161531615416155161561615716158161591616016161161621616316164161651616616167161681616916170161711617216173161741617516176161771617816179161801618116182161831618416185161861618716188161891619016191161921619316194161951619616197161981619916200162011620216203162041620516206162071620816209162101621116212162131621416215162161621716218162191622016221162221622316224162251622616227162281622916230162311623216233162341623516236162371623816239162401624116242162431624416245162461624716248162491625016251162521625316254162551625616257162581625916260162611626216263162641626516266162671626816269162701627116272162731627416275162761627716278162791628016281162821628316284162851628616287162881628916290162911629216293162941629516296162971629816299163001630116302163031630416305163061630716308163091631016311163121631316314163151631616317163181631916320163211632216323163241632516326163271632816329163301633116332163331633416335163361633716338163391634016341163421634316344163451634616347163481634916350163511635216353163541635516356163571635816359163601636116362163631636416365163661636716368163691637016371163721637316374163751637616377163781637916380163811638216383163841638516386163871638816389163901639116392163931639416395163961639716398163991640016401164021640316404164051640616407164081640916410164111641216413164141641516416164171641816419164201642116422164231642416425164261642716428164291643016431164321643316434164351643616437164381643916440164411644216443164441644516446164471644816449164501645116452164531645416455164561645716458164591646016461164621646316464164651646616467164681646916470164711647216473164741647516476164771647816479164801648116482164831648416485164861648716488164891649016491164921649316494164951649616497164981649916500165011650216503165041650516506165071650816509165101651116512165131651416515165161651716518165191652016521165221652316524165251652616527165281652916530165311653216533165341653516536165371653816539165401654116542165431654416545165461654716548165491655016551165521655316554165551655616557165581655916560165611656216563165641656516566165671656816569165701657116572165731657416575165761657716578165791658016581165821658316584165851658616587165881658916590165911659216593165941659516596165971659816599166001660116602166031660416605166061660716608166091661016611166121661316614166151661616617166181661916620166211662216623166241662516626166271662816629166301663116632166331663416635166361663716638166391664016641166421664316644166451664616647166481664916650166511665216653166541665516656166571665816659166601666116662166631666416665166661666716668166691667016671166721667316674166751667616677166781667916680166811668216683166841668516686166871668816689166901669116692166931669416695166961669716698166991670016701167021670316704167051670616707167081670916710167111671216713167141671516716167171671816719167201672116722167231672416725167261672716728167291673016731167321673316734167351673616737167381673916740167411674216743167441674516746167471674816749167501675116752167531675416755167561675716758167591676016761167621676316764167651676616767167681676916770167711677216773167741677516776167771677816779167801678116782167831678416785167861678716788167891679016791167921679316794167951679616797167981679916800168011680216803168041680516806168071680816809168101681116812168131681416815168161681716818168191682016821168221682316824168251682616827168281682916830168311683216833168341683516836168371683816839168401684116842168431684416845168461684716848168491685016851168521685316854168551685616857168581685916860168611686216863168641686516866168671686816869168701687116872168731687416875168761687716878168791688016881168821688316884168851688616887168881688916890168911689216893168941689516896168971689816899169001690116902169031690416905169061690716908169091691016911169121691316914169151691616917169181691916920169211692216923169241692516926169271692816929169301693116932169331693416935169361693716938169391694016941169421694316944169451694616947169481694916950169511695216953169541695516956169571695816959169601696116962169631696416965169661696716968169691697016971169721697316974169751697616977169781697916980169811698216983169841698516986169871698816989169901699116992169931699416995169961699716998169991700017001170021700317004170051700617007170081700917010170111701217013170141701517016170171701817019170201702117022170231702417025170261702717028170291703017031170321703317034170351703617037170381703917040170411704217043170441704517046170471704817049170501705117052170531705417055170561705717058170591706017061170621706317064170651706617067170681706917070170711707217073170741707517076170771707817079170801708117082170831708417085170861708717088170891709017091170921709317094170951709617097170981709917100171011710217103171041710517106171071710817109171101711117112171131711417115171161711717118171191712017121171221712317124171251712617127171281712917130171311713217133171341713517136171371713817139171401714117142171431714417145171461714717148171491715017151171521715317154171551715617157171581715917160171611716217163171641716517166171671716817169171701717117172171731717417175171761717717178171791718017181171821718317184171851718617187171881718917190171911719217193171941719517196171971719817199172001720117202172031720417205172061720717208172091721017211172121721317214172151721617217172181721917220172211722217223172241722517226172271722817229172301723117232172331723417235172361723717238172391724017241172421724317244172451724617247172481724917250172511725217253172541725517256172571725817259172601726117262172631726417265172661726717268172691727017271172721727317274172751727617277172781727917280172811728217283172841728517286172871728817289172901729117292172931729417295172961729717298172991730017301173021730317304173051730617307173081730917310173111731217313173141731517316173171731817319173201732117322173231732417325173261732717328173291733017331173321733317334173351733617337173381733917340173411734217343173441734517346173471734817349173501735117352173531735417355173561735717358173591736017361173621736317364173651736617367173681736917370173711737217373173741737517376173771737817379173801738117382173831738417385173861738717388173891739017391173921739317394173951739617397173981739917400174011740217403174041740517406174071740817409174101741117412174131741417415174161741717418174191742017421174221742317424174251742617427174281742917430174311743217433174341743517436174371743817439174401744117442174431744417445174461744717448174491745017451174521745317454174551745617457174581745917460174611746217463174641746517466174671746817469174701747117472174731747417475174761747717478174791748017481174821748317484174851748617487174881748917490174911749217493174941749517496174971749817499175001750117502175031750417505175061750717508175091751017511175121751317514175151751617517175181751917520175211752217523175241752517526175271752817529175301753117532175331753417535175361753717538175391754017541175421754317544175451754617547175481754917550175511755217553175541755517556175571755817559175601756117562175631756417565175661756717568175691757017571175721757317574175751757617577175781757917580175811758217583175841758517586175871758817589175901759117592175931759417595175961759717598175991760017601176021760317604176051760617607176081760917610176111761217613176141761517616176171761817619176201762117622176231762417625176261762717628176291763017631176321763317634176351763617637176381763917640176411764217643176441764517646176471764817649176501765117652176531765417655176561765717658176591766017661176621766317664176651766617667176681766917670176711767217673176741767517676176771767817679176801768117682176831768417685176861768717688176891769017691176921769317694176951769617697176981769917700177011770217703177041770517706177071770817709177101771117712177131771417715177161771717718177191772017721177221772317724177251772617727177281772917730177311773217733177341773517736177371773817739177401774117742177431774417745177461774717748177491775017751177521775317754177551775617757177581775917760177611776217763177641776517766177671776817769177701777117772177731777417775177761777717778177791778017781177821778317784177851778617787177881778917790177911779217793177941779517796177971779817799178001780117802178031780417805178061780717808178091781017811178121781317814178151781617817178181781917820178211782217823178241782517826178271782817829178301783117832178331783417835178361783717838178391784017841178421784317844178451784617847178481784917850178511785217853178541785517856178571785817859178601786117862178631786417865178661786717868178691787017871178721787317874178751787617877178781787917880178811788217883178841788517886178871788817889178901789117892178931789417895178961789717898178991790017901179021790317904179051790617907179081790917910179111791217913179141791517916179171791817919179201792117922179231792417925179261792717928179291793017931179321793317934179351793617937179381793917940179411794217943179441794517946179471794817949179501795117952179531795417955179561795717958179591796017961179621796317964179651796617967179681796917970179711797217973179741797517976179771797817979179801798117982179831798417985179861798717988179891799017991179921799317994179951799617997179981799918000180011800218003180041800518006180071800818009180101801118012180131801418015180161801718018180191802018021180221802318024180251802618027180281802918030180311803218033180341803518036180371803818039180401804118042180431804418045180461804718048180491805018051180521805318054180551805618057180581805918060180611806218063180641806518066180671806818069180701807118072180731807418075180761807718078180791808018081180821808318084180851808618087180881808918090180911809218093180941809518096180971809818099181001810118102181031810418105181061810718108181091811018111181121811318114181151811618117181181811918120181211812218123181241812518126181271812818129181301813118132181331813418135181361813718138181391814018141181421814318144181451814618147181481814918150181511815218153181541815518156181571815818159181601816118162181631816418165181661816718168181691817018171181721817318174181751817618177181781817918180181811818218183181841818518186181871818818189181901819118192181931819418195181961819718198181991820018201182021820318204182051820618207182081820918210182111821218213182141821518216182171821818219182201822118222182231822418225182261822718228182291823018231182321823318234182351823618237182381823918240182411824218243182441824518246182471824818249182501825118252182531825418255182561825718258182591826018261182621826318264182651826618267182681826918270182711827218273182741827518276182771827818279182801828118282182831828418285182861828718288182891829018291182921829318294182951829618297182981829918300183011830218303183041830518306183071830818309183101831118312183131831418315183161831718318183191832018321183221832318324183251832618327183281832918330183311833218333183341833518336183371833818339183401834118342183431834418345183461834718348183491835018351183521835318354183551835618357183581835918360183611836218363183641836518366183671836818369183701837118372183731837418375183761837718378183791838018381183821838318384183851838618387183881838918390183911839218393183941839518396183971839818399184001840118402184031840418405184061840718408184091841018411184121841318414184151841618417184181841918420184211842218423184241842518426184271842818429184301843118432184331843418435184361843718438184391844018441184421844318444184451844618447184481844918450184511845218453184541845518456184571845818459184601846118462184631846418465184661846718468184691847018471184721847318474184751847618477184781847918480184811848218483184841848518486184871848818489184901849118492184931849418495184961849718498184991850018501185021850318504185051850618507185081850918510185111851218513185141851518516185171851818519185201852118522185231852418525185261852718528185291853018531185321853318534185351853618537185381853918540185411854218543185441854518546185471854818549185501855118552185531855418555185561855718558185591856018561185621856318564185651856618567185681856918570185711857218573185741857518576185771857818579185801858118582185831858418585185861858718588185891859018591185921859318594185951859618597185981859918600186011860218603186041860518606186071860818609186101861118612186131861418615186161861718618186191862018621186221862318624186251862618627186281862918630186311863218633186341863518636186371863818639186401864118642186431864418645186461864718648186491865018651186521865318654186551865618657186581865918660186611866218663186641866518666186671866818669186701867118672186731867418675186761867718678186791868018681186821868318684186851868618687186881868918690186911869218693186941869518696186971869818699187001870118702187031870418705187061870718708187091871018711187121871318714187151871618717187181871918720187211872218723187241872518726187271872818729187301873118732187331873418735187361873718738187391874018741187421874318744187451874618747187481874918750187511875218753187541875518756187571875818759187601876118762187631876418765187661876718768187691877018771187721877318774187751877618777187781877918780187811878218783187841878518786187871878818789187901879118792187931879418795187961879718798187991880018801188021880318804188051880618807188081880918810188111881218813188141881518816188171881818819188201882118822188231882418825188261882718828188291883018831188321883318834188351883618837188381883918840188411884218843188441884518846188471884818849188501885118852188531885418855188561885718858188591886018861188621886318864188651886618867188681886918870188711887218873188741887518876188771887818879188801888118882188831888418885188861888718888188891889018891188921889318894188951889618897188981889918900189011890218903189041890518906189071890818909189101891118912189131891418915189161891718918189191892018921189221892318924189251892618927189281892918930189311893218933189341893518936189371893818939189401894118942189431894418945189461894718948189491895018951189521895318954189551895618957189581895918960189611896218963189641896518966189671896818969189701897118972189731897418975189761897718978189791898018981189821898318984189851898618987189881898918990189911899218993189941899518996189971899818999190001900119002190031900419005190061900719008190091901019011190121901319014190151901619017190181901919020190211902219023190241902519026190271902819029190301903119032190331903419035190361903719038190391904019041190421904319044190451904619047190481904919050190511905219053190541905519056190571905819059190601906119062190631906419065190661906719068190691907019071190721907319074190751907619077190781907919080190811908219083190841908519086190871908819089190901909119092190931909419095190961909719098190991910019101191021910319104191051910619107191081910919110191111911219113191141911519116191171911819119191201912119122191231912419125191261912719128191291913019131191321913319134191351913619137191381913919140191411914219143191441914519146191471914819149191501915119152191531915419155191561915719158191591916019161191621916319164191651916619167191681916919170191711917219173191741917519176191771917819179191801918119182191831918419185191861918719188191891919019191191921919319194191951919619197191981919919200192011920219203192041920519206192071920819209192101921119212192131921419215192161921719218192191922019221192221922319224192251922619227192281922919230192311923219233192341923519236192371923819239192401924119242192431924419245192461924719248192491925019251192521925319254192551925619257192581925919260192611926219263192641926519266192671926819269192701927119272192731927419275192761927719278192791928019281192821928319284192851928619287192881928919290192911929219293192941929519296192971929819299193001930119302193031930419305193061930719308193091931019311193121931319314193151931619317193181931919320193211932219323193241932519326193271932819329193301933119332193331933419335193361933719338193391934019341193421934319344193451934619347193481934919350193511935219353193541935519356193571935819359193601936119362193631936419365193661936719368193691937019371193721937319374193751937619377193781937919380193811938219383193841938519386193871938819389193901939119392193931939419395193961939719398193991940019401194021940319404194051940619407194081940919410194111941219413194141941519416194171941819419194201942119422194231942419425194261942719428194291943019431194321943319434194351943619437194381943919440194411944219443194441944519446194471944819449194501945119452194531945419455194561945719458194591946019461194621946319464194651946619467194681946919470194711947219473194741947519476194771947819479194801948119482194831948419485194861948719488194891949019491194921949319494194951949619497194981949919500195011950219503195041950519506195071950819509195101951119512195131951419515195161951719518195191952019521195221952319524195251952619527195281952919530195311953219533195341953519536195371953819539195401954119542195431954419545195461954719548195491955019551195521955319554195551955619557195581955919560195611956219563195641956519566195671956819569195701957119572195731957419575195761957719578195791958019581195821958319584195851958619587195881958919590195911959219593195941959519596195971959819599196001960119602196031960419605196061960719608196091961019611196121961319614196151961619617196181961919620196211962219623196241962519626196271962819629196301963119632196331963419635196361963719638196391964019641196421964319644196451964619647196481964919650196511965219653196541965519656196571965819659196601966119662196631966419665196661966719668196691967019671196721967319674196751967619677196781967919680196811968219683196841968519686196871968819689196901969119692196931969419695196961969719698196991970019701197021970319704197051970619707197081970919710197111971219713197141971519716197171971819719197201972119722197231972419725197261972719728197291973019731197321973319734197351973619737197381973919740197411974219743197441974519746197471974819749197501975119752197531975419755197561975719758197591976019761197621976319764197651976619767197681976919770197711977219773197741977519776197771977819779197801978119782197831978419785197861978719788197891979019791197921979319794197951979619797197981979919800198011980219803198041980519806198071980819809198101981119812198131981419815198161981719818198191982019821198221982319824198251982619827198281982919830198311983219833198341983519836198371983819839198401984119842198431984419845198461984719848198491985019851198521985319854198551985619857198581985919860198611986219863198641986519866198671986819869198701987119872198731987419875198761987719878198791988019881198821988319884198851988619887198881988919890198911989219893198941989519896198971989819899199001990119902199031990419905199061990719908199091991019911199121991319914199151991619917199181991919920199211992219923199241992519926199271992819929199301993119932199331993419935199361993719938199391994019941199421994319944199451994619947199481994919950199511995219953199541995519956199571995819959199601996119962199631996419965199661996719968199691997019971199721997319974199751997619977199781997919980199811998219983199841998519986199871998819989199901999119992199931999419995199961999719998199992000020001200022000320004200052000620007200082000920010200112001220013200142001520016200172001820019200202002120022200232002420025200262002720028200292003020031200322003320034200352003620037200382003920040200412004220043200442004520046200472004820049200502005120052200532005420055200562005720058200592006020061200622006320064200652006620067200682006920070200712007220073200742007520076200772007820079200802008120082200832008420085200862008720088200892009020091200922009320094200952009620097200982009920100201012010220103201042010520106201072010820109201102011120112201132011420115201162011720118201192012020121201222012320124201252012620127201282012920130201312013220133201342013520136201372013820139201402014120142201432014420145201462014720148201492015020151201522015320154201552015620157201582015920160201612016220163201642016520166201672016820169201702017120172201732017420175201762017720178201792018020181201822018320184201852018620187201882018920190201912019220193201942019520196201972019820199202002020120202202032020420205202062020720208202092021020211202122021320214202152021620217202182021920220202212022220223202242022520226202272022820229202302023120232202332023420235202362023720238202392024020241202422024320244202452024620247202482024920250202512025220253202542025520256202572025820259202602026120262202632026420265202662026720268202692027020271202722027320274202752027620277202782027920280202812028220283202842028520286202872028820289202902029120292202932029420295202962029720298202992030020301203022030320304203052030620307203082030920310203112031220313203142031520316203172031820319203202032120322203232032420325203262032720328203292033020331203322033320334203352033620337203382033920340203412034220343203442034520346203472034820349203502035120352203532035420355203562035720358203592036020361203622036320364203652036620367203682036920370203712037220373203742037520376203772037820379203802038120382203832038420385203862038720388203892039020391203922039320394203952039620397203982039920400204012040220403204042040520406204072040820409204102041120412204132041420415204162041720418204192042020421204222042320424204252042620427204282042920430204312043220433204342043520436204372043820439204402044120442204432044420445204462044720448204492045020451204522045320454204552045620457204582045920460204612046220463204642046520466204672046820469204702047120472204732047420475204762047720478204792048020481204822048320484204852048620487204882048920490204912049220493204942049520496204972049820499205002050120502205032050420505205062050720508205092051020511205122051320514205152051620517205182051920520205212052220523205242052520526205272052820529205302053120532205332053420535205362053720538205392054020541205422054320544205452054620547205482054920550205512055220553205542055520556205572055820559205602056120562205632056420565205662056720568205692057020571205722057320574205752057620577205782057920580205812058220583205842058520586205872058820589205902059120592205932059420595205962059720598205992060020601206022060320604206052060620607206082060920610206112061220613206142061520616206172061820619206202062120622206232062420625206262062720628206292063020631206322063320634206352063620637206382063920640206412064220643206442064520646206472064820649206502065120652206532065420655206562065720658206592066020661206622066320664206652066620667206682066920670206712067220673206742067520676206772067820679206802068120682206832068420685206862068720688206892069020691206922069320694206952069620697206982069920700207012070220703207042070520706207072070820709207102071120712207132071420715207162071720718207192072020721207222072320724207252072620727207282072920730207312073220733207342073520736207372073820739207402074120742207432074420745207462074720748207492075020751207522075320754207552075620757207582075920760207612076220763207642076520766207672076820769207702077120772207732077420775207762077720778207792078020781207822078320784207852078620787207882078920790207912079220793207942079520796207972079820799208002080120802208032080420805208062080720808208092081020811208122081320814208152081620817208182081920820208212082220823208242082520826208272082820829208302083120832208332083420835208362083720838208392084020841208422084320844208452084620847208482084920850208512085220853208542085520856208572085820859208602086120862208632086420865208662086720868208692087020871208722087320874208752087620877208782087920880208812088220883208842088520886208872088820889208902089120892208932089420895208962089720898208992090020901209022090320904209052090620907209082090920910209112091220913209142091520916209172091820919209202092120922209232092420925209262092720928209292093020931209322093320934209352093620937209382093920940209412094220943209442094520946209472094820949209502095120952209532095420955209562095720958209592096020961209622096320964209652096620967209682096920970209712097220973209742097520976209772097820979209802098120982209832098420985209862098720988209892099020991209922099320994209952099620997209982099921000210012100221003210042100521006210072100821009210102101121012210132101421015210162101721018210192102021021210222102321024210252102621027210282102921030210312103221033210342103521036210372103821039210402104121042210432104421045210462104721048210492105021051210522105321054210552105621057210582105921060210612106221063210642106521066210672106821069210702107121072210732107421075210762107721078210792108021081210822108321084210852108621087210882108921090210912109221093210942109521096210972109821099211002110121102211032110421105211062110721108211092111021111211122111321114211152111621117211182111921120211212112221123211242112521126211272112821129211302113121132211332113421135211362113721138211392114021141211422114321144211452114621147211482114921150211512115221153211542115521156211572115821159211602116121162211632116421165211662116721168211692117021171211722117321174211752117621177211782117921180211812118221183211842118521186211872118821189211902119121192211932119421195211962119721198211992120021201212022120321204212052120621207212082120921210212112121221213212142121521216212172121821219212202122121222212232122421225212262122721228212292123021231212322123321234212352123621237212382123921240212412124221243212442124521246212472124821249212502125121252212532125421255212562125721258212592126021261212622126321264212652126621267212682126921270212712127221273212742127521276212772127821279212802128121282212832128421285212862128721288212892129021291212922129321294212952129621297212982129921300213012130221303213042130521306213072130821309213102131121312213132131421315213162131721318213192132021321213222132321324213252132621327213282132921330213312133221333213342133521336213372133821339213402134121342213432134421345213462134721348213492135021351213522135321354213552135621357213582135921360213612136221363213642136521366213672136821369213702137121372213732137421375213762137721378213792138021381213822138321384213852138621387213882138921390213912139221393213942139521396213972139821399214002140121402214032140421405214062140721408214092141021411214122141321414214152141621417214182141921420214212142221423214242142521426214272142821429214302143121432214332143421435214362143721438214392144021441214422144321444214452144621447214482144921450214512145221453214542145521456214572145821459214602146121462214632146421465214662146721468214692147021471214722147321474214752147621477214782147921480214812148221483214842148521486214872148821489214902149121492214932149421495214962149721498214992150021501215022150321504215052150621507215082150921510215112151221513215142151521516215172151821519215202152121522215232152421525215262152721528215292153021531215322153321534215352153621537215382153921540215412154221543215442154521546215472154821549215502155121552215532155421555215562155721558215592156021561215622156321564215652156621567215682156921570215712157221573215742157521576215772157821579215802158121582215832158421585215862158721588215892159021591215922159321594215952159621597215982159921600216012160221603216042160521606216072160821609216102161121612216132161421615216162161721618216192162021621216222162321624216252162621627216282162921630216312163221633216342163521636216372163821639216402164121642216432164421645216462164721648216492165021651216522165321654216552165621657216582165921660216612166221663216642166521666216672166821669216702167121672216732167421675216762167721678216792168021681216822168321684216852168621687216882168921690216912169221693216942169521696216972169821699217002170121702217032170421705217062170721708217092171021711217122171321714217152171621717217182171921720217212172221723217242172521726217272172821729217302173121732217332173421735217362173721738217392174021741217422174321744217452174621747217482174921750217512175221753217542175521756217572175821759217602176121762217632176421765217662176721768217692177021771217722177321774217752177621777217782177921780217812178221783217842178521786217872178821789217902179121792217932179421795217962179721798217992180021801218022180321804218052180621807218082180921810218112181221813218142181521816218172181821819218202182121822218232182421825218262182721828218292183021831218322183321834218352183621837218382183921840218412184221843218442184521846218472184821849218502185121852218532185421855218562185721858218592186021861218622186321864218652186621867218682186921870218712187221873218742187521876218772187821879218802188121882218832188421885218862188721888218892189021891218922189321894218952189621897218982189921900219012190221903219042190521906219072190821909219102191121912219132191421915219162191721918219192192021921219222192321924219252192621927219282192921930219312193221933219342193521936219372193821939219402194121942219432194421945219462194721948219492195021951219522195321954219552195621957219582195921960219612196221963219642196521966219672196821969219702197121972219732197421975219762197721978219792198021981219822198321984219852198621987219882198921990219912199221993219942199521996219972199821999220002200122002220032200422005220062200722008220092201022011220122201322014220152201622017220182201922020220212202222023220242202522026220272202822029220302203122032220332203422035220362203722038220392204022041220422204322044220452204622047220482204922050220512205222053220542205522056220572205822059220602206122062220632206422065220662206722068220692207022071220722207322074220752207622077220782207922080220812208222083220842208522086220872208822089220902209122092220932209422095220962209722098220992210022101221022210322104221052210622107221082210922110221112211222113221142211522116221172211822119221202212122122221232212422125221262212722128221292213022131221322213322134221352213622137221382213922140221412214222143221442214522146221472214822149221502215122152221532215422155221562215722158221592216022161221622216322164221652216622167221682216922170221712217222173221742217522176221772217822179221802218122182221832218422185221862218722188221892219022191221922219322194221952219622197221982219922200222012220222203222042220522206222072220822209222102221122212222132221422215222162221722218222192222022221222222222322224222252222622227222282222922230222312223222233222342223522236222372223822239222402224122242222432224422245222462224722248222492225022251222522225322254222552225622257222582225922260222612226222263222642226522266222672226822269222702227122272222732227422275222762227722278222792228022281222822228322284222852228622287222882228922290222912229222293222942229522296222972229822299223002230122302223032230422305223062230722308223092231022311223122231322314223152231622317223182231922320223212232222323223242232522326223272232822329223302233122332223332233422335223362233722338223392234022341223422234322344223452234622347223482234922350223512235222353223542235522356223572235822359223602236122362223632236422365223662236722368223692237022371223722237322374223752237622377223782237922380223812238222383223842238522386223872238822389223902239122392223932239422395223962239722398223992240022401224022240322404224052240622407224082240922410224112241222413224142241522416224172241822419224202242122422224232242422425224262242722428224292243022431224322243322434224352243622437224382243922440224412244222443224442244522446224472244822449224502245122452224532245422455224562245722458224592246022461224622246322464224652246622467224682246922470224712247222473224742247522476224772247822479224802248122482224832248422485224862248722488224892249022491224922249322494224952249622497224982249922500225012250222503225042250522506225072250822509225102251122512225132251422515225162251722518225192252022521225222252322524225252252622527225282252922530225312253222533225342253522536225372253822539225402254122542225432254422545225462254722548225492255022551225522255322554225552255622557225582255922560225612256222563225642256522566225672256822569225702257122572225732257422575225762257722578225792258022581225822258322584225852258622587225882258922590225912259222593225942259522596225972259822599226002260122602226032260422605226062260722608226092261022611226122261322614226152261622617226182261922620226212262222623226242262522626226272262822629226302263122632226332263422635226362263722638226392264022641226422264322644226452264622647226482264922650226512265222653226542265522656226572265822659226602266122662226632266422665226662266722668226692267022671226722267322674226752267622677226782267922680226812268222683226842268522686226872268822689226902269122692226932269422695226962269722698226992270022701227022270322704227052270622707227082270922710227112271222713227142271522716227172271822719227202272122722227232272422725227262272722728227292273022731227322273322734227352273622737227382273922740227412274222743227442274522746227472274822749227502275122752227532275422755227562275722758227592276022761227622276322764227652276622767227682276922770227712277222773227742277522776227772277822779227802278122782227832278422785227862278722788227892279022791227922279322794227952279622797227982279922800228012280222803228042280522806228072280822809228102281122812228132281422815228162281722818228192282022821228222282322824228252282622827228282282922830228312283222833228342283522836228372283822839228402284122842228432284422845228462284722848228492285022851228522285322854228552285622857228582285922860228612286222863228642286522866228672286822869228702287122872228732287422875228762287722878228792288022881228822288322884228852288622887228882288922890228912289222893228942289522896228972289822899229002290122902229032290422905229062290722908229092291022911229122291322914229152291622917229182291922920229212292222923229242292522926229272292822929229302293122932229332293422935229362293722938229392294022941229422294322944229452294622947229482294922950229512295222953229542295522956229572295822959229602296122962229632296422965229662296722968229692297022971229722297322974229752297622977229782297922980229812298222983229842298522986229872298822989229902299122992229932299422995229962299722998229992300023001230022300323004230052300623007230082300923010230112301223013230142301523016230172301823019230202302123022230232302423025230262302723028230292303023031230322303323034230352303623037230382303923040230412304223043230442304523046230472304823049230502305123052230532305423055230562305723058230592306023061230622306323064230652306623067230682306923070230712307223073230742307523076230772307823079230802308123082230832308423085230862308723088230892309023091230922309323094230952309623097230982309923100231012310223103231042310523106231072310823109231102311123112231132311423115231162311723118231192312023121231222312323124231252312623127231282312923130231312313223133231342313523136231372313823139231402314123142231432314423145231462314723148231492315023151231522315323154231552315623157231582315923160231612316223163231642316523166231672316823169231702317123172231732317423175231762317723178231792318023181231822318323184231852318623187231882318923190231912319223193231942319523196231972319823199232002320123202232032320423205232062320723208232092321023211232122321323214232152321623217232182321923220232212322223223232242322523226232272322823229232302323123232232332323423235232362323723238232392324023241232422324323244232452324623247232482324923250232512325223253232542325523256232572325823259232602326123262232632326423265232662326723268232692327023271232722327323274232752327623277232782327923280232812328223283232842328523286232872328823289232902329123292232932329423295232962329723298232992330023301233022330323304233052330623307233082330923310233112331223313233142331523316233172331823319233202332123322233232332423325233262332723328233292333023331233322333323334233352333623337233382333923340233412334223343233442334523346233472334823349233502335123352233532335423355233562335723358233592336023361233622336323364233652336623367233682336923370233712337223373233742337523376233772337823379233802338123382233832338423385233862338723388233892339023391233922339323394233952339623397233982339923400234012340223403234042340523406234072340823409234102341123412234132341423415234162341723418234192342023421234222342323424234252342623427234282342923430234312343223433234342343523436234372343823439234402344123442234432344423445234462344723448234492345023451234522345323454234552345623457234582345923460234612346223463234642346523466234672346823469234702347123472234732347423475234762347723478234792348023481234822348323484234852348623487234882348923490234912349223493234942349523496234972349823499235002350123502235032350423505235062350723508235092351023511235122351323514235152351623517235182351923520235212352223523235242352523526235272352823529235302353123532235332353423535235362353723538235392354023541235422354323544235452354623547235482354923550235512355223553235542355523556235572355823559235602356123562235632356423565235662356723568235692357023571235722357323574235752357623577235782357923580235812358223583235842358523586235872358823589235902359123592235932359423595235962359723598235992360023601236022360323604236052360623607236082360923610236112361223613236142361523616236172361823619236202362123622236232362423625236262362723628236292363023631236322363323634236352363623637236382363923640236412364223643236442364523646236472364823649236502365123652236532365423655236562365723658236592366023661236622366323664236652366623667236682366923670236712367223673236742367523676236772367823679236802368123682236832368423685236862368723688236892369023691236922369323694236952369623697236982369923700237012370223703237042370523706237072370823709237102371123712237132371423715237162371723718237192372023721237222372323724237252372623727237282372923730237312373223733237342373523736237372373823739237402374123742237432374423745237462374723748237492375023751237522375323754237552375623757237582375923760237612376223763237642376523766237672376823769237702377123772237732377423775237762377723778237792378023781237822378323784237852378623787237882378923790237912379223793237942379523796237972379823799238002380123802238032380423805238062380723808238092381023811238122381323814238152381623817238182381923820238212382223823238242382523826238272382823829238302383123832238332383423835238362383723838238392384023841238422384323844238452384623847238482384923850238512385223853238542385523856238572385823859238602386123862238632386423865238662386723868238692387023871238722387323874238752387623877238782387923880238812388223883238842388523886238872388823889238902389123892238932389423895238962389723898238992390023901239022390323904239052390623907239082390923910239112391223913239142391523916239172391823919239202392123922239232392423925239262392723928239292393023931239322393323934239352393623937239382393923940239412394223943239442394523946239472394823949239502395123952239532395423955239562395723958239592396023961239622396323964239652396623967239682396923970239712397223973239742397523976239772397823979239802398123982239832398423985239862398723988239892399023991239922399323994239952399623997239982399924000240012400224003240042400524006240072400824009240102401124012240132401424015240162401724018240192402024021240222402324024240252402624027240282402924030240312403224033240342403524036240372403824039240402404124042240432404424045240462404724048240492405024051240522405324054240552405624057240582405924060240612406224063240642406524066240672406824069240702407124072240732407424075240762407724078240792408024081240822408324084240852408624087240882408924090240912409224093240942409524096240972409824099241002410124102241032410424105241062410724108241092411024111241122411324114241152411624117241182411924120241212412224123241242412524126241272412824129241302413124132241332413424135241362413724138241392414024141241422414324144241452414624147241482414924150241512415224153241542415524156241572415824159241602416124162241632416424165241662416724168241692417024171241722417324174241752417624177241782417924180241812418224183241842418524186241872418824189241902419124192241932419424195241962419724198241992420024201242022420324204242052420624207242082420924210242112421224213242142421524216242172421824219242202422124222242232422424225242262422724228242292423024231242322423324234242352423624237242382423924240242412424224243242442424524246242472424824249242502425124252242532425424255242562425724258242592426024261242622426324264242652426624267242682426924270242712427224273242742427524276242772427824279242802428124282242832428424285242862428724288242892429024291242922429324294242952429624297242982429924300243012430224303243042430524306243072430824309243102431124312243132431424315243162431724318243192432024321243222432324324243252432624327243282432924330243312433224333243342433524336243372433824339243402434124342243432434424345243462434724348243492435024351243522435324354243552435624357243582435924360243612436224363243642436524366243672436824369243702437124372243732437424375243762437724378243792438024381243822438324384243852438624387243882438924390243912439224393243942439524396243972439824399244002440124402244032440424405244062440724408244092441024411244122441324414244152441624417244182441924420244212442224423244242442524426244272442824429244302443124432244332443424435244362443724438244392444024441244422444324444244452444624447244482444924450244512445224453244542445524456244572445824459244602446124462244632446424465244662446724468244692447024471244722447324474244752447624477244782447924480244812448224483244842448524486244872448824489244902449124492244932449424495244962449724498244992450024501245022450324504245052450624507245082450924510245112451224513245142451524516245172451824519245202452124522245232452424525245262452724528245292453024531245322453324534245352453624537245382453924540245412454224543245442454524546245472454824549245502455124552245532455424555245562455724558245592456024561245622456324564245652456624567245682456924570245712457224573245742457524576245772457824579245802458124582245832458424585245862458724588245892459024591245922459324594245952459624597245982459924600246012460224603246042460524606246072460824609246102461124612246132461424615246162461724618246192462024621246222462324624246252462624627246282462924630246312463224633246342463524636246372463824639246402464124642246432464424645246462464724648246492465024651246522465324654246552465624657246582465924660246612466224663246642466524666246672466824669246702467124672246732467424675246762467724678246792468024681246822468324684246852468624687246882468924690246912469224693246942469524696246972469824699247002470124702247032470424705247062470724708247092471024711247122471324714247152471624717247182471924720247212472224723247242472524726247272472824729247302473124732247332473424735247362473724738247392474024741247422474324744247452474624747247482474924750247512475224753247542475524756247572475824759247602476124762247632476424765247662476724768247692477024771247722477324774247752477624777247782477924780247812478224783247842478524786247872478824789247902479124792247932479424795247962479724798247992480024801248022480324804248052480624807248082480924810248112481224813248142481524816248172481824819248202482124822248232482424825248262482724828248292483024831248322483324834248352483624837248382483924840248412484224843248442484524846248472484824849248502485124852248532485424855248562485724858248592486024861248622486324864248652486624867248682486924870248712487224873248742487524876248772487824879248802488124882248832488424885248862488724888248892489024891248922489324894248952489624897248982489924900249012490224903249042490524906249072490824909249102491124912249132491424915249162491724918249192492024921249222492324924249252492624927249282492924930249312493224933249342493524936249372493824939249402494124942249432494424945249462494724948249492495024951249522495324954249552495624957249582495924960249612496224963249642496524966249672496824969249702497124972249732497424975249762497724978249792498024981249822498324984249852498624987249882498924990249912499224993249942499524996249972499824999250002500125002250032500425005250062500725008250092501025011250122501325014250152501625017250182501925020250212502225023250242502525026250272502825029250302503125032250332503425035250362503725038250392504025041250422504325044250452504625047250482504925050250512505225053250542505525056250572505825059250602506125062250632506425065250662506725068250692507025071250722507325074250752507625077250782507925080250812508225083250842508525086250872508825089250902509125092250932509425095250962509725098250992510025101251022510325104251052510625107251082510925110251112511225113251142511525116251172511825119251202512125122251232512425125251262512725128251292513025131251322513325134251352513625137251382513925140251412514225143251442514525146251472514825149251502515125152251532515425155251562515725158251592516025161251622516325164251652516625167251682516925170251712517225173251742517525176251772517825179251802518125182251832518425185251862518725188251892519025191251922519325194251952519625197251982519925200252012520225203252042520525206252072520825209252102521125212252132521425215252162521725218252192522025221252222522325224252252522625227252282522925230252312523225233252342523525236252372523825239252402524125242252432524425245252462524725248252492525025251252522525325254252552525625257252582525925260252612526225263252642526525266252672526825269252702527125272252732527425275252762527725278252792528025281252822528325284252852528625287252882528925290252912529225293252942529525296252972529825299253002530125302253032530425305253062530725308253092531025311253122531325314253152531625317253182531925320253212532225323253242532525326253272532825329253302533125332253332533425335253362533725338253392534025341253422534325344253452534625347253482534925350253512535225353253542535525356253572535825359253602536125362253632536425365253662536725368253692537025371253722537325374253752537625377253782537925380253812538225383253842538525386253872538825389253902539125392253932539425395253962539725398253992540025401254022540325404254052540625407254082540925410254112541225413254142541525416254172541825419254202542125422254232542425425254262542725428254292543025431254322543325434254352543625437254382543925440254412544225443254442544525446254472544825449254502545125452254532545425455254562545725458254592546025461254622546325464254652546625467254682546925470254712547225473254742547525476254772547825479254802548125482254832548425485254862548725488254892549025491254922549325494254952549625497254982549925500255012550225503255042550525506255072550825509255102551125512255132551425515255162551725518255192552025521255222552325524255252552625527255282552925530255312553225533255342553525536255372553825539255402554125542255432554425545255462554725548255492555025551255522555325554255552555625557255582555925560255612556225563255642556525566255672556825569255702557125572255732557425575255762557725578255792558025581255822558325584255852558625587255882558925590255912559225593255942559525596255972559825599256002560125602256032560425605256062560725608256092561025611256122561325614256152561625617256182561925620256212562225623256242562525626256272562825629256302563125632256332563425635256362563725638256392564025641256422564325644256452564625647256482564925650256512565225653256542565525656256572565825659256602566125662256632566425665256662566725668256692567025671256722567325674256752567625677256782567925680256812568225683256842568525686256872568825689256902569125692256932569425695256962569725698256992570025701257022570325704257052570625707257082570925710257112571225713257142571525716257172571825719257202572125722257232572425725257262572725728257292573025731257322573325734257352573625737257382573925740257412574225743257442574525746257472574825749257502575125752257532575425755257562575725758257592576025761257622576325764257652576625767257682576925770257712577225773257742577525776257772577825779257802578125782257832578425785257862578725788257892579025791257922579325794257952579625797257982579925800258012580225803258042580525806258072580825809258102581125812258132581425815258162581725818258192582025821258222582325824258252582625827258282582925830258312583225833258342583525836258372583825839258402584125842258432584425845258462584725848258492585025851258522585325854258552585625857258582585925860258612586225863258642586525866258672586825869258702587125872258732587425875258762587725878258792588025881258822588325884258852588625887258882588925890258912589225893258942589525896258972589825899259002590125902259032590425905259062590725908259092591025911259122591325914259152591625917259182591925920259212592225923259242592525926259272592825929259302593125932259332593425935259362593725938259392594025941259422594325944259452594625947259482594925950259512595225953259542595525956259572595825959259602596125962259632596425965259662596725968259692597025971259722597325974259752597625977259782597925980259812598225983259842598525986259872598825989259902599125992259932599425995259962599725998259992600026001260022600326004260052600626007260082600926010260112601226013260142601526016260172601826019260202602126022260232602426025260262602726028260292603026031260322603326034260352603626037260382603926040260412604226043260442604526046260472604826049260502605126052260532605426055260562605726058260592606026061260622606326064260652606626067260682606926070260712607226073260742607526076260772607826079260802608126082260832608426085260862608726088260892609026091260922609326094260952609626097260982609926100261012610226103261042610526106261072610826109261102611126112261132611426115261162611726118261192612026121261222612326124261252612626127261282612926130261312613226133261342613526136261372613826139261402614126142261432614426145261462614726148261492615026151261522615326154261552615626157261582615926160261612616226163261642616526166261672616826169261702617126172261732617426175261762617726178261792618026181261822618326184261852618626187261882618926190261912619226193261942619526196261972619826199262002620126202262032620426205262062620726208262092621026211262122621326214262152621626217262182621926220262212622226223262242622526226262272622826229262302623126232262332623426235262362623726238262392624026241262422624326244262452624626247262482624926250262512625226253262542625526256262572625826259262602626126262262632626426265262662626726268262692627026271262722627326274262752627626277262782627926280262812628226283262842628526286262872628826289262902629126292262932629426295262962629726298262992630026301263022630326304263052630626307263082630926310263112631226313263142631526316263172631826319263202632126322263232632426325263262632726328263292633026331263322633326334263352633626337263382633926340263412634226343263442634526346263472634826349263502635126352263532635426355263562635726358263592636026361263622636326364263652636626367263682636926370263712637226373263742637526376263772637826379263802638126382263832638426385263862638726388263892639026391263922639326394263952639626397263982639926400264012640226403264042640526406264072640826409264102641126412264132641426415264162641726418264192642026421264222642326424264252642626427264282642926430264312643226433264342643526436264372643826439264402644126442264432644426445264462644726448264492645026451264522645326454264552645626457264582645926460264612646226463264642646526466264672646826469264702647126472264732647426475264762647726478264792648026481264822648326484264852648626487264882648926490264912649226493264942649526496264972649826499265002650126502265032650426505265062650726508265092651026511265122651326514265152651626517265182651926520265212652226523265242652526526265272652826529265302653126532265332653426535265362653726538265392654026541265422654326544265452654626547265482654926550265512655226553265542655526556265572655826559265602656126562265632656426565265662656726568265692657026571265722657326574265752657626577265782657926580265812658226583265842658526586265872658826589265902659126592265932659426595265962659726598265992660026601266022660326604266052660626607266082660926610266112661226613266142661526616266172661826619266202662126622266232662426625266262662726628266292663026631266322663326634266352663626637266382663926640266412664226643266442664526646266472664826649266502665126652266532665426655266562665726658266592666026661266622666326664266652666626667266682666926670266712667226673266742667526676266772667826679266802668126682266832668426685266862668726688266892669026691266922669326694266952669626697266982669926700267012670226703267042670526706267072670826709267102671126712267132671426715267162671726718267192672026721267222672326724267252672626727267282672926730267312673226733267342673526736267372673826739267402674126742267432674426745267462674726748267492675026751267522675326754267552675626757267582675926760267612676226763267642676526766267672676826769267702677126772267732677426775267762677726778267792678026781267822678326784267852678626787267882678926790267912679226793267942679526796267972679826799268002680126802268032680426805268062680726808268092681026811268122681326814268152681626817268182681926820268212682226823268242682526826268272682826829268302683126832268332683426835268362683726838268392684026841268422684326844268452684626847268482684926850268512685226853268542685526856268572685826859268602686126862268632686426865268662686726868268692687026871268722687326874268752687626877268782687926880268812688226883268842688526886268872688826889268902689126892268932689426895268962689726898268992690026901269022690326904269052690626907269082690926910269112691226913269142691526916269172691826919269202692126922269232692426925269262692726928269292693026931269322693326934269352693626937269382693926940269412694226943269442694526946269472694826949269502695126952269532695426955269562695726958269592696026961269622696326964269652696626967269682696926970269712697226973269742697526976269772697826979269802698126982269832698426985269862698726988269892699026991269922699326994269952699626997269982699927000270012700227003270042700527006270072700827009270102701127012270132701427015270162701727018270192702027021270222702327024270252702627027270282702927030270312703227033270342703527036270372703827039270402704127042270432704427045270462704727048270492705027051270522705327054270552705627057270582705927060270612706227063270642706527066270672706827069270702707127072270732707427075270762707727078270792708027081270822708327084270852708627087270882708927090270912709227093270942709527096270972709827099271002710127102271032710427105271062710727108271092711027111271122711327114271152711627117271182711927120271212712227123271242712527126271272712827129271302713127132271332713427135271362713727138271392714027141271422714327144271452714627147271482714927150271512715227153271542715527156271572715827159271602716127162271632716427165271662716727168271692717027171271722717327174271752717627177271782717927180271812718227183271842718527186271872718827189271902719127192271932719427195271962719727198271992720027201272022720327204272052720627207272082720927210272112721227213272142721527216272172721827219272202722127222272232722427225272262722727228272292723027231272322723327234272352723627237272382723927240272412724227243272442724527246272472724827249272502725127252272532725427255272562725727258272592726027261272622726327264272652726627267272682726927270272712727227273272742727527276272772727827279272802728127282272832728427285272862728727288272892729027291272922729327294272952729627297272982729927300273012730227303273042730527306273072730827309273102731127312273132731427315273162731727318273192732027321273222732327324273252732627327273282732927330273312733227333273342733527336273372733827339273402734127342273432734427345273462734727348273492735027351273522735327354273552735627357273582735927360273612736227363273642736527366273672736827369273702737127372273732737427375273762737727378273792738027381273822738327384273852738627387273882738927390273912739227393273942739527396273972739827399274002740127402274032740427405274062740727408274092741027411274122741327414274152741627417274182741927420274212742227423274242742527426274272742827429274302743127432274332743427435274362743727438274392744027441274422744327444274452744627447
  1. // NOTE: This file should be saved as UTF-8 w/ BOM
  2. #include <httplib.h>
  3. #include <signal.h>
  4. #ifndef _WIN32
  5. #include <arpa/inet.h>
  6. #include <ctime>
  7. #include <curl/curl.h>
  8. #include <netinet/in.h>
  9. #include <sys/socket.h>
  10. #include <sys/time.h>
  11. #include <unistd.h>
  12. #endif
  13. #include <gtest/gtest.h>
  14. #include <algorithm>
  15. #include <atomic>
  16. #include <cctype>
  17. #include <chrono>
  18. #include <clocale>
  19. #include <cstdio>
  20. #include <fstream>
  21. #include <future>
  22. #include <limits>
  23. #include <memory>
  24. #include <sstream>
  25. #include <stdexcept>
  26. #include <thread>
  27. #include <type_traits>
  28. #include <vector>
  29. #if __cplusplus >= 202002L
  30. inline std::string u8_to_string(const char8_t *s) {
  31. return std::string(reinterpret_cast<const char *>(s));
  32. }
  33. #define U8(x) u8_to_string(u8##x)
  34. #else
  35. #define U8(x) u8##x
  36. #endif
  37. #define SERVER_CERT_FILE "./cert.pem"
  38. #define SERVER_CERT2_FILE "./cert2.pem"
  39. #define SERVER_CERT_IP_CN_FILE "./cert_ip_cn.pem"
  40. #define SERVER_CERT_IPV6_FILE "./cert_ipv6.pem"
  41. #define SERVER_CERT_SAN_TYPES_FILE "./cert_san_types.pem"
  42. #define SERVER_CERT_WILDCARD_SAN_FILE "./cert_wildcard_san.pem"
  43. #define SERVER_PRIVATE_KEY_FILE "./key.pem"
  44. #define CA_CERT_FILE "./ca-bundle.crt"
  45. #define CLIENT_CA_CERT_FILE "./rootCA.cert.pem"
  46. #define CLIENT_CA_CERT_DIR "."
  47. #define CLIENT_CERT_FILE "./client.cert.pem"
  48. #define CLIENT_PRIVATE_KEY_FILE "./client.key.pem"
  49. #define CLIENT_ENCRYPTED_CERT_FILE "./client_encrypted.cert.pem"
  50. // Mbed TLS < 3.6 (e.g. Ubuntu's 2.28) has no PBES2-AES and needs the PBES1-3DES
  51. // key; 3.6+/4.x (4.x dropped DES) and OpenSSL/wolfSSL use the PBES2 AES key.
  52. #if defined(CPPHTTPLIB_MBEDTLS_SUPPORT) && (MBEDTLS_VERSION_NUMBER < 0x03060000)
  53. #define CLIENT_ENCRYPTED_PRIVATE_KEY_FILE "./client_encrypted_pbes1.key.pem"
  54. #else
  55. #define CLIENT_ENCRYPTED_PRIVATE_KEY_FILE "./client_encrypted.key.pem"
  56. #endif
  57. #define CLIENT_ENCRYPTED_PRIVATE_KEY_PASS "test012!"
  58. #define SERVER_ENCRYPTED_CERT_FILE "./cert_encrypted.pem"
  59. #define SERVER_ENCRYPTED_PRIVATE_KEY_FILE "./key_encrypted.pem"
  60. #define SERVER_ENCRYPTED_PRIVATE_KEY_PASS "test123!"
  61. #ifdef CPPHTTPLIB_SSL_ENABLED
  62. namespace httplib {
  63. namespace tls {
  64. // Declared here for the split build, where the TLS abstraction declarations
  65. // live below the split border; the definition is linked from httplib.cc.
  66. ca_store_t create_ca_store(const char *pem, size_t len);
  67. } // namespace tls
  68. } // namespace httplib
  69. #endif
  70. using namespace std;
  71. using namespace httplib;
  72. const char *HOST = "localhost";
  73. static int get_base_port() {
  74. const char *shard = getenv("GTEST_SHARD_INDEX");
  75. return shard ? 11234 + std::atoi(shard) * 100 : 1234;
  76. }
  77. // NOTE: PORT is only for legacy fixtures (ServerTest, etc.).
  78. // New standalone tests MUST use svr.bind_to_any_port() instead.
  79. const int PORT = get_base_port();
  80. const string LONG_QUERY_VALUE = string(25000, '@');
  81. const string LONG_QUERY_URL = "/long-query-value?key=" + LONG_QUERY_VALUE;
  82. const string TOO_LONG_QUERY_VALUE = string(35000, '@');
  83. const string TOO_LONG_QUERY_URL =
  84. "/too-long-query-value?key=" + TOO_LONG_QUERY_VALUE;
  85. const std::string JSON_DATA = "{\"hello\":\"world\"}";
  86. const string LARGE_DATA = string(1024 * 1024 * 100, '@'); // 100MB
  87. FormData &get_file_value(std::vector<FormData> &items, const char *key) {
  88. auto it = std::find_if(items.begin(), items.end(), [&](const FormData &file) {
  89. return file.name == key;
  90. });
  91. #ifdef CPPHTTPLIB_NO_EXCEPTIONS
  92. return *it;
  93. #else
  94. if (it != items.end()) { return *it; }
  95. throw std::runtime_error("invalid multipart form data name error");
  96. #endif
  97. }
  98. static void read_file(const std::string &path, std::string &out) {
  99. std::ifstream fs(path, std::ios_base::binary);
  100. if (!fs) {
  101. #ifdef CPPHTTPLIB_NO_EXCEPTIONS
  102. return;
  103. #else
  104. throw std::runtime_error("File not found: " + path);
  105. #endif
  106. }
  107. fs.seekg(0, std::ios_base::end);
  108. auto size = fs.tellg();
  109. fs.seekg(0);
  110. out.resize(static_cast<size_t>(size));
  111. fs.read(&out[0], static_cast<std::streamsize>(size));
  112. }
  113. class UnixSocketTest : public ::testing::Test {
  114. protected:
  115. void TearDown() override { std::remove(pathname_.c_str()); }
  116. void client_GET(const std::string &addr) {
  117. httplib::Client cli{addr};
  118. cli.set_address_family(AF_UNIX);
  119. ASSERT_TRUE(cli.is_valid());
  120. const auto &result = cli.Get(pattern_);
  121. ASSERT_TRUE(result) << "error: " << result.error();
  122. const auto &resp = result.value();
  123. EXPECT_EQ(resp.status, StatusCode::OK_200);
  124. EXPECT_EQ(resp.body, content_);
  125. }
  126. static std::string make_sock_path() {
  127. const char *shard = getenv("GTEST_SHARD_INDEX");
  128. return shard ? std::string("./httplib-server-") + shard + ".sock"
  129. : "./httplib-server.sock";
  130. }
  131. const std::string pathname_{make_sock_path()};
  132. const std::string pattern_{"/hi"};
  133. const std::string content_{"Hello World!"};
  134. };
  135. TEST_F(UnixSocketTest, pathname) {
  136. httplib::Server svr;
  137. svr.Get(pattern_, [&](const httplib::Request &, httplib::Response &res) {
  138. res.set_content(content_, "text/plain");
  139. });
  140. std::thread t{[&] {
  141. ASSERT_TRUE(svr.set_address_family(AF_UNIX).listen(pathname_, 80));
  142. }};
  143. auto se = detail::scope_exit([&] {
  144. svr.stop();
  145. t.join();
  146. ASSERT_FALSE(svr.is_running());
  147. });
  148. svr.wait_until_ready();
  149. ASSERT_TRUE(svr.is_running());
  150. client_GET(pathname_);
  151. }
  152. #if defined(__linux__) || \
  153. /* __APPLE__ */ (defined(SOL_LOCAL) && defined(SO_PEERPID))
  154. TEST_F(UnixSocketTest, PeerPid) {
  155. httplib::Server svr;
  156. std::string remote_port_val;
  157. svr.Get(pattern_, [&](const httplib::Request &req, httplib::Response &res) {
  158. res.set_content(content_, "text/plain");
  159. remote_port_val = std::to_string(req.remote_port);
  160. });
  161. std::thread t{[&] {
  162. ASSERT_TRUE(svr.set_address_family(AF_UNIX).listen(pathname_, 80));
  163. }};
  164. auto se = detail::scope_exit([&] {
  165. svr.stop();
  166. t.join();
  167. ASSERT_FALSE(svr.is_running());
  168. });
  169. svr.wait_until_ready();
  170. ASSERT_TRUE(svr.is_running());
  171. client_GET(pathname_);
  172. EXPECT_EQ(std::to_string(getpid()), remote_port_val);
  173. }
  174. #endif
  175. #ifdef __linux__
  176. TEST_F(UnixSocketTest, abstract) {
  177. constexpr char svr_path[]{"\x00httplib-server.sock"};
  178. const std::string abstract_addr{svr_path, sizeof(svr_path) - 1};
  179. httplib::Server svr;
  180. svr.Get(pattern_, [&](const httplib::Request &, httplib::Response &res) {
  181. res.set_content(content_, "text/plain");
  182. });
  183. std::thread t{[&] {
  184. ASSERT_TRUE(svr.set_address_family(AF_UNIX).listen(abstract_addr, 80));
  185. }};
  186. auto se = detail::scope_exit([&] {
  187. svr.stop();
  188. t.join();
  189. ASSERT_FALSE(svr.is_running());
  190. });
  191. svr.wait_until_ready();
  192. ASSERT_TRUE(svr.is_running());
  193. client_GET(abstract_addr);
  194. }
  195. #endif
  196. TEST_F(UnixSocketTest, HostHeaderAutoSet) {
  197. httplib::Server svr;
  198. std::string received_host_header;
  199. svr.Get(pattern_, [&](const httplib::Request &req, httplib::Response &res) {
  200. // Capture the Host header sent by the client
  201. auto host_iter = req.headers.find("Host");
  202. if (host_iter != req.headers.end()) {
  203. received_host_header = host_iter->second;
  204. }
  205. res.set_content(content_, "text/plain");
  206. });
  207. std::thread t{[&] {
  208. ASSERT_TRUE(svr.set_address_family(AF_UNIX).listen(pathname_, 80));
  209. }};
  210. auto se = detail::scope_exit([&] {
  211. svr.stop();
  212. t.join();
  213. ASSERT_FALSE(svr.is_running());
  214. });
  215. svr.wait_until_ready();
  216. ASSERT_TRUE(svr.is_running());
  217. // Test that Host header is automatically set to "localhost" for Unix socket
  218. // connections
  219. httplib::Client cli{pathname_};
  220. cli.set_address_family(AF_UNIX);
  221. ASSERT_TRUE(cli.is_valid());
  222. const auto &result = cli.Get(pattern_);
  223. ASSERT_TRUE(result) << "error: " << result.error();
  224. const auto &resp = result.value();
  225. EXPECT_EQ(resp.status, StatusCode::OK_200);
  226. EXPECT_EQ(resp.body, content_);
  227. // Verify that Host header was automatically set to "localhost"
  228. EXPECT_EQ(received_host_header, "localhost");
  229. }
  230. #ifndef _WIN32
  231. TEST(SocketStream, wait_writable_UNIX) {
  232. int fds[2];
  233. ASSERT_EQ(0, socketpair(AF_UNIX, SOCK_STREAM, 0, fds));
  234. const auto asSocketStream = [&](socket_t fd,
  235. std::function<bool(Stream &)> func) {
  236. return detail::process_client_socket(
  237. fd, 0, 0, 0, 0, 0, std::chrono::steady_clock::time_point::min(), func);
  238. };
  239. asSocketStream(fds[0], [&](Stream &s0) {
  240. EXPECT_EQ(s0.socket(), fds[0]);
  241. EXPECT_TRUE(s0.wait_writable());
  242. EXPECT_TRUE(s0.is_peer_alive());
  243. EXPECT_EQ(0, close(fds[1]));
  244. EXPECT_FALSE(s0.is_peer_alive());
  245. return true;
  246. });
  247. EXPECT_EQ(0, close(fds[0]));
  248. }
  249. TEST(SocketStream, wait_writable_INET) {
  250. sockaddr_in addr;
  251. memset(&addr, 0, sizeof(addr));
  252. addr.sin_family = AF_INET;
  253. addr.sin_port = htons(static_cast<uint16_t>(PORT + 1));
  254. addr.sin_addr.s_addr = htonl(INADDR_LOOPBACK);
  255. int disconnected_svr_sock = -1;
  256. std::thread svr{[&] {
  257. const int s = socket(AF_INET, SOCK_STREAM, 0);
  258. ASSERT_LE(0, s);
  259. // PORT + 1 is shared with the SSL redirect tests and with
  260. // VulnerabilityTest.CRLFInjectionInHeaders, all of which set this. Without
  261. // it, a TIME_WAIT one of them left behind makes bind() fail here, and
  262. // because that happens on a worker thread the ASSERT does not stop the
  263. // test: it runs on and fails at the disconnected_svr_sock check instead.
  264. default_socket_options(s);
  265. ASSERT_EQ(0, ::bind(s, reinterpret_cast<sockaddr *>(&addr), sizeof(addr)));
  266. ASSERT_EQ(0, listen(s, 1));
  267. ASSERT_LE(0, disconnected_svr_sock = accept(s, nullptr, nullptr));
  268. ASSERT_EQ(0, close(s));
  269. }};
  270. std::this_thread::sleep_for(std::chrono::milliseconds(100));
  271. std::thread cli{[&] {
  272. const int s = socket(AF_INET, SOCK_STREAM, 0);
  273. ASSERT_LE(0, s);
  274. ASSERT_EQ(0, connect(s, reinterpret_cast<sockaddr *>(&addr), sizeof(addr)));
  275. ASSERT_EQ(0, close(s));
  276. }};
  277. cli.join();
  278. svr.join();
  279. ASSERT_NE(disconnected_svr_sock, -1);
  280. const auto asSocketStream = [&](socket_t fd,
  281. std::function<bool(Stream &)> func) {
  282. return detail::process_client_socket(
  283. fd, 0, 0, 0, 0, 0, std::chrono::steady_clock::time_point::min(), func);
  284. };
  285. asSocketStream(disconnected_svr_sock, [&](Stream &ss) {
  286. EXPECT_EQ(ss.socket(), disconnected_svr_sock);
  287. // wait_writable() returns true because select_write() only checks if the
  288. // send buffer has space. Peer disconnection is detected later by send().
  289. EXPECT_TRUE(ss.wait_writable());
  290. return true;
  291. });
  292. ASSERT_EQ(0, close(disconnected_svr_sock));
  293. }
  294. #endif // #ifndef _WIN32
  295. TEST(SetSocketOptTest, TcpNoDelay) {
  296. auto sock = ::socket(AF_INET, SOCK_STREAM, 0);
  297. ASSERT_NE(sock, INVALID_SOCKET);
  298. EXPECT_TRUE(set_socket_opt(sock, IPPROTO_TCP, TCP_NODELAY, 1));
  299. int val = 0;
  300. socklen_t len = sizeof(val);
  301. ASSERT_EQ(0, ::getsockopt(sock, IPPROTO_TCP, TCP_NODELAY,
  302. reinterpret_cast<char *>(&val), &len));
  303. EXPECT_NE(val, 0);
  304. detail::close_socket(sock);
  305. }
  306. TEST(AcceptErrorTest, RetryableFailuresAreClassifiedPerPlatform) {
  307. // accept() reports failures through WSAGetLastError() on Windows and through
  308. // errno everywhere else. Asking the wrong one is what made the accept loop
  309. // treat every recoverable failure as fatal on Windows.
  310. struct Classification {
  311. bool resource;
  312. bool transient;
  313. };
  314. auto classify = [](int err) {
  315. #ifdef _WIN32
  316. WSASetLastError(err);
  317. #else
  318. errno = err;
  319. #endif
  320. // Read both before asserting: an assertion may clobber the error slot.
  321. Classification c;
  322. c.resource = detail::is_accept_resource_error();
  323. c.transient = detail::is_accept_transient_error();
  324. return c;
  325. };
  326. #ifdef _WIN32
  327. const std::vector<int> resource_errors = {WSAEMFILE, WSAENOBUFS};
  328. const std::vector<int> transient_errors = {WSAEINTR, WSAEWOULDBLOCK,
  329. WSAECONNRESET, WSAECONNABORTED};
  330. const std::vector<int> fatal_errors = {WSAENOTSOCK, WSAEINVAL, WSAEOPNOTSUPP};
  331. #else
  332. const std::vector<int> resource_errors = {EMFILE, ENFILE, ENOBUFS, ENOMEM};
  333. const std::vector<int> transient_errors = {EINTR, EAGAIN, EWOULDBLOCK,
  334. ECONNABORTED};
  335. const std::vector<int> fatal_errors = {EBADF, EINVAL, ENOTSOCK};
  336. #endif
  337. for (auto err : resource_errors) {
  338. const auto c = classify(err);
  339. EXPECT_TRUE(c.resource) << "error " << err;
  340. EXPECT_FALSE(c.transient) << "error " << err;
  341. }
  342. for (auto err : transient_errors) {
  343. const auto c = classify(err);
  344. EXPECT_TRUE(c.transient) << "error " << err;
  345. EXPECT_FALSE(c.resource) << "error " << err;
  346. }
  347. for (auto err : fatal_errors) {
  348. const auto c = classify(err);
  349. EXPECT_FALSE(c.resource) << "error " << err;
  350. EXPECT_FALSE(c.transient) << "error " << err;
  351. }
  352. #ifdef _WIN32
  353. WSASetLastError(0);
  354. #else
  355. errno = 0;
  356. #endif
  357. }
  358. TEST(ClientTest, MoveConstructible) {
  359. EXPECT_FALSE(std::is_copy_constructible<Client>::value);
  360. EXPECT_TRUE(std::is_nothrow_move_constructible<Client>::value);
  361. }
  362. TEST(ClientTest, MoveAssignable) {
  363. EXPECT_FALSE(std::is_copy_assignable<Client>::value);
  364. EXPECT_TRUE(std::is_nothrow_move_assignable<Client>::value);
  365. }
  366. #ifdef _WIN32
  367. TEST(StartupTest, WSAStartup) {
  368. WSADATA wsaData;
  369. int ret = WSAStartup(0x0002, &wsaData);
  370. ASSERT_EQ(0, ret);
  371. }
  372. #endif
  373. TEST(DecodePathTest, PercentCharacter) {
  374. EXPECT_EQ(
  375. decode_path_component(
  376. R"(descrip=Gastos%20%C3%A1%C3%A9%C3%AD%C3%B3%C3%BA%C3%B1%C3%91%206)"),
  377. U8("descrip=Gastos áéíóúñÑ 6"));
  378. }
  379. TEST(DecodePathTest, PercentCharacterNUL) {
  380. string expected;
  381. expected.push_back('x');
  382. expected.push_back('\0');
  383. expected.push_back('x');
  384. EXPECT_EQ(decode_path_component("x%00x"), expected);
  385. }
  386. TEST(DecodePathTest, UnicodeEncoding) {
  387. // %u0041 = 'A' (1-byte UTF-8)
  388. EXPECT_EQ("A", decode_path_component("%u0041"));
  389. // %u00E9 = 'é' (2-byte UTF-8)
  390. EXPECT_EQ(U8("é"), decode_path_component("%u00E9"));
  391. // %u3042 = 'あ' (3-byte UTF-8)
  392. EXPECT_EQ(U8("あ"), decode_path_component("%u3042"));
  393. // %uFFFF = max 4-digit hex (3-byte UTF-8, must not overflow buff[4])
  394. EXPECT_FALSE(decode_path_component("%uFFFF").empty());
  395. // %uD800 = surrogate (invalid, silently dropped)
  396. EXPECT_EQ("", decode_path_component("%uD800"));
  397. }
  398. TEST(DecodeQueryTest, RejectsNonHexEscapes) {
  399. // A sign or whitespace inside the two-character escape window must not be
  400. // accepted as a valid percent-encoding; the sequence is passed through
  401. // literally, matching decode_uri_component / decode_path_component.
  402. EXPECT_EQ("%-1", decode_query_component("%-1", false));
  403. EXPECT_EQ("%-0", decode_query_component("%-0", false));
  404. EXPECT_EQ("%+5", decode_query_component("%+5", false));
  405. EXPECT_EQ("% 5", decode_query_component("% 5", false));
  406. // Well-formed escapes still decode.
  407. EXPECT_EQ("-", decode_query_component("%2D", false));
  408. EXPECT_EQ("A", decode_query_component("%41", false));
  409. }
  410. TEST(SanitizeFilenameTest, VariousPatterns) {
  411. // Path traversal
  412. EXPECT_EQ("passwd", httplib::sanitize_filename("../../../etc/passwd"));
  413. EXPECT_EQ("passwd", httplib::sanitize_filename("..\\..\\etc\\passwd"));
  414. EXPECT_EQ("file.txt", httplib::sanitize_filename("path/to\\..\\file.txt"));
  415. // Normal and edge cases
  416. EXPECT_EQ("photo.jpg", httplib::sanitize_filename("photo.jpg"));
  417. EXPECT_EQ("filename.txt",
  418. httplib::sanitize_filename("/path/to/filename.txt"));
  419. EXPECT_EQ(".gitignore", httplib::sanitize_filename(".gitignore"));
  420. EXPECT_EQ("", httplib::sanitize_filename(".."));
  421. EXPECT_EQ("", httplib::sanitize_filename(""));
  422. // Null bytes stripped
  423. EXPECT_EQ("safe.txt",
  424. httplib::sanitize_filename(std::string("safe\0.txt", 9)));
  425. // Whitespace-only rejected
  426. EXPECT_EQ("", httplib::sanitize_filename(" "));
  427. }
  428. // Forward declaration (see the base64_encode note below): split builds move the
  429. // definition into httplib.cc, so re-declaring it here lets the test link.
  430. namespace httplib {
  431. namespace detail {
  432. bool is_chunked_transfer_encoding(const Headers &headers);
  433. } // namespace detail
  434. } // namespace httplib
  435. TEST(ChunkedTransferEncodingTest, DetectsChunkedAsFinalCoding) {
  436. // Build a Headers with the given Transfer-Encoding lines (nullptr = none).
  437. auto make = [](std::initializer_list<const char *> lines) {
  438. Headers h;
  439. for (auto te : lines) {
  440. if (te) { h.emplace("Transfer-Encoding", te); }
  441. }
  442. return h;
  443. };
  444. // Sole coding, matched case-insensitively.
  445. EXPECT_TRUE(detail::is_chunked_transfer_encoding(make({"chunked"})));
  446. EXPECT_TRUE(detail::is_chunked_transfer_encoding(make({"Chunked"})));
  447. EXPECT_TRUE(detail::is_chunked_transfer_encoding(make({"CHUNKED"})));
  448. // RFC 9112 6.1: chunked as the final coding of a list still frames the body.
  449. EXPECT_TRUE(detail::is_chunked_transfer_encoding(make({"gzip, chunked"})));
  450. EXPECT_TRUE(detail::is_chunked_transfer_encoding(make({"gzip,chunked"})));
  451. EXPECT_TRUE(detail::is_chunked_transfer_encoding(make({"gzip, Chunked "})));
  452. // Single line: chunked absent, or not the final coding -> not chunk-framed.
  453. EXPECT_FALSE(detail::is_chunked_transfer_encoding(make({"gzip"})));
  454. EXPECT_FALSE(detail::is_chunked_transfer_encoding(make({"chunked, gzip"})));
  455. EXPECT_FALSE(detail::is_chunked_transfer_encoding(make({""})));
  456. EXPECT_FALSE(detail::is_chunked_transfer_encoding(make({nullptr})));
  457. // RFC 9110 5.3: multiple Transfer-Encoding lines combine, in the order they
  458. // were received, into one list. Headers preserves that order, so the answer
  459. // is decided by the last coding of the last line and the order the lines
  460. // arrived in is significant.
  461. EXPECT_TRUE(detail::is_chunked_transfer_encoding(make({"gzip", "chunked"})));
  462. EXPECT_FALSE(detail::is_chunked_transfer_encoding(make({"chunked", "gzip"})));
  463. EXPECT_FALSE(detail::is_chunked_transfer_encoding(make({"gzip", "deflate"})));
  464. // The split can fall anywhere in the list.
  465. EXPECT_TRUE(
  466. detail::is_chunked_transfer_encoding(make({"deflate", "gzip, chunked"})));
  467. EXPECT_FALSE(
  468. detail::is_chunked_transfer_encoding(make({"gzip, chunked", "deflate"})));
  469. // A trailing line naming no coding leaves the list ending in nothing, so it
  470. // must not inherit the chunked from the line before it.
  471. EXPECT_FALSE(detail::is_chunked_transfer_encoding(make({"chunked", ""})));
  472. }
  473. // Forward declaration: in split builds split.py strips `inline` and moves the
  474. // definition into httplib.cc, so detail::base64_encode is not visible from the
  475. // public httplib.h. Re-declaring it here lets the tests link against the symbol
  476. // in both header-only and split builds.
  477. namespace httplib {
  478. namespace detail {
  479. std::string base64_encode(const std::string &in);
  480. } // namespace detail
  481. } // namespace httplib
  482. TEST(Base64EncodeTest, KnownAnswers) {
  483. // RFC 4648 test vectors. Inputs of four bytes or more exercise the round
  484. // where the accumulator's top bit is already set before the next shift.
  485. EXPECT_EQ("", detail::base64_encode(""));
  486. EXPECT_EQ("Zg==", detail::base64_encode("f"));
  487. EXPECT_EQ("Zm8=", detail::base64_encode("fo"));
  488. EXPECT_EQ("Zm9v", detail::base64_encode("foo"));
  489. EXPECT_EQ("Zm9vYg==", detail::base64_encode("foob"));
  490. EXPECT_EQ("Zm9vYmE=", detail::base64_encode("fooba"));
  491. EXPECT_EQ("Zm9vYmFy", detail::base64_encode("foobar"));
  492. // High bytes keep the top bit set across several rounds.
  493. EXPECT_EQ("AAECA//+wIB/", detail::base64_encode(std::string(
  494. "\x00\x01\x02\x03\xff\xfe\xc0\x80\x7f", 9)));
  495. }
  496. TEST(EncodeQueryParamTest, ParseUnescapedChararactersTest) {
  497. string unescapedCharacters = "-_.!~*'()";
  498. EXPECT_EQ(httplib::encode_uri_component(unescapedCharacters), "-_.!~*'()");
  499. }
  500. TEST(EncodeQueryParamTest, ParseReservedCharactersTest) {
  501. string reservedCharacters = ";,/?:@&=+$";
  502. EXPECT_EQ(httplib::encode_uri_component(reservedCharacters),
  503. "%3B%2C%2F%3F%3A%40%26%3D%2B%24");
  504. }
  505. TEST(ClientQueryOrder, PreserveOrder) {
  506. // This test reproduces Issue #2259: client may reorder query parameters
  507. // when sending a GET request. The expected behavior is that the client
  508. // preserves the original query string order when the caller supplied it
  509. // as part of the path.
  510. Server svr;
  511. svr.Get("/", [&](const Request &req, Response &res) {
  512. // Echo back the raw target so the test can assert ordering
  513. res.set_content(req.target, "text/plain");
  514. });
  515. std::thread t{[&] { svr.listen(HOST, PORT); }};
  516. auto se = detail::scope_exit([&] {
  517. svr.stop();
  518. t.join();
  519. ASSERT_FALSE(svr.is_running());
  520. });
  521. svr.wait_until_ready();
  522. Client cli(HOST, PORT);
  523. ASSERT_TRUE(cli.is_valid());
  524. const std::string original = "/?z=1&y=2&x=3&c=7&b=8&a=9";
  525. auto res = cli.Get(original);
  526. ASSERT_TRUE(res) << "Error: " << to_string(res.error());
  527. // Expect the echoed target to exactly match the original path (order
  528. // preserved)
  529. EXPECT_EQ(res->body, original);
  530. }
  531. TEST(EncodeQueryParamTest, TestUTF8Characters) {
  532. string chineseCharacters = U8("中国語");
  533. string russianCharacters = U8("дом");
  534. string brazilianCharacters = U8("óculos");
  535. EXPECT_EQ(httplib::encode_uri_component(chineseCharacters),
  536. "%E4%B8%AD%E5%9B%BD%E8%AA%9E");
  537. EXPECT_EQ(httplib::encode_uri_component(russianCharacters),
  538. "%D0%B4%D0%BE%D0%BC");
  539. EXPECT_EQ(httplib::encode_uri_component(brazilianCharacters), "%C3%B3culos");
  540. }
  541. TEST(EncodeUriComponentTest, ParseUnescapedChararactersTest) {
  542. string unescapedCharacters = "-_.!~*'()";
  543. EXPECT_EQ(httplib::encode_uri_component(unescapedCharacters), "-_.!~*'()");
  544. }
  545. TEST(EncodeUriComponentTest, ParseReservedCharactersTest) {
  546. string reservedCharacters = ";,/?:@&=+$";
  547. EXPECT_EQ(httplib::encode_uri_component(reservedCharacters),
  548. "%3B%2C%2F%3F%3A%40%26%3D%2B%24");
  549. }
  550. TEST(EncodeUriComponentTest, TestUTF8Characters) {
  551. string chineseCharacters = U8("中国語");
  552. string russianCharacters = U8("дом");
  553. string brazilianCharacters = U8("óculos");
  554. EXPECT_EQ(httplib::encode_uri_component(chineseCharacters),
  555. "%E4%B8%AD%E5%9B%BD%E8%AA%9E");
  556. EXPECT_EQ(httplib::encode_uri_component(russianCharacters),
  557. "%D0%B4%D0%BE%D0%BC");
  558. EXPECT_EQ(httplib::encode_uri_component(brazilianCharacters), "%C3%B3culos");
  559. }
  560. TEST(EncodeUriComponentTest, TestPathComponentEncoding) {
  561. // Issue #2082 use case: encoding path component with ampersand
  562. string pathWithAmpersand = "Piri Tommy Villiers - on & on";
  563. EXPECT_EQ(httplib::encode_uri_component(pathWithAmpersand),
  564. "Piri%20Tommy%20Villiers%20-%20on%20%26%20on");
  565. }
  566. TEST(EncodeUriTest, ParseUnescapedChararactersTest) {
  567. string unescapedCharacters = "-_.!~*'()";
  568. EXPECT_EQ(httplib::encode_uri(unescapedCharacters), "-_.!~*'()");
  569. }
  570. TEST(EncodeUriTest, ParseReservedCharactersTest) {
  571. string reservedCharacters = ";,/?:@&=+$#";
  572. EXPECT_EQ(httplib::encode_uri(reservedCharacters), ";,/?:@&=+$#");
  573. }
  574. TEST(EncodeUriTest, TestUTF8Characters) {
  575. string chineseCharacters = U8("中国語");
  576. string russianCharacters = U8("дом");
  577. string brazilianCharacters = U8("óculos");
  578. EXPECT_EQ(httplib::encode_uri(chineseCharacters),
  579. "%E4%B8%AD%E5%9B%BD%E8%AA%9E");
  580. EXPECT_EQ(httplib::encode_uri(russianCharacters), "%D0%B4%D0%BE%D0%BC");
  581. EXPECT_EQ(httplib::encode_uri(brazilianCharacters), "%C3%B3culos");
  582. }
  583. TEST(EncodeUriTest, TestCompleteUri) {
  584. string uri =
  585. "https://example.com/path/to/resource?query=value&param=test#fragment";
  586. EXPECT_EQ(
  587. httplib::encode_uri(uri),
  588. "https://example.com/path/to/resource?query=value&param=test#fragment");
  589. }
  590. TEST(EncodeUriTest, TestUriWithSpacesAndSpecialChars) {
  591. string uri =
  592. "https://example.com/path with spaces/file name.html?q=hello world";
  593. EXPECT_EQ(httplib::encode_uri(uri),
  594. "https://example.com/path%20with%20spaces/"
  595. "file%20name.html?q=hello%20world");
  596. }
  597. TEST(DecodeUriComponentTest, ParseEncodedChararactersTest) {
  598. string encodedString = "%3B%2C%2F%3F%3A%40%26%3D%2B%24";
  599. EXPECT_EQ(httplib::decode_uri_component(encodedString), ";,/?:@&=+$");
  600. }
  601. TEST(DecodeUriComponentTest, ParseUnescapedChararactersTest) {
  602. string unescapedCharacters = "-_.!~*'()";
  603. EXPECT_EQ(httplib::decode_uri_component(unescapedCharacters), "-_.!~*'()");
  604. }
  605. TEST(DecodeUriComponentTest, TestUTF8Characters) {
  606. string encodedChinese = "%E4%B8%AD%E5%9B%BD%E8%AA%9E";
  607. string encodedRussian = "%D0%B4%D0%BE%D0%BC";
  608. string encodedBrazilian = "%C3%B3culos";
  609. EXPECT_EQ(httplib::decode_uri_component(encodedChinese), U8("中国語"));
  610. EXPECT_EQ(httplib::decode_uri_component(encodedRussian), U8("дом"));
  611. EXPECT_EQ(httplib::decode_uri_component(encodedBrazilian), U8("óculos"));
  612. }
  613. TEST(DecodeUriComponentTest, TestPathComponentDecoding) {
  614. string encodedPath = "Piri%20Tommy%20Villiers%20-%20on%20%26%20on";
  615. EXPECT_EQ(httplib::decode_uri_component(encodedPath),
  616. "Piri Tommy Villiers - on & on");
  617. }
  618. TEST(DecodeUriTest, ParseEncodedChararactersTest) {
  619. string encodedString = "%20%22%3C%3E%5C%5E%60%7B%7D%7C";
  620. EXPECT_EQ(httplib::decode_uri(encodedString), " \"<>\\^`{}|");
  621. }
  622. TEST(DecodeUriTest, ParseUnescapedChararactersTest) {
  623. string unescapedCharacters = "-_.!~*'();,/?:@&=+$#";
  624. EXPECT_EQ(httplib::decode_uri(unescapedCharacters), "-_.!~*'();,/?:@&=+$#");
  625. }
  626. TEST(DecodeUriTest, TestUTF8Characters) {
  627. string encodedChinese = "%E4%B8%AD%E5%9B%BD%E8%AA%9E";
  628. string encodedRussian = "%D0%B4%D0%BE%D0%BC";
  629. string encodedBrazilian = "%C3%B3culos";
  630. EXPECT_EQ(httplib::decode_uri(encodedChinese), U8("中国語"));
  631. EXPECT_EQ(httplib::decode_uri(encodedRussian), U8("дом"));
  632. EXPECT_EQ(httplib::decode_uri(encodedBrazilian), U8("óculos"));
  633. }
  634. TEST(DecodeUriTest, TestCompleteUri) {
  635. string encodedUri = "https://example.com/path%20with%20spaces/"
  636. "file%20name.html?q=hello%20world";
  637. EXPECT_EQ(
  638. httplib::decode_uri(encodedUri),
  639. "https://example.com/path with spaces/file name.html?q=hello world");
  640. }
  641. TEST(DecodeUriTest, TestRoundTripWithEncodeUri) {
  642. string original =
  643. "https://example.com/path with spaces/file name.html?q=hello world";
  644. string encoded = httplib::encode_uri(original);
  645. string decoded = httplib::decode_uri(encoded);
  646. EXPECT_EQ(decoded, original);
  647. }
  648. TEST(DecodeUriTest, KeepsReservedCharacterEscapes) {
  649. // decode_uri is the inverse of encode_uri: an escaped reserved character
  650. // stays encoded so it is not promoted into a real delimiter, while
  651. // non-reserved escapes still decode (like JS decodeURI).
  652. EXPECT_EQ(httplib::decode_uri("%2F"), "%2F");
  653. EXPECT_EQ(httplib::decode_uri("%23"), "%23");
  654. EXPECT_EQ(httplib::decode_uri("%3F%3A%40%26%3D%2B%24%2C%3B"),
  655. "%3F%3A%40%26%3D%2B%24%2C%3B");
  656. EXPECT_EQ(httplib::decode_uri("%2D"), "-");
  657. EXPECT_EQ(httplib::decode_uri("%20"), " ");
  658. EXPECT_EQ(httplib::decode_uri("http://example.com/a%2Fb"),
  659. "http://example.com/a%2Fb");
  660. // decode_uri_component still decodes the reserved character.
  661. EXPECT_EQ(httplib::decode_uri_component("%2F"), "/");
  662. }
  663. TEST(DecodeUriComponentTest, TestRoundTripWithEncodeUriComponent) {
  664. string original = "Piri Tommy Villiers - on & on";
  665. string encoded = httplib::encode_uri_component(original);
  666. string decoded = httplib::decode_uri_component(encoded);
  667. EXPECT_EQ(decoded, original);
  668. }
  669. TEST(TrimTests, TrimStringTests) {
  670. EXPECT_EQ("abc", detail::trim_copy("abc"));
  671. EXPECT_EQ("abc", detail::trim_copy(" abc "));
  672. EXPECT_TRUE(detail::trim_copy("").empty());
  673. }
  674. TEST(AsciiTest, LocaleIndependentClassification) {
  675. // detail::is_ascii_digit/alpha/alnum replace the <cctype> classifiers,
  676. // which consult the global C locale: std::isalnum(0xC5) can return true
  677. // once an embedder calls setlocale() (observed on macOS). The is_ascii_*
  678. // helpers must classify every byte by the ASCII grammar alone.
  679. for (int i = 0; i < 256; i++) {
  680. auto c = static_cast<char>(i);
  681. auto is_digit = i >= '0' && i <= '9';
  682. auto is_upper = i >= 'A' && i <= 'Z';
  683. auto is_lower = i >= 'a' && i <= 'z';
  684. EXPECT_EQ(is_digit, detail::is_ascii_digit(c)) << "byte " << i;
  685. EXPECT_EQ(is_upper || is_lower, detail::is_ascii_alpha(c)) << "byte " << i;
  686. EXPECT_EQ(is_digit || is_upper || is_lower, detail::is_ascii_alnum(c))
  687. << "byte " << i;
  688. }
  689. // Regression check for the reported byte: 0xC5 is not alphanumeric.
  690. EXPECT_FALSE(detail::is_ascii_alnum(static_cast<char>(0xC5)));
  691. // Non-ASCII bytes must be percent-encoded, never passed through as
  692. // alphanumeric.
  693. EXPECT_EQ("%C5", httplib::encode_uri_component("\xC5"));
  694. }
  695. TEST(FromCharsTest, Double) {
  696. // detail::from_chars(double) recognizes exactly the HTTP quality-value
  697. // grammar (RFC 9110 12.4.2): a non-negative decimal "1*DIGIT [ '.' *DIGIT ]"
  698. // with no sign, exponent, or "inf"/"nan", parsed locale-independently.
  699. auto parse = [](const std::string &s, double &v) {
  700. return detail::from_chars(s.data(), s.data() + s.size(), v);
  701. };
  702. double v = -1.0;
  703. // Representative quality values.
  704. EXPECT_EQ(parse("0", v).ec, std::errc{});
  705. EXPECT_DOUBLE_EQ(v, 0.0);
  706. EXPECT_EQ(parse("1", v).ec, std::errc{});
  707. EXPECT_DOUBLE_EQ(v, 1.0);
  708. EXPECT_EQ(parse("0.8", v).ec, std::errc{});
  709. EXPECT_DOUBLE_EQ(v, 0.8);
  710. EXPECT_EQ(parse("0.001", v).ec, std::errc{});
  711. EXPECT_DOUBLE_EQ(v, 0.001);
  712. EXPECT_EQ(parse("1.000", v).ec, std::errc{});
  713. EXPECT_DOUBLE_EQ(v, 1.0);
  714. // A missing integer or fractional part is tolerated.
  715. EXPECT_EQ(parse(".5", v).ec, std::errc{});
  716. EXPECT_DOUBLE_EQ(v, 0.5);
  717. EXPECT_EQ(parse("5.", v).ec, std::errc{});
  718. EXPECT_DOUBLE_EQ(v, 5.0);
  719. // Values outside [0, 1] still parse; the caller range-checks them.
  720. EXPECT_EQ(parse("123.456", v).ec, std::errc{});
  721. EXPECT_DOUBLE_EQ(v, 123.456);
  722. // Stops at the first byte that is not part of the number and reports where.
  723. std::string trailing = "0.9, text/html";
  724. auto r = parse(trailing, v);
  725. EXPECT_EQ(r.ec, std::errc{});
  726. EXPECT_DOUBLE_EQ(v, 0.9);
  727. EXPECT_EQ(*r.ptr, ',');
  728. // Sign and exponent are NOT part of the grammar: '+'/'-' are rejected
  729. // outright, and an 'e'/'E' simply ends the number.
  730. EXPECT_EQ(parse("-3.25", v).ec, std::errc::invalid_argument);
  731. EXPECT_EQ(parse("+2.5", v).ec, std::errc::invalid_argument);
  732. std::string exp_input = "1.5e3";
  733. r = parse(exp_input, v);
  734. EXPECT_EQ(r.ec, std::errc{});
  735. EXPECT_DOUBLE_EQ(v, 1.5);
  736. EXPECT_EQ(*r.ptr, 'e');
  737. // Invalid inputs.
  738. EXPECT_EQ(parse("", v).ec, std::errc::invalid_argument);
  739. EXPECT_EQ(parse(".", v).ec, std::errc::invalid_argument);
  740. EXPECT_EQ(parse("abc", v).ec, std::errc::invalid_argument);
  741. EXPECT_EQ(parse("nan", v).ec, std::errc::invalid_argument);
  742. EXPECT_EQ(parse("inf", v).ec, std::errc::invalid_argument);
  743. // Pathological but well-formed inputs must stay bounded (no overflow, no
  744. // out-of-bounds table access) and stay within [0, 1] for the caller.
  745. EXPECT_EQ(parse(std::string("0.") + std::string(500, '0'), v).ec,
  746. std::errc{});
  747. EXPECT_DOUBLE_EQ(v, 0.0);
  748. EXPECT_EQ(parse(std::string("0.") + std::string(500, '9'), v).ec,
  749. std::errc{});
  750. EXPECT_GE(v, 0.0);
  751. EXPECT_LE(v, 1.0);
  752. EXPECT_EQ(parse(std::string(500, '9'), v).ec, std::errc{});
  753. EXPECT_GT(v, 1.0); // huge integer: finite, > 1, so the caller rejects it
  754. }
  755. TEST(ParseAcceptHeaderTest, BasicAcceptParsing) {
  756. // Simple case without quality values
  757. std::vector<std::string> result1;
  758. EXPECT_TRUE(detail::parse_accept_header(
  759. "text/html,application/json,text/plain", result1));
  760. EXPECT_EQ(result1.size(), 3U);
  761. EXPECT_EQ(result1[0], "text/html");
  762. EXPECT_EQ(result1[1], "application/json");
  763. EXPECT_EQ(result1[2], "text/plain");
  764. // With quality values
  765. std::vector<std::string> result2;
  766. EXPECT_TRUE(detail::parse_accept_header(
  767. "text/html;q=0.9,application/json;q=1.0,text/plain;q=0.8", result2));
  768. EXPECT_EQ(result2.size(), 3U);
  769. EXPECT_EQ(result2[0], "application/json"); // highest q value
  770. EXPECT_EQ(result2[1], "text/html");
  771. EXPECT_EQ(result2[2], "text/plain"); // lowest q value
  772. }
  773. TEST(ParseAcceptHeaderTest, MixedQualityValues) {
  774. // Mixed with and without quality values
  775. std::vector<std::string> result;
  776. EXPECT_TRUE(detail::parse_accept_header(
  777. "text/html,application/json;q=0.5,text/plain;q=0.8", result));
  778. EXPECT_EQ(result.size(), 3U);
  779. EXPECT_EQ(result[0], "text/html"); // no q value means 1.0
  780. EXPECT_EQ(result[1], "text/plain"); // q=0.8
  781. EXPECT_EQ(result[2], "application/json"); // q=0.5
  782. }
  783. TEST(ParseAcceptHeaderTest, EdgeCases) {
  784. // Empty header
  785. std::vector<std::string> empty_result;
  786. EXPECT_TRUE(detail::parse_accept_header("", empty_result));
  787. EXPECT_TRUE(empty_result.empty());
  788. // Single type
  789. std::vector<std::string> single_result;
  790. EXPECT_TRUE(detail::parse_accept_header("application/json", single_result));
  791. EXPECT_EQ(single_result.size(), 1U);
  792. EXPECT_EQ(single_result[0], "application/json");
  793. // Wildcard types
  794. std::vector<std::string> wildcard_result;
  795. EXPECT_TRUE(detail::parse_accept_header(
  796. "text/*;q=0.5,*/*;q=0.1,application/json", wildcard_result));
  797. EXPECT_EQ(wildcard_result.size(), 3U);
  798. EXPECT_EQ(wildcard_result[0], "application/json");
  799. EXPECT_EQ(wildcard_result[1], "text/*");
  800. EXPECT_EQ(wildcard_result[2], "*/*");
  801. }
  802. TEST(ParseAcceptHeaderTest, RealWorldExamples) {
  803. // Common browser Accept header
  804. std::vector<std::string> browser_result;
  805. EXPECT_TRUE(
  806. detail::parse_accept_header("text/html,application/xhtml+xml,application/"
  807. "xml;q=0.9,image/webp,image/apng,*/*;q=0.8",
  808. browser_result));
  809. EXPECT_EQ(browser_result.size(), 6U);
  810. EXPECT_EQ(browser_result[0], "text/html"); // q=1.0 (default)
  811. EXPECT_EQ(browser_result[1], "application/xhtml+xml"); // q=1.0 (default)
  812. EXPECT_EQ(browser_result[2], "image/webp"); // q=1.0 (default)
  813. EXPECT_EQ(browser_result[3], "image/apng"); // q=1.0 (default)
  814. EXPECT_EQ(browser_result[4], "application/xml"); // q=0.9
  815. EXPECT_EQ(browser_result[5], "*/*"); // q=0.8
  816. // API client header
  817. std::vector<std::string> api_result;
  818. EXPECT_TRUE(detail::parse_accept_header(
  819. "application/json;q=0.9,application/xml;q=0.8,text/plain;q=0.1",
  820. api_result));
  821. EXPECT_EQ(api_result.size(), 3U);
  822. EXPECT_EQ(api_result[0], "application/json");
  823. EXPECT_EQ(api_result[1], "application/xml");
  824. EXPECT_EQ(api_result[2], "text/plain");
  825. }
  826. TEST(ParseAcceptHeaderTest, SpecialCases) {
  827. // Quality value with 3 decimal places
  828. std::vector<std::string> decimal_result;
  829. EXPECT_TRUE(detail::parse_accept_header(
  830. "text/html;q=0.123,application/json;q=0.456", decimal_result));
  831. EXPECT_EQ(decimal_result.size(), 2U);
  832. EXPECT_EQ(decimal_result[0], "application/json"); // Higher q value
  833. EXPECT_EQ(decimal_result[1], "text/html");
  834. // Zero quality (should still be included but with lowest priority)
  835. std::vector<std::string> zero_q_result;
  836. EXPECT_TRUE(detail::parse_accept_header("text/html;q=0,application/json;q=1",
  837. zero_q_result));
  838. EXPECT_EQ(zero_q_result.size(), 2U);
  839. EXPECT_EQ(zero_q_result[0], "application/json"); // q=1
  840. EXPECT_EQ(zero_q_result[1], "text/html"); // q=0
  841. // No spaces around commas
  842. std::vector<std::string> no_space_result;
  843. EXPECT_TRUE(detail::parse_accept_header(
  844. "text/html;q=0.9,application/json;q=0.8,text/plain;q=0.7",
  845. no_space_result));
  846. EXPECT_EQ(no_space_result.size(), 3U);
  847. EXPECT_EQ(no_space_result[0], "text/html");
  848. EXPECT_EQ(no_space_result[1], "application/json");
  849. EXPECT_EQ(no_space_result[2], "text/plain");
  850. }
  851. TEST(ParseAcceptHeaderTest, QualityValueLocaleIndependence) {
  852. // Quality values always use '.' as the decimal separator, so parsing must
  853. // not depend on the process locale. An embedding application may have
  854. // switched to a locale that uses ',' via setlocale(LC_ALL, "").
  855. const char *cur = std::setlocale(LC_NUMERIC, nullptr);
  856. std::string saved = cur ? cur : "C";
  857. const char *comma_locales[] = {"de_DE.UTF-8", "de_DE.utf8", "nl_NL.UTF-8",
  858. "fr_FR.UTF-8"};
  859. bool switched = false;
  860. for (const auto loc : comma_locales) {
  861. if (std::setlocale(LC_NUMERIC, loc) != nullptr &&
  862. std::localeconv()->decimal_point[0] == ',') {
  863. switched = true;
  864. break;
  865. }
  866. }
  867. if (!switched) {
  868. std::setlocale(LC_NUMERIC, saved.c_str());
  869. GTEST_SKIP() << "no comma-decimal locale available on this host";
  870. }
  871. // The higher-weighted type appears later in the list, so a correct parse
  872. // must reorder it ahead of the earlier, lower-weighted one. A locale-
  873. // sensitive parse reads both weights as 0 and leaves the original order.
  874. std::vector<std::string> result;
  875. EXPECT_TRUE(detail::parse_accept_header(
  876. "application/json;q=0.1,text/html;q=0.9", result));
  877. ASSERT_EQ(result.size(), 2U);
  878. EXPECT_EQ(result[0], "text/html");
  879. EXPECT_EQ(result[1], "application/json");
  880. std::setlocale(LC_NUMERIC, saved.c_str());
  881. }
  882. TEST(ParseAcceptHeaderTest, InvalidCases) {
  883. std::vector<std::string> result;
  884. // Invalid quality value (> 1.0)
  885. EXPECT_FALSE(
  886. detail::parse_accept_header("text/html;q=1.5,application/json", result));
  887. // Invalid quality value (< 0.0)
  888. EXPECT_FALSE(
  889. detail::parse_accept_header("text/html;q=-0.1,application/json", result));
  890. // Invalid quality value (not a number)
  891. EXPECT_FALSE(detail::parse_accept_header(
  892. "text/html;q=invalid,application/json", result));
  893. // A valid numeric prefix does not make the entire quality value valid.
  894. EXPECT_FALSE(detail::parse_accept_header(
  895. "text/html;q=0.5junk,application/json", result));
  896. // Empty quality value
  897. EXPECT_FALSE(
  898. detail::parse_accept_header("text/html;q=,application/json", result));
  899. // Invalid media type format (no slash and not wildcard)
  900. EXPECT_FALSE(
  901. detail::parse_accept_header("invalidtype,application/json", result));
  902. // Valid cases should still work
  903. EXPECT_TRUE(detail::parse_accept_header("*/*", result));
  904. EXPECT_EQ(result.size(), 1U);
  905. EXPECT_EQ(result[0], "*/*");
  906. EXPECT_TRUE(detail::parse_accept_header("*", result));
  907. EXPECT_EQ(result.size(), 1U);
  908. EXPECT_EQ(result[0], "*");
  909. EXPECT_TRUE(detail::parse_accept_header("text/*", result));
  910. EXPECT_EQ(result.size(), 1U);
  911. EXPECT_EQ(result[0], "text/*");
  912. }
  913. // RFC 9110 Section 5.6.1.2: a recipient has to parse and ignore empty list
  914. // elements, so a leading, trailing or doubled comma is a legal Accept value
  915. // and must not be answered with 400 Bad Request.
  916. TEST(ParseAcceptHeaderTest, EmptyListElementsAreIgnored) {
  917. struct {
  918. const char *value;
  919. std::vector<std::string> expected;
  920. } cases[] = {
  921. {",application/json", {"application/json"}},
  922. {"text/html,", {"text/html"}},
  923. {"text/html,,*/*", {"text/html", "*/*"}},
  924. // An empty element may be spelled with whitespace in it
  925. {"text/html, , application/json", {"text/html", "application/json"}},
  926. // Nothing but empty elements is an empty list, which means the same
  927. // thing as no Accept header at all
  928. {",,,", {}},
  929. // Quality values still apply across ignored empty elements
  930. {",text/html;q=0.5,,application/json", {"application/json", "text/html"}},
  931. };
  932. for (const auto &c : cases) {
  933. std::vector<std::string> result;
  934. EXPECT_TRUE(detail::parse_accept_header(c.value, result))
  935. << "value: " << c.value;
  936. EXPECT_EQ(c.expected, result) << "value: " << c.value;
  937. }
  938. // An invalid entry is still rejected when empty elements surround it
  939. std::vector<std::string> result;
  940. EXPECT_FALSE(detail::parse_accept_header(",invalidtype,", result));
  941. }
  942. // RFC 9110 Section 5.6.6: a parameter value may be a quoted-string, and a ','
  943. // or ';' inside one does not end the list element or the parameter. Section
  944. // 5.6.4: nor does a '"' that a backslash escapes end the quoted-string.
  945. TEST(ParseAcceptHeaderTest, DelimitersInQuotedParameterValues) {
  946. struct {
  947. const char *value;
  948. std::vector<std::string> expected;
  949. } cases[] = {
  950. {"text/html;profile=\"a,b\",application/json",
  951. {"text/html", "application/json"}},
  952. // A "q=" inside a quoted value is not the weight
  953. {"text/html;profile=\"a;q=0.1\",application/json;q=0.5",
  954. {"text/html", "application/json"}},
  955. // The weight after a quoted value still applies
  956. {"text/html;profile=\"a,b;q=0.1\";q=0.8,application/json;q=0.9",
  957. {"application/json", "text/html"}},
  958. {"text/html;profile=\"a\\\",b\";q=0.8,application/json;q=0.9",
  959. {"application/json", "text/html"}},
  960. {"text/html;profile=\"a\\\"b\",application/json",
  961. {"text/html", "application/json"}},
  962. // An escaped backslash does not escape the '"' after it
  963. {"text/html;profile=\"a\\\\\",application/json",
  964. {"text/html", "application/json"}},
  965. };
  966. for (const auto &c : cases) {
  967. std::vector<std::string> result;
  968. EXPECT_TRUE(detail::parse_accept_header(c.value, result))
  969. << "value: " << c.value;
  970. EXPECT_EQ(c.expected, result) << "value: " << c.value;
  971. }
  972. }
  973. TEST(ParseAcceptHeaderTest, ContentTypesPopulatedAndInvalidHeaderHandling) {
  974. Server svr;
  975. svr.Get("/accept_ok", [&](const Request &req, Response &res) {
  976. EXPECT_EQ(req.accept_content_types.size(), 3U);
  977. EXPECT_EQ(req.accept_content_types[0], "application/json");
  978. EXPECT_EQ(req.accept_content_types[1], "text/html");
  979. EXPECT_EQ(req.accept_content_types[2], "*/*");
  980. res.set_content("ok", "text/plain");
  981. });
  982. svr.Get("/accept_bad_request", [&](const Request & /*req*/, Response &res) {
  983. EXPECT_TRUE(false);
  984. res.set_content("bad request", "text/plain");
  985. });
  986. auto listen_thread = std::thread([&svr]() { svr.listen("localhost", PORT); });
  987. auto se = detail::scope_exit([&] {
  988. svr.stop();
  989. listen_thread.join();
  990. ASSERT_FALSE(svr.is_running());
  991. });
  992. svr.wait_until_ready();
  993. Client cli("localhost", PORT);
  994. {
  995. auto res = cli.Get(
  996. "/accept_ok",
  997. Headers{{"Accept", "application/json, text/html;q=0.8, */*;q=0.1"}});
  998. ASSERT_TRUE(res) << "Error: " << to_string(res.error());
  999. EXPECT_EQ(StatusCode::OK_200, res->status);
  1000. }
  1001. {
  1002. auto res = cli.Get("/accept_bad_request",
  1003. Headers{{"Accept", "text/html;q=abc,application/json"}});
  1004. ASSERT_TRUE(res) << "Error: " << to_string(res.error());
  1005. EXPECT_EQ(StatusCode::BadRequest_400, res->status);
  1006. }
  1007. }
  1008. TEST(ServerStartHandlerTest, CalledOnceWhenReady) {
  1009. Server svr;
  1010. svr.Get("/", [](const Request & /*req*/, Response &res) {
  1011. res.set_content("ok", "text/plain");
  1012. });
  1013. std::atomic<int> start_count{0};
  1014. std::atomic<bool> running_when_called{false};
  1015. svr.set_start_handler([&]() {
  1016. running_when_called = svr.is_running();
  1017. start_count++;
  1018. });
  1019. auto port = svr.bind_to_any_port(HOST);
  1020. std::thread t([&]() { svr.listen_after_bind(); });
  1021. auto se = detail::scope_exit([&] {
  1022. svr.stop();
  1023. t.join();
  1024. ASSERT_FALSE(svr.is_running());
  1025. });
  1026. svr.wait_until_ready();
  1027. // A successful request proves the accept loop is running, which the start
  1028. // handler precedes; so by now the handler must have run exactly once.
  1029. Client cli(HOST, port);
  1030. cli.set_connection_timeout(std::chrono::seconds(5));
  1031. auto res = cli.Get("/");
  1032. ASSERT_TRUE(res) << "Error: " << to_string(res.error());
  1033. EXPECT_EQ(StatusCode::OK_200, res->status);
  1034. EXPECT_EQ(1, start_count.load());
  1035. EXPECT_TRUE(running_when_called.load());
  1036. }
  1037. TEST(DivideTest, DivideStringTests) {
  1038. auto divide = [](const std::string &str, char d) {
  1039. std::string lhs;
  1040. std::string rhs;
  1041. detail::divide(str, d,
  1042. [&](const char *lhs_data, std::size_t lhs_size,
  1043. const char *rhs_data, std::size_t rhs_size) {
  1044. lhs.assign(lhs_data, lhs_size);
  1045. rhs.assign(rhs_data, rhs_size);
  1046. });
  1047. return std::make_pair(std::move(lhs), std::move(rhs));
  1048. };
  1049. {
  1050. const auto res = divide("", '=');
  1051. EXPECT_EQ(res.first, "");
  1052. EXPECT_EQ(res.second, "");
  1053. }
  1054. {
  1055. const auto res = divide("=", '=');
  1056. EXPECT_EQ(res.first, "");
  1057. EXPECT_EQ(res.second, "");
  1058. }
  1059. {
  1060. const auto res = divide(" ", '=');
  1061. EXPECT_EQ(res.first, " ");
  1062. EXPECT_EQ(res.second, "");
  1063. }
  1064. {
  1065. const auto res = divide("a", '=');
  1066. EXPECT_EQ(res.first, "a");
  1067. EXPECT_EQ(res.second, "");
  1068. }
  1069. {
  1070. const auto res = divide("a=", '=');
  1071. EXPECT_EQ(res.first, "a");
  1072. EXPECT_EQ(res.second, "");
  1073. }
  1074. {
  1075. const auto res = divide("=b", '=');
  1076. EXPECT_EQ(res.first, "");
  1077. EXPECT_EQ(res.second, "b");
  1078. }
  1079. {
  1080. const auto res = divide("a=b", '=');
  1081. EXPECT_EQ(res.first, "a");
  1082. EXPECT_EQ(res.second, "b");
  1083. }
  1084. {
  1085. const auto res = divide("a=b=", '=');
  1086. EXPECT_EQ(res.first, "a");
  1087. EXPECT_EQ(res.second, "b=");
  1088. }
  1089. {
  1090. const auto res = divide("a=b=c", '=');
  1091. EXPECT_EQ(res.first, "a");
  1092. EXPECT_EQ(res.second, "b=c");
  1093. }
  1094. }
  1095. TEST(SplitTest, ParseQueryString) {
  1096. string s = "key1=val1&key2=val2&key3=val3";
  1097. Params dic;
  1098. detail::split(s.c_str(), s.c_str() + s.size(), '&',
  1099. [&](const char *b, const char *e) {
  1100. string key, val;
  1101. detail::split(b, e, '=', [&](const char *b2, const char *e2) {
  1102. if (key.empty()) {
  1103. key.assign(b2, e2);
  1104. } else {
  1105. val.assign(b2, e2);
  1106. }
  1107. });
  1108. dic.emplace(key, val);
  1109. });
  1110. EXPECT_EQ("val1", dic.find("key1")->second);
  1111. EXPECT_EQ("val2", dic.find("key2")->second);
  1112. EXPECT_EQ("val3", dic.find("key3")->second);
  1113. }
  1114. TEST(SplitTest, ParseInvalidQueryTests) {
  1115. {
  1116. string s = " ";
  1117. Params dict;
  1118. detail::parse_query_text(s, dict);
  1119. EXPECT_TRUE(dict.empty());
  1120. }
  1121. {
  1122. string s = " = =";
  1123. Params dict;
  1124. detail::parse_query_text(s, dict);
  1125. EXPECT_TRUE(dict.empty());
  1126. }
  1127. }
  1128. TEST(ParseQueryTest, ParseQueryString) {
  1129. {
  1130. std::string s = "key1=val1&key2=val2&key3=val3";
  1131. Params dic;
  1132. detail::parse_query_text(s, dic);
  1133. EXPECT_EQ("val1", dic.find("key1")->second);
  1134. EXPECT_EQ("val2", dic.find("key2")->second);
  1135. EXPECT_EQ("val3", dic.find("key3")->second);
  1136. }
  1137. {
  1138. std::string s = "key1&key2=val1&key3=val1=val2&key4=val1=val2=val3";
  1139. Params dic;
  1140. detail::parse_query_text(s, dic);
  1141. EXPECT_EQ("", dic.find("key1")->second);
  1142. EXPECT_EQ("val1", dic.find("key2")->second);
  1143. EXPECT_EQ("val1=val2", dic.find("key3")->second);
  1144. EXPECT_EQ("val1=val2=val3", dic.find("key4")->second);
  1145. }
  1146. }
  1147. TEST(ParamsToQueryTest, ConvertParamsToQuery) {
  1148. Params dic;
  1149. EXPECT_EQ(detail::params_to_query_str(dic), "");
  1150. dic.emplace("key1", "val1");
  1151. EXPECT_EQ(detail::params_to_query_str(dic), "key1=val1");
  1152. dic.emplace("key2", "val2");
  1153. dic.emplace("key3", "val3");
  1154. EXPECT_EQ(detail::params_to_query_str(dic), "key1=val1&key2=val2&key3=val3");
  1155. }
  1156. // Joins every entry of a Headers or Params into "key=value " so a whole
  1157. // traversal can be compared in one assertion. Both are instantiations of the
  1158. // same insertion-ordered container, so one helper serves both.
  1159. template <typename Map> static std::string entries_to_string(const Map &m) {
  1160. std::string s;
  1161. for (const auto &entry : m) {
  1162. s += entry.first + "=" + entry.second + " ";
  1163. }
  1164. return s;
  1165. }
  1166. TEST(ParamsOrderTest, QueryIsBuiltInInsertionOrderNotSorted) {
  1167. // Params used to be a std::multimap, which sorted by name and handed the
  1168. // caller's query back alphabetised. A client signing its query string could
  1169. // not reproduce the order it asked for.
  1170. Params dic;
  1171. dic.emplace("zulu", "1");
  1172. dic.emplace("alpha", "2");
  1173. dic.emplace("mike", "3");
  1174. EXPECT_EQ("zulu=1&alpha=2&mike=3", detail::params_to_query_str(dic));
  1175. EXPECT_EQ("/p?zulu=1&alpha=2&mike=3", append_query_params("/p", dic));
  1176. }
  1177. TEST(ParamsOrderTest, ParsingKeepsTheOrderReceived) {
  1178. Params dic;
  1179. detail::parse_query_text("zulu=1&alpha=2&mike=3", dic);
  1180. EXPECT_EQ("zulu=1 alpha=2 mike=3 ", entries_to_string(dic));
  1181. }
  1182. TEST(ParamsOrderTest, RepeatedNamesKeepTheirOrder) {
  1183. Request req;
  1184. detail::parse_query_text("tag=first&other=x&tag=second&tag=third",
  1185. req.params);
  1186. EXPECT_EQ(3U, req.get_param_value_count("tag"));
  1187. EXPECT_EQ("first", req.get_param_value("tag"));
  1188. EXPECT_EQ("first", req.get_param_value("tag", 0));
  1189. EXPECT_EQ("second", req.get_param_value("tag", 1));
  1190. EXPECT_EQ("third", req.get_param_value("tag", 2));
  1191. EXPECT_EQ("", req.get_param_value("tag", 3));
  1192. }
  1193. TEST(ParamsOrderTest, LookupStaysCaseSensitive) {
  1194. // Params shares its container with Headers, which matches field names
  1195. // case-insensitively. Parameter names must not pick that up.
  1196. Params dic;
  1197. dic.emplace("Key", "upper");
  1198. dic.emplace("key", "lower");
  1199. EXPECT_EQ(2U, dic.size());
  1200. EXPECT_EQ(1U, dic.count("Key"));
  1201. EXPECT_EQ(1U, dic.count("key"));
  1202. EXPECT_EQ("upper", dic.find("Key")->second);
  1203. EXPECT_EQ("lower", dic.find("key")->second);
  1204. EXPECT_TRUE(dic.find("KEY") == dic.end());
  1205. }
  1206. TEST(ParamsOrderTest, ServerSeesTheOrderTheClientSent) {
  1207. Server svr;
  1208. std::string order;
  1209. svr.Get("/order", [&](const Request &req, Response &res) {
  1210. order = entries_to_string(req.params);
  1211. res.set_content("ok", "text/plain");
  1212. });
  1213. auto port = svr.bind_to_any_port(HOST);
  1214. thread t = thread([&] { svr.listen_after_bind(); });
  1215. auto se = detail::scope_exit([&] {
  1216. svr.stop();
  1217. t.join();
  1218. ASSERT_FALSE(svr.is_running());
  1219. });
  1220. svr.wait_until_ready();
  1221. Client cli(HOST, port);
  1222. auto res = cli.Get("/order?zulu=1&alpha=2&tag=x&mike=3&tag=y");
  1223. ASSERT_TRUE(res);
  1224. EXPECT_EQ("zulu=1 alpha=2 tag=x mike=3 tag=y ", order);
  1225. }
  1226. TEST(MultipartOrderTest, PartsKeepTheOrderSent) {
  1227. Server svr;
  1228. std::string field_order, file_order;
  1229. svr.Post("/order", [&](const Request &req, Response &res) {
  1230. for (const auto &field : req.form.fields) {
  1231. field_order += field.first + "=" + field.second.content + " ";
  1232. }
  1233. for (const auto &file : req.form.files) {
  1234. file_order += file.first + "=" + file.second.filename + " ";
  1235. }
  1236. res.set_content("ok", "text/plain");
  1237. });
  1238. auto port = svr.bind_to_any_port(HOST);
  1239. thread t = thread([&] { svr.listen_after_bind(); });
  1240. auto se = detail::scope_exit([&] {
  1241. svr.stop();
  1242. t.join();
  1243. ASSERT_FALSE(svr.is_running());
  1244. });
  1245. svr.wait_until_ready();
  1246. UploadFormDataItems items = {
  1247. {"zulu", "1", "", ""},
  1248. {"alpha", "2", "", ""},
  1249. {"mike", "3", "", ""},
  1250. {"zebra", "z", "z.txt", "text/plain"},
  1251. {"apple", "a", "a.txt", "text/plain"},
  1252. };
  1253. Client cli(HOST, port);
  1254. auto res = cli.Post("/order", items);
  1255. ASSERT_TRUE(res);
  1256. EXPECT_EQ("zulu=1 alpha=2 mike=3 ", field_order);
  1257. EXPECT_EQ("zebra=z.txt apple=a.txt ", file_order);
  1258. }
  1259. TEST(MultipartOrderTest, RepeatedNamesKeepTheirOrder) {
  1260. Server svr;
  1261. std::vector<std::string> values;
  1262. std::string first, second, out_of_range, order;
  1263. svr.Post("/repeated", [&](const Request &req, Response &res) {
  1264. values = req.form.get_fields("tag");
  1265. first = req.form.get_field("tag", 0);
  1266. second = req.form.get_field("tag", 1);
  1267. out_of_range = req.form.get_field("tag", 2);
  1268. for (const auto &field : req.form.fields) {
  1269. order += field.first + "=" + field.second.content + " ";
  1270. }
  1271. res.set_content("ok", "text/plain");
  1272. });
  1273. auto port = svr.bind_to_any_port(HOST);
  1274. thread t = thread([&] { svr.listen_after_bind(); });
  1275. auto se = detail::scope_exit([&] {
  1276. svr.stop();
  1277. t.join();
  1278. ASSERT_FALSE(svr.is_running());
  1279. });
  1280. svr.wait_until_ready();
  1281. // "other" sits between the two "tag" parts, so the entries sharing a name are
  1282. // not adjacent in the container.
  1283. UploadFormDataItems items = {
  1284. {"tag", "first", "", ""},
  1285. {"other", "x", "", ""},
  1286. {"tag", "second", "", ""},
  1287. };
  1288. Client cli(HOST, port);
  1289. auto res = cli.Post("/repeated", items);
  1290. ASSERT_TRUE(res);
  1291. ASSERT_EQ(2U, values.size());
  1292. EXPECT_EQ("first", values[0]);
  1293. EXPECT_EQ("second", values[1]);
  1294. EXPECT_EQ("first", first);
  1295. EXPECT_EQ("second", second);
  1296. // std::multimap already kept entries sharing a name in insertion order, so
  1297. // everything above passes without this change too. The whole traversal is
  1298. // what tells the two apart: sorting by name would hoist "other" to the front
  1299. // and the two "tag" parts would end up adjacent.
  1300. EXPECT_EQ("tag=first other=x tag=second ", order);
  1301. // Advancing past the last entry of a name used to run off the container;
  1302. // the container's saturating increment makes it return the default instead.
  1303. EXPECT_EQ("", out_of_range);
  1304. }
  1305. TEST(MultipartOrderTest, ContentSurvivesContainerGrowth) {
  1306. // Server::read_content() keeps a FormFields::iterator alive across the
  1307. // content callbacks that fill the part it points at. The container is
  1308. // vector-backed, so a later emplace can reallocate and invalidate an older
  1309. // iterator; 64 parts grow the vector through seven reallocations, which
  1310. // checks that every part's content still lands in its own entry.
  1311. const size_t part_count = 64;
  1312. // One formula for both the parts sent and the values expected back, so the
  1313. // two cannot drift apart.
  1314. auto name_of = [](size_t i) { return "f" + std::to_string(i); };
  1315. auto content_of = [](size_t i) {
  1316. return std::string(64, static_cast<char>('a' + (i % 26)));
  1317. };
  1318. Server svr;
  1319. std::vector<std::pair<std::string, std::string>> received;
  1320. svr.Post("/many", [&](const Request &req, Response &res) {
  1321. for (const auto &field : req.form.fields) {
  1322. received.emplace_back(field.first, field.second.content);
  1323. }
  1324. res.set_content("ok", "text/plain");
  1325. });
  1326. auto port = svr.bind_to_any_port(HOST);
  1327. thread t = thread([&] { svr.listen_after_bind(); });
  1328. auto se = detail::scope_exit([&] {
  1329. svr.stop();
  1330. t.join();
  1331. ASSERT_FALSE(svr.is_running());
  1332. });
  1333. svr.wait_until_ready();
  1334. UploadFormDataItems items;
  1335. for (size_t i = 0; i < part_count; i++) {
  1336. items.push_back({name_of(i), content_of(i), "", ""});
  1337. }
  1338. Client cli(HOST, port);
  1339. auto res = cli.Post("/many", items);
  1340. ASSERT_TRUE(res);
  1341. ASSERT_EQ(part_count, received.size());
  1342. for (size_t i = 0; i < part_count; i++) {
  1343. EXPECT_EQ(name_of(i), received[i].first) << "part " << i;
  1344. EXPECT_EQ(content_of(i), received[i].second) << "part " << i;
  1345. }
  1346. }
  1347. TEST(ParseMultipartBoundaryTest, DefaultValue) {
  1348. string content_type = "multipart/form-data; boundary=something";
  1349. string boundary;
  1350. auto ret = detail::parse_multipart_boundary(content_type, boundary);
  1351. EXPECT_TRUE(ret);
  1352. EXPECT_EQ(boundary, "something");
  1353. }
  1354. TEST(ParseMultipartBoundaryTest, ValueWithQuote) {
  1355. string content_type = "multipart/form-data; boundary=\"gc0pJq0M:08jU534c0p\"";
  1356. string boundary;
  1357. auto ret = detail::parse_multipart_boundary(content_type, boundary);
  1358. EXPECT_TRUE(ret);
  1359. EXPECT_EQ(boundary, "gc0pJq0M:08jU534c0p");
  1360. }
  1361. TEST(ParseMultipartBoundaryTest, ValueWithCharset) {
  1362. string content_type =
  1363. "multipart/mixed; boundary=THIS_STRING_SEPARATES;charset=UTF-8";
  1364. string boundary;
  1365. auto ret = detail::parse_multipart_boundary(content_type, boundary);
  1366. EXPECT_TRUE(ret);
  1367. EXPECT_EQ(boundary, "THIS_STRING_SEPARATES");
  1368. }
  1369. TEST(ParseMultipartBoundaryTest, ValueWithQuotesAndCharset) {
  1370. string content_type =
  1371. "multipart/mixed; boundary=\"cpp-httplib-multipart-data\"; charset=UTF-8";
  1372. string boundary;
  1373. auto ret = detail::parse_multipart_boundary(content_type, boundary);
  1374. EXPECT_TRUE(ret);
  1375. EXPECT_EQ(boundary, "cpp-httplib-multipart-data");
  1376. }
  1377. TEST(ParseMultipartBoundaryTest, LongestAllowedValue) {
  1378. const string boundary(70, 'a');
  1379. string content_type = "multipart/form-data; boundary=" + boundary;
  1380. string parsed;
  1381. auto ret = detail::parse_multipart_boundary(content_type, parsed);
  1382. EXPECT_TRUE(ret);
  1383. EXPECT_EQ(parsed, boundary);
  1384. }
  1385. TEST(ParseMultipartBoundaryTest, ValueLongerThanRFCLimit) {
  1386. // RFC 2046 5.1.1 caps a boundary at 70 characters.
  1387. string content_type = "multipart/form-data; boundary=" + string(71, 'a');
  1388. string parsed;
  1389. auto ret = detail::parse_multipart_boundary(content_type, parsed);
  1390. EXPECT_FALSE(ret);
  1391. }
  1392. TEST(ParseMultipartBoundaryTest, QuotedValueIsMeasuredAfterUnquoting) {
  1393. // The limit applies to the unquoted value, so a quoted 70 character boundary
  1394. // is 72 characters on the wire and still valid.
  1395. const string boundary(70, 'a');
  1396. string content_type = "multipart/form-data; boundary=\"" + boundary + "\"";
  1397. string parsed;
  1398. EXPECT_TRUE(detail::parse_multipart_boundary(content_type, parsed));
  1399. EXPECT_EQ(parsed, boundary);
  1400. content_type = "multipart/form-data; boundary=\"" + string(71, 'a') + "\"";
  1401. parsed.clear();
  1402. EXPECT_FALSE(detail::parse_multipart_boundary(content_type, parsed));
  1403. }
  1404. TEST(ParseMultipartBoundaryTest, QuotedValueWithEqualsSign) {
  1405. // RFC 2046 5.1.1 allows '=' in a boundary, so a MIME sender has to quote it.
  1406. // The parameter parser must not treat that '=' as the key/value separator.
  1407. string content_type =
  1408. "multipart/mixed; boundary=\"----=_NextPart_000_0000_01D9\"; "
  1409. "charset=UTF-8";
  1410. string parsed;
  1411. EXPECT_TRUE(detail::parse_multipart_boundary(content_type, parsed));
  1412. EXPECT_EQ(parsed, "----=_NextPart_000_0000_01D9");
  1413. }
  1414. TEST(ParseMultipartBoundaryTest, QuotedValueWithSemicolon) {
  1415. // A ';' inside the quoted-string is part of the value, not a parameter
  1416. // separator, so it must not truncate the boundary.
  1417. string content_type = "multipart/mixed; boundary=\"a;b\"; charset=UTF-8";
  1418. string parsed;
  1419. EXPECT_TRUE(detail::parse_multipart_boundary(content_type, parsed));
  1420. EXPECT_EQ(parsed, "a;b");
  1421. }
  1422. TEST(ParseDispositionParamsTest, QuotedValues) {
  1423. // RFC 9110 Section 5.6.6: a parameter value may be a quoted-string, and
  1424. // ';' and '=' are ordinary characters inside one.
  1425. struct {
  1426. const char *value;
  1427. std::vector<std::pair<const char *, const char *>> expected;
  1428. } cases[] = {
  1429. {"name=\"file1\"; filename=\"a.txt\"",
  1430. {{"name", "file1"}, {"filename", "a.txt"}}},
  1431. // Whitespace around '=' and ';' is still trimmed
  1432. {"name=\"file2\" ;filename = \"a.html\"",
  1433. {{"name", "file2"}, {"filename", "a.html"}}},
  1434. // '=' inside the value used to leave only the text after the last one
  1435. {"name=\"file1\"; filename=\"report=v2.pdf\"",
  1436. {{"name", "file1"}, {"filename", "report=v2.pdf"}}},
  1437. {"name=\"x=y\"", {{"name", "x=y"}}},
  1438. // ';' inside the value used to truncate the pair and leave a bogus one
  1439. {"name=\"file3\"; filename=\"a;b.txt\"",
  1440. {{"name", "file3"}, {"filename", "a;b.txt"}}},
  1441. // An unquoted value keeps working, and so does filename*
  1442. {"filename*=UTF-8''%41.txt; filename=\"a.txt\"",
  1443. {{"filename*", "UTF-8''%41.txt"}, {"filename", "a.txt"}}},
  1444. // A parameter with no key is dropped rather than turned into one whose
  1445. // key is the value
  1446. {"=nokey; name=\"file5\"", {{"name", "file5"}}},
  1447. };
  1448. for (const auto &c : cases) {
  1449. Params params;
  1450. detail::parse_disposition_params(c.value, params);
  1451. for (const auto &kv : c.expected) {
  1452. auto it = params.find(kv.first);
  1453. ASSERT_NE(it, params.end())
  1454. << "value: " << c.value << ", key: " << kv.first;
  1455. EXPECT_EQ(kv.second, it->second) << "value: " << c.value;
  1456. }
  1457. EXPECT_EQ(c.expected.size(), params.size()) << "value: " << c.value;
  1458. }
  1459. }
  1460. TEST(ParseDispositionParamsTest, QuotedValuesSurviveTheRoundTrip) {
  1461. // escape_multipart_field() only escapes '"', CR and LF, so a name or
  1462. // filename holding '=' or ';' reaches the server's parameter parser as is.
  1463. Server svr;
  1464. std::string field_value, file_name, file_filename;
  1465. bool has_field = false, has_file = false;
  1466. svr.Post("/quoted", [&](const Request &req, Response &res) {
  1467. has_field = req.form.has_field("x=y");
  1468. field_value = req.form.get_field("x=y");
  1469. has_file = req.form.has_file("file1");
  1470. const auto &file = req.form.get_file("file1");
  1471. file_name = file.name;
  1472. file_filename = file.filename;
  1473. res.set_content("ok", "text/plain");
  1474. });
  1475. auto port = svr.bind_to_any_port(HOST);
  1476. thread t = thread([&] { svr.listen_after_bind(); });
  1477. auto se = detail::scope_exit([&] {
  1478. svr.stop();
  1479. t.join();
  1480. ASSERT_FALSE(svr.is_running());
  1481. });
  1482. svr.wait_until_ready();
  1483. UploadFormDataItems items = {
  1484. {"x=y", "field-value", "", ""},
  1485. {"file1", "pdf-bytes", "a;b=report.pdf", "application/pdf"},
  1486. };
  1487. Client cli(HOST, port);
  1488. auto res = cli.Post("/quoted", items);
  1489. ASSERT_TRUE(res) << "Error: " << to_string(res.error());
  1490. ASSERT_EQ(StatusCode::OK_200, res->status);
  1491. EXPECT_TRUE(has_field);
  1492. EXPECT_EQ("field-value", field_value);
  1493. EXPECT_TRUE(has_file);
  1494. EXPECT_EQ("file1", file_name);
  1495. EXPECT_EQ("a;b=report.pdf", file_filename);
  1496. }
  1497. TEST(GetHeaderValueTest, DefaultValue) {
  1498. Headers headers = {{"Dummy", "Dummy"}};
  1499. auto val = detail::get_header_value(headers, "Content-Type", "text/plain", 0);
  1500. EXPECT_STREQ("text/plain", val);
  1501. }
  1502. TEST(GetHeaderValueTest, DefaultValueInt) {
  1503. Headers headers = {{"Dummy", "Dummy"}};
  1504. auto val = detail::get_header_value_u64(headers, "Content-Length", 100, 0);
  1505. EXPECT_EQ(100ull, val);
  1506. }
  1507. TEST(GetHeaderValueTest, RegularValue) {
  1508. Headers headers = {{"Content-Type", "text/html"}, {"Dummy", "Dummy"}};
  1509. auto val = detail::get_header_value(headers, "Content-Type", "text/plain", 0);
  1510. EXPECT_STREQ("text/html", val);
  1511. }
  1512. TEST(GetHeaderValueTest, RegularValueWithDifferentCase) {
  1513. Headers headers = {{"Content-Type", "text/html"}, {"Dummy", "Dummy"}};
  1514. auto val = detail::get_header_value(headers, "content-type", "text/plain", 0);
  1515. EXPECT_STREQ("text/html", val);
  1516. }
  1517. TEST(GetHeaderValueTest, SetContent) {
  1518. Response res;
  1519. res.set_content("html", "text/html");
  1520. EXPECT_EQ("text/html", res.get_header_value("Content-Type"));
  1521. res.set_content("text", "text/plain");
  1522. EXPECT_EQ(1U, res.get_header_value_count("Content-Type"));
  1523. EXPECT_EQ("text/plain", res.get_header_value("Content-Type"));
  1524. }
  1525. TEST(GetHeaderValueTest, RegularValueInt) {
  1526. Headers headers = {{"Content-Length", "100"}, {"Dummy", "Dummy"}};
  1527. auto val = detail::get_header_value_u64(headers, "Content-Length", 0, 0);
  1528. EXPECT_EQ(100ull, val);
  1529. }
  1530. TEST(GetHeaderValueTest, RegularInvalidValueInt) {
  1531. Headers headers = {{"Content-Length", "x"}};
  1532. auto is_invalid_value = false;
  1533. auto val = detail::get_header_value_u64(headers, "Content-Length", 0, 0,
  1534. is_invalid_value);
  1535. EXPECT_EQ(0ull, val);
  1536. EXPECT_TRUE(is_invalid_value);
  1537. }
  1538. TEST(GetHeaderValueTest, OutOfRangeValueInt) {
  1539. // An all-digit value that overflows size_t must be reported as invalid, not
  1540. // silently saturated/truncated: parsing at size_t width would otherwise wrap
  1541. // a large length to a small one on 32-bit builds, leaving the framing length
  1542. // wrong while is_invalid_value stayed false.
  1543. Headers headers = {{"Content-Length", "99999999999999999999999999"}};
  1544. auto is_invalid_value = false;
  1545. detail::get_header_value_u64(headers, "Content-Length", 0, 0,
  1546. is_invalid_value);
  1547. EXPECT_TRUE(is_invalid_value);
  1548. // A well-formed length is unaffected.
  1549. Headers ok = {{"Content-Length", "1234"}};
  1550. is_invalid_value = false;
  1551. auto val = detail::get_header_value_u64(ok, "Content-Length", 0, 0,
  1552. is_invalid_value);
  1553. EXPECT_EQ(1234ull, val);
  1554. EXPECT_FALSE(is_invalid_value);
  1555. }
  1556. TEST(GetHeaderValueTest, Range) {
  1557. {
  1558. Headers headers = {make_range_header({{1, -1}})};
  1559. auto val = detail::get_header_value(headers, "Range", 0, 0);
  1560. EXPECT_STREQ("bytes=1-", val);
  1561. }
  1562. {
  1563. Headers headers = {make_range_header({{-1, 1}})};
  1564. auto val = detail::get_header_value(headers, "Range", 0, 0);
  1565. EXPECT_STREQ("bytes=-1", val);
  1566. }
  1567. {
  1568. Headers headers = {make_range_header({{1, 10}})};
  1569. auto val = detail::get_header_value(headers, "Range", 0, 0);
  1570. EXPECT_STREQ("bytes=1-10", val);
  1571. }
  1572. {
  1573. Headers headers = {make_range_header({{1, 10}, {100, -1}})};
  1574. auto val = detail::get_header_value(headers, "Range", 0, 0);
  1575. EXPECT_STREQ("bytes=1-10, 100-", val);
  1576. }
  1577. {
  1578. Headers headers = {make_range_header({{1, 10}, {100, 200}})};
  1579. auto val = detail::get_header_value(headers, "Range", 0, 0);
  1580. EXPECT_STREQ("bytes=1-10, 100-200", val);
  1581. }
  1582. {
  1583. Headers headers = {make_range_header({{0, 0}, {-1, 1}})};
  1584. auto val = detail::get_header_value(headers, "Range", 0, 0);
  1585. EXPECT_STREQ("bytes=0-0, -1", val);
  1586. }
  1587. }
  1588. TEST(BearerTokenAuthTest, SchemeValidation) {
  1589. // A value shorter than "Bearer " must not throw from the fixed-length
  1590. // substr, and a non-Bearer scheme must not be reported as a token.
  1591. struct {
  1592. const char *value;
  1593. const char *expected;
  1594. } cases[] = {
  1595. {"x", ""},
  1596. {"Basic QWxhZGRpbjpvcGVuIHNlc2FtZQ==", ""},
  1597. {"Bearer abc123", "abc123"},
  1598. {"bearer abc123", "abc123"}, // scheme match is case-insensitive
  1599. };
  1600. for (const auto &c : cases) {
  1601. Request req;
  1602. req.set_header("Authorization", c.value);
  1603. EXPECT_EQ(c.expected, get_bearer_token_auth(req)) << "value: " << c.value;
  1604. }
  1605. }
  1606. TEST(HeadersOrderTest, DuplicateFieldsKeepInsertionOrder) {
  1607. // RFC 9110 5.3: the order of fields sharing a name is significant. This used
  1608. // to depend on the standard library (libstdc++ handed back duplicates in
  1609. // reverse insertion order, libc++ in insertion order).
  1610. Request req;
  1611. req.set_header("Accept-Encoding", "gzip");
  1612. req.set_header("Accept-Encoding", "deflate");
  1613. req.set_header("Accept-Encoding", "br");
  1614. EXPECT_EQ(3U, req.get_header_value_count("Accept-Encoding"));
  1615. EXPECT_EQ("gzip", req.get_header_value("Accept-Encoding"));
  1616. EXPECT_EQ("gzip", req.get_header_value("Accept-Encoding", "", 0));
  1617. EXPECT_EQ("deflate", req.get_header_value("Accept-Encoding", "", 1));
  1618. EXPECT_EQ("br", req.get_header_value("Accept-Encoding", "", 2));
  1619. }
  1620. TEST(HeadersOrderTest, IdBeyondTheLastDuplicateYieldsDefault) {
  1621. Request req;
  1622. req.set_header("X-Test", "only");
  1623. EXPECT_EQ("only", req.get_header_value("X-Test", "def", 0));
  1624. EXPECT_EQ("def", req.get_header_value("X-Test", "def", 1));
  1625. EXPECT_EQ("def", req.get_header_value("X-Test", "def", 99));
  1626. EXPECT_EQ("def", req.get_header_value("X-Missing", "def", 3));
  1627. }
  1628. TEST(HeadersOrderTest, HugeIdYieldsDefault) {
  1629. Request req;
  1630. req.set_header("X-First", "1");
  1631. req.set_header("X-Test", "2");
  1632. req.params.emplace("first", "1");
  1633. req.params.emplace("test", "2");
  1634. req.form.fields.emplace("first", FormField{"first", "1", {}});
  1635. req.form.fields.emplace("test", FormField{"test", "2", {}});
  1636. req.form.files.emplace("first", FormData{"first", "1", "", "", {}});
  1637. req.form.files.emplace("test", FormData{"test", "2", "", "", {}});
  1638. // The second one is negative when read as a signed value
  1639. const auto max_id = (std::numeric_limits<size_t>::max)();
  1640. for (auto id : {max_id / 2, max_id}) {
  1641. EXPECT_EQ("def", req.get_header_value("X-Test", "def", id));
  1642. EXPECT_EQ(7U, req.get_header_value_u64("X-Test", 7, id));
  1643. EXPECT_EQ("", req.get_param_value("test", id));
  1644. EXPECT_EQ("", req.form.get_field("test", id));
  1645. EXPECT_EQ("", req.form.get_file("test", id).content);
  1646. }
  1647. }
  1648. TEST(HeadersOrderTest, TraversalFollowsInsertionOrder) {
  1649. Headers headers;
  1650. headers.emplace("Host", "example.com");
  1651. headers.emplace("Accept-Encoding", "gzip");
  1652. headers.emplace("User-Agent", "test");
  1653. headers.emplace("Accept-Encoding", "deflate");
  1654. EXPECT_EQ("Host=example.com Accept-Encoding=gzip User-Agent=test "
  1655. "Accept-Encoding=deflate ",
  1656. entries_to_string(headers));
  1657. }
  1658. TEST(HeadersOrderTest, LookupIsCaseInsensitiveAndPicksTheFirstField) {
  1659. Headers headers = {{"Content-Type", "text/html"},
  1660. {"CONTENT-TYPE", "text/xml"}};
  1661. EXPECT_EQ(2U, headers.count("content-type"));
  1662. auto it = headers.find("content-type");
  1663. ASSERT_TRUE(it != headers.end());
  1664. EXPECT_EQ("text/html", it->second);
  1665. }
  1666. TEST(HeadersOrderTest, ErasingAnEqualRangeSparesInterleavedFields) {
  1667. // The fields sharing a name are not adjacent, so an equal_range() erase must
  1668. // drop only those fields and leave everything positioned between them.
  1669. Headers headers = {{"A", "1"}, {"X", "x"}, {"A", "2"},
  1670. {"Y", "y"}, {"A", "3"}, {"Z", "z"}};
  1671. auto rng = headers.equal_range("a");
  1672. headers.erase(rng.first, rng.second);
  1673. EXPECT_EQ("X=x Y=y Z=z ", entries_to_string(headers));
  1674. }
  1675. TEST(HeadersOrderTest, ErasingByNameKeepsTheRemainingOrder) {
  1676. Headers headers = {
  1677. {"A", "1"}, {"B", "2"}, {"a", "3"}, {"C", "4"}, {"A", "5"}};
  1678. EXPECT_EQ(3U, headers.erase("A"));
  1679. EXPECT_EQ(0U, headers.count("A"));
  1680. EXPECT_EQ("B=2 C=4 ", entries_to_string(headers));
  1681. }
  1682. TEST(HeadersOrderTest, EmplaceFrontPrepends) {
  1683. Headers headers = {{"Accept", "*/*"}, {"User-Agent", "test"}};
  1684. headers.emplace_front("Host", "example.com");
  1685. EXPECT_EQ("Host=example.com Accept=*/* User-Agent=test ",
  1686. entries_to_string(headers));
  1687. }
  1688. TEST(ParseHeaderValueTest, Range) {
  1689. {
  1690. Ranges ranges;
  1691. auto ret = detail::parse_range_header("bytes=1-", ranges);
  1692. EXPECT_TRUE(ret);
  1693. EXPECT_EQ(1u, ranges.size());
  1694. EXPECT_EQ(1u, ranges[0].first);
  1695. EXPECT_EQ(-1, ranges[0].second);
  1696. }
  1697. {
  1698. Ranges ranges;
  1699. auto ret = detail::parse_range_header("bytes=-1", ranges);
  1700. EXPECT_TRUE(ret);
  1701. EXPECT_EQ(1u, ranges.size());
  1702. EXPECT_EQ(-1, ranges[0].first);
  1703. EXPECT_EQ(1u, ranges[0].second);
  1704. }
  1705. {
  1706. Ranges ranges;
  1707. auto ret = detail::parse_range_header("bytes=1-10", ranges);
  1708. EXPECT_TRUE(ret);
  1709. EXPECT_EQ(1u, ranges.size());
  1710. EXPECT_EQ(1u, ranges[0].first);
  1711. EXPECT_EQ(10u, ranges[0].second);
  1712. }
  1713. {
  1714. Ranges ranges;
  1715. auto ret = detail::parse_range_header("bytes=10-1", ranges);
  1716. EXPECT_FALSE(ret);
  1717. }
  1718. {
  1719. Ranges ranges;
  1720. auto ret = detail::parse_range_header("bytes=1-10, 100-", ranges);
  1721. EXPECT_TRUE(ret);
  1722. EXPECT_EQ(2u, ranges.size());
  1723. EXPECT_EQ(1u, ranges[0].first);
  1724. EXPECT_EQ(10u, ranges[0].second);
  1725. EXPECT_EQ(100u, ranges[1].first);
  1726. EXPECT_EQ(-1, ranges[1].second);
  1727. }
  1728. {
  1729. Ranges ranges;
  1730. auto ret =
  1731. detail::parse_range_header("bytes=1-10, 100-200, 300-400", ranges);
  1732. EXPECT_TRUE(ret);
  1733. EXPECT_EQ(3u, ranges.size());
  1734. EXPECT_EQ(1u, ranges[0].first);
  1735. EXPECT_EQ(10u, ranges[0].second);
  1736. EXPECT_EQ(100u, ranges[1].first);
  1737. EXPECT_EQ(200u, ranges[1].second);
  1738. EXPECT_EQ(300u, ranges[2].first);
  1739. EXPECT_EQ(400u, ranges[2].second);
  1740. }
  1741. {
  1742. Ranges ranges;
  1743. EXPECT_FALSE(detail::parse_range_header("bytes", ranges));
  1744. EXPECT_FALSE(detail::parse_range_header("bytes=", ranges));
  1745. EXPECT_FALSE(detail::parse_range_header("bytes=0", ranges));
  1746. EXPECT_FALSE(detail::parse_range_header("bytes=-", ranges));
  1747. EXPECT_FALSE(detail::parse_range_header("bytes= ", ranges));
  1748. EXPECT_FALSE(detail::parse_range_header("bytes=,", ranges));
  1749. EXPECT_FALSE(detail::parse_range_header("bytes=,,", ranges));
  1750. EXPECT_FALSE(detail::parse_range_header("bytes=,,,", ranges));
  1751. EXPECT_FALSE(detail::parse_range_header("bytes=a-b", ranges));
  1752. EXPECT_FALSE(detail::parse_range_header("bytes=1-0", ranges));
  1753. EXPECT_FALSE(detail::parse_range_header("bytes=0--1", ranges));
  1754. EXPECT_FALSE(detail::parse_range_header("bytes=0- 1", ranges));
  1755. EXPECT_FALSE(detail::parse_range_header("bytes=0 -1", ranges));
  1756. // Overflows ssize_t; must not be read as the suffix range "bytes=-100".
  1757. EXPECT_FALSE(
  1758. detail::parse_range_header("bytes=9223372036854775808-100", ranges));
  1759. EXPECT_TRUE(ranges.empty());
  1760. }
  1761. {
  1762. // RFC 9110 14.1.2: a last-byte-pos greater than the content length is the
  1763. // remainder of the representation, so it stays accepted.
  1764. Ranges ranges;
  1765. auto ret =
  1766. detail::parse_range_header("bytes=0-99999999999999999999", ranges);
  1767. EXPECT_TRUE(ret);
  1768. ASSERT_EQ(1u, ranges.size());
  1769. EXPECT_EQ(0, ranges[0].first);
  1770. EXPECT_EQ(-1, ranges[0].second);
  1771. }
  1772. // RFC 9110 14.1: range unit names are case-insensitive.
  1773. for (const auto &s : {"Bytes=1-10", "BYTES=1-10", "bYtEs=1-10"}) {
  1774. Ranges ranges;
  1775. EXPECT_TRUE(detail::parse_range_header(s, ranges)) << s;
  1776. EXPECT_EQ((Ranges{{1, 10}}), ranges) << s;
  1777. }
  1778. }
  1779. TEST(ParseAcceptEncoding1, AcceptEncoding) {
  1780. Request req;
  1781. req.set_header("Accept-Encoding", "gzip");
  1782. Response res;
  1783. res.set_header("Content-Type", "text/plain");
  1784. auto ret = detail::encoding_type(req, res);
  1785. #ifdef CPPHTTPLIB_ZLIB_SUPPORT
  1786. EXPECT_TRUE(ret == detail::EncodingType::Gzip);
  1787. #else
  1788. EXPECT_TRUE(ret == detail::EncodingType::None);
  1789. #endif
  1790. }
  1791. TEST(ParseAcceptEncoding2, AcceptEncoding) {
  1792. Request req;
  1793. req.set_header("Accept-Encoding", "gzip, deflate, br, zstd");
  1794. Response res;
  1795. res.set_header("Content-Type", "text/plain");
  1796. auto ret = detail::encoding_type(req, res);
  1797. #ifdef CPPHTTPLIB_BROTLI_SUPPORT
  1798. EXPECT_TRUE(ret == detail::EncodingType::Brotli);
  1799. #elif CPPHTTPLIB_ZLIB_SUPPORT
  1800. EXPECT_TRUE(ret == detail::EncodingType::Gzip);
  1801. #elif CPPHTTPLIB_ZSTD_SUPPORT
  1802. EXPECT_TRUE(ret == detail::EncodingType::Zstd);
  1803. #else
  1804. EXPECT_TRUE(ret == detail::EncodingType::None);
  1805. #endif
  1806. }
  1807. TEST(ParseAcceptEncoding3, AcceptEncoding) {
  1808. Request req;
  1809. req.set_header("Accept-Encoding",
  1810. "br;q=1.0, gzip;q=0.8, zstd;q=0.8, *;q=0.1");
  1811. Response res;
  1812. res.set_header("Content-Type", "text/plain");
  1813. auto ret = detail::encoding_type(req, res);
  1814. #ifdef CPPHTTPLIB_BROTLI_SUPPORT
  1815. EXPECT_TRUE(ret == detail::EncodingType::Brotli);
  1816. #elif CPPHTTPLIB_ZLIB_SUPPORT
  1817. EXPECT_TRUE(ret == detail::EncodingType::Gzip);
  1818. #elif CPPHTTPLIB_ZSTD_SUPPORT
  1819. EXPECT_TRUE(ret == detail::EncodingType::Zstd);
  1820. #else
  1821. EXPECT_TRUE(ret == detail::EncodingType::None);
  1822. #endif
  1823. }
  1824. TEST(ParseAcceptEncoding4, AcceptEncodingQZero) {
  1825. // All supported encodings rejected with q=0 should return None
  1826. Request req;
  1827. req.set_header("Accept-Encoding", "gzip;q=0, br;q=0, zstd;q=0, deflate");
  1828. Response res;
  1829. res.set_header("Content-Type", "text/plain");
  1830. auto ret = detail::encoding_type(req, res);
  1831. EXPECT_TRUE(ret == detail::EncodingType::None);
  1832. }
  1833. TEST(ParseAcceptEncoding5, AcceptEncodingQZeroVariants) {
  1834. // q=0.0, q=0.00, q=0.000 should also be treated as rejected
  1835. Request req;
  1836. req.set_header("Accept-Encoding", "gzip;q=0.000, br;q=0.0, zstd;q=0.00");
  1837. Response res;
  1838. res.set_header("Content-Type", "text/plain");
  1839. auto ret = detail::encoding_type(req, res);
  1840. EXPECT_TRUE(ret == detail::EncodingType::None);
  1841. }
  1842. TEST(ParseAcceptEncodingTest, RejectsTrailingQualityCharacters) {
  1843. Request req;
  1844. req.set_header("Accept-Encoding", "gzip;q=0.5junk");
  1845. Response res;
  1846. res.set_header("Content-Type", "text/plain");
  1847. EXPECT_EQ(detail::EncodingType::None, detail::encoding_type(req, res));
  1848. }
  1849. TEST(ParseAcceptEncoding6, AcceptEncodingXGzipQZero) {
  1850. // x-gzip;q=0 should not cause "gzip" to be incorrectly detected
  1851. Request req;
  1852. req.set_header("Accept-Encoding", "x-gzip;q=0");
  1853. Response res;
  1854. res.set_header("Content-Type", "text/plain");
  1855. auto ret = detail::encoding_type(req, res);
  1856. EXPECT_TRUE(ret == detail::EncodingType::None);
  1857. }
  1858. TEST(ParseAcceptEncoding7, AcceptEncodingCaseInsensitive) {
  1859. // RFC 7231: Accept-Encoding values are case-insensitive
  1860. Request req;
  1861. req.set_header("Accept-Encoding", "GZIP, BR, ZSTD");
  1862. Response res;
  1863. res.set_header("Content-Type", "text/plain");
  1864. auto ret = detail::encoding_type(req, res);
  1865. #ifdef CPPHTTPLIB_BROTLI_SUPPORT
  1866. EXPECT_TRUE(ret == detail::EncodingType::Brotli);
  1867. #elif CPPHTTPLIB_ZLIB_SUPPORT
  1868. EXPECT_TRUE(ret == detail::EncodingType::Gzip);
  1869. #elif CPPHTTPLIB_ZSTD_SUPPORT
  1870. EXPECT_TRUE(ret == detail::EncodingType::Zstd);
  1871. #else
  1872. EXPECT_TRUE(ret == detail::EncodingType::None);
  1873. #endif
  1874. }
  1875. TEST(ParseAcceptEncoding8, AcceptEncodingQValuePriority) {
  1876. // q value should determine priority, not hardcoded order
  1877. Request req;
  1878. req.set_header("Accept-Encoding", "br;q=0.5, gzip;q=1.0, zstd;q=0.8");
  1879. Response res;
  1880. res.set_header("Content-Type", "text/plain");
  1881. auto ret = detail::encoding_type(req, res);
  1882. // gzip has highest q=1.0, so it should be selected even though
  1883. // br and zstd are also supported
  1884. #ifdef CPPHTTPLIB_ZLIB_SUPPORT
  1885. EXPECT_TRUE(ret == detail::EncodingType::Gzip);
  1886. #elif CPPHTTPLIB_ZSTD_SUPPORT
  1887. EXPECT_TRUE(ret == detail::EncodingType::Zstd);
  1888. #elif CPPHTTPLIB_BROTLI_SUPPORT
  1889. EXPECT_TRUE(ret == detail::EncodingType::Brotli);
  1890. #else
  1891. EXPECT_TRUE(ret == detail::EncodingType::None);
  1892. #endif
  1893. }
  1894. TEST(BufferStreamTest, read) {
  1895. detail::BufferStream strm1;
  1896. Stream &strm = strm1;
  1897. EXPECT_EQ(5, strm.write("hello"));
  1898. char buf[512];
  1899. EXPECT_EQ(2, strm.read(buf, 2));
  1900. EXPECT_EQ('h', buf[0]);
  1901. EXPECT_EQ('e', buf[1]);
  1902. EXPECT_EQ(2, strm.read(buf, 2));
  1903. EXPECT_EQ('l', buf[0]);
  1904. EXPECT_EQ('l', buf[1]);
  1905. EXPECT_EQ(1, strm.read(buf, 1));
  1906. EXPECT_EQ('o', buf[0]);
  1907. EXPECT_EQ(0, strm.read(buf, 1));
  1908. }
  1909. TEST(HostnameToIPConversionTest, HTTPWatch_Online) {
  1910. auto host = "www.httpwatch.com";
  1911. auto ip = hosted_at(host);
  1912. EXPECT_EQ("23.96.13.243", ip);
  1913. std::vector<std::string> addrs;
  1914. hosted_at(host, addrs);
  1915. EXPECT_EQ(1u, addrs.size());
  1916. }
  1917. #if 0 // It depends on each test environment...
  1918. TEST(HostnameToIPConversionTest, YouTube_Online) {
  1919. auto host = "www.youtube.com";
  1920. std::vector<std::string> addrs;
  1921. hosted_at(host, addrs);
  1922. EXPECT_EQ(20u, addrs.size());
  1923. auto it = std::find(addrs.begin(), addrs.end(), "2607:f8b0:4006:809::200e");
  1924. EXPECT_TRUE(it != addrs.end());
  1925. }
  1926. #endif
  1927. class ChunkedEncodingTest : public ::testing::Test {
  1928. protected:
  1929. ChunkedEncodingTest()
  1930. : cli_(HOST, PORT)
  1931. #ifdef CPPHTTPLIB_SSL_ENABLED
  1932. ,
  1933. svr_(SERVER_CERT_FILE, SERVER_PRIVATE_KEY_FILE)
  1934. #endif
  1935. {
  1936. cli_.set_connection_timeout(2);
  1937. #ifdef CPPHTTPLIB_SSL_ENABLED
  1938. cli_.enable_server_certificate_verification(false);
  1939. #endif
  1940. }
  1941. virtual void SetUp() {
  1942. read_file("./image.jpg", image_data_);
  1943. svr_.Get("/hi", [&](const Request & /*req*/, Response &res) {
  1944. res.set_content("Hello World!", "text/plain");
  1945. });
  1946. svr_.Get(
  1947. "/chunked", [this](const httplib::Request &, httplib::Response &res) {
  1948. res.set_chunked_content_provider(
  1949. "image/jpeg", [this](size_t offset, httplib::DataSink &sink) {
  1950. size_t remaining = image_data_.size() - offset;
  1951. if (remaining == 0) {
  1952. sink.done();
  1953. } else {
  1954. constexpr size_t CHUNK_SIZE = 1024;
  1955. size_t send_size = std::min(CHUNK_SIZE, remaining);
  1956. sink.write(&image_data_[offset], send_size);
  1957. std::this_thread::sleep_for(std::chrono::milliseconds(10));
  1958. }
  1959. return true;
  1960. });
  1961. });
  1962. t_ = thread([&]() { ASSERT_TRUE(svr_.listen(HOST, PORT)); });
  1963. svr_.wait_until_ready();
  1964. }
  1965. virtual void TearDown() {
  1966. svr_.stop();
  1967. if (!request_threads_.empty()) {
  1968. std::this_thread::sleep_for(std::chrono::seconds(1));
  1969. for (auto &t : request_threads_) {
  1970. t.join();
  1971. }
  1972. }
  1973. t_.join();
  1974. }
  1975. #ifdef CPPHTTPLIB_SSL_ENABLED
  1976. SSLClient cli_;
  1977. SSLServer svr_;
  1978. #else
  1979. Client cli_;
  1980. Server svr_;
  1981. #endif
  1982. thread t_;
  1983. std::vector<thread> request_threads_;
  1984. std::string image_data_;
  1985. };
  1986. TEST_F(ChunkedEncodingTest, NormalGet) {
  1987. auto res = cli_.Get("/chunked");
  1988. ASSERT_TRUE(res) << "Error: " << to_string(res.error());
  1989. std::string out;
  1990. read_file("./image.jpg", out);
  1991. EXPECT_EQ(StatusCode::OK_200, res->status);
  1992. EXPECT_EQ(out, res->body);
  1993. }
  1994. TEST_F(ChunkedEncodingTest, WithContentReceiver) {
  1995. std::string body;
  1996. auto res = cli_.Get("/chunked", [&](const char *data, size_t data_length) {
  1997. body.append(data, data_length);
  1998. return true;
  1999. });
  2000. ASSERT_TRUE(res) << "Error: " << to_string(res.error());
  2001. std::string out;
  2002. read_file("./image.jpg", out);
  2003. EXPECT_EQ(StatusCode::OK_200, res->status);
  2004. EXPECT_EQ(out, body);
  2005. }
  2006. TEST_F(ChunkedEncodingTest, WithResponseHandlerAndContentReceiver) {
  2007. std::string body;
  2008. auto res = cli_.Get(
  2009. "/chunked",
  2010. [&](const Response &response) {
  2011. EXPECT_EQ(StatusCode::OK_200, response.status);
  2012. return true;
  2013. },
  2014. [&](const char *data, size_t data_length) {
  2015. body.append(data, data_length);
  2016. return true;
  2017. });
  2018. ASSERT_TRUE(res) << "Error: " << to_string(res.error());
  2019. std::string out;
  2020. read_file("./image.jpg", out);
  2021. EXPECT_EQ(StatusCode::OK_200, res->status);
  2022. EXPECT_EQ(out, body);
  2023. }
  2024. TEST(RangeTest, FromHTTPBin_Online) {
  2025. auto host = "httpbingo.org";
  2026. auto path = std::string{"/range/32"};
  2027. #ifdef CPPHTTPLIB_SSL_ENABLED
  2028. auto port = 443;
  2029. SSLClient cli(host, port);
  2030. #else
  2031. auto port = 80;
  2032. Client cli(host, port);
  2033. #endif
  2034. cli.set_connection_timeout(5);
  2035. {
  2036. auto res = cli.Get(path);
  2037. ASSERT_TRUE(res) << "Error: " << to_string(res.error());
  2038. EXPECT_EQ("abcdefghijklmnopqrstuvwxyzabcdef", res->body);
  2039. EXPECT_EQ(StatusCode::OK_200, res->status);
  2040. }
  2041. {
  2042. Headers headers = {make_range_header({{1, -1}})};
  2043. auto res = cli.Get(path, headers);
  2044. ASSERT_TRUE(res) << "Error: " << to_string(res.error());
  2045. EXPECT_EQ("bcdefghijklmnopqrstuvwxyzabcdef", res->body);
  2046. EXPECT_EQ(StatusCode::PartialContent_206, res->status);
  2047. }
  2048. {
  2049. Headers headers = {make_range_header({{1, 10}})};
  2050. auto res = cli.Get(path, headers);
  2051. ASSERT_TRUE(res) << "Error: " << to_string(res.error());
  2052. EXPECT_EQ("bcdefghijk", res->body);
  2053. EXPECT_EQ(StatusCode::PartialContent_206, res->status);
  2054. }
  2055. // go-httpbin (httpbingo.org) returns 206 even when the range covers the
  2056. // entire resource, while the original httpbin returned 200. Both are
  2057. // acceptable per RFC 9110 §15.3.7, so we accept either status code.
  2058. {
  2059. Headers headers = {make_range_header({{0, 31}})};
  2060. auto res = cli.Get(path, headers);
  2061. ASSERT_TRUE(res) << "Error: " << to_string(res.error());
  2062. EXPECT_EQ("abcdefghijklmnopqrstuvwxyzabcdef", res->body);
  2063. EXPECT_TRUE(res->status == StatusCode::OK_200 ||
  2064. res->status == StatusCode::PartialContent_206);
  2065. }
  2066. {
  2067. Headers headers = {make_range_header({{0, -1}})};
  2068. auto res = cli.Get(path, headers);
  2069. ASSERT_TRUE(res) << "Error: " << to_string(res.error());
  2070. EXPECT_EQ("abcdefghijklmnopqrstuvwxyzabcdef", res->body);
  2071. EXPECT_TRUE(res->status == StatusCode::OK_200 ||
  2072. res->status == StatusCode::PartialContent_206);
  2073. }
  2074. // go-httpbin returns 206 with clamped range for over-range requests,
  2075. // while the original httpbin returned 416. Both behaviors are observed
  2076. // in real servers, so we only verify the request succeeds.
  2077. {
  2078. Headers headers = {make_range_header({{0, 32}})};
  2079. auto res = cli.Get(path, headers);
  2080. ASSERT_TRUE(res) << "Error: " << to_string(res.error());
  2081. }
  2082. }
  2083. TEST(GetAddrInfoDanglingRefTest, LongTimeout) {
  2084. auto host = "unresolvableaddress.local";
  2085. auto path = std::string{"/"};
  2086. #ifdef CPPHTTPLIB_SSL_ENABLED
  2087. auto port = 443;
  2088. SSLClient cli(host, port);
  2089. #else
  2090. auto port = 80;
  2091. Client cli(host, port);
  2092. #endif
  2093. cli.set_connection_timeout(1);
  2094. {
  2095. auto res = cli.Get(path);
  2096. ASSERT_FALSE(res);
  2097. }
  2098. std::this_thread::sleep_for(std::chrono::seconds(8));
  2099. }
  2100. #if defined(__linux__) && defined(__GLIBC__) && \
  2101. defined(CPPHTTPLIB_USE_NON_BLOCKING_GETADDRINFO)
  2102. // Forward declaration: in split builds split.py strips `inline` and moves the
  2103. // definition into httplib.cc, so detail::getaddrinfo_with_timeout is not
  2104. // visible from the public httplib.h. Re-declaring it here lets the tests link
  2105. // against the symbol in both header-only and split builds.
  2106. namespace httplib {
  2107. namespace detail {
  2108. int getaddrinfo_with_timeout(const char *node, const char *service,
  2109. const struct addrinfo *hints,
  2110. struct addrinfo **res, time_t timeout_sec);
  2111. } // namespace detail
  2112. } // namespace httplib
  2113. // Reproducer for https://github.com/yhirose/cpp-httplib/issues/2431.
  2114. //
  2115. // On Linux/glibc, getaddrinfo_with_timeout() runs the lookup via
  2116. // getaddrinfo_a(GAI_NOWAIT) using a stack-local `struct gaicb`. When the
  2117. // gai_suspend() call hits the connection timeout the function calls
  2118. // gai_cancel() and returns immediately. gai_cancel() is non-blocking and
  2119. // can return EAI_NOTCANCELED, in which case the resolver worker thread is
  2120. // still alive and still references the now-destroyed stack frame.
  2121. //
  2122. // Triggering the bug requires DNS to actually hang (UDP/53 dropped, etc.),
  2123. // so these tests are gated on CPPHTTPLIB_TEST_ISSUE_2431=1 and are skipped
  2124. // during normal runs. test/run_issue_2431_repro.sh sets up the environment
  2125. // and runs them in a container.
  2126. namespace {
  2127. bool should_run_issue_2431_tests() {
  2128. const char *v = getenv("CPPHTTPLIB_TEST_ISSUE_2431");
  2129. return v && *v && std::string(v) != "0";
  2130. }
  2131. std::string unique_unresolvable_host(int n) {
  2132. // .invalid is reserved (RFC 6761) and is never served by real DNS, but
  2133. // glibc still asks the configured nameserver — which is exactly the path
  2134. // we want to exercise. A unique label per call avoids the resolver cache.
  2135. auto t = std::chrono::steady_clock::now().time_since_epoch().count();
  2136. return "h-" + std::to_string(::getpid()) + "-" + std::to_string(t) + "-" +
  2137. std::to_string(n) + ".invalid";
  2138. }
  2139. } // namespace
  2140. TEST(GetAddrInfoAsyncCancelTest, DirectCallSingleThread) {
  2141. if (!should_run_issue_2431_tests()) {
  2142. GTEST_SKIP()
  2143. << "Set CPPHTTPLIB_TEST_ISSUE_2431=1 (and sinkhole DNS) to run";
  2144. }
  2145. for (int i = 0; i < 8; ++i) {
  2146. struct addrinfo hints;
  2147. memset(&hints, 0, sizeof(hints));
  2148. hints.ai_family = AF_UNSPEC;
  2149. hints.ai_socktype = SOCK_STREAM;
  2150. auto host = unique_unresolvable_host(i);
  2151. struct addrinfo *result = nullptr;
  2152. int rc = detail::getaddrinfo_with_timeout(host.c_str(), "80", &hints,
  2153. &result, /*timeout_sec=*/1);
  2154. if (rc == 0 && result) { freeaddrinfo(result); }
  2155. }
  2156. // Give orphaned getaddrinfo_a worker threads a chance to write into the
  2157. // stack region they still believe holds their gaicb.
  2158. std::this_thread::sleep_for(std::chrono::seconds(3));
  2159. }
  2160. TEST(GetAddrInfoAsyncCancelTest, DirectCallMultiThread) {
  2161. if (!should_run_issue_2431_tests()) {
  2162. GTEST_SKIP()
  2163. << "Set CPPHTTPLIB_TEST_ISSUE_2431=1 (and sinkhole DNS) to run";
  2164. }
  2165. std::atomic<bool> stop{false};
  2166. std::vector<std::thread> threads;
  2167. for (int t = 0; t < 8; ++t) {
  2168. threads.emplace_back([t, &stop] {
  2169. int i = 0;
  2170. while (!stop.load(std::memory_order_relaxed)) {
  2171. struct addrinfo hints;
  2172. memset(&hints, 0, sizeof(hints));
  2173. hints.ai_family = AF_UNSPEC;
  2174. hints.ai_socktype = SOCK_STREAM;
  2175. auto host = unique_unresolvable_host(t * 100000 + i++);
  2176. struct addrinfo *result = nullptr;
  2177. int rc = detail::getaddrinfo_with_timeout(host.c_str(), "80", &hints,
  2178. &result, /*timeout_sec=*/1);
  2179. if (rc == 0 && result) { freeaddrinfo(result); }
  2180. }
  2181. });
  2182. }
  2183. std::this_thread::sleep_for(std::chrono::seconds(8));
  2184. stop.store(true, std::memory_order_relaxed);
  2185. for (auto &th : threads) {
  2186. th.join();
  2187. }
  2188. std::this_thread::sleep_for(std::chrono::seconds(3));
  2189. }
  2190. TEST(GetAddrInfoAsyncCancelTest, ClientGetMultiThread) {
  2191. if (!should_run_issue_2431_tests()) {
  2192. GTEST_SKIP()
  2193. << "Set CPPHTTPLIB_TEST_ISSUE_2431=1 (and sinkhole DNS) to run";
  2194. }
  2195. std::atomic<bool> stop{false};
  2196. std::vector<std::thread> threads;
  2197. for (int t = 0; t < 8; ++t) {
  2198. threads.emplace_back([t, &stop] {
  2199. int i = 0;
  2200. while (!stop.load(std::memory_order_relaxed)) {
  2201. auto host = unique_unresolvable_host(t * 100000 + i++);
  2202. Client cli(host, 80);
  2203. cli.set_connection_timeout(1, 0);
  2204. cli.set_read_timeout(1, 0);
  2205. cli.set_write_timeout(1, 0);
  2206. (void)cli.Get("/");
  2207. }
  2208. });
  2209. }
  2210. std::this_thread::sleep_for(std::chrono::seconds(8));
  2211. stop.store(true, std::memory_order_relaxed);
  2212. for (auto &th : threads) {
  2213. th.join();
  2214. }
  2215. std::this_thread::sleep_for(std::chrono::seconds(3));
  2216. }
  2217. #endif // __linux__ && __GLIBC__ && CPPHTTPLIB_USE_NON_BLOCKING_GETADDRINFO
  2218. TEST(ConnectionErrorTest, InvalidHost) {
  2219. auto host = "-abcde.com";
  2220. #ifdef CPPHTTPLIB_SSL_ENABLED
  2221. auto port = 443;
  2222. SSLClient cli(host, port);
  2223. #else
  2224. auto port = 80;
  2225. Client cli(host, port);
  2226. #endif
  2227. cli.set_connection_timeout(std::chrono::seconds(2));
  2228. auto res = cli.Get("/");
  2229. ASSERT_TRUE(!res);
  2230. EXPECT_EQ(Error::Connection, res.error());
  2231. }
  2232. TEST(ConnectionErrorTest, InvalidHost2) {
  2233. auto host = "httpcan.org/";
  2234. #ifdef CPPHTTPLIB_SSL_ENABLED
  2235. SSLClient cli(host);
  2236. #else
  2237. Client cli(host);
  2238. #endif
  2239. cli.set_connection_timeout(std::chrono::seconds(2));
  2240. auto res = cli.Get("/");
  2241. ASSERT_TRUE(!res);
  2242. EXPECT_EQ(Error::Connection, res.error());
  2243. }
  2244. TEST(ConnectionErrorTest, InvalidHostCheckResultErrorToString) {
  2245. auto host = "httpcan.org/";
  2246. #ifdef CPPHTTPLIB_SSL_ENABLED
  2247. SSLClient cli(host);
  2248. #else
  2249. Client cli(host);
  2250. #endif
  2251. cli.set_connection_timeout(std::chrono::seconds(2));
  2252. auto res = cli.Get("/");
  2253. ASSERT_TRUE(!res);
  2254. stringstream s;
  2255. s << "error code: " << res.error();
  2256. EXPECT_EQ("error code: Could not establish connection (2)", s.str());
  2257. }
  2258. TEST(ConnectionErrorTest, InvalidPort) {
  2259. auto host = "localhost";
  2260. auto port = 44380;
  2261. #ifdef CPPHTTPLIB_SSL_ENABLED
  2262. SSLClient cli(host, port);
  2263. #else
  2264. Client cli(host, port);
  2265. #endif
  2266. cli.set_connection_timeout(std::chrono::seconds(2));
  2267. auto res = cli.Get("/");
  2268. ASSERT_TRUE(!res);
  2269. EXPECT_TRUE(Error::Connection == res.error() ||
  2270. Error::ConnectionTimeout == res.error());
  2271. }
  2272. TEST(ConnectionErrorTest, Timeout_Online) {
  2273. auto host = "google.com";
  2274. #ifdef CPPHTTPLIB_SSL_ENABLED
  2275. auto port = 44380;
  2276. SSLClient cli(host, port);
  2277. #else
  2278. auto port = 8080;
  2279. Client cli(host, port);
  2280. #endif
  2281. cli.set_connection_timeout(std::chrono::seconds(2));
  2282. // only probe one address type so that the error reason
  2283. // correlates to the timed-out IPv4, not the unsupported
  2284. // IPv6 connection attempt
  2285. cli.set_address_family(AF_INET);
  2286. auto res = cli.Get("/");
  2287. ASSERT_TRUE(!res);
  2288. EXPECT_EQ(Error::ConnectionTimeout, res.error());
  2289. }
  2290. TEST(CancelTest, NoCancel_Online) {
  2291. auto host = "httpbingo.org";
  2292. auto path = std::string{"/range/32"};
  2293. #ifdef CPPHTTPLIB_SSL_ENABLED
  2294. auto port = 443;
  2295. SSLClient cli(host, port);
  2296. #else
  2297. auto port = 80;
  2298. Client cli(host, port);
  2299. #endif
  2300. cli.set_connection_timeout(std::chrono::seconds(5));
  2301. auto res = cli.Get(path, [](uint64_t, uint64_t) { return true; });
  2302. ASSERT_TRUE(res) << "Error: " << to_string(res.error());
  2303. EXPECT_EQ("abcdefghijklmnopqrstuvwxyzabcdef", res->body);
  2304. EXPECT_EQ(StatusCode::OK_200, res->status);
  2305. }
  2306. TEST(CancelTest, WithCancelSmallPayload_Online) {
  2307. // Use /bytes with a large payload so that the DownloadProgress callback
  2308. // (which only fires for Content-Length responses) is invoked before the
  2309. // entire body is received, giving cancellation a chance to fire.
  2310. auto host = "httpbingo.org";
  2311. auto path = std::string{"/bytes/524288"};
  2312. #ifdef CPPHTTPLIB_SSL_ENABLED
  2313. auto port = 443;
  2314. SSLClient cli(host, port);
  2315. #else
  2316. auto port = 80;
  2317. Client cli(host, port);
  2318. #endif
  2319. auto res = cli.Get(path, [](uint64_t, uint64_t) { return false; });
  2320. cli.set_connection_timeout(std::chrono::seconds(5));
  2321. ASSERT_TRUE(!res);
  2322. EXPECT_EQ(Error::Canceled, res.error());
  2323. }
  2324. TEST(CancelTest, WithCancelLargePayload_Online) {
  2325. auto host = "httpbingo.org";
  2326. auto path = std::string{"/bytes/524288"};
  2327. #ifdef CPPHTTPLIB_SSL_ENABLED
  2328. auto port = 443;
  2329. SSLClient cli(host, port);
  2330. #else
  2331. auto port = 80;
  2332. Client cli(host, port);
  2333. #endif
  2334. cli.set_connection_timeout(std::chrono::seconds(5));
  2335. uint32_t count = 0;
  2336. auto res =
  2337. cli.Get(path, [&count](uint64_t, uint64_t) { return (count++ == 0); });
  2338. ASSERT_TRUE(!res);
  2339. EXPECT_EQ(Error::Canceled, res.error());
  2340. }
  2341. TEST(CancelTest, NoCancelPost) {
  2342. Server svr;
  2343. svr.Post("/", [&](const Request & /*req*/, Response &res) {
  2344. res.set_content("Hello World!", "text/plain");
  2345. });
  2346. auto thread = std::thread([&]() { svr.listen(HOST, PORT); });
  2347. auto se = detail::scope_exit([&] {
  2348. svr.stop();
  2349. thread.join();
  2350. ASSERT_FALSE(svr.is_running());
  2351. });
  2352. svr.wait_until_ready();
  2353. Client cli(HOST, PORT);
  2354. cli.set_connection_timeout(std::chrono::seconds(5));
  2355. auto res =
  2356. cli.Post("/", Headers(), JSON_DATA.data(), JSON_DATA.size(),
  2357. "application/json", [](uint64_t, uint64_t) { return true; });
  2358. ASSERT_TRUE(res) << "Error: " << to_string(res.error());
  2359. EXPECT_EQ("Hello World!", res->body);
  2360. EXPECT_EQ(StatusCode::OK_200, res->status);
  2361. }
  2362. TEST(CancelTest, WithCancelSmallPayloadPost) {
  2363. Server svr;
  2364. svr.Post("/", [&](const Request & /*req*/, Response &res) {
  2365. res.set_content("Hello World!", "text/plain");
  2366. });
  2367. auto thread = std::thread([&]() { svr.listen(HOST, PORT); });
  2368. auto se = detail::scope_exit([&] {
  2369. svr.stop();
  2370. thread.join();
  2371. ASSERT_FALSE(svr.is_running());
  2372. });
  2373. svr.wait_until_ready();
  2374. Client cli(HOST, PORT);
  2375. cli.set_connection_timeout(std::chrono::seconds(5));
  2376. auto res =
  2377. cli.Post("/", Headers(), JSON_DATA.data(), JSON_DATA.size(),
  2378. "application/json", [](uint64_t, uint64_t) { return false; });
  2379. ASSERT_TRUE(!res);
  2380. EXPECT_EQ(Error::Canceled, res.error());
  2381. }
  2382. TEST(CancelTest, WithCancelLargePayloadPost) {
  2383. Server svr;
  2384. svr.set_payload_max_length(200 * 1024 * 1024);
  2385. svr.Post("/", [&](const Request & /*req*/, Response &res) {
  2386. res.set_content(LARGE_DATA, "text/plain");
  2387. });
  2388. auto thread = std::thread([&]() { svr.listen(HOST, PORT); });
  2389. auto se = detail::scope_exit([&] {
  2390. svr.stop();
  2391. thread.join();
  2392. ASSERT_FALSE(svr.is_running());
  2393. });
  2394. svr.wait_until_ready();
  2395. Client cli(HOST, PORT);
  2396. cli.set_payload_max_length(200 * 1024 * 1024);
  2397. cli.set_connection_timeout(std::chrono::seconds(5));
  2398. auto res =
  2399. cli.Post("/", Headers(), JSON_DATA.data(), JSON_DATA.size(),
  2400. "application/json", [](uint64_t, uint64_t) { return false; });
  2401. ASSERT_TRUE(!res);
  2402. EXPECT_EQ(Error::Canceled, res.error());
  2403. }
  2404. TEST(CancelTest, NoCancelPut) {
  2405. Server svr;
  2406. svr.Put("/", [&](const Request & /*req*/, Response &res) {
  2407. res.set_content("Hello World!", "text/plain");
  2408. });
  2409. auto thread = std::thread([&]() { svr.listen(HOST, PORT); });
  2410. auto se = detail::scope_exit([&] {
  2411. svr.stop();
  2412. thread.join();
  2413. ASSERT_FALSE(svr.is_running());
  2414. });
  2415. svr.wait_until_ready();
  2416. Client cli(HOST, PORT);
  2417. cli.set_connection_timeout(std::chrono::seconds(5));
  2418. auto res =
  2419. cli.Put("/", Headers(), JSON_DATA.data(), JSON_DATA.size(),
  2420. "application/json", [](uint64_t, uint64_t) { return true; });
  2421. ASSERT_TRUE(res) << "Error: " << to_string(res.error());
  2422. EXPECT_EQ("Hello World!", res->body);
  2423. EXPECT_EQ(StatusCode::OK_200, res->status);
  2424. }
  2425. TEST(CancelTest, WithCancelSmallPayloadPut) {
  2426. Server svr;
  2427. svr.Put("/", [&](const Request & /*req*/, Response &res) {
  2428. res.set_content("Hello World!", "text/plain");
  2429. });
  2430. auto thread = std::thread([&]() { svr.listen(HOST, PORT); });
  2431. auto se = detail::scope_exit([&] {
  2432. svr.stop();
  2433. thread.join();
  2434. ASSERT_FALSE(svr.is_running());
  2435. });
  2436. svr.wait_until_ready();
  2437. Client cli(HOST, PORT);
  2438. cli.set_connection_timeout(std::chrono::seconds(5));
  2439. auto res =
  2440. cli.Put("/", Headers(), JSON_DATA.data(), JSON_DATA.size(),
  2441. "application/json", [](uint64_t, uint64_t) { return false; });
  2442. ASSERT_TRUE(!res);
  2443. EXPECT_EQ(Error::Canceled, res.error());
  2444. }
  2445. TEST(CancelTest, WithCancelLargePayloadPut) {
  2446. Server svr;
  2447. svr.set_payload_max_length(200 * 1024 * 1024);
  2448. svr.Put("/", [&](const Request & /*req*/, Response &res) {
  2449. res.set_content(LARGE_DATA, "text/plain");
  2450. });
  2451. auto thread = std::thread([&]() { svr.listen(HOST, PORT); });
  2452. auto se = detail::scope_exit([&] {
  2453. svr.stop();
  2454. thread.join();
  2455. ASSERT_FALSE(svr.is_running());
  2456. });
  2457. svr.wait_until_ready();
  2458. Client cli(HOST, PORT);
  2459. cli.set_payload_max_length(200 * 1024 * 1024);
  2460. cli.set_connection_timeout(std::chrono::seconds(5));
  2461. auto res =
  2462. cli.Put("/", Headers(), JSON_DATA.data(), JSON_DATA.size(),
  2463. "application/json", [](uint64_t, uint64_t) { return false; });
  2464. ASSERT_TRUE(!res);
  2465. EXPECT_EQ(Error::Canceled, res.error());
  2466. }
  2467. TEST(CancelTest, NoCancelPatch) {
  2468. Server svr;
  2469. svr.Patch("/", [&](const Request & /*req*/, Response &res) {
  2470. res.set_content("Hello World!", "text/plain");
  2471. });
  2472. auto thread = std::thread([&]() { svr.listen(HOST, PORT); });
  2473. auto se = detail::scope_exit([&] {
  2474. svr.stop();
  2475. thread.join();
  2476. ASSERT_FALSE(svr.is_running());
  2477. });
  2478. svr.wait_until_ready();
  2479. Client cli(HOST, PORT);
  2480. cli.set_connection_timeout(std::chrono::seconds(5));
  2481. auto res =
  2482. cli.Patch("/", Headers(), JSON_DATA.data(), JSON_DATA.size(),
  2483. "application/json", [](uint64_t, uint64_t) { return true; });
  2484. ASSERT_TRUE(res) << "Error: " << to_string(res.error());
  2485. EXPECT_EQ("Hello World!", res->body);
  2486. EXPECT_EQ(StatusCode::OK_200, res->status);
  2487. }
  2488. TEST(CancelTest, WithCancelSmallPayloadPatch) {
  2489. Server svr;
  2490. svr.Patch("/", [&](const Request & /*req*/, Response &res) {
  2491. res.set_content("Hello World!", "text/plain");
  2492. });
  2493. auto thread = std::thread([&]() { svr.listen(HOST, PORT); });
  2494. auto se = detail::scope_exit([&] {
  2495. svr.stop();
  2496. thread.join();
  2497. ASSERT_FALSE(svr.is_running());
  2498. });
  2499. svr.wait_until_ready();
  2500. Client cli(HOST, PORT);
  2501. cli.set_connection_timeout(std::chrono::seconds(5));
  2502. auto res =
  2503. cli.Patch("/", Headers(), JSON_DATA.data(), JSON_DATA.size(),
  2504. "application/json", [](uint64_t, uint64_t) { return false; });
  2505. ASSERT_TRUE(!res);
  2506. EXPECT_EQ(Error::Canceled, res.error());
  2507. }
  2508. TEST(CancelTest, WithCancelLargePayloadPatch) {
  2509. Server svr;
  2510. svr.set_payload_max_length(200 * 1024 * 1024);
  2511. svr.Patch("/", [&](const Request & /*req*/, Response &res) {
  2512. res.set_content(LARGE_DATA, "text/plain");
  2513. });
  2514. auto thread = std::thread([&]() { svr.listen(HOST, PORT); });
  2515. auto se = detail::scope_exit([&] {
  2516. svr.stop();
  2517. thread.join();
  2518. ASSERT_FALSE(svr.is_running());
  2519. });
  2520. svr.wait_until_ready();
  2521. Client cli(HOST, PORT);
  2522. cli.set_payload_max_length(200 * 1024 * 1024);
  2523. cli.set_connection_timeout(std::chrono::seconds(5));
  2524. auto res =
  2525. cli.Patch("/", Headers(), JSON_DATA.data(), JSON_DATA.size(),
  2526. "application/json", [](uint64_t, uint64_t) { return false; });
  2527. ASSERT_TRUE(!res);
  2528. EXPECT_EQ(Error::Canceled, res.error());
  2529. }
  2530. TEST(CancelTest, NoCancelDelete) {
  2531. Server svr;
  2532. svr.Delete("/", [&](const Request & /*req*/, Response &res) {
  2533. res.set_content("Hello World!", "text/plain");
  2534. });
  2535. auto thread = std::thread([&]() { svr.listen(HOST, PORT); });
  2536. auto se = detail::scope_exit([&] {
  2537. svr.stop();
  2538. thread.join();
  2539. ASSERT_FALSE(svr.is_running());
  2540. });
  2541. svr.wait_until_ready();
  2542. Client cli(HOST, PORT);
  2543. cli.set_connection_timeout(std::chrono::seconds(5));
  2544. auto res =
  2545. cli.Delete("/", Headers(), JSON_DATA.data(), JSON_DATA.size(),
  2546. "application/json", [](uint64_t, uint64_t) { return true; });
  2547. ASSERT_TRUE(res) << "Error: " << to_string(res.error());
  2548. EXPECT_EQ("Hello World!", res->body);
  2549. EXPECT_EQ(StatusCode::OK_200, res->status);
  2550. }
  2551. TEST(CancelTest, WithCancelSmallPayloadDelete) {
  2552. Server svr;
  2553. svr.Delete("/", [&](const Request & /*req*/, Response &res) {
  2554. res.set_content("Hello World!", "text/plain");
  2555. });
  2556. auto thread = std::thread([&]() { svr.listen(HOST, PORT); });
  2557. auto se = detail::scope_exit([&] {
  2558. svr.stop();
  2559. thread.join();
  2560. ASSERT_FALSE(svr.is_running());
  2561. });
  2562. svr.wait_until_ready();
  2563. Client cli(HOST, PORT);
  2564. cli.set_connection_timeout(std::chrono::seconds(5));
  2565. auto res =
  2566. cli.Delete("/", Headers(), JSON_DATA.data(), JSON_DATA.size(),
  2567. "application/json", [](uint64_t, uint64_t) { return false; });
  2568. ASSERT_TRUE(!res);
  2569. EXPECT_EQ(Error::Canceled, res.error());
  2570. }
  2571. TEST(CancelTest, WithCancelLargePayloadDelete) {
  2572. Server svr;
  2573. svr.set_payload_max_length(200 * 1024 * 1024);
  2574. svr.Delete("/", [&](const Request & /*req*/, Response &res) {
  2575. res.set_content(LARGE_DATA, "text/plain");
  2576. });
  2577. auto thread = std::thread([&]() { svr.listen(HOST, PORT); });
  2578. auto se = detail::scope_exit([&] {
  2579. svr.stop();
  2580. thread.join();
  2581. ASSERT_FALSE(svr.is_running());
  2582. });
  2583. svr.wait_until_ready();
  2584. Client cli(HOST, PORT);
  2585. cli.set_payload_max_length(200 * 1024 * 1024);
  2586. cli.set_connection_timeout(std::chrono::seconds(5));
  2587. auto res =
  2588. cli.Delete("/", Headers(), JSON_DATA.data(), JSON_DATA.size(),
  2589. "application/json", [](uint64_t, uint64_t) { return false; });
  2590. ASSERT_TRUE(!res);
  2591. EXPECT_EQ(Error::Canceled, res.error());
  2592. }
  2593. static std::string remove_whitespace(const std::string &input) {
  2594. std::string output;
  2595. output.reserve(input.size());
  2596. std::copy_if(input.begin(), input.end(), std::back_inserter(output),
  2597. [](unsigned char c) { return !std::isspace(c); });
  2598. return output;
  2599. }
  2600. TEST(BaseAuthTest, FromHTTPWatch_Online) {
  2601. auto host = "httpbingo.org";
  2602. auto path = std::string{"/basic-auth/hello/world"};
  2603. #ifdef CPPHTTPLIB_SSL_ENABLED
  2604. auto port = 443;
  2605. SSLClient cli(host, port);
  2606. #else
  2607. auto port = 80;
  2608. Client cli(host, port);
  2609. #endif
  2610. {
  2611. auto res = cli.Get(path);
  2612. ASSERT_TRUE(res) << "Error: " << to_string(res.error());
  2613. EXPECT_EQ(StatusCode::Unauthorized_401, res->status);
  2614. }
  2615. {
  2616. auto res = cli.Get(
  2617. path, Headers{make_basic_authentication_header("hello", "world")});
  2618. ASSERT_TRUE(res) << "Error: " << to_string(res.error());
  2619. auto body = remove_whitespace(res->body);
  2620. EXPECT_TRUE(body.find("\"authenticated\":true") != std::string::npos);
  2621. EXPECT_TRUE(body.find("\"user\":\"hello\"") != std::string::npos);
  2622. EXPECT_EQ(StatusCode::OK_200, res->status);
  2623. }
  2624. {
  2625. cli.set_basic_auth("hello", "world");
  2626. auto res = cli.Get(path);
  2627. ASSERT_TRUE(res) << "Error: " << to_string(res.error());
  2628. auto body = remove_whitespace(res->body);
  2629. EXPECT_TRUE(body.find("\"authenticated\":true") != std::string::npos);
  2630. EXPECT_TRUE(body.find("\"user\":\"hello\"") != std::string::npos);
  2631. EXPECT_EQ(StatusCode::OK_200, res->status);
  2632. }
  2633. {
  2634. cli.set_basic_auth("hello", "bad");
  2635. auto res = cli.Get(path);
  2636. ASSERT_TRUE(res) << "Error: " << to_string(res.error());
  2637. EXPECT_EQ(StatusCode::Unauthorized_401, res->status);
  2638. }
  2639. {
  2640. cli.set_basic_auth("bad", "world");
  2641. auto res = cli.Get(path);
  2642. ASSERT_TRUE(res) << "Error: " << to_string(res.error());
  2643. EXPECT_EQ(StatusCode::Unauthorized_401, res->status);
  2644. }
  2645. }
  2646. #ifdef CPPHTTPLIB_SSL_ENABLED
  2647. TEST(DigestAuthTest, FromHTTPWatch_Online) {
  2648. auto host = "httpbingo.org";
  2649. auto unauth_path = std::string{"/digest-auth/auth/hello/world"};
  2650. auto paths = std::vector<std::string>{
  2651. "/digest-auth/auth/hello/world/MD5",
  2652. "/digest-auth/auth/hello/world/SHA-256",
  2653. };
  2654. auto port = 443;
  2655. SSLClient cli(host, port);
  2656. {
  2657. auto res = cli.Get(unauth_path);
  2658. ASSERT_TRUE(res) << "Error: " << to_string(res.error());
  2659. EXPECT_EQ(StatusCode::Unauthorized_401, res->status);
  2660. }
  2661. {
  2662. cli.set_digest_auth("hello", "world");
  2663. for (const auto &path : paths) {
  2664. auto res = cli.Get(path.c_str());
  2665. ASSERT_TRUE(res) << "Error: " << to_string(res.error());
  2666. auto body = remove_whitespace(res->body);
  2667. EXPECT_TRUE(body.find("\"authenticated\":true") != std::string::npos);
  2668. EXPECT_TRUE(body.find("\"user\":\"hello\"") != std::string::npos);
  2669. EXPECT_EQ(StatusCode::OK_200, res->status);
  2670. }
  2671. cli.set_digest_auth("hello", "bad");
  2672. for (const auto &path : paths) {
  2673. auto res = cli.Get(path.c_str());
  2674. ASSERT_TRUE(res) << "Error: " << to_string(res.error());
  2675. EXPECT_EQ(StatusCode::Unauthorized_401, res->status);
  2676. }
  2677. }
  2678. }
  2679. // RFC 9110 Section 11.6.1: a WWW-Authenticate field value is a
  2680. // comma-separated list of challenges, and each challenge may itself carry a
  2681. // comma-separated auth-param list, so a server can legally offer Basic
  2682. // before Digest, either as two field lines or packed into one. Runs one 401
  2683. // -> Digest-retry round trip with the given field lines (get_combined_header_
  2684. // value() joins them in receipt order) and checks that the retry carries a
  2685. // well-formed Digest Authorization header naming expected_realm.
  2686. static void
  2687. run_digest_challenge_list_test(const std::vector<std::string> &challenges,
  2688. const std::string &expected_realm) {
  2689. std::atomic<int> hits{0};
  2690. Server svr;
  2691. svr.Get("/x", [&](const Request &req, Response &res) {
  2692. if (++hits == 1) {
  2693. res.status = StatusCode::Unauthorized_401;
  2694. for (const auto &challenge : challenges) {
  2695. res.set_header("WWW-Authenticate", challenge);
  2696. }
  2697. } else {
  2698. auto authorization = req.get_header_value("Authorization");
  2699. EXPECT_EQ(0u, authorization.rfind("Digest ", 0));
  2700. EXPECT_NE(std::string::npos,
  2701. authorization.find("realm=\"" + expected_realm + "\""));
  2702. EXPECT_EQ(std::string::npos, authorization.find("Basic"));
  2703. res.set_content("ok", "text/plain");
  2704. }
  2705. });
  2706. auto port = svr.bind_to_any_port(HOST);
  2707. std::thread t([&]() { svr.listen_after_bind(); });
  2708. auto se = detail::scope_exit([&] {
  2709. svr.stop();
  2710. t.join();
  2711. });
  2712. svr.wait_until_ready();
  2713. Client cli(HOST, port);
  2714. cli.set_digest_auth("hello", "world");
  2715. auto res = cli.Get("/x");
  2716. ASSERT_TRUE(res) << "Error: " << to_string(res.error());
  2717. EXPECT_EQ(2, hits.load());
  2718. }
  2719. static const char *kBasicChallenge = "Basic realm=\"decoy\"";
  2720. static const char *kDigestChallenge =
  2721. "Digest realm=\"testrealm\", qop=\"auth\", nonce=\"abc123\", "
  2722. "algorithm=MD5";
  2723. TEST(DigestAuthTest, BasicChallengeListedBeforeDigest) {
  2724. run_digest_challenge_list_test({kBasicChallenge, kDigestChallenge},
  2725. "testrealm");
  2726. }
  2727. // Same challenge list with the schemes in the opposite order, to make sure
  2728. // the fix above didn't just special-case "Basic first".
  2729. TEST(DigestAuthTest, DigestChallengeListedBeforeBasic) {
  2730. run_digest_challenge_list_test({kDigestChallenge, kBasicChallenge},
  2731. "testrealm");
  2732. }
  2733. // A comma inside a quoted auth-param value must not be mistaken for the
  2734. // separator between two challenges (or two auth-params).
  2735. TEST(DigestAuthTest, RealmContainingCommaIsNotSplit) {
  2736. run_digest_challenge_list_test(
  2737. {"Digest realm=\"test,realm\", qop=\"auth\", nonce=\"abc123\", "
  2738. "algorithm=MD5"},
  2739. "test,realm");
  2740. }
  2741. // RFC 7616 Section 3.3 requires realm and nonce on every Digest challenge.
  2742. // make_digest_authentication_header() dereferences both unconditionally, so
  2743. // a server sending a challenge missing either one must not be treated as
  2744. // usable -- doing so used to crash the client with std::out_of_range.
  2745. static void run_digest_challenge_missing_field_test(const char *challenge) {
  2746. Server svr;
  2747. svr.Get("/x", [&](const Request & /*req*/, Response &res) {
  2748. res.status = StatusCode::Unauthorized_401;
  2749. res.set_header("WWW-Authenticate", challenge);
  2750. });
  2751. auto port = svr.bind_to_any_port(HOST);
  2752. std::thread t([&]() { svr.listen_after_bind(); });
  2753. auto se = detail::scope_exit([&] {
  2754. svr.stop();
  2755. t.join();
  2756. });
  2757. svr.wait_until_ready();
  2758. Client cli(HOST, port);
  2759. cli.set_digest_auth("hello", "world");
  2760. auto res = cli.Get("/x");
  2761. ASSERT_TRUE(res) << "Error: " << to_string(res.error());
  2762. EXPECT_EQ(StatusCode::Unauthorized_401, res->status);
  2763. }
  2764. TEST(DigestAuthTest, ChallengeMissingRealmAndNonceDoesNotCrash) {
  2765. run_digest_challenge_missing_field_test("Digest qop=\"auth\"");
  2766. }
  2767. TEST(DigestAuthTest, ChallengeMissingNonceDoesNotCrash) {
  2768. run_digest_challenge_missing_field_test("Digest realm=\"r\", qop=\"auth\"");
  2769. }
  2770. TEST(DigestAuthTest, ChallengeMissingRealmDoesNotCrash) {
  2771. run_digest_challenge_missing_field_test("Digest nonce=\"n\", qop=\"auth\"");
  2772. }
  2773. // A hostile server can put a '"' in realm/nonce/opaque, or a non-token
  2774. // algorithm, in its challenge. parse_www_authenticate() de-escapes quoted-pairs
  2775. // when storing the values, so the header builder has to re-escape them (and
  2776. // keep algorithm a bare token); otherwise the value breaks out of its
  2777. // quoted-string and injects extra auth-params into the client's Authorization.
  2778. TEST(DigestAuthTest, EscapesInjectedAuthParams) {
  2779. std::atomic<int> hits{0};
  2780. std::string authorization;
  2781. Server svr;
  2782. svr.Get("/x", [&](const Request &req, Response &res) {
  2783. if (++hits == 1) {
  2784. res.status = StatusCode::Unauthorized_401;
  2785. // On the wire the quotes embedded in the values are backslash-escaped.
  2786. res.set_header("WWW-Authenticate",
  2787. "Digest realm=\"testrealm\", "
  2788. "nonce=\"n\\\"; injected=\\\"x\", "
  2789. "algorithm=\"MD5, injected2=\\\"y\\\"\", qop=\"auth\"");
  2790. } else {
  2791. authorization = req.get_header_value("Authorization");
  2792. res.set_content("ok", "text/plain");
  2793. }
  2794. });
  2795. auto port = svr.bind_to_any_port(HOST);
  2796. std::thread t([&]() { svr.listen_after_bind(); });
  2797. auto se = detail::scope_exit([&] {
  2798. svr.stop();
  2799. t.join();
  2800. });
  2801. svr.wait_until_ready();
  2802. Client cli(HOST, port);
  2803. cli.set_digest_auth("hello", "world");
  2804. auto res = cli.Get("/x");
  2805. ASSERT_TRUE(res) << "Error: " << to_string(res.error());
  2806. EXPECT_EQ(2, hits.load());
  2807. EXPECT_EQ(0u, authorization.rfind("Digest ", 0));
  2808. // The nonce (de-escaped to n"; injected="x ) must be re-escaped so it stays
  2809. // inside its quoted-string rather than starting an "injected" auth-param.
  2810. EXPECT_NE(std::string::npos,
  2811. authorization.find("nonce=\"n\\\"; injected=\\\"x\""));
  2812. // A non-token algorithm falls back to a bare MD5 token, dropping the payload.
  2813. EXPECT_EQ(std::string::npos, authorization.find("injected2"));
  2814. }
  2815. #endif
  2816. TEST(SpecifyServerIPAddressTest, AnotherHostname_Online) {
  2817. auto host = "google.com";
  2818. auto another_host = "example.com";
  2819. auto wrong_ip = "0.0.0.0";
  2820. #ifdef CPPHTTPLIB_SSL_ENABLED
  2821. SSLClient cli(host);
  2822. #else
  2823. Client cli(host);
  2824. #endif
  2825. cli.set_hostname_addr_map({{another_host, wrong_ip}});
  2826. auto res = cli.Get("/");
  2827. ASSERT_TRUE(res) << "Error: " << to_string(res.error());
  2828. ASSERT_EQ(StatusCode::MovedPermanently_301, res->status);
  2829. }
  2830. TEST(SpecifyServerIPAddressTest, RealHostname_Online) {
  2831. auto host = "google.com";
  2832. auto wrong_ip = "0.0.0.0";
  2833. #ifdef CPPHTTPLIB_SSL_ENABLED
  2834. SSLClient cli(host);
  2835. #else
  2836. Client cli(host);
  2837. #endif
  2838. cli.set_hostname_addr_map({{host, wrong_ip}});
  2839. auto res = cli.Get("/");
  2840. ASSERT_TRUE(!res);
  2841. EXPECT_EQ(Error::Connection, res.error());
  2842. }
  2843. TEST(SpecifyServerIPAddressTest, HostnameAsAddrMapValue) {
  2844. // A mapped value that is not an IP literal must be resolved. "localhost"
  2845. // resolves from the hosts file, so this test needs no external DNS.
  2846. // "target.invalid" (RFC 6761) is only a map key and the Host header value.
  2847. auto host = "target.invalid";
  2848. Server svr;
  2849. std::string received_host;
  2850. svr.Get("/hi", [&](const Request &req, Response &res) {
  2851. received_host = req.get_header_value("Host");
  2852. res.set_content("Hello World!", "text/plain");
  2853. });
  2854. auto port = svr.bind_to_any_port(HOST);
  2855. auto thread = std::thread([&]() { svr.listen_after_bind(); });
  2856. auto se = detail::scope_exit([&] {
  2857. svr.stop();
  2858. thread.join();
  2859. ASSERT_FALSE(svr.is_running());
  2860. });
  2861. svr.wait_until_ready();
  2862. Client cli(host, port);
  2863. cli.set_hostname_addr_map({{host, HOST}});
  2864. auto res = cli.Get("/hi");
  2865. ASSERT_TRUE(res) << "Error: " << to_string(res.error());
  2866. EXPECT_EQ(StatusCode::OK_200, res->status);
  2867. // The mapping only redirects the connection; the identity stays host_.
  2868. EXPECT_EQ(std::string(host) + ":" + std::to_string(port), received_host);
  2869. }
  2870. TEST(SpecifyServerIPAddressTest, IPAddressAsAddrMapValue) {
  2871. // A mapped value that is an IP literal keeps the AI_NUMERICHOST path.
  2872. auto host = "target.invalid";
  2873. Server svr;
  2874. svr.Get("/hi", [](const Request & /*req*/, Response &res) {
  2875. res.set_content("Hello World!", "text/plain");
  2876. });
  2877. auto port = svr.bind_to_any_port("127.0.0.1");
  2878. auto thread = std::thread([&]() { svr.listen_after_bind(); });
  2879. auto se = detail::scope_exit([&] {
  2880. svr.stop();
  2881. thread.join();
  2882. ASSERT_FALSE(svr.is_running());
  2883. });
  2884. svr.wait_until_ready();
  2885. Client cli(host, port);
  2886. cli.set_hostname_addr_map({{host, "127.0.0.1"}});
  2887. auto res = cli.Get("/hi");
  2888. ASSERT_TRUE(res) << "Error: " << to_string(res.error());
  2889. EXPECT_EQ(StatusCode::OK_200, res->status);
  2890. }
  2891. TEST(SpecifyServerIPAddressTest, EmptyAddrMapValueIsIgnored) {
  2892. // An empty mapped value must leave host_ as the connection target. Without
  2893. // that guard the empty value would become the host argument, getaddrinfo
  2894. // would be called with a null node, and (no AI_PASSIVE) it would resolve to
  2895. // loopback - silently connecting somewhere the caller never asked for.
  2896. // The server listens on loopback, so such a fallback would succeed and is
  2897. // therefore observable as a failure of this test.
  2898. auto blackhole = "192.0.2.1"; // TEST-NET-1, never routable
  2899. Server svr;
  2900. svr.Get("/hi", [](const Request & /*req*/, Response &res) {
  2901. res.set_content("Hello World!", "text/plain");
  2902. });
  2903. auto port = svr.bind_to_any_port(HOST);
  2904. auto thread = std::thread([&]() { svr.listen_after_bind(); });
  2905. auto se = detail::scope_exit([&] {
  2906. svr.stop();
  2907. thread.join();
  2908. ASSERT_FALSE(svr.is_running());
  2909. });
  2910. svr.wait_until_ready();
  2911. Client cli(blackhole, port);
  2912. cli.set_hostname_addr_map({{blackhole, ""}});
  2913. cli.set_connection_timeout(1);
  2914. auto res = cli.Get("/hi");
  2915. EXPECT_FALSE(res) << "empty mapping must not redirect to loopback";
  2916. }
  2917. TEST(AbsoluteRedirectTest, Redirect_Online) {
  2918. auto host = "httpbingo.org";
  2919. auto path = std::string{"/absolute-redirect/3"};
  2920. #ifdef CPPHTTPLIB_SSL_ENABLED
  2921. SSLClient cli(host);
  2922. #else
  2923. Client cli(host);
  2924. #endif
  2925. cli.set_follow_location(true);
  2926. auto res = cli.Get(path);
  2927. ASSERT_TRUE(res) << "Error: " << to_string(res.error());
  2928. EXPECT_EQ(StatusCode::OK_200, res->status);
  2929. }
  2930. TEST(RedirectTest, Redirect_Online) {
  2931. auto host = "httpbingo.org";
  2932. auto path = std::string{"/redirect/3"};
  2933. #ifdef CPPHTTPLIB_SSL_ENABLED
  2934. SSLClient cli(host);
  2935. #else
  2936. Client cli(host);
  2937. #endif
  2938. cli.set_follow_location(true);
  2939. auto res = cli.Get(path);
  2940. ASSERT_TRUE(res) << "Error: " << to_string(res.error());
  2941. EXPECT_EQ(StatusCode::OK_200, res->status);
  2942. }
  2943. TEST(RelativeRedirectTest, Redirect_Online) {
  2944. auto host = "httpbingo.org";
  2945. auto path = std::string{"/relative-redirect/3"};
  2946. #ifdef CPPHTTPLIB_SSL_ENABLED
  2947. SSLClient cli(host);
  2948. #else
  2949. Client cli(host);
  2950. #endif
  2951. cli.set_follow_location(true);
  2952. auto res = cli.Get(path);
  2953. ASSERT_TRUE(res) << "Error: " << to_string(res.error());
  2954. EXPECT_EQ(StatusCode::OK_200, res->status);
  2955. }
  2956. TEST(TooManyRedirectTest, Redirect_Online) {
  2957. auto host = "httpbingo.org";
  2958. auto path = std::string{"/redirect/21"};
  2959. #ifdef CPPHTTPLIB_SSL_ENABLED
  2960. SSLClient cli(host);
  2961. #else
  2962. Client cli(host);
  2963. #endif
  2964. cli.set_follow_location(true);
  2965. auto res = cli.Get(path);
  2966. ASSERT_TRUE(!res);
  2967. EXPECT_EQ(Error::ExceedRedirectCount, res.error());
  2968. }
  2969. #ifdef CPPHTTPLIB_SSL_ENABLED
  2970. TEST(YahooRedirectTest, Redirect_Online) {
  2971. Client cli("yahoo.com");
  2972. auto res = cli.Get("/");
  2973. ASSERT_TRUE(res) << "Error: " << to_string(res.error());
  2974. EXPECT_EQ(StatusCode::MovedPermanently_301, res->status);
  2975. cli.set_follow_location(true);
  2976. res = cli.Get("/");
  2977. ASSERT_TRUE(res) << "Error: " << to_string(res.error());
  2978. EXPECT_EQ(StatusCode::OK_200, res->status);
  2979. EXPECT_EQ("https://www.yahoo.com/", res->location);
  2980. }
  2981. // Previously "nghttp2.org" "/httpbin/redirect-to"
  2982. #define REDIR_HOST "httpbingo.org"
  2983. #define REDIR_PATH "/redirect-to"
  2984. TEST(HttpsToHttpRedirectTest, Redirect_Online) {
  2985. SSLClient cli(REDIR_HOST);
  2986. cli.set_follow_location(true);
  2987. auto res =
  2988. cli.Get(REDIR_PATH "?url=http%3A%2F%2Fexample.com&status_code=302");
  2989. ASSERT_TRUE(res) << "Error: " << to_string(res.error());
  2990. EXPECT_EQ(StatusCode::OK_200, res->status);
  2991. }
  2992. TEST(HttpsToHttpRedirectTest2, Redirect_Online) {
  2993. SSLClient cli(REDIR_HOST);
  2994. cli.set_follow_location(true);
  2995. Params params;
  2996. params.emplace("url", "http://example.com");
  2997. params.emplace("status_code", "302");
  2998. auto res = cli.Get(REDIR_PATH, params, Headers{});
  2999. ASSERT_TRUE(res) << "Error: " << to_string(res.error());
  3000. EXPECT_EQ(StatusCode::OK_200, res->status);
  3001. }
  3002. TEST(HttpsToHttpRedirectTest3, Redirect_Online) {
  3003. SSLClient cli(REDIR_HOST);
  3004. cli.set_follow_location(true);
  3005. Params params;
  3006. params.emplace("url", "http://example.com");
  3007. auto res = cli.Get(REDIR_PATH "?status_code=302", params, Headers{});
  3008. ASSERT_TRUE(res) << "Error: " << to_string(res.error());
  3009. EXPECT_EQ(StatusCode::OK_200, res->status);
  3010. }
  3011. TEST(UrlWithSpace, Redirect_Online) {
  3012. SSLClient cli("edge.forgecdn.net");
  3013. cli.set_follow_location(true);
  3014. auto res = cli.Get("/files/2595/310/Neat 1.4-17.jar");
  3015. ASSERT_TRUE(res) << "Error: " << to_string(res.error());
  3016. EXPECT_EQ(StatusCode::OK_200, res->status);
  3017. EXPECT_EQ(18527U, res->get_header_value_u64("Content-Length"));
  3018. }
  3019. #endif
  3020. #if !defined(_WIN32) && !defined(_WIN64)
  3021. TEST(ReceiveSignals, Signal) {
  3022. auto setupSignalHandlers = []() {
  3023. struct sigaction act;
  3024. sigemptyset(&act.sa_mask);
  3025. act.sa_flags = SA_SIGINFO;
  3026. act.sa_sigaction = [](int sig, siginfo_t *, void *) {
  3027. switch (sig) {
  3028. case SIGINT:
  3029. default: break;
  3030. }
  3031. };
  3032. ::sigaction(SIGINT, &act, nullptr);
  3033. };
  3034. Server svr;
  3035. int port = 0;
  3036. auto thread = std::thread([&]() {
  3037. setupSignalHandlers();
  3038. port = svr.bind_to_any_port(HOST);
  3039. svr.listen_after_bind();
  3040. });
  3041. auto se = detail::scope_exit([&] {
  3042. svr.stop();
  3043. thread.join();
  3044. ASSERT_FALSE(svr.is_running());
  3045. });
  3046. svr.wait_until_ready();
  3047. ASSERT_TRUE(svr.is_running());
  3048. pthread_kill(thread.native_handle(), SIGINT);
  3049. std::this_thread::sleep_for(std::chrono::milliseconds(100));
  3050. ASSERT_TRUE(svr.is_running());
  3051. }
  3052. #endif
  3053. TEST(RedirectToDifferentPort, Redirect) {
  3054. Server svr1;
  3055. svr1.Get("/1", [&](const Request & /*req*/, Response &res) {
  3056. res.set_content("Hello World!", "text/plain");
  3057. });
  3058. int svr1_port = 0;
  3059. auto thread1 = std::thread([&]() {
  3060. svr1_port = svr1.bind_to_any_port(HOST);
  3061. svr1.listen_after_bind();
  3062. });
  3063. Server svr2;
  3064. svr2.Get("/2", [&](const Request & /*req*/, Response &res) {
  3065. res.set_redirect("http://localhost:" + std::to_string(svr1_port) + "/1");
  3066. });
  3067. int svr2_port = 0;
  3068. auto thread2 = std::thread([&]() {
  3069. svr2_port = svr2.bind_to_any_port(HOST);
  3070. svr2.listen_after_bind();
  3071. });
  3072. auto se = detail::scope_exit([&] {
  3073. svr2.stop();
  3074. thread2.join();
  3075. svr1.stop();
  3076. thread1.join();
  3077. ASSERT_FALSE(svr2.is_running());
  3078. ASSERT_FALSE(svr1.is_running());
  3079. });
  3080. svr1.wait_until_ready();
  3081. svr2.wait_until_ready();
  3082. Client cli("localhost", svr2_port);
  3083. cli.set_follow_location(true);
  3084. auto res = cli.Get("/2");
  3085. ASSERT_TRUE(res) << "Error: " << to_string(res.error());
  3086. EXPECT_EQ(StatusCode::OK_200, res->status);
  3087. EXPECT_EQ("Hello World!", res->body);
  3088. }
  3089. static void
  3090. TestDoNotForwardCredentialsOnRedirect(std::function<void(Client &)> set_auth) {
  3091. Server svr1;
  3092. std::string captured_authorization;
  3093. svr1.Get("/target", [&](const Request &req, Response &res) {
  3094. captured_authorization = req.get_header_value("Authorization");
  3095. res.set_content("OK", "text/plain");
  3096. });
  3097. int svr1_port = 0;
  3098. auto thread1 = std::thread([&]() {
  3099. svr1_port = svr1.bind_to_any_port(HOST);
  3100. svr1.listen_after_bind();
  3101. });
  3102. Server svr2;
  3103. svr2.Get("/redir", [&](const Request & /*req*/, Response &res) {
  3104. res.set_redirect(
  3105. "http://localhost:" + std::to_string(svr1_port) + "/target", 302);
  3106. });
  3107. int svr2_port = 0;
  3108. auto thread2 = std::thread([&]() {
  3109. svr2_port = svr2.bind_to_any_port(HOST);
  3110. svr2.listen_after_bind();
  3111. });
  3112. auto se = detail::scope_exit([&] {
  3113. svr2.stop();
  3114. thread2.join();
  3115. svr1.stop();
  3116. thread1.join();
  3117. ASSERT_FALSE(svr2.is_running());
  3118. ASSERT_FALSE(svr1.is_running());
  3119. });
  3120. svr1.wait_until_ready();
  3121. svr2.wait_until_ready();
  3122. Client cli("localhost", svr2_port);
  3123. cli.set_follow_location(true);
  3124. set_auth(cli);
  3125. auto res = cli.Get("/redir");
  3126. ASSERT_TRUE(res) << "Error: " << to_string(res.error());
  3127. EXPECT_EQ(StatusCode::OK_200, res->status);
  3128. // RFC 9110: credentials MUST NOT be forwarded to a different host
  3129. EXPECT_TRUE(captured_authorization.empty());
  3130. }
  3131. TEST(RedirectToDifferentPort, DoNotForwardCredentialsBasicAuth) {
  3132. TestDoNotForwardCredentialsOnRedirect(
  3133. [](Client &cli) { cli.set_basic_auth("admin", "secret"); });
  3134. }
  3135. TEST(RedirectToDifferentPort, DoNotForwardCredentialsBearerToken) {
  3136. TestDoNotForwardCredentialsOnRedirect(
  3137. [](Client &cli) { cli.set_bearer_token_auth("my-secret-token"); });
  3138. }
  3139. TEST(RedirectToDifferentPort, DoNotForwardCookie) {
  3140. Server svr1;
  3141. std::string captured_cookie;
  3142. bool target_hit = false;
  3143. svr1.Get("/target", [&](const Request &req, Response &res) {
  3144. captured_cookie = req.get_header_value("Cookie");
  3145. target_hit = true;
  3146. res.set_content("OK", "text/plain");
  3147. });
  3148. int svr1_port = 0;
  3149. auto thread1 = std::thread([&]() {
  3150. svr1_port = svr1.bind_to_any_port(HOST);
  3151. svr1.listen_after_bind();
  3152. });
  3153. Server svr2;
  3154. svr2.Get("/redir", [&](const Request & /*req*/, Response &res) {
  3155. res.set_redirect(
  3156. "http://localhost:" + std::to_string(svr1_port) + "/target", 302);
  3157. });
  3158. int svr2_port = 0;
  3159. auto thread2 = std::thread([&]() {
  3160. svr2_port = svr2.bind_to_any_port(HOST);
  3161. svr2.listen_after_bind();
  3162. });
  3163. auto se = detail::scope_exit([&] {
  3164. svr2.stop();
  3165. thread2.join();
  3166. svr1.stop();
  3167. thread1.join();
  3168. ASSERT_FALSE(svr2.is_running());
  3169. ASSERT_FALSE(svr1.is_running());
  3170. });
  3171. svr1.wait_until_ready();
  3172. svr2.wait_until_ready();
  3173. Client cli("localhost", svr2_port);
  3174. cli.set_follow_location(true);
  3175. Headers headers = {{"Cookie", "session_id=SECRET; auth=PRIVATE"}};
  3176. auto res = cli.Get("/redir", headers);
  3177. ASSERT_TRUE(res) << "Error: " << to_string(res.error());
  3178. EXPECT_EQ(StatusCode::OK_200, res->status);
  3179. EXPECT_TRUE(target_hit);
  3180. // Cookie MUST NOT be forwarded to a different host (GHSA-22mf-w2v3-r2jv)
  3181. EXPECT_TRUE(captured_cookie.empty());
  3182. }
  3183. TEST(RedirectToSamePort, ForwardCookie) {
  3184. // A same-origin redirect (same scheme/host/port) should preserve the Cookie
  3185. // header so that ordinary session flows keep working.
  3186. Server svr;
  3187. std::string captured_cookie;
  3188. svr.Get("/redir", [&](const Request & /*req*/, Response &res) {
  3189. res.set_redirect("/target", 302);
  3190. });
  3191. svr.Get("/target", [&](const Request &req, Response &res) {
  3192. captured_cookie = req.get_header_value("Cookie");
  3193. res.set_content("OK", "text/plain");
  3194. });
  3195. auto port = svr.bind_to_any_port(HOST);
  3196. auto thread = std::thread([&]() { svr.listen_after_bind(); });
  3197. auto se = detail::scope_exit([&] {
  3198. svr.stop();
  3199. thread.join();
  3200. ASSERT_FALSE(svr.is_running());
  3201. });
  3202. svr.wait_until_ready();
  3203. Client cli(HOST, port);
  3204. cli.set_follow_location(true);
  3205. Headers headers = {{"Cookie", "session_id=SECRET"}};
  3206. auto res = cli.Get("/redir", headers);
  3207. ASSERT_TRUE(res) << "Error: " << to_string(res.error());
  3208. EXPECT_EQ(StatusCode::OK_200, res->status);
  3209. EXPECT_EQ("session_id=SECRET", captured_cookie);
  3210. }
  3211. TEST(RedirectToDifferentPort, OverflowPortNumber) {
  3212. Server svr;
  3213. svr.Get("/redir", [&](const Request & /*req*/, Response &res) {
  3214. // Port number that overflows int — should not crash
  3215. res.set_redirect("http://localhost:99999999999999999999/target");
  3216. });
  3217. auto port = svr.bind_to_any_port(HOST);
  3218. auto thread = std::thread([&]() { svr.listen_after_bind(); });
  3219. auto se = detail::scope_exit([&] {
  3220. svr.stop();
  3221. thread.join();
  3222. ASSERT_FALSE(svr.is_running());
  3223. });
  3224. svr.wait_until_ready();
  3225. Client cli(HOST, port);
  3226. cli.set_follow_location(true);
  3227. auto res = cli.Get("/redir");
  3228. // Should fail gracefully, not crash (no valid response due to bad port)
  3229. EXPECT_FALSE(res);
  3230. }
  3231. TEST(RedirectToDifferentPort, TrailingCharactersInPort) {
  3232. Server svr;
  3233. auto port = svr.bind_to_any_port(HOST);
  3234. svr.Get("/redir", [&](const Request & /*req*/, Response &res) {
  3235. // The server's own port followed by junk must not be followed
  3236. res.set_redirect("http://" + std::string(HOST) + ":" +
  3237. std::to_string(port) + "junk/target");
  3238. });
  3239. svr.Get("/target", [&](const Request & /*req*/, Response &res) {
  3240. res.set_content("target", "text/plain");
  3241. });
  3242. auto thread = std::thread([&]() { svr.listen_after_bind(); });
  3243. auto se = detail::scope_exit([&] {
  3244. svr.stop();
  3245. thread.join();
  3246. ASSERT_FALSE(svr.is_running());
  3247. });
  3248. svr.wait_until_ready();
  3249. Client cli(HOST, port);
  3250. cli.set_follow_location(true);
  3251. auto res = cli.Get("/redir");
  3252. EXPECT_FALSE(res);
  3253. }
  3254. TEST(RedirectFromPageWithContent, Redirect) {
  3255. Server svr;
  3256. svr.Get("/1", [&](const Request & /*req*/, Response &res) {
  3257. res.set_content("___", "text/plain");
  3258. res.set_redirect("/2");
  3259. });
  3260. svr.Get("/2", [&](const Request & /*req*/, Response &res) {
  3261. res.set_content("Hello World!", "text/plain");
  3262. });
  3263. auto th = std::thread([&]() { svr.listen("localhost", PORT); });
  3264. auto se = detail::scope_exit([&] {
  3265. svr.stop();
  3266. th.join();
  3267. ASSERT_FALSE(svr.is_running());
  3268. });
  3269. svr.wait_until_ready();
  3270. {
  3271. Client cli("localhost", PORT);
  3272. cli.set_follow_location(true);
  3273. std::string body;
  3274. auto res = cli.Get("/1", [&](const char *data, size_t data_length) {
  3275. body.append(data, data_length);
  3276. return true;
  3277. });
  3278. ASSERT_TRUE(res) << "Error: " << to_string(res.error());
  3279. EXPECT_EQ(StatusCode::OK_200, res->status);
  3280. EXPECT_EQ("Hello World!", body);
  3281. }
  3282. {
  3283. Client cli("localhost", PORT);
  3284. std::string body;
  3285. auto res = cli.Get("/1", [&](const char *data, size_t data_length) {
  3286. body.append(data, data_length);
  3287. return true;
  3288. });
  3289. ASSERT_TRUE(res) << "Error: " << to_string(res.error());
  3290. EXPECT_EQ(StatusCode::Found_302, res->status);
  3291. EXPECT_EQ("___", body);
  3292. }
  3293. }
  3294. TEST(RedirectFromPageWithContentIP6, Redirect) {
  3295. Server svr;
  3296. auto port_str = std::to_string(PORT);
  3297. auto redirect_url = "http://[::1]:" + port_str + "/2";
  3298. auto expected_host = "[::1]:" + port_str;
  3299. svr.Get("/1", [&](const Request & /*req*/, Response &res) {
  3300. res.set_content("___", "text/plain");
  3301. // res.set_redirect("/2");
  3302. res.set_redirect(redirect_url);
  3303. });
  3304. svr.Get("/2", [&](const Request &req, Response &res) {
  3305. auto host_header = req.headers.find("Host");
  3306. ASSERT_TRUE(host_header != req.headers.end());
  3307. EXPECT_EQ(expected_host, host_header->second);
  3308. res.set_content("Hello World!", "text/plain");
  3309. });
  3310. auto th = std::thread([&]() { svr.listen("::1", PORT); });
  3311. auto se = detail::scope_exit([&] {
  3312. svr.stop();
  3313. th.join();
  3314. ASSERT_FALSE(svr.is_running());
  3315. });
  3316. // When IPV6 support isn't available svr.listen("::1", PORT) never
  3317. // actually starts anything, so the condition !svr.is_running() will
  3318. // always remain true, and the loop never stops.
  3319. // This basically counts how many milliseconds have passed since the
  3320. // call to svr.listen(), and if after 5 seconds nothing started yet
  3321. // aborts the test.
  3322. for (unsigned int milliseconds = 0; !svr.is_running(); milliseconds++) {
  3323. std::this_thread::sleep_for(std::chrono::milliseconds(1));
  3324. ASSERT_LT(milliseconds, 5000U);
  3325. }
  3326. {
  3327. Client cli("::1", PORT);
  3328. cli.set_follow_location(true);
  3329. std::string body;
  3330. auto res = cli.Get("/1", [&](const char *data, size_t data_length) {
  3331. body.append(data, data_length);
  3332. return true;
  3333. });
  3334. ASSERT_TRUE(res) << "Error: " << to_string(res.error());
  3335. EXPECT_EQ(StatusCode::OK_200, res->status);
  3336. EXPECT_EQ("Hello World!", body);
  3337. }
  3338. {
  3339. Client cli("::1", PORT);
  3340. std::string body;
  3341. auto res = cli.Get("/1", [&](const char *data, size_t data_length) {
  3342. body.append(data, data_length);
  3343. return true;
  3344. });
  3345. ASSERT_TRUE(res) << "Error: " << to_string(res.error());
  3346. EXPECT_EQ(StatusCode::Found_302, res->status);
  3347. EXPECT_EQ("___", body);
  3348. }
  3349. }
  3350. TEST(PathUrlEncodeTest, PathUrlEncode) {
  3351. Server svr;
  3352. svr.Get("/foo", [](const Request &req, Response &res) {
  3353. auto a = req.params.find("a");
  3354. if (a != req.params.end()) {
  3355. res.set_content((*a).second, "text/plain");
  3356. res.status = StatusCode::OK_200;
  3357. } else {
  3358. res.status = StatusCode::BadRequest_400;
  3359. }
  3360. });
  3361. auto thread = std::thread([&]() { svr.listen(HOST, PORT); });
  3362. auto se = detail::scope_exit([&] {
  3363. svr.stop();
  3364. thread.join();
  3365. ASSERT_FALSE(svr.is_running());
  3366. });
  3367. svr.wait_until_ready();
  3368. {
  3369. Client cli(HOST, PORT);
  3370. cli.set_path_encode(false);
  3371. auto res = cli.Get("/foo?a=explicitly+encoded");
  3372. ASSERT_TRUE(res) << "Error: " << to_string(res.error());
  3373. EXPECT_EQ(StatusCode::OK_200, res->status);
  3374. // This expects it back with a space, as the `+` won't have been
  3375. // url-encoded, and server-side the params get decoded turning `+`
  3376. // into spaces.
  3377. EXPECT_EQ("explicitly encoded", res->body);
  3378. }
  3379. }
  3380. TEST(PathUrlEncodeTest, PreEncodedQueryNotReencoded) {
  3381. // When path encoding is disabled the client must transmit the supplied
  3382. // query verbatim. Decoding-then-re-encoding it (the previous behavior)
  3383. // corrupts pre-encoded binary payloads: e.g. `%20` would be turned into
  3384. // `+`, which a strict RFC 3986 server decodes back as `+` (0x2B) rather
  3385. // than a space (0x20). Assert on the raw wire target to catch this.
  3386. Server svr;
  3387. const std::string expected_target = "/foo?q=a%20b%2Cc%24d%3Bx&a=%00%FF";
  3388. svr.Get("/foo", [&](const Request &req, Response &res) {
  3389. EXPECT_EQ(expected_target, req.target);
  3390. res.status = StatusCode::OK_200;
  3391. });
  3392. auto thread = std::thread([&]() { svr.listen(HOST, PORT); });
  3393. auto se = detail::scope_exit([&] {
  3394. svr.stop();
  3395. thread.join();
  3396. ASSERT_FALSE(svr.is_running());
  3397. });
  3398. svr.wait_until_ready();
  3399. {
  3400. Client cli(HOST, PORT);
  3401. cli.set_path_encode(false);
  3402. auto res = cli.Get(expected_target.c_str());
  3403. ASSERT_TRUE(res) << "Error: " << to_string(res.error());
  3404. EXPECT_EQ(StatusCode::OK_200, res->status);
  3405. }
  3406. }
  3407. TEST(PathUrlEncodeTest, StreamingMatchesBufferedTarget) {
  3408. // `open_stream()` used to skip the path encoding that the buffered send
  3409. // path applies, so the same `path` produced different bytes in the request
  3410. // line depending on which API was used. Assert the two agree.
  3411. Server svr;
  3412. std::string target;
  3413. svr.Get(".*", [&](const Request &req, Response &res) {
  3414. target = req.target;
  3415. res.status = StatusCode::OK_200;
  3416. });
  3417. auto port = svr.bind_to_any_port(HOST);
  3418. auto thread = std::thread([&]() { svr.listen_after_bind(); });
  3419. auto se = detail::scope_exit([&] {
  3420. svr.stop();
  3421. thread.join();
  3422. ASSERT_FALSE(svr.is_running());
  3423. });
  3424. svr.wait_until_ready();
  3425. struct {
  3426. const char *path;
  3427. const char *expected;
  3428. } cases[] = {
  3429. {"/a b?x=1", "/a%20b?x=1"},
  3430. {"/\xE6\x97\xA5\xE6\x9C\xAC", "/%E6%97%A5%E6%9C%AC"},
  3431. {"/a,b;c+d", "/a%2Cb%3Bc%2Bd"},
  3432. };
  3433. for (const auto &c : cases) {
  3434. Client cli(HOST, port);
  3435. target.clear();
  3436. auto res = cli.Get(c.path);
  3437. ASSERT_TRUE(res) << "Error: " << to_string(res.error());
  3438. EXPECT_EQ(c.expected, target) << "buffered path: " << c.path;
  3439. auto buffered_target = target;
  3440. target.clear();
  3441. auto handle = cli.open_stream("GET", c.path);
  3442. EXPECT_TRUE(handle.is_valid())
  3443. << "streaming path: " << c.path << ", " << to_string(handle.error);
  3444. EXPECT_EQ(buffered_target, target) << "streaming path: " << c.path;
  3445. }
  3446. }
  3447. TEST(PathUrlEncodeTest, StreamingPreEncodedQueryNotReencoded) {
  3448. // The `set_path_encode(false)` contract — transmit the supplied target
  3449. // verbatim — must hold for the streaming API too.
  3450. Server svr;
  3451. const std::string expected_target = "/foo?q=a%20b%2Cc%24d%3Bx&a=%00%FF";
  3452. std::string target;
  3453. svr.Get("/foo", [&](const Request &req, Response &res) {
  3454. target = req.target;
  3455. res.status = StatusCode::OK_200;
  3456. });
  3457. auto port = svr.bind_to_any_port(HOST);
  3458. auto thread = std::thread([&]() { svr.listen_after_bind(); });
  3459. auto se = detail::scope_exit([&] {
  3460. svr.stop();
  3461. thread.join();
  3462. ASSERT_FALSE(svr.is_running());
  3463. });
  3464. svr.wait_until_ready();
  3465. {
  3466. Client cli(HOST, port);
  3467. cli.set_path_encode(false);
  3468. auto handle = cli.open_stream("GET", expected_target);
  3469. EXPECT_TRUE(handle.is_valid()) << to_string(handle.error);
  3470. EXPECT_EQ(expected_target, target);
  3471. }
  3472. }
  3473. TEST(PathUrlEncodeTest, StreamingCRLFInTargetIsEncoded) {
  3474. // With path encoding enabled a CR/LF in the target is percent-encoded
  3475. // rather than rejected, matching the buffered send path. The CR/LF guard in
  3476. // write_request_line still backstops `set_path_encode(false)`, which is
  3477. // covered by StreamingCRLFRejectedWhenPathEncodeDisabled.
  3478. Server svr;
  3479. // Captured before routing: the decoded path contains a newline, which a
  3480. // `.*` handler pattern would not match (`.` excludes `\n` in std::regex).
  3481. std::string target;
  3482. svr.set_pre_routing_handler([&](const Request &req, Response &res) {
  3483. target = req.target;
  3484. res.status = StatusCode::OK_200;
  3485. return Server::HandlerResponse::Handled;
  3486. });
  3487. auto port = svr.bind_to_any_port(HOST);
  3488. auto thread = std::thread([&]() { svr.listen_after_bind(); });
  3489. auto se = detail::scope_exit([&] {
  3490. svr.stop();
  3491. thread.join();
  3492. ASSERT_FALSE(svr.is_running());
  3493. });
  3494. svr.wait_until_ready();
  3495. {
  3496. Client cli(HOST, port);
  3497. auto handle = cli.open_stream("GET", "/a\r\nX-Injected: 1");
  3498. EXPECT_TRUE(handle.is_valid()) << to_string(handle.error);
  3499. EXPECT_EQ("/a%0D%0AX-Injected:%201", target);
  3500. }
  3501. }
  3502. TEST(PathUrlEncodeTest, ControlCharsInPathAreEncoded) {
  3503. // Every control character is percent-encoded, not just CR/LF, so the target
  3504. // passes the request-target check in write_request_line.
  3505. Server svr;
  3506. std::string target;
  3507. svr.set_pre_routing_handler([&](const Request &req, Response &res) {
  3508. target = req.target;
  3509. res.status = StatusCode::OK_200;
  3510. return Server::HandlerResponse::Handled;
  3511. });
  3512. auto port = svr.bind_to_any_port(HOST);
  3513. auto thread = std::thread([&]() { svr.listen_after_bind(); });
  3514. auto se = detail::scope_exit([&] {
  3515. svr.stop();
  3516. thread.join();
  3517. ASSERT_FALSE(svr.is_running());
  3518. });
  3519. svr.wait_until_ready();
  3520. {
  3521. Client cli(HOST, port);
  3522. auto res = cli.Get("/a\tb\x1b\x7f");
  3523. ASSERT_TRUE(res) << "Error: " << to_string(res.error());
  3524. EXPECT_EQ("/a%09b%1B%7F", target);
  3525. }
  3526. }
  3527. TEST(PathUrlEncodeTest, StreamingCRLFRejectedWhenPathEncodeDisabled) {
  3528. // Nothing may reach the wire: a raw CR/LF target would split the request
  3529. // line and inject headers.
  3530. Server svr;
  3531. // Pre-routing so that "not called" means nothing reached the server at all,
  3532. // rather than merely failing to match a handler pattern.
  3533. auto handler_called = false;
  3534. svr.set_pre_routing_handler([&](const Request & /*req*/, Response &res) {
  3535. handler_called = true;
  3536. res.status = StatusCode::OK_200;
  3537. return Server::HandlerResponse::Handled;
  3538. });
  3539. auto port = svr.bind_to_any_port(HOST);
  3540. auto thread = std::thread([&]() { svr.listen_after_bind(); });
  3541. auto se = detail::scope_exit([&] {
  3542. svr.stop();
  3543. thread.join();
  3544. ASSERT_FALSE(svr.is_running());
  3545. });
  3546. svr.wait_until_ready();
  3547. {
  3548. Client cli(HOST, port);
  3549. cli.set_path_encode(false);
  3550. auto handle = cli.open_stream("GET", "/a\r\nX-Injected: 1");
  3551. EXPECT_FALSE(handle.is_valid());
  3552. EXPECT_EQ(Error::Write, handle.error);
  3553. EXPECT_FALSE(handler_called);
  3554. }
  3555. }
  3556. TEST(PathUrlEncodeTest, RequestParamsBranchSelection) {
  3557. // Which of the two branches runs is decided by whether the query component
  3558. // is empty, not by whether `req.path` contains a `?`: a trailing `?` yields
  3559. // an empty query and must still fall back to building one from
  3560. // `req.params`, while a non-empty query must win over `req.params`.
  3561. Server svr;
  3562. std::string target;
  3563. svr.Get("/foo", [&](const Request &req, Response &res) {
  3564. target = req.target;
  3565. res.status = StatusCode::OK_200;
  3566. });
  3567. auto port = svr.bind_to_any_port(HOST);
  3568. auto thread = std::thread([&]() { svr.listen_after_bind(); });
  3569. auto se = detail::scope_exit([&] {
  3570. svr.stop();
  3571. thread.join();
  3572. ASSERT_FALSE(svr.is_running());
  3573. });
  3574. svr.wait_until_ready();
  3575. {
  3576. // Trailing `?` -> empty query component -> `req.params` is used.
  3577. Client cli(HOST, port);
  3578. Request req;
  3579. req.method = "GET";
  3580. req.path = "/foo?";
  3581. req.params.emplace("a", "1");
  3582. target.clear();
  3583. auto res = cli.send(req);
  3584. ASSERT_TRUE(res) << "Error: " << to_string(res.error());
  3585. EXPECT_EQ("/foo?a=1", target);
  3586. }
  3587. {
  3588. // Non-empty query in `req.path` -> `req.params` is not appended.
  3589. Client cli(HOST, port);
  3590. Request req;
  3591. req.method = "GET";
  3592. req.path = "/foo?b=2";
  3593. req.params.emplace("a", "1");
  3594. target.clear();
  3595. auto res = cli.send(req);
  3596. ASSERT_TRUE(res) << "Error: " << to_string(res.error());
  3597. EXPECT_EQ("/foo?b=2", target);
  3598. }
  3599. }
  3600. TEST(PathUrlEncodeTest, IncludePercentEncodingLF) {
  3601. Server svr;
  3602. svr.Get("/", [](const Request &req, Response &) {
  3603. EXPECT_EQ("\x0A", req.get_param_value("something"));
  3604. });
  3605. auto thread = std::thread([&]() { svr.listen(HOST, PORT); });
  3606. auto se = detail::scope_exit([&] {
  3607. svr.stop();
  3608. thread.join();
  3609. ASSERT_FALSE(svr.is_running());
  3610. });
  3611. svr.wait_until_ready();
  3612. {
  3613. Client cli(HOST, PORT);
  3614. cli.set_path_encode(false);
  3615. auto res = cli.Get("/?something=%0A");
  3616. ASSERT_TRUE(res) << "Error: " << to_string(res.error());
  3617. EXPECT_EQ(StatusCode::OK_200, res->status);
  3618. }
  3619. }
  3620. TEST(BindServerTest, BindDualStack) {
  3621. Server svr;
  3622. svr.Get("/1", [&](const Request & /*req*/, Response &res) {
  3623. res.set_content("Hello World!", "text/plain");
  3624. });
  3625. auto thread = std::thread([&]() { svr.listen("::", PORT); });
  3626. auto se = detail::scope_exit([&] {
  3627. svr.stop();
  3628. thread.join();
  3629. ASSERT_FALSE(svr.is_running());
  3630. });
  3631. svr.wait_until_ready();
  3632. {
  3633. Client cli("127.0.0.1", PORT);
  3634. auto res = cli.Get("/1");
  3635. ASSERT_TRUE(res) << "Error: " << to_string(res.error());
  3636. EXPECT_EQ(StatusCode::OK_200, res->status);
  3637. EXPECT_EQ("Hello World!", res->body);
  3638. }
  3639. {
  3640. Client cli("::1", PORT);
  3641. auto res = cli.Get("/1");
  3642. ASSERT_TRUE(res) << "Error: " << to_string(res.error());
  3643. EXPECT_EQ(StatusCode::OK_200, res->status);
  3644. EXPECT_EQ("Hello World!", res->body);
  3645. }
  3646. }
  3647. TEST(BindServerTest, BindAndListenSeparately) {
  3648. Server svr;
  3649. int port = svr.bind_to_any_port("0.0.0.0");
  3650. ASSERT_TRUE(svr.is_valid());
  3651. ASSERT_TRUE(port > 0);
  3652. svr.stop();
  3653. }
  3654. // Reports whether anything is still listening on a loopback port. A plain
  3655. // connect() is used instead of a Client request because a socket left bound by
  3656. // mistake accepts the connection into its backlog and never answers, which
  3657. // would hang the test instead of failing it.
  3658. static bool is_loopback_port_accepting(int port) {
  3659. sockaddr_in addr{};
  3660. addr.sin_family = AF_INET;
  3661. addr.sin_port = htons(static_cast<uint16_t>(port));
  3662. addr.sin_addr.s_addr = htonl(INADDR_LOOPBACK);
  3663. socket_t sock = ::socket(AF_INET, SOCK_STREAM, 0);
  3664. EXPECT_NE(sock, INVALID_SOCKET);
  3665. if (sock == INVALID_SOCKET) { return false; }
  3666. auto ret = ::connect(sock, reinterpret_cast<sockaddr *>(&addr),
  3667. static_cast<socklen_t>(sizeof(addr)));
  3668. detail::close_socket(sock);
  3669. return ret == 0;
  3670. }
  3671. TEST(BindServerTest, StopClosesBoundSocketWithoutListen) {
  3672. Server svr;
  3673. auto port = svr.bind_to_any_port("127.0.0.1");
  3674. ASSERT_TRUE(port > 0);
  3675. svr.stop();
  3676. // bind_to_any_port() already called listen(2), so until stop() closed the
  3677. // descriptor the port kept accepting connections into the backlog. ASSERT
  3678. // rather than EXPECT: with the socket still open, the listen_after_bind()
  3679. // below blocks forever in the accept loop.
  3680. ASSERT_FALSE(is_loopback_port_accepting(port));
  3681. // Nothing is left to accept on, so listen_after_bind() must report failure
  3682. // instead of returning success without ever serving.
  3683. EXPECT_FALSE(svr.listen_after_bind());
  3684. // The failed listen marks the server decommissioned, so a waiter returns
  3685. // instead of spinning forever.
  3686. svr.wait_until_ready();
  3687. }
  3688. #ifdef CPPHTTPLIB_SSL_ENABLED
  3689. TEST(BindServerTest, BindAndListenSeparatelySSL) {
  3690. SSLServer svr(SERVER_CERT_FILE, SERVER_PRIVATE_KEY_FILE, CLIENT_CA_CERT_FILE,
  3691. CLIENT_CA_CERT_DIR);
  3692. int port = svr.bind_to_any_port("0.0.0.0");
  3693. ASSERT_TRUE(svr.is_valid());
  3694. ASSERT_TRUE(port > 0);
  3695. svr.stop();
  3696. }
  3697. // SSLServer::is_valid() overrides the base version, so it has to chain to it
  3698. // or a rejected CustomRoute() registration would not stop the server binding.
  3699. TEST(BindServerTest, SSLServerIsInvalidAfterRejectedCustomRoute) {
  3700. SSLServer svr(SERVER_CERT_FILE, SERVER_PRIVATE_KEY_FILE, CLIENT_CA_CERT_FILE,
  3701. CLIENT_CA_CERT_DIR);
  3702. ASSERT_TRUE(svr.is_valid());
  3703. svr.CustomRoute("GET", "/x", [](const Request &, Response &) {});
  3704. EXPECT_FALSE(svr.is_valid());
  3705. EXPECT_TRUE(svr.bind_to_any_port("0.0.0.0") < 0);
  3706. }
  3707. TEST(BindServerTest, BindAndListenSeparatelySSLEncryptedKey) {
  3708. SSLServer svr(SERVER_ENCRYPTED_CERT_FILE, SERVER_ENCRYPTED_PRIVATE_KEY_FILE,
  3709. nullptr, nullptr, SERVER_ENCRYPTED_PRIVATE_KEY_PASS);
  3710. int port = svr.bind_to_any_port("0.0.0.0");
  3711. ASSERT_TRUE(svr.is_valid());
  3712. ASSERT_TRUE(port > 0);
  3713. svr.stop();
  3714. }
  3715. TEST(BindServerTest, UpdateCertsPem) {
  3716. SSLServer svr(SERVER_CERT_FILE, SERVER_PRIVATE_KEY_FILE, CLIENT_CA_CERT_FILE);
  3717. int port = svr.bind_to_any_port("0.0.0.0");
  3718. ASSERT_TRUE(svr.is_valid());
  3719. ASSERT_TRUE(port > 0);
  3720. // Read PEM files
  3721. std::string cert_pem, key_pem, ca_pem;
  3722. read_file(SERVER_CERT_FILE, cert_pem);
  3723. read_file(SERVER_PRIVATE_KEY_FILE, key_pem);
  3724. read_file(CLIENT_CA_CERT_FILE, ca_pem);
  3725. // Update server certificates using PEM API
  3726. ASSERT_TRUE(
  3727. svr.update_certs_pem(cert_pem.c_str(), key_pem.c_str(), ca_pem.c_str()));
  3728. ASSERT_TRUE(svr.is_valid());
  3729. svr.stop();
  3730. }
  3731. TEST(SSLClientServerTest, UpdateCertsPemWithClientAuth) {
  3732. // Start server with client CA (enables client auth)
  3733. SSLServer svr(SERVER_CERT_FILE, SERVER_PRIVATE_KEY_FILE, CLIENT_CA_CERT_FILE);
  3734. ASSERT_TRUE(svr.is_valid());
  3735. bool handler_called = false;
  3736. svr.Get("/test", [&](const Request &req, Response &res) {
  3737. handler_called = true;
  3738. // Verify client certificate is present
  3739. auto cert = req.peer_cert();
  3740. EXPECT_TRUE(static_cast<bool>(cert));
  3741. res.set_content("ok", "text/plain");
  3742. });
  3743. thread t = thread([&]() { ASSERT_TRUE(svr.listen(HOST, PORT)); });
  3744. auto se = detail::scope_exit([&] {
  3745. svr.stop();
  3746. t.join();
  3747. ASSERT_FALSE(svr.is_running());
  3748. });
  3749. svr.wait_until_ready();
  3750. // Read PEM files
  3751. std::string cert_pem, key_pem, ca_pem;
  3752. read_file(SERVER_CERT_FILE, cert_pem);
  3753. read_file(SERVER_PRIVATE_KEY_FILE, key_pem);
  3754. read_file(CLIENT_CA_CERT_FILE, ca_pem);
  3755. // Update server certificates and client CA using PEM API while server running
  3756. ASSERT_TRUE(
  3757. svr.update_certs_pem(cert_pem.c_str(), key_pem.c_str(), ca_pem.c_str()));
  3758. // Connect with client certificate
  3759. SSLClient cli(HOST, PORT, CLIENT_CERT_FILE, CLIENT_PRIVATE_KEY_FILE);
  3760. cli.enable_server_certificate_verification(false);
  3761. cli.set_connection_timeout(30);
  3762. auto res = cli.Get("/test");
  3763. ASSERT_TRUE(res) << "Error: " << to_string(res.error());
  3764. ASSERT_EQ(StatusCode::OK_200, res->status);
  3765. ASSERT_TRUE(handler_called);
  3766. EXPECT_EQ("ok", res->body);
  3767. }
  3768. #endif
  3769. TEST(ErrorHandlerTest, ContentLength) {
  3770. Server svr;
  3771. svr.set_error_handler([](const Request & /*req*/, Response &res) {
  3772. res.status = StatusCode::OK_200;
  3773. res.set_content("abcdefghijklmnopqrstuvwxyz",
  3774. "text/html"); // <= Content-Length still 13
  3775. });
  3776. svr.Get("/hi", [](const Request & /*req*/, Response &res) {
  3777. res.set_content("Hello World!\n", "text/plain");
  3778. res.status = 524;
  3779. });
  3780. auto thread = std::thread([&]() { svr.listen(HOST, PORT); });
  3781. auto se = detail::scope_exit([&] {
  3782. svr.stop();
  3783. thread.join();
  3784. ASSERT_FALSE(svr.is_running());
  3785. });
  3786. svr.wait_until_ready();
  3787. {
  3788. Client cli(HOST, PORT);
  3789. auto res = cli.Get("/hi", Headers{{"Accept-Encoding", ""}});
  3790. ASSERT_TRUE(res) << "Error: " << to_string(res.error());
  3791. EXPECT_EQ(StatusCode::OK_200, res->status);
  3792. EXPECT_EQ("text/html", res->get_header_value("Content-Type"));
  3793. EXPECT_EQ("26", res->get_header_value("Content-Length"));
  3794. EXPECT_EQ("abcdefghijklmnopqrstuvwxyz", res->body);
  3795. }
  3796. }
  3797. #ifndef CPPHTTPLIB_NO_EXCEPTIONS
  3798. TEST(ExceptionTest, WithoutExceptionHandler) {
  3799. Server svr;
  3800. svr.Get("/exception", [&](const Request & /*req*/, Response & /*res*/) {
  3801. throw std::runtime_error("exception...");
  3802. });
  3803. svr.Get("/unknown", [&](const Request & /*req*/, Response & /*res*/) {
  3804. throw std::runtime_error("exception\r\n...");
  3805. });
  3806. auto listen_thread = std::thread([&svr]() { svr.listen("localhost", PORT); });
  3807. auto se = detail::scope_exit([&] {
  3808. svr.stop();
  3809. listen_thread.join();
  3810. ASSERT_FALSE(svr.is_running());
  3811. });
  3812. svr.wait_until_ready();
  3813. Client cli("localhost", PORT);
  3814. {
  3815. auto res = cli.Get("/exception");
  3816. ASSERT_TRUE(res) << "Error: " << to_string(res.error());
  3817. EXPECT_EQ(StatusCode::InternalServerError_500, res->status);
  3818. EXPECT_FALSE(res->has_header("EXCEPTION_WHAT"));
  3819. }
  3820. {
  3821. auto res = cli.Get("/unknown");
  3822. ASSERT_TRUE(res) << "Error: " << to_string(res.error());
  3823. EXPECT_EQ(StatusCode::InternalServerError_500, res->status);
  3824. EXPECT_FALSE(res->has_header("EXCEPTION_WHAT"));
  3825. }
  3826. }
  3827. TEST(ExceptionTest, WithExceptionHandler) {
  3828. Server svr;
  3829. svr.set_exception_handler([](const Request & /*req*/, Response &res,
  3830. std::exception_ptr ep) {
  3831. EXPECT_FALSE(ep == nullptr);
  3832. try {
  3833. std::rethrow_exception(ep);
  3834. } catch (std::exception &e) {
  3835. EXPECT_EQ("abc", std::string(e.what()));
  3836. } catch (...) {}
  3837. res.status = StatusCode::InternalServerError_500;
  3838. res.set_content("abcdefghijklmnopqrstuvwxyz",
  3839. "text/html"); // <= Content-Length still 13 at this point
  3840. });
  3841. svr.Get("/hi", [](const Request & /*req*/, Response &res) {
  3842. res.set_content("Hello World!\n", "text/plain");
  3843. throw std::runtime_error("abc");
  3844. });
  3845. auto thread = std::thread([&]() { svr.listen(HOST, PORT); });
  3846. auto se = detail::scope_exit([&] {
  3847. svr.stop();
  3848. thread.join();
  3849. ASSERT_FALSE(svr.is_running());
  3850. });
  3851. svr.wait_until_ready();
  3852. for (size_t i = 0; i < 10; i++) {
  3853. Client cli(HOST, PORT);
  3854. for (size_t j = 0; j < 100; j++) {
  3855. auto res = cli.Get("/hi", Headers{{"Accept-Encoding", ""}});
  3856. ASSERT_TRUE(res) << "Error: " << to_string(res.error());
  3857. EXPECT_EQ(StatusCode::InternalServerError_500, res->status);
  3858. EXPECT_EQ("text/html", res->get_header_value("Content-Type"));
  3859. EXPECT_EQ("26", res->get_header_value("Content-Length"));
  3860. EXPECT_EQ("abcdefghijklmnopqrstuvwxyz", res->body);
  3861. }
  3862. cli.set_keep_alive(true);
  3863. for (size_t j = 0; j < 100; j++) {
  3864. auto res = cli.Get("/hi", Headers{{"Accept-Encoding", ""}});
  3865. ASSERT_TRUE(res) << "Error: " << to_string(res.error());
  3866. EXPECT_EQ(StatusCode::InternalServerError_500, res->status);
  3867. EXPECT_EQ("text/html", res->get_header_value("Content-Type"));
  3868. EXPECT_EQ("26", res->get_header_value("Content-Length"));
  3869. EXPECT_EQ("abcdefghijklmnopqrstuvwxyz", res->body);
  3870. }
  3871. }
  3872. }
  3873. TEST(ExceptionTest, AndErrorHandler) {
  3874. Server svr;
  3875. svr.set_error_handler([](const Request & /*req*/, Response &res) {
  3876. if (res.body.empty()) { res.set_content("NOT_FOUND", "text/html"); }
  3877. });
  3878. svr.set_exception_handler(
  3879. [](const Request & /*req*/, Response &res, std::exception_ptr ep) {
  3880. EXPECT_FALSE(ep == nullptr);
  3881. try {
  3882. std::rethrow_exception(ep);
  3883. } catch (std::exception &e) {
  3884. res.set_content(e.what(), "text/html");
  3885. } catch (...) {}
  3886. res.status = StatusCode::InternalServerError_500;
  3887. });
  3888. svr.Get("/exception", [](const Request & /*req*/, Response & /*res*/) {
  3889. throw std::runtime_error("EXCEPTION");
  3890. });
  3891. svr.Get("/error", [](const Request & /*req*/, Response &res) {
  3892. res.set_content("ERROR", "text/html");
  3893. res.status = StatusCode::InternalServerError_500;
  3894. });
  3895. auto thread = std::thread([&]() { svr.listen(HOST, PORT); });
  3896. auto se = detail::scope_exit([&] {
  3897. svr.stop();
  3898. thread.join();
  3899. ASSERT_FALSE(svr.is_running());
  3900. });
  3901. svr.wait_until_ready();
  3902. Client cli(HOST, PORT);
  3903. {
  3904. auto res = cli.Get("/exception");
  3905. ASSERT_TRUE(res) << "Error: " << to_string(res.error());
  3906. EXPECT_EQ("text/html", res->get_header_value("Content-Type"));
  3907. EXPECT_EQ("EXCEPTION", res->body);
  3908. }
  3909. {
  3910. auto res = cli.Get("/error");
  3911. ASSERT_TRUE(res) << "Error: " << to_string(res.error());
  3912. EXPECT_EQ(StatusCode::InternalServerError_500, res->status);
  3913. EXPECT_EQ("ERROR", res->body);
  3914. }
  3915. {
  3916. auto res = cli.Get("/invalid");
  3917. ASSERT_TRUE(res) << "Error: " << to_string(res.error());
  3918. EXPECT_EQ(StatusCode::NotFound_404, res->status);
  3919. EXPECT_EQ("NOT_FOUND", res->body);
  3920. }
  3921. }
  3922. #endif
  3923. #ifndef CPPHTTPLIB_NO_EXCEPTIONS
  3924. // process_request() wraps only routing() in a try/catch, so an exception from
  3925. // any other user callback used to unwind into the task queue - which does not
  3926. // catch - and terminate the process. Each test below runs the server on a
  3927. // single worker thread: a guard that catches the exception but still loses the
  3928. // thread would otherwise be hidden by a spare worker serving the follow-up
  3929. // request. Note that a regression here aborts the whole test binary rather
  3930. // than failing one test.
  3931. TEST(ServerExceptionTest, ThrowingContentProviderDoesNotKillTheServer) {
  3932. Server svr;
  3933. svr.new_task_queue = [] { return new ThreadPool(1); };
  3934. std::atomic<int> reported{0};
  3935. svr.set_error_logger([&](const Error &err, const Request * /*req*/) {
  3936. if (err == Error::UserCallbackException) { reported++; }
  3937. });
  3938. svr.Get("/throw", [](const Request & /*req*/, Response &res) {
  3939. res.set_content_provider(
  3940. 1024, "text/plain",
  3941. [](size_t /*offset*/, size_t /*length*/, DataSink &sink) -> bool {
  3942. sink.write("hello", 5);
  3943. throw std::runtime_error("from the content provider");
  3944. });
  3945. });
  3946. svr.Get("/ok", [](const Request & /*req*/, Response &res) {
  3947. res.set_content("ok", "text/plain");
  3948. });
  3949. auto port = svr.bind_to_any_port(HOST);
  3950. auto listen_thread = std::thread([&svr]() { svr.listen_after_bind(); });
  3951. auto se = detail::scope_exit([&] {
  3952. svr.stop();
  3953. listen_thread.join();
  3954. ASSERT_FALSE(svr.is_running());
  3955. });
  3956. svr.wait_until_ready();
  3957. {
  3958. Client cli(HOST, port);
  3959. cli.set_read_timeout(5, 0);
  3960. EXPECT_FALSE(cli.Get("/throw"));
  3961. }
  3962. EXPECT_TRUE(svr.is_running());
  3963. EXPECT_EQ(1, reported.load());
  3964. // A request on a fresh connection is still served.
  3965. {
  3966. Client cli(HOST, port);
  3967. auto res = cli.Get("/ok");
  3968. ASSERT_TRUE(res) << "Error: " << to_string(res.error());
  3969. EXPECT_EQ(StatusCode::OK_200, res->status);
  3970. EXPECT_EQ("ok", res->body);
  3971. }
  3972. }
  3973. TEST(ServerExceptionTest, ThrowingPostRoutingHandlerDoesNotKillTheServer) {
  3974. Server svr;
  3975. svr.new_task_queue = [] { return new ThreadPool(1); };
  3976. std::atomic<bool> should_throw{true};
  3977. svr.Get("/hi", [](const Request & /*req*/, Response &res) {
  3978. res.set_content("hi", "text/plain");
  3979. });
  3980. svr.set_post_routing_handler(
  3981. [&](const Request & /*req*/, Response & /*res*/) {
  3982. if (should_throw) {
  3983. throw std::runtime_error("from the post-routing handler");
  3984. }
  3985. });
  3986. auto port = svr.bind_to_any_port(HOST);
  3987. auto listen_thread = std::thread([&svr]() { svr.listen_after_bind(); });
  3988. auto se = detail::scope_exit([&] {
  3989. svr.stop();
  3990. listen_thread.join();
  3991. ASSERT_FALSE(svr.is_running());
  3992. });
  3993. svr.wait_until_ready();
  3994. {
  3995. Client cli(HOST, port);
  3996. cli.set_read_timeout(5, 0);
  3997. EXPECT_FALSE(cli.Get("/hi"));
  3998. }
  3999. EXPECT_TRUE(svr.is_running());
  4000. should_throw = false;
  4001. {
  4002. Client cli(HOST, port);
  4003. auto res = cli.Get("/hi");
  4004. ASSERT_TRUE(res) << "Error: " << to_string(res.error());
  4005. EXPECT_EQ(StatusCode::OK_200, res->status);
  4006. EXPECT_EQ("hi", res->body);
  4007. }
  4008. }
  4009. TEST(ServerExceptionTest, ThrowingErrorLoggerDoesNotReopenTheGuard) {
  4010. // The guard reports the caught exception through the error logger, which is
  4011. // a user callback too. A logger that throws has to be contained as well, or
  4012. // the process would terminate from inside the catch.
  4013. Server svr;
  4014. svr.new_task_queue = [] { return new ThreadPool(1); };
  4015. std::atomic<int> reported{0};
  4016. svr.set_error_logger([&](const Error &err, const Request * /*req*/) {
  4017. if (err == Error::UserCallbackException) {
  4018. reported++;
  4019. throw std::runtime_error("from the error logger");
  4020. }
  4021. });
  4022. svr.Get("/throw", [](const Request & /*req*/, Response &res) {
  4023. res.set_content_provider(
  4024. 1024, "text/plain",
  4025. [](size_t /*offset*/, size_t /*length*/, DataSink &sink) -> bool {
  4026. sink.write("hello", 5);
  4027. throw std::runtime_error("from the content provider");
  4028. });
  4029. });
  4030. svr.Get("/ok", [](const Request & /*req*/, Response &res) {
  4031. res.set_content("ok", "text/plain");
  4032. });
  4033. auto port = svr.bind_to_any_port(HOST);
  4034. auto listen_thread = std::thread([&svr]() { svr.listen_after_bind(); });
  4035. auto se = detail::scope_exit([&] {
  4036. svr.stop();
  4037. listen_thread.join();
  4038. ASSERT_FALSE(svr.is_running());
  4039. });
  4040. svr.wait_until_ready();
  4041. {
  4042. Client cli(HOST, port);
  4043. cli.set_read_timeout(5, 0);
  4044. EXPECT_FALSE(cli.Get("/throw"));
  4045. }
  4046. EXPECT_TRUE(svr.is_running());
  4047. EXPECT_EQ(1, reported.load());
  4048. {
  4049. Client cli(HOST, port);
  4050. auto res = cli.Get("/ok");
  4051. ASSERT_TRUE(res) << "Error: " << to_string(res.error());
  4052. EXPECT_EQ(StatusCode::OK_200, res->status);
  4053. EXPECT_EQ("ok", res->body);
  4054. }
  4055. }
  4056. TEST(ServerExceptionTest, ThrowingWebSocketHandlerDoesNotKillTheServer) {
  4057. // A WebSocket handler runs on the upgrade path after the 101 has been sent,
  4058. // so the exception unwinds through the ws::WebSocket object on its way to
  4059. // the guard. None of the HTTP cases above cross that.
  4060. Server svr;
  4061. svr.new_task_queue = [] { return new ThreadPool(1); };
  4062. std::atomic<int> reported{0};
  4063. svr.set_error_logger([&](const Error &err, const Request * /*req*/) {
  4064. if (err == Error::UserCallbackException) { reported++; }
  4065. });
  4066. svr.WebSocket("/ws", [](const Request & /*req*/, ws::WebSocket & /*ws*/) {
  4067. throw std::runtime_error("from the WebSocket handler");
  4068. });
  4069. svr.Get("/ok", [](const Request & /*req*/, Response &res) {
  4070. res.set_content("ok", "text/plain");
  4071. });
  4072. auto port = svr.bind_to_any_port(HOST);
  4073. auto listen_thread = std::thread([&svr]() { svr.listen_after_bind(); });
  4074. auto se = detail::scope_exit([&] {
  4075. svr.stop();
  4076. listen_thread.join();
  4077. ASSERT_FALSE(svr.is_running());
  4078. });
  4079. svr.wait_until_ready();
  4080. {
  4081. ws::WebSocketClient client("ws://localhost:" + std::to_string(port) +
  4082. "/ws");
  4083. auto res = client.connect();
  4084. ASSERT_TRUE(res) << "Error: " << to_string(res.error());
  4085. // The server dropped the connection instead of dying.
  4086. std::string msg;
  4087. EXPECT_FALSE(client.read(msg));
  4088. client.close();
  4089. }
  4090. EXPECT_TRUE(svr.is_running());
  4091. EXPECT_EQ(1, reported.load());
  4092. {
  4093. Client cli(HOST, port);
  4094. auto res = cli.Get("/ok");
  4095. ASSERT_TRUE(res) << "Error: " << to_string(res.error());
  4096. EXPECT_EQ(StatusCode::OK_200, res->status);
  4097. EXPECT_EQ("ok", res->body);
  4098. }
  4099. }
  4100. #ifdef CPPHTTPLIB_SSL_ENABLED
  4101. TEST(ServerExceptionTest, ThrowingContentProviderDoesNotKillTheSSLServer) {
  4102. // SSLServer::process_and_close_socket() is a separate overload with its own
  4103. // guard, so it is exercised on its own.
  4104. SSLServer svr(SERVER_CERT_FILE, SERVER_PRIVATE_KEY_FILE);
  4105. ASSERT_TRUE(svr.is_valid());
  4106. svr.new_task_queue = [] { return new ThreadPool(1); };
  4107. std::atomic<int> reported{0};
  4108. svr.set_error_logger([&](const Error &err, const Request * /*req*/) {
  4109. if (err == Error::UserCallbackException) { reported++; }
  4110. });
  4111. svr.Get("/throw", [](const Request & /*req*/, Response &res) {
  4112. res.set_content_provider(
  4113. 1024, "text/plain",
  4114. [](size_t /*offset*/, size_t /*length*/, DataSink &sink) -> bool {
  4115. sink.write("hello", 5);
  4116. throw std::runtime_error("from the content provider");
  4117. });
  4118. });
  4119. svr.Get("/ok", [](const Request & /*req*/, Response &res) {
  4120. res.set_content("ok", "text/plain");
  4121. });
  4122. auto port = svr.bind_to_any_port(HOST);
  4123. auto listen_thread = std::thread([&svr]() { svr.listen_after_bind(); });
  4124. auto se = detail::scope_exit([&] {
  4125. svr.stop();
  4126. listen_thread.join();
  4127. ASSERT_FALSE(svr.is_running());
  4128. });
  4129. svr.wait_until_ready();
  4130. {
  4131. SSLClient cli(HOST, port);
  4132. cli.enable_server_certificate_verification(false);
  4133. cli.set_read_timeout(5, 0);
  4134. EXPECT_FALSE(cli.Get("/throw"));
  4135. }
  4136. EXPECT_TRUE(svr.is_running());
  4137. EXPECT_EQ(1, reported.load());
  4138. {
  4139. SSLClient cli(HOST, port);
  4140. cli.enable_server_certificate_verification(false);
  4141. auto res = cli.Get("/ok");
  4142. ASSERT_TRUE(res) << "Error: " << to_string(res.error());
  4143. EXPECT_EQ(StatusCode::OK_200, res->status);
  4144. EXPECT_EQ("ok", res->body);
  4145. }
  4146. }
  4147. #endif
  4148. #endif
  4149. TEST(NoContentTest, ContentLength) {
  4150. Server svr;
  4151. svr.Get("/hi", [](const Request & /*req*/, Response &res) {
  4152. res.status = StatusCode::NoContent_204;
  4153. });
  4154. auto thread = std::thread([&]() { svr.listen(HOST, PORT); });
  4155. auto se = detail::scope_exit([&] {
  4156. svr.stop();
  4157. thread.join();
  4158. ASSERT_FALSE(svr.is_running());
  4159. });
  4160. svr.wait_until_ready();
  4161. {
  4162. Client cli(HOST, PORT);
  4163. auto res = cli.Get("/hi");
  4164. ASSERT_TRUE(res) << "Error: " << to_string(res.error());
  4165. EXPECT_EQ(StatusCode::NoContent_204, res->status);
  4166. EXPECT_EQ("0", res->get_header_value("Content-Length"));
  4167. }
  4168. }
  4169. TEST(RoutingHandlerTest, PreAndPostRoutingHandlers) {
  4170. #ifdef CPPHTTPLIB_SSL_ENABLED
  4171. SSLServer svr(SERVER_CERT_FILE, SERVER_PRIVATE_KEY_FILE);
  4172. ASSERT_TRUE(svr.is_valid());
  4173. #else
  4174. Server svr;
  4175. #endif
  4176. svr.set_pre_routing_handler([](const Request &req, Response &res) {
  4177. if (req.path == "/routing_handler") {
  4178. res.set_header("PRE_ROUTING", "on");
  4179. res.set_content("Routing Handler", "text/plain");
  4180. return httplib::Server::HandlerResponse::Handled;
  4181. }
  4182. return httplib::Server::HandlerResponse::Unhandled;
  4183. });
  4184. svr.set_error_handler([](const Request & /*req*/, Response &res) {
  4185. res.set_content("Error", "text/html");
  4186. });
  4187. svr.set_post_routing_handler([](const Request &req, Response &res) {
  4188. if (req.path == "/routing_handler") {
  4189. res.set_header("POST_ROUTING", "on");
  4190. }
  4191. });
  4192. svr.Get("/hi", [](const Request & /*req*/, Response &res) {
  4193. res.set_content("Hello World!\n", "text/plain");
  4194. });
  4195. auto thread = std::thread([&]() { svr.listen(HOST, PORT); });
  4196. auto se = detail::scope_exit([&] {
  4197. svr.stop();
  4198. thread.join();
  4199. ASSERT_FALSE(svr.is_running());
  4200. });
  4201. svr.wait_until_ready();
  4202. {
  4203. #ifdef CPPHTTPLIB_SSL_ENABLED
  4204. SSLClient cli(HOST, PORT);
  4205. cli.enable_server_certificate_verification(false);
  4206. #else
  4207. Client cli(HOST, PORT);
  4208. #endif
  4209. auto res = cli.Get("/routing_handler");
  4210. ASSERT_TRUE(res) << "Error: " << to_string(res.error());
  4211. EXPECT_EQ(StatusCode::OK_200, res->status);
  4212. EXPECT_EQ("Routing Handler", res->body);
  4213. EXPECT_EQ(1U, res->get_header_value_count("PRE_ROUTING"));
  4214. EXPECT_EQ("on", res->get_header_value("PRE_ROUTING"));
  4215. EXPECT_EQ(1U, res->get_header_value_count("POST_ROUTING"));
  4216. EXPECT_EQ("on", res->get_header_value("POST_ROUTING"));
  4217. }
  4218. {
  4219. #ifdef CPPHTTPLIB_SSL_ENABLED
  4220. SSLClient cli(HOST, PORT);
  4221. cli.enable_server_certificate_verification(false);
  4222. #else
  4223. Client cli(HOST, PORT);
  4224. #endif
  4225. auto res = cli.Get("/hi");
  4226. ASSERT_TRUE(res) << "Error: " << to_string(res.error());
  4227. EXPECT_EQ(StatusCode::OK_200, res->status);
  4228. EXPECT_EQ("Hello World!\n", res->body);
  4229. EXPECT_EQ(0U, res->get_header_value_count("PRE_ROUTING"));
  4230. EXPECT_EQ(0U, res->get_header_value_count("POST_ROUTING"));
  4231. }
  4232. {
  4233. #ifdef CPPHTTPLIB_SSL_ENABLED
  4234. SSLClient cli(HOST, PORT);
  4235. cli.enable_server_certificate_verification(false);
  4236. #else
  4237. Client cli(HOST, PORT);
  4238. #endif
  4239. auto res = cli.Get("/aaa");
  4240. ASSERT_TRUE(res) << "Error: " << to_string(res.error());
  4241. EXPECT_EQ(StatusCode::NotFound_404, res->status);
  4242. EXPECT_EQ("Error", res->body);
  4243. EXPECT_EQ(0U, res->get_header_value_count("PRE_ROUTING"));
  4244. EXPECT_EQ(0U, res->get_header_value_count("POST_ROUTING"));
  4245. }
  4246. }
  4247. TEST(RequestHandlerTest, PreRequestHandler) {
  4248. auto route_path = "/user/:user";
  4249. Server svr;
  4250. svr.Get("/hi", [](const Request &, Response &res) {
  4251. res.set_content("hi", "text/plain");
  4252. });
  4253. svr.Get(route_path, [](const Request &req, Response &res) {
  4254. res.set_content(req.path_params.at("user"), "text/plain");
  4255. });
  4256. svr.set_pre_request_handler([&](const Request &req, Response &res) {
  4257. if (req.matched_route == route_path) {
  4258. auto user = req.path_params.at("user");
  4259. if (user != "john") {
  4260. res.status = StatusCode::Forbidden_403;
  4261. res.set_content("error", "text/html");
  4262. return Server::HandlerResponse::Handled;
  4263. }
  4264. }
  4265. return Server::HandlerResponse::Unhandled;
  4266. });
  4267. auto thread = std::thread([&]() { svr.listen(HOST, PORT); });
  4268. auto se = detail::scope_exit([&] {
  4269. svr.stop();
  4270. thread.join();
  4271. ASSERT_FALSE(svr.is_running());
  4272. });
  4273. svr.wait_until_ready();
  4274. Client cli(HOST, PORT);
  4275. {
  4276. auto res = cli.Get("/hi");
  4277. ASSERT_TRUE(res) << "Error: " << to_string(res.error());
  4278. EXPECT_EQ(StatusCode::OK_200, res->status);
  4279. EXPECT_EQ("hi", res->body);
  4280. }
  4281. {
  4282. auto res = cli.Get("/user/john");
  4283. ASSERT_TRUE(res) << "Error: " << to_string(res.error());
  4284. EXPECT_EQ(StatusCode::OK_200, res->status);
  4285. EXPECT_EQ("john", res->body);
  4286. }
  4287. {
  4288. auto res = cli.Get("/user/invalid-user");
  4289. ASSERT_TRUE(res) << "Error: " << to_string(res.error());
  4290. EXPECT_EQ(StatusCode::Forbidden_403, res->status);
  4291. EXPECT_EQ("error", res->body);
  4292. }
  4293. }
  4294. // The pre-request handler must run before the request body is read, so a
  4295. // rejected request never forces the server to buffer a (potentially large)
  4296. // body. Here the posted body is larger than the payload limit: if the body
  4297. // were read first the server would answer 413, but because the pre-request
  4298. // handler runs first it answers 403 and the body is never read.
  4299. TEST(RequestHandlerTest, PreRequestHandlerRunsBeforeBodyIsRead) {
  4300. Server svr;
  4301. svr.set_payload_max_length(8);
  4302. auto handler_ran = false;
  4303. svr.Post("/reject", [&](const Request &req, Response &res) {
  4304. handler_ran = true;
  4305. res.set_content(req.body, "text/plain");
  4306. });
  4307. svr.Post("/accept", [](const Request &req, Response &res) {
  4308. res.set_content(req.body, "text/plain");
  4309. });
  4310. svr.set_pre_request_handler([](const Request &req, Response &res) {
  4311. if (req.matched_route == "/reject") {
  4312. res.status = StatusCode::Forbidden_403;
  4313. res.set_content("denied", "text/plain");
  4314. return Server::HandlerResponse::Handled;
  4315. }
  4316. return Server::HandlerResponse::Unhandled;
  4317. });
  4318. auto thread = std::thread([&]() { svr.listen(HOST, PORT); });
  4319. auto se = detail::scope_exit([&] {
  4320. svr.stop();
  4321. thread.join();
  4322. ASSERT_FALSE(svr.is_running());
  4323. });
  4324. svr.wait_until_ready();
  4325. Client cli(HOST, PORT);
  4326. // Body (10 bytes) exceeds the 8-byte limit, yet the pre-request handler
  4327. // rejects with 403 before the body is read, so 413 is never reached.
  4328. {
  4329. auto res = cli.Post("/reject", "0123456789", "text/plain");
  4330. ASSERT_TRUE(res) << "Error: " << to_string(res.error());
  4331. EXPECT_EQ(StatusCode::Forbidden_403, res->status);
  4332. EXPECT_EQ("denied", res->body);
  4333. EXPECT_FALSE(handler_ran);
  4334. }
  4335. // An approved route still reads the body and enforces the payload limit.
  4336. {
  4337. auto res = cli.Post("/accept", "0123456789", "text/plain");
  4338. ASSERT_TRUE(res) << "Error: " << to_string(res.error());
  4339. EXPECT_EQ(StatusCode::PayloadTooLarge_413, res->status);
  4340. }
  4341. }
  4342. TEST(UserDataTest, BasicOperations) {
  4343. httplib::UserData ud;
  4344. // Initially empty
  4345. EXPECT_FALSE(ud.has("key"));
  4346. EXPECT_EQ(nullptr, ud.get<int>("key"));
  4347. // set and get
  4348. ud.set("key", 42);
  4349. EXPECT_TRUE(ud.has("key"));
  4350. auto *p = ud.get<int>("key");
  4351. ASSERT_NE(nullptr, p);
  4352. EXPECT_EQ(42, *p);
  4353. // Type mismatch → nullptr
  4354. EXPECT_EQ(nullptr, ud.get<std::string>("key"));
  4355. // Overwrite with different type
  4356. ud.set("key", std::string("hello"));
  4357. EXPECT_EQ(nullptr, ud.get<int>("key"));
  4358. auto *s = ud.get<std::string>("key");
  4359. ASSERT_NE(nullptr, s);
  4360. EXPECT_EQ("hello", *s);
  4361. // erase
  4362. ud.erase("key");
  4363. EXPECT_FALSE(ud.has("key"));
  4364. // clear
  4365. ud.set("a", 1);
  4366. ud.set("b", 2);
  4367. ud.clear();
  4368. EXPECT_FALSE(ud.has("a"));
  4369. EXPECT_FALSE(ud.has("b"));
  4370. }
  4371. TEST(RequestHandlerTest, ResponseUserDataInPreRouting) {
  4372. struct AuthCtx {
  4373. std::string user_id;
  4374. };
  4375. Server svr;
  4376. svr.set_pre_routing_handler([](const Request & /*req*/, Response &res) {
  4377. res.user_data.set("auth", AuthCtx{"alice"});
  4378. return Server::HandlerResponse::Unhandled;
  4379. });
  4380. svr.Get("/me", [](const Request & /*req*/, Response &res) {
  4381. auto *ctx = res.user_data.get<AuthCtx>("auth");
  4382. ASSERT_NE(nullptr, ctx);
  4383. res.set_content("Hello " + ctx->user_id, "text/plain");
  4384. });
  4385. auto thread = std::thread([&]() { svr.listen(HOST, PORT); });
  4386. auto se = detail::scope_exit([&] {
  4387. svr.stop();
  4388. thread.join();
  4389. ASSERT_FALSE(svr.is_running());
  4390. });
  4391. svr.wait_until_ready();
  4392. Client cli(HOST, PORT);
  4393. auto res = cli.Get("/me");
  4394. ASSERT_TRUE(res) << "Error: " << to_string(res.error());
  4395. EXPECT_EQ(StatusCode::OK_200, res->status);
  4396. EXPECT_EQ("Hello alice", res->body);
  4397. }
  4398. TEST(RequestHandlerTest, ResponseUserDataInPreRequest) {
  4399. struct RoleCtx {
  4400. std::string role;
  4401. };
  4402. Server svr;
  4403. svr.set_pre_request_handler([](const Request & /*req*/, Response &res) {
  4404. res.user_data.set("role", RoleCtx{"admin"});
  4405. return Server::HandlerResponse::Unhandled;
  4406. });
  4407. svr.Get("/role", [](const Request & /*req*/, Response &res) {
  4408. auto *ctx = res.user_data.get<RoleCtx>("role");
  4409. ASSERT_NE(nullptr, ctx);
  4410. res.set_content(ctx->role, "text/plain");
  4411. });
  4412. auto thread = std::thread([&]() { svr.listen(HOST, PORT); });
  4413. auto se = detail::scope_exit([&] {
  4414. svr.stop();
  4415. thread.join();
  4416. ASSERT_FALSE(svr.is_running());
  4417. });
  4418. svr.wait_until_ready();
  4419. Client cli(HOST, PORT);
  4420. auto res = cli.Get("/role");
  4421. ASSERT_TRUE(res) << "Error: " << to_string(res.error());
  4422. EXPECT_EQ(StatusCode::OK_200, res->status);
  4423. EXPECT_EQ("admin", res->body);
  4424. }
  4425. TEST(InvalidFormatTest, StatusCode) {
  4426. Server svr;
  4427. svr.Get("/hi", [](const Request & /*req*/, Response &res) {
  4428. res.set_content("Hello World!\n", "text/plain");
  4429. res.status = 9999; // Status should be a three-digit code...
  4430. });
  4431. auto thread = std::thread([&]() { svr.listen(HOST, PORT); });
  4432. auto se = detail::scope_exit([&] {
  4433. svr.stop();
  4434. thread.join();
  4435. ASSERT_FALSE(svr.is_running());
  4436. });
  4437. svr.wait_until_ready();
  4438. {
  4439. Client cli(HOST, PORT);
  4440. auto res = cli.Get("/hi");
  4441. ASSERT_FALSE(res);
  4442. }
  4443. }
  4444. TEST(URLFragmentTest, WithFragment) {
  4445. Server svr;
  4446. svr.Get("/hi", [](const Request &req, Response & /*res*/) {
  4447. EXPECT_TRUE(req.target == "/hi");
  4448. });
  4449. auto thread = std::thread([&]() { svr.listen(HOST, PORT); });
  4450. auto se = detail::scope_exit([&] {
  4451. svr.stop();
  4452. thread.join();
  4453. ASSERT_FALSE(svr.is_running());
  4454. });
  4455. svr.wait_until_ready();
  4456. {
  4457. Client cli(HOST, PORT);
  4458. auto res = cli.Get("/hi#key1=val1=key2=val2");
  4459. EXPECT_TRUE(res);
  4460. EXPECT_EQ(StatusCode::OK_200, res->status);
  4461. res = cli.Get("/hi%23key1=val1=key2=val2");
  4462. EXPECT_TRUE(res);
  4463. EXPECT_EQ(StatusCode::NotFound_404, res->status);
  4464. }
  4465. }
  4466. TEST(HeaderWriter, SetHeaderWriter) {
  4467. Server svr;
  4468. svr.set_header_writer([](Stream &strm, Headers &hdrs) {
  4469. hdrs.emplace("CustomServerHeader", "CustomServerValue");
  4470. return detail::write_headers(strm, hdrs);
  4471. });
  4472. svr.Get("/hi", [](const Request &req, Response &res) {
  4473. auto it = req.headers.find("CustomClientHeader");
  4474. EXPECT_TRUE(it != req.headers.end());
  4475. EXPECT_EQ(it->second, "CustomClientValue");
  4476. res.set_content("Hello World!\n", "text/plain");
  4477. });
  4478. auto thread = std::thread([&]() { svr.listen(HOST, PORT); });
  4479. auto se = detail::scope_exit([&] {
  4480. svr.stop();
  4481. thread.join();
  4482. ASSERT_FALSE(svr.is_running());
  4483. });
  4484. svr.wait_until_ready();
  4485. {
  4486. Client cli(HOST, PORT);
  4487. cli.set_header_writer([](Stream &strm, Headers &hdrs) {
  4488. hdrs.emplace("CustomClientHeader", "CustomClientValue");
  4489. return detail::write_headers(strm, hdrs);
  4490. });
  4491. auto res = cli.Get("/hi");
  4492. EXPECT_TRUE(res);
  4493. EXPECT_EQ(StatusCode::OK_200, res->status);
  4494. auto it = res->headers.find("CustomServerHeader");
  4495. EXPECT_TRUE(it != res->headers.end());
  4496. EXPECT_EQ(it->second, "CustomServerValue");
  4497. }
  4498. }
  4499. class ServerTest : public ::testing::Test {
  4500. protected:
  4501. ServerTest()
  4502. : cli_(HOST, PORT)
  4503. #ifdef CPPHTTPLIB_SSL_ENABLED
  4504. ,
  4505. svr_(SERVER_CERT_FILE, SERVER_PRIVATE_KEY_FILE)
  4506. #endif
  4507. {
  4508. #ifdef CPPHTTPLIB_SSL_ENABLED
  4509. cli_.enable_server_certificate_verification(false);
  4510. #endif
  4511. // Allow LARGE_DATA (100MB) responses
  4512. cli_.set_payload_max_length(200 * 1024 * 1024);
  4513. }
  4514. virtual void SetUp() {
  4515. // Allow LARGE_DATA (100MB) tests to pass with new 100MB default limit
  4516. svr_.set_payload_max_length(200 * 1024 * 1024);
  4517. svr_.set_mount_point("/", "./www");
  4518. svr_.set_mount_point("/mount", "./www2");
  4519. svr_.set_file_extension_and_mimetype_mapping("abcde", "text/abcde");
  4520. svr_.Get("/hi",
  4521. [&](const Request & /*req*/, Response &res) {
  4522. res.set_content("Hello World!", "text/plain");
  4523. })
  4524. .Get("/file_content",
  4525. [&](const Request & /*req*/, Response &res) {
  4526. res.set_file_content("./www/dir/test.html");
  4527. })
  4528. .Get("/file_content_with_content_type",
  4529. [&](const Request & /*req*/, Response &res) {
  4530. res.set_file_content("./www/file", "text/plain");
  4531. })
  4532. .Get("/invalid_file_content",
  4533. [&](const Request & /*req*/, Response &res) {
  4534. res.set_file_content("./www/dir/invalid_file_path");
  4535. })
  4536. .Get("/http_response_splitting",
  4537. [&](const Request & /*req*/, Response &res) {
  4538. res.set_header("a", "1\r\nSet-Cookie: a=1");
  4539. EXPECT_EQ(0U, res.headers.size());
  4540. EXPECT_FALSE(res.has_header("a"));
  4541. res.set_header("a", "1\nSet-Cookie: a=1");
  4542. EXPECT_EQ(0U, res.headers.size());
  4543. EXPECT_FALSE(res.has_header("a"));
  4544. res.set_header("a", "1\rSet-Cookie: a=1");
  4545. EXPECT_EQ(0U, res.headers.size());
  4546. EXPECT_FALSE(res.has_header("a"));
  4547. res.set_header("a\r\nb", "0");
  4548. EXPECT_EQ(0U, res.headers.size());
  4549. EXPECT_FALSE(res.has_header("a"));
  4550. res.set_header("a\rb", "0");
  4551. EXPECT_EQ(0U, res.headers.size());
  4552. EXPECT_FALSE(res.has_header("a"));
  4553. res.set_header("a\nb", "0");
  4554. EXPECT_EQ(0U, res.headers.size());
  4555. EXPECT_FALSE(res.has_header("a"));
  4556. res.set_redirect("1\r\nSet-Cookie: a=1");
  4557. EXPECT_EQ(0U, res.headers.size());
  4558. EXPECT_FALSE(res.has_header("Location"));
  4559. })
  4560. .Get("/slow",
  4561. [&](const Request & /*req*/, Response &res) {
  4562. std::this_thread::sleep_for(std::chrono::seconds(4));
  4563. res.set_content("slow", "text/plain");
  4564. })
  4565. #if 0
  4566. .Post("/slowpost",
  4567. [&](const Request & /*req*/, Response &res) {
  4568. std::this_thread::sleep_for(std::chrono::seconds(2));
  4569. res.set_content("slow", "text/plain");
  4570. })
  4571. #endif
  4572. .Get("/remote_addr",
  4573. [&](const Request &req, Response &res) {
  4574. ASSERT_FALSE(req.has_header("REMOTE_ADDR"));
  4575. ASSERT_FALSE(req.has_header("REMOTE_PORT"));
  4576. #ifndef CPPHTTPLIB_NO_EXCEPTIONS
  4577. ASSERT_ANY_THROW(req.get_header_value("REMOTE_ADDR"));
  4578. ASSERT_ANY_THROW(req.get_header_value("REMOTE_PORT"));
  4579. #endif
  4580. res.set_content(req.remote_addr, "text/plain");
  4581. })
  4582. .Get("/local_addr",
  4583. [&](const Request &req, Response &res) {
  4584. ASSERT_FALSE(req.has_header("LOCAL_ADDR"));
  4585. ASSERT_FALSE(req.has_header("LOCAL_PORT"));
  4586. #ifndef CPPHTTPLIB_NO_EXCEPTIONS
  4587. ASSERT_ANY_THROW(req.get_header_value("LOCAL_ADDR"));
  4588. ASSERT_ANY_THROW(req.get_header_value("LOCAL_PORT"));
  4589. #endif
  4590. auto local_addr = req.local_addr;
  4591. auto local_port = std::to_string(req.local_port);
  4592. res.set_content(local_addr.append(":").append(local_port),
  4593. "text/plain");
  4594. })
  4595. .Get("/endwith%",
  4596. [&](const Request & /*req*/, Response &res) {
  4597. res.set_content("Hello World!", "text/plain");
  4598. })
  4599. .Get("/a\\+\\+b",
  4600. [&](const Request &req, Response &res) {
  4601. ASSERT_TRUE(req.has_param("a +b"));
  4602. auto val = req.get_param_value("a +b");
  4603. res.set_content(val, "text/plain");
  4604. })
  4605. .Get("/", [&](const Request & /*req*/,
  4606. Response &res) { res.set_redirect("/hi"); })
  4607. .Post("/1",
  4608. [](const Request & /*req*/, Response &res) {
  4609. res.set_redirect("/2", StatusCode::SeeOther_303);
  4610. })
  4611. .Get("/2",
  4612. [](const Request & /*req*/, Response &res) {
  4613. res.set_content("redirected.", "text/plain");
  4614. res.status = StatusCode::OK_200;
  4615. })
  4616. .Post("/person",
  4617. [&](const Request &req, Response &res) {
  4618. if (req.has_param("name") && req.has_param("note")) {
  4619. persons_[req.get_param_value("name")] =
  4620. req.get_param_value("note");
  4621. } else {
  4622. res.status = StatusCode::BadRequest_400;
  4623. }
  4624. })
  4625. .Put("/person",
  4626. [&](const Request &req, Response &res) {
  4627. if (req.has_param("name") && req.has_param("note")) {
  4628. persons_[req.get_param_value("name")] =
  4629. req.get_param_value("note");
  4630. } else {
  4631. res.status = StatusCode::BadRequest_400;
  4632. }
  4633. })
  4634. .Get("/person/(.*)",
  4635. [&](const Request &req, Response &res) {
  4636. string name = req.matches[1];
  4637. if (persons_.find(name) != persons_.end()) {
  4638. auto note = persons_[name];
  4639. res.set_content(note, "text/plain");
  4640. } else {
  4641. res.status = StatusCode::NotFound_404;
  4642. }
  4643. })
  4644. .Delete("/person",
  4645. [&](const Request &req, Response &res) {
  4646. if (req.has_param("name")) {
  4647. string name = req.get_param_value("name");
  4648. if (persons_.find(name) != persons_.end()) {
  4649. persons_.erase(name);
  4650. res.set_content("DELETED", "text/plain");
  4651. } else {
  4652. res.status = StatusCode::NotFound_404;
  4653. }
  4654. } else {
  4655. res.status = StatusCode::BadRequest_400;
  4656. }
  4657. })
  4658. .Post("/x-www-form-urlencoded-json",
  4659. [&](const Request &req, Response &res) {
  4660. auto json = req.get_param_value("json");
  4661. ASSERT_EQ(JSON_DATA, json);
  4662. res.set_content(json, "appliation/json");
  4663. res.status = StatusCode::OK_200;
  4664. })
  4665. .Get("/streamed-chunked",
  4666. [&](const Request & /*req*/, Response &res) {
  4667. res.set_chunked_content_provider(
  4668. "text/plain", [](size_t /*offset*/, DataSink &sink) {
  4669. sink.os << "123";
  4670. sink.os << "456";
  4671. sink.os << "789";
  4672. sink.done();
  4673. return true;
  4674. });
  4675. })
  4676. .Get("/streamed-chunked-with-prohibited-trailer",
  4677. [&](const Request & /*req*/, Response &res) {
  4678. auto i = new int(0);
  4679. // Declare both a prohibited trailer (Content-Length) and an
  4680. // allowed one
  4681. res.set_header("Trailer", "Content-Length, X-Allowed");
  4682. res.set_chunked_content_provider(
  4683. "text/plain",
  4684. [i](size_t /*offset*/, DataSink &sink) {
  4685. switch (*i) {
  4686. case 0: sink.os << "123"; break;
  4687. case 1: sink.os << "456"; break;
  4688. case 2: sink.os << "789"; break;
  4689. case 3: {
  4690. sink.done_with_trailer(
  4691. {{"Content-Length", "5"}, {"X-Allowed", "yes"}});
  4692. } break;
  4693. }
  4694. (*i)++;
  4695. return true;
  4696. },
  4697. [i](bool success) {
  4698. EXPECT_TRUE(success);
  4699. delete i;
  4700. });
  4701. })
  4702. .Get("/streamed-chunked2",
  4703. [&](const Request & /*req*/, Response &res) {
  4704. auto i = new int(0);
  4705. res.set_chunked_content_provider(
  4706. "text/plain",
  4707. [i](size_t /*offset*/, DataSink &sink) {
  4708. switch (*i) {
  4709. case 0: sink.os << "123"; break;
  4710. case 1: sink.os << "456"; break;
  4711. case 2: sink.os << "789"; break;
  4712. case 3: sink.done(); break;
  4713. }
  4714. (*i)++;
  4715. return true;
  4716. },
  4717. [i](bool success) {
  4718. EXPECT_TRUE(success);
  4719. delete i;
  4720. });
  4721. })
  4722. .Get("/streamed-chunked-with-trailer",
  4723. [&](const Request & /*req*/, Response &res) {
  4724. auto i = new int(0);
  4725. res.set_header("Trailer", "Dummy1, Dummy2");
  4726. res.set_chunked_content_provider(
  4727. "text/plain",
  4728. [i](size_t /*offset*/, DataSink &sink) {
  4729. switch (*i) {
  4730. case 0: sink.os << "123"; break;
  4731. case 1: sink.os << "456"; break;
  4732. case 2: sink.os << "789"; break;
  4733. case 3: {
  4734. sink.done_with_trailer(
  4735. {{"Dummy1", "DummyVal1"}, {"Dummy2", "DummyVal2"}});
  4736. } break;
  4737. }
  4738. (*i)++;
  4739. return true;
  4740. },
  4741. [i](bool success) {
  4742. EXPECT_TRUE(success);
  4743. delete i;
  4744. });
  4745. })
  4746. .Get("/streamed",
  4747. [&](const Request & /*req*/, Response &res) {
  4748. res.set_content_provider(
  4749. 6, "text/plain",
  4750. [](size_t offset, size_t /*length*/, DataSink &sink) {
  4751. sink.os << (offset < 3 ? "a" : "b");
  4752. return true;
  4753. });
  4754. })
  4755. .Get("/streamed-without-length",
  4756. [&](const Request & /*req*/, Response &res) {
  4757. auto data = new std::string("abcdefg");
  4758. res.set_content_provider(
  4759. "text/plain",
  4760. [data](size_t offset, DataSink &sink) {
  4761. if (offset < data->size()) {
  4762. sink.os << data->substr(offset);
  4763. }
  4764. sink.done();
  4765. return true;
  4766. },
  4767. [data](bool success) {
  4768. EXPECT_TRUE(success);
  4769. delete data;
  4770. });
  4771. })
  4772. .Get("/streamed-with-range",
  4773. [&](const Request &req, Response &res) {
  4774. auto data = new std::string("abcdefg");
  4775. // An explicit status keeps the server from picking the 206 it
  4776. // would otherwise choose for a ranged request, so the response
  4777. // is not a partial representation.
  4778. auto status = req.get_param_value("status");
  4779. if (status == "200") {
  4780. res.status = StatusCode::OK_200;
  4781. } else if (status == "403") {
  4782. res.status = StatusCode::Forbidden_403;
  4783. }
  4784. res.set_content_provider(
  4785. data->size(), "text/plain",
  4786. [data](size_t offset, size_t length, DataSink &sink) {
  4787. size_t DATA_CHUNK_SIZE = 4;
  4788. const auto &d = *data;
  4789. auto out_len =
  4790. std::min(static_cast<size_t>(length), DATA_CHUNK_SIZE);
  4791. auto ret =
  4792. sink.write(&d[static_cast<size_t>(offset)], out_len);
  4793. EXPECT_TRUE(ret);
  4794. return true;
  4795. },
  4796. [data, &req](bool success) {
  4797. EXPECT_EQ(success, !req.has_param("error"));
  4798. delete data;
  4799. });
  4800. })
  4801. .Get("/streamed-cancel",
  4802. [&](const Request & /*req*/, Response &res) {
  4803. res.set_content_provider(
  4804. size_t(-1), "text/plain",
  4805. [](size_t /*offset*/, size_t /*length*/, DataSink &sink) {
  4806. sink.os << "data_chunk";
  4807. return true;
  4808. });
  4809. })
  4810. .Get("/regex-with-delimiter",
  4811. [&](const Request &req, Response & /*res*/) {
  4812. ASSERT_TRUE(req.has_param("key"));
  4813. EXPECT_EQ("^(?.*(value))", req.get_param_value("key"));
  4814. })
  4815. .Get("/with-range",
  4816. [&](const Request & /*req*/, Response &res) {
  4817. res.set_content("abcdefg", "text/plain");
  4818. })
  4819. .Get("/test-start-time",
  4820. [&](const Request &req, Response & /*res*/) {
  4821. EXPECT_NE(req.start_time_,
  4822. std::chrono::steady_clock::time_point::min());
  4823. })
  4824. .Get("/with-range-customized-response",
  4825. [&](const Request & /*req*/, Response &res) {
  4826. res.status = StatusCode::BadRequest_400;
  4827. res.set_content(JSON_DATA, "application/json");
  4828. })
  4829. .Post("/chunked",
  4830. [&](const Request &req, Response & /*res*/) {
  4831. EXPECT_EQ(req.body, "dechunked post body");
  4832. })
  4833. .Post("/large-chunked",
  4834. [&](const Request &req, Response & /*res*/) {
  4835. std::string expected(6 * 30 * 1024u, 'a');
  4836. EXPECT_EQ(req.body, expected);
  4837. })
  4838. .Post("/multipart",
  4839. [&](const Request &req, Response & /*res*/) {
  4840. EXPECT_EQ(4u, req.form.get_field_count("text1") +
  4841. req.form.get_field_count("text2") +
  4842. req.form.get_field_count("file3") +
  4843. req.form.get_field_count("file4"));
  4844. EXPECT_EQ(2u, req.form.get_file_count("file1") +
  4845. req.form.get_file_count("file2"));
  4846. ASSERT_TRUE(!req.form.has_file("???"));
  4847. ASSERT_TRUE(!req.form.has_field("???"));
  4848. ASSERT_TRUE(req.body.empty());
  4849. {
  4850. const auto &text = req.form.get_field("text1");
  4851. EXPECT_EQ("text default", text);
  4852. }
  4853. {
  4854. const auto &text = req.form.get_field("text2");
  4855. EXPECT_EQ("aωb", text);
  4856. }
  4857. {
  4858. const auto &file = req.form.get_file("file1");
  4859. EXPECT_EQ("hello.txt", file.filename);
  4860. EXPECT_EQ("text/plain", file.content_type);
  4861. EXPECT_EQ("h\ne\n\nl\nl\no\n", file.content);
  4862. }
  4863. {
  4864. const auto &file = req.form.get_file("file2");
  4865. EXPECT_EQ("world.json", file.filename);
  4866. EXPECT_EQ("application/json", file.content_type);
  4867. EXPECT_EQ("{\n \"world\", true\n}\n", file.content);
  4868. }
  4869. {
  4870. const auto &text = req.form.get_field("file3");
  4871. EXPECT_EQ(0u, text.size());
  4872. }
  4873. {
  4874. const auto &text = req.form.get_field("file4");
  4875. EXPECT_EQ(0u, text.size());
  4876. }
  4877. })
  4878. .Post("/multipart/multi_file_values",
  4879. [&](const Request &req, Response & /*res*/) {
  4880. EXPECT_EQ(3u, req.form.get_field_count("text") +
  4881. req.form.get_field_count("multi_text1"));
  4882. EXPECT_EQ(2u, req.form.get_file_count("multi_file1"));
  4883. ASSERT_TRUE(!req.form.has_file("???"));
  4884. ASSERT_TRUE(!req.form.has_field("???"));
  4885. ASSERT_TRUE(req.body.empty());
  4886. {
  4887. const auto &text = req.form.get_field("text");
  4888. EXPECT_EQ("default text", text);
  4889. }
  4890. {
  4891. const auto &text1_values = req.form.get_fields("multi_text1");
  4892. EXPECT_EQ(2u, text1_values.size());
  4893. EXPECT_EQ("aaaaa", text1_values[0]);
  4894. EXPECT_EQ("bbbbb", text1_values[1]);
  4895. }
  4896. {
  4897. const auto &file1_values = req.form.get_files("multi_file1");
  4898. EXPECT_EQ(2u, file1_values.size());
  4899. auto file1 = file1_values[0];
  4900. EXPECT_EQ(file1.filename, "hello.txt");
  4901. EXPECT_EQ(file1.content_type, "text/plain");
  4902. EXPECT_EQ("h\ne\n\nl\nl\no\n", file1.content);
  4903. auto file2 = file1_values[1];
  4904. EXPECT_EQ(file2.filename, "world.json");
  4905. EXPECT_EQ(file2.content_type, "application/json");
  4906. EXPECT_EQ("{\n \"world\", true\n}\n", file2.content);
  4907. }
  4908. })
  4909. .Post("/empty",
  4910. [&](const Request &req, Response &res) {
  4911. EXPECT_EQ(req.body, "");
  4912. EXPECT_EQ("text/plain", req.get_header_value("Content-Type"));
  4913. EXPECT_EQ("0", req.get_header_value("Content-Length"));
  4914. res.set_content("empty", "text/plain");
  4915. })
  4916. .Post("/empty-no-content-type",
  4917. [&](const Request &req, Response &res) {
  4918. EXPECT_EQ(req.body, "");
  4919. EXPECT_FALSE(req.has_header("Content-Type"));
  4920. EXPECT_EQ("0", req.get_header_value("Content-Length"));
  4921. res.set_content("empty-no-content-type", "text/plain");
  4922. })
  4923. .Post("/path-only",
  4924. [&](const Request &req, Response &res) {
  4925. EXPECT_EQ(req.body, "");
  4926. EXPECT_EQ("", req.get_header_value("Content-Type"));
  4927. EXPECT_EQ("0", req.get_header_value("Content-Length"));
  4928. res.set_content("path-only", "text/plain");
  4929. })
  4930. .Post("/path-headers-only",
  4931. [&](const Request &req, Response &res) {
  4932. EXPECT_EQ(req.body, "");
  4933. EXPECT_EQ("", req.get_header_value("Content-Type"));
  4934. EXPECT_EQ("0", req.get_header_value("Content-Length"));
  4935. EXPECT_EQ("world", req.get_header_value("hello"));
  4936. EXPECT_EQ("world2", req.get_header_value("hello2"));
  4937. res.set_content("path-headers-only", "text/plain");
  4938. })
  4939. .Post("/post-large",
  4940. [&](const Request &req, Response &res) {
  4941. EXPECT_EQ(req.body, LARGE_DATA);
  4942. res.set_content(req.body, "text/plain");
  4943. })
  4944. .Post("/post-loopback",
  4945. [&](const Request &, Response &res,
  4946. ContentReader const &content_reader) {
  4947. std::string body;
  4948. content_reader([&](const char *data, size_t data_length) {
  4949. body.append(data, data_length);
  4950. return true;
  4951. });
  4952. res.set_content(body, "text/plain");
  4953. })
  4954. .Put("/put-loopback",
  4955. [&](const Request &, Response &res,
  4956. ContentReader const &content_reader) {
  4957. std::string body;
  4958. content_reader([&](const char *data, size_t data_length) {
  4959. body.append(data, data_length);
  4960. return true;
  4961. });
  4962. res.set_content(body, "text/plain");
  4963. })
  4964. .Patch("/patch-loopback",
  4965. [&](const Request &, Response &res,
  4966. ContentReader const &content_reader) {
  4967. std::string body;
  4968. content_reader([&](const char *data, size_t data_length) {
  4969. body.append(data, data_length);
  4970. return true;
  4971. });
  4972. res.set_content(body, "text/plain");
  4973. })
  4974. .Put("/empty-no-content-type",
  4975. [&](const Request &req, Response &res) {
  4976. EXPECT_EQ(req.body, "");
  4977. EXPECT_FALSE(req.has_header("Content-Type"));
  4978. EXPECT_EQ("0", req.get_header_value("Content-Length"));
  4979. res.set_content("empty-no-content-type", "text/plain");
  4980. })
  4981. .Put("/put",
  4982. [&](const Request &req, Response &res) {
  4983. EXPECT_EQ(req.body, "PUT");
  4984. res.set_content(req.body, "text/plain");
  4985. })
  4986. .Put("/put-large",
  4987. [&](const Request &req, Response &res) {
  4988. EXPECT_EQ(req.body, LARGE_DATA);
  4989. res.set_content(req.body, "text/plain");
  4990. })
  4991. .Patch("/patch",
  4992. [&](const Request &req, Response &res) {
  4993. EXPECT_EQ(req.body, "PATCH");
  4994. res.set_content(req.body, "text/plain");
  4995. })
  4996. .Delete("/delete",
  4997. [&](const Request & /*req*/, Response &res) {
  4998. res.set_content("DELETE", "text/plain");
  4999. })
  5000. .Delete("/delete-body",
  5001. [&](const Request &req, Response &res) {
  5002. EXPECT_EQ(req.body, "content");
  5003. res.set_content(req.body, "text/plain");
  5004. })
  5005. .Options(R"(\*)",
  5006. [&](const Request & /*req*/, Response &res) {
  5007. res.set_header("Allow", "GET, POST, HEAD, OPTIONS");
  5008. })
  5009. .CustomRoute("PROPFIND", "/dav/:id",
  5010. [&](const Request &req, Response &res) {
  5011. res.set_header("x-body-size",
  5012. std::to_string(req.body.size()));
  5013. res.set_header("x-matched-route", req.matched_route);
  5014. res.set_header("x-dav-id", req.path_params.at("id"));
  5015. res.status = StatusCode::MultiStatus_207;
  5016. res.set_content(req.body, "application/xml");
  5017. })
  5018. .CustomRoute("PROPFIND", R"(/dav-re/(\d+))",
  5019. [&](const Request &req, Response &res) {
  5020. res.set_header("x-dav-match", req.matches[1]);
  5021. res.status = StatusCode::MultiStatus_207;
  5022. })
  5023. .CustomRoute("MKCOL", "/dav-mkcol",
  5024. [&](const Request &req, Response &res) {
  5025. EXPECT_TRUE(req.body.empty());
  5026. res.status = StatusCode::Created_201;
  5027. })
  5028. .CustomRoute(
  5029. "REPORT", "/dav-report",
  5030. [&](const Request & /*req*/, Response &res,
  5031. const ContentReader &content_reader) {
  5032. std::string body;
  5033. content_reader([&](const char *data, size_t data_length) {
  5034. body.append(data, data_length);
  5035. return true;
  5036. });
  5037. res.set_header("x-body-size", std::to_string(body.size()));
  5038. res.status = StatusCode::MultiStatus_207;
  5039. res.set_content(body, "application/xml");
  5040. })
  5041. .Get("/request-target",
  5042. [&](const Request &req, Response & /*res*/) {
  5043. EXPECT_EQ("/request-target?aaa=bbb&ccc=ddd", req.target);
  5044. EXPECT_EQ("bbb", req.get_param_value("aaa"));
  5045. EXPECT_EQ("ddd", req.get_param_value("ccc"));
  5046. })
  5047. .Get("/long-query-value",
  5048. [&](const Request &req, Response & /*res*/) {
  5049. EXPECT_EQ(LONG_QUERY_URL, req.target);
  5050. EXPECT_EQ(LONG_QUERY_VALUE, req.get_param_value("key"));
  5051. })
  5052. .Get("/too-long-query-value",
  5053. [&](const Request &req, Response & /*res*/) {
  5054. EXPECT_EQ(TOO_LONG_QUERY_URL, req.target);
  5055. EXPECT_EQ(TOO_LONG_QUERY_VALUE, req.get_param_value("key"));
  5056. })
  5057. .Get("/array-param",
  5058. [&](const Request &req, Response & /*res*/) {
  5059. EXPECT_EQ(3u, req.get_param_value_count("array"));
  5060. EXPECT_EQ("value1", req.get_param_value("array", 0));
  5061. EXPECT_EQ("value2", req.get_param_value("array", 1));
  5062. EXPECT_EQ("value3", req.get_param_value("array", 2));
  5063. })
  5064. .Get("/array-param-values",
  5065. [&](const Request &req, Response & /*res*/) {
  5066. auto values = req.get_param_values("array");
  5067. EXPECT_EQ(3u, values.size());
  5068. EXPECT_EQ("value1", values[0]);
  5069. EXPECT_EQ("value2", values[1]);
  5070. EXPECT_EQ("value3", values[2]);
  5071. auto empty = req.get_param_values("nonexistent");
  5072. EXPECT_TRUE(empty.empty());
  5073. })
  5074. .Post("/validate-no-multiple-headers",
  5075. [&](const Request &req, Response & /*res*/) {
  5076. EXPECT_EQ(1u, req.get_header_value_count("Content-Length"));
  5077. EXPECT_EQ("5", req.get_header_value("Content-Length"));
  5078. })
  5079. .Post("/content_receiver",
  5080. [&](const Request &req, Response &res,
  5081. const ContentReader &content_reader) {
  5082. if (req.is_multipart_form_data()) {
  5083. std::vector<FormData> items;
  5084. content_reader(
  5085. [&](const FormData &file) {
  5086. items.push_back(file);
  5087. return true;
  5088. },
  5089. [&](const char *data, size_t data_length) {
  5090. items.back().content.append(data, data_length);
  5091. return true;
  5092. });
  5093. EXPECT_EQ(5u, items.size());
  5094. {
  5095. const auto &file = get_file_value(items, "text1");
  5096. EXPECT_TRUE(file.filename.empty());
  5097. EXPECT_EQ("text default", file.content);
  5098. }
  5099. {
  5100. const auto &file = get_file_value(items, "text2");
  5101. EXPECT_TRUE(file.filename.empty());
  5102. EXPECT_EQ("aωb", file.content);
  5103. }
  5104. {
  5105. const auto &file = get_file_value(items, "file1");
  5106. EXPECT_EQ("hello.txt", file.filename);
  5107. EXPECT_EQ("text/plain", file.content_type);
  5108. EXPECT_EQ("h\ne\n\nl\nl\no\n", file.content);
  5109. }
  5110. {
  5111. const auto &file = get_file_value(items, "file2");
  5112. EXPECT_EQ("world.json", file.filename);
  5113. EXPECT_EQ("application/json", file.content_type);
  5114. EXPECT_EQ(R"({\n "world": true\n}\n)", file.content);
  5115. }
  5116. {
  5117. const auto &file = get_file_value(items, "file3");
  5118. EXPECT_TRUE(file.filename.empty());
  5119. EXPECT_EQ("application/octet-stream", file.content_type);
  5120. EXPECT_EQ(0u, file.content.size());
  5121. }
  5122. } else {
  5123. std::string body;
  5124. content_reader([&](const char *data, size_t data_length) {
  5125. EXPECT_EQ(7U, data_length);
  5126. body.append(data, data_length);
  5127. return true;
  5128. });
  5129. EXPECT_EQ(body, "content");
  5130. res.set_content(body, "text/plain");
  5131. }
  5132. })
  5133. .Put("/content_receiver",
  5134. [&](const Request & /*req*/, Response &res,
  5135. const ContentReader &content_reader) {
  5136. std::string body;
  5137. content_reader([&](const char *data, size_t data_length) {
  5138. body.append(data, data_length);
  5139. return true;
  5140. });
  5141. EXPECT_EQ(body, "content");
  5142. res.set_content(body, "text/plain");
  5143. })
  5144. .Patch("/content_receiver",
  5145. [&](const Request & /*req*/, Response &res,
  5146. const ContentReader &content_reader) {
  5147. std::string body;
  5148. content_reader([&](const char *data, size_t data_length) {
  5149. body.append(data, data_length);
  5150. return true;
  5151. });
  5152. EXPECT_EQ(body, "content");
  5153. res.set_content(body, "text/plain");
  5154. })
  5155. .Post("/query-string-and-body",
  5156. [&](const Request &req, Response & /*res*/) {
  5157. ASSERT_TRUE(req.has_param("key"));
  5158. EXPECT_EQ(req.get_param_value("key"), "value");
  5159. EXPECT_EQ(req.body, "content");
  5160. })
  5161. .Get("/last-request",
  5162. [&](const Request &req, Response & /*res*/) {
  5163. EXPECT_EQ("close", req.get_header_value("Connection"));
  5164. })
  5165. .Get(R"(/redirect/(\d+))",
  5166. [&](const Request &req, Response &res) {
  5167. auto num = std::stoi(req.matches[1]) + 1;
  5168. std::string url = "/redirect/" + std::to_string(num);
  5169. res.set_redirect(url);
  5170. })
  5171. .Post("/binary",
  5172. [&](const Request &req, Response &res) {
  5173. EXPECT_EQ(4U, req.body.size());
  5174. EXPECT_EQ("application/octet-stream",
  5175. req.get_header_value("Content-Type"));
  5176. EXPECT_EQ("4", req.get_header_value("Content-Length"));
  5177. res.set_content(req.body, "application/octet-stream");
  5178. })
  5179. .Put("/binary",
  5180. [&](const Request &req, Response &res) {
  5181. EXPECT_EQ(4U, req.body.size());
  5182. EXPECT_EQ("application/octet-stream",
  5183. req.get_header_value("Content-Type"));
  5184. EXPECT_EQ("4", req.get_header_value("Content-Length"));
  5185. res.set_content(req.body, "application/octet-stream");
  5186. })
  5187. .Patch("/binary",
  5188. [&](const Request &req, Response &res) {
  5189. EXPECT_EQ(4U, req.body.size());
  5190. EXPECT_EQ("application/octet-stream",
  5191. req.get_header_value("Content-Type"));
  5192. EXPECT_EQ("4", req.get_header_value("Content-Length"));
  5193. res.set_content(req.body, "application/octet-stream");
  5194. })
  5195. .Delete("/binary",
  5196. [&](const Request &req, Response &res) {
  5197. EXPECT_EQ(4U, req.body.size());
  5198. EXPECT_EQ("application/octet-stream",
  5199. req.get_header_value("Content-Type"));
  5200. EXPECT_EQ("4", req.get_header_value("Content-Length"));
  5201. res.set_content(req.body, "application/octet-stream");
  5202. })
  5203. .Get("/issue1772",
  5204. [&](const Request & /*req*/, Response &res) {
  5205. res.status = 401;
  5206. res.set_header("WWW-Authenticate", "Basic realm=123456");
  5207. })
  5208. .Delete("/issue609",
  5209. [](const httplib::Request &, httplib::Response &res,
  5210. const httplib::ContentReader &) {
  5211. res.set_content("ok", "text/plain");
  5212. })
  5213. #if defined(CPPHTTPLIB_ZLIB_SUPPORT) || defined(CPPHTTPLIB_BROTLI_SUPPORT) || \
  5214. defined(CPPHTTPLIB_ZSTD_SUPPORT)
  5215. .Get("/compress",
  5216. [&](const Request & /*req*/, Response &res) {
  5217. res.set_content(
  5218. "12345678901234567890123456789012345678901234567890123456789"
  5219. "01234567890123456789012345678901234567890",
  5220. "text/plain");
  5221. })
  5222. .Get("/compress-with-charset",
  5223. [&](const Request & /*req*/, Response &res) {
  5224. res.set_content(
  5225. "12345678901234567890123456789012345678901234567890123456789"
  5226. "01234567890123456789012345678901234567890",
  5227. "application/json; charset=utf-8");
  5228. })
  5229. .Get("/nocompress",
  5230. [&](const Request & /*req*/, Response &res) {
  5231. res.set_content(
  5232. "12345678901234567890123456789012345678901234567890123456789"
  5233. "01234567890123456789012345678901234567890",
  5234. "application/octet-stream");
  5235. })
  5236. .Post("/compress-multipart",
  5237. [&](const Request &req, Response & /*res*/) {
  5238. EXPECT_EQ(2u, req.form.fields.size());
  5239. ASSERT_TRUE(!req.form.has_field("???"));
  5240. {
  5241. const auto &text = req.form.get_field("key1");
  5242. EXPECT_EQ("test", text);
  5243. }
  5244. {
  5245. const auto &text = req.form.get_field("key2");
  5246. EXPECT_EQ("--abcdefg123", text);
  5247. }
  5248. })
  5249. #endif
  5250. ;
  5251. persons_["john"] = "programmer";
  5252. t_ = thread([&]() { ASSERT_TRUE(svr_.listen(HOST, PORT)); });
  5253. svr_.wait_until_ready();
  5254. }
  5255. virtual void TearDown() {
  5256. svr_.stop();
  5257. if (!request_threads_.empty()) {
  5258. std::this_thread::sleep_for(std::chrono::seconds(1));
  5259. for (auto &t : request_threads_) {
  5260. t.join();
  5261. }
  5262. }
  5263. t_.join();
  5264. }
  5265. map<string, string> persons_;
  5266. #ifdef CPPHTTPLIB_SSL_ENABLED
  5267. SSLClient cli_;
  5268. SSLServer svr_;
  5269. #else
  5270. Client cli_;
  5271. Server svr_;
  5272. #endif
  5273. thread t_;
  5274. std::vector<thread> request_threads_;
  5275. };
  5276. TEST_F(ServerTest, GetMethod200) {
  5277. auto res = cli_.Get("/hi");
  5278. ASSERT_TRUE(res) << "Error: " << to_string(res.error());
  5279. EXPECT_EQ("HTTP/1.1", res->version);
  5280. EXPECT_EQ(StatusCode::OK_200, res->status);
  5281. EXPECT_EQ("OK", res->reason);
  5282. EXPECT_EQ("text/plain", res->get_header_value("Content-Type"));
  5283. EXPECT_EQ(1U, res->get_header_value_count("Content-Type"));
  5284. EXPECT_EQ("Hello World!", res->body);
  5285. }
  5286. TEST_F(ServerTest, GetEmptyFile) {
  5287. auto res = cli_.Get("/empty_file");
  5288. ASSERT_TRUE(res) << "Error: " << to_string(res.error());
  5289. EXPECT_EQ(StatusCode::OK_200, res->status);
  5290. EXPECT_EQ("application/octet-stream", res->get_header_value("Content-Type"));
  5291. EXPECT_EQ(0, std::stoi(res->get_header_value("Content-Length")));
  5292. EXPECT_EQ("", res->body);
  5293. }
  5294. TEST_F(ServerTest, GetFileContent) {
  5295. auto res = cli_.Get("/file_content");
  5296. ASSERT_TRUE(res) << "Error: " << to_string(res.error());
  5297. EXPECT_EQ(StatusCode::OK_200, res->status);
  5298. EXPECT_EQ("text/html", res->get_header_value("Content-Type"));
  5299. EXPECT_EQ(9, std::stoi(res->get_header_value("Content-Length")));
  5300. EXPECT_EQ("test.html", res->body);
  5301. }
  5302. TEST_F(ServerTest, GetFileContentWithRange) {
  5303. auto res = cli_.Get("/file_content", Headers{{make_range_header({{1, 3}})}});
  5304. ASSERT_TRUE(res) << "Error: " << to_string(res.error());
  5305. EXPECT_EQ(StatusCode::PartialContent_206, res->status);
  5306. EXPECT_EQ("text/html", res->get_header_value("Content-Type"));
  5307. EXPECT_EQ("bytes 1-3/9", res->get_header_value("Content-Range"));
  5308. EXPECT_EQ(3, std::stoi(res->get_header_value("Content-Length")));
  5309. EXPECT_EQ("est", res->body);
  5310. }
  5311. TEST_F(ServerTest, GetFileContentWithContentType) {
  5312. auto res = cli_.Get("/file_content_with_content_type");
  5313. ASSERT_TRUE(res) << "Error: " << to_string(res.error());
  5314. EXPECT_EQ(StatusCode::OK_200, res->status);
  5315. EXPECT_EQ("text/plain", res->get_header_value("Content-Type"));
  5316. EXPECT_EQ(5, std::stoi(res->get_header_value("Content-Length")));
  5317. EXPECT_EQ("file\n", res->body);
  5318. }
  5319. TEST_F(ServerTest, GetInvalidFileContent) {
  5320. auto res = cli_.Get("/invalid_file_content");
  5321. ASSERT_TRUE(res) << "Error: " << to_string(res.error());
  5322. EXPECT_EQ(StatusCode::NotFound_404, res->status);
  5323. }
  5324. TEST_F(ServerTest, GetMethod200withPercentEncoding) {
  5325. auto res = cli_.Get("/%68%69"); // auto res = cli_.Get("/hi");
  5326. ASSERT_TRUE(res) << "Error: " << to_string(res.error());
  5327. EXPECT_EQ("HTTP/1.1", res->version);
  5328. EXPECT_EQ(StatusCode::OK_200, res->status);
  5329. EXPECT_EQ("text/plain", res->get_header_value("Content-Type"));
  5330. EXPECT_EQ(1U, res->get_header_value_count("Content-Type"));
  5331. EXPECT_EQ("Hello World!", res->body);
  5332. }
  5333. TEST_F(ServerTest, GetMethod302) {
  5334. auto res = cli_.Get("/");
  5335. ASSERT_TRUE(res) << "Error: " << to_string(res.error());
  5336. EXPECT_EQ(StatusCode::Found_302, res->status);
  5337. EXPECT_EQ("/hi", res->get_header_value("Location"));
  5338. }
  5339. TEST_F(ServerTest, GetMethod302Redirect) {
  5340. cli_.set_follow_location(true);
  5341. auto res = cli_.Get("/");
  5342. ASSERT_TRUE(res) << "Error: " << to_string(res.error());
  5343. EXPECT_EQ(StatusCode::OK_200, res->status);
  5344. EXPECT_EQ("Hello World!", res->body);
  5345. EXPECT_EQ("/hi", res->location);
  5346. }
  5347. TEST_F(ServerTest, GetMethod404) {
  5348. auto res = cli_.Get("/invalid");
  5349. ASSERT_TRUE(res) << "Error: " << to_string(res.error());
  5350. EXPECT_EQ(StatusCode::NotFound_404, res->status);
  5351. }
  5352. TEST_F(ServerTest, HeadMethod200) {
  5353. auto res = cli_.Head("/hi");
  5354. ASSERT_TRUE(res) << "Error: " << to_string(res.error());
  5355. EXPECT_EQ(StatusCode::OK_200, res->status);
  5356. EXPECT_EQ("text/plain", res->get_header_value("Content-Type"));
  5357. EXPECT_TRUE(res->body.empty());
  5358. }
  5359. TEST_F(ServerTest, HeadMethod200Static) {
  5360. auto res = cli_.Head("/mount/dir/index.html");
  5361. ASSERT_TRUE(res) << "Error: " << to_string(res.error());
  5362. EXPECT_EQ(StatusCode::OK_200, res->status);
  5363. EXPECT_EQ("text/html", res->get_header_value("Content-Type"));
  5364. EXPECT_EQ(104, std::stoi(res->get_header_value("Content-Length")));
  5365. EXPECT_TRUE(res->body.empty());
  5366. }
  5367. TEST_F(ServerTest, HeadMethod404) {
  5368. auto res = cli_.Head("/invalid");
  5369. ASSERT_TRUE(res) << "Error: " << to_string(res.error());
  5370. EXPECT_EQ(StatusCode::NotFound_404, res->status);
  5371. EXPECT_TRUE(res->body.empty());
  5372. }
  5373. TEST_F(ServerTest, GetMethodPersonJohn) {
  5374. auto res = cli_.Get("/person/john");
  5375. ASSERT_TRUE(res) << "Error: " << to_string(res.error());
  5376. EXPECT_EQ(StatusCode::OK_200, res->status);
  5377. EXPECT_EQ("text/plain", res->get_header_value("Content-Type"));
  5378. EXPECT_EQ("programmer", res->body);
  5379. }
  5380. TEST_F(ServerTest, PostMethod1) {
  5381. auto res = cli_.Get("/person/john1");
  5382. ASSERT_TRUE(res) << "Error: " << to_string(res.error());
  5383. ASSERT_EQ(StatusCode::NotFound_404, res->status);
  5384. res = cli_.Post("/person", "name=john1&note=coder",
  5385. "application/x-www-form-urlencoded");
  5386. ASSERT_TRUE(res) << "Error: " << to_string(res.error());
  5387. ASSERT_EQ(StatusCode::OK_200, res->status);
  5388. res = cli_.Get("/person/john1");
  5389. ASSERT_TRUE(res) << "Error: " << to_string(res.error());
  5390. ASSERT_EQ(StatusCode::OK_200, res->status);
  5391. ASSERT_EQ("text/plain", res->get_header_value("Content-Type"));
  5392. ASSERT_EQ("coder", res->body);
  5393. }
  5394. TEST_F(ServerTest, PostMethod2) {
  5395. auto res = cli_.Get("/person/john2");
  5396. ASSERT_TRUE(res) << "Error: " << to_string(res.error());
  5397. ASSERT_EQ(StatusCode::NotFound_404, res->status);
  5398. Params params;
  5399. params.emplace("name", "john2");
  5400. params.emplace("note", "coder");
  5401. res = cli_.Post("/person", params);
  5402. ASSERT_TRUE(res) << "Error: " << to_string(res.error());
  5403. ASSERT_EQ(StatusCode::OK_200, res->status);
  5404. res = cli_.Get("/person/john2");
  5405. ASSERT_TRUE(res) << "Error: " << to_string(res.error());
  5406. ASSERT_EQ(StatusCode::OK_200, res->status);
  5407. ASSERT_EQ("text/plain", res->get_header_value("Content-Type"));
  5408. ASSERT_EQ("coder", res->body);
  5409. }
  5410. TEST_F(ServerTest, PutMethod3) {
  5411. auto res = cli_.Get("/person/john3");
  5412. ASSERT_TRUE(res) << "Error: " << to_string(res.error());
  5413. ASSERT_EQ(StatusCode::NotFound_404, res->status);
  5414. Params params;
  5415. params.emplace("name", "john3");
  5416. params.emplace("note", "coder");
  5417. res = cli_.Put("/person", params);
  5418. ASSERT_TRUE(res) << "Error: " << to_string(res.error());
  5419. ASSERT_EQ(StatusCode::OK_200, res->status);
  5420. res = cli_.Get("/person/john3");
  5421. ASSERT_TRUE(res) << "Error: " << to_string(res.error());
  5422. ASSERT_EQ(StatusCode::OK_200, res->status);
  5423. ASSERT_EQ("text/plain", res->get_header_value("Content-Type"));
  5424. ASSERT_EQ("coder", res->body);
  5425. }
  5426. TEST_F(ServerTest, DeleteMethod1) {
  5427. auto res = cli_.Get("/person/john4");
  5428. ASSERT_TRUE(res) << "Error: " << to_string(res.error());
  5429. ASSERT_EQ(StatusCode::NotFound_404, res->status);
  5430. Params params;
  5431. params.emplace("name", "john4");
  5432. params.emplace("note", "coder");
  5433. res = cli_.Post("/person", params);
  5434. ASSERT_TRUE(res) << "Error: " << to_string(res.error());
  5435. ASSERT_EQ(StatusCode::OK_200, res->status);
  5436. res = cli_.Get("/person/john4");
  5437. ASSERT_TRUE(res) << "Error: " << to_string(res.error());
  5438. ASSERT_EQ(StatusCode::OK_200, res->status);
  5439. ASSERT_EQ("text/plain", res->get_header_value("Content-Type"));
  5440. ASSERT_EQ("coder", res->body);
  5441. Params delete_params;
  5442. delete_params.emplace("name", "john4");
  5443. res = cli_.Delete("/person", delete_params);
  5444. ASSERT_TRUE(res) << "Error: " << to_string(res.error());
  5445. ASSERT_EQ(StatusCode::OK_200, res->status);
  5446. ASSERT_EQ("DELETED", res->body);
  5447. res = cli_.Get("/person/john4");
  5448. ASSERT_TRUE(res) << "Error: " << to_string(res.error());
  5449. ASSERT_EQ(StatusCode::NotFound_404, res->status);
  5450. }
  5451. TEST_F(ServerTest, DeleteMethod2) {
  5452. auto res = cli_.Get("/person/john5");
  5453. ASSERT_TRUE(res) << "Error: " << to_string(res.error());
  5454. ASSERT_EQ(StatusCode::NotFound_404, res->status);
  5455. Params params;
  5456. params.emplace("name", "john5");
  5457. params.emplace("note", "developer");
  5458. res = cli_.Post("/person", params);
  5459. ASSERT_TRUE(res) << "Error: " << to_string(res.error());
  5460. ASSERT_EQ(StatusCode::OK_200, res->status);
  5461. res = cli_.Get("/person/john5");
  5462. ASSERT_TRUE(res) << "Error: " << to_string(res.error());
  5463. ASSERT_EQ(StatusCode::OK_200, res->status);
  5464. ASSERT_EQ("text/plain", res->get_header_value("Content-Type"));
  5465. ASSERT_EQ("developer", res->body);
  5466. Params delete_params;
  5467. delete_params.emplace("name", "john5");
  5468. Headers headers;
  5469. headers.emplace("Custom-Header", "test-value");
  5470. res = cli_.Delete("/person", headers, delete_params);
  5471. ASSERT_TRUE(res) << "Error: " << to_string(res.error());
  5472. ASSERT_EQ(StatusCode::OK_200, res->status);
  5473. ASSERT_EQ("DELETED", res->body);
  5474. res = cli_.Get("/person/john5");
  5475. ASSERT_TRUE(res) << "Error: " << to_string(res.error());
  5476. ASSERT_EQ(StatusCode::NotFound_404, res->status);
  5477. }
  5478. TEST_F(ServerTest, DeleteMethod3) {
  5479. auto res = cli_.Get("/person/john6");
  5480. ASSERT_TRUE(res) << "Error: " << to_string(res.error());
  5481. ASSERT_EQ(StatusCode::NotFound_404, res->status);
  5482. Params params;
  5483. params.emplace("name", "john6");
  5484. params.emplace("note", "tester");
  5485. res = cli_.Post("/person", params);
  5486. ASSERT_TRUE(res) << "Error: " << to_string(res.error());
  5487. ASSERT_EQ(StatusCode::OK_200, res->status);
  5488. res = cli_.Get("/person/john6");
  5489. ASSERT_TRUE(res) << "Error: " << to_string(res.error());
  5490. ASSERT_EQ(StatusCode::OK_200, res->status);
  5491. ASSERT_EQ("text/plain", res->get_header_value("Content-Type"));
  5492. ASSERT_EQ("tester", res->body);
  5493. Params delete_params;
  5494. delete_params.emplace("name", "john6");
  5495. Headers headers;
  5496. headers.emplace("Custom-Header", "test-value");
  5497. res = cli_.Delete("/person", headers, delete_params, nullptr);
  5498. ASSERT_TRUE(res) << "Error: " << to_string(res.error());
  5499. ASSERT_EQ(StatusCode::OK_200, res->status);
  5500. ASSERT_EQ("DELETED", res->body);
  5501. res = cli_.Get("/person/john6");
  5502. ASSERT_TRUE(res) << "Error: " << to_string(res.error());
  5503. ASSERT_EQ(StatusCode::NotFound_404, res->status);
  5504. }
  5505. TEST_F(ServerTest, PostWwwFormUrlEncodedJson) {
  5506. Params params;
  5507. params.emplace("json", JSON_DATA);
  5508. auto res = cli_.Post("/x-www-form-urlencoded-json", params);
  5509. ASSERT_TRUE(res) << "Error: " << to_string(res.error());
  5510. ASSERT_EQ(StatusCode::OK_200, res->status);
  5511. ASSERT_EQ(JSON_DATA, res->body);
  5512. }
  5513. TEST_F(ServerTest, PostEmptyContent) {
  5514. auto res = cli_.Post("/empty", "", "text/plain");
  5515. ASSERT_TRUE(res) << "Error: " << to_string(res.error());
  5516. ASSERT_EQ(StatusCode::OK_200, res->status);
  5517. ASSERT_EQ("empty", res->body);
  5518. }
  5519. TEST_F(ServerTest, PostEmptyContentWithNoContentType) {
  5520. auto res = cli_.Post("/empty-no-content-type");
  5521. ASSERT_TRUE(res) << "Error: " << to_string(res.error());
  5522. ASSERT_EQ(StatusCode::OK_200, res->status);
  5523. ASSERT_EQ("empty-no-content-type", res->body);
  5524. }
  5525. TEST_F(ServerTest, PostPathOnly) {
  5526. auto res = cli_.Post("/path-only");
  5527. ASSERT_TRUE(res) << "Error: " << to_string(res.error());
  5528. ASSERT_EQ(StatusCode::OK_200, res->status);
  5529. ASSERT_EQ("path-only", res->body);
  5530. }
  5531. TEST_F(ServerTest, PostPathAndHeadersOnly) {
  5532. auto res = cli_.Post("/path-headers-only",
  5533. Headers({{"hello", "world"}, {"hello2", "world2"}}));
  5534. ASSERT_TRUE(res) << "Error: " << to_string(res.error());
  5535. ASSERT_EQ(StatusCode::OK_200, res->status);
  5536. ASSERT_EQ("path-headers-only", res->body);
  5537. }
  5538. TEST_F(ServerTest, PostLarge) {
  5539. auto res = cli_.Post("/post-large", LARGE_DATA, "text/plain");
  5540. ASSERT_TRUE(res) << "Error: " << to_string(res.error());
  5541. ASSERT_EQ(StatusCode::OK_200, res->status);
  5542. EXPECT_EQ(LARGE_DATA, res->body);
  5543. }
  5544. TEST_F(ServerTest, PutEmptyContentWithNoContentType) {
  5545. auto res = cli_.Put("/empty-no-content-type");
  5546. ASSERT_TRUE(res) << "Error: " << to_string(res.error());
  5547. ASSERT_EQ(StatusCode::OK_200, res->status);
  5548. ASSERT_EQ("empty-no-content-type", res->body);
  5549. }
  5550. TEST_F(ServerTest, GetMethodDir) {
  5551. auto res = cli_.Get("/dir/");
  5552. ASSERT_TRUE(res) << "Error: " << to_string(res.error());
  5553. EXPECT_EQ(StatusCode::OK_200, res->status);
  5554. EXPECT_EQ("text/html", res->get_header_value("Content-Type"));
  5555. auto body = R"(<html>
  5556. <head>
  5557. </head>
  5558. <body>
  5559. <a href="/dir/test.html">Test</a>
  5560. <a href="/hi">hi</a>
  5561. </body>
  5562. </html>
  5563. )";
  5564. EXPECT_EQ(body, res->body);
  5565. }
  5566. TEST_F(ServerTest, GetMethodDirTest) {
  5567. auto res = cli_.Get("/dir/test.html");
  5568. ASSERT_TRUE(res) << "Error: " << to_string(res.error());
  5569. EXPECT_EQ(StatusCode::OK_200, res->status);
  5570. EXPECT_EQ("text/html", res->get_header_value("Content-Type"));
  5571. EXPECT_EQ("test.html", res->body);
  5572. }
  5573. TEST_F(ServerTest, GetMethodDirTestWithDoubleDots) {
  5574. auto res = cli_.Get("/dir/../dir/test.html");
  5575. ASSERT_TRUE(res) << "Error: " << to_string(res.error());
  5576. EXPECT_EQ(StatusCode::OK_200, res->status);
  5577. EXPECT_EQ("text/html", res->get_header_value("Content-Type"));
  5578. EXPECT_EQ("test.html", res->body);
  5579. }
  5580. TEST_F(ServerTest, GetMethodInvalidPath) {
  5581. auto res = cli_.Get("/dir/../test.html");
  5582. ASSERT_TRUE(res) << "Error: " << to_string(res.error());
  5583. EXPECT_EQ(StatusCode::NotFound_404, res->status);
  5584. }
  5585. TEST_F(ServerTest, GetMethodOutOfBaseDir) {
  5586. auto res = cli_.Get("/../www/dir/test.html");
  5587. ASSERT_TRUE(res) << "Error: " << to_string(res.error());
  5588. EXPECT_EQ(StatusCode::NotFound_404, res->status);
  5589. }
  5590. TEST_F(ServerTest, GetMethodOutOfBaseDir2) {
  5591. auto res = cli_.Get("/dir/../../www/dir/test.html");
  5592. ASSERT_TRUE(res) << "Error: " << to_string(res.error());
  5593. EXPECT_EQ(StatusCode::NotFound_404, res->status);
  5594. }
  5595. TEST_F(ServerTest, GetMethodDirMountTest) {
  5596. auto res = cli_.Get("/mount/dir/test.html");
  5597. ASSERT_TRUE(res) << "Error: " << to_string(res.error());
  5598. EXPECT_EQ(StatusCode::OK_200, res->status);
  5599. EXPECT_EQ("text/html", res->get_header_value("Content-Type"));
  5600. EXPECT_EQ("test.html", res->body);
  5601. }
  5602. TEST_F(ServerTest, GetMethodDirMountTestWithDoubleDots) {
  5603. auto res = cli_.Get("/mount/dir/../dir/test.html");
  5604. ASSERT_TRUE(res) << "Error: " << to_string(res.error());
  5605. EXPECT_EQ(StatusCode::OK_200, res->status);
  5606. EXPECT_EQ("text/html", res->get_header_value("Content-Type"));
  5607. EXPECT_EQ("test.html", res->body);
  5608. }
  5609. TEST_F(ServerTest, GetMethodInvalidMountPath) {
  5610. auto res = cli_.Get("/mount/dir/../test.html");
  5611. ASSERT_TRUE(res) << "Error: " << to_string(res.error());
  5612. EXPECT_EQ(StatusCode::NotFound_404, res->status);
  5613. }
  5614. TEST_F(ServerTest, GetMethodEmbeddedNUL) {
  5615. auto res = cli_.Get("/mount/dir/test.html%00.js");
  5616. ASSERT_TRUE(res) << "Error: " << to_string(res.error());
  5617. EXPECT_EQ(StatusCode::NotFound_404, res->status);
  5618. }
  5619. TEST_F(ServerTest, GetMethodOutOfBaseDirMount) {
  5620. auto res = cli_.Get("/mount/../www2/dir/test.html");
  5621. ASSERT_TRUE(res) << "Error: " << to_string(res.error());
  5622. EXPECT_EQ(StatusCode::NotFound_404, res->status);
  5623. }
  5624. TEST_F(ServerTest, GetMethodOutOfBaseDirMount2) {
  5625. auto res = cli_.Get("/mount/dir/../../www2/dir/test.html");
  5626. ASSERT_TRUE(res) << "Error: " << to_string(res.error());
  5627. EXPECT_EQ(StatusCode::NotFound_404, res->status);
  5628. }
  5629. TEST_F(ServerTest, GetMethodOutOfBaseDirMountWithBackslash) {
  5630. auto res = cli_.Get("/mount/%2e%2e%5c/www2/dir/test.html");
  5631. ASSERT_TRUE(res) << "Error: " << to_string(res.error());
  5632. EXPECT_EQ(StatusCode::NotFound_404, res->status);
  5633. }
  5634. TEST_F(ServerTest, PostMethod303) {
  5635. auto res = cli_.Post("/1", "body", "text/plain");
  5636. ASSERT_TRUE(res) << "Error: " << to_string(res.error());
  5637. EXPECT_EQ(StatusCode::SeeOther_303, res->status);
  5638. EXPECT_EQ("/2", res->get_header_value("Location"));
  5639. }
  5640. TEST_F(ServerTest, PostMethod303Redirect) {
  5641. cli_.set_follow_location(true);
  5642. auto res = cli_.Post("/1", "body", "text/plain");
  5643. ASSERT_TRUE(res) << "Error: " << to_string(res.error());
  5644. EXPECT_EQ(StatusCode::OK_200, res->status);
  5645. EXPECT_EQ("redirected.", res->body);
  5646. EXPECT_EQ("/2", res->location);
  5647. }
  5648. TEST_F(ServerTest, UserDefinedMIMETypeMapping) {
  5649. auto res = cli_.Get("/dir/test.abcde");
  5650. ASSERT_TRUE(res) << "Error: " << to_string(res.error());
  5651. EXPECT_EQ(StatusCode::OK_200, res->status);
  5652. EXPECT_EQ("text/abcde", res->get_header_value("Content-Type"));
  5653. EXPECT_EQ("abcde", res->body);
  5654. }
  5655. TEST_F(ServerTest, StaticFileRange) {
  5656. auto res =
  5657. cli_.Get("/dir/test.abcde", Headers{{make_range_header({{2, 3}})}});
  5658. ASSERT_TRUE(res) << "Error: " << to_string(res.error());
  5659. EXPECT_EQ(StatusCode::PartialContent_206, res->status);
  5660. EXPECT_EQ("text/abcde", res->get_header_value("Content-Type"));
  5661. EXPECT_EQ("2", res->get_header_value("Content-Length"));
  5662. EXPECT_EQ(true, res->has_header("Content-Range"));
  5663. EXPECT_EQ("bytes 2-3/5", res->get_header_value("Content-Range"));
  5664. EXPECT_EQ(std::string("cd"), res->body);
  5665. }
  5666. TEST_F(ServerTest, StaticFileRanges) {
  5667. auto res = cli_.Get("/dir/test.abcde",
  5668. Headers{{make_range_header({{1, 2}, {4, -1}})}});
  5669. ASSERT_TRUE(res) << "Error: " << to_string(res.error());
  5670. EXPECT_EQ(StatusCode::PartialContent_206, res->status);
  5671. EXPECT_TRUE(
  5672. res->get_header_value("Content-Type")
  5673. .find(
  5674. "multipart/byteranges; boundary=--cpp-httplib-multipart-data-") ==
  5675. 0);
  5676. EXPECT_EQ("266", res->get_header_value("Content-Length"));
  5677. }
  5678. TEST_F(ServerTest, StaticFileRangeHead) {
  5679. auto res = cli_.Head("/dir/test.abcde", {{make_range_header({{2, 3}})}});
  5680. ASSERT_TRUE(res) << "Error: " << to_string(res.error());
  5681. EXPECT_EQ(StatusCode::PartialContent_206, res->status);
  5682. EXPECT_EQ("text/abcde", res->get_header_value("Content-Type"));
  5683. EXPECT_EQ("2", res->get_header_value("Content-Length"));
  5684. EXPECT_EQ(true, res->has_header("Content-Range"));
  5685. EXPECT_EQ("bytes 2-3/5", res->get_header_value("Content-Range"));
  5686. }
  5687. TEST_F(ServerTest, StaticFileRangeBigFile) {
  5688. auto res = cli_.Get("/dir/1MB.txt", Headers{{make_range_header({{-1, 5}})}});
  5689. ASSERT_TRUE(res) << "Error: " << to_string(res.error());
  5690. EXPECT_EQ(StatusCode::PartialContent_206, res->status);
  5691. EXPECT_EQ("text/plain", res->get_header_value("Content-Type"));
  5692. EXPECT_EQ("5", res->get_header_value("Content-Length"));
  5693. EXPECT_EQ(true, res->has_header("Content-Range"));
  5694. EXPECT_EQ("bytes 1048571-1048575/1048576",
  5695. res->get_header_value("Content-Range"));
  5696. EXPECT_EQ("LAST\n", res->body);
  5697. }
  5698. TEST_F(ServerTest, StaticFileRangeBigFile2) {
  5699. auto res =
  5700. cli_.Get("/dir/1MB.txt", Headers{{make_range_header({{1, 4097}})}});
  5701. ASSERT_TRUE(res) << "Error: " << to_string(res.error());
  5702. EXPECT_EQ(StatusCode::PartialContent_206, res->status);
  5703. EXPECT_EQ("text/plain", res->get_header_value("Content-Type"));
  5704. EXPECT_EQ("4097", res->get_header_value("Content-Length"));
  5705. EXPECT_EQ(true, res->has_header("Content-Range"));
  5706. EXPECT_EQ("bytes 1-4097/1048576", res->get_header_value("Content-Range"));
  5707. }
  5708. TEST_F(ServerTest, StaticFileBigFile) {
  5709. auto res = cli_.Get("/dir/1MB.txt");
  5710. ASSERT_TRUE(res) << "Error: " << to_string(res.error());
  5711. EXPECT_EQ(StatusCode::OK_200, res->status);
  5712. EXPECT_EQ("text/plain", res->get_header_value("Content-Type"));
  5713. EXPECT_EQ("1048576", res->get_header_value("Content-Length"));
  5714. }
  5715. TEST_F(ServerTest, InvalidBaseDirMount) {
  5716. EXPECT_EQ(false, svr_.set_mount_point("invalid_mount_point", "./www3"));
  5717. }
  5718. TEST_F(ServerTest, Binary) {
  5719. std::vector<char> binary{0x00, 0x01, 0x02, 0x03};
  5720. auto res = cli_.Post("/binary", binary.data(), binary.size(),
  5721. "application/octet-stream");
  5722. ASSERT_TRUE(res) << "Error: " << to_string(res.error());
  5723. ASSERT_EQ(StatusCode::OK_200, res->status);
  5724. ASSERT_EQ(4U, res->body.size());
  5725. res = cli_.Put("/binary", binary.data(), binary.size(),
  5726. "application/octet-stream");
  5727. ASSERT_TRUE(res) << "Error: " << to_string(res.error());
  5728. ASSERT_EQ(StatusCode::OK_200, res->status);
  5729. ASSERT_EQ(4U, res->body.size());
  5730. res = cli_.Patch("/binary", binary.data(), binary.size(),
  5731. "application/octet-stream");
  5732. ASSERT_TRUE(res) << "Error: " << to_string(res.error());
  5733. ASSERT_EQ(StatusCode::OK_200, res->status);
  5734. ASSERT_EQ(4U, res->body.size());
  5735. res = cli_.Delete("/binary", binary.data(), binary.size(),
  5736. "application/octet-stream");
  5737. ASSERT_TRUE(res) << "Error: " << to_string(res.error());
  5738. ASSERT_EQ(StatusCode::OK_200, res->status);
  5739. ASSERT_EQ(4U, res->body.size());
  5740. }
  5741. TEST_F(ServerTest, BinaryString) {
  5742. auto binary = std::string("\x00\x01\x02\x03", 4);
  5743. auto res = cli_.Post("/binary", binary, "application/octet-stream");
  5744. ASSERT_TRUE(res) << "Error: " << to_string(res.error());
  5745. ASSERT_EQ(StatusCode::OK_200, res->status);
  5746. ASSERT_EQ(4U, res->body.size());
  5747. res = cli_.Put("/binary", binary, "application/octet-stream");
  5748. ASSERT_TRUE(res) << "Error: " << to_string(res.error());
  5749. ASSERT_EQ(StatusCode::OK_200, res->status);
  5750. ASSERT_EQ(4U, res->body.size());
  5751. res = cli_.Patch("/binary", binary, "application/octet-stream");
  5752. ASSERT_TRUE(res) << "Error: " << to_string(res.error());
  5753. ASSERT_EQ(StatusCode::OK_200, res->status);
  5754. ASSERT_EQ(4U, res->body.size());
  5755. res = cli_.Delete("/binary", binary, "application/octet-stream");
  5756. ASSERT_TRUE(res) << "Error: " << to_string(res.error());
  5757. ASSERT_EQ(StatusCode::OK_200, res->status);
  5758. ASSERT_EQ(4U, res->body.size());
  5759. }
  5760. TEST_F(ServerTest, EmptyRequest) {
  5761. auto res = cli_.Get("");
  5762. ASSERT_TRUE(!res);
  5763. EXPECT_EQ(Error::Connection, res.error());
  5764. }
  5765. TEST_F(ServerTest, LongRequest) {
  5766. std::string request;
  5767. for (size_t i = 0; i < 545; i++) {
  5768. request += "/TooLongRequest";
  5769. }
  5770. request += "OK";
  5771. auto res = cli_.Get(request.c_str());
  5772. ASSERT_TRUE(res) << "Error: " << to_string(res.error());
  5773. EXPECT_EQ(StatusCode::NotFound_404, res->status);
  5774. }
  5775. TEST_F(ServerTest, TooLongRequest) {
  5776. std::string request;
  5777. for (size_t i = 0; i < 546; i++) {
  5778. request += "/TooLongRequest";
  5779. }
  5780. request += "_NG";
  5781. auto start = std::chrono::high_resolution_clock::now();
  5782. cli_.set_keep_alive(true);
  5783. auto res = cli_.Get(request.c_str());
  5784. auto end = std::chrono::high_resolution_clock::now();
  5785. auto elapsed =
  5786. std::chrono::duration_cast<std::chrono::milliseconds>(end - start)
  5787. .count();
  5788. ASSERT_TRUE(res) << "Error: " << to_string(res.error());
  5789. EXPECT_EQ(StatusCode::UriTooLong_414, res->status);
  5790. EXPECT_LE(elapsed, 1000);
  5791. EXPECT_EQ("close", res->get_header_value("Connection"));
  5792. EXPECT_FALSE(cli_.is_socket_open());
  5793. }
  5794. TEST_F(ServerTest, AlmostTooLongRequest) {
  5795. // test for #2046 - URI length check shouldn't include other content on req
  5796. // line URI is max URI length, minus 14 other chars in req line (GET, space,
  5797. // leading /, space, HTTP/1.1)
  5798. std::string request =
  5799. "/" + string(CPPHTTPLIB_REQUEST_URI_MAX_LENGTH - 14, 'A');
  5800. auto res = cli_.Get(request.c_str());
  5801. ASSERT_TRUE(res) << "Error: " << to_string(res.error());
  5802. EXPECT_EQ(StatusCode::NotFound_404, res->status);
  5803. }
  5804. TEST_F(ServerTest, LongHeader) {
  5805. Request req;
  5806. req.method = "GET";
  5807. req.path = "/hi";
  5808. std::string host_and_port;
  5809. host_and_port += HOST;
  5810. host_and_port += ":";
  5811. host_and_port += std::to_string(PORT);
  5812. req.headers.emplace("Host", host_and_port.c_str());
  5813. req.headers.emplace("Accept", "*/*");
  5814. req.headers.emplace("User-Agent", "cpp-httplib/0.1");
  5815. req.headers.emplace(
  5816. "Header-Name",
  5817. "@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@"
  5818. "@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@"
  5819. "@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@"
  5820. "@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@"
  5821. "@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@"
  5822. "@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@"
  5823. "@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@"
  5824. "@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@"
  5825. "@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@"
  5826. "@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@"
  5827. "@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@"
  5828. "@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@"
  5829. "@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@"
  5830. "@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@"
  5831. "@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@"
  5832. "@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@"
  5833. "@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@"
  5834. "@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@"
  5835. "@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@"
  5836. "@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@"
  5837. "@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@"
  5838. "@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@"
  5839. "@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@"
  5840. "@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@"
  5841. "@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@"
  5842. "@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@"
  5843. "@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@"
  5844. "@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@"
  5845. "@@@@@@@@@@@@@@@@");
  5846. auto res = std::make_shared<Response>();
  5847. auto error = Error::Success;
  5848. auto ret = cli_.send(req, *res, error);
  5849. ASSERT_TRUE(ret);
  5850. EXPECT_EQ(StatusCode::OK_200, res->status);
  5851. }
  5852. TEST_F(ServerTest, LongQueryValue) {
  5853. auto start = std::chrono::high_resolution_clock::now();
  5854. cli_.set_keep_alive(true);
  5855. auto res = cli_.Get(LONG_QUERY_URL.c_str());
  5856. auto end = std::chrono::high_resolution_clock::now();
  5857. auto elapsed =
  5858. std::chrono::duration_cast<std::chrono::milliseconds>(end - start)
  5859. .count();
  5860. ASSERT_TRUE(res) << "Error: " << to_string(res.error());
  5861. EXPECT_EQ(StatusCode::UriTooLong_414, res->status);
  5862. EXPECT_LE(elapsed, 1000);
  5863. EXPECT_EQ("close", res->get_header_value("Connection"));
  5864. EXPECT_FALSE(cli_.is_socket_open());
  5865. }
  5866. TEST_F(ServerTest, TooLongQueryValue) {
  5867. auto res = cli_.Get(TOO_LONG_QUERY_URL.c_str());
  5868. ASSERT_FALSE(res);
  5869. EXPECT_EQ(Error::Read, res.error());
  5870. }
  5871. TEST_F(ServerTest, TooLongHeader) {
  5872. Request req;
  5873. req.method = "GET";
  5874. req.path = "/hi";
  5875. std::string host_and_port;
  5876. host_and_port += HOST;
  5877. host_and_port += ":";
  5878. host_and_port += std::to_string(PORT);
  5879. req.headers.emplace("Host", host_and_port.c_str());
  5880. req.headers.emplace("Accept", "*/*");
  5881. req.headers.emplace("User-Agent", "cpp-httplib/0.1");
  5882. req.headers.emplace(
  5883. "Header-Name",
  5884. "@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@"
  5885. "@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@"
  5886. "@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@"
  5887. "@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@"
  5888. "@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@"
  5889. "@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@"
  5890. "@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@"
  5891. "@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@"
  5892. "@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@"
  5893. "@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@"
  5894. "@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@"
  5895. "@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@"
  5896. "@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@"
  5897. "@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@"
  5898. "@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@"
  5899. "@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@"
  5900. "@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@"
  5901. "@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@"
  5902. "@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@"
  5903. "@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@"
  5904. "@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@"
  5905. "@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@"
  5906. "@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@"
  5907. "@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@"
  5908. "@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@"
  5909. "@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@"
  5910. "@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@"
  5911. "@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@"
  5912. "@@@@@@@@@@@@@@@@@");
  5913. auto res = std::make_shared<Response>();
  5914. auto error = Error::Success;
  5915. auto ret = cli_.send(req, *res, error);
  5916. ASSERT_TRUE(ret);
  5917. EXPECT_EQ(StatusCode::OK_200, res->status);
  5918. }
  5919. TEST_F(ServerTest, HeaderCountAtLimit) {
  5920. // Test with headers just under the 100 limit
  5921. httplib::Headers headers;
  5922. // Add 95 custom headers (the client will add Host, User-Agent, Accept, etc.)
  5923. // This should keep us just under the 100 header limit
  5924. for (int i = 0; i < 95; i++) {
  5925. std::string name = "X-Test-Header-" + std::to_string(i);
  5926. std::string value = "value" + std::to_string(i);
  5927. headers.emplace(name, value);
  5928. }
  5929. // This should work fine as we're under the limit
  5930. auto res = cli_.Get("/hi", headers);
  5931. EXPECT_TRUE(res);
  5932. if (res) { EXPECT_EQ(StatusCode::OK_200, res->status); }
  5933. }
  5934. TEST_F(ServerTest, HeaderCountExceedsLimit) {
  5935. // Test with many headers to exceed the 100 limit
  5936. httplib::Headers headers;
  5937. // Add 150 headers to definitely exceed the 100 limit
  5938. for (int i = 0; i < 150; i++) {
  5939. std::string name = "X-Test-Header-" + std::to_string(i);
  5940. std::string value = "value" + std::to_string(i);
  5941. headers.emplace(name, value);
  5942. }
  5943. // This should fail due to exceeding header count limit
  5944. cli_.set_keep_alive(true);
  5945. auto res = cli_.Get("/hi", headers);
  5946. // The server should respond with 400 Bad Request
  5947. ASSERT_TRUE(res) << "Error: " << to_string(res.error());
  5948. EXPECT_EQ(StatusCode::BadRequest_400, res->status);
  5949. EXPECT_EQ("close", res->get_header_value("Connection"));
  5950. EXPECT_FALSE(cli_.is_socket_open());
  5951. }
  5952. TEST_F(ServerTest, PercentEncoding) {
  5953. auto res = cli_.Get("/e%6edwith%");
  5954. ASSERT_TRUE(res) << "Error: " << to_string(res.error());
  5955. EXPECT_EQ(StatusCode::OK_200, res->status);
  5956. }
  5957. TEST_F(ServerTest, PercentEncodingUnicode) {
  5958. auto res = cli_.Get("/e%u006edwith%");
  5959. ASSERT_TRUE(res) << "Error: " << to_string(res.error());
  5960. EXPECT_EQ(StatusCode::OK_200, res->status);
  5961. }
  5962. TEST_F(ServerTest, InvalidPercentEncoding) {
  5963. auto res = cli_.Get("/%endwith%");
  5964. ASSERT_TRUE(res) << "Error: " << to_string(res.error());
  5965. EXPECT_EQ(StatusCode::NotFound_404, res->status);
  5966. }
  5967. TEST_F(ServerTest, InvalidPercentEncodingUnicode) {
  5968. auto res = cli_.Get("/%uendwith%");
  5969. ASSERT_TRUE(res) << "Error: " << to_string(res.error());
  5970. EXPECT_EQ(StatusCode::NotFound_404, res->status);
  5971. }
  5972. TEST_F(ServerTest, EndWithPercentCharacterInQuery) {
  5973. auto res = cli_.Get("/hello?aaa=bbb%");
  5974. ASSERT_TRUE(res) << "Error: " << to_string(res.error());
  5975. EXPECT_EQ(StatusCode::NotFound_404, res->status);
  5976. }
  5977. TEST_F(ServerTest, PlusSignEncoding) {
  5978. auto res = cli_.Get("/a+%2Bb?a %2bb=a %2Bb");
  5979. ASSERT_TRUE(res) << "Error: " << to_string(res.error());
  5980. EXPECT_EQ(StatusCode::OK_200, res->status);
  5981. EXPECT_EQ("a +b", res->body);
  5982. }
  5983. TEST_F(ServerTest, HeaderCountSecurityTest) {
  5984. // This test simulates a potential DoS attack using many headers
  5985. // to verify our security fix prevents memory exhaustion
  5986. httplib::Headers attack_headers;
  5987. // Attempt to add many headers like an attacker would (200 headers to far
  5988. // exceed limit)
  5989. for (int i = 0; i < 200; i++) {
  5990. std::string name = "X-Attack-Header-" + std::to_string(i);
  5991. std::string value = "attack_payload_" + std::to_string(i);
  5992. attack_headers.emplace(name, value);
  5993. }
  5994. // Try to POST with excessive headers
  5995. cli_.set_keep_alive(true);
  5996. auto res = cli_.Post("/", attack_headers, "test_data", "text/plain");
  5997. // Should either fail or return 400 Bad Request due to security limit
  5998. if (res) {
  5999. // If we get a response, it should be 400 Bad Request
  6000. EXPECT_EQ(StatusCode::BadRequest_400, res->status);
  6001. EXPECT_EQ("close", res->get_header_value("Connection"));
  6002. }
  6003. EXPECT_FALSE(cli_.is_socket_open());
  6004. }
  6005. TEST_F(ServerTest, MultipartFormData) {
  6006. UploadFormDataItems items = {
  6007. {"text1", "text default", "", ""},
  6008. {"text2", "aωb", "", ""},
  6009. {"file1", "h\ne\n\nl\nl\no\n", "hello.txt", "text/plain"},
  6010. {"file2", "{\n \"world\", true\n}\n", "world.json", "application/json"},
  6011. {"file3", "", "", "application/octet-stream"},
  6012. {"file4", "", "", " application/json tmp-string "}};
  6013. auto res = cli_.Post("/multipart", items);
  6014. ASSERT_TRUE(res) << "Error: " << to_string(res.error());
  6015. EXPECT_EQ(StatusCode::OK_200, res->status);
  6016. }
  6017. TEST_F(ServerTest, MultipartFormDataMultiFileValues) {
  6018. UploadFormDataItems items = {
  6019. {"text", "default text", "", ""},
  6020. {"multi_text1", "aaaaa", "", ""},
  6021. {"multi_text1", "bbbbb", "", ""},
  6022. {"multi_file1", "h\ne\n\nl\nl\no\n", "hello.txt", "text/plain"},
  6023. {"multi_file1", "{\n \"world\", true\n}\n", "world.json",
  6024. "application/json"},
  6025. };
  6026. auto res = cli_.Post("/multipart/multi_file_values", items);
  6027. ASSERT_TRUE(res) << "Error: " << to_string(res.error());
  6028. EXPECT_EQ(StatusCode::OK_200, res->status);
  6029. }
  6030. TEST_F(ServerTest, CaseInsensitiveHeaderName) {
  6031. auto res = cli_.Get("/hi");
  6032. ASSERT_TRUE(res) << "Error: " << to_string(res.error());
  6033. EXPECT_EQ(StatusCode::OK_200, res->status);
  6034. EXPECT_EQ("text/plain", res->get_header_value("content-type"));
  6035. EXPECT_EQ("Hello World!", res->body);
  6036. }
  6037. TEST_F(ServerTest, CaseInsensitiveTransferEncoding) {
  6038. Request req;
  6039. req.method = "POST";
  6040. req.path = "/chunked";
  6041. std::string host_and_port;
  6042. host_and_port += HOST;
  6043. host_and_port += ":";
  6044. host_and_port += std::to_string(PORT);
  6045. req.headers.emplace("Host", host_and_port.c_str());
  6046. req.headers.emplace("Accept", "*/*");
  6047. req.headers.emplace("User-Agent", "cpp-httplib/0.1");
  6048. req.headers.emplace("Content-Type", "text/plain");
  6049. req.headers.emplace("Content-Length", "0");
  6050. req.headers.emplace(
  6051. "Transfer-Encoding",
  6052. "Chunked"); // Note, "Chunked" rather than typical "chunked".
  6053. // Client does not chunk, so make a chunked body manually.
  6054. req.body = "4\r\ndech\r\nf\r\nunked post body\r\n0\r\n\r\n";
  6055. auto res = std::make_shared<Response>();
  6056. auto error = Error::Success;
  6057. auto ret = cli_.send(req, *res, error);
  6058. ASSERT_TRUE(ret);
  6059. EXPECT_EQ(StatusCode::OK_200, res->status);
  6060. }
  6061. template <typename ClientT>
  6062. static void expect_chunked_body_status(ClientT &cli, const char *body,
  6063. int expected_status) {
  6064. Request req;
  6065. req.method = "POST";
  6066. req.path = "/chunked";
  6067. std::string host_and_port;
  6068. host_and_port += HOST;
  6069. host_and_port += ":";
  6070. host_and_port += std::to_string(PORT);
  6071. req.headers.emplace("Host", host_and_port.c_str());
  6072. req.headers.emplace("Content-Length", "0");
  6073. req.headers.emplace("Transfer-Encoding", "chunked");
  6074. req.body = body;
  6075. auto res = std::make_shared<Response>();
  6076. auto error = Error::Success;
  6077. ASSERT_TRUE(cli.send(req, *res, error));
  6078. EXPECT_EQ(expected_status, res->status);
  6079. }
  6080. // GHSA-h6wq-j5mv-f3q8: the server must reject malformed chunk-size lines
  6081. // rather than treat them as valid lengths.
  6082. template <typename ClientT>
  6083. static void expect_chunked_body_rejected(ClientT &cli, const char *body) {
  6084. expect_chunked_body_status(cli, body, StatusCode::BadRequest_400);
  6085. }
  6086. TEST_F(ServerTest, RejectsNegativeChunkSize) {
  6087. expect_chunked_body_rejected(cli_, "-2\r\nAAAA\r\n0\r\n\r\n");
  6088. }
  6089. TEST_F(ServerTest, RejectsChunkSizeWithLeadingPlus) {
  6090. expect_chunked_body_rejected(
  6091. cli_, "+4\r\ndech\r\nf\r\nunked post body\r\n0\r\n\r\n");
  6092. }
  6093. // RFC 9112 §7.1.1: a chunk-ext is made of tokens and quoted-strings, so the
  6094. // chunk-size line carries no CR, LF or other control character ahead of its
  6095. // terminator. Such a line must be refused rather than read as extension text.
  6096. TEST_F(ServerTest, RejectsBareLFInChunkExtension) {
  6097. expect_chunked_body_rejected(
  6098. cli_, "4;\nxx\r\ndech\r\nf\r\nunked post body\r\n0\r\n\r\n");
  6099. }
  6100. TEST_F(ServerTest, RejectsBareLFAfterChunkSize) {
  6101. expect_chunked_body_rejected(
  6102. cli_, "4\nxx\r\ndech\r\nf\r\nunked post body\r\n0\r\n\r\n");
  6103. }
  6104. TEST_F(ServerTest, RejectsBareCRInChunkExtension) {
  6105. expect_chunked_body_rejected(
  6106. cli_, "4;a\rb\r\ndech\r\nf\r\nunked post body\r\n0\r\n\r\n");
  6107. }
  6108. TEST_F(ServerTest, RejectsControlCharacterInChunkExtension) {
  6109. // The literal stays split: a hex escape consumes every hex digit that
  6110. // follows, so "\x01b" would be the single byte \x1b, not \x01 then 'b'.
  6111. expect_chunked_body_rejected(
  6112. cli_, "4;a\x01"
  6113. "b\r\ndech\r\nf\r\nunked post body\r\n0\r\n\r\n");
  6114. }
  6115. TEST_F(ServerTest, AcceptsChunkExtension) {
  6116. expect_chunked_body_status(cli_,
  6117. "4;name=value\r\ndech\r\n"
  6118. "f ; note=\"a;b c\"\r\nunked post body\r\n"
  6119. "0;last\r\n\r\n",
  6120. StatusCode::OK_200);
  6121. }
  6122. TEST_F(ServerTest, GetStreamed2) {
  6123. auto res = cli_.Get("/streamed", Headers{{make_range_header({{2, 3}})}});
  6124. ASSERT_TRUE(res) << "Error: " << to_string(res.error());
  6125. EXPECT_EQ(StatusCode::PartialContent_206, res->status);
  6126. EXPECT_EQ("2", res->get_header_value("Content-Length"));
  6127. EXPECT_EQ(true, res->has_header("Content-Range"));
  6128. EXPECT_EQ("bytes 2-3/6", res->get_header_value("Content-Range"));
  6129. EXPECT_EQ(std::string("ab"), res->body);
  6130. }
  6131. TEST_F(ServerTest, GetStreamed) {
  6132. auto res = cli_.Get("/streamed");
  6133. ASSERT_TRUE(res) << "Error: " << to_string(res.error());
  6134. EXPECT_EQ(StatusCode::OK_200, res->status);
  6135. EXPECT_EQ("6", res->get_header_value("Content-Length"));
  6136. EXPECT_EQ(std::string("aaabbb"), res->body);
  6137. }
  6138. TEST_F(ServerTest, GetStreamedWithoutLengthWithRange) {
  6139. auto res = cli_.Get("/streamed-without-length",
  6140. Headers{make_range_header({{0, -1}})});
  6141. ASSERT_TRUE(res) << "Error: " << to_string(res.error());
  6142. EXPECT_EQ(StatusCode::OK_200, res->status);
  6143. EXPECT_EQ(false, res->has_header("Content-Length"));
  6144. EXPECT_EQ(false, res->has_header("Content-Range"));
  6145. EXPECT_EQ(std::string("abcdefg"), res->body);
  6146. }
  6147. TEST_F(ServerTest, GetStreamedWithRange1) {
  6148. auto res =
  6149. cli_.Get("/streamed-with-range", Headers{{make_range_header({{3, 5}})}});
  6150. ASSERT_TRUE(res) << "Error: " << to_string(res.error());
  6151. EXPECT_EQ(StatusCode::PartialContent_206, res->status);
  6152. EXPECT_EQ("3", res->get_header_value("Content-Length"));
  6153. EXPECT_EQ(true, res->has_header("Content-Range"));
  6154. EXPECT_EQ("bytes 3-5/7", res->get_header_value("Content-Range"));
  6155. EXPECT_EQ(std::string("def"), res->body);
  6156. }
  6157. TEST_F(ServerTest, GetStreamedWithRange2) {
  6158. auto res =
  6159. cli_.Get("/streamed-with-range", Headers{{make_range_header({{1, -1}})}});
  6160. ASSERT_TRUE(res) << "Error: " << to_string(res.error());
  6161. EXPECT_EQ(StatusCode::PartialContent_206, res->status);
  6162. EXPECT_EQ("6", res->get_header_value("Content-Length"));
  6163. EXPECT_EQ(true, res->has_header("Content-Range"));
  6164. EXPECT_EQ("bytes 1-6/7", res->get_header_value("Content-Range"));
  6165. EXPECT_EQ(std::string("bcdefg"), res->body);
  6166. }
  6167. TEST_F(ServerTest, GetStreamedWithRangeSuffix1) {
  6168. auto res = cli_.Get("/streamed-with-range", Headers{{"Range", "bytes=-3"}});
  6169. ASSERT_TRUE(res) << "Error: " << to_string(res.error());
  6170. EXPECT_EQ(StatusCode::PartialContent_206, res->status);
  6171. EXPECT_EQ("3", res->get_header_value("Content-Length"));
  6172. EXPECT_EQ(true, res->has_header("Content-Range"));
  6173. EXPECT_EQ("bytes 4-6/7", res->get_header_value("Content-Range"));
  6174. EXPECT_EQ(std::string("efg"), res->body);
  6175. }
  6176. TEST_F(ServerTest, GetStreamedWithRangeSuffix2) {
  6177. // RFC 9110 14.1.2: a suffix-length longer than the representation selects
  6178. // the entire representation.
  6179. for (auto range : {"bytes=-8", "bytes=-9999"}) {
  6180. auto res = cli_.Get("/streamed-with-range", Headers{{"Range", range}});
  6181. ASSERT_TRUE(res) << "Error: " << to_string(res.error());
  6182. EXPECT_EQ(StatusCode::PartialContent_206, res->status) << range;
  6183. EXPECT_EQ("7", res->get_header_value("Content-Length")) << range;
  6184. EXPECT_EQ("bytes 0-6/7", res->get_header_value("Content-Range")) << range;
  6185. EXPECT_EQ(std::string("abcdefg"), res->body) << range;
  6186. }
  6187. }
  6188. TEST_F(ServerTest, GetStreamedWithRangeSuffixZero) {
  6189. auto res =
  6190. cli_.Get("/streamed-with-range?error", Headers{{"Range", "bytes=-0"}});
  6191. ASSERT_TRUE(res) << "Error: " << to_string(res.error());
  6192. EXPECT_EQ(StatusCode::RangeNotSatisfiable_416, res->status);
  6193. EXPECT_EQ("0", res->get_header_value("Content-Length"));
  6194. EXPECT_EQ(false, res->has_header("Content-Range"));
  6195. EXPECT_EQ(0U, res->body.size());
  6196. }
  6197. TEST_F(ServerTest, GetStreamedWithRangeAndNonPartialStatus) {
  6198. // Only a 206 is served as a partial representation. Under any other status
  6199. // `apply_ranges()` reported the full content length, so the body must match
  6200. // that header, and the content provider must never be asked for an offset
  6201. // outside the representation.
  6202. auto check = [&](int status, const char *range) {
  6203. auto path =
  6204. std::string("/streamed-with-range?status=") + std::to_string(status);
  6205. auto ctx = path + " Range: " + range;
  6206. auto res = cli_.Get(path, Headers{{"Range", range}});
  6207. ASSERT_TRUE(res) << ctx << " Error: " << to_string(res.error());
  6208. EXPECT_EQ(status, res->status) << ctx;
  6209. EXPECT_EQ("7", res->get_header_value("Content-Length")) << ctx;
  6210. EXPECT_EQ("text/plain", res->get_header_value("Content-Type")) << ctx;
  6211. EXPECT_FALSE(res->has_header("Content-Range")) << ctx;
  6212. EXPECT_EQ(std::string("abcdefg"), res->body) << ctx;
  6213. };
  6214. // Non-2xx: `detail::range_error()` never validated these ranges at all.
  6215. check(403, "bytes=3-5");
  6216. // The offset is far past the representation.
  6217. check(403, "bytes=100000-100200");
  6218. // `first_pos` is still -1 here, and the bounds asserts in
  6219. // `get_range_offset_and_length()` are compiled out under NDEBUG.
  6220. check(403, "bytes=-3");
  6221. // `apply_ranges()` makes no boundary for a non-206 response, so the
  6222. // multipart branch would have written one that is empty.
  6223. check(403, "bytes=1-2, 4-5");
  6224. // 2xx but not 206: the ranges were validated, yet the Content-Length still
  6225. // covers the whole representation.
  6226. check(200, "bytes=3-5");
  6227. check(200, "bytes=1-2, 4-5");
  6228. }
  6229. TEST_F(ServerTest, GetStreamedWithRangeError) {
  6230. auto res =
  6231. cli_.Get("/streamed-with-range",
  6232. Headers{{"Range", "bytes=92233720368547758079223372036854775806-"
  6233. "92233720368547758079223372036854775807"}});
  6234. ASSERT_TRUE(res) << "Error: " << to_string(res.error());
  6235. EXPECT_EQ(StatusCode::RangeNotSatisfiable_416, res->status);
  6236. EXPECT_EQ("0", res->get_header_value("Content-Length"));
  6237. EXPECT_EQ(false, res->has_header("Content-Range"));
  6238. EXPECT_EQ(0U, res->body.size());
  6239. }
  6240. TEST_F(ServerTest, GetRangeWithMaxLongLength) {
  6241. auto res = cli_.Get(
  6242. "/with-range",
  6243. Headers{{"Range",
  6244. "bytes=0-" + std::to_string(std::numeric_limits<long>::max())},
  6245. {"Accept-Encoding", ""}});
  6246. ASSERT_TRUE(res) << "Error: " << to_string(res.error());
  6247. EXPECT_EQ(StatusCode::PartialContent_206, res->status);
  6248. EXPECT_EQ("7", res->get_header_value("Content-Length"));
  6249. EXPECT_EQ(true, res->has_header("Content-Range"));
  6250. EXPECT_EQ("bytes 0-6/7", res->get_header_value("Content-Range"));
  6251. EXPECT_EQ(std::string("abcdefg"), res->body);
  6252. }
  6253. TEST_F(ServerTest, GetRangeWithZeroToInfinite) {
  6254. auto res = cli_.Get("/with-range", Headers{
  6255. {"Range", "bytes=0-"},
  6256. {"Accept-Encoding", ""},
  6257. });
  6258. ASSERT_TRUE(res) << "Error: " << to_string(res.error());
  6259. EXPECT_EQ(StatusCode::PartialContent_206, res->status);
  6260. EXPECT_EQ("7", res->get_header_value("Content-Length"));
  6261. EXPECT_EQ(true, res->has_header("Content-Range"));
  6262. EXPECT_EQ("bytes 0-6/7", res->get_header_value("Content-Range"));
  6263. EXPECT_EQ(std::string("abcdefg"), res->body);
  6264. }
  6265. TEST_F(ServerTest, GetStreamedWithRangeMultipart) {
  6266. auto res = cli_.Get("/streamed-with-range",
  6267. Headers{{make_range_header({{1, 2}, {4, 5}})}});
  6268. ASSERT_TRUE(res) << "Error: " << to_string(res.error());
  6269. EXPECT_EQ(StatusCode::PartialContent_206, res->status);
  6270. EXPECT_EQ("267", res->get_header_value("Content-Length"));
  6271. EXPECT_EQ(false, res->has_header("Content-Range"));
  6272. EXPECT_EQ(267U, res->body.size());
  6273. // Check that both range contents are present
  6274. EXPECT_TRUE(res->body.find("bc\r\n") != std::string::npos);
  6275. EXPECT_TRUE(res->body.find("ef\r\n") != std::string::npos);
  6276. // Check that Content-Range headers are present for both ranges
  6277. EXPECT_TRUE(res->body.find("Content-Range: bytes 1-2/7") !=
  6278. std::string::npos);
  6279. EXPECT_TRUE(res->body.find("Content-Range: bytes 4-5/7") !=
  6280. std::string::npos);
  6281. }
  6282. TEST_F(ServerTest, GetStreamedWithTooManyRanges) {
  6283. Ranges ranges;
  6284. for (size_t i = 0; i < CPPHTTPLIB_RANGE_MAX_COUNT + 1; i++) {
  6285. ranges.emplace_back(0, -1);
  6286. }
  6287. auto res = cli_.Get("/streamed-with-range?error",
  6288. Headers{{make_range_header(ranges)}});
  6289. ASSERT_TRUE(res) << "Error: " << to_string(res.error());
  6290. EXPECT_EQ(StatusCode::RangeNotSatisfiable_416, res->status);
  6291. EXPECT_EQ("0", res->get_header_value("Content-Length"));
  6292. EXPECT_EQ(false, res->has_header("Content-Range"));
  6293. EXPECT_EQ(0U, res->body.size());
  6294. }
  6295. TEST_F(ServerTest, GetStreamedWithOverwrapping) {
  6296. auto res = cli_.Get("/streamed-with-range",
  6297. Headers{{make_range_header({{1, 4}, {2, 5}})}});
  6298. ASSERT_TRUE(res) << "Error: " << to_string(res.error());
  6299. EXPECT_EQ(StatusCode::PartialContent_206, res->status);
  6300. EXPECT_EQ(5U, res->body.size());
  6301. // Check that overlapping ranges are coalesced into a single range
  6302. EXPECT_EQ("bcdef", res->body);
  6303. EXPECT_EQ("bytes 1-5/7", res->get_header_value("Content-Range"));
  6304. // Should be single range, not multipart
  6305. EXPECT_TRUE(res->has_header("Content-Range"));
  6306. EXPECT_EQ("text/plain", res->get_header_value("Content-Type"));
  6307. }
  6308. TEST_F(ServerTest, GetStreamedWithNonAscendingRanges) {
  6309. auto res = cli_.Get("/streamed-with-range",
  6310. Headers{{make_range_header({{4, 5}, {0, 2}})}});
  6311. ASSERT_TRUE(res) << "Error: " << to_string(res.error());
  6312. EXPECT_EQ(StatusCode::PartialContent_206, res->status);
  6313. EXPECT_EQ(268U, res->body.size());
  6314. // Check that both range contents are present
  6315. EXPECT_TRUE(res->body.find("ef\r\n") != std::string::npos);
  6316. EXPECT_TRUE(res->body.find("abc\r\n") != std::string::npos);
  6317. // Check that Content-Range headers are present for both ranges
  6318. EXPECT_TRUE(res->body.find("Content-Range: bytes 4-5/7") !=
  6319. std::string::npos);
  6320. EXPECT_TRUE(res->body.find("Content-Range: bytes 0-2/7") !=
  6321. std::string::npos);
  6322. }
  6323. TEST_F(ServerTest, GetStreamedWithDuplicateRanges) {
  6324. auto res = cli_.Get("/streamed-with-range",
  6325. Headers{{make_range_header({{0, 2}, {0, 2}})}});
  6326. ASSERT_TRUE(res) << "Error: " << to_string(res.error());
  6327. EXPECT_EQ(StatusCode::PartialContent_206, res->status);
  6328. EXPECT_EQ(269U, res->body.size());
  6329. // Check that both duplicate range contents are present
  6330. size_t first_abc = res->body.find("abc\r\n");
  6331. EXPECT_TRUE(first_abc != std::string::npos);
  6332. size_t second_abc = res->body.find("abc\r\n", first_abc + 1);
  6333. EXPECT_TRUE(second_abc != std::string::npos);
  6334. // Check that Content-Range headers are present for both ranges
  6335. size_t first_range = res->body.find("Content-Range: bytes 0-2/7");
  6336. EXPECT_TRUE(first_range != std::string::npos);
  6337. size_t second_range =
  6338. res->body.find("Content-Range: bytes 0-2/7", first_range + 1);
  6339. EXPECT_TRUE(second_range != std::string::npos);
  6340. }
  6341. TEST_F(ServerTest, GetStreamedWithRangesMoreThanTwoOverwrapping) {
  6342. auto res =
  6343. cli_.Get("/streamed-with-range?error",
  6344. Headers{{make_range_header({{0, 1}, {1, 2}, {2, 3}, {3, 4}})}});
  6345. ASSERT_TRUE(res) << "Error: " << to_string(res.error());
  6346. EXPECT_EQ(StatusCode::RangeNotSatisfiable_416, res->status);
  6347. EXPECT_EQ("0", res->get_header_value("Content-Length"));
  6348. EXPECT_EQ(false, res->has_header("Content-Range"));
  6349. EXPECT_EQ(0U, res->body.size());
  6350. }
  6351. TEST_F(ServerTest, GetStreamedEndless) {
  6352. uint64_t offset = 0;
  6353. auto res = cli_.Get("/streamed-cancel",
  6354. [&](const char * /*data*/, uint64_t data_length) {
  6355. if (offset < 100) {
  6356. offset += data_length;
  6357. return true;
  6358. }
  6359. return false;
  6360. });
  6361. ASSERT_TRUE(!res);
  6362. EXPECT_EQ(Error::Canceled, res.error());
  6363. }
  6364. TEST_F(ServerTest, ClientStop) {
  6365. std::atomic_size_t count{4};
  6366. std::vector<std::thread> threads;
  6367. for (auto i = count.load(); i != 0; --i) {
  6368. threads.emplace_back([&]() {
  6369. auto res = cli_.Get("/streamed-cancel",
  6370. [&](const char *, uint64_t) { return true; });
  6371. --count;
  6372. ASSERT_TRUE(!res);
  6373. EXPECT_TRUE(res.error() == Error::Canceled ||
  6374. res.error() == Error::Read || res.error() == Error::Write);
  6375. });
  6376. }
  6377. std::this_thread::sleep_for(std::chrono::seconds(2));
  6378. while (count != 0) {
  6379. cli_.stop();
  6380. std::this_thread::sleep_for(std::chrono::milliseconds(10));
  6381. }
  6382. for (auto &t : threads) {
  6383. t.join();
  6384. }
  6385. }
  6386. TEST_F(ServerTest, GetWithRange1) {
  6387. auto res = cli_.Get("/with-range", Headers{
  6388. make_range_header({{3, 5}}),
  6389. {"Accept-Encoding", ""},
  6390. });
  6391. ASSERT_TRUE(res) << "Error: " << to_string(res.error());
  6392. EXPECT_EQ(StatusCode::PartialContent_206, res->status);
  6393. EXPECT_EQ("3", res->get_header_value("Content-Length"));
  6394. EXPECT_EQ(true, res->has_header("Content-Range"));
  6395. EXPECT_EQ("bytes 3-5/7", res->get_header_value("Content-Range"));
  6396. EXPECT_EQ(std::string("def"), res->body);
  6397. }
  6398. TEST_F(ServerTest, GetWithRange2) {
  6399. auto res = cli_.Get("/with-range", Headers{
  6400. make_range_header({{1, -1}}),
  6401. {"Accept-Encoding", ""},
  6402. });
  6403. ASSERT_TRUE(res) << "Error: " << to_string(res.error());
  6404. EXPECT_EQ(StatusCode::PartialContent_206, res->status);
  6405. EXPECT_EQ("6", res->get_header_value("Content-Length"));
  6406. EXPECT_EQ(true, res->has_header("Content-Range"));
  6407. EXPECT_EQ("bytes 1-6/7", res->get_header_value("Content-Range"));
  6408. EXPECT_EQ(std::string("bcdefg"), res->body);
  6409. }
  6410. TEST_F(ServerTest, GetWithRange3) {
  6411. auto res = cli_.Get("/with-range", Headers{
  6412. make_range_header({{0, 0}}),
  6413. {"Accept-Encoding", ""},
  6414. });
  6415. ASSERT_TRUE(res) << "Error: " << to_string(res.error());
  6416. EXPECT_EQ(StatusCode::PartialContent_206, res->status);
  6417. EXPECT_EQ("1", res->get_header_value("Content-Length"));
  6418. EXPECT_EQ(true, res->has_header("Content-Range"));
  6419. EXPECT_EQ("bytes 0-0/7", res->get_header_value("Content-Range"));
  6420. EXPECT_EQ(std::string("a"), res->body);
  6421. }
  6422. TEST_F(ServerTest, GetWithRange4) {
  6423. auto res = cli_.Get("/with-range", Headers{
  6424. make_range_header({{-1, 2}}),
  6425. {"Accept-Encoding", ""},
  6426. });
  6427. ASSERT_TRUE(res) << "Error: " << to_string(res.error());
  6428. EXPECT_EQ(StatusCode::PartialContent_206, res->status);
  6429. EXPECT_EQ("2", res->get_header_value("Content-Length"));
  6430. EXPECT_EQ(true, res->has_header("Content-Range"));
  6431. EXPECT_EQ("bytes 5-6/7", res->get_header_value("Content-Range"));
  6432. EXPECT_EQ(std::string("fg"), res->body);
  6433. }
  6434. TEST_F(ServerTest, GetWithRange5) {
  6435. auto res = cli_.Get("/with-range", Headers{
  6436. make_range_header({{0, 5}}),
  6437. {"Accept-Encoding", ""},
  6438. });
  6439. ASSERT_TRUE(res) << "Error: " << to_string(res.error());
  6440. EXPECT_EQ(StatusCode::PartialContent_206, res->status);
  6441. EXPECT_EQ("6", res->get_header_value("Content-Length"));
  6442. EXPECT_EQ(true, res->has_header("Content-Range"));
  6443. EXPECT_EQ("bytes 0-5/7", res->get_header_value("Content-Range"));
  6444. EXPECT_EQ(std::string("abcdef"), res->body);
  6445. }
  6446. TEST_F(ServerTest, GetWithRangeOffsetGreaterThanContent) {
  6447. auto res =
  6448. cli_.Get("/with-range", Headers{{make_range_header({{10000, 20000}})}});
  6449. ASSERT_TRUE(res) << "Error: " << to_string(res.error());
  6450. EXPECT_EQ(StatusCode::RangeNotSatisfiable_416, res->status);
  6451. }
  6452. TEST_F(ServerTest, GetWithRangeMultipart) {
  6453. auto res =
  6454. cli_.Get("/with-range", Headers{{make_range_header({{1, 2}, {4, 5}})}});
  6455. ASSERT_TRUE(res) << "Error: " << to_string(res.error());
  6456. EXPECT_EQ(StatusCode::PartialContent_206, res->status);
  6457. EXPECT_EQ("267", res->get_header_value("Content-Length"));
  6458. EXPECT_EQ(false, res->has_header("Content-Range"));
  6459. EXPECT_EQ(267U, res->body.size());
  6460. }
  6461. TEST_F(ServerTest, GetWithRangeMultipartOffsetGreaterThanContent) {
  6462. auto res = cli_.Get("/with-range",
  6463. Headers{{make_range_header({{-1, 2}, {10000, 30000}})}});
  6464. ASSERT_TRUE(res) << "Error: " << to_string(res.error());
  6465. EXPECT_EQ(StatusCode::RangeNotSatisfiable_416, res->status);
  6466. }
  6467. TEST_F(ServerTest, GetWithRangeCustomizedResponse) {
  6468. auto res = cli_.Get("/with-range-customized-response",
  6469. Headers{{make_range_header({{1, 2}})}});
  6470. ASSERT_TRUE(res) << "Error: " << to_string(res.error());
  6471. EXPECT_EQ(StatusCode::BadRequest_400, res->status);
  6472. EXPECT_EQ(true, res->has_header("Content-Length"));
  6473. EXPECT_EQ(false, res->has_header("Content-Range"));
  6474. EXPECT_EQ(JSON_DATA, res->body);
  6475. }
  6476. TEST_F(ServerTest, GetWithRangeMultipartCustomizedResponseMultipleRange) {
  6477. auto res = cli_.Get("/with-range-customized-response",
  6478. Headers{{make_range_header({{1, 2}, {4, 5}})}});
  6479. ASSERT_TRUE(res) << "Error: " << to_string(res.error());
  6480. EXPECT_EQ(StatusCode::BadRequest_400, res->status);
  6481. EXPECT_EQ(true, res->has_header("Content-Length"));
  6482. EXPECT_EQ(false, res->has_header("Content-Range"));
  6483. EXPECT_EQ(JSON_DATA, res->body);
  6484. }
  6485. TEST_F(ServerTest, Issue1772) {
  6486. auto res = cli_.Get("/issue1772", Headers{{make_range_header({{1000, -1}})}});
  6487. ASSERT_TRUE(res) << "Error: " << to_string(res.error());
  6488. EXPECT_EQ(StatusCode::Unauthorized_401, res->status);
  6489. }
  6490. TEST_F(ServerTest, Issue609) {
  6491. auto res = cli_.Delete("/issue609");
  6492. ASSERT_TRUE(res) << "Error: " << to_string(res.error());
  6493. EXPECT_EQ(StatusCode::OK_200, res->status);
  6494. EXPECT_EQ(std::string("ok"), res->body);
  6495. }
  6496. TEST_F(ServerTest, GetStreamedChunked) {
  6497. auto res = cli_.Get("/streamed-chunked");
  6498. ASSERT_TRUE(res) << "Error: " << to_string(res.error());
  6499. EXPECT_EQ(StatusCode::OK_200, res->status);
  6500. EXPECT_EQ(std::string("123456789"), res->body);
  6501. }
  6502. TEST_F(ServerTest, GetStreamedChunked2) {
  6503. auto res = cli_.Get("/streamed-chunked2");
  6504. ASSERT_TRUE(res) << "Error: " << to_string(res.error());
  6505. EXPECT_EQ(StatusCode::OK_200, res->status);
  6506. EXPECT_EQ(std::string("123456789"), res->body);
  6507. }
  6508. TEST_F(ServerTest, GetStreamedChunkedWithTrailer) {
  6509. auto res = cli_.Get("/streamed-chunked-with-trailer");
  6510. ASSERT_TRUE(res) << "Error: " << to_string(res.error());
  6511. EXPECT_EQ(StatusCode::OK_200, res->status);
  6512. EXPECT_EQ(std::string("123456789"), res->body);
  6513. EXPECT_TRUE(res->has_header("Trailer"));
  6514. EXPECT_EQ(1U, res->get_header_value_count("Trailer"));
  6515. EXPECT_EQ(std::string("Dummy1, Dummy2"), res->get_header_value("Trailer"));
  6516. // Trailers are now stored separately from headers (security fix)
  6517. EXPECT_EQ(2U, res->trailers.size());
  6518. EXPECT_TRUE(res->has_trailer("Dummy1"));
  6519. EXPECT_TRUE(res->has_trailer("Dummy2"));
  6520. EXPECT_FALSE(res->has_trailer("Dummy3"));
  6521. EXPECT_EQ(std::string("DummyVal1"), res->get_trailer_value("Dummy1"));
  6522. EXPECT_EQ(std::string("DummyVal2"), res->get_trailer_value("Dummy2"));
  6523. // Verify trailers are NOT in headers (security verification)
  6524. EXPECT_EQ(std::string(""), res->get_header_value("Dummy1"));
  6525. EXPECT_EQ(std::string(""), res->get_header_value("Dummy2"));
  6526. }
  6527. TEST_F(ServerTest, LargeChunkedPost) {
  6528. Request req;
  6529. req.method = "POST";
  6530. req.path = "/large-chunked";
  6531. std::string host_and_port;
  6532. host_and_port += HOST;
  6533. host_and_port += ":";
  6534. host_and_port += std::to_string(PORT);
  6535. req.headers.emplace("Host", host_and_port.c_str());
  6536. req.headers.emplace("Accept", "*/*");
  6537. req.headers.emplace("User-Agent", "cpp-httplib/0.1");
  6538. req.headers.emplace("Content-Type", "text/plain");
  6539. req.headers.emplace("Content-Length", "0");
  6540. req.headers.emplace("Transfer-Encoding", "chunked");
  6541. std::string long_string(30 * 1024u, 'a');
  6542. std::string chunk = "7800\r\n" + long_string + "\r\n";
  6543. // Attempt to make a large enough post to exceed OS buffers, to test that
  6544. // the server handles short reads if the full chunk data isn't available.
  6545. req.body = chunk + chunk + chunk + chunk + chunk + chunk + "0\r\n\r\n";
  6546. auto res = std::make_shared<Response>();
  6547. auto error = Error::Success;
  6548. auto ret = cli_.send(req, *res, error);
  6549. ASSERT_TRUE(ret);
  6550. EXPECT_EQ(StatusCode::OK_200, res->status);
  6551. }
  6552. TEST_F(ServerTest, GetMethodRemoteAddr) {
  6553. auto res = cli_.Get("/remote_addr");
  6554. ASSERT_TRUE(res) << "Error: " << to_string(res.error());
  6555. EXPECT_EQ(StatusCode::OK_200, res->status);
  6556. EXPECT_EQ("text/plain", res->get_header_value("Content-Type"));
  6557. EXPECT_TRUE(res->body == "::1" || res->body == "127.0.0.1");
  6558. }
  6559. TEST_F(ServerTest, GetMethodLocalAddr) {
  6560. auto res = cli_.Get("/local_addr");
  6561. ASSERT_TRUE(res) << "Error: " << to_string(res.error());
  6562. EXPECT_EQ(StatusCode::OK_200, res->status);
  6563. EXPECT_EQ("text/plain", res->get_header_value("Content-Type"));
  6564. EXPECT_TRUE(res->body == std::string("::1:").append(to_string(PORT)) ||
  6565. res->body == std::string("127.0.0.1:").append(to_string(PORT)));
  6566. }
  6567. TEST_F(ServerTest, HTTPResponseSplitting) {
  6568. auto res = cli_.Get("/http_response_splitting");
  6569. ASSERT_TRUE(res) << "Error: " << to_string(res.error());
  6570. EXPECT_EQ(StatusCode::OK_200, res->status);
  6571. }
  6572. TEST_F(ServerTest, SlowRequest) {
  6573. request_threads_.emplace_back([this]() { auto res = cli_.Get("/slow"); });
  6574. request_threads_.emplace_back([this]() { auto res = cli_.Get("/slow"); });
  6575. request_threads_.emplace_back([this]() { auto res = cli_.Get("/slow"); });
  6576. }
  6577. #if 0
  6578. TEST_F(ServerTest, SlowPost) {
  6579. char buffer[64 * 1024];
  6580. memset(buffer, 0x42, sizeof(buffer));
  6581. auto res = cli_.Post(
  6582. "/slowpost", 64 * 1024 * 1024,
  6583. [&](size_t /*offset*/, size_t /*length*/, DataSink &sink) {
  6584. auto ret = sink.write(buffer, sizeof(buffer));
  6585. EXPECT_TRUE(ret);
  6586. return true;
  6587. },
  6588. "text/plain");
  6589. ASSERT_TRUE(res) << "Error: " << to_string(res.error());
  6590. EXPECT_EQ(StatusCode::OK_200, res->status);
  6591. }
  6592. TEST_F(ServerTest, SlowPostFail) {
  6593. char buffer[64 * 1024];
  6594. memset(buffer, 0x42, sizeof(buffer));
  6595. cli_.set_write_timeout(std::chrono::seconds(0));
  6596. auto res = cli_.Post(
  6597. "/slowpost", 64 * 1024 * 1024,
  6598. [&](size_t /*offset*/, size_t /*length*/, DataSink &sink) {
  6599. sink.write(buffer, sizeof(buffer));
  6600. return true;
  6601. },
  6602. "text/plain");
  6603. ASSERT_TRUE(!res);
  6604. EXPECT_EQ(Error::Write, res.error());
  6605. }
  6606. #endif
  6607. TEST_F(ServerTest, Put) {
  6608. auto res = cli_.Put("/put", "PUT", "text/plain");
  6609. ASSERT_TRUE(res) << "Error: " << to_string(res.error());
  6610. EXPECT_EQ(StatusCode::OK_200, res->status);
  6611. EXPECT_EQ("PUT", res->body);
  6612. }
  6613. TEST_F(ServerTest, PutWithContentProvider) {
  6614. auto res = cli_.Put(
  6615. "/put", 3,
  6616. [](size_t /*offset*/, size_t /*length*/, DataSink &sink) {
  6617. sink.os << "PUT";
  6618. return true;
  6619. },
  6620. "text/plain");
  6621. ASSERT_TRUE(res) << "Error: " << to_string(res.error());
  6622. EXPECT_EQ(StatusCode::OK_200, res->status);
  6623. EXPECT_EQ("PUT", res->body);
  6624. }
  6625. TEST_F(ServerTest, PostWithContentProviderAbort) {
  6626. auto res = cli_.Post(
  6627. "/post", 42,
  6628. [](size_t /*offset*/, size_t /*length*/, DataSink & /*sink*/) {
  6629. return false;
  6630. },
  6631. "text/plain");
  6632. ASSERT_TRUE(!res);
  6633. EXPECT_EQ(Error::Canceled, res.error());
  6634. }
  6635. TEST_F(ServerTest, PutWithContentProviderWithoutLength) {
  6636. auto res = cli_.Put(
  6637. "/put",
  6638. [](size_t /*offset*/, DataSink &sink) {
  6639. sink.os << "PUT";
  6640. sink.done();
  6641. return true;
  6642. },
  6643. "text/plain");
  6644. ASSERT_TRUE(res) << "Error: " << to_string(res.error());
  6645. EXPECT_EQ(StatusCode::OK_200, res->status);
  6646. EXPECT_EQ("PUT", res->body);
  6647. }
  6648. TEST_F(ServerTest, PostWithContentProviderWithoutLengthAbort) {
  6649. auto res = cli_.Post(
  6650. "/post", [](size_t /*offset*/, DataSink & /*sink*/) { return false; },
  6651. "text/plain");
  6652. ASSERT_TRUE(!res);
  6653. EXPECT_EQ(Error::Canceled, res.error());
  6654. }
  6655. TEST_F(ServerTest, PostLoopBack) {
  6656. std::string body;
  6657. auto res = cli_.Post(
  6658. "/post-loopback", 9,
  6659. [](size_t /*offset*/, size_t length, DataSink &sink) {
  6660. EXPECT_EQ(9u, length);
  6661. sink.write("123", 3);
  6662. sink.write("456", 3);
  6663. sink.write("789", 3);
  6664. return true;
  6665. },
  6666. "text/plain",
  6667. [&body](const char *data, size_t data_length) {
  6668. body.append(data, data_length);
  6669. return true;
  6670. });
  6671. ASSERT_TRUE(res) << "Error: " << to_string(res.error());
  6672. EXPECT_EQ(StatusCode::OK_200, res->status);
  6673. EXPECT_EQ("123456789", body);
  6674. }
  6675. TEST_F(ServerTest, PutLoopBack) {
  6676. std::string body;
  6677. auto res = cli_.Put(
  6678. "/put-loopback", 9,
  6679. [](size_t /*offset*/, size_t length, DataSink &sink) {
  6680. EXPECT_EQ(9u, length);
  6681. sink.write("123", 3);
  6682. sink.write("456", 3);
  6683. sink.write("789", 3);
  6684. return true;
  6685. },
  6686. "text/plain",
  6687. [&body](const char *data, size_t data_length) {
  6688. body.append(data, data_length);
  6689. return true;
  6690. });
  6691. ASSERT_TRUE(res) << "Error: " << to_string(res.error());
  6692. EXPECT_EQ(StatusCode::OK_200, res->status);
  6693. EXPECT_EQ("123456789", body);
  6694. }
  6695. TEST_F(ServerTest, PatchLoopBack) {
  6696. std::string body;
  6697. auto res = cli_.Patch(
  6698. "/patch-loopback", 9,
  6699. [](size_t /*offset*/, size_t length, DataSink &sink) {
  6700. EXPECT_EQ(9u, length);
  6701. sink.write("123", 3);
  6702. sink.write("456", 3);
  6703. sink.write("789", 3);
  6704. return true;
  6705. },
  6706. "text/plain",
  6707. [&body](const char *data, size_t data_length) {
  6708. body.append(data, data_length);
  6709. return true;
  6710. });
  6711. ASSERT_TRUE(res) << "Error: " << to_string(res.error());
  6712. EXPECT_EQ(StatusCode::OK_200, res->status);
  6713. EXPECT_EQ("123456789", body);
  6714. }
  6715. TEST_F(ServerTest, PostLoopBackWithoutRequestContentLength) {
  6716. std::string body;
  6717. auto res = cli_.Post(
  6718. "/post-loopback",
  6719. [](size_t /*offset*/, DataSink &sink) {
  6720. sink.write("123", 3);
  6721. sink.write("456", 3);
  6722. sink.write("789", 3);
  6723. sink.done();
  6724. return true;
  6725. },
  6726. "text/plain",
  6727. [&body](const char *data, size_t data_length) {
  6728. body.append(data, data_length);
  6729. return true;
  6730. });
  6731. ASSERT_TRUE(res) << "Error: " << to_string(res.error());
  6732. EXPECT_EQ(StatusCode::OK_200, res->status);
  6733. EXPECT_EQ("123456789", body);
  6734. }
  6735. #ifdef CPPHTTPLIB_ZLIB_SUPPORT
  6736. TEST_F(ServerTest, PutWithContentProviderWithGzip) {
  6737. cli_.set_compress(true);
  6738. auto res = cli_.Put(
  6739. "/put", 3,
  6740. [](size_t /*offset*/, size_t /*length*/, DataSink &sink) {
  6741. sink.os << "PUT";
  6742. return true;
  6743. },
  6744. "text/plain");
  6745. ASSERT_TRUE(res) << "Error: " << to_string(res.error());
  6746. EXPECT_EQ(StatusCode::OK_200, res->status);
  6747. EXPECT_EQ("PUT", res->body);
  6748. }
  6749. TEST_F(ServerTest, PostWithContentProviderWithGzipAbort) {
  6750. cli_.set_compress(true);
  6751. auto res = cli_.Post(
  6752. "/post", 42,
  6753. [](size_t /*offset*/, size_t /*length*/, DataSink & /*sink*/) {
  6754. return false;
  6755. },
  6756. "text/plain");
  6757. ASSERT_TRUE(!res);
  6758. EXPECT_EQ(Error::Canceled, res.error());
  6759. }
  6760. TEST_F(ServerTest, PutWithContentProviderWithoutLengthWithGzip) {
  6761. cli_.set_compress(true);
  6762. auto res = cli_.Put(
  6763. "/put",
  6764. [](size_t /*offset*/, DataSink &sink) {
  6765. sink.os << "PUT";
  6766. sink.done();
  6767. return true;
  6768. },
  6769. "text/plain");
  6770. ASSERT_TRUE(res) << "Error: " << to_string(res.error());
  6771. EXPECT_EQ(StatusCode::OK_200, res->status);
  6772. EXPECT_EQ("PUT", res->body);
  6773. }
  6774. TEST_F(ServerTest, PostWithContentProviderWithoutLengthWithGzipAbort) {
  6775. cli_.set_compress(true);
  6776. auto res = cli_.Post(
  6777. "/post", [](size_t /*offset*/, DataSink & /*sink*/) { return false; },
  6778. "text/plain");
  6779. ASSERT_TRUE(!res);
  6780. EXPECT_EQ(Error::Canceled, res.error());
  6781. }
  6782. TEST_F(ServerTest, PutLargeFileWithGzip) {
  6783. cli_.set_compress(true);
  6784. auto res = cli_.Put("/put-large", LARGE_DATA, "text/plain");
  6785. ASSERT_TRUE(res) << "Error: " << to_string(res.error());
  6786. EXPECT_EQ(StatusCode::OK_200, res->status);
  6787. EXPECT_EQ(LARGE_DATA, res->body);
  6788. }
  6789. TEST_F(ServerTest, PutLargeFileWithGzip2) {
  6790. #ifdef CPPHTTPLIB_SSL_ENABLED
  6791. std::string s = std::string("https://") + HOST + ":" + std::to_string(PORT);
  6792. Client cli(s.c_str());
  6793. cli.enable_server_certificate_verification(false);
  6794. #else
  6795. std::string s = std::string("http://") + HOST + ":" + std::to_string(PORT);
  6796. Client cli(s.c_str());
  6797. #endif
  6798. cli.set_compress(true);
  6799. auto res = cli.Put("/put-large", LARGE_DATA, "text/plain");
  6800. ASSERT_TRUE(res) << "Error: " << to_string(res.error());
  6801. EXPECT_EQ(StatusCode::OK_200, res->status);
  6802. EXPECT_EQ(LARGE_DATA, res->body);
  6803. // The compressed size should be less than a 10th of the original. May vary
  6804. // depending on the zlib library.
  6805. EXPECT_LT(res.get_request_header_value_u64("Content-Length"),
  6806. static_cast<uint64_t>(10 * 1024 * 1024));
  6807. #ifdef CPPHTTPLIB_BROTLI_SUPPORT
  6808. EXPECT_EQ("br", res.get_request_header_value("Content-Encoding"));
  6809. #elif defined(CPPHTTPLIB_ZLIB_SUPPORT)
  6810. EXPECT_EQ("gzip", res.get_request_header_value("Content-Encoding"));
  6811. #elif defined(CPPHTTPLIB_ZSTD_SUPPORT)
  6812. EXPECT_EQ("zstd", res.get_request_header_value("Content-Encoding"));
  6813. #endif
  6814. }
  6815. TEST_F(ServerTest, PutContentWithDeflate) {
  6816. cli_.set_compress(false);
  6817. Headers headers;
  6818. headers.emplace("Content-Encoding", "deflate");
  6819. // PUT in deflate format:
  6820. auto res = cli_.Put("/put", headers,
  6821. "\170\234\013\010\015\001\0\001\361\0\372", "text/plain");
  6822. ASSERT_TRUE(res) << "Error: " << to_string(res.error());
  6823. EXPECT_EQ(StatusCode::OK_200, res->status);
  6824. EXPECT_EQ("PUT", res->body);
  6825. }
  6826. TEST_F(ServerTest, GetStreamedChunkedWithGzip) {
  6827. Headers headers;
  6828. headers.emplace("Accept-Encoding", "gzip, deflate");
  6829. auto res = cli_.Get("/streamed-chunked", headers);
  6830. ASSERT_TRUE(res) << "Error: " << to_string(res.error());
  6831. EXPECT_EQ(StatusCode::OK_200, res->status);
  6832. EXPECT_EQ(std::string("123456789"), res->body);
  6833. }
  6834. TEST_F(ServerTest, GetStreamedChunkedWithGzip2) {
  6835. Headers headers;
  6836. headers.emplace("Accept-Encoding", "gzip, deflate");
  6837. auto res = cli_.Get("/streamed-chunked2", headers);
  6838. ASSERT_TRUE(res) << "Error: " << to_string(res.error());
  6839. EXPECT_EQ(StatusCode::OK_200, res->status);
  6840. EXPECT_EQ(std::string("123456789"), res->body);
  6841. }
  6842. TEST_F(ServerTest, SplitDelimiterInPathRegex) {
  6843. auto res = cli_.Get("/regex-with-delimiter?key=^(?.*(value))");
  6844. ASSERT_TRUE(res) << "Error: " << to_string(res.error());
  6845. EXPECT_EQ(StatusCode::OK_200, res->status);
  6846. }
  6847. TEST(GzipDecompressor, ChunkedDecompression) {
  6848. std::string data;
  6849. for (size_t i = 0; i < 32 * 1024; ++i) {
  6850. data.push_back(static_cast<char>('a' + i % 26));
  6851. }
  6852. std::string compressed_data;
  6853. {
  6854. httplib::detail::gzip_compressor compressor;
  6855. bool result = compressor.compress(
  6856. data.data(), data.size(),
  6857. /*last=*/true,
  6858. [&](const char *compressed_data_chunk, size_t compressed_data_size) {
  6859. compressed_data.insert(compressed_data.size(), compressed_data_chunk,
  6860. compressed_data_size);
  6861. return true;
  6862. });
  6863. ASSERT_TRUE(result);
  6864. }
  6865. std::string decompressed_data;
  6866. {
  6867. httplib::detail::gzip_decompressor decompressor;
  6868. // Chunk size is chosen specifically to have a decompressed chunk size equal
  6869. // to 16384 bytes 16384 bytes is the size of decompressor output buffer
  6870. size_t chunk_size = 130;
  6871. for (size_t chunk_begin = 0; chunk_begin < compressed_data.size();
  6872. chunk_begin += chunk_size) {
  6873. size_t current_chunk_size =
  6874. std::min(compressed_data.size() - chunk_begin, chunk_size);
  6875. bool result = decompressor.decompress(
  6876. compressed_data.data() + chunk_begin, current_chunk_size,
  6877. [&](const char *decompressed_data_chunk,
  6878. size_t decompressed_data_chunk_size) {
  6879. decompressed_data.insert(decompressed_data.size(),
  6880. decompressed_data_chunk,
  6881. decompressed_data_chunk_size);
  6882. return true;
  6883. });
  6884. ASSERT_TRUE(result);
  6885. }
  6886. }
  6887. ASSERT_EQ(data, decompressed_data);
  6888. }
  6889. TEST(GzipDecompressor, DeflateDecompression) {
  6890. std::string original_text = "Raw deflate without gzip";
  6891. unsigned char data[32] = {0x78, 0x9C, 0x0B, 0x4A, 0x2C, 0x57, 0x48, 0x49,
  6892. 0x4D, 0xCB, 0x49, 0x2C, 0x49, 0x55, 0x28, 0xCF,
  6893. 0x2C, 0xC9, 0xC8, 0x2F, 0x2D, 0x51, 0x48, 0xAF,
  6894. 0xCA, 0x2C, 0x00, 0x00, 0x6F, 0x98, 0x09, 0x2E};
  6895. std::string compressed_data(data, data + sizeof(data) / sizeof(data[0]));
  6896. std::string decompressed_data;
  6897. {
  6898. httplib::detail::gzip_decompressor decompressor;
  6899. bool result = decompressor.decompress(
  6900. compressed_data.data(), compressed_data.size(),
  6901. [&](const char *decompressed_data_chunk,
  6902. size_t decompressed_data_chunk_size) {
  6903. decompressed_data.insert(decompressed_data.size(),
  6904. decompressed_data_chunk,
  6905. decompressed_data_chunk_size);
  6906. return true;
  6907. });
  6908. ASSERT_TRUE(result);
  6909. }
  6910. ASSERT_EQ(original_text, decompressed_data);
  6911. }
  6912. TEST(GzipDecompressor, DeflateDecompressionTrailingBytes) {
  6913. std::string original_text = "Raw deflate without gzip";
  6914. unsigned char data[40] = {0x78, 0x9C, 0x0B, 0x4A, 0x2C, 0x57, 0x48, 0x49,
  6915. 0x4D, 0xCB, 0x49, 0x2C, 0x49, 0x55, 0x28, 0xCF,
  6916. 0x2C, 0xC9, 0xC8, 0x2F, 0x2D, 0x51, 0x48, 0xAF,
  6917. 0xCA, 0x2C, 0x00, 0x00, 0x6F, 0x98, 0x09, 0x2E,
  6918. 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00};
  6919. std::string compressed_data(data, data + sizeof(data) / sizeof(data[0]));
  6920. std::string decompressed_data;
  6921. {
  6922. httplib::detail::gzip_decompressor decompressor;
  6923. bool result = decompressor.decompress(
  6924. compressed_data.data(), compressed_data.size(),
  6925. [&](const char *decompressed_data_chunk,
  6926. size_t decompressed_data_chunk_size) {
  6927. decompressed_data.insert(decompressed_data.size(),
  6928. decompressed_data_chunk,
  6929. decompressed_data_chunk_size);
  6930. return true;
  6931. });
  6932. ASSERT_TRUE(result);
  6933. }
  6934. ASSERT_EQ(original_text, decompressed_data);
  6935. }
  6936. #endif
  6937. #ifdef CPPHTTPLIB_BROTLI_SUPPORT
  6938. TEST_F(ServerTest, GetStreamedChunkedWithBrotli) {
  6939. Headers headers;
  6940. headers.emplace("Accept-Encoding", "br");
  6941. auto res = cli_.Get("/streamed-chunked", headers);
  6942. ASSERT_TRUE(res) << "Error: " << to_string(res.error());
  6943. EXPECT_EQ(StatusCode::OK_200, res->status);
  6944. EXPECT_EQ(std::string("123456789"), res->body);
  6945. }
  6946. TEST_F(ServerTest, GetStreamedChunkedWithBrotli2) {
  6947. Headers headers;
  6948. headers.emplace("Accept-Encoding", "br");
  6949. auto res = cli_.Get("/streamed-chunked2", headers);
  6950. ASSERT_TRUE(res) << "Error: " << to_string(res.error());
  6951. EXPECT_EQ(StatusCode::OK_200, res->status);
  6952. EXPECT_EQ(std::string("123456789"), res->body);
  6953. }
  6954. TEST_F(ServerTest, PutWithContentProviderWithBrotli) {
  6955. cli_.set_compress(true);
  6956. auto res = cli_.Put(
  6957. "/put", 3,
  6958. [](size_t /*offset*/, size_t /*length*/, DataSink &sink) {
  6959. sink.os << "PUT";
  6960. return true;
  6961. },
  6962. "text/plain");
  6963. ASSERT_TRUE(res) << "Error: " << to_string(res.error());
  6964. EXPECT_EQ(StatusCode::OK_200, res->status);
  6965. EXPECT_EQ("PUT", res->body);
  6966. }
  6967. TEST_F(ServerTest, PutWithContentProviderWithoutLengthWithBrotli) {
  6968. cli_.set_compress(true);
  6969. auto res = cli_.Put(
  6970. "/put",
  6971. [](size_t /*offset*/, DataSink &sink) {
  6972. sink.os << "PUT";
  6973. sink.done();
  6974. return true;
  6975. },
  6976. "text/plain");
  6977. ASSERT_TRUE(res) << "Error: " << to_string(res.error());
  6978. EXPECT_EQ(StatusCode::OK_200, res->status);
  6979. EXPECT_EQ("PUT", res->body);
  6980. }
  6981. TEST_F(ServerTest, PutLargeFileWithBrotli) {
  6982. cli_.set_compress(true);
  6983. auto res = cli_.Put("/put-large", LARGE_DATA, "text/plain");
  6984. ASSERT_TRUE(res) << "Error: " << to_string(res.error());
  6985. EXPECT_EQ(StatusCode::OK_200, res->status);
  6986. EXPECT_EQ(LARGE_DATA, res->body);
  6987. EXPECT_EQ("br", res.get_request_header_value("Content-Encoding"));
  6988. }
  6989. #endif
  6990. TEST_F(ServerTest, Patch) {
  6991. auto res = cli_.Patch("/patch", "PATCH", "text/plain");
  6992. ASSERT_TRUE(res) << "Error: " << to_string(res.error());
  6993. EXPECT_EQ(StatusCode::OK_200, res->status);
  6994. EXPECT_EQ("PATCH", res->body);
  6995. }
  6996. TEST_F(ServerTest, Delete) {
  6997. auto res = cli_.Delete("/delete");
  6998. ASSERT_TRUE(res) << "Error: " << to_string(res.error());
  6999. EXPECT_EQ(StatusCode::OK_200, res->status);
  7000. EXPECT_EQ("DELETE", res->body);
  7001. }
  7002. TEST_F(ServerTest, DeleteContentReceiver) {
  7003. auto res = cli_.Delete("/delete-body", "content", "text/plain");
  7004. ASSERT_TRUE(res) << "Error: " << to_string(res.error());
  7005. EXPECT_EQ(StatusCode::OK_200, res->status);
  7006. EXPECT_EQ("content", res->body);
  7007. }
  7008. TEST_F(ServerTest, Options) {
  7009. auto res = cli_.Options("*");
  7010. ASSERT_TRUE(res) << "Error: " << to_string(res.error());
  7011. EXPECT_EQ(StatusCode::OK_200, res->status);
  7012. EXPECT_EQ("GET, POST, HEAD, OPTIONS", res->get_header_value("Allow"));
  7013. EXPECT_TRUE(res->body.empty());
  7014. }
  7015. TEST_F(ServerTest, URL) {
  7016. auto res = cli_.Get("/request-target?aaa=bbb&ccc=ddd");
  7017. ASSERT_TRUE(res) << "Error: " << to_string(res.error());
  7018. EXPECT_EQ(StatusCode::OK_200, res->status);
  7019. }
  7020. TEST_F(ServerTest, ArrayParam) {
  7021. auto res = cli_.Get("/array-param?array=value1&array=value2&array=value3");
  7022. ASSERT_TRUE(res) << "Error: " << to_string(res.error());
  7023. EXPECT_EQ(StatusCode::OK_200, res->status);
  7024. }
  7025. TEST_F(ServerTest, ArrayParamValues) {
  7026. auto res =
  7027. cli_.Get("/array-param-values?array=value1&array=value2&array=value3");
  7028. ASSERT_TRUE(res) << "Error: " << to_string(res.error());
  7029. EXPECT_EQ(StatusCode::OK_200, res->status);
  7030. }
  7031. TEST_F(ServerTest, NoMultipleHeaders) {
  7032. Headers headers = {{"Content-Length", "5"}};
  7033. auto res = cli_.Post("/validate-no-multiple-headers", headers, "hello",
  7034. "text/plain");
  7035. ASSERT_TRUE(res) << "Error: " << to_string(res.error());
  7036. EXPECT_EQ(StatusCode::OK_200, res->status);
  7037. }
  7038. TEST_F(ServerTest, PostContentReceiver) {
  7039. auto res = cli_.Post("/content_receiver", "content", "text/plain");
  7040. ASSERT_TRUE(res) << "Error: " << to_string(res.error());
  7041. ASSERT_EQ(StatusCode::OK_200, res->status);
  7042. ASSERT_EQ("content", res->body);
  7043. }
  7044. TEST_F(ServerTest, PostMultipartFileContentReceiver) {
  7045. UploadFormDataItems items = {
  7046. {"text1", "text default", "", ""},
  7047. {"text2", "aωb", "", ""},
  7048. {"file1", "h\ne\n\nl\nl\no\n", "hello.txt", "text/plain"},
  7049. {"file2", R"({\n "world": true\n}\n)", "world.json", "application/json"},
  7050. {"file3", "", "", "application/octet-stream"},
  7051. };
  7052. auto res = cli_.Post("/content_receiver", items);
  7053. ASSERT_TRUE(res) << "Error: " << to_string(res.error());
  7054. EXPECT_EQ(StatusCode::OK_200, res->status);
  7055. }
  7056. TEST_F(ServerTest, PostMultipartPlusBoundary) {
  7057. UploadFormDataItems items = {
  7058. {"text1", "text default", "", ""},
  7059. {"text2", "aωb", "", ""},
  7060. {"file1", "h\ne\n\nl\nl\no\n", "hello.txt", "text/plain"},
  7061. {"file2", R"({\n "world": true\n}\n)", "world.json", "application/json"},
  7062. {"file3", "", "", "application/octet-stream"},
  7063. };
  7064. auto boundary = std::string("+++++");
  7065. std::string body;
  7066. for (const auto &item : items) {
  7067. body += "--" + boundary + "\r\n";
  7068. body += "Content-Disposition: form-data; name=\"" + item.name + "\"";
  7069. if (!item.filename.empty()) {
  7070. body += "; filename=\"" + item.filename + "\"";
  7071. }
  7072. body += "\r\n";
  7073. if (!item.content_type.empty()) {
  7074. body += "Content-Type: " + item.content_type + "\r\n";
  7075. }
  7076. body += "\r\n";
  7077. body += item.content + "\r\n";
  7078. }
  7079. body += "--" + boundary + "--\r\n";
  7080. std::string content_type = "multipart/form-data; boundary=" + boundary;
  7081. auto res = cli_.Post("/content_receiver", body, content_type.c_str());
  7082. ASSERT_TRUE(res) << "Error: " << to_string(res.error());
  7083. EXPECT_EQ(StatusCode::OK_200, res->status);
  7084. }
  7085. TEST(MultipartFormDataTest, FieldEscaping) {
  7086. Server svr;
  7087. svr.Post("/post", [&](const Request &req, Response & /*res*/,
  7088. const ContentReader &content_reader) {
  7089. ASSERT_TRUE(req.is_multipart_form_data());
  7090. std::vector<FormData> received;
  7091. content_reader(
  7092. [&](const FormData &file) {
  7093. received.push_back(file);
  7094. return true;
  7095. },
  7096. [&](const char *data, size_t data_length) {
  7097. received.back().content.append(data, data_length);
  7098. return true;
  7099. });
  7100. // '"', CR and LF in names and filenames are escaped following the
  7101. // WHATWG HTML standard, so each part still parses as a single part
  7102. // with no injected headers. Content types get CR/LF escaped too,
  7103. // while '"' (legal there, e.g. quoted charset) is preserved.
  7104. ASSERT_EQ(4U, received.size());
  7105. EXPECT_EQ("na%22me", received[0].name);
  7106. EXPECT_EQ("quoted name", received[0].content);
  7107. EXPECT_EQ("file", received[1].name);
  7108. EXPECT_EQ("evil%0D%0AContent-Type: text/evil%0D%0A%0D%0A.pdf",
  7109. received[1].filename);
  7110. EXPECT_EQ("application/octet-stream", received[1].content_type);
  7111. EXPECT_EQ("injected", received[1].content);
  7112. EXPECT_EQ("my%0Dna%0Ame", received[2].name);
  7113. EXPECT_EQ("my%22file.txt", received[2].filename);
  7114. EXPECT_EQ("cr lf name", received[2].content);
  7115. EXPECT_EQ("typed", received[3].name);
  7116. EXPECT_EQ("text/plain; charset=\"utf-8\"%0D%0AX-Evil: 1",
  7117. received[3].content_type);
  7118. EXPECT_EQ("typed content", received[3].content);
  7119. });
  7120. auto port = svr.bind_to_any_port("localhost");
  7121. auto t = std::thread([&]() { svr.listen_after_bind(); });
  7122. auto se = detail::scope_exit([&] {
  7123. svr.stop();
  7124. t.join();
  7125. ASSERT_FALSE(svr.is_running());
  7126. });
  7127. svr.wait_until_ready();
  7128. Client cli("localhost", port);
  7129. UploadFormDataItems items = {
  7130. {"na\"me", "quoted name", "", ""},
  7131. {"file", "injected", "evil\r\nContent-Type: text/evil\r\n\r\n.pdf",
  7132. "application/octet-stream"},
  7133. {"my\rna\nme", "cr lf name", "my\"file.txt", "text/plain"},
  7134. {"typed", "typed content", "",
  7135. "text/plain; charset=\"utf-8\"\r\nX-Evil: 1"},
  7136. };
  7137. auto res = cli.Post("/post", items);
  7138. ASSERT_TRUE(res) << "Error: " << to_string(res.error());
  7139. EXPECT_EQ(StatusCode::OK_200, res->status);
  7140. }
  7141. TEST(MultipartFormDataTest, PublicWriterAPI) {
  7142. const UploadFormDataItems items = {
  7143. {"name1", "Content 1", "", ""},
  7144. {"name2", "Content 2", "file2.txt", "text/plain"},
  7145. };
  7146. Server svr;
  7147. svr.Post("/post", [&](const Request &req, Response & /*res*/,
  7148. const ContentReader &content_reader) {
  7149. ASSERT_TRUE(req.is_multipart_form_data());
  7150. std::vector<FormData> received;
  7151. content_reader(
  7152. [&](const FormData &file) {
  7153. received.push_back(file);
  7154. return true;
  7155. },
  7156. [&](const char *data, size_t data_length) {
  7157. received.back().content.append(data, data_length);
  7158. return true;
  7159. });
  7160. ASSERT_EQ(2U, received.size());
  7161. EXPECT_EQ("name1", received[0].name);
  7162. EXPECT_EQ("Content 1", received[0].content);
  7163. EXPECT_EQ("name2", received[1].name);
  7164. EXPECT_EQ("Content 2", received[1].content);
  7165. EXPECT_EQ("file2.txt", received[1].filename);
  7166. EXPECT_EQ("text/plain", received[1].content_type);
  7167. });
  7168. auto port = svr.bind_to_any_port("localhost");
  7169. auto t = std::thread([&]() { svr.listen_after_bind(); });
  7170. auto se = detail::scope_exit([&] {
  7171. svr.stop();
  7172. t.join();
  7173. ASSERT_FALSE(svr.is_running());
  7174. });
  7175. svr.wait_until_ready();
  7176. Client cli("localhost", port);
  7177. // Whole-body serialization with a generated boundary
  7178. {
  7179. MultipartFormDataWriter writer;
  7180. EXPECT_TRUE(is_valid_multipart_boundary(writer.boundary()));
  7181. EXPECT_EQ("multipart/form-data; boundary=" + writer.boundary(),
  7182. writer.content_type());
  7183. auto body = writer.serialize(items);
  7184. EXPECT_EQ(body.size(), writer.content_length(items));
  7185. auto res = cli.Post("/post", body, writer.content_type());
  7186. ASSERT_TRUE(res) << "Error: " << to_string(res.error());
  7187. EXPECT_EQ(StatusCode::OK_200, res->status);
  7188. }
  7189. // Per-part framing with a custom boundary via a content provider
  7190. {
  7191. EXPECT_FALSE(is_valid_multipart_boundary("bad boundary"));
  7192. ASSERT_TRUE(is_valid_multipart_boundary("custom-boundary_123"));
  7193. MultipartFormDataWriter writer("custom-boundary_123");
  7194. EXPECT_EQ("custom-boundary_123", writer.boundary());
  7195. std::string body;
  7196. for (const auto &item : items) {
  7197. body += writer.item_begin(item);
  7198. body += item.content;
  7199. body += MultipartFormDataWriter::item_end();
  7200. }
  7201. body += writer.finish();
  7202. EXPECT_EQ(body.size(), writer.content_length(items));
  7203. auto res = cli.Post(
  7204. "/post", body.size(),
  7205. [&](size_t offset, size_t length, DataSink &sink) {
  7206. sink.write(body.data() + offset, length);
  7207. return true;
  7208. },
  7209. writer.content_type());
  7210. ASSERT_TRUE(res) << "Error: " << to_string(res.error());
  7211. EXPECT_EQ(StatusCode::OK_200, res->status);
  7212. }
  7213. }
  7214. TEST_F(ServerTest, PostContentReceiverGzip) {
  7215. cli_.set_compress(true);
  7216. auto res = cli_.Post("/content_receiver", "content", "text/plain");
  7217. ASSERT_TRUE(res) << "Error: " << to_string(res.error());
  7218. ASSERT_EQ(StatusCode::OK_200, res->status);
  7219. ASSERT_EQ("content", res->body);
  7220. }
  7221. TEST_F(ServerTest, PutContentReceiver) {
  7222. auto res = cli_.Put("/content_receiver", "content", "text/plain");
  7223. ASSERT_TRUE(res) << "Error: " << to_string(res.error());
  7224. ASSERT_EQ(StatusCode::OK_200, res->status);
  7225. ASSERT_EQ("content", res->body);
  7226. }
  7227. TEST_F(ServerTest, PatchContentReceiver) {
  7228. auto res = cli_.Patch("/content_receiver", "content", "text/plain");
  7229. ASSERT_TRUE(res) << "Error: " << to_string(res.error());
  7230. ASSERT_EQ(StatusCode::OK_200, res->status);
  7231. ASSERT_EQ("content", res->body);
  7232. }
  7233. template <typename ClientType>
  7234. void TestWithHeadersAndContentReceiver(
  7235. ClientType &cli,
  7236. std::function<Result(ClientType &, const std::string &, const Headers &,
  7237. const std::string &, const std::string &,
  7238. ContentReceiver, DownloadProgress)>
  7239. request_func) {
  7240. Headers headers;
  7241. headers.emplace("X-Custom-Header", "test-value");
  7242. std::string received_body;
  7243. auto res = request_func(
  7244. cli, "/content_receiver", headers, "content", "application/json",
  7245. [&](const char *data, size_t data_length) {
  7246. received_body.append(data, data_length);
  7247. return true;
  7248. },
  7249. nullptr);
  7250. ASSERT_TRUE(res) << "Error: " << to_string(res.error());
  7251. EXPECT_EQ(StatusCode::OK_200, res->status);
  7252. EXPECT_EQ("content", received_body);
  7253. }
  7254. TEST_F(ServerTest, PostWithHeadersAndContentReceiver) {
  7255. #ifdef CPPHTTPLIB_SSL_ENABLED
  7256. using ClientT = SSLClient;
  7257. #else
  7258. using ClientT = Client;
  7259. #endif
  7260. TestWithHeadersAndContentReceiver<ClientT>(
  7261. cli_, [](ClientT &cli, const std::string &path, const Headers &headers,
  7262. const std::string &body, const std::string &content_type,
  7263. ContentReceiver receiver, DownloadProgress progress) {
  7264. return cli.Post(path, headers, body, content_type, receiver, progress);
  7265. });
  7266. }
  7267. TEST_F(ServerTest, PutWithHeadersAndContentReceiver) {
  7268. #ifdef CPPHTTPLIB_SSL_ENABLED
  7269. using ClientT = SSLClient;
  7270. #else
  7271. using ClientT = Client;
  7272. #endif
  7273. TestWithHeadersAndContentReceiver<ClientT>(
  7274. cli_, [](ClientT &cli, const std::string &path, const Headers &headers,
  7275. const std::string &body, const std::string &content_type,
  7276. ContentReceiver receiver, DownloadProgress progress) {
  7277. return cli.Put(path, headers, body, content_type, receiver, progress);
  7278. });
  7279. }
  7280. TEST_F(ServerTest, PatchWithHeadersAndContentReceiver) {
  7281. #ifdef CPPHTTPLIB_SSL_ENABLED
  7282. using ClientT = SSLClient;
  7283. #else
  7284. using ClientT = Client;
  7285. #endif
  7286. TestWithHeadersAndContentReceiver<ClientT>(
  7287. cli_, [](ClientT &cli, const std::string &path, const Headers &headers,
  7288. const std::string &body, const std::string &content_type,
  7289. ContentReceiver receiver, DownloadProgress progress) {
  7290. return cli.Patch(path, headers, body, content_type, receiver, progress);
  7291. });
  7292. }
  7293. template <typename ClientType>
  7294. void TestWithHeadersAndContentReceiverWithProgress(
  7295. ClientType &cli,
  7296. std::function<Result(ClientType &, const std::string &, const Headers &,
  7297. const std::string &, const std::string &,
  7298. ContentReceiver, DownloadProgress)>
  7299. request_func) {
  7300. Headers headers;
  7301. headers.emplace("X-Test-Header", "progress-test");
  7302. std::string received_body;
  7303. auto progress_called = false;
  7304. auto res = request_func(
  7305. cli, "/content_receiver", headers, "content", "text/plain",
  7306. [&](const char *data, size_t data_length) {
  7307. received_body.append(data, data_length);
  7308. return true;
  7309. },
  7310. [&](uint64_t /*current*/, uint64_t /*total*/) {
  7311. progress_called = true;
  7312. return true;
  7313. });
  7314. ASSERT_TRUE(res) << "Error: " << to_string(res.error());
  7315. EXPECT_EQ(StatusCode::OK_200, res->status);
  7316. EXPECT_EQ("content", received_body);
  7317. EXPECT_TRUE(progress_called);
  7318. }
  7319. TEST_F(ServerTest, PostWithHeadersAndContentReceiverWithProgress) {
  7320. #ifdef CPPHTTPLIB_SSL_ENABLED
  7321. using ClientT = SSLClient;
  7322. #else
  7323. using ClientT = Client;
  7324. #endif
  7325. TestWithHeadersAndContentReceiverWithProgress<ClientT>(
  7326. cli_, [](ClientT &cli, const std::string &path, const Headers &headers,
  7327. const std::string &body, const std::string &content_type,
  7328. ContentReceiver receiver, DownloadProgress progress) {
  7329. return cli.Post(path, headers, body, content_type, receiver, progress);
  7330. });
  7331. }
  7332. TEST_F(ServerTest, PutWithHeadersAndContentReceiverWithProgress) {
  7333. #ifdef CPPHTTPLIB_SSL_ENABLED
  7334. using ClientT = SSLClient;
  7335. #else
  7336. using ClientT = Client;
  7337. #endif
  7338. TestWithHeadersAndContentReceiverWithProgress<ClientT>(
  7339. cli_, [](ClientT &cli, const std::string &path, const Headers &headers,
  7340. const std::string &body, const std::string &content_type,
  7341. ContentReceiver receiver, DownloadProgress progress) {
  7342. return cli.Put(path, headers, body, content_type, receiver, progress);
  7343. });
  7344. }
  7345. TEST_F(ServerTest, PatchWithHeadersAndContentReceiverWithProgress) {
  7346. #ifdef CPPHTTPLIB_SSL_ENABLED
  7347. using ClientT = SSLClient;
  7348. #else
  7349. using ClientT = Client;
  7350. #endif
  7351. TestWithHeadersAndContentReceiverWithProgress<ClientT>(
  7352. cli_, [](ClientT &cli, const std::string &path, const Headers &headers,
  7353. const std::string &body, const std::string &content_type,
  7354. ContentReceiver receiver, DownloadProgress progress) {
  7355. return cli.Patch(path, headers, body, content_type, receiver, progress);
  7356. });
  7357. }
  7358. template <typename ClientType>
  7359. void TestWithHeadersAndContentReceiverError(
  7360. ClientType &cli, std::function<Result(ClientType &, const std::string &,
  7361. const Headers &, const std::string &,
  7362. const std::string &, ContentReceiver)>
  7363. request_func) {
  7364. Headers headers;
  7365. headers.emplace("X-Error-Test", "true");
  7366. std::string received_body;
  7367. auto receiver_failed = false;
  7368. auto res =
  7369. request_func(cli, "/content_receiver", headers, "content", "text/plain",
  7370. [&](const char *data, size_t data_length) {
  7371. received_body.append(data, data_length);
  7372. receiver_failed = true;
  7373. return false;
  7374. });
  7375. ASSERT_FALSE(res);
  7376. EXPECT_TRUE(receiver_failed);
  7377. }
  7378. TEST_F(ServerTest, PostWithHeadersAndContentReceiverError) {
  7379. #ifdef CPPHTTPLIB_SSL_ENABLED
  7380. using ClientT = SSLClient;
  7381. #else
  7382. using ClientT = Client;
  7383. #endif
  7384. TestWithHeadersAndContentReceiverError<ClientT>(
  7385. cli_, [](ClientT &cli, const std::string &path, const Headers &headers,
  7386. const std::string &body, const std::string &content_type,
  7387. ContentReceiver receiver) {
  7388. return cli.Post(path, headers, body, content_type, receiver);
  7389. });
  7390. }
  7391. TEST_F(ServerTest, PuttWithHeadersAndContentReceiverError) {
  7392. #ifdef CPPHTTPLIB_SSL_ENABLED
  7393. using ClientT = SSLClient;
  7394. #else
  7395. using ClientT = Client;
  7396. #endif
  7397. TestWithHeadersAndContentReceiverError<ClientT>(
  7398. cli_, [](ClientT &cli, const std::string &path, const Headers &headers,
  7399. const std::string &body, const std::string &content_type,
  7400. ContentReceiver receiver) {
  7401. return cli.Put(path, headers, body, content_type, receiver);
  7402. });
  7403. }
  7404. TEST_F(ServerTest, PatchWithHeadersAndContentReceiverError) {
  7405. #ifdef CPPHTTPLIB_SSL_ENABLED
  7406. using ClientT = SSLClient;
  7407. #else
  7408. using ClientT = Client;
  7409. #endif
  7410. TestWithHeadersAndContentReceiverError<ClientT>(
  7411. cli_, [](ClientT &cli, const std::string &path, const Headers &headers,
  7412. const std::string &body, const std::string &content_type,
  7413. ContentReceiver receiver) {
  7414. return cli.Patch(path, headers, body, content_type, receiver);
  7415. });
  7416. }
  7417. TEST_F(ServerTest, PostQueryStringAndBody) {
  7418. auto res =
  7419. cli_.Post("/query-string-and-body?key=value", "content", "text/plain");
  7420. ASSERT_TRUE(res) << "Error: " << to_string(res.error());
  7421. ASSERT_EQ(StatusCode::OK_200, res->status);
  7422. }
  7423. TEST_F(ServerTest, HTTP2Magic) {
  7424. Request req;
  7425. req.method = "PRI";
  7426. req.path = "*";
  7427. req.body = "SM";
  7428. auto res = std::make_shared<Response>();
  7429. auto error = Error::Success;
  7430. auto ret = cli_.send(req, *res, error);
  7431. ASSERT_TRUE(ret);
  7432. EXPECT_EQ(StatusCode::BadRequest_400, res->status);
  7433. }
  7434. TEST_F(ServerTest, KeepAlive) {
  7435. auto res = cli_.Get("/hi");
  7436. ASSERT_TRUE(res) << "Error: " << to_string(res.error());
  7437. EXPECT_EQ(StatusCode::OK_200, res->status);
  7438. EXPECT_EQ("text/plain", res->get_header_value("Content-Type"));
  7439. EXPECT_EQ("Hello World!", res->body);
  7440. res = cli_.Get("/hi");
  7441. ASSERT_TRUE(res) << "Error: " << to_string(res.error());
  7442. EXPECT_EQ(StatusCode::OK_200, res->status);
  7443. EXPECT_EQ("text/plain", res->get_header_value("Content-Type"));
  7444. EXPECT_EQ("Hello World!", res->body);
  7445. res = cli_.Get("/hi");
  7446. ASSERT_TRUE(res) << "Error: " << to_string(res.error());
  7447. EXPECT_EQ(StatusCode::OK_200, res->status);
  7448. EXPECT_EQ("text/plain", res->get_header_value("Content-Type"));
  7449. EXPECT_EQ("Hello World!", res->body);
  7450. res = cli_.Get("/not-exist");
  7451. ASSERT_TRUE(res) << "Error: " << to_string(res.error());
  7452. EXPECT_EQ(StatusCode::NotFound_404, res->status);
  7453. res = cli_.Post("/empty", "", "text/plain");
  7454. ASSERT_TRUE(res) << "Error: " << to_string(res.error());
  7455. EXPECT_EQ(StatusCode::OK_200, res->status);
  7456. EXPECT_EQ("text/plain", res->get_header_value("Content-Type"));
  7457. EXPECT_EQ("empty", res->body);
  7458. EXPECT_EQ("close", res->get_header_value("Connection"));
  7459. res = cli_.Post(
  7460. "/empty", 0, [&](size_t, size_t, DataSink &) { return true; },
  7461. "text/plain");
  7462. ASSERT_TRUE(res) << "Error: " << to_string(res.error());
  7463. EXPECT_EQ(StatusCode::OK_200, res->status);
  7464. EXPECT_EQ("text/plain", res->get_header_value("Content-Type"));
  7465. EXPECT_EQ("empty", res->body);
  7466. cli_.set_keep_alive(false);
  7467. res = cli_.Get("/last-request");
  7468. ASSERT_TRUE(res) << "Error: " << to_string(res.error());
  7469. EXPECT_EQ(StatusCode::OK_200, res->status);
  7470. EXPECT_EQ("close", res->get_header_value("Connection"));
  7471. }
  7472. TEST_F(ServerTest, TooManyRedirect) {
  7473. cli_.set_follow_location(true);
  7474. auto res = cli_.Get("/redirect/0");
  7475. ASSERT_TRUE(!res);
  7476. EXPECT_EQ(Error::ExceedRedirectCount, res.error());
  7477. }
  7478. TEST_F(ServerTest, BadRequestLineCancelsKeepAlive) {
  7479. Request req;
  7480. req.method = "FOOBAR";
  7481. req.path = "/hi";
  7482. cli_.set_keep_alive(true);
  7483. auto res = cli_.send(req);
  7484. ASSERT_TRUE(res) << "Error: " << to_string(res.error());
  7485. EXPECT_EQ(StatusCode::BadRequest_400, res->status);
  7486. EXPECT_EQ("close", res->get_header_value("Connection"));
  7487. EXPECT_FALSE(cli_.is_socket_open());
  7488. }
  7489. TEST_F(ServerTest, CustomRouteReadsBody) {
  7490. const std::string xml =
  7491. R"(<?xml version="1.0"?><propfind><allprop/></propfind>)";
  7492. Request req;
  7493. req.method = "PROPFIND";
  7494. req.path = "/dav/dir";
  7495. req.set_header("Depth", "1");
  7496. req.body = xml;
  7497. auto res = cli_.send(req);
  7498. ASSERT_TRUE(res) << "Error: " << to_string(res.error());
  7499. EXPECT_EQ(StatusCode::MultiStatus_207, res->status);
  7500. EXPECT_EQ(xml, res->body);
  7501. EXPECT_EQ(std::to_string(xml.size()), res->get_header_value("x-body-size"));
  7502. EXPECT_EQ("application/xml", res->get_header_value("Content-Type"));
  7503. }
  7504. TEST_F(ServerTest, CustomRouteMatchedRouteAndPathParams) {
  7505. Request req;
  7506. req.method = "PROPFIND";
  7507. req.path = "/dav/42";
  7508. auto res = cli_.send(req);
  7509. ASSERT_TRUE(res) << "Error: " << to_string(res.error());
  7510. EXPECT_EQ(StatusCode::MultiStatus_207, res->status);
  7511. EXPECT_EQ("/dav/:id", res->get_header_value("x-matched-route"));
  7512. EXPECT_EQ("42", res->get_header_value("x-dav-id"));
  7513. }
  7514. TEST_F(ServerTest, CustomRouteRegexPattern) {
  7515. Request req;
  7516. req.method = "PROPFIND";
  7517. req.path = "/dav-re/123";
  7518. auto res = cli_.send(req);
  7519. ASSERT_TRUE(res) << "Error: " << to_string(res.error());
  7520. EXPECT_EQ(StatusCode::MultiStatus_207, res->status);
  7521. EXPECT_EQ("123", res->get_header_value("x-dav-match"));
  7522. }
  7523. TEST_F(ServerTest, CustomRouteWithoutBody) {
  7524. Request req;
  7525. req.method = "MKCOL";
  7526. req.path = "/dav-mkcol";
  7527. auto res = cli_.send(req);
  7528. ASSERT_TRUE(res) << "Error: " << to_string(res.error());
  7529. EXPECT_EQ(StatusCode::Created_201, res->status);
  7530. }
  7531. TEST_F(ServerTest, CustomRouteWithContentReader) {
  7532. const std::string xml = R"(<?xml version="1.0"?><sync-collection/>)";
  7533. Request req;
  7534. req.method = "REPORT";
  7535. req.path = "/dav-report";
  7536. req.body = xml;
  7537. auto res = cli_.send(req);
  7538. ASSERT_TRUE(res) << "Error: " << to_string(res.error());
  7539. EXPECT_EQ(StatusCode::MultiStatus_207, res->status);
  7540. EXPECT_EQ(xml, res->body);
  7541. }
  7542. // A content reader route must fire even when the request carries no body,
  7543. // the way the built-in Delete(pattern, HandlerWithContentReader) does.
  7544. // Without that, a body-less PROPFIND-style request would fall through to 404.
  7545. TEST_F(ServerTest, CustomRouteWithContentReaderWithoutBody) {
  7546. Request req;
  7547. req.method = "REPORT";
  7548. req.path = "/dav-report";
  7549. auto res = cli_.send(req);
  7550. ASSERT_TRUE(res) << "Error: " << to_string(res.error());
  7551. EXPECT_EQ(StatusCode::MultiStatus_207, res->status);
  7552. EXPECT_EQ("0", res->get_header_value("x-body-size"));
  7553. }
  7554. TEST_F(ServerTest, CustomRouteUnmatchedPathReturns404) {
  7555. Request req;
  7556. req.method = "PROPFIND";
  7557. req.path = "/not-dav";
  7558. auto res = cli_.send(req);
  7559. ASSERT_TRUE(res) << "Error: " << to_string(res.error());
  7560. EXPECT_EQ(StatusCode::NotFound_404, res->status);
  7561. }
  7562. TEST_F(ServerTest, CustomRouteUnregisteredMethodIsRejected) {
  7563. Request req;
  7564. req.method = "UNLOCK";
  7565. req.path = "/dav/dir";
  7566. cli_.set_keep_alive(true);
  7567. auto res = cli_.send(req);
  7568. ASSERT_TRUE(res) << "Error: " << to_string(res.error());
  7569. EXPECT_EQ(StatusCode::BadRequest_400, res->status);
  7570. EXPECT_EQ("close", res->get_header_value("Connection"));
  7571. EXPECT_FALSE(cli_.is_socket_open());
  7572. }
  7573. TEST_F(ServerTest, CustomRouteDoesNotServeStaticFiles) {
  7574. // The mount point serves this path, but only for GET and HEAD.
  7575. auto get_res = cli_.Get("/dir/index.html");
  7576. ASSERT_TRUE(get_res) << "Error: " << to_string(get_res.error());
  7577. ASSERT_EQ(StatusCode::OK_200, get_res->status);
  7578. Request req;
  7579. req.method = "PROPFIND";
  7580. req.path = "/dir/index.html";
  7581. auto res = cli_.send(req);
  7582. ASSERT_TRUE(res) << "Error: " << to_string(res.error());
  7583. EXPECT_EQ(StatusCode::NotFound_404, res->status);
  7584. }
  7585. TEST_F(ServerTest, CustomRouteKeepAlive) {
  7586. const std::string xml = R"(<?xml version="1.0"?><propfind/>)";
  7587. cli_.set_keep_alive(true);
  7588. for (auto i = 0; i < 2; i++) {
  7589. Request req;
  7590. req.method = "PROPFIND";
  7591. req.path = "/dav/dir";
  7592. req.body = xml;
  7593. auto res = cli_.send(req);
  7594. ASSERT_TRUE(res) << "Error: " << to_string(res.error());
  7595. EXPECT_EQ(StatusCode::MultiStatus_207, res->status);
  7596. EXPECT_EQ(xml, res->body);
  7597. EXPECT_TRUE(cli_.is_socket_open());
  7598. }
  7599. // A built-in method must still be served on the same connection.
  7600. cli_.set_keep_alive(false);
  7601. auto res = cli_.Get("/hi");
  7602. ASSERT_TRUE(res) << "Error: " << to_string(res.error());
  7603. EXPECT_EQ(StatusCode::OK_200, res->status);
  7604. EXPECT_EQ("close", res->get_header_value("Connection"));
  7605. }
  7606. TEST_F(ServerTest, CustomRouteExpect100Continue) {
  7607. const std::string xml = R"(<?xml version="1.0"?><propfind/>)";
  7608. Request req;
  7609. req.method = "PROPFIND";
  7610. req.path = "/dav/dir";
  7611. req.set_header("Expect", "100-continue");
  7612. req.body = xml;
  7613. auto res = cli_.send(req);
  7614. ASSERT_TRUE(res) << "Error: " << to_string(res.error());
  7615. EXPECT_EQ(StatusCode::MultiStatus_207, res->status);
  7616. EXPECT_EQ(xml, res->body);
  7617. }
  7618. TEST_F(ServerTest, StartTime) { auto res = cli_.Get("/test-start-time"); }
  7619. #ifdef CPPHTTPLIB_ZLIB_SUPPORT
  7620. TEST_F(ServerTest, Gzip) {
  7621. Headers headers;
  7622. headers.emplace("Accept-Encoding", "gzip, deflate");
  7623. auto res = cli_.Get("/compress", headers);
  7624. ASSERT_TRUE(res) << "Error: " << to_string(res.error());
  7625. EXPECT_EQ("gzip", res->get_header_value("Content-Encoding"));
  7626. EXPECT_EQ("text/plain", res->get_header_value("Content-Type"));
  7627. EXPECT_EQ("33", res->get_header_value("Content-Length"));
  7628. EXPECT_EQ("123456789012345678901234567890123456789012345678901234567890123456"
  7629. "7890123456789012345678901234567890",
  7630. res->body);
  7631. EXPECT_EQ(StatusCode::OK_200, res->status);
  7632. }
  7633. TEST_F(ServerTest, GzipWithContentTypeParameters) {
  7634. Headers headers;
  7635. headers.emplace("Accept-Encoding", "gzip, deflate");
  7636. auto res = cli_.Get("/compress-with-charset", headers);
  7637. ASSERT_TRUE(res) << "Error: " << to_string(res.error());
  7638. EXPECT_EQ("gzip", res->get_header_value("Content-Encoding"));
  7639. EXPECT_EQ("application/json; charset=utf-8",
  7640. res->get_header_value("Content-Type"));
  7641. EXPECT_EQ("123456789012345678901234567890123456789012345678901234567890123456"
  7642. "7890123456789012345678901234567890",
  7643. res->body);
  7644. EXPECT_EQ(StatusCode::OK_200, res->status);
  7645. }
  7646. TEST_F(ServerTest, GzipWithoutAcceptEncoding) {
  7647. Headers headers;
  7648. headers.emplace("Accept-Encoding", "");
  7649. auto res = cli_.Get("/compress", headers);
  7650. ASSERT_TRUE(res) << "Error: " << to_string(res.error());
  7651. EXPECT_TRUE(res->get_header_value("Content-Encoding").empty());
  7652. EXPECT_EQ("text/plain", res->get_header_value("Content-Type"));
  7653. EXPECT_EQ("100", res->get_header_value("Content-Length"));
  7654. EXPECT_EQ("123456789012345678901234567890123456789012345678901234567890123456"
  7655. "7890123456789012345678901234567890",
  7656. res->body);
  7657. EXPECT_EQ(StatusCode::OK_200, res->status);
  7658. }
  7659. TEST_F(ServerTest, GzipWithContentReceiver) {
  7660. Headers headers;
  7661. headers.emplace("Accept-Encoding", "gzip, deflate");
  7662. std::string body;
  7663. auto res = cli_.Get("/compress", headers,
  7664. [&](const char *data, uint64_t data_length) {
  7665. EXPECT_EQ(100U, data_length);
  7666. body.append(data, data_length);
  7667. return true;
  7668. });
  7669. ASSERT_TRUE(res) << "Error: " << to_string(res.error());
  7670. EXPECT_EQ("gzip", res->get_header_value("Content-Encoding"));
  7671. EXPECT_EQ("text/plain", res->get_header_value("Content-Type"));
  7672. EXPECT_EQ("33", res->get_header_value("Content-Length"));
  7673. EXPECT_EQ("123456789012345678901234567890123456789012345678901234567890123456"
  7674. "7890123456789012345678901234567890",
  7675. body);
  7676. EXPECT_EQ(StatusCode::OK_200, res->status);
  7677. }
  7678. TEST_F(ServerTest, GzipWithoutDecompressing) {
  7679. Headers headers;
  7680. headers.emplace("Accept-Encoding", "gzip, deflate");
  7681. cli_.set_decompress(false);
  7682. auto res = cli_.Get("/compress", headers);
  7683. ASSERT_TRUE(res) << "Error: " << to_string(res.error());
  7684. EXPECT_EQ("gzip", res->get_header_value("Content-Encoding"));
  7685. EXPECT_EQ("text/plain", res->get_header_value("Content-Type"));
  7686. EXPECT_EQ("33", res->get_header_value("Content-Length"));
  7687. EXPECT_EQ(33U, res->body.size());
  7688. EXPECT_EQ(StatusCode::OK_200, res->status);
  7689. }
  7690. TEST_F(ServerTest, GzipWithContentReceiverWithoutAcceptEncoding) {
  7691. Headers headers;
  7692. headers.emplace("Accept-Encoding", "");
  7693. std::string body;
  7694. auto res = cli_.Get("/compress", headers,
  7695. [&](const char *data, uint64_t data_length) {
  7696. EXPECT_EQ(100U, data_length);
  7697. body.append(data, data_length);
  7698. return true;
  7699. });
  7700. ASSERT_TRUE(res) << "Error: " << to_string(res.error());
  7701. EXPECT_TRUE(res->get_header_value("Content-Encoding").empty());
  7702. EXPECT_EQ("text/plain", res->get_header_value("Content-Type"));
  7703. EXPECT_EQ("100", res->get_header_value("Content-Length"));
  7704. EXPECT_EQ("123456789012345678901234567890123456789012345678901234567890123456"
  7705. "7890123456789012345678901234567890",
  7706. body);
  7707. EXPECT_EQ(StatusCode::OK_200, res->status);
  7708. }
  7709. TEST_F(ServerTest, NoGzip) {
  7710. Headers headers;
  7711. headers.emplace("Accept-Encoding", "gzip, deflate");
  7712. auto res = cli_.Get("/nocompress", headers);
  7713. ASSERT_TRUE(res) << "Error: " << to_string(res.error());
  7714. EXPECT_EQ(false, res->has_header("Content-Encoding"));
  7715. EXPECT_EQ("application/octet-stream", res->get_header_value("Content-Type"));
  7716. EXPECT_EQ("100", res->get_header_value("Content-Length"));
  7717. EXPECT_EQ("123456789012345678901234567890123456789012345678901234567890123456"
  7718. "7890123456789012345678901234567890",
  7719. res->body);
  7720. EXPECT_EQ(StatusCode::OK_200, res->status);
  7721. }
  7722. TEST_F(ServerTest, NoGzipWithContentReceiver) {
  7723. Headers headers;
  7724. headers.emplace("Accept-Encoding", "gzip, deflate");
  7725. std::string body;
  7726. auto res = cli_.Get("/nocompress", headers,
  7727. [&](const char *data, uint64_t data_length) {
  7728. EXPECT_EQ(100U, data_length);
  7729. body.append(data, data_length);
  7730. return true;
  7731. });
  7732. ASSERT_TRUE(res) << "Error: " << to_string(res.error());
  7733. EXPECT_EQ(false, res->has_header("Content-Encoding"));
  7734. EXPECT_EQ("application/octet-stream", res->get_header_value("Content-Type"));
  7735. EXPECT_EQ("100", res->get_header_value("Content-Length"));
  7736. EXPECT_EQ("123456789012345678901234567890123456789012345678901234567890123456"
  7737. "7890123456789012345678901234567890",
  7738. body);
  7739. EXPECT_EQ(StatusCode::OK_200, res->status);
  7740. }
  7741. TEST_F(ServerTest, MultipartFormDataGzip) {
  7742. UploadFormDataItems items = {
  7743. {"key1", "test", "", ""},
  7744. {"key2", "--abcdefg123", "", ""},
  7745. };
  7746. cli_.set_compress(true);
  7747. auto res = cli_.Post("/compress-multipart", items);
  7748. ASSERT_TRUE(res) << "Error: " << to_string(res.error());
  7749. EXPECT_EQ(StatusCode::OK_200, res->status);
  7750. }
  7751. #endif
  7752. #ifdef CPPHTTPLIB_ZLIB_SUPPORT
  7753. // Static file compression is opt-in, so these run their own server rather than
  7754. // flipping it on for the shared ServerTest fixture, which would silently
  7755. // rewrite what every other static file test is asserting.
  7756. class StaticFileCompressionTest : public ::testing::Test {
  7757. protected:
  7758. void TearDown() override {
  7759. if (t_.joinable()) {
  7760. svr_.stop();
  7761. t_.join();
  7762. }
  7763. }
  7764. int start(const std::function<void(Server &)> &configure = nullptr) {
  7765. // Serves the same tree as a directory of build-time compressed assets
  7766. // would be served: the mount point names the coding the files are already
  7767. // stored in. Registered before "/" so it is the one that matches.
  7768. svr_.set_mount_point("/pre-encoded", "./www",
  7769. {{"Content-Encoding", "gzip"}});
  7770. svr_.set_mount_point("/", "./www");
  7771. svr_.Get("/file_content", [](const Request & /*req*/, Response &res) {
  7772. res.set_file_content("./www/dir/index.html", "text/html");
  7773. });
  7774. svr_.Get("/pre-encoded-file-content",
  7775. [](const Request & /*req*/, Response &res) {
  7776. res.set_header("Content-Encoding", "gzip");
  7777. res.set_file_content("./www/dir/index.html", "text/html");
  7778. });
  7779. svr_.Get("/streamed", [](const Request & /*req*/, Response &res) {
  7780. res.set_content_provider(
  7781. 6, "text/plain",
  7782. [](size_t offset, size_t /*length*/, DataSink &sink) {
  7783. sink.write(offset < 3 ? "aaa" : "bbb", 3);
  7784. return true;
  7785. });
  7786. });
  7787. svr_.Get("/slow-stream", [](const Request & /*req*/, Response &res) {
  7788. res.set_content_provider(
  7789. 1000, "text/plain",
  7790. [](size_t offset, size_t /*length*/, DataSink &sink) {
  7791. if (offset < 100) {
  7792. std::string data(100, 'A');
  7793. sink.write(data.data(), data.size());
  7794. return true;
  7795. }
  7796. std::this_thread::sleep_for(std::chrono::seconds(2));
  7797. std::string data(900, 'B');
  7798. sink.write(data.data(), data.size());
  7799. return true;
  7800. });
  7801. });
  7802. if (configure) { configure(svr_); }
  7803. auto port = svr_.bind_to_any_port(HOST);
  7804. t_ = std::thread([&]() { svr_.listen_after_bind(); });
  7805. svr_.wait_until_ready();
  7806. return port;
  7807. }
  7808. static void enable(Server &svr) { svr.set_static_file_compression(true); }
  7809. // Every file under ./www except 1MB.txt is smaller than the default
  7810. // 1400-byte floor, so a test that needs a small file compressed has to lower
  7811. // it out of the way.
  7812. static void enable_without_floor(Server &svr) {
  7813. svr.set_static_file_compression(true);
  7814. svr.set_static_file_compression_min_length(0);
  7815. }
  7816. Server svr_;
  7817. std::thread t_;
  7818. };
  7819. TEST_F(StaticFileCompressionTest, DisabledByDefault) {
  7820. auto port = start();
  7821. Client cli(HOST, port);
  7822. auto res = cli.Get("/dir/1MB.txt", Headers{{"Accept-Encoding", "gzip"}});
  7823. ASSERT_TRUE(res) << "Error: " << to_string(res.error());
  7824. EXPECT_EQ(StatusCode::OK_200, res->status);
  7825. EXPECT_FALSE(res->has_header("Content-Encoding"));
  7826. EXPECT_EQ("1048576", res->get_header_value("Content-Length"));
  7827. EXPECT_EQ(1048576U, res->body.size());
  7828. }
  7829. TEST_F(StaticFileCompressionTest, MountPoint) {
  7830. auto port = start(enable);
  7831. Client cli(HOST, port);
  7832. cli.set_decompress(false);
  7833. auto res = cli.Get("/dir/1MB.txt", Headers{{"Accept-Encoding", "gzip"}});
  7834. ASSERT_TRUE(res) << "Error: " << to_string(res.error());
  7835. EXPECT_EQ(StatusCode::OK_200, res->status);
  7836. EXPECT_EQ("text/plain", res->get_header_value("Content-Type"));
  7837. EXPECT_EQ("gzip", res->get_header_value("Content-Encoding"));
  7838. EXPECT_EQ("Accept-Encoding", res->get_header_value("Vary"));
  7839. // The response stays self-delimiting: a length, not a chunked body.
  7840. EXPECT_FALSE(res->has_header("Transfer-Encoding"));
  7841. EXPECT_EQ(std::to_string(res->body.size()),
  7842. res->get_header_value("Content-Length"));
  7843. EXPECT_LT(res->body.size(), 1048576U);
  7844. EXPECT_FALSE(res->body.empty());
  7845. }
  7846. TEST_F(StaticFileCompressionTest, MountPointDecompressed) {
  7847. auto port = start(enable);
  7848. Client cli(HOST, port);
  7849. auto res = cli.Get("/dir/1MB.txt", Headers{{"Accept-Encoding", "gzip"}});
  7850. ASSERT_TRUE(res) << "Error: " << to_string(res.error());
  7851. EXPECT_EQ(StatusCode::OK_200, res->status);
  7852. EXPECT_EQ("gzip", res->get_header_value("Content-Encoding"));
  7853. EXPECT_EQ(1048576U, res->body.size());
  7854. }
  7855. TEST_F(StaticFileCompressionTest, FileContent) {
  7856. auto port = start(enable_without_floor);
  7857. Client cli(HOST, port);
  7858. auto res = cli.Get("/file_content", Headers{{"Accept-Encoding", "gzip"}});
  7859. ASSERT_TRUE(res) << "Error: " << to_string(res.error());
  7860. EXPECT_EQ(StatusCode::OK_200, res->status);
  7861. EXPECT_EQ("text/html", res->get_header_value("Content-Type"));
  7862. EXPECT_EQ("gzip", res->get_header_value("Content-Encoding"));
  7863. EXPECT_EQ(104U, res->body.size());
  7864. }
  7865. // A handler that serves an already-encoded file names the coding itself. The
  7866. // file-backed path decided its coding from Accept-Encoding and the content
  7867. // type alone, so it compressed the stored bytes a second time and appended a
  7868. // second Content-Encoding field line.
  7869. TEST_F(StaticFileCompressionTest, PreEncodedFileContentIsNotCompressedAgain) {
  7870. auto port = start(enable_without_floor);
  7871. Client cli(HOST, port);
  7872. cli.set_decompress(false);
  7873. auto res = cli.Get("/pre-encoded-file-content",
  7874. Headers{{"Accept-Encoding", "gzip"}});
  7875. ASSERT_TRUE(res) << "Error: " << to_string(res.error());
  7876. EXPECT_EQ(StatusCode::OK_200, res->status);
  7877. EXPECT_EQ(1U, res->get_header_value_count("Content-Encoding"));
  7878. EXPECT_EQ("gzip", res->get_header_value("Content-Encoding"));
  7879. // Vary belongs to a coding the server chose, and it chose none here.
  7880. EXPECT_FALSE(res->has_header("Vary"));
  7881. // The file travels exactly as it is stored on disk.
  7882. EXPECT_EQ(104U, res->body.size());
  7883. }
  7884. // The 1MB file clears the default floor, so this one runs the configuration a
  7885. // deployment would actually have.
  7886. TEST_F(StaticFileCompressionTest, PreEncodedMountPointIsNotCompressedAgain) {
  7887. auto port = start(enable);
  7888. Client cli(HOST, port);
  7889. cli.set_decompress(false);
  7890. auto res =
  7891. cli.Get("/pre-encoded/dir/1MB.txt", Headers{{"Accept-Encoding", "gzip"}});
  7892. ASSERT_TRUE(res) << "Error: " << to_string(res.error());
  7893. EXPECT_EQ(StatusCode::OK_200, res->status);
  7894. EXPECT_EQ(1U, res->get_header_value_count("Content-Encoding"));
  7895. EXPECT_EQ("gzip", res->get_header_value("Content-Encoding"));
  7896. EXPECT_FALSE(res->has_header("Vary"));
  7897. EXPECT_EQ(1048576U, res->body.size());
  7898. EXPECT_EQ("1048576", res->get_header_value("Content-Length"));
  7899. }
  7900. TEST_F(StaticFileCompressionTest, Head) {
  7901. auto port = start(enable);
  7902. Client cli(HOST, port);
  7903. cli.set_decompress(false);
  7904. auto get = cli.Get("/dir/1MB.txt", Headers{{"Accept-Encoding", "gzip"}});
  7905. ASSERT_TRUE(get) << "Error: " << to_string(get.error());
  7906. auto res = cli.Head("/dir/1MB.txt", Headers{{"Accept-Encoding", "gzip"}});
  7907. ASSERT_TRUE(res) << "Error: " << to_string(res.error());
  7908. EXPECT_EQ(StatusCode::OK_200, res->status);
  7909. EXPECT_EQ("gzip", res->get_header_value("Content-Encoding"));
  7910. EXPECT_FALSE(res->has_header("Transfer-Encoding"));
  7911. // HEAD still reports the size a GET would return.
  7912. EXPECT_EQ(get->get_header_value("Content-Length"),
  7913. res->get_header_value("Content-Length"));
  7914. EXPECT_TRUE(res->body.empty());
  7915. }
  7916. TEST_F(StaticFileCompressionTest, RangeStaysIdentity) {
  7917. auto port = start(enable);
  7918. Client cli(HOST, port);
  7919. auto res = cli.Get("/dir/test.abcde", Headers{make_range_header({{2, 3}}),
  7920. {"Accept-Encoding", "gzip"}});
  7921. ASSERT_TRUE(res) << "Error: " << to_string(res.error());
  7922. EXPECT_EQ(StatusCode::PartialContent_206, res->status);
  7923. EXPECT_FALSE(res->has_header("Content-Encoding"));
  7924. EXPECT_EQ("2", res->get_header_value("Content-Length"));
  7925. EXPECT_EQ("bytes 2-3/5", res->get_header_value("Content-Range"));
  7926. EXPECT_EQ("cd", res->body);
  7927. }
  7928. TEST_F(StaticFileCompressionTest, NotCompressibleType) {
  7929. auto port = start(enable);
  7930. Client cli(HOST, port);
  7931. auto res = cli.Get("/file", Headers{{"Accept-Encoding", "gzip"}});
  7932. ASSERT_TRUE(res) << "Error: " << to_string(res.error());
  7933. EXPECT_EQ(StatusCode::OK_200, res->status);
  7934. EXPECT_EQ("application/octet-stream", res->get_header_value("Content-Type"));
  7935. EXPECT_FALSE(res->has_header("Content-Encoding"));
  7936. EXPECT_EQ("5", res->get_header_value("Content-Length"));
  7937. }
  7938. TEST_F(StaticFileCompressionTest, EmptyFile) {
  7939. auto port = start(enable);
  7940. Client cli(HOST, port);
  7941. auto res = cli.Get("/empty_file", Headers{{"Accept-Encoding", "gzip"}});
  7942. ASSERT_TRUE(res) << "Error: " << to_string(res.error());
  7943. EXPECT_EQ(StatusCode::OK_200, res->status);
  7944. EXPECT_FALSE(res->has_header("Content-Encoding"));
  7945. EXPECT_EQ("0", res->get_header_value("Content-Length"));
  7946. EXPECT_TRUE(res->body.empty());
  7947. }
  7948. TEST_F(StaticFileCompressionTest, MinLength) {
  7949. auto port = start(enable);
  7950. Client cli(HOST, port);
  7951. // 104 bytes, well under the default floor. Compressing it would add the
  7952. // gzip header and trailer to a body that already fits in one packet.
  7953. auto res = cli.Get("/dir/index.html", Headers{{"Accept-Encoding", "gzip"}});
  7954. ASSERT_TRUE(res) << "Error: " << to_string(res.error());
  7955. EXPECT_EQ(StatusCode::OK_200, res->status);
  7956. EXPECT_FALSE(res->has_header("Content-Encoding"));
  7957. EXPECT_EQ("104", res->get_header_value("Content-Length"));
  7958. }
  7959. TEST_F(StaticFileCompressionTest, MinLengthLowered) {
  7960. auto port = start([](Server &svr) {
  7961. svr.set_static_file_compression(true);
  7962. svr.set_static_file_compression_min_length(1);
  7963. });
  7964. Client cli(HOST, port);
  7965. cli.set_decompress(false);
  7966. auto res = cli.Get("/dir/test.html", Headers{{"Accept-Encoding", "gzip"}});
  7967. ASSERT_TRUE(res) << "Error: " << to_string(res.error());
  7968. EXPECT_EQ("gzip", res->get_header_value("Content-Encoding"));
  7969. // A 9-byte file comes back larger than it went in, because gzip's header and
  7970. // trailer outweigh anything deflate can save. That is the end of the range
  7971. // the floor exists to keep out.
  7972. EXPECT_GT(res->body.size(), 9U);
  7973. }
  7974. TEST_F(StaticFileCompressionTest, MaxLength) {
  7975. auto port = start([](Server &svr) {
  7976. svr.set_static_file_compression(true);
  7977. svr.set_static_file_compression_min_length(0);
  7978. svr.set_static_file_compression_max_length(1024);
  7979. });
  7980. Client cli(HOST, port);
  7981. // Over the limit: served as is. Not named `big`/`small`: <rpcndr.h>
  7982. // defines `small` as a macro on Windows.
  7983. auto over = cli.Get("/dir/1MB.txt", Headers{{"Accept-Encoding", "gzip"}});
  7984. ASSERT_TRUE(over) << "Error: " << to_string(over.error());
  7985. EXPECT_FALSE(over->has_header("Content-Encoding"));
  7986. EXPECT_EQ("1048576", over->get_header_value("Content-Length"));
  7987. // Under it: compressed.
  7988. auto under = cli.Get("/dir/index.html", Headers{{"Accept-Encoding", "gzip"}});
  7989. ASSERT_TRUE(under) << "Error: " << to_string(under.error());
  7990. EXPECT_EQ("gzip", under->get_header_value("Content-Encoding"));
  7991. }
  7992. TEST_F(StaticFileCompressionTest, EtagPerEncoding) {
  7993. auto port = start(enable_without_floor);
  7994. Client cli(HOST, port);
  7995. auto identity = cli.Get("/dir/index.html", Headers{{"Accept-Encoding", ""}});
  7996. ASSERT_TRUE(identity) << "Error: " << to_string(identity.error());
  7997. EXPECT_FALSE(identity->has_header("Content-Encoding"));
  7998. auto identity_etag = identity->get_header_value("ETag");
  7999. ASSERT_FALSE(identity_etag.empty());
  8000. auto gzipped =
  8001. cli.Get("/dir/index.html", Headers{{"Accept-Encoding", "gzip"}});
  8002. ASSERT_TRUE(gzipped) << "Error: " << to_string(gzipped.error());
  8003. EXPECT_EQ("gzip", gzipped->get_header_value("Content-Encoding"));
  8004. auto gzip_etag = gzipped->get_header_value("ETag");
  8005. ASSERT_FALSE(gzip_etag.empty());
  8006. // Two representations, two validators.
  8007. EXPECT_NE(identity_etag, gzip_etag);
  8008. // Each one revalidates against the request that would produce it...
  8009. auto fresh =
  8010. cli.Get("/dir/index.html", Headers{{"Accept-Encoding", "gzip"},
  8011. {"If-None-Match", gzip_etag}});
  8012. ASSERT_TRUE(fresh) << "Error: " << to_string(fresh.error());
  8013. EXPECT_EQ(StatusCode::NotModified_304, fresh->status);
  8014. auto fresh_identity =
  8015. cli.Get("/dir/index.html", Headers{{"Accept-Encoding", ""},
  8016. {"If-None-Match", identity_etag}});
  8017. ASSERT_TRUE(fresh_identity) << "Error: " << to_string(fresh_identity.error());
  8018. EXPECT_EQ(StatusCode::NotModified_304, fresh_identity->status);
  8019. // ...and not against the other representation.
  8020. auto crossed =
  8021. cli.Get("/dir/index.html",
  8022. Headers{{"Accept-Encoding", ""}, {"If-None-Match", gzip_etag}});
  8023. ASSERT_TRUE(crossed) << "Error: " << to_string(crossed.error());
  8024. EXPECT_EQ(StatusCode::OK_200, crossed->status);
  8025. }
  8026. // The opt-in covers responses the server reads off disk itself. A caller's own
  8027. // known-length provider keeps its Content-Length and, more importantly, keeps
  8028. // delivering incrementally: routing it through a compressor would hold every
  8029. // write back until zlib's window filled.
  8030. TEST_F(StaticFileCompressionTest, KnownLengthProviderUnaffected) {
  8031. auto port = start(enable);
  8032. Client cli(HOST, port);
  8033. auto res = cli.Get("/streamed", Headers{{"Accept-Encoding", "gzip"}});
  8034. ASSERT_TRUE(res) << "Error: " << to_string(res.error());
  8035. EXPECT_EQ(StatusCode::OK_200, res->status);
  8036. EXPECT_FALSE(res->has_header("Content-Encoding"));
  8037. EXPECT_EQ("6", res->get_header_value("Content-Length"));
  8038. EXPECT_EQ("aaabbb", res->body);
  8039. }
  8040. TEST_F(StaticFileCompressionTest, IncrementalProviderUnaffected) {
  8041. auto port = start(enable);
  8042. Client cli(HOST, port);
  8043. cli.set_read_timeout(1, 0);
  8044. auto handle = cli.open_stream("GET", "/slow-stream", Params{},
  8045. Headers{{"Accept-Encoding", "gzip"}});
  8046. ASSERT_TRUE(handle.is_valid());
  8047. // The provider writes 100 bytes and then stalls for longer than the read
  8048. // timeout. Those first bytes have to arrive anyway: run the response through
  8049. // a compressor and zlib holds them until its window fills, so the read would
  8050. // come back empty instead.
  8051. char buf[256];
  8052. auto n = handle.read(buf, sizeof(buf));
  8053. ASSERT_GT(n, 0) << "first read should return the bytes already written";
  8054. EXPECT_EQ(std::string(100, 'A'), std::string(buf, static_cast<size_t>(n)));
  8055. }
  8056. #endif
  8057. #ifdef CPPHTTPLIB_BROTLI_SUPPORT
  8058. TEST_F(ServerTest, Brotli) {
  8059. Headers headers;
  8060. headers.emplace("Accept-Encoding", "br");
  8061. auto res = cli_.Get("/compress", headers);
  8062. ASSERT_TRUE(res) << "Error: " << to_string(res.error());
  8063. EXPECT_EQ("br", res->get_header_value("Content-Encoding"));
  8064. EXPECT_EQ("text/plain", res->get_header_value("Content-Type"));
  8065. EXPECT_EQ("19", res->get_header_value("Content-Length"));
  8066. EXPECT_EQ("123456789012345678901234567890123456789012345678901234567890123456"
  8067. "7890123456789012345678901234567890",
  8068. res->body);
  8069. EXPECT_EQ(StatusCode::OK_200, res->status);
  8070. }
  8071. #endif
  8072. #ifdef CPPHTTPLIB_ZSTD_SUPPORT
  8073. TEST_F(ServerTest, Zstd) {
  8074. Headers headers;
  8075. headers.emplace("Accept-Encoding", "zstd");
  8076. auto res = cli_.Get("/compress", headers);
  8077. ASSERT_TRUE(res) << "Error: " << to_string(res.error());
  8078. EXPECT_EQ("zstd", res->get_header_value("Content-Encoding"));
  8079. EXPECT_EQ("text/plain", res->get_header_value("Content-Type"));
  8080. EXPECT_EQ("26", res->get_header_value("Content-Length"));
  8081. EXPECT_EQ("123456789012345678901234567890123456789012345678901234567890123456"
  8082. "7890123456789012345678901234567890",
  8083. res->body);
  8084. EXPECT_EQ(StatusCode::OK_200, res->status);
  8085. }
  8086. TEST_F(ServerTest, ZstdWithoutAcceptEncoding) {
  8087. Headers headers;
  8088. headers.emplace("Accept-Encoding", "");
  8089. auto res = cli_.Get("/compress", headers);
  8090. ASSERT_TRUE(res) << "Error: " << to_string(res.error());
  8091. EXPECT_TRUE(res->get_header_value("Content-Encoding").empty());
  8092. EXPECT_EQ("text/plain", res->get_header_value("Content-Type"));
  8093. EXPECT_EQ("100", res->get_header_value("Content-Length"));
  8094. EXPECT_EQ("123456789012345678901234567890123456789012345678901234567890123456"
  8095. "7890123456789012345678901234567890",
  8096. res->body);
  8097. EXPECT_EQ(StatusCode::OK_200, res->status);
  8098. }
  8099. TEST_F(ServerTest, ZstdWithContentReceiver) {
  8100. Headers headers;
  8101. headers.emplace("Accept-Encoding", "zstd");
  8102. std::string body;
  8103. auto res = cli_.Get("/compress", headers,
  8104. [&](const char *data, uint64_t data_length) {
  8105. EXPECT_EQ(100U, data_length);
  8106. body.append(data, data_length);
  8107. return true;
  8108. });
  8109. ASSERT_TRUE(res) << "Error: " << to_string(res.error());
  8110. EXPECT_EQ("zstd", res->get_header_value("Content-Encoding"));
  8111. EXPECT_EQ("text/plain", res->get_header_value("Content-Type"));
  8112. EXPECT_EQ("26", res->get_header_value("Content-Length"));
  8113. EXPECT_EQ("123456789012345678901234567890123456789012345678901234567890123456"
  8114. "7890123456789012345678901234567890",
  8115. body);
  8116. EXPECT_EQ(StatusCode::OK_200, res->status);
  8117. }
  8118. TEST_F(ServerTest, ZstdWithoutDecompressing) {
  8119. Headers headers;
  8120. headers.emplace("Accept-Encoding", "zstd");
  8121. cli_.set_decompress(false);
  8122. auto res = cli_.Get("/compress", headers);
  8123. unsigned char compressed[26] = {0x28, 0xb5, 0x2f, 0xfd, 0x20, 0x64, 0x8d,
  8124. 0x00, 0x00, 0x50, 0x31, 0x32, 0x33, 0x34,
  8125. 0x35, 0x36, 0x37, 0x38, 0x39, 0x30, 0x01,
  8126. 0x00, 0xd7, 0xa9, 0x20, 0x01};
  8127. ASSERT_TRUE(res) << "Error: " << to_string(res.error());
  8128. EXPECT_EQ("zstd", res->get_header_value("Content-Encoding"));
  8129. EXPECT_EQ("text/plain", res->get_header_value("Content-Type"));
  8130. EXPECT_EQ("26", res->get_header_value("Content-Length"));
  8131. EXPECT_EQ(StatusCode::OK_200, res->status);
  8132. ASSERT_EQ(26U, res->body.size());
  8133. EXPECT_TRUE(std::memcmp(compressed, res->body.data(), sizeof(compressed)) ==
  8134. 0);
  8135. }
  8136. TEST_F(ServerTest, ZstdWithContentReceiverWithoutAcceptEncoding) {
  8137. Headers headers;
  8138. headers.emplace("Accept-Encoding", "");
  8139. std::string body;
  8140. auto res = cli_.Get("/compress", headers,
  8141. [&](const char *data, uint64_t data_length) {
  8142. EXPECT_EQ(100U, data_length);
  8143. body.append(data, data_length);
  8144. return true;
  8145. });
  8146. ASSERT_TRUE(res) << "Error: " << to_string(res.error());
  8147. EXPECT_TRUE(res->get_header_value("Content-Encoding").empty());
  8148. EXPECT_EQ("text/plain", res->get_header_value("Content-Type"));
  8149. EXPECT_EQ("100", res->get_header_value("Content-Length"));
  8150. EXPECT_EQ("123456789012345678901234567890123456789012345678901234567890123456"
  8151. "7890123456789012345678901234567890",
  8152. body);
  8153. EXPECT_EQ(StatusCode::OK_200, res->status);
  8154. }
  8155. TEST_F(ServerTest, NoZstd) {
  8156. Headers headers;
  8157. headers.emplace("Accept-Encoding", "zstd");
  8158. auto res = cli_.Get("/nocompress", headers);
  8159. ASSERT_TRUE(res) << "Error: " << to_string(res.error());
  8160. EXPECT_EQ(false, res->has_header("Content-Encoding"));
  8161. EXPECT_EQ("application/octet-stream", res->get_header_value("Content-Type"));
  8162. EXPECT_EQ("100", res->get_header_value("Content-Length"));
  8163. EXPECT_EQ("123456789012345678901234567890123456789012345678901234567890123456"
  8164. "7890123456789012345678901234567890",
  8165. res->body);
  8166. EXPECT_EQ(StatusCode::OK_200, res->status);
  8167. }
  8168. TEST_F(ServerTest, NoZstdWithContentReceiver) {
  8169. Headers headers;
  8170. headers.emplace("Accept-Encoding", "zstd");
  8171. std::string body;
  8172. auto res = cli_.Get("/nocompress", headers,
  8173. [&](const char *data, uint64_t data_length) {
  8174. EXPECT_EQ(100U, data_length);
  8175. body.append(data, data_length);
  8176. return true;
  8177. });
  8178. ASSERT_TRUE(res) << "Error: " << to_string(res.error());
  8179. EXPECT_EQ(false, res->has_header("Content-Encoding"));
  8180. EXPECT_EQ("application/octet-stream", res->get_header_value("Content-Type"));
  8181. EXPECT_EQ("100", res->get_header_value("Content-Length"));
  8182. EXPECT_EQ("123456789012345678901234567890123456789012345678901234567890123456"
  8183. "7890123456789012345678901234567890",
  8184. body);
  8185. EXPECT_EQ(StatusCode::OK_200, res->status);
  8186. }
  8187. // TODO: How to enable zstd ??
  8188. TEST_F(ServerTest, MultipartFormDataZstd) {
  8189. UploadFormDataItems items = {
  8190. {"key1", "test", "", ""},
  8191. {"key2", "--abcdefg123", "", ""},
  8192. };
  8193. Headers headers;
  8194. headers.emplace("Accept-Encoding", "zstd");
  8195. cli_.set_compress(true);
  8196. auto res = cli_.Post("/compress-multipart", headers, items);
  8197. ASSERT_TRUE(res) << "Error: " << to_string(res.error());
  8198. EXPECT_EQ(StatusCode::OK_200, res->status);
  8199. }
  8200. TEST_F(ServerTest, PutWithContentProviderWithZstd) {
  8201. Headers headers;
  8202. headers.emplace("Accept-Encoding", "zstd");
  8203. cli_.set_compress(true);
  8204. auto res = cli_.Put(
  8205. "/put", headers, 3,
  8206. [](size_t /*offset*/, size_t /*length*/, DataSink &sink) {
  8207. sink.os << "PUT";
  8208. return true;
  8209. },
  8210. "text/plain");
  8211. ASSERT_TRUE(res) << "Error: " << to_string(res.error());
  8212. EXPECT_EQ(StatusCode::OK_200, res->status);
  8213. EXPECT_EQ("PUT", res->body);
  8214. }
  8215. // Pre-compression logging tests
  8216. TEST_F(ServerTest, PreCompressionLogging) {
  8217. // Test data for compression (matches the actual /compress endpoint content)
  8218. const std::string test_content =
  8219. "123456789012345678901234567890123456789012345678901234567890123456789012"
  8220. "3456789012345678901234567890";
  8221. // Variables to capture logging data
  8222. std::string pre_compression_body;
  8223. std::string pre_compression_content_type;
  8224. std::string pre_compression_content_encoding;
  8225. std::string post_compression_body;
  8226. std::string post_compression_content_type;
  8227. std::string post_compression_content_encoding;
  8228. // Set up pre-compression logger
  8229. svr_.set_pre_compression_logger([&](const Request & /*req*/,
  8230. const Response &res) {
  8231. pre_compression_body = res.body;
  8232. pre_compression_content_type = res.get_header_value("Content-Type");
  8233. pre_compression_content_encoding = res.get_header_value("Content-Encoding");
  8234. });
  8235. // Set up post-compression logger
  8236. svr_.set_logger([&](const Request & /*req*/, const Response &res) {
  8237. post_compression_body = res.body;
  8238. post_compression_content_type = res.get_header_value("Content-Type");
  8239. post_compression_content_encoding =
  8240. res.get_header_value("Content-Encoding");
  8241. });
  8242. // Test with gzip compression
  8243. Headers headers;
  8244. headers.emplace("Accept-Encoding", "gzip");
  8245. auto res = cli_.Get("/compress", headers);
  8246. // Verify response was compressed
  8247. ASSERT_TRUE(res) << "Error: " << to_string(res.error());
  8248. EXPECT_EQ(StatusCode::OK_200, res->status);
  8249. EXPECT_EQ("gzip", res->get_header_value("Content-Encoding"));
  8250. // Verify pre-compression logger captured uncompressed content
  8251. EXPECT_EQ(test_content, pre_compression_body);
  8252. EXPECT_EQ("text/plain", pre_compression_content_type);
  8253. EXPECT_TRUE(pre_compression_content_encoding
  8254. .empty()); // No encoding header before compression
  8255. // Verify post-compression logger captured compressed content
  8256. EXPECT_NE(test_content,
  8257. post_compression_body); // Should be different after compression
  8258. EXPECT_EQ("text/plain", post_compression_content_type);
  8259. EXPECT_EQ("gzip", post_compression_content_encoding);
  8260. // Verify compressed content is smaller
  8261. EXPECT_LT(post_compression_body.size(), pre_compression_body.size());
  8262. }
  8263. TEST_F(ServerTest, PreCompressionLoggingWithBrotli) {
  8264. const std::string test_content =
  8265. "123456789012345678901234567890123456789012345678901234567890123456789012"
  8266. "3456789012345678901234567890";
  8267. std::string pre_compression_body;
  8268. std::string post_compression_body;
  8269. svr_.set_pre_compression_logger(
  8270. [&](const Request & /*req*/, const Response &res) {
  8271. pre_compression_body = res.body;
  8272. });
  8273. svr_.set_logger([&](const Request & /*req*/, const Response &res) {
  8274. post_compression_body = res.body;
  8275. });
  8276. Headers headers;
  8277. headers.emplace("Accept-Encoding", "br");
  8278. auto res = cli_.Get("/compress", headers);
  8279. ASSERT_TRUE(res) << "Error: " << to_string(res.error());
  8280. EXPECT_EQ(StatusCode::OK_200, res->status);
  8281. EXPECT_EQ("br", res->get_header_value("Content-Encoding"));
  8282. // Verify pre-compression content is uncompressed
  8283. EXPECT_EQ(test_content, pre_compression_body);
  8284. // Verify post-compression content is compressed
  8285. EXPECT_NE(test_content, post_compression_body);
  8286. EXPECT_LT(post_compression_body.size(), pre_compression_body.size());
  8287. }
  8288. TEST_F(ServerTest, PreCompressionLoggingWithoutCompression) {
  8289. const std::string test_content =
  8290. "123456789012345678901234567890123456789012345678901234567890123456789012"
  8291. "3456789012345678901234567890";
  8292. std::string pre_compression_body;
  8293. std::string post_compression_body;
  8294. svr_.set_pre_compression_logger(
  8295. [&](const Request & /*req*/, const Response &res) {
  8296. pre_compression_body = res.body;
  8297. });
  8298. svr_.set_logger([&](const Request & /*req*/, const Response &res) {
  8299. post_compression_body = res.body;
  8300. });
  8301. // Request without compression (use /nocompress endpoint)
  8302. Headers headers;
  8303. auto res = cli_.Get("/nocompress", headers);
  8304. ASSERT_TRUE(res) << "Error: " << to_string(res.error());
  8305. EXPECT_EQ(StatusCode::OK_200, res->status);
  8306. EXPECT_TRUE(res->get_header_value("Content-Encoding").empty());
  8307. // Pre-compression logger should not be called when no compression is applied
  8308. EXPECT_TRUE(
  8309. pre_compression_body.empty()); // Pre-compression logger not called
  8310. EXPECT_EQ(
  8311. test_content,
  8312. post_compression_body); // Post-compression logger captures final content
  8313. }
  8314. TEST_F(ServerTest, LoggerSeesContentLength) {
  8315. size_t logged_content_length = 0;
  8316. std::string logged_content_length_header;
  8317. svr_.set_logger([&](const Request & /*req*/, const Response &res) {
  8318. logged_content_length = res.content_length_;
  8319. logged_content_length_header = res.get_header_value("Content-Length");
  8320. });
  8321. auto res = cli_.Get("/nocompress");
  8322. ASSERT_TRUE(res) << "Error: " << to_string(res.error());
  8323. EXPECT_EQ(StatusCode::OK_200, res->status);
  8324. EXPECT_EQ(res->body.size(), logged_content_length);
  8325. EXPECT_EQ(std::to_string(logged_content_length),
  8326. logged_content_length_header);
  8327. }
  8328. TEST_F(ServerTest, PreCompressionLoggingOnlyPreLogger) {
  8329. const std::string test_content =
  8330. "123456789012345678901234567890123456789012345678901234567890123456789012"
  8331. "3456789012345678901234567890";
  8332. std::string pre_compression_body;
  8333. bool pre_logger_called = false;
  8334. // Set only pre-compression logger
  8335. svr_.set_pre_compression_logger(
  8336. [&](const Request & /*req*/, const Response &res) {
  8337. pre_compression_body = res.body;
  8338. pre_logger_called = true;
  8339. });
  8340. Headers headers;
  8341. headers.emplace("Accept-Encoding", "gzip");
  8342. auto res = cli_.Get("/compress", headers);
  8343. ASSERT_TRUE(res) << "Error: " << to_string(res.error());
  8344. EXPECT_EQ(StatusCode::OK_200, res->status);
  8345. EXPECT_EQ("gzip", res->get_header_value("Content-Encoding"));
  8346. // Verify pre-compression logger was called
  8347. EXPECT_TRUE(pre_logger_called);
  8348. EXPECT_EQ(test_content, pre_compression_body);
  8349. }
  8350. TEST_F(ServerTest, SendLargeBodyAfterRequestLineError) {
  8351. {
  8352. // Test with Expect: 100-continue header - success case
  8353. // Server returns 100 Continue, client sends body, server returns 200 OK
  8354. Request req;
  8355. req.method = "POST";
  8356. req.path = "/post-large";
  8357. req.set_header("Expect", "100-continue");
  8358. req.body = LARGE_DATA;
  8359. Response res;
  8360. auto error = Error::Success;
  8361. cli_.set_keep_alive(true);
  8362. auto ret = cli_.send(req, res, error);
  8363. EXPECT_TRUE(ret);
  8364. EXPECT_EQ(StatusCode::OK_200, res.status);
  8365. EXPECT_EQ(LARGE_DATA, res.body);
  8366. }
  8367. {
  8368. // Test with Expect: 100-continue header - error case
  8369. // Client should not send the body when server returns an error
  8370. Request req;
  8371. req.method = "POST";
  8372. req.path = "/post-large?q=" + LONG_QUERY_VALUE;
  8373. req.set_header("Expect", "100-continue");
  8374. req.body = LARGE_DATA;
  8375. Response res;
  8376. auto error = Error::Success;
  8377. auto start = std::chrono::high_resolution_clock::now();
  8378. cli_.set_keep_alive(true);
  8379. auto ret = cli_.send(req, res, error);
  8380. auto end = std::chrono::high_resolution_clock::now();
  8381. auto elapsed =
  8382. std::chrono::duration_cast<std::chrono::milliseconds>(end - start)
  8383. .count();
  8384. // With Expect: 100-continue, request completes successfully but with error
  8385. EXPECT_TRUE(ret);
  8386. EXPECT_EQ(StatusCode::UriTooLong_414, res.status);
  8387. EXPECT_EQ("close", res.get_header_value("Connection"));
  8388. EXPECT_FALSE(cli_.is_socket_open());
  8389. EXPECT_LE(elapsed, 2000);
  8390. }
  8391. {
  8392. // Send an extra GET request to ensure error recovery without hanging
  8393. Request req;
  8394. req.method = "GET";
  8395. req.path = "/hi";
  8396. auto start = std::chrono::high_resolution_clock::now();
  8397. auto res = cli_.send(req);
  8398. auto end = std::chrono::high_resolution_clock::now();
  8399. auto elapsed =
  8400. std::chrono::duration_cast<std::chrono::milliseconds>(end - start)
  8401. .count();
  8402. ASSERT_TRUE(res) << "Error: " << to_string(res.error());
  8403. EXPECT_EQ(StatusCode::OK_200, res->status);
  8404. EXPECT_EQ("Hello World!", res->body);
  8405. EXPECT_LE(elapsed, 500);
  8406. }
  8407. }
  8408. TEST(ZstdDecompressor, ChunkedDecompression) {
  8409. std::string data;
  8410. for (size_t i = 0; i < 32 * 1024; ++i) {
  8411. data.push_back(static_cast<char>('a' + i % 26));
  8412. }
  8413. std::string compressed_data;
  8414. {
  8415. httplib::detail::zstd_compressor compressor;
  8416. bool result = compressor.compress(
  8417. data.data(), data.size(),
  8418. /*last=*/true,
  8419. [&](const char *compressed_data_chunk, size_t compressed_data_size) {
  8420. compressed_data.insert(compressed_data.size(), compressed_data_chunk,
  8421. compressed_data_size);
  8422. return true;
  8423. });
  8424. ASSERT_TRUE(result);
  8425. }
  8426. std::string decompressed_data;
  8427. {
  8428. httplib::detail::zstd_decompressor decompressor;
  8429. // Chunk size is chosen specifically to have a decompressed chunk size equal
  8430. // to 16384 bytes 16384 bytes is the size of decompressor output buffer
  8431. size_t chunk_size = 130;
  8432. for (size_t chunk_begin = 0; chunk_begin < compressed_data.size();
  8433. chunk_begin += chunk_size) {
  8434. size_t current_chunk_size =
  8435. std::min(compressed_data.size() - chunk_begin, chunk_size);
  8436. bool result = decompressor.decompress(
  8437. compressed_data.data() + chunk_begin, current_chunk_size,
  8438. [&](const char *decompressed_data_chunk,
  8439. size_t decompressed_data_chunk_size) {
  8440. decompressed_data.insert(decompressed_data.size(),
  8441. decompressed_data_chunk,
  8442. decompressed_data_chunk_size);
  8443. return true;
  8444. });
  8445. ASSERT_TRUE(result);
  8446. }
  8447. }
  8448. ASSERT_EQ(data, decompressed_data);
  8449. }
  8450. TEST(ZstdDecompressor, Decompress) {
  8451. std::string original_text = "Compressed with ZSTD";
  8452. unsigned char data[29] = {0x28, 0xb5, 0x2f, 0xfd, 0x20, 0x14, 0xa1, 0x00,
  8453. 0x00, 0x43, 0x6f, 0x6d, 0x70, 0x72, 0x65, 0x73,
  8454. 0x73, 0x65, 0x64, 0x20, 0x77, 0x69, 0x74, 0x68,
  8455. 0x20, 0x5a, 0x53, 0x54, 0x44};
  8456. std::string compressed_data(data, data + sizeof(data) / sizeof(data[0]));
  8457. std::string decompressed_data;
  8458. {
  8459. httplib::detail::zstd_decompressor decompressor;
  8460. bool result = decompressor.decompress(
  8461. compressed_data.data(), compressed_data.size(),
  8462. [&](const char *decompressed_data_chunk,
  8463. size_t decompressed_data_chunk_size) {
  8464. decompressed_data.insert(decompressed_data.size(),
  8465. decompressed_data_chunk,
  8466. decompressed_data_chunk_size);
  8467. return true;
  8468. });
  8469. ASSERT_TRUE(result);
  8470. }
  8471. ASSERT_EQ(original_text, decompressed_data);
  8472. }
  8473. #endif
  8474. // Sends a raw request to a server listening at HOST:PORT, writing it in
  8475. // separate chunks so that the server sees each part in its own read(). Used to
  8476. // place a read boundary at a specific offset of a request body.
  8477. static bool send_request_in_parts(time_t read_timeout_sec,
  8478. const std::vector<std::string> &parts,
  8479. std::string *resp = nullptr,
  8480. int port = PORT) {
  8481. auto error = Error::Success;
  8482. auto client_sock = detail::create_client_socket(
  8483. HOST, "", port, AF_UNSPEC, false, false, nullptr,
  8484. /*connection_timeout_sec=*/5, 0,
  8485. /*read_timeout_sec=*/5, 0,
  8486. /*write_timeout_sec=*/5, 0, std::string(), error);
  8487. if (client_sock == INVALID_SOCKET) { return false; }
  8488. auto ret = detail::process_client_socket(
  8489. client_sock, read_timeout_sec, 0, 0, 0, 0,
  8490. std::chrono::steady_clock::time_point::min(), [&](Stream &strm) {
  8491. for (size_t i = 0; i < parts.size(); i++) {
  8492. const auto &part = parts[i];
  8493. if (part.size() !=
  8494. static_cast<size_t>(strm.write(part.data(), part.size()))) {
  8495. return false;
  8496. }
  8497. if (i + 1 < parts.size()) {
  8498. std::this_thread::sleep_for(std::chrono::milliseconds(100));
  8499. }
  8500. }
  8501. char buf[512];
  8502. detail::stream_line_reader line_reader(strm, buf, sizeof(buf));
  8503. while (line_reader.getline()) {
  8504. if (resp) { *resp += line_reader.ptr(); }
  8505. }
  8506. return true;
  8507. });
  8508. detail::close_socket(client_sock);
  8509. return ret;
  8510. }
  8511. // Sends a raw request to a server listening at HOST:PORT.
  8512. static bool send_request(time_t read_timeout_sec, const std::string &req,
  8513. std::string *resp = nullptr, int port = PORT) {
  8514. return send_request_in_parts(read_timeout_sec, {req}, resp, port);
  8515. }
  8516. TEST(ServerRequestParsingTest, TrimWhitespaceFromHeaderValues) {
  8517. Server svr;
  8518. std::string header_value;
  8519. svr.Get("/validate-ws-in-headers", [&](const Request &req, Response &res) {
  8520. header_value = req.get_header_value("foo");
  8521. res.set_content("ok", "text/plain");
  8522. });
  8523. thread t = thread([&] { svr.listen(HOST, PORT); });
  8524. auto se = detail::scope_exit([&] {
  8525. svr.stop();
  8526. t.join();
  8527. ASSERT_FALSE(svr.is_running());
  8528. });
  8529. svr.wait_until_ready();
  8530. // Only space and horizontal tab are whitespace. Make sure other whitespace-
  8531. // like characters are not treated the same - use vertical tab and escape.
  8532. const std::string req = "GET /validate-ws-in-headers HTTP/1.1\r\n"
  8533. "foo: \t \v bar \x1B\t \r\n"
  8534. "Connection: close\r\n"
  8535. "\r\n";
  8536. std::string res;
  8537. ASSERT_TRUE(send_request(5, req, &res));
  8538. EXPECT_EQ(header_value, "");
  8539. EXPECT_EQ("HTTP/1.1 400 Bad Request", res.substr(0, 24));
  8540. }
  8541. TEST(HeadersOrderTest, ReceivedFieldsKeepTheirOrder) {
  8542. Server svr;
  8543. std::string received;
  8544. svr.Get("/order", [&](const Request &req, Response &res) {
  8545. received = entries_to_string(req.headers);
  8546. res.set_content("ok", "text/plain");
  8547. });
  8548. auto port = svr.bind_to_any_port(HOST);
  8549. thread t = thread([&] { svr.listen_after_bind(); });
  8550. auto se = detail::scope_exit([&] {
  8551. svr.stop();
  8552. t.join();
  8553. ASSERT_FALSE(svr.is_running());
  8554. });
  8555. svr.wait_until_ready();
  8556. const std::string req = "GET /order HTTP/1.1\r\n"
  8557. "X-First: 1\r\n"
  8558. "X-Dup: a\r\n"
  8559. "X-Second: 2\r\n"
  8560. "X-Dup: b\r\n"
  8561. "Connection: close\r\n"
  8562. "\r\n";
  8563. std::string res;
  8564. ASSERT_TRUE(send_request(5, req, &res, port));
  8565. EXPECT_EQ("HTTP/1.1 200 OK", res.substr(0, 15));
  8566. EXPECT_EQ("X-First=1 X-Dup=a X-Second=2 X-Dup=b Connection=close ", received);
  8567. }
  8568. TEST(HeadersOrderTest, SentFieldsKeepTheirOrder) {
  8569. Server svr;
  8570. svr.Get("/cookies", [](const Request & /*req*/, Response &res) {
  8571. res.set_header("Set-Cookie", "first=1");
  8572. res.set_header("X-Between", "y");
  8573. res.set_header("Set-Cookie", "second=2");
  8574. res.set_content("ok", "text/plain");
  8575. });
  8576. auto port = svr.bind_to_any_port(HOST);
  8577. thread t = thread([&] { svr.listen_after_bind(); });
  8578. auto se = detail::scope_exit([&] {
  8579. svr.stop();
  8580. t.join();
  8581. ASSERT_FALSE(svr.is_running());
  8582. });
  8583. svr.wait_until_ready();
  8584. Client cli(HOST, port);
  8585. auto res = cli.Get("/cookies");
  8586. ASSERT_TRUE(res);
  8587. EXPECT_EQ(2U, res->get_header_value_count("Set-Cookie"));
  8588. EXPECT_EQ("first=1", res->get_header_value("Set-Cookie", "", 0));
  8589. EXPECT_EQ("second=2", res->get_header_value("Set-Cookie", "", 1));
  8590. }
  8591. TEST(ServerResponseSplittingTest, ChunkedTrailerCRLFInjection) {
  8592. Server svr;
  8593. svr.Get("/injected-trailer", [&](const Request & /*req*/, Response &res) {
  8594. auto i = new int(0);
  8595. res.set_header("Trailer", "X-Safe, X-Reflected");
  8596. res.set_chunked_content_provider(
  8597. "text/plain",
  8598. [i](size_t /*offset*/, DataSink &sink) {
  8599. if (*i == 0) {
  8600. sink.os << "body";
  8601. } else {
  8602. Headers trailer;
  8603. // A valid trailer that must survive.
  8604. trailer.emplace("X-Safe", "safe");
  8605. // Attacker-controlled value carrying CR/LF (response splitting).
  8606. trailer.emplace("X-Reflected",
  8607. "legit\r\nInjected-Header: pwned\r\nX-Evil: also");
  8608. // Attacker-controlled name carrying CR/LF.
  8609. trailer.emplace("X-Bad\r\nSet-Cookie: a=1", "x");
  8610. sink.done_with_trailer(trailer);
  8611. }
  8612. (*i)++;
  8613. return true;
  8614. },
  8615. [i](bool /*success*/) { delete i; });
  8616. });
  8617. thread t = thread([&] { svr.listen(HOST, PORT); });
  8618. auto se = detail::scope_exit([&] {
  8619. svr.stop();
  8620. t.join();
  8621. ASSERT_FALSE(svr.is_running());
  8622. });
  8623. svr.wait_until_ready();
  8624. const std::string req = std::string("GET /injected-trailer HTTP/1.1\r\n") +
  8625. "Host: " + HOST +
  8626. "\r\n"
  8627. "Connection: close\r\n"
  8628. "\r\n";
  8629. std::string res;
  8630. ASSERT_TRUE(send_request(5, req, &res));
  8631. // The injected fields must not appear anywhere in the raw response.
  8632. EXPECT_EQ(std::string::npos, res.find("Injected-Header"));
  8633. EXPECT_EQ(std::string::npos, res.find("X-Evil"));
  8634. EXPECT_EQ(std::string::npos, res.find("Set-Cookie"));
  8635. // Invalid trailers are dropped entirely, matching set_header().
  8636. EXPECT_EQ(std::string::npos, res.find("X-Reflected:"));
  8637. // The valid trailer still passes through.
  8638. EXPECT_NE(std::string::npos, res.find("X-Safe: safe"));
  8639. }
  8640. TEST(ServerResponseSplittingTest, ResponseHeaderCRLFInjection) {
  8641. Server svr;
  8642. svr.Get("/injected-header", [&](const Request & /*req*/, Response &res) {
  8643. // res.headers is a public field an application can populate directly,
  8644. // bypassing set_header()'s validation (e.g. reflecting a request value).
  8645. // A valid header that must survive.
  8646. res.headers.emplace("X-Safe", "safe");
  8647. // Attacker-controlled value carrying CR/LF (response splitting).
  8648. res.headers.emplace("X-Reflected",
  8649. "legit\r\nInjected-Header: pwned\r\nX-Evil: also");
  8650. // Attacker-controlled name carrying CR/LF.
  8651. res.headers.emplace("X-Bad\r\nSet-Cookie: a=1", "x");
  8652. res.set_content("body", "text/plain");
  8653. });
  8654. thread t = thread([&] { svr.listen(HOST, PORT); });
  8655. auto se = detail::scope_exit([&] {
  8656. svr.stop();
  8657. t.join();
  8658. ASSERT_FALSE(svr.is_running());
  8659. });
  8660. svr.wait_until_ready();
  8661. const std::string req = std::string("GET /injected-header HTTP/1.1\r\n") +
  8662. "Host: " + HOST +
  8663. "\r\n"
  8664. "Connection: close\r\n"
  8665. "\r\n";
  8666. std::string res;
  8667. ASSERT_TRUE(send_request(5, req, &res));
  8668. // The injected fields must not appear anywhere in the raw response.
  8669. EXPECT_EQ(std::string::npos, res.find("Injected-Header"));
  8670. EXPECT_EQ(std::string::npos, res.find("X-Evil"));
  8671. EXPECT_EQ(std::string::npos, res.find("Set-Cookie"));
  8672. // Invalid headers are dropped entirely, matching set_header().
  8673. EXPECT_EQ(std::string::npos, res.find("X-Reflected:"));
  8674. // The valid header still passes through.
  8675. EXPECT_NE(std::string::npos, res.find("X-Safe: safe"));
  8676. }
  8677. // Forward declaration: in split builds split.py strips `inline` and moves the
  8678. // definition into httplib.cc, so detail::write_request_line is not visible from
  8679. // the public httplib.h. Re-declaring it here lets the tests link against the
  8680. // symbol in both header-only and split builds.
  8681. namespace httplib {
  8682. namespace detail {
  8683. ssize_t write_request_line(Stream &strm, const std::string &method,
  8684. const std::string &path);
  8685. } // namespace detail
  8686. } // namespace httplib
  8687. TEST(RequestLineInjectionTest, RejectsInvalidCharsInTarget) {
  8688. // A well-formed target is written verbatim.
  8689. {
  8690. detail::BufferStream strm;
  8691. auto n = detail::write_request_line(strm, "GET", "/path?a=b");
  8692. EXPECT_GT(n, 0);
  8693. EXPECT_EQ("GET /path?a=b HTTP/1.1\r\n", strm.get_buffer());
  8694. }
  8695. // A target carrying CR/LF, SP or other control octets must be rejected
  8696. // before anything reaches the wire, otherwise it splits the request line and
  8697. // injects a header or a whole request.
  8698. const std::string evil_targets[] = {
  8699. "/a\r\nInjected: pwned",
  8700. "/a\rInjected",
  8701. "/a\nInjected",
  8702. "/a\r\n\r\nGET /evil HTTP/1.1\r\nHost: victim\r\n\r\n",
  8703. "/a b",
  8704. "/a\tb",
  8705. "/a\x7f",
  8706. };
  8707. for (const auto &evil : evil_targets) {
  8708. detail::BufferStream strm;
  8709. auto n = detail::write_request_line(strm, "GET", evil);
  8710. EXPECT_LT(n, 0);
  8711. EXPECT_TRUE(strm.get_buffer().empty());
  8712. }
  8713. }
  8714. TEST(RequestLineInjectionTest, ClientRejectsCRLFTargetEndToEnd) {
  8715. // End-to-end counterpart to RejectsInvalidCharsInTarget. With path encoding
  8716. // disabled the client transmits the target verbatim, so a CR/LF-bearing
  8717. // target reaches write_request. The client must fail cleanly with
  8718. // Error::Write instead of putting a request-line-less, header-injecting
  8719. // request on the wire.
  8720. Server svr;
  8721. svr.Get("/a", [](const Request &, Response &res) {
  8722. res.set_content("ok", "text/plain");
  8723. });
  8724. auto thread = std::thread([&]() { svr.listen(HOST, PORT); });
  8725. auto se = detail::scope_exit([&] {
  8726. svr.stop();
  8727. thread.join();
  8728. ASSERT_FALSE(svr.is_running());
  8729. });
  8730. svr.wait_until_ready();
  8731. {
  8732. Client cli(HOST, PORT);
  8733. cli.set_path_encode(false);
  8734. // The request is rejected before anything is written, so the connection
  8735. // stays silent and the subsequent response read would otherwise block for
  8736. // the full default read timeout. Shorten it -- the assertion is on the
  8737. // error, not the timeout.
  8738. cli.set_read_timeout(1, 0);
  8739. auto res = cli.Get("/a\r\nInjected: pwned");
  8740. EXPECT_FALSE(res);
  8741. EXPECT_EQ(Error::Write, res.error());
  8742. }
  8743. }
  8744. TEST(RequestLineInjectionTest, RejectsNonTokenMethod) {
  8745. // Methods that are tokens (RFC 9110 Section 9.1) are written verbatim,
  8746. // including extension methods.
  8747. const std::string good_methods[] = {"GET", "PROPFIND", "M-SEARCH"};
  8748. for (const auto &method : good_methods) {
  8749. detail::BufferStream strm;
  8750. auto n = detail::write_request_line(strm, method, "/");
  8751. EXPECT_GT(n, 0);
  8752. EXPECT_EQ(method + " / HTTP/1.1\r\n", strm.get_buffer());
  8753. }
  8754. // A method carrying CR/LF would split the request line and smuggle a whole
  8755. // request ahead of the real one. A space or an empty method corrupts the
  8756. // request line. All must be rejected before anything reaches the wire.
  8757. const std::string evil_methods[] = {
  8758. "GET /smuggled HTTP/1.1\r\nHost: x\r\n\r\nGET",
  8759. "GET\r\nInjected: pwned",
  8760. "GET\r",
  8761. "GET\n",
  8762. "GE T",
  8763. "",
  8764. };
  8765. for (const auto &evil : evil_methods) {
  8766. detail::BufferStream strm;
  8767. auto n = detail::write_request_line(strm, evil, "/");
  8768. EXPECT_LT(n, 0);
  8769. EXPECT_TRUE(strm.get_buffer().empty());
  8770. }
  8771. }
  8772. TEST(RequestLineInjectionTest, ClientRejectsNonTokenMethodEndToEnd) {
  8773. // End-to-end counterpart to RejectsNonTokenMethod: a smuggling method passed
  8774. // through Client::send must fail with Error::Write and no request, neither
  8775. // the smuggled one nor the real one, may reach the server.
  8776. Server svr;
  8777. std::atomic<int> request_count(0);
  8778. svr.set_pre_routing_handler([&](const Request &, Response &res) {
  8779. request_count++;
  8780. res.status = StatusCode::OK_200;
  8781. return Server::HandlerResponse::Handled;
  8782. });
  8783. auto port = svr.bind_to_any_port(HOST);
  8784. auto thread = std::thread([&]() { svr.listen_after_bind(); });
  8785. auto se = detail::scope_exit([&] {
  8786. svr.stop();
  8787. thread.join();
  8788. ASSERT_FALSE(svr.is_running());
  8789. });
  8790. svr.wait_until_ready();
  8791. {
  8792. Client cli(HOST, port);
  8793. const std::string evil_methods[] = {
  8794. "GET /smuggled HTTP/1.1\r\nHost: x\r\n\r\nGET",
  8795. "GE T",
  8796. "",
  8797. };
  8798. for (const auto &evil : evil_methods) {
  8799. Request req;
  8800. req.method = evil;
  8801. req.path = "/";
  8802. auto res = cli.send(req);
  8803. EXPECT_FALSE(res);
  8804. EXPECT_EQ(Error::Write, res.error());
  8805. }
  8806. auto handle =
  8807. cli.open_stream("GET /smuggled HTTP/1.1\r\nHost: x\r\n\r\nGET", "/");
  8808. EXPECT_FALSE(handle.is_valid());
  8809. EXPECT_EQ(Error::Write, handle.error);
  8810. // A valid request on the same client still goes through.
  8811. auto res = cli.Get("/");
  8812. ASSERT_TRUE(res);
  8813. EXPECT_EQ(StatusCode::OK_200, res->status);
  8814. }
  8815. EXPECT_EQ(1, request_count.load());
  8816. }
  8817. // Sends a raw request and verifies that there isn't a crash or exception.
  8818. static void test_raw_request(const std::string &req,
  8819. std::string *out = nullptr) {
  8820. Server svr;
  8821. svr.Get("/hi", [&](const Request & /*req*/, Response &res) {
  8822. res.set_content("ok", "text/plain");
  8823. });
  8824. svr.Put("/put_hi", [&](const Request & /*req*/, Response &res) {
  8825. res.set_content("ok", "text/plain");
  8826. });
  8827. svr.Get("/header_field_value_check",
  8828. [&](const Request & /*req*/, Response &res) {
  8829. res.set_content("ok", "text/plain");
  8830. });
  8831. svr.CustomRoute("PROPFIND", "/dav",
  8832. [&](const Request & /*req*/, Response &res) {
  8833. res.status = StatusCode::MultiStatus_207;
  8834. });
  8835. // Server read timeout must be longer than the client read timeout for the
  8836. // bug to reproduce, probably to force the server to process a request
  8837. // without a trailing blank line.
  8838. const time_t client_read_timeout_sec = 1;
  8839. svr.set_read_timeout(std::chrono::seconds(client_read_timeout_sec + 1));
  8840. bool listen_thread_ok = false;
  8841. thread t = thread([&] { listen_thread_ok = svr.listen(HOST, PORT); });
  8842. auto se = detail::scope_exit([&] {
  8843. svr.stop();
  8844. t.join();
  8845. ASSERT_FALSE(svr.is_running());
  8846. EXPECT_TRUE(listen_thread_ok);
  8847. });
  8848. svr.wait_until_ready();
  8849. ASSERT_TRUE(send_request(client_read_timeout_sec, req, out));
  8850. }
  8851. TEST(ServerRequestParsingTest, ReadHeadersRegexComplexity) {
  8852. // A certain header line causes an exception if the header property is parsed
  8853. // naively with a single regex. This occurs with libc++ but not libstdc++.
  8854. test_raw_request(
  8855. "GET /hi HTTP/1.1\r\n"
  8856. " : "
  8857. " "
  8858. " ");
  8859. }
  8860. TEST(ServerRequestParsingTest, ReadHeadersRegexComplexity2) {
  8861. // A certain header line causes an exception if the header property *name* is
  8862. // parsed with a regular expression starting with "(.+?):" - this is a non-
  8863. // greedy matcher and requires backtracking when there are a lot of ":"
  8864. // characters.
  8865. // This occurs with libc++ but not libstdc++.
  8866. test_raw_request(
  8867. "GET /hi HTTP/1.1\r\n"
  8868. ":-:::::::::::::::::::::::::::-::::::::::::::::::::::::@-&&&&&&&&&&&"
  8869. "--:::::::-:::::::::::::::::::::::::::::-:::::::::::::::::@-&&&&&&&&"
  8870. "&&&--:::::::-:::::::::::::::::::::::::::::-:::::::::::::::::@-:::::"
  8871. "::-:::::::::::::::::@-&&&&&&&&&&&--:::::::-::::::::::::::::::::::::"
  8872. ":::::-:::::::::::::::::@-&&&&&&&&&&&--:::::::-:::::::::::::::::::::"
  8873. "::::::::-:::::::::::::::::@-&&&&&&&--:::::::-::::::::::::::::::::::"
  8874. ":::::::-:::::::::::::::::@-&&&&&&&&&&&--:::::::-:::::::::::::::::::"
  8875. "::::::::::-:::::::::::::::::@-&&&&&::::::::::::-:::::::::::::::::@-"
  8876. "&&&&&&&&&&&--:::::::-:::::::::::::::::::::::::::::-::::::::::::::::"
  8877. ":@-&&&&&&&&&&&--:::::::-:::::::::::::::::::::::::::::-:::::::::::::"
  8878. "::::@-&&&&&&&&&&&--:::::::-:::::::::::::::::::::::::::::-::::::@-&&"
  8879. "&&&&&&&&&--:::::::-:::::::::::::::::::::::::::::-:::::::::::::::::@"
  8880. "::::::-:::::::::::::::::::::::::::::-:::::::::::::::::@-&&&&&&&&&&&"
  8881. "--:::::::-:::::::::::::::::::::::::::::-:::::::::::::::::@-&&&&&&&&"
  8882. "&&&--:::::::-:::::::::::::::::::::::::::::-:::::::::::::::::@-&&&&&"
  8883. "&&&&&&--:::::::-:::::::::::::::::::::::::::::-:::::::::::::::::@-&&"
  8884. "&&&&&&&&&--:::::::-:::::::::::::::::::::::::::::-:::::::::::::::::@"
  8885. "-&&&&&&&&&&&--:::::::-:::::::::::::::::::::::::::::-:::::::::::::::"
  8886. "::@-&&&&&&&&&&&--:::::::-:::::::::::::::::::::::::::::-::::::::::::"
  8887. ":::::@-&&&&&&&&&&&::-:::::::::::::::::@-&&&&&&&&&&&--:::::::-::::::"
  8888. ":::::::::::::::::::::::-:::::::::::::::::@-&&&&&&&&&&&--:::::::-:::"
  8889. "::::::::::::::::::::::::::-:::::::::::::::::@-&&&&&&&&&&&--:::::::-"
  8890. ":::::::::::::::::::::::::::::-:::::::::::::::::@-&&&&&&&&&&&---&&:&"
  8891. "&&.0------------:-:::::::::::::::::::::::::::::-:::::::::::::::::@-"
  8892. "&&&&&&&&&&&--:::::::-:::::::::::::::::::::::::::::-::::::::::::::::"
  8893. ":@-&&&&&&&&&&&--:::::::-:::::::::::::::::::::::::::::-:::::::::::::"
  8894. "::::@-&&&&&&&&&&&---&&:&&&.0------------O--------\rH PUTHTTP/1.1\r\n"
  8895. "&&&%%%");
  8896. }
  8897. TEST(ServerRequestParsingTest, ExcessiveWhitespaceInUnparsableHeaderLine) {
  8898. // Make sure this doesn't crash the server.
  8899. // In a previous version of the header line regex, the "\r" rendered the line
  8900. // unparsable and the regex engine repeatedly backtracked, trying to look for
  8901. // a new position where the leading white space ended and the field value
  8902. // began.
  8903. // The crash occurs with libc++ but not libstdc++.
  8904. test_raw_request("GET /hi HTTP/1.1\r\n"
  8905. "a:" +
  8906. std::string(2000, ' ') + '\r' + std::string(20, 'z') +
  8907. "\r\n"
  8908. "\r\n");
  8909. }
  8910. TEST(ServerRequestParsingTest, InvalidFirstChunkLengthInRequest) {
  8911. std::string out;
  8912. test_raw_request("PUT /put_hi HTTP/1.1\r\n"
  8913. "Content-Type: text/plain\r\n"
  8914. "Transfer-Encoding: chunked\r\n"
  8915. "\r\n"
  8916. "nothex\r\n",
  8917. &out);
  8918. EXPECT_EQ("HTTP/1.1 400 Bad Request", out.substr(0, 24));
  8919. }
  8920. TEST(ServerRequestParsingTest, InvalidSecondChunkLengthInRequest) {
  8921. std::string out;
  8922. test_raw_request("PUT /put_hi HTTP/1.1\r\n"
  8923. "Content-Type: text/plain\r\n"
  8924. "Transfer-Encoding: chunked\r\n"
  8925. "\r\n"
  8926. "3\r\n"
  8927. "xyz\r\n"
  8928. "NaN\r\n",
  8929. &out);
  8930. EXPECT_EQ("HTTP/1.1 400 Bad Request", out.substr(0, 24));
  8931. }
  8932. TEST(ServerRequestParsingTest, ChunkLengthTooHighInRequest) {
  8933. std::string out;
  8934. test_raw_request("PUT /put_hi HTTP/1.1\r\n"
  8935. "Content-Type: text/plain\r\n"
  8936. "Transfer-Encoding: chunked\r\n"
  8937. "\r\n"
  8938. // Length is too large for 64 bits.
  8939. "1ffffffffffffffff\r\n"
  8940. "xyz\r\n",
  8941. &out);
  8942. EXPECT_EQ("HTTP/1.1 400 Bad Request", out.substr(0, 24));
  8943. }
  8944. TEST(ServerRequestParsingTest, InvalidHeaderTextWithExtraCR) {
  8945. test_raw_request("GET /hi HTTP/1.1\r\n"
  8946. "Content-Type: text/plain\r\n\r");
  8947. }
  8948. TEST(ServerRequestParsingTest, InvalidSpaceInURL) {
  8949. std::string out;
  8950. test_raw_request("GET /h i HTTP/1.1\r\n\r\n", &out);
  8951. EXPECT_EQ("HTTP/1.1 400 Bad Request", out.substr(0, 24));
  8952. }
  8953. TEST(ServerRequestParsingTest, InvalidControlCharInURL) {
  8954. for (auto target : {"/h\ri", "/h\x7fi"}) {
  8955. std::string out;
  8956. test_raw_request(std::string("GET ") + target + " HTTP/1.1\r\n\r\n", &out);
  8957. EXPECT_EQ("HTTP/1.1 400 Bad Request", out.substr(0, 24)) << target;
  8958. }
  8959. }
  8960. TEST(ServerRequestParsingTest, NonAsciiInURLAccepted) {
  8961. std::string out;
  8962. test_raw_request("GET /hi?q=\xE3\x81\x82 HTTP/1.1\r\n"
  8963. "Connection: close\r\n\r\n",
  8964. &out);
  8965. EXPECT_EQ("HTTP/1.1 200 OK", out.substr(0, 15));
  8966. }
  8967. TEST(ServerRequestParsingTest, RemoteAddrSetOnBadRequest) {
  8968. Server svr;
  8969. svr.set_error_handler([&](const Request &req, Response & /*res*/) {
  8970. EXPECT_TRUE(!req.remote_addr.empty());
  8971. });
  8972. thread t = thread([&] { svr.listen(HOST, PORT); });
  8973. auto se = detail::scope_exit([&] {
  8974. svr.stop();
  8975. t.join();
  8976. ASSERT_FALSE(svr.is_running());
  8977. });
  8978. svr.wait_until_ready();
  8979. // Send an invalid request line to trigger Bad Request
  8980. const std::string bad_req = "BADMETHOD / HTTP/1.1\r\nHost: localhost\r\n\r\n";
  8981. std::string out;
  8982. ASSERT_TRUE(send_request(5, bad_req, &out));
  8983. EXPECT_EQ("HTTP/1.1 400 Bad Request", out.substr(0, 24));
  8984. }
  8985. // A custom method with neither Content-Length nor Transfer-Encoding must be
  8986. // answered right away rather than blocking on a read that waits for EOF.
  8987. TEST(ServerRequestParsingTest, CustomMethodWithoutFraming) {
  8988. std::string out;
  8989. test_raw_request("PROPFIND /dav HTTP/1.1\r\nHost: localhost\r\n\r\n", &out);
  8990. EXPECT_EQ("HTTP/1.1 207 Multi-Status", out.substr(0, 25));
  8991. }
  8992. TEST(CustomRouteRegistrationTest, RejectsBuiltInMethods) {
  8993. const char *methods[] = {"GET", "HEAD", "POST", "PUT", "DELETE",
  8994. "CONNECT", "OPTIONS", "TRACE", "PATCH", "PRI"};
  8995. for (const auto *method : methods) {
  8996. Server svr;
  8997. svr.CustomRoute(method, "/x", [](const Request &, Response &) {});
  8998. EXPECT_FALSE(svr.is_valid()) << method;
  8999. EXPECT_FALSE(svr.listen(HOST, PORT)) << method;
  9000. }
  9001. }
  9002. TEST(CustomRouteRegistrationTest, RejectsNonTokenMethods) {
  9003. const char *methods[] = {"", "PRO PFIND", "PROP\tFIND", "PROP/FIND",
  9004. "PROP,FIND", "PROP:FIND", "PROP(FIND)", "\x01FIND"};
  9005. for (const auto *method : methods) {
  9006. Server svr;
  9007. svr.CustomRoute(method, "/x", [](const Request &, Response &) {});
  9008. EXPECT_FALSE(svr.is_valid()) << method;
  9009. }
  9010. }
  9011. TEST(CustomRouteRegistrationTest, AcceptsWebDavAndUpnpMethods) {
  9012. const char *methods[] = {"PROPFIND", "PROPPATCH", "MKCOL",
  9013. "COPY", "MOVE", "LOCK",
  9014. "UNLOCK", "REPORT", "SUBSCRIBE"};
  9015. Server svr;
  9016. for (const auto *method : methods) {
  9017. svr.CustomRoute(method, "/x", [](const Request &, Response &) {});
  9018. }
  9019. EXPECT_TRUE(svr.is_valid());
  9020. }
  9021. TEST(CustomRouteRegistrationTest, ContentReaderOverloadRejectsBuiltInMethods) {
  9022. Server svr;
  9023. svr.CustomRoute("POST", "/x",
  9024. [](const Request &, Response &, const ContentReader &) {});
  9025. EXPECT_FALSE(svr.is_valid());
  9026. }
  9027. TEST(CustomRouteRegistrationTest, RejectionIsSticky) {
  9028. Server svr;
  9029. svr.CustomRoute("PROPFIND", "/a", [](const Request &, Response &) {});
  9030. svr.CustomRoute("GET", "/b", [](const Request &, Response &) {});
  9031. svr.CustomRoute("MKCOL", "/c", [](const Request &, Response &) {});
  9032. EXPECT_FALSE(svr.is_valid());
  9033. }
  9034. TEST(CustomRouteRegistrationTest, ReportsRejectionToErrorLogger) {
  9035. Server svr;
  9036. auto captured = Error::Success;
  9037. svr.set_error_logger(
  9038. [&](const Error &err, const Request * /*req*/) { captured = err; });
  9039. svr.CustomRoute("POST", "/x", [](const Request &, Response &) {});
  9040. EXPECT_EQ(Error::InvalidHTTPMethod, captured);
  9041. }
  9042. TEST(ServerRequestParsingTest, InvalidFieldValueContains_CR_LF_NUL) {
  9043. std::string out;
  9044. std::string request(
  9045. "GET /header_field_value_check HTTP/1.1\r\nTest: [\r\x00\n]\r\n\r\n", 55);
  9046. test_raw_request(request, &out);
  9047. EXPECT_EQ("HTTP/1.1 400 Bad Request", out.substr(0, 24));
  9048. }
  9049. TEST(ServerRequestParsingTest, InvalidFieldValueContains_LF) {
  9050. std::string out;
  9051. std::string request(
  9052. "GET /header_field_value_check HTTP/1.1\r\nTest: [\n\n\n]\r\n\r\n", 55);
  9053. test_raw_request(request, &out);
  9054. EXPECT_EQ("HTTP/1.1 400 Bad Request", out.substr(0, 24));
  9055. }
  9056. TEST(ServerRequestParsingTest, InvalidFieldNameContains_PreceedingSpaces) {
  9057. std::string out;
  9058. std::string request(
  9059. "GET /header_field_value_check HTTP/1.1\r\n Test: val\r\n\r\n", 55);
  9060. test_raw_request(request, &out);
  9061. EXPECT_EQ("HTTP/1.1 400 Bad Request", out.substr(0, 24));
  9062. }
  9063. TEST(ServerRequestParsingTest, EmptyFieldValue) {
  9064. std::string out;
  9065. test_raw_request("GET /header_field_value_check HTTP/1.1\r\n"
  9066. "Test: \r\n\r\n",
  9067. &out);
  9068. EXPECT_EQ("HTTP/1.1 200 OK", out.substr(0, 15));
  9069. }
  9070. TEST(ServerRequestParsingTest, HeaderValueNotPercentDecoded) {
  9071. Server svr;
  9072. std::string x_custom;
  9073. std::string cookie;
  9074. std::string xff;
  9075. std::string x_unicode;
  9076. std::string x_iis;
  9077. svr.Get("/check", [&](const Request &req, Response &res) {
  9078. x_custom = req.get_header_value("X-Custom");
  9079. cookie = req.get_header_value("Cookie");
  9080. xff = req.get_header_value("X-Forwarded-For");
  9081. x_unicode = req.get_header_value("X-Unicode");
  9082. x_iis = req.get_header_value("X-IIS");
  9083. res.set_content("ok", "text/plain");
  9084. });
  9085. thread t = thread([&] { svr.listen(HOST, PORT); });
  9086. auto se = detail::scope_exit([&] {
  9087. svr.stop();
  9088. t.join();
  9089. ASSERT_FALSE(svr.is_running());
  9090. });
  9091. svr.wait_until_ready();
  9092. const std::string req = "GET /check HTTP/1.1\r\n"
  9093. "Host: localhost\r\n"
  9094. "X-Custom: a%0D%0AInjected: b\r\n"
  9095. "Cookie: session%3Dvictim%3B%20admin%3Dyes\r\n"
  9096. "X-Forwarded-For: 1.2.3.4%2C5.6.7.8\r\n"
  9097. "X-Unicode: %E3%81%82\r\n"
  9098. "X-IIS: %u00E9\r\n"
  9099. "Connection: close\r\n"
  9100. "\r\n";
  9101. std::string res;
  9102. ASSERT_TRUE(send_request(5, req, &res));
  9103. EXPECT_EQ("HTTP/1.1 200 OK", res.substr(0, 15));
  9104. // Every value must be returned verbatim (wire form), with no decoding.
  9105. EXPECT_EQ("a%0D%0AInjected: b", x_custom);
  9106. EXPECT_EQ("session%3Dvictim%3B%20admin%3Dyes", cookie);
  9107. EXPECT_EQ("1.2.3.4%2C5.6.7.8", xff);
  9108. EXPECT_EQ("%E3%81%82", x_unicode);
  9109. EXPECT_EQ("%u00E9", x_iis);
  9110. }
  9111. // Applications that previously relied on automatic percent-decoding can
  9112. // reproduce the old behavior by explicitly calling decode_path_component()
  9113. // or, for RFC 3986 conformance, decode_uri_component().
  9114. TEST(ServerRequestParsingTest, HeaderValueExplicitDecodingByApplication) {
  9115. Server svr;
  9116. std::string decoded;
  9117. svr.Get("/check", [&](const Request &req, Response &res) {
  9118. decoded = decode_uri_component(req.get_header_value("X-Custom"));
  9119. res.set_content("ok", "text/plain");
  9120. });
  9121. thread t = thread([&] { svr.listen(HOST, PORT); });
  9122. auto se = detail::scope_exit([&] {
  9123. svr.stop();
  9124. t.join();
  9125. ASSERT_FALSE(svr.is_running());
  9126. });
  9127. svr.wait_until_ready();
  9128. const std::string req = "GET /check HTTP/1.1\r\n"
  9129. "Host: localhost\r\n"
  9130. "X-Custom: hello%20world\r\n"
  9131. "Connection: close\r\n"
  9132. "\r\n";
  9133. std::string res;
  9134. ASSERT_TRUE(send_request(5, req, &res));
  9135. EXPECT_EQ("HTTP/1.1 200 OK", res.substr(0, 15));
  9136. EXPECT_EQ("hello world", decoded);
  9137. }
  9138. // Regression test for #2033. Browsers send Referer values that include
  9139. // percent-encoded characters such as %0A inside the URL. Decoding the
  9140. // header value would either trip the post-decode CR/LF/NUL guard (the
  9141. // original bug, returning 400) or, after that guard was relaxed, silently
  9142. // store a literal LF — both unacceptable. The wire form must round-trip.
  9143. TEST(ServerRequestParsingTest, RefererWithPercentEncodedNewline) {
  9144. Server svr;
  9145. std::string referer;
  9146. svr.Get("/check", [&](const Request &req, Response &res) {
  9147. referer = req.get_header_value("Referer");
  9148. res.set_content("ok", "text/plain");
  9149. });
  9150. thread t = thread([&] { svr.listen(HOST, PORT); });
  9151. auto se = detail::scope_exit([&] {
  9152. svr.stop();
  9153. t.join();
  9154. ASSERT_FALSE(svr.is_running());
  9155. });
  9156. svr.wait_until_ready();
  9157. const std::string req = "GET /check HTTP/1.1\r\n"
  9158. "Host: localhost\r\n"
  9159. "Referer: http://localhost:1111/?q=Hello%0A\r\n"
  9160. "Connection: close\r\n"
  9161. "\r\n";
  9162. std::string res;
  9163. ASSERT_TRUE(send_request(5, req, &res));
  9164. EXPECT_EQ("HTTP/1.1 200 OK", res.substr(0, 15));
  9165. EXPECT_EQ("http://localhost:1111/?q=Hello%0A", referer);
  9166. }
  9167. TEST(ServerStopTest, StopServerWithChunkedTransmission) {
  9168. Server svr;
  9169. svr.Get("/events", [](const Request & /*req*/, Response &res) {
  9170. res.set_header("Cache-Control", "no-cache");
  9171. res.set_chunked_content_provider(
  9172. "text/event-stream", [](size_t offset, DataSink &sink) {
  9173. std::string s = "data:";
  9174. s += std::to_string(offset);
  9175. s += "\n\n";
  9176. auto ret = sink.write(s.data(), s.size());
  9177. EXPECT_TRUE(ret);
  9178. std::this_thread::sleep_for(std::chrono::seconds(1));
  9179. return true;
  9180. });
  9181. });
  9182. auto listen_thread = std::thread([&svr]() { svr.listen("localhost", PORT); });
  9183. svr.wait_until_ready();
  9184. Client client(HOST, PORT);
  9185. const Headers headers = {{"Accept", "text/event-stream"}};
  9186. auto get_thread = std::thread([&client, &headers]() {
  9187. auto res = client.Get(
  9188. "/events", headers,
  9189. [](const char * /*data*/, size_t /*len*/) -> bool { return true; });
  9190. });
  9191. auto se = detail::scope_exit([&] {
  9192. svr.stop();
  9193. get_thread.join();
  9194. listen_thread.join();
  9195. ASSERT_FALSE(svr.is_running());
  9196. });
  9197. // Give GET time to get a few messages.
  9198. std::this_thread::sleep_for(std::chrono::seconds(2));
  9199. }
  9200. TEST(ServerStopTest, ClientAccessAfterServerDown) {
  9201. httplib::Server svr;
  9202. svr.Post("/hi",
  9203. [&](const httplib::Request & /*req*/, httplib::Response &res) {
  9204. res.status = StatusCode::OK_200;
  9205. });
  9206. auto thread = std::thread([&]() { svr.listen(HOST, PORT); });
  9207. svr.wait_until_ready();
  9208. Client cli(HOST, PORT);
  9209. auto res = cli.Post("/hi", "data", "text/plain");
  9210. ASSERT_TRUE(res) << "Error: " << to_string(res.error());
  9211. EXPECT_EQ(StatusCode::OK_200, res->status);
  9212. svr.stop();
  9213. thread.join();
  9214. ASSERT_FALSE(svr.is_running());
  9215. res = cli.Post("/hi", "data", "text/plain");
  9216. ASSERT_FALSE(res);
  9217. }
  9218. TEST(ServerStopTest, ListenFailure) {
  9219. Server svr;
  9220. auto t = thread([&]() {
  9221. auto ret = svr.listen("????", PORT);
  9222. EXPECT_FALSE(ret);
  9223. });
  9224. svr.wait_until_ready();
  9225. svr.stop();
  9226. t.join();
  9227. }
  9228. #ifndef CPPHTTPLIB_NO_EXCEPTIONS
  9229. TEST(ServerStopTest, Decommision) {
  9230. Server svr;
  9231. svr.Get("/hi", [&](const Request &, Response &res) { res.body = "hi..."; });
  9232. for (int i = 0; i < 4; i++) {
  9233. auto is_even = !(i % 2);
  9234. std::thread t{[&] {
  9235. try {
  9236. std::this_thread::sleep_for(std::chrono::milliseconds(100));
  9237. if (is_even) {
  9238. throw std::runtime_error("Some thing that happens to go wrong.");
  9239. }
  9240. svr.listen(HOST, PORT);
  9241. } catch (...) { svr.decommission(); }
  9242. }};
  9243. svr.wait_until_ready();
  9244. // Server is up
  9245. {
  9246. Client cli(HOST, PORT);
  9247. auto res = cli.Get("/hi");
  9248. if (is_even) {
  9249. EXPECT_FALSE(res);
  9250. } else {
  9251. EXPECT_TRUE(res);
  9252. EXPECT_EQ("hi...", res->body);
  9253. }
  9254. }
  9255. svr.stop();
  9256. t.join();
  9257. // Server is down...
  9258. {
  9259. Client cli(HOST, PORT);
  9260. auto res = cli.Get("/hi");
  9261. EXPECT_FALSE(res);
  9262. }
  9263. }
  9264. }
  9265. #endif
  9266. // Helper function for string body upload progress tests
  9267. template <typename SetupHandler, typename ClientCall>
  9268. void TestStringBodyUploadProgress(SetupHandler &&setup_handler,
  9269. ClientCall &&client_call,
  9270. const string &body) {
  9271. Server svr;
  9272. setup_handler(svr);
  9273. thread t = thread([&]() { svr.listen(HOST, PORT); });
  9274. auto se = detail::scope_exit([&] {
  9275. svr.stop();
  9276. t.join();
  9277. });
  9278. svr.wait_until_ready();
  9279. Client cli(HOST, PORT);
  9280. vector<uint64_t> progress_values;
  9281. bool progress_called = false;
  9282. auto res =
  9283. client_call(cli, body, [&](uint64_t current, uint64_t /*total*/) -> bool {
  9284. progress_values.push_back(current);
  9285. progress_called = true;
  9286. return true;
  9287. });
  9288. ASSERT_TRUE(res) << "Error: " << to_string(res.error());
  9289. EXPECT_EQ(200, res->status);
  9290. EXPECT_TRUE(progress_called);
  9291. }
  9292. TEST(UploadProgressTest, PostStringBodyBasic) {
  9293. TestStringBodyUploadProgress(
  9294. [](Server &svr) {
  9295. svr.Post("/test", [](const Request & /*req*/, Response &res) {
  9296. res.set_content("received", "text/plain");
  9297. });
  9298. },
  9299. [](Client &cli, const string &body, UploadProgress progress_callback) {
  9300. return cli.Post("/test", body, "text/plain", progress_callback);
  9301. },
  9302. "test data for upload progress");
  9303. }
  9304. TEST(UploadProgressTest, PutStringBodyBasic) {
  9305. TestStringBodyUploadProgress(
  9306. [](Server &svr) {
  9307. svr.Put("/test", [](const Request & /*req*/, Response &res) {
  9308. res.set_content("put received", "text/plain");
  9309. });
  9310. },
  9311. [](Client &cli, const string &body, UploadProgress progress_callback) {
  9312. return cli.Put("/test", body, "text/plain", progress_callback);
  9313. },
  9314. "put test data for upload progress");
  9315. }
  9316. TEST(UploadProgressTest, PatchStringBodyBasic) {
  9317. TestStringBodyUploadProgress(
  9318. [](Server &svr) {
  9319. svr.Patch("/test", [](const Request & /*req*/, Response &res) {
  9320. res.set_content("patch received", "text/plain");
  9321. });
  9322. },
  9323. [](Client &cli, const string &body, UploadProgress progress_callback) {
  9324. return cli.Patch("/test", body, "text/plain", progress_callback);
  9325. },
  9326. "patch test data for upload progress");
  9327. }
  9328. // Helper function for content provider upload progress tests
  9329. template <typename SetupHandler, typename ClientCall>
  9330. void TestContentProviderUploadProgress(SetupHandler &&setup_handler,
  9331. ClientCall &&client_call) {
  9332. Server svr;
  9333. setup_handler(svr);
  9334. thread t = thread([&]() { svr.listen(HOST, PORT); });
  9335. auto se = detail::scope_exit([&] {
  9336. svr.stop();
  9337. t.join();
  9338. });
  9339. svr.wait_until_ready();
  9340. Client cli(HOST, PORT);
  9341. vector<uint64_t> progress_values;
  9342. auto res =
  9343. client_call(cli, [&](uint64_t current, uint64_t /*total*/) -> bool {
  9344. progress_values.push_back(current);
  9345. return true;
  9346. });
  9347. ASSERT_TRUE(res) << "Error: " << to_string(res.error());
  9348. EXPECT_EQ(200, res->status);
  9349. EXPECT_FALSE(progress_values.empty());
  9350. }
  9351. TEST(UploadProgressTest, PostContentProviderProgress) {
  9352. TestContentProviderUploadProgress(
  9353. [](Server &svr) {
  9354. svr.Post("/test", [](const Request & /*req*/, Response &res) {
  9355. res.set_content("provider received", "text/plain");
  9356. });
  9357. },
  9358. [](Client &cli, UploadProgress progress_callback) {
  9359. return cli.Post(
  9360. "/test", 10,
  9361. [](size_t /*offset*/, size_t /*length*/, DataSink &sink) -> bool {
  9362. sink.os << "test data";
  9363. return true;
  9364. },
  9365. "text/plain", progress_callback);
  9366. });
  9367. }
  9368. // Helper function for multipart upload progress tests
  9369. template <typename SetupHandler, typename ClientCall>
  9370. void TestMultipartUploadProgress(SetupHandler &&setup_handler,
  9371. ClientCall &&client_call,
  9372. const string &endpoint) {
  9373. Server svr;
  9374. setup_handler(svr);
  9375. thread t = thread([&]() { svr.listen(HOST, PORT); });
  9376. auto se = detail::scope_exit([&] {
  9377. svr.stop();
  9378. t.join();
  9379. });
  9380. svr.wait_until_ready();
  9381. Client cli(HOST, PORT);
  9382. vector<uint64_t> progress_values;
  9383. UploadFormDataItems items = {
  9384. {"field1", "value1", "", ""},
  9385. {"field2", "longer value for progress tracking test", "", ""},
  9386. {"file1", "file content data for upload progress", "test.txt",
  9387. "text/plain"}};
  9388. auto res = client_call(cli, endpoint, items,
  9389. [&](uint64_t current, uint64_t /*total*/) -> bool {
  9390. progress_values.push_back(current);
  9391. return true;
  9392. });
  9393. ASSERT_TRUE(res) << "Error: " << to_string(res.error());
  9394. EXPECT_EQ(200, res->status);
  9395. EXPECT_FALSE(progress_values.empty());
  9396. }
  9397. TEST(UploadProgressTest, PostMultipartProgress) {
  9398. TestMultipartUploadProgress(
  9399. [](Server &svr) {
  9400. svr.Post("/multipart", [](const Request &req, Response &res) {
  9401. EXPECT_TRUE(!req.form.files.empty() || !req.form.fields.empty());
  9402. res.set_content("multipart received", "text/plain");
  9403. });
  9404. },
  9405. [](Client &cli, const string &endpoint, const UploadFormDataItems &items,
  9406. UploadProgress progress_callback) {
  9407. return cli.Post(endpoint, items, progress_callback);
  9408. },
  9409. "/multipart");
  9410. }
  9411. // Helper function for basic download progress tests
  9412. template <typename SetupHandler, typename ClientCall>
  9413. void TestBasicDownloadProgress(SetupHandler &&setup_handler,
  9414. ClientCall &&client_call, const string &endpoint,
  9415. size_t expected_content_size) {
  9416. Server svr;
  9417. setup_handler(svr);
  9418. thread t = thread([&]() { svr.listen(HOST, PORT); });
  9419. auto se = detail::scope_exit([&] {
  9420. svr.stop();
  9421. t.join();
  9422. });
  9423. svr.wait_until_ready();
  9424. Client cli(HOST, PORT);
  9425. vector<uint64_t> progress_values;
  9426. auto res = client_call(cli, endpoint,
  9427. [&](uint64_t current, uint64_t /*total*/) -> bool {
  9428. progress_values.push_back(current);
  9429. return true;
  9430. });
  9431. ASSERT_TRUE(res) << "Error: " << to_string(res.error());
  9432. EXPECT_EQ(200, res->status);
  9433. EXPECT_FALSE(progress_values.empty());
  9434. EXPECT_EQ(expected_content_size, res->body.size());
  9435. }
  9436. TEST(DownloadProgressTest, GetBasic) {
  9437. TestBasicDownloadProgress(
  9438. [](Server &svr) {
  9439. svr.Get("/download", [](const Request & /*req*/, Response &res) {
  9440. string content(1000, 'D');
  9441. res.set_content(content, "text/plain");
  9442. });
  9443. },
  9444. [](Client &cli, const string &endpoint,
  9445. DownloadProgress progress_callback) {
  9446. return cli.Get(endpoint, progress_callback);
  9447. },
  9448. "/download", 1000u);
  9449. }
  9450. // Helper function for content receiver download progress tests
  9451. template <typename SetupHandler, typename ClientCall>
  9452. void TestContentReceiverDownloadProgress(SetupHandler &&setup_handler,
  9453. ClientCall &&client_call,
  9454. const string &endpoint,
  9455. size_t expected_content_size) {
  9456. Server svr;
  9457. setup_handler(svr);
  9458. thread t = thread([&]() { svr.listen(HOST, PORT); });
  9459. auto se = detail::scope_exit([&] {
  9460. svr.stop();
  9461. t.join();
  9462. });
  9463. svr.wait_until_ready();
  9464. Client cli(HOST, PORT);
  9465. vector<uint64_t> progress_values;
  9466. string received_body;
  9467. auto res = client_call(
  9468. cli, endpoint,
  9469. [&](const char *data, size_t data_length) -> bool {
  9470. received_body.append(data, data_length);
  9471. return true;
  9472. },
  9473. [&](uint64_t current, uint64_t /*total*/) -> bool {
  9474. progress_values.push_back(current);
  9475. return true;
  9476. });
  9477. ASSERT_TRUE(res) << "Error: " << to_string(res.error());
  9478. EXPECT_EQ(200, res->status);
  9479. EXPECT_FALSE(progress_values.empty());
  9480. EXPECT_EQ(expected_content_size, received_body.size());
  9481. EXPECT_TRUE(res->body.empty());
  9482. }
  9483. TEST(DownloadProgressTest, GetWithContentReceiver) {
  9484. TestContentReceiverDownloadProgress(
  9485. [](Server &svr) {
  9486. svr.Get("/download-receiver",
  9487. [](const Request & /*req*/, Response &res) {
  9488. string content(2000, 'R');
  9489. res.set_content(content, "text/plain");
  9490. });
  9491. },
  9492. [](Client &cli, const string &endpoint, ContentReceiver content_receiver,
  9493. DownloadProgress progress_callback) {
  9494. return cli.Get(endpoint, content_receiver, progress_callback);
  9495. },
  9496. "/download-receiver", 2000u);
  9497. }
  9498. TEST(StreamingTest, ChunkedZeroLengthWriteDoesNotEndTheBody) {
  9499. // A provider reaching a pass with nothing to hand over - an empty buffer
  9500. // popped off a queue, say - must not be taken to mean the body is finished.
  9501. // It used to end the loop with the terminating chunk unwritten while the
  9502. // server still considered the response complete, so the peer waited for an
  9503. // end that never arrived.
  9504. Server svr;
  9505. svr.Get("/stream", [](const Request & /*req*/, Response &res) {
  9506. auto step = std::make_shared<int>(0);
  9507. res.set_chunked_content_provider("text/plain",
  9508. [step](size_t /*offset*/, DataSink &sink) {
  9509. switch ((*step)++) {
  9510. case 0: sink.write("", 0); break;
  9511. case 1: sink.write("hello", 5); break;
  9512. default: sink.done(); break;
  9513. }
  9514. return true;
  9515. });
  9516. });
  9517. auto port = svr.bind_to_any_port(HOST);
  9518. auto listen_thread = std::thread([&svr]() { svr.listen_after_bind(); });
  9519. auto listen_se = detail::scope_exit([&] {
  9520. svr.stop();
  9521. listen_thread.join();
  9522. ASSERT_FALSE(svr.is_running());
  9523. });
  9524. svr.wait_until_ready();
  9525. Client cli(HOST, port);
  9526. // Without the fix the body is never terminated, so bound the wait rather
  9527. // than letting the test hang on the default read timeout.
  9528. cli.set_read_timeout(5, 0);
  9529. auto res = cli.Get("/stream");
  9530. ASSERT_TRUE(res) << "Error: " << to_string(res.error());
  9531. EXPECT_EQ(StatusCode::OK_200, res->status);
  9532. EXPECT_EQ("hello", res->body);
  9533. }
  9534. TEST(StreamingTest, NoContentLengthStreaming) {
  9535. Server svr;
  9536. svr.Get("/stream", [](const Request & /*req*/, Response &res) {
  9537. res.set_content_provider("text/plain", [](size_t offset, DataSink &sink) {
  9538. if (offset < 6) {
  9539. sink.os << (offset < 3 ? "a" : "b");
  9540. } else {
  9541. sink.done();
  9542. }
  9543. return true;
  9544. });
  9545. });
  9546. auto listen_thread = std::thread([&svr]() { svr.listen("localhost", PORT); });
  9547. auto listen_se = detail::scope_exit([&] {
  9548. svr.stop();
  9549. listen_thread.join();
  9550. ASSERT_FALSE(svr.is_running());
  9551. });
  9552. svr.wait_until_ready();
  9553. Client client(HOST, PORT);
  9554. auto get_thread = std::thread([&client]() {
  9555. std::string s;
  9556. auto res =
  9557. client.Get("/stream", [&s](const char *data, size_t len) -> bool {
  9558. s += std::string(data, len);
  9559. return true;
  9560. });
  9561. ASSERT_TRUE(res) << "Error: " << to_string(res.error());
  9562. EXPECT_EQ(StatusCode::OK_200, res->status);
  9563. EXPECT_EQ("aaabbb", s);
  9564. });
  9565. auto get_se = detail::scope_exit([&] { get_thread.join(); });
  9566. // Give GET time to get a few messages.
  9567. std::this_thread::sleep_for(std::chrono::milliseconds(500));
  9568. }
  9569. TEST(MountTest, Unmount) {
  9570. Server svr;
  9571. auto listen_thread = std::thread([&svr]() { svr.listen("localhost", PORT); });
  9572. auto se = detail::scope_exit([&] {
  9573. svr.stop();
  9574. listen_thread.join();
  9575. ASSERT_FALSE(svr.is_running());
  9576. });
  9577. svr.wait_until_ready();
  9578. Client cli("localhost", PORT);
  9579. svr.set_mount_point("/mount2", "./www2");
  9580. auto res = cli.Get("/");
  9581. ASSERT_TRUE(res) << "Error: " << to_string(res.error());
  9582. EXPECT_EQ(StatusCode::NotFound_404, res->status);
  9583. res = cli.Get("/mount2/dir/test.html");
  9584. ASSERT_TRUE(res) << "Error: " << to_string(res.error());
  9585. EXPECT_EQ(StatusCode::OK_200, res->status);
  9586. svr.set_mount_point("/", "./www");
  9587. res = cli.Get("/dir/");
  9588. ASSERT_TRUE(res) << "Error: " << to_string(res.error());
  9589. EXPECT_EQ(StatusCode::OK_200, res->status);
  9590. svr.remove_mount_point("/");
  9591. res = cli.Get("/dir/");
  9592. ASSERT_TRUE(res) << "Error: " << to_string(res.error());
  9593. EXPECT_EQ(StatusCode::NotFound_404, res->status);
  9594. svr.remove_mount_point("/mount2");
  9595. res = cli.Get("/mount2/dir/test.html");
  9596. ASSERT_TRUE(res) << "Error: " << to_string(res.error());
  9597. EXPECT_EQ(StatusCode::NotFound_404, res->status);
  9598. }
  9599. TEST(MountTest, PathSegmentBoundary) {
  9600. Server svr;
  9601. svr.set_mount_point("/mount2", "./www2");
  9602. svr.set_mount_point("/", "./www");
  9603. auto port = svr.bind_to_any_port(HOST);
  9604. auto listen_thread = std::thread([&svr]() { svr.listen_after_bind(); });
  9605. auto se = detail::scope_exit([&] {
  9606. svr.stop();
  9607. listen_thread.join();
  9608. ASSERT_FALSE(svr.is_running());
  9609. });
  9610. svr.wait_until_ready();
  9611. Client cli(HOST, port);
  9612. auto res = cli.Get("/mount2/dir/test.html");
  9613. ASSERT_TRUE(res) << "Error: " << to_string(res.error());
  9614. EXPECT_EQ(StatusCode::OK_200, res->status);
  9615. // "/mount2" must not match part-way through a path segment.
  9616. res = cli.Get("/mount2dir/test.html");
  9617. ASSERT_TRUE(res) << "Error: " << to_string(res.error());
  9618. EXPECT_EQ(StatusCode::NotFound_404, res->status);
  9619. // A mount point ending in '/' keeps matching every path below it.
  9620. res = cli.Get("/dir/test.html");
  9621. ASSERT_TRUE(res) << "Error: " << to_string(res.error());
  9622. EXPECT_EQ(StatusCode::OK_200, res->status);
  9623. }
  9624. TEST(MountTest, Redicect) {
  9625. Server svr;
  9626. auto listen_thread = std::thread([&svr]() { svr.listen("localhost", PORT); });
  9627. auto se = detail::scope_exit([&] {
  9628. svr.stop();
  9629. listen_thread.join();
  9630. ASSERT_FALSE(svr.is_running());
  9631. });
  9632. svr.set_mount_point("/", "./www");
  9633. svr.wait_until_ready();
  9634. Client cli("localhost", PORT);
  9635. auto res = cli.Get("/dir/");
  9636. ASSERT_TRUE(res) << "Error: " << to_string(res.error());
  9637. EXPECT_EQ(StatusCode::OK_200, res->status);
  9638. res = cli.Get("/dir");
  9639. ASSERT_TRUE(res) << "Error: " << to_string(res.error());
  9640. EXPECT_EQ(StatusCode::MovedPermanently_301, res->status);
  9641. res = cli.Get("/file");
  9642. ASSERT_TRUE(res) << "Error: " << to_string(res.error());
  9643. EXPECT_EQ(StatusCode::OK_200, res->status);
  9644. res = cli.Get("/file/");
  9645. ASSERT_TRUE(res) << "Error: " << to_string(res.error());
  9646. EXPECT_EQ(StatusCode::NotFound_404, res->status);
  9647. cli.set_follow_location(true);
  9648. res = cli.Get("/dir");
  9649. ASSERT_TRUE(res) << "Error: " << to_string(res.error());
  9650. EXPECT_EQ(StatusCode::OK_200, res->status);
  9651. }
  9652. TEST(MountTest, MultibytesPathName) {
  9653. Server svr;
  9654. auto listen_thread = std::thread([&svr]() { svr.listen("localhost", PORT); });
  9655. auto se = detail::scope_exit([&] {
  9656. svr.stop();
  9657. listen_thread.join();
  9658. ASSERT_FALSE(svr.is_running());
  9659. });
  9660. svr.set_mount_point("/", "./www");
  9661. svr.wait_until_ready();
  9662. Client cli("localhost", PORT);
  9663. auto res = cli.Get(U8("/日本語Dir/日本語File.txt"));
  9664. ASSERT_TRUE(res) << "Error: " << to_string(res.error());
  9665. EXPECT_EQ(StatusCode::OK_200, res->status);
  9666. EXPECT_EQ(U8("日本語コンテンツ"), res->body);
  9667. }
  9668. #ifdef _WIN32
  9669. // Issue #2435: mmap::open() must succeed even when another handle holds
  9670. // the file open for writing (e.g. an active log file).
  9671. TEST(MmapTest, OpenWhileFileHeldForWriting) {
  9672. const char *path = "mmap_concurrent_writer_test.txt";
  9673. const char *content = "hello";
  9674. {
  9675. std::ofstream f(path, std::ios::binary);
  9676. f.write(content, static_cast<std::streamsize>(strlen(content)));
  9677. }
  9678. auto file_cleanup = detail::scope_exit([&] { std::remove(path); });
  9679. HANDLE writer = ::CreateFileA(path, GENERIC_WRITE, FILE_SHARE_READ, NULL,
  9680. OPEN_EXISTING, FILE_ATTRIBUTE_NORMAL, NULL);
  9681. ASSERT_NE(INVALID_HANDLE_VALUE, writer);
  9682. auto handle_cleanup = detail::scope_exit([&] { ::CloseHandle(writer); });
  9683. detail::mmap m(path);
  9684. ASSERT_TRUE(m.is_open());
  9685. EXPECT_EQ(strlen(content), m.size());
  9686. EXPECT_EQ(0, std::memcmp(content, m.data(), strlen(content)));
  9687. }
  9688. #endif
  9689. #ifndef _WIN32
  9690. // A failed ::mmap() must not be reported as an open mapping, otherwise data()
  9691. // hands the caller the MAP_FAILED sentinel. A directory is the easiest way to
  9692. // reach it, since ::open() and fstat() succeed for one but ::mmap() doesn't.
  9693. TEST(MmapTest, FailedMappingIsNotOpen) {
  9694. const char *path = "./mmap_failed_mapping_test_dir";
  9695. ASSERT_EQ(0, ::mkdir(path, 0755));
  9696. auto dir_cleanup = detail::scope_exit([&] { ::rmdir(path); });
  9697. detail::mmap m(path);
  9698. EXPECT_FALSE(m.is_open());
  9699. EXPECT_EQ(0U, m.size());
  9700. EXPECT_NE(static_cast<const void *>(m.data()),
  9701. static_cast<const void *>(MAP_FAILED));
  9702. }
  9703. #endif
  9704. TEST(KeepAliveTest, ReadTimeout) {
  9705. Server svr;
  9706. svr.Get("/a", [&](const Request & /*req*/, Response &res) {
  9707. std::this_thread::sleep_for(std::chrono::seconds(2));
  9708. res.set_content("a", "text/plain");
  9709. });
  9710. svr.Get("/b", [&](const Request & /*req*/, Response &res) {
  9711. res.set_content("b", "text/plain");
  9712. });
  9713. auto listen_thread = std::thread([&svr]() { svr.listen("localhost", PORT); });
  9714. auto se = detail::scope_exit([&] {
  9715. svr.stop();
  9716. listen_thread.join();
  9717. ASSERT_FALSE(svr.is_running());
  9718. });
  9719. svr.wait_until_ready();
  9720. Client cli("localhost", PORT);
  9721. cli.set_keep_alive(true);
  9722. cli.set_read_timeout(std::chrono::seconds(1));
  9723. auto resa = cli.Get("/a");
  9724. ASSERT_FALSE(resa);
  9725. EXPECT_EQ(Error::Read, resa.error());
  9726. auto resb = cli.Get("/b");
  9727. ASSERT_TRUE(resb);
  9728. EXPECT_EQ(StatusCode::OK_200, resb->status);
  9729. EXPECT_EQ("b", resb->body);
  9730. }
  9731. TEST(KeepAliveTest, MaxCount) {
  9732. size_t keep_alive_max_count = 3;
  9733. Server svr;
  9734. svr.set_keep_alive_max_count(keep_alive_max_count);
  9735. svr.Get("/hi", [](const httplib::Request &, httplib::Response &res) {
  9736. res.set_content("Hello World!", "text/plain");
  9737. });
  9738. auto listen_thread = std::thread([&svr] { svr.listen(HOST, PORT); });
  9739. auto se = detail::scope_exit([&] {
  9740. svr.stop();
  9741. listen_thread.join();
  9742. ASSERT_FALSE(svr.is_running());
  9743. });
  9744. svr.wait_until_ready();
  9745. Client cli(HOST, PORT);
  9746. cli.set_keep_alive(true);
  9747. for (size_t i = 0; i < 5; i++) {
  9748. auto result = cli.Get("/hi");
  9749. ASSERT_TRUE(result);
  9750. EXPECT_EQ(StatusCode::OK_200, result->status);
  9751. if (i == keep_alive_max_count - 1) {
  9752. EXPECT_EQ("close", result->get_header_value("Connection"));
  9753. } else {
  9754. EXPECT_FALSE(result->has_header("Connection"));
  9755. }
  9756. }
  9757. }
  9758. // A client may pipeline its requests (RFC 9112 9.3.2), so reading one request
  9759. // can pull the next one into the server's buffer. The server must serve it
  9760. // without waiting for the socket to become readable again. The keep-alive
  9761. // timeout outlasts the client's read timeout, so a request left waiting for it
  9762. // shows up as a missing response.
  9763. static void serve_pipelining_routes(Server &svr,
  9764. const std::function<void(int)> &client) {
  9765. svr.set_keep_alive_timeout(5);
  9766. svr.Get("/hi/(\\d+)", [](const Request &req, Response &res) {
  9767. res.set_content("hi " + req.matches[1].str(), "text/plain");
  9768. });
  9769. svr.Post("/echo", [](const Request &req, Response &res) {
  9770. res.set_content("echo " + req.body, "text/plain");
  9771. });
  9772. auto port = svr.bind_to_any_port(HOST);
  9773. thread t = thread([&] { svr.listen_after_bind(); });
  9774. auto se = detail::scope_exit([&] {
  9775. svr.stop();
  9776. t.join();
  9777. });
  9778. svr.wait_until_ready();
  9779. client(port);
  9780. }
  9781. static std::string
  9782. send_pipelined_requests(const std::vector<std::string> &parts) {
  9783. Server svr;
  9784. std::string res;
  9785. serve_pipelining_routes(svr, [&](int port) {
  9786. EXPECT_TRUE(send_request_in_parts(2, parts, &res, port));
  9787. });
  9788. return res;
  9789. }
  9790. static void expect_in_order(const std::string &res,
  9791. const std::vector<std::string> &bodies) {
  9792. size_t pos = 0;
  9793. for (const auto &body : bodies) {
  9794. pos = res.find(body, pos);
  9795. ASSERT_NE(std::string::npos, pos) << "missing or out of order: " << body;
  9796. pos += body.size();
  9797. }
  9798. }
  9799. TEST(KeepAliveTest, PipelinedRequests) {
  9800. auto res = send_pipelined_requests(
  9801. {"GET /hi/1 HTTP/1.1\r\nHost: localhost\r\n\r\n"
  9802. "POST /echo HTTP/1.1\r\nHost: localhost\r\n"
  9803. "Content-Length: 4\r\n\r\nbody"
  9804. "GET /hi/3 HTTP/1.1\r\nHost: localhost\r\nConnection: close\r\n\r\n"});
  9805. expect_in_order(res, {"hi 1", "echo body", "hi 3"});
  9806. }
  9807. // The second request starts in the server's buffer and ends on the socket.
  9808. TEST(KeepAliveTest, PipelinedRequestSplitAcrossReads) {
  9809. auto res =
  9810. send_pipelined_requests({"GET /hi/1 HTTP/1.1\r\nHost: localhost\r\n\r\n"
  9811. "GET /hi/2 HTTP/1.1\r\nHo",
  9812. "st: localhost\r\nConnection: close\r\n\r\n"});
  9813. expect_in_order(res, {"hi 1", "hi 2"});
  9814. }
  9815. // RFC 9112 2.2: an empty line before the request-line is ignored, so an extra
  9816. // CRLF after a body does not turn into a 400 for the next request.
  9817. TEST(KeepAliveTest, EmptyLineBeforeRequestLineIsIgnored) {
  9818. auto res = send_pipelined_requests(
  9819. {"POST /echo HTTP/1.1\r\nHost: localhost\r\n"
  9820. "Content-Length: 4\r\n\r\nbody\r\n"
  9821. "GET /hi/2 HTTP/1.1\r\nHost: localhost\r\nConnection: close\r\n\r\n"});
  9822. EXPECT_EQ(std::string::npos, res.find("400 Bad Request"));
  9823. expect_in_order(res, {"echo body", "hi 2"});
  9824. }
  9825. // Where an unparsable request ends is unknown, so what follows it in the buffer
  9826. // must not be served as the next request.
  9827. TEST(KeepAliveTest, PipelinedRequestAfterInvalidRequestIsNotServed) {
  9828. auto res = send_pipelined_requests(
  9829. {"INVALID REQUEST LINE\r\n\r\n"
  9830. "GET /hi/1 HTTP/1.1\r\nHost: localhost\r\n\r\n"});
  9831. EXPECT_EQ("HTTP/1.1 400 Bad Request", res.substr(0, 24));
  9832. EXPECT_EQ(std::string::npos, res.find("hi 1"));
  9833. }
  9834. #ifdef CPPHTTPLIB_OPENSSL_SUPPORT
  9835. // Over TLS, the next request is held by the TLS library as already decrypted
  9836. // data rather than on the socket.
  9837. TEST(KeepAliveTest, SSLPipelinedRequests) {
  9838. SSLServer svr(SERVER_CERT_FILE, SERVER_PRIVATE_KEY_FILE);
  9839. std::string res;
  9840. serve_pipelining_routes(svr, [&](int port) {
  9841. auto error = Error::Success;
  9842. auto sock = detail::create_client_socket(
  9843. HOST, "", port, AF_UNSPEC, false, false, nullptr,
  9844. /*connection_timeout_sec=*/5, 0,
  9845. /*read_timeout_sec=*/2, 0,
  9846. /*write_timeout_sec=*/5, 0, std::string(), error);
  9847. ASSERT_NE(INVALID_SOCKET, sock);
  9848. auto sock_se = detail::scope_exit([&] { detail::close_socket(sock); });
  9849. auto ctx = SSL_CTX_new(TLS_client_method());
  9850. auto ssl = SSL_new(ctx);
  9851. auto ssl_se = detail::scope_exit([&] {
  9852. SSL_free(ssl);
  9853. SSL_CTX_free(ctx);
  9854. });
  9855. SSL_set_fd(ssl, static_cast<int>(sock));
  9856. ASSERT_EQ(1, SSL_connect(ssl));
  9857. // One write, so all three requests arrive in one TLS record
  9858. const std::string req =
  9859. "GET /hi/1 HTTP/1.1\r\nHost: localhost\r\n\r\n"
  9860. "GET /hi/2 HTTP/1.1\r\nHost: localhost\r\n\r\n"
  9861. "GET /hi/3 HTTP/1.1\r\nHost: localhost\r\nConnection: close\r\n\r\n";
  9862. ASSERT_EQ(static_cast<int>(req.size()),
  9863. SSL_write(ssl, req.data(), static_cast<int>(req.size())));
  9864. char buf[512];
  9865. int n;
  9866. while ((n = SSL_read(ssl, buf, sizeof(buf))) > 0) {
  9867. res.append(buf, static_cast<size_t>(n));
  9868. }
  9869. });
  9870. expect_in_order(res, {"hi 1", "hi 2", "hi 3"});
  9871. }
  9872. #endif
  9873. TEST(KeepAliveTest, Issue1041) {
  9874. Server svr;
  9875. svr.set_keep_alive_timeout(3);
  9876. svr.Get("/hi", [](const httplib::Request &, httplib::Response &res) {
  9877. res.set_content("Hello World!", "text/plain");
  9878. });
  9879. auto listen_thread = std::thread([&svr] { svr.listen(HOST, PORT); });
  9880. auto se = detail::scope_exit([&] {
  9881. svr.stop();
  9882. listen_thread.join();
  9883. ASSERT_FALSE(svr.is_running());
  9884. });
  9885. svr.wait_until_ready();
  9886. Client cli(HOST, PORT);
  9887. cli.set_keep_alive(true);
  9888. auto result = cli.Get("/hi");
  9889. ASSERT_TRUE(result);
  9890. EXPECT_EQ(StatusCode::OK_200, result->status);
  9891. std::this_thread::sleep_for(std::chrono::seconds(5));
  9892. result = cli.Get("/hi");
  9893. ASSERT_TRUE(result);
  9894. EXPECT_EQ(StatusCode::OK_200, result->status);
  9895. }
  9896. TEST(KeepAliveTest, Issue1959) {
  9897. Server svr;
  9898. svr.set_keep_alive_timeout(5);
  9899. svr.Get("/a", [&](const Request & /*req*/, Response &res) {
  9900. res.set_content("a", "text/plain");
  9901. });
  9902. auto listen_thread = std::thread([&svr]() { svr.listen("localhost", PORT); });
  9903. auto se = detail::scope_exit([&] {
  9904. if (!svr.is_running()) return;
  9905. svr.stop();
  9906. listen_thread.join();
  9907. ASSERT_FALSE(svr.is_running());
  9908. });
  9909. svr.wait_until_ready();
  9910. Client cli("localhost", PORT);
  9911. cli.set_keep_alive(true);
  9912. using namespace std::chrono;
  9913. auto start = steady_clock::now();
  9914. cli.Get("/a");
  9915. svr.stop();
  9916. listen_thread.join();
  9917. auto end = steady_clock::now();
  9918. auto elapsed = duration_cast<milliseconds>(end - start).count();
  9919. EXPECT_LT(elapsed, 5000);
  9920. }
  9921. #ifdef CPPHTTPLIB_SSL_ENABLED
  9922. TEST(KeepAliveTest, SSLClientReconnection) {
  9923. SSLServer svr(SERVER_CERT_FILE, SERVER_PRIVATE_KEY_FILE);
  9924. ASSERT_TRUE(svr.is_valid());
  9925. svr.set_keep_alive_timeout(1);
  9926. svr.Get("/hi", [](const httplib::Request &, httplib::Response &res) {
  9927. res.set_content("Hello World!", "text/plain");
  9928. });
  9929. auto listen_thread = std::thread([&svr] { svr.listen(HOST, PORT); });
  9930. auto se = detail::scope_exit([&] {
  9931. svr.stop();
  9932. listen_thread.join();
  9933. ASSERT_FALSE(svr.is_running());
  9934. });
  9935. svr.wait_until_ready();
  9936. SSLClient cli(HOST, PORT);
  9937. cli.enable_server_certificate_verification(false);
  9938. cli.set_keep_alive(true);
  9939. auto result = cli.Get("/hi");
  9940. ASSERT_TRUE(result);
  9941. EXPECT_EQ(StatusCode::OK_200, result->status);
  9942. result = cli.Get("/hi");
  9943. ASSERT_TRUE(result);
  9944. EXPECT_EQ(StatusCode::OK_200, result->status);
  9945. std::this_thread::sleep_for(std::chrono::seconds(2));
  9946. // Recoonect
  9947. result = cli.Get("/hi");
  9948. ASSERT_TRUE(result);
  9949. EXPECT_EQ(StatusCode::OK_200, result->status);
  9950. result = cli.Get("/hi");
  9951. ASSERT_TRUE(result);
  9952. EXPECT_EQ(StatusCode::OK_200, result->status);
  9953. }
  9954. TEST(KeepAliveTest, SSLClientReconnectionPost) {
  9955. SSLServer svr(SERVER_CERT_FILE, SERVER_PRIVATE_KEY_FILE);
  9956. ASSERT_TRUE(svr.is_valid());
  9957. svr.set_keep_alive_timeout(1);
  9958. std::string content = "reconnect";
  9959. svr.Post("/hi", [](const httplib::Request &, httplib::Response &res) {
  9960. res.set_content("Hello World!", "text/plain");
  9961. });
  9962. auto listen_thread = std::thread([&svr] { svr.listen(HOST, PORT); });
  9963. auto se = detail::scope_exit([&] {
  9964. svr.stop();
  9965. listen_thread.join();
  9966. ASSERT_FALSE(svr.is_running());
  9967. });
  9968. svr.wait_until_ready();
  9969. SSLClient cli(HOST, PORT);
  9970. cli.enable_server_certificate_verification(false);
  9971. cli.set_keep_alive(true);
  9972. auto result = cli.Post(
  9973. "/hi", content.size(),
  9974. [&content](size_t /*offset*/, size_t /*length*/, DataSink &sink) {
  9975. sink.write(content.c_str(), content.size());
  9976. return true;
  9977. },
  9978. "text/plain");
  9979. ASSERT_TRUE(result);
  9980. EXPECT_EQ(200, result->status);
  9981. std::this_thread::sleep_for(std::chrono::seconds(2));
  9982. // Recoonect
  9983. result = cli.Post(
  9984. "/hi", content.size(),
  9985. [&content](size_t /*offset*/, size_t /*length*/, DataSink &sink) {
  9986. sink.write(content.c_str(), content.size());
  9987. return true;
  9988. },
  9989. "text/plain");
  9990. ASSERT_TRUE(result);
  9991. EXPECT_EQ(200, result->status);
  9992. result = cli.Post(
  9993. "/hi", content.size(),
  9994. [&content](size_t /*offset*/, size_t /*length*/, DataSink &sink) {
  9995. sink.write(content.c_str(), content.size());
  9996. return true;
  9997. },
  9998. "text/plain");
  9999. ASSERT_TRUE(result);
  10000. EXPECT_EQ(200, result->status);
  10001. }
  10002. TEST(SNI_AutoDetectionTest, SNI_Logic) {
  10003. using namespace httplib::tls;
  10004. {
  10005. SSLServer svr(SERVER_CERT_FILE, SERVER_PRIVATE_KEY_FILE);
  10006. ASSERT_TRUE(svr.is_valid());
  10007. svr.Get("/sni", [&](const Request &req, Response &res) {
  10008. std::string expected = req.sni();
  10009. EXPECT_EQ(expected, req.get_param_value("expected"));
  10010. res.set_content("ok", "text/plain");
  10011. });
  10012. auto listen_thread = std::thread([&svr] { svr.listen(HOST, PORT); });
  10013. auto se = detail::scope_exit([&] {
  10014. svr.stop();
  10015. listen_thread.join();
  10016. ASSERT_FALSE(svr.is_running());
  10017. });
  10018. svr.wait_until_ready();
  10019. {
  10020. SSLClient cli("localhost", PORT);
  10021. cli.enable_server_certificate_verification(false);
  10022. auto res = cli.Get("/sni?expected=localhost");
  10023. ASSERT_TRUE(res) << "Error: " << to_string(res.error());
  10024. }
  10025. {
  10026. SSLClient cli("::1", PORT);
  10027. cli.enable_server_certificate_verification(false);
  10028. auto res = cli.Get("/sni?expected=");
  10029. // NOTE: This may fail if the server is listening on IPv4 only
  10030. // (e.g., when localhost resolves to 127.0.0.1 only)
  10031. if (res) {
  10032. EXPECT_EQ(StatusCode::OK_200, res->status);
  10033. } else {
  10034. EXPECT_EQ(Error::Connection, res.error());
  10035. }
  10036. }
  10037. }
  10038. }
  10039. #endif
  10040. TEST(ClientProblemDetectionTest, ContentProvider) {
  10041. Server svr;
  10042. size_t content_length = 1024 * 1024;
  10043. svr.Get("/hi", [&](const Request & /*req*/, Response &res) {
  10044. res.set_content_provider(
  10045. content_length, "text/plain",
  10046. [&](size_t offset, size_t length, DataSink &sink) {
  10047. auto out_len = std::min(length, static_cast<size_t>(1024));
  10048. std::string out(out_len, '@');
  10049. sink.write(out.data(), out_len);
  10050. return offset < 4096;
  10051. },
  10052. [](bool success) { ASSERT_FALSE(success); });
  10053. });
  10054. svr.Get("/empty", [&](const Request & /*req*/, Response &res) {
  10055. res.set_content_provider(
  10056. 0, "text/plain",
  10057. [&](size_t /*offset*/, size_t /*length*/, DataSink & /*sink*/) -> bool {
  10058. EXPECT_TRUE(false);
  10059. return true;
  10060. },
  10061. [](bool success) { ASSERT_FALSE(success); });
  10062. });
  10063. auto listen_thread = std::thread([&svr]() { svr.listen("localhost", PORT); });
  10064. auto se = detail::scope_exit([&] {
  10065. svr.stop();
  10066. listen_thread.join();
  10067. ASSERT_FALSE(svr.is_running());
  10068. });
  10069. svr.wait_until_ready();
  10070. Client cli("localhost", PORT);
  10071. {
  10072. auto res = cli.Get("/hi", [&](const char * /*data*/,
  10073. size_t /*data_length*/) { return false; });
  10074. ASSERT_FALSE(res);
  10075. }
  10076. {
  10077. auto res = cli.Get("/empty", [&](const char * /*data*/,
  10078. size_t /*data_length*/) { return false; });
  10079. ASSERT_TRUE(res) << "Error: " << to_string(res.error());
  10080. }
  10081. }
  10082. TEST(ContentProviderTest, ProviderMakingNoProgressFails) {
  10083. // A provider that reports success without writing anything and without
  10084. // calling done() used to be handed the same offset and length again on every
  10085. // pass, so it spun for as long as the peer stayed connected.
  10086. Server svr;
  10087. svr.Post("/", [](const Request & /*req*/, Response &res) {
  10088. res.set_content("ok", "text/plain");
  10089. });
  10090. auto port = svr.bind_to_any_port(HOST);
  10091. auto listen_thread = std::thread([&svr] { svr.listen_after_bind(); });
  10092. auto se = detail::scope_exit([&] {
  10093. svr.stop();
  10094. listen_thread.join();
  10095. ASSERT_FALSE(svr.is_running());
  10096. });
  10097. svr.wait_until_ready();
  10098. std::atomic<int> call_count{0};
  10099. Client cli(HOST, port);
  10100. auto res = cli.Post(
  10101. "/", 1024,
  10102. [&](size_t /*offset*/, size_t /*length*/, DataSink & /*sink*/) {
  10103. // Give up after enough passes to show the spin, so that losing the
  10104. // check below fails this test instead of hanging it.
  10105. return ++call_count < 100;
  10106. },
  10107. "text/plain");
  10108. ASSERT_FALSE(res);
  10109. EXPECT_EQ(Error::Write, res.error());
  10110. EXPECT_EQ(1, call_count.load());
  10111. }
  10112. TEST(DataSinkTest, OptionalCallbacksAreCallableByDefault) {
  10113. // A writer only has to assign `write`. The other three used to be left as
  10114. // empty std::functions, so a provider calling one threw
  10115. // std::bad_function_call out of the thread running it and took the whole
  10116. // process down.
  10117. DataSink sink;
  10118. std::string written;
  10119. sink.write = [&](const char *data, size_t data_len) {
  10120. written.append(data, data_len);
  10121. return true;
  10122. };
  10123. EXPECT_TRUE(sink.is_writable());
  10124. sink.done();
  10125. sink.done_with_trailer(Headers{{"X-Trailer", "value"}});
  10126. EXPECT_TRUE(written.empty());
  10127. }
  10128. TEST(DataSinkTest, DoneWithTrailerFallsBackToDone) {
  10129. // A sink that cannot carry trailers still has to finish.
  10130. DataSink sink;
  10131. auto done_count = 0;
  10132. sink.done = [&]() { done_count++; };
  10133. sink.done_with_trailer(Headers{{"X-Trailer", "value"}});
  10134. EXPECT_EQ(1, done_count);
  10135. }
  10136. TEST(DataSinkTest, LengthFramedProviderMayCallDoneAfterWritingEverything) {
  10137. Server svr;
  10138. const std::string body(4096, 'x');
  10139. svr.Get("/", [&](const Request & /*req*/, Response &res) {
  10140. res.set_content_provider(body.size(), "text/plain",
  10141. [&](size_t offset, size_t length, DataSink &sink) {
  10142. sink.write(body.data() + offset, length);
  10143. sink.done();
  10144. return true;
  10145. });
  10146. });
  10147. auto port = svr.bind_to_any_port(HOST);
  10148. auto listen_thread = std::thread([&svr]() { svr.listen_after_bind(); });
  10149. auto se = detail::scope_exit([&] {
  10150. svr.stop();
  10151. listen_thread.join();
  10152. ASSERT_FALSE(svr.is_running());
  10153. });
  10154. svr.wait_until_ready();
  10155. Client cli(HOST, port);
  10156. auto res = cli.Get("/");
  10157. ASSERT_TRUE(res) << "Error: " << to_string(res.error());
  10158. EXPECT_EQ(StatusCode::OK_200, res->status);
  10159. EXPECT_EQ(body, res->body);
  10160. }
  10161. TEST(DataSinkTest, LengthFramedProviderThatFinishesEarlyFailsTheResponse) {
  10162. Server svr;
  10163. svr.Get("/", [](const Request & /*req*/, Response &res) {
  10164. res.set_content_provider(
  10165. 1024, "text/plain",
  10166. [](size_t /*offset*/, size_t /*length*/, DataSink &sink) {
  10167. sink.write("hello", 5);
  10168. sink.done(); // short of the 1024 bytes the response promised
  10169. return true;
  10170. });
  10171. });
  10172. auto port = svr.bind_to_any_port(HOST);
  10173. auto listen_thread = std::thread([&svr]() { svr.listen_after_bind(); });
  10174. auto se = detail::scope_exit([&] {
  10175. svr.stop();
  10176. listen_thread.join();
  10177. ASSERT_FALSE(svr.is_running());
  10178. });
  10179. svr.wait_until_ready();
  10180. Client cli(HOST, port);
  10181. cli.set_read_timeout(5, 0);
  10182. // The response is short of its Content-Length, so the client cannot read a
  10183. // complete body. What matters is that this returns at all: a no-op done()
  10184. // would leave the writer looping over a provider that never makes progress.
  10185. auto res = cli.Get("/");
  10186. EXPECT_FALSE(res);
  10187. }
  10188. #ifdef CPPHTTPLIB_ZLIB_SUPPORT
  10189. TEST(DataSinkTest, CompressedRequestProviderThatFinishesEarlyFails) {
  10190. // The compressed path builds the whole body before connecting, so this
  10191. // fails client-side and never reaches a server.
  10192. Client cli(HOST, PORT);
  10193. cli.set_compress(true);
  10194. auto res = cli.Post(
  10195. "/", 1024,
  10196. [](size_t /*offset*/, size_t /*length*/, DataSink &sink) {
  10197. sink.write("hello", 5);
  10198. sink.done(); // short of the 1024 bytes the request announced
  10199. return true;
  10200. },
  10201. "text/plain");
  10202. ASSERT_FALSE(res);
  10203. EXPECT_EQ(Error::Write, res.error());
  10204. }
  10205. #endif
  10206. TEST(ErrorHandlerWithContentProviderTest, ErrorHandler) {
  10207. Server svr;
  10208. svr.set_error_handler([](Request const &, Response &res) -> void {
  10209. res.set_chunked_content_provider(
  10210. "text/plain", [](std::size_t const, DataSink &sink) -> bool {
  10211. sink.os << "hello";
  10212. sink.os << "world";
  10213. sink.done();
  10214. return true;
  10215. });
  10216. });
  10217. auto listen_thread = std::thread([&svr]() { svr.listen("localhost", PORT); });
  10218. auto se = detail::scope_exit([&] {
  10219. svr.stop();
  10220. listen_thread.join();
  10221. ASSERT_FALSE(svr.is_running());
  10222. });
  10223. svr.wait_until_ready();
  10224. Client cli("localhost", PORT);
  10225. auto res = cli.Get("/");
  10226. ASSERT_TRUE(res) << "Error: " << to_string(res.error());
  10227. EXPECT_EQ(StatusCode::NotFound_404, res->status);
  10228. EXPECT_EQ("helloworld", res->body);
  10229. }
  10230. TEST(LongPollingTest, ClientCloseDetection) {
  10231. Server svr;
  10232. svr.Get("/events", [&](const Request & /*req*/, Response &res) {
  10233. res.set_chunked_content_provider(
  10234. "text/plain", [](std::size_t const, DataSink &sink) -> bool {
  10235. EXPECT_TRUE(sink.is_writable()); // the socket is alive
  10236. sink.os << "hello";
  10237. auto count = 10;
  10238. while (count > 0 && sink.is_writable()) {
  10239. this_thread::sleep_for(chrono::milliseconds(10));
  10240. count--;
  10241. }
  10242. EXPECT_FALSE(sink.is_writable()); // the socket is closed
  10243. return true;
  10244. });
  10245. });
  10246. auto listen_thread = std::thread([&svr]() { svr.listen("localhost", PORT); });
  10247. auto se = detail::scope_exit([&] {
  10248. svr.stop();
  10249. listen_thread.join();
  10250. ASSERT_FALSE(svr.is_running());
  10251. });
  10252. svr.wait_until_ready();
  10253. Client cli("localhost", PORT);
  10254. auto res = cli.Get("/events", [&](const char *data, size_t data_length) {
  10255. EXPECT_EQ("hello", string(data, data_length));
  10256. return false; // close the socket immediately.
  10257. });
  10258. ASSERT_FALSE(res);
  10259. }
  10260. TEST(LongPollingTest, ClientCloseDetectionWithStreamOperator) {
  10261. Server svr;
  10262. svr.Get("/events", [&](const Request & /*req*/, Response &res) {
  10263. res.set_chunked_content_provider(
  10264. "text/plain", [](std::size_t const, DataSink &sink) -> bool {
  10265. EXPECT_TRUE(sink.is_writable()); // the socket is alive
  10266. sink.os << "hello";
  10267. EXPECT_TRUE(sink.os.good());
  10268. // Wait for the client to close the connection
  10269. auto count = 10;
  10270. while (count > 0 && sink.is_writable()) {
  10271. this_thread::sleep_for(chrono::milliseconds(10));
  10272. count--;
  10273. }
  10274. // After client disconnect, write repeatedly until the socket
  10275. // write actually fails (small writes may be absorbed by the
  10276. // kernel buffer)
  10277. std::string chunk(1024, 'x');
  10278. for (int i = 0; i < 1000 && sink.os.good(); i++) {
  10279. sink.os << chunk;
  10280. }
  10281. EXPECT_TRUE(sink.os.fail());
  10282. return true;
  10283. });
  10284. });
  10285. auto port = svr.bind_to_any_port("localhost");
  10286. auto listen_thread = std::thread([&svr]() { svr.listen_after_bind(); });
  10287. auto se = detail::scope_exit([&] {
  10288. svr.stop();
  10289. listen_thread.join();
  10290. ASSERT_FALSE(svr.is_running());
  10291. });
  10292. svr.wait_until_ready();
  10293. Client cli("localhost", port);
  10294. auto res = cli.Get("/events", [&](const char *data, size_t data_length) {
  10295. EXPECT_EQ("hello", string(data, data_length));
  10296. return false; // close the socket immediately.
  10297. });
  10298. ASSERT_FALSE(res);
  10299. }
  10300. TEST(GetWithParametersTest, GetWithParameters) {
  10301. Server svr;
  10302. svr.Get("/", [&](const Request &req, Response &) {
  10303. EXPECT_EQ("world", req.get_param_value("hello"));
  10304. EXPECT_EQ("world2", req.get_param_value("hello2"));
  10305. EXPECT_EQ("world3", req.get_param_value("hello3"));
  10306. });
  10307. svr.Get("/params", [&](const Request &req, Response &) {
  10308. EXPECT_EQ("world", req.get_param_value("hello"));
  10309. EXPECT_EQ("world2", req.get_param_value("hello2"));
  10310. EXPECT_EQ("world3", req.get_param_value("hello3"));
  10311. });
  10312. svr.Get(R"(/resources/([a-z0-9\\-]+))", [&](const Request &req, Response &) {
  10313. EXPECT_EQ("resource-id", req.matches[1]);
  10314. EXPECT_EQ("foo", req.get_param_value("param1"));
  10315. EXPECT_EQ("bar", req.get_param_value("param2"));
  10316. });
  10317. svr.Get("/users/:id", [&](const Request &req, Response &) {
  10318. EXPECT_EQ("user-id", req.path_params.at("id"));
  10319. EXPECT_EQ("foo", req.get_param_value("param1"));
  10320. EXPECT_EQ("bar", req.get_param_value("param2"));
  10321. });
  10322. auto listen_thread = std::thread([&svr]() { svr.listen(HOST, PORT); });
  10323. auto se = detail::scope_exit([&] {
  10324. svr.stop();
  10325. listen_thread.join();
  10326. ASSERT_FALSE(svr.is_running());
  10327. });
  10328. svr.wait_until_ready();
  10329. {
  10330. Client cli(HOST, PORT);
  10331. Params params;
  10332. params.emplace("hello", "world");
  10333. params.emplace("hello2", "world2");
  10334. params.emplace("hello3", "world3");
  10335. auto res = cli.Get("/", params, Headers{});
  10336. ASSERT_TRUE(res) << "Error: " << to_string(res.error());
  10337. EXPECT_EQ(StatusCode::OK_200, res->status);
  10338. }
  10339. {
  10340. Client cli(HOST, PORT);
  10341. auto res = cli.Get("/params?hello=world&hello2=world2&hello3=world3");
  10342. ASSERT_TRUE(res) << "Error: " << to_string(res.error());
  10343. EXPECT_EQ(StatusCode::OK_200, res->status);
  10344. }
  10345. {
  10346. Client cli(HOST, PORT);
  10347. auto res = cli.Get("/resources/resource-id?param1=foo&param2=bar");
  10348. ASSERT_TRUE(res) << "Error: " << to_string(res.error());
  10349. EXPECT_EQ(StatusCode::OK_200, res->status);
  10350. }
  10351. {
  10352. Client cli(HOST, PORT);
  10353. auto res = cli.Get("/users/user-id?param1=foo&param2=bar");
  10354. ASSERT_TRUE(res) << "Error: " << to_string(res.error());
  10355. EXPECT_EQ(StatusCode::OK_200, res->status);
  10356. }
  10357. }
  10358. TEST(GetWithParametersTest, GetWithParameters2) {
  10359. Server svr;
  10360. svr.Get("/", [&](const Request &req, Response &res) {
  10361. auto text = req.get_param_value("hello");
  10362. res.set_content(text, "text/plain");
  10363. });
  10364. auto listen_thread = std::thread([&svr]() { svr.listen("localhost", PORT); });
  10365. auto se = detail::scope_exit([&] {
  10366. svr.stop();
  10367. listen_thread.join();
  10368. ASSERT_FALSE(svr.is_running());
  10369. });
  10370. svr.wait_until_ready();
  10371. Client cli("localhost", PORT);
  10372. Params params;
  10373. params.emplace("hello", "world");
  10374. std::string body;
  10375. auto res = cli.Get("/", params, Headers{},
  10376. [&](const char *data, size_t data_length) {
  10377. body.append(data, data_length);
  10378. return true;
  10379. });
  10380. ASSERT_TRUE(res) << "Error: " << to_string(res.error());
  10381. EXPECT_EQ(StatusCode::OK_200, res->status);
  10382. EXPECT_EQ("world", body);
  10383. }
  10384. TEST(GetWithParametersTest, GetWithParamsOnlyNoHeaders) {
  10385. Server svr;
  10386. svr.Get("/search", [&](const Request &req, Response &res) {
  10387. auto q = req.get_param_value("q");
  10388. res.set_content(q, "text/plain");
  10389. });
  10390. auto listen_thread = std::thread([&svr]() { svr.listen("localhost", PORT); });
  10391. auto se = detail::scope_exit([&] {
  10392. svr.stop();
  10393. listen_thread.join();
  10394. ASSERT_FALSE(svr.is_running());
  10395. });
  10396. svr.wait_until_ready();
  10397. Client cli("localhost", PORT);
  10398. // Verify that Get(path, params) works without requiring Headers argument
  10399. auto res = cli.Get("/search", httplib::Params{{"q", "cpp-httplib"}});
  10400. ASSERT_TRUE(res) << "Error: " << to_string(res.error());
  10401. EXPECT_EQ(StatusCode::OK_200, res->status);
  10402. EXPECT_EQ("cpp-httplib", res->body);
  10403. }
  10404. TEST(ClientDefaultHeadersTest, DefaultHeaders_Online) {
  10405. auto host = "httpbingo.org";
  10406. auto path = std::string{"/range/32"};
  10407. #ifdef CPPHTTPLIB_SSL_ENABLED
  10408. SSLClient cli(host);
  10409. #else
  10410. Client cli(host);
  10411. #endif
  10412. cli.set_default_headers({make_range_header({{1, 10}})});
  10413. cli.set_connection_timeout(5);
  10414. {
  10415. auto res = cli.Get(path);
  10416. ASSERT_TRUE(res) << "Error: " << to_string(res.error());
  10417. EXPECT_EQ("bcdefghijk", res->body);
  10418. EXPECT_EQ(StatusCode::PartialContent_206, res->status);
  10419. }
  10420. {
  10421. auto res = cli.Get(path);
  10422. ASSERT_TRUE(res) << "Error: " << to_string(res.error());
  10423. EXPECT_EQ("bcdefghijk", res->body);
  10424. EXPECT_EQ(StatusCode::PartialContent_206, res->status);
  10425. }
  10426. }
  10427. TEST(ServerDefaultHeadersTest, DefaultHeaders) {
  10428. Server svr;
  10429. svr.set_default_headers({{"Hello", "World"}});
  10430. svr.Get("/", [&](const Request & /*req*/, Response &res) {
  10431. res.set_content("ok", "text/plain");
  10432. });
  10433. auto listen_thread = std::thread([&svr]() { svr.listen("localhost", PORT); });
  10434. auto se = detail::scope_exit([&] {
  10435. svr.stop();
  10436. listen_thread.join();
  10437. ASSERT_FALSE(svr.is_running());
  10438. });
  10439. svr.wait_until_ready();
  10440. Client cli("localhost", PORT);
  10441. auto res = cli.Get("/");
  10442. ASSERT_TRUE(res) << "Error: " << to_string(res.error());
  10443. EXPECT_EQ(StatusCode::OK_200, res->status);
  10444. EXPECT_EQ("ok", res->body);
  10445. EXPECT_EQ("World", res->get_header_value("Hello"));
  10446. }
  10447. #ifdef CPPHTTPLIB_SSL_ENABLED
  10448. TEST(KeepAliveTest, ReadTimeoutSSL) {
  10449. SSLServer svr(SERVER_CERT_FILE, SERVER_PRIVATE_KEY_FILE);
  10450. ASSERT_TRUE(svr.is_valid());
  10451. svr.Get("/a", [&](const Request & /*req*/, Response &res) {
  10452. std::this_thread::sleep_for(std::chrono::seconds(2));
  10453. res.set_content("a", "text/plain");
  10454. });
  10455. svr.Get("/b", [&](const Request & /*req*/, Response &res) {
  10456. res.set_content("b", "text/plain");
  10457. });
  10458. auto listen_thread = std::thread([&svr]() { svr.listen("localhost", PORT); });
  10459. auto se = detail::scope_exit([&] {
  10460. svr.stop();
  10461. listen_thread.join();
  10462. ASSERT_FALSE(svr.is_running());
  10463. });
  10464. svr.wait_until_ready();
  10465. SSLClient cli("localhost", PORT);
  10466. cli.enable_server_certificate_verification(false);
  10467. cli.set_keep_alive(true);
  10468. cli.set_read_timeout(std::chrono::seconds(1));
  10469. auto resa = cli.Get("/a");
  10470. ASSERT_TRUE(!resa);
  10471. EXPECT_EQ(Error::Read, resa.error());
  10472. auto resb = cli.Get("/b");
  10473. ASSERT_TRUE(resb);
  10474. EXPECT_EQ(StatusCode::OK_200, resb->status);
  10475. EXPECT_EQ("b", resb->body);
  10476. }
  10477. // Closing an idle keep-alive connection sends close_notify and returns. The
  10478. // server must not wait for the client's close_notify: an idle client never
  10479. // sends one, so the worker would be held until the read timeout expires, and
  10480. // stop() would wait for it.
  10481. TEST(KeepAliveTest, SSLIdleCloseDoesNotWaitForPeer) {
  10482. SSLServer svr(SERVER_CERT_FILE, SERVER_PRIVATE_KEY_FILE);
  10483. ASSERT_TRUE(svr.is_valid());
  10484. svr.set_keep_alive_timeout(1);
  10485. svr.set_read_timeout(10, 0);
  10486. svr.Get("/", [](const Request &, Response &res) {
  10487. res.set_content("ok", "text/plain");
  10488. });
  10489. auto port = svr.bind_to_any_port(HOST);
  10490. auto listen_thread = std::thread([&svr]() { svr.listen_after_bind(); });
  10491. auto se = detail::scope_exit([&] {
  10492. if (listen_thread.joinable()) {
  10493. svr.stop();
  10494. listen_thread.join();
  10495. }
  10496. });
  10497. svr.wait_until_ready();
  10498. SSLClient cli(HOST, port);
  10499. cli.enable_server_certificate_verification(false);
  10500. cli.set_keep_alive(true);
  10501. auto res = cli.Get("/");
  10502. ASSERT_TRUE(res) << "Error: " << to_string(res.error());
  10503. EXPECT_EQ(StatusCode::OK_200, res->status);
  10504. // Stay idle past the keep-alive timeout so the server closes the connection.
  10505. std::this_thread::sleep_for(std::chrono::milliseconds(1500));
  10506. auto start = std::chrono::steady_clock::now();
  10507. svr.stop();
  10508. listen_thread.join();
  10509. auto elapsed = std::chrono::duration_cast<std::chrono::milliseconds>(
  10510. std::chrono::steady_clock::now() - start)
  10511. .count();
  10512. EXPECT_LT(elapsed, 3000);
  10513. }
  10514. #endif
  10515. class ServerTestWithAI_PASSIVE : public ::testing::Test {
  10516. protected:
  10517. ServerTestWithAI_PASSIVE()
  10518. : cli_(HOST, PORT)
  10519. #ifdef CPPHTTPLIB_SSL_ENABLED
  10520. ,
  10521. svr_(SERVER_CERT_FILE, SERVER_PRIVATE_KEY_FILE)
  10522. #endif
  10523. {
  10524. #ifdef CPPHTTPLIB_SSL_ENABLED
  10525. cli_.enable_server_certificate_verification(false);
  10526. #endif
  10527. }
  10528. virtual void SetUp() {
  10529. svr_.Get("/hi", [&](const Request & /*req*/, Response &res) {
  10530. res.set_content("Hello World!", "text/plain");
  10531. });
  10532. t_ = thread(
  10533. [&]() { ASSERT_TRUE(svr_.listen(std::string(), PORT, AI_PASSIVE)); });
  10534. svr_.wait_until_ready();
  10535. }
  10536. virtual void TearDown() {
  10537. svr_.stop();
  10538. t_.join();
  10539. }
  10540. #ifdef CPPHTTPLIB_SSL_ENABLED
  10541. SSLClient cli_;
  10542. SSLServer svr_;
  10543. #else
  10544. Client cli_;
  10545. Server svr_;
  10546. #endif
  10547. thread t_;
  10548. };
  10549. TEST_F(ServerTestWithAI_PASSIVE, GetMethod200) {
  10550. auto res = cli_.Get("/hi");
  10551. ASSERT_TRUE(res) << "Error: " << to_string(res.error());
  10552. EXPECT_EQ(StatusCode::OK_200, res->status);
  10553. EXPECT_EQ("text/plain", res->get_header_value("Content-Type"));
  10554. EXPECT_EQ("Hello World!", res->body);
  10555. }
  10556. class ServerUpDownTest : public ::testing::Test {
  10557. protected:
  10558. ServerUpDownTest() : cli_(HOST, PORT) {}
  10559. virtual void SetUp() {
  10560. t_ = thread([&]() {
  10561. svr_.bind_to_any_port(HOST);
  10562. std::this_thread::sleep_for(std::chrono::milliseconds(500));
  10563. ASSERT_TRUE(svr_.listen_after_bind());
  10564. });
  10565. svr_.wait_until_ready();
  10566. }
  10567. virtual void TearDown() {
  10568. svr_.stop();
  10569. t_.join();
  10570. }
  10571. Client cli_;
  10572. Server svr_;
  10573. thread t_;
  10574. };
  10575. TEST_F(ServerUpDownTest, QuickStartStop) {
  10576. // Should not crash, especially when run with
  10577. // --gtest_filter=ServerUpDownTest.QuickStartStop --gtest_repeat=1000
  10578. }
  10579. class PayloadMaxLengthTest : public ::testing::Test {
  10580. protected:
  10581. PayloadMaxLengthTest()
  10582. : cli_(HOST, PORT)
  10583. #ifdef CPPHTTPLIB_SSL_ENABLED
  10584. ,
  10585. svr_(SERVER_CERT_FILE, SERVER_PRIVATE_KEY_FILE)
  10586. #endif
  10587. {
  10588. #ifdef CPPHTTPLIB_SSL_ENABLED
  10589. cli_.enable_server_certificate_verification(false);
  10590. #endif
  10591. }
  10592. virtual void SetUp() {
  10593. svr_.set_payload_max_length(8);
  10594. svr_.Post("/test", [&](const Request & /*req*/, Response &res) {
  10595. res.set_content("test", "text/plain");
  10596. });
  10597. t_ = thread([&]() { ASSERT_TRUE(svr_.listen(HOST, PORT)); });
  10598. svr_.wait_until_ready();
  10599. }
  10600. virtual void TearDown() {
  10601. svr_.stop();
  10602. t_.join();
  10603. }
  10604. #ifdef CPPHTTPLIB_SSL_ENABLED
  10605. SSLClient cli_;
  10606. SSLServer svr_;
  10607. #else
  10608. Client cli_;
  10609. Server svr_;
  10610. #endif
  10611. thread t_;
  10612. };
  10613. TEST_F(PayloadMaxLengthTest, ExceedLimit) {
  10614. auto res = cli_.Post("/test", "123456789", "text/plain");
  10615. ASSERT_TRUE(res) << "Error: " << to_string(res.error());
  10616. EXPECT_EQ(StatusCode::PayloadTooLarge_413, res->status);
  10617. res = cli_.Post("/test", "12345678", "text/plain");
  10618. ASSERT_TRUE(res) << "Error: " << to_string(res.error());
  10619. EXPECT_EQ(StatusCode::OK_200, res->status);
  10620. }
  10621. TEST_F(PayloadMaxLengthTest, ChunkedEncodingSecurityTest) {
  10622. // Test chunked encoding with payload exceeding the 8-byte limit
  10623. std::string large_chunked_data(16, 'A'); // 16 bytes, exceeds 8-byte limit
  10624. auto res = cli_.Post("/test", large_chunked_data, "text/plain");
  10625. ASSERT_TRUE(res) << "Error: " << to_string(res.error());
  10626. EXPECT_EQ(StatusCode::PayloadTooLarge_413, res->status);
  10627. }
  10628. TEST_F(PayloadMaxLengthTest, ChunkedEncodingWithinLimit) {
  10629. // Test chunked encoding with payload within the 8-byte limit
  10630. std::string small_chunked_data(4, 'B'); // 4 bytes, within 8-byte limit
  10631. auto res = cli_.Post("/test", small_chunked_data, "text/plain");
  10632. ASSERT_TRUE(res) << "Error: " << to_string(res.error());
  10633. EXPECT_EQ(StatusCode::OK_200, res->status);
  10634. }
  10635. TEST_F(PayloadMaxLengthTest, RawSocketChunkedTest) {
  10636. // Test using send_request to send chunked data exceeding payload limit
  10637. std::string chunked_request = "POST /test HTTP/1.1\r\n"
  10638. "Host: " +
  10639. std::string(HOST) + ":" + std::to_string(PORT) +
  10640. "\r\n"
  10641. "Transfer-Encoding: chunked\r\n"
  10642. "Connection: close\r\n"
  10643. "\r\n"
  10644. "a\r\n" // 10 bytes chunk (exceeds 8-byte limit)
  10645. "0123456789\r\n"
  10646. "0\r\n" // End chunk
  10647. "\r\n";
  10648. std::string response;
  10649. bool result = send_request(1, chunked_request, &response);
  10650. if (!result) {
  10651. // If send_request fails, it might be because the server closed the
  10652. // connection due to payload limit enforcement, which is acceptable
  10653. SUCCEED()
  10654. << "Server rejected oversized chunked request (connection closed)";
  10655. } else {
  10656. // If we got a response, check if it's an error response or connection was
  10657. // closed early Short response length indicates connection was closed due to
  10658. // payload limit
  10659. if (response.length() <= 10) {
  10660. SUCCEED() << "Server closed connection for oversized chunked request";
  10661. } else {
  10662. // Check for error status codes
  10663. EXPECT_TRUE(response.find("413") != std::string::npos ||
  10664. response.find("Payload Too Large") != std::string::npos ||
  10665. response.find("400") != std::string::npos);
  10666. }
  10667. }
  10668. }
  10669. TEST_F(PayloadMaxLengthTest, NoContentLengthPayloadLimit) {
  10670. // Test request without Content-Length header exceeding payload limit
  10671. std::string request_without_content_length = "POST /test HTTP/1.1\r\n"
  10672. "Host: " +
  10673. std::string(HOST) + ":" +
  10674. std::to_string(PORT) +
  10675. "\r\n"
  10676. "Connection: close\r\n"
  10677. "\r\n";
  10678. // Add payload exceeding the 8-byte limit
  10679. std::string large_payload(16, 'X'); // 16 bytes, exceeds 8-byte limit
  10680. request_without_content_length += large_payload;
  10681. std::string response;
  10682. bool result = send_request(1, request_without_content_length, &response);
  10683. if (!result) {
  10684. // If send_request fails, server likely closed connection due to payload
  10685. // limit
  10686. SUCCEED() << "Server rejected oversized request without Content-Length "
  10687. "(connection closed)";
  10688. } else {
  10689. // Check if server responded with error or closed connection early
  10690. if (response.length() <= 10) {
  10691. SUCCEED() << "Server closed connection for oversized request without "
  10692. "Content-Length";
  10693. } else {
  10694. // Check for error status codes
  10695. EXPECT_TRUE(response.find("413") != std::string::npos ||
  10696. response.find("Payload Too Large") != std::string::npos ||
  10697. response.find("400") != std::string::npos);
  10698. }
  10699. }
  10700. }
  10701. TEST_F(PayloadMaxLengthTest, NoContentLengthWithinLimit) {
  10702. // Test request without Content-Length header within payload limit
  10703. std::string request_without_content_length = "POST /test HTTP/1.1\r\n"
  10704. "Host: " +
  10705. std::string(HOST) + ":" +
  10706. std::to_string(PORT) +
  10707. "\r\n"
  10708. "Connection: close\r\n"
  10709. "\r\n";
  10710. // Add payload within the 8-byte limit
  10711. std::string small_payload(4, 'Y'); // 4 bytes, within 8-byte limit
  10712. request_without_content_length += small_payload;
  10713. std::string response;
  10714. bool result = send_request(1, request_without_content_length, &response);
  10715. // For requests without Content-Length, the server may have different behavior
  10716. // The key is that it should not reject due to payload limit for small
  10717. // payloads
  10718. if (result) {
  10719. // Check for any HTTP response (success or error, but not connection closed)
  10720. if (response.length() > 10) {
  10721. SUCCEED()
  10722. << "Server processed request without Content-Length within limit";
  10723. } else {
  10724. // Short response might indicate connection closed, which is acceptable
  10725. SUCCEED() << "Server closed connection for request without "
  10726. "Content-Length (acceptable behavior)";
  10727. }
  10728. } else {
  10729. // Connection failure might be due to protocol requirements
  10730. SUCCEED() << "Connection issue with request without Content-Length "
  10731. "(environment-specific)";
  10732. }
  10733. }
  10734. class LargePayloadMaxLengthTest : public ::testing::Test {
  10735. protected:
  10736. LargePayloadMaxLengthTest()
  10737. : cli_(HOST, PORT)
  10738. #ifdef CPPHTTPLIB_SSL_ENABLED
  10739. ,
  10740. svr_(SERVER_CERT_FILE, SERVER_PRIVATE_KEY_FILE)
  10741. #endif
  10742. {
  10743. #ifdef CPPHTTPLIB_SSL_ENABLED
  10744. cli_.enable_server_certificate_verification(false);
  10745. #endif
  10746. }
  10747. virtual void SetUp() {
  10748. // Set 10MB payload limit
  10749. const size_t LARGE_PAYLOAD_LIMIT = 10 * 1024 * 1024; // 10MB
  10750. svr_.set_payload_max_length(LARGE_PAYLOAD_LIMIT);
  10751. svr_.Post("/test", [&](const Request & /*req*/, Response &res) {
  10752. res.set_content("Large payload test", "text/plain");
  10753. });
  10754. t_ = thread([&]() { ASSERT_TRUE(svr_.listen(HOST, PORT)); });
  10755. svr_.wait_until_ready();
  10756. }
  10757. virtual void TearDown() {
  10758. svr_.stop();
  10759. t_.join();
  10760. }
  10761. #ifdef CPPHTTPLIB_SSL_ENABLED
  10762. SSLClient cli_;
  10763. SSLServer svr_;
  10764. #else
  10765. Client cli_;
  10766. Server svr_;
  10767. #endif
  10768. thread t_;
  10769. };
  10770. TEST_F(LargePayloadMaxLengthTest, ChunkedEncodingWithin10MB) {
  10771. // Test chunked encoding with payload within 10MB limit
  10772. std::string medium_payload(5 * 1024 * 1024,
  10773. 'A'); // 5MB payload, within 10MB limit
  10774. auto res = cli_.Post("/test", medium_payload, "application/octet-stream");
  10775. ASSERT_TRUE(res) << "Error: " << to_string(res.error());
  10776. EXPECT_EQ(StatusCode::OK_200, res->status);
  10777. }
  10778. TEST_F(LargePayloadMaxLengthTest, ChunkedEncodingExceeds10MB) {
  10779. // Test chunked encoding with payload exceeding 10MB limit
  10780. std::string large_payload(12 * 1024 * 1024,
  10781. 'B'); // 12MB payload, exceeds 10MB limit
  10782. auto res = cli_.Post("/test", large_payload, "application/octet-stream");
  10783. // Server may either return 413 or close the connection
  10784. if (res) {
  10785. EXPECT_EQ(StatusCode::PayloadTooLarge_413, res->status);
  10786. } else {
  10787. SUCCEED() << "Server closed connection for payload exceeding 10MB limit";
  10788. }
  10789. }
  10790. TEST_F(LargePayloadMaxLengthTest, NoContentLengthWithin10MB) {
  10791. // Test request without Content-Length header within 10MB limit
  10792. std::string request_without_content_length = "POST /test HTTP/1.1\r\n"
  10793. "Host: " +
  10794. std::string(HOST) + ":" +
  10795. std::to_string(PORT) +
  10796. "\r\n"
  10797. "Connection: close\r\n"
  10798. "\r\n";
  10799. // Add 1MB payload (within 10MB limit)
  10800. std::string medium_payload(1024 * 1024, 'C'); // 1MB payload
  10801. request_without_content_length += medium_payload;
  10802. std::string response;
  10803. bool result = send_request(5, request_without_content_length, &response);
  10804. if (result) {
  10805. // Should get a proper HTTP response for payloads within limit
  10806. if (response.length() > 10) {
  10807. SUCCEED() << "Server processed 1MB request without Content-Length within "
  10808. "10MB limit";
  10809. } else {
  10810. SUCCEED() << "Server closed connection (acceptable behavior for no "
  10811. "Content-Length)";
  10812. }
  10813. } else {
  10814. SUCCEED() << "Connection issue with 1MB payload (environment-specific)";
  10815. }
  10816. }
  10817. TEST_F(LargePayloadMaxLengthTest, NoContentLengthExceeds10MB) {
  10818. // Test request without Content-Length header exceeding 10MB limit
  10819. std::string request_without_content_length = "POST /test HTTP/1.1\r\n"
  10820. "Host: " +
  10821. std::string(HOST) + ":" +
  10822. std::to_string(PORT) +
  10823. "\r\n"
  10824. "Connection: close\r\n"
  10825. "\r\n";
  10826. // Add 12MB payload (exceeds 10MB limit)
  10827. std::string large_payload(12 * 1024 * 1024, 'D'); // 12MB payload
  10828. request_without_content_length += large_payload;
  10829. std::string response;
  10830. bool result = send_request(10, request_without_content_length, &response);
  10831. if (!result) {
  10832. // Server should close connection due to payload limit
  10833. SUCCEED() << "Server rejected 12MB request without Content-Length "
  10834. "(connection closed)";
  10835. } else {
  10836. // Check for error response
  10837. if (response.length() <= 10) {
  10838. SUCCEED()
  10839. << "Server closed connection for 12MB request exceeding 10MB limit";
  10840. } else {
  10841. EXPECT_TRUE(response.find("413") != std::string::npos ||
  10842. response.find("Payload Too Large") != std::string::npos ||
  10843. response.find("400") != std::string::npos);
  10844. }
  10845. }
  10846. }
  10847. #ifdef CPPHTTPLIB_ZLIB_SUPPORT
  10848. // `payload_max_length` is not enforced on decompressed body in ContentReader
  10849. // path.
  10850. TEST(PayloadLimitBypassTest, StreamingGzipDecompression) {
  10851. Server svr;
  10852. const size_t LIMIT = 64 * 1024; // 64KB
  10853. svr.set_payload_max_length(LIMIT);
  10854. size_t total = 0;
  10855. svr.Post("/stream", [&](const Request & /*req*/, Response &res,
  10856. const ContentReader &content_reader) {
  10857. content_reader([&](const char * /*data*/, size_t len) {
  10858. total += len;
  10859. return true;
  10860. });
  10861. res.status = 200;
  10862. res.set_content("stream_ok", "text/plain");
  10863. });
  10864. auto thread = std::thread([&]() { svr.listen(HOST, PORT); });
  10865. auto se = detail::scope_exit([&] {
  10866. svr.stop();
  10867. thread.join();
  10868. ASSERT_FALSE(svr.is_running());
  10869. });
  10870. svr.wait_until_ready();
  10871. // Prepare 256KB raw data and gzip-compress it
  10872. std::string raw(256 * 1024, 'A');
  10873. std::string gz;
  10874. {
  10875. z_stream zs{};
  10876. deflateInit2(&zs, Z_BEST_COMPRESSION, Z_DEFLATED, 15 + 16, 8,
  10877. Z_DEFAULT_STRATEGY);
  10878. zs.next_in = reinterpret_cast<Bytef *>(const_cast<char *>(raw.data()));
  10879. zs.avail_in = static_cast<uInt>(raw.size());
  10880. char outbuf[4096];
  10881. int ret;
  10882. do {
  10883. zs.next_out = reinterpret_cast<Bytef *>(outbuf);
  10884. zs.avail_out = sizeof(outbuf);
  10885. ret = deflate(&zs, Z_FINISH);
  10886. gz.append(outbuf, sizeof(outbuf) - zs.avail_out);
  10887. } while (ret != Z_STREAM_END);
  10888. deflateEnd(&zs);
  10889. }
  10890. Client cli(HOST, PORT);
  10891. cli.set_connection_timeout(std::chrono::seconds(5));
  10892. Headers headers = {{"Content-Encoding", "gzip"}};
  10893. auto res = cli.Post("/stream", headers, gz.data(), gz.size(),
  10894. "application/octet-stream");
  10895. ASSERT_TRUE(res) << "Error: " << to_string(res.error());
  10896. // Server must reject oversized decompressed payloads with 413.
  10897. EXPECT_EQ(StatusCode::PayloadTooLarge_413, res->status);
  10898. // Decompressed bytes delivered to the handler must not exceed LIMIT.
  10899. EXPECT_LE(total, LIMIT);
  10900. }
  10901. #ifndef CPPHTTPLIB_SSL_ENABLED
  10902. // For a request with neither Content-Length nor Transfer-Encoding, the
  10903. // non-SSL raw-socket fallback in read_content_core() used to hand the
  10904. // compressed wire bytes straight to the ContentReader without ever routing
  10905. // them through the decompressor, so payload_max_length_ only bounded the
  10906. // compressed size on the wire, not the decompressed size.
  10907. TEST(PayloadLimitBypassTest, UnframedGzipDecompression) {
  10908. Server svr;
  10909. const size_t LIMIT = 64 * 1024; // 64KB
  10910. svr.set_payload_max_length(LIMIT);
  10911. size_t total = 0;
  10912. svr.Post("/stream", [&](const Request & /*req*/, Response &res,
  10913. const ContentReader &content_reader) {
  10914. content_reader([&](const char * /*data*/, size_t len) {
  10915. total += len;
  10916. return true;
  10917. });
  10918. res.status = 200;
  10919. res.set_content("stream_ok", "text/plain");
  10920. });
  10921. auto port = svr.bind_to_any_port(HOST);
  10922. auto thread = std::thread([&]() { svr.listen_after_bind(); });
  10923. auto se = detail::scope_exit([&] {
  10924. svr.stop();
  10925. thread.join();
  10926. ASSERT_FALSE(svr.is_running());
  10927. });
  10928. svr.wait_until_ready();
  10929. // Prepare 256KB raw data and gzip-compress it, same payload as the
  10930. // StreamingGzipDecompression test above.
  10931. std::string raw(256 * 1024, 'A');
  10932. std::string gz;
  10933. {
  10934. httplib::detail::gzip_compressor compressor;
  10935. bool result = compressor.compress(raw.data(), raw.size(), /*last=*/true,
  10936. [&](const char *chunk, size_t len) {
  10937. gz.append(chunk, len);
  10938. return true;
  10939. });
  10940. ASSERT_TRUE(result);
  10941. }
  10942. // Send the gzip body over raw TCP with neither Content-Length nor
  10943. // Transfer-Encoding, and Connection: close so the server's stray-body scan
  10944. // kicks in.
  10945. std::string req = "POST /stream HTTP/1.1\r\n"
  10946. "Host: " +
  10947. std::string(HOST) + ":" + std::to_string(port) +
  10948. "\r\n"
  10949. "Content-Encoding: gzip\r\n"
  10950. "Connection: close\r\n"
  10951. "\r\n" +
  10952. gz;
  10953. std::string response;
  10954. ASSERT_TRUE(send_request(5, req, &response, port));
  10955. // Decompressed bytes delivered to the handler must not exceed LIMIT.
  10956. EXPECT_LE(total, LIMIT);
  10957. }
  10958. #endif
  10959. #endif
  10960. // Some servers misuse Content-Encoding to advertise a character set, e.g.
  10961. // `Content-Encoding: UTF-8` on a JPEG. Such a value is not a content coding, so
  10962. // the payload must be passed through untouched instead of being rejected.
  10963. TEST(ContentEncodingTest, UnknownEncodingIsPassedThrough) {
  10964. const std::string body = "\xff\xd8\xff\xe0 not really a jpeg";
  10965. Server svr;
  10966. svr.Get("/image", [&](const Request & /*req*/, Response &res) {
  10967. res.set_content(body, "image/jpeg");
  10968. res.set_header("Content-Encoding", "UTF-8");
  10969. });
  10970. svr.Get("/identity", [&](const Request & /*req*/, Response &res) {
  10971. res.set_content(body, "image/jpeg");
  10972. res.set_header("Content-Encoding", "identity");
  10973. });
  10974. svr.Post("/echo", [](const Request &req, Response &res) {
  10975. res.set_content(req.body, "image/jpeg");
  10976. });
  10977. thread t = thread([&]() { svr.listen(HOST, PORT); });
  10978. auto se = detail::scope_exit([&] {
  10979. svr.stop();
  10980. t.join();
  10981. ASSERT_FALSE(svr.is_running());
  10982. });
  10983. svr.wait_until_ready();
  10984. Client cli(HOST, PORT);
  10985. {
  10986. auto res = cli.Get("/image");
  10987. ASSERT_TRUE(res) << "Error: " << to_string(res.error());
  10988. EXPECT_EQ(StatusCode::OK_200, res->status);
  10989. EXPECT_EQ(body, res->body);
  10990. }
  10991. {
  10992. auto res = cli.Get("/identity");
  10993. ASSERT_TRUE(res) << "Error: " << to_string(res.error());
  10994. EXPECT_EQ(StatusCode::OK_200, res->status);
  10995. EXPECT_EQ(body, res->body);
  10996. }
  10997. {
  10998. // The same applies to a request body reaching the server.
  10999. Headers headers = {{"Content-Encoding", "UTF-8"}};
  11000. auto res = cli.Post("/echo", headers, body, "image/jpeg");
  11001. ASSERT_TRUE(res) << "Error: " << to_string(res.error());
  11002. EXPECT_EQ(StatusCode::OK_200, res->status);
  11003. EXPECT_EQ(body, res->body);
  11004. }
  11005. }
  11006. // "Hello World!" as gzip. Hard-coded so that the test below can serve a
  11007. // gzip-encoded response even when the build has no zlib support.
  11008. static const char GZIPPED_HELLO_WORLD[] = {
  11009. '\x1f', '\x8b', '\x08', '\x00', '\x00', '\x00', '\x00', '\x00',
  11010. '\x02', '\x03', '\xf3', '\x48', '\xcd', '\xc9', '\xc9', '\x57',
  11011. '\x08', '\xcf', '\x2f', '\xca', '\x49', '\x51', '\x04', '\x00',
  11012. '\xa3', '\x1c', '\x29', '\x1c', '\x0c', '\x00', '\x00', '\x00'};
  11013. // A content coding is a whole token, not something the field value merely
  11014. // contains. Matching "br" and "zstd" as substrings made unrelated values such
  11015. // as "fibre" look like Brotli, and turned a multi-coding value like
  11016. // "gzip, br" into a Brotli-labeled body, so a decompressor was run over data
  11017. // it was never meant to see.
  11018. TEST(ContentEncodingTest, SubstringOfACodingIsNotTheCoding) {
  11019. const std::string body = "\xff\xd8\xff\xe0 not really a jpeg";
  11020. Server svr;
  11021. svr.Get("/fibre", [&](const Request & /*req*/, Response &res) {
  11022. res.set_content(body, "image/jpeg");
  11023. res.set_header("Content-Encoding", "fibre");
  11024. });
  11025. svr.Get("/multi", [&](const Request & /*req*/, Response &res) {
  11026. res.set_content(body, "image/jpeg");
  11027. res.set_header("Content-Encoding", "gzip, br");
  11028. });
  11029. svr.Get("/zstdish", [&](const Request & /*req*/, Response &res) {
  11030. res.set_content(body, "image/jpeg");
  11031. res.set_header("Content-Encoding", "x-zstd-ish");
  11032. });
  11033. auto port = svr.bind_to_any_port(HOST);
  11034. thread t = thread([&]() { svr.listen_after_bind(); });
  11035. auto se = detail::scope_exit([&] {
  11036. svr.stop();
  11037. t.join();
  11038. ASSERT_FALSE(svr.is_running());
  11039. });
  11040. svr.wait_until_ready();
  11041. Client cli(HOST, port);
  11042. for (const char *path : {"/fibre", "/multi", "/zstdish"}) {
  11043. auto res = cli.Get(path);
  11044. ASSERT_TRUE(res) << path << " -> " << to_string(res.error());
  11045. EXPECT_EQ(StatusCode::OK_200, res->status) << path;
  11046. // Not a coding we recognize, so the payload comes back untouched
  11047. EXPECT_EQ(body, res->body) << path;
  11048. }
  11049. }
  11050. // A content coding cpp-httplib recognizes but was not built with must be
  11051. // reported as such. Handing the still-compressed payload back to the caller
  11052. // would silently corrupt it.
  11053. TEST(ContentEncodingTest, KnownEncodingWithoutSupportIsReported) {
  11054. const std::string gzipped(GZIPPED_HELLO_WORLD, sizeof(GZIPPED_HELLO_WORLD));
  11055. Server svr;
  11056. // "image/jpeg" keeps the server from applying a content coding of its own,
  11057. // so the hand-crafted Content-Encoding below survives.
  11058. svr.Get("/gzipped", [&](const Request & /*req*/, Response &res) {
  11059. res.set_content(gzipped, "image/jpeg");
  11060. res.set_header("Content-Encoding", "gzip");
  11061. });
  11062. // Content codings are case-insensitive (RFC 9110 8.4.1).
  11063. svr.Get("/gzipped-uppercase", [&](const Request & /*req*/, Response &res) {
  11064. res.set_content(gzipped, "image/jpeg");
  11065. res.set_header("Content-Encoding", "GZIP");
  11066. });
  11067. thread t = thread([&]() { svr.listen(HOST, PORT); });
  11068. auto se = detail::scope_exit([&] {
  11069. svr.stop();
  11070. t.join();
  11071. ASSERT_FALSE(svr.is_running());
  11072. });
  11073. svr.wait_until_ready();
  11074. Client cli(HOST, PORT);
  11075. {
  11076. auto res = cli.Get("/gzipped");
  11077. #ifdef CPPHTTPLIB_ZLIB_SUPPORT
  11078. ASSERT_TRUE(res) << "Error: " << to_string(res.error());
  11079. EXPECT_EQ("Hello World!", res->body);
  11080. #else
  11081. ASSERT_FALSE(res);
  11082. EXPECT_EQ(Error::UnsupportedContentEncoding, res.error());
  11083. #endif
  11084. }
  11085. {
  11086. // open_stream() must behave the same way.
  11087. auto handle = cli.open_stream("GET", "/gzipped");
  11088. #ifdef CPPHTTPLIB_ZLIB_SUPPORT
  11089. ASSERT_TRUE(handle.is_valid());
  11090. std::string received;
  11091. char buf[256];
  11092. ssize_t n;
  11093. while ((n = handle.read(buf, sizeof(buf))) > 0) {
  11094. received.append(buf, static_cast<size_t>(n));
  11095. }
  11096. EXPECT_EQ("Hello World!", received);
  11097. #else
  11098. EXPECT_FALSE(handle.is_valid());
  11099. EXPECT_EQ(Error::UnsupportedContentEncoding, handle.error);
  11100. #endif
  11101. }
  11102. {
  11103. // A differently-cased coding must not be mistaken for an unknown one, or
  11104. // the body would be handed back still compressed.
  11105. auto res = cli.Get("/gzipped-uppercase");
  11106. #ifdef CPPHTTPLIB_ZLIB_SUPPORT
  11107. ASSERT_TRUE(res) << "Error: " << to_string(res.error());
  11108. EXPECT_EQ("Hello World!", res->body);
  11109. #else
  11110. ASSERT_FALSE(res);
  11111. EXPECT_EQ(Error::UnsupportedContentEncoding, res.error());
  11112. #endif
  11113. }
  11114. }
  11115. #ifdef CPPHTTPLIB_ZLIB_SUPPORT
  11116. // A handler serving pre-compressed content (e.g. build-time gzipped static
  11117. // assets) sets Content-Encoding itself. The server used to pick a coding from
  11118. // Accept-Encoding and the content type alone, gzipping the already-gzipped
  11119. // body a second time and appending a second Content-Encoding field line, so
  11120. // clients that decode one coding per listed value handed back raw gzip bytes.
  11121. TEST(ContentEncodingTest, PreEncodedResponseIsNotCompressedAgain) {
  11122. const std::string gzipped(GZIPPED_HELLO_WORLD, sizeof(GZIPPED_HELLO_WORLD));
  11123. Server svr;
  11124. // text/plain is a compressible type, so only the pre-set Content-Encoding
  11125. // keeps the server from applying a coding of its own.
  11126. svr.Get("/pre-gzipped", [&](const Request & /*req*/, Response &res) {
  11127. res.set_content(gzipped, "text/plain");
  11128. res.set_header("Content-Encoding", "gzip");
  11129. });
  11130. auto port = svr.bind_to_any_port(HOST);
  11131. thread t = thread([&]() { svr.listen_after_bind(); });
  11132. auto se = detail::scope_exit([&] {
  11133. svr.stop();
  11134. t.join();
  11135. ASSERT_FALSE(svr.is_running());
  11136. });
  11137. svr.wait_until_ready();
  11138. Client cli(HOST, port);
  11139. Headers headers = {{"Accept-Encoding", "gzip"}};
  11140. auto res = cli.Get("/pre-gzipped", headers);
  11141. ASSERT_TRUE(res) << "Error: " << to_string(res.error());
  11142. EXPECT_EQ(StatusCode::OK_200, res->status);
  11143. EXPECT_EQ(1U, res->get_header_value_count("Content-Encoding"));
  11144. EXPECT_EQ("Hello World!", res->body);
  11145. }
  11146. // A chunked provider settles its coding where the headers are written and
  11147. // reuses it at write time. Both ends of that have to hold: a handler's own
  11148. // Content-Encoding suppresses the coding, and a response without one is still
  11149. // compressed as it always was.
  11150. TEST(ContentEncodingTest, PreEncodedChunkedResponseIsNotCompressedAgain) {
  11151. const std::string gzipped(GZIPPED_HELLO_WORLD, sizeof(GZIPPED_HELLO_WORLD));
  11152. const std::string plain = "Hello World! Hello World! Hello World!";
  11153. Server svr;
  11154. svr.Get("/pre-gzipped", [&](const Request & /*req*/, Response &res) {
  11155. res.set_header("Content-Encoding", "gzip");
  11156. res.set_chunked_content_provider(
  11157. "text/plain", [gzipped](size_t /*offset*/, DataSink &sink) {
  11158. sink.write(gzipped.data(), gzipped.size());
  11159. sink.done();
  11160. return true;
  11161. });
  11162. });
  11163. svr.Get("/negotiated", [&](const Request & /*req*/, Response &res) {
  11164. res.set_chunked_content_provider(
  11165. "text/plain", [plain](size_t /*offset*/, DataSink &sink) {
  11166. sink.write(plain.data(), plain.size());
  11167. sink.done();
  11168. return true;
  11169. });
  11170. });
  11171. auto port = svr.bind_to_any_port(HOST);
  11172. thread t = thread([&]() { svr.listen_after_bind(); });
  11173. auto se = detail::scope_exit([&] {
  11174. svr.stop();
  11175. t.join();
  11176. ASSERT_FALSE(svr.is_running());
  11177. });
  11178. svr.wait_until_ready();
  11179. Client cli(HOST, port);
  11180. Headers headers = {{"Accept-Encoding", "gzip"}};
  11181. {
  11182. auto res = cli.Get("/pre-gzipped", headers);
  11183. ASSERT_TRUE(res) << "Error: " << to_string(res.error());
  11184. EXPECT_EQ(StatusCode::OK_200, res->status);
  11185. EXPECT_EQ(1U, res->get_header_value_count("Content-Encoding"));
  11186. EXPECT_EQ("Hello World!", res->body);
  11187. }
  11188. {
  11189. auto res = cli.Get("/negotiated", headers);
  11190. ASSERT_TRUE(res) << "Error: " << to_string(res.error());
  11191. EXPECT_EQ(StatusCode::OK_200, res->status);
  11192. EXPECT_EQ("gzip", res->get_header_value("Content-Encoding"));
  11193. EXPECT_EQ(plain, res->body);
  11194. }
  11195. }
  11196. #endif
  11197. // RFC 9110 Section 5.3: a Content-Encoding split over several field lines is
  11198. // the same message as the comma-joined one, so both have to be read the same
  11199. // way. Reading only the first line made "gzip" followed by "gzip" look like a
  11200. // single gzip coding, and a body the sender says was encoded twice was handed
  11201. // back after one pass, still compressed but presented as decoded.
  11202. TEST(ContentEncodingTest, DuplicateFieldLinesAreTheSameAsTheJoinedValue) {
  11203. const std::string body = "\xff\xd8\xff\xe0 not really a jpeg";
  11204. Server svr;
  11205. svr.Get("/split", [&](const Request & /*req*/, Response &res) {
  11206. res.set_content(body, "image/jpeg");
  11207. res.headers.emplace("Content-Encoding", "gzip");
  11208. res.headers.emplace("Content-Encoding", "gzip");
  11209. });
  11210. svr.Get("/joined", [&](const Request & /*req*/, Response &res) {
  11211. res.set_content(body, "image/jpeg");
  11212. res.set_header("Content-Encoding", "gzip, gzip");
  11213. });
  11214. auto port = svr.bind_to_any_port(HOST);
  11215. thread t = thread([&]() { svr.listen_after_bind(); });
  11216. auto se = detail::scope_exit([&] {
  11217. svr.stop();
  11218. t.join();
  11219. ASSERT_FALSE(svr.is_running());
  11220. });
  11221. svr.wait_until_ready();
  11222. Client cli(HOST, port);
  11223. // Two codings is not something cpp-httplib decodes, so both representations
  11224. // take the pass-through path rather than one of them being gunzipped once.
  11225. for (const char *path : {"/split", "/joined"}) {
  11226. auto res = cli.Get(path);
  11227. ASSERT_TRUE(res) << path << " -> " << to_string(res.error());
  11228. EXPECT_EQ(StatusCode::OK_200, res->status) << path;
  11229. EXPECT_EQ(body, res->body) << path;
  11230. }
  11231. }
  11232. // Regression test for DoS vulnerability: a malicious server sending a response
  11233. // without Content-Length header must not cause unbounded memory consumption on
  11234. // the client side. The client should stop reading after a reasonable limit,
  11235. // similar to the server-side set_payload_max_length protection.
  11236. TEST(ClientVulnerabilityTest, UnboundedReadWithoutContentLength) {
  11237. constexpr size_t CLIENT_READ_LIMIT = 2 * 1024 * 1024; // 2MB safety limit
  11238. #ifndef _WIN32
  11239. signal(SIGPIPE, SIG_IGN);
  11240. #endif
  11241. auto server_thread = std::thread([] {
  11242. constexpr size_t MALICIOUS_DATA_SIZE = 10 * 1024 * 1024; // 10MB from server
  11243. auto srv = ::socket(AF_INET, SOCK_STREAM, 0);
  11244. default_socket_options(srv);
  11245. detail::set_socket_opt_time(srv, SOL_SOCKET, SO_RCVTIMEO, 5, 0);
  11246. detail::set_socket_opt_time(srv, SOL_SOCKET, SO_SNDTIMEO, 5, 0);
  11247. sockaddr_in addr{};
  11248. addr.sin_family = AF_INET;
  11249. addr.sin_port = htons(static_cast<uint16_t>(PORT + 2));
  11250. ::inet_pton(AF_INET, "127.0.0.1", &addr.sin_addr);
  11251. int opt = 1;
  11252. ::setsockopt(srv, SOL_SOCKET, SO_REUSEADDR,
  11253. #ifdef _WIN32
  11254. reinterpret_cast<const char *>(&opt),
  11255. #else
  11256. &opt,
  11257. #endif
  11258. sizeof(opt));
  11259. ::bind(srv, reinterpret_cast<sockaddr *>(&addr), sizeof(addr));
  11260. ::listen(srv, 1);
  11261. sockaddr_in cli_addr{};
  11262. socklen_t cli_len = sizeof(cli_addr);
  11263. auto cli = ::accept(srv, reinterpret_cast<sockaddr *>(&cli_addr), &cli_len);
  11264. if (cli != INVALID_SOCKET) {
  11265. char buf[4096];
  11266. ::recv(cli, buf, sizeof(buf), 0);
  11267. // Malicious response: no Content-Length, no chunked encoding
  11268. std::string response_header = "HTTP/1.1 200 OK\r\n"
  11269. "Connection: close\r\n"
  11270. "\r\n";
  11271. ::send(cli,
  11272. #ifdef _WIN32
  11273. static_cast<const char *>(response_header.c_str()),
  11274. static_cast<int>(response_header.size()),
  11275. #else
  11276. response_header.c_str(), response_header.size(),
  11277. #endif
  11278. 0);
  11279. // Send 10MB of data
  11280. std::string chunk(64 * 1024, 'A');
  11281. size_t total_sent = 0;
  11282. while (total_sent < MALICIOUS_DATA_SIZE) {
  11283. auto to_send = std::min(chunk.size(), MALICIOUS_DATA_SIZE - total_sent);
  11284. auto sent = ::send(cli,
  11285. #ifdef _WIN32
  11286. static_cast<const char *>(chunk.c_str()),
  11287. static_cast<int>(to_send),
  11288. #else
  11289. chunk.c_str(), to_send,
  11290. #endif
  11291. 0);
  11292. if (sent <= 0) break;
  11293. total_sent += static_cast<size_t>(sent);
  11294. }
  11295. detail::close_socket(cli);
  11296. }
  11297. detail::close_socket(srv);
  11298. });
  11299. std::this_thread::sleep_for(std::chrono::milliseconds(200));
  11300. size_t total_read = 0;
  11301. {
  11302. Client cli("127.0.0.1", PORT + 2);
  11303. cli.set_read_timeout(5, 0);
  11304. cli.set_payload_max_length(CLIENT_READ_LIMIT);
  11305. auto stream = cli.open_stream("GET", "/malicious");
  11306. ASSERT_TRUE(stream.is_valid());
  11307. char buffer[64 * 1024];
  11308. ssize_t n;
  11309. while ((n = stream.read(buffer, sizeof(buffer))) > 0) {
  11310. total_read += static_cast<size_t>(n);
  11311. }
  11312. } // StreamHandle and Client destroyed here, closing the socket
  11313. server_thread.join();
  11314. // With set_payload_max_length, the client must stop reading before consuming
  11315. // all 10MB. The read loop should be cut off at or near the configured limit.
  11316. EXPECT_LE(total_read, CLIENT_READ_LIMIT)
  11317. << "Client read " << total_read << " bytes, exceeding the configured "
  11318. << "payload_max_length of " << CLIENT_READ_LIMIT << " bytes.";
  11319. }
  11320. // Verify that set_payload_max_length(0) means "no limit" and allows reading
  11321. // the entire response body without truncation.
  11322. TEST(ClientVulnerabilityTest, PayloadMaxLengthZeroMeansNoLimit) {
  11323. static constexpr size_t DATA_SIZE = 4 * 1024 * 1024; // 4MB from server
  11324. #ifndef _WIN32
  11325. signal(SIGPIPE, SIG_IGN);
  11326. #endif
  11327. auto server_thread = std::thread([] {
  11328. auto srv = ::socket(AF_INET, SOCK_STREAM, 0);
  11329. default_socket_options(srv);
  11330. detail::set_socket_opt_time(srv, SOL_SOCKET, SO_RCVTIMEO, 5, 0);
  11331. detail::set_socket_opt_time(srv, SOL_SOCKET, SO_SNDTIMEO, 5, 0);
  11332. sockaddr_in addr{};
  11333. addr.sin_family = AF_INET;
  11334. addr.sin_port = htons(static_cast<uint16_t>(PORT + 2));
  11335. ::inet_pton(AF_INET, "127.0.0.1", &addr.sin_addr);
  11336. int opt = 1;
  11337. ::setsockopt(srv, SOL_SOCKET, SO_REUSEADDR,
  11338. #ifdef _WIN32
  11339. reinterpret_cast<const char *>(&opt),
  11340. #else
  11341. &opt,
  11342. #endif
  11343. sizeof(opt));
  11344. ::bind(srv, reinterpret_cast<sockaddr *>(&addr), sizeof(addr));
  11345. ::listen(srv, 1);
  11346. sockaddr_in cli_addr{};
  11347. socklen_t cli_len = sizeof(cli_addr);
  11348. auto cli = ::accept(srv, reinterpret_cast<sockaddr *>(&cli_addr), &cli_len);
  11349. if (cli != INVALID_SOCKET) {
  11350. char buf[4096];
  11351. ::recv(cli, buf, sizeof(buf), 0);
  11352. std::string response_header = "HTTP/1.1 200 OK\r\n"
  11353. "Connection: close\r\n"
  11354. "\r\n";
  11355. ::send(cli,
  11356. #ifdef _WIN32
  11357. static_cast<const char *>(response_header.c_str()),
  11358. static_cast<int>(response_header.size()),
  11359. #else
  11360. response_header.c_str(), response_header.size(),
  11361. #endif
  11362. 0);
  11363. std::string chunk(64 * 1024, 'A');
  11364. size_t total_sent = 0;
  11365. while (total_sent < DATA_SIZE) {
  11366. auto to_send = std::min(chunk.size(), DATA_SIZE - total_sent);
  11367. auto sent = ::send(cli,
  11368. #ifdef _WIN32
  11369. static_cast<const char *>(chunk.c_str()),
  11370. static_cast<int>(to_send),
  11371. #else
  11372. chunk.c_str(), to_send,
  11373. #endif
  11374. 0);
  11375. if (sent <= 0) break;
  11376. total_sent += static_cast<size_t>(sent);
  11377. }
  11378. #ifdef _WIN32
  11379. ::shutdown(cli, SD_SEND);
  11380. #else
  11381. ::shutdown(cli, SHUT_WR);
  11382. #endif
  11383. // Drain until the client closes its end, ensuring all data is delivered
  11384. char drain[1024];
  11385. while (::recv(cli, drain, sizeof(drain), 0) > 0) {}
  11386. detail::close_socket(cli);
  11387. }
  11388. detail::close_socket(srv);
  11389. });
  11390. std::this_thread::sleep_for(std::chrono::milliseconds(200));
  11391. size_t total_read = 0;
  11392. {
  11393. Client cli("127.0.0.1", PORT + 2);
  11394. cli.set_read_timeout(5, 0);
  11395. cli.set_payload_max_length(0); // 0 means no limit
  11396. auto stream = cli.open_stream("GET", "/data");
  11397. ASSERT_TRUE(stream.is_valid());
  11398. char buffer[64 * 1024];
  11399. ssize_t n;
  11400. while ((n = stream.read(buffer, sizeof(buffer))) > 0) {
  11401. total_read += static_cast<size_t>(n);
  11402. }
  11403. }
  11404. server_thread.join();
  11405. EXPECT_EQ(total_read, DATA_SIZE)
  11406. << "With payload_max_length(0), the client should read all " << DATA_SIZE
  11407. << " bytes without truncation, but only read " << total_read << " bytes.";
  11408. }
  11409. // Regression test for OSS-Fuzz issue 508342856: a malicious server sending an
  11410. // enormous Content-Length must not cause the client to pre-allocate a huge
  11411. // response body buffer. The reservation is capped at payload_max_length_, and
  11412. // the read itself fails when the body exceeds the limit.
  11413. TEST(ClientVulnerabilityTest, HugeContentLengthDoesNotPreallocate) {
  11414. #ifndef _WIN32
  11415. signal(SIGPIPE, SIG_IGN);
  11416. #endif
  11417. auto server_thread = std::thread([] {
  11418. auto srv = ::socket(AF_INET, SOCK_STREAM, 0);
  11419. default_socket_options(srv);
  11420. detail::set_socket_opt_time(srv, SOL_SOCKET, SO_RCVTIMEO, 5, 0);
  11421. detail::set_socket_opt_time(srv, SOL_SOCKET, SO_SNDTIMEO, 5, 0);
  11422. sockaddr_in addr{};
  11423. addr.sin_family = AF_INET;
  11424. addr.sin_port = htons(static_cast<uint16_t>(PORT + 2));
  11425. ::inet_pton(AF_INET, "127.0.0.1", &addr.sin_addr);
  11426. int opt = 1;
  11427. ::setsockopt(srv, SOL_SOCKET, SO_REUSEADDR,
  11428. #ifdef _WIN32
  11429. reinterpret_cast<const char *>(&opt),
  11430. #else
  11431. &opt,
  11432. #endif
  11433. sizeof(opt));
  11434. ::bind(srv, reinterpret_cast<sockaddr *>(&addr), sizeof(addr));
  11435. ::listen(srv, 1);
  11436. sockaddr_in cli_addr{};
  11437. socklen_t cli_len = sizeof(cli_addr);
  11438. auto cli = ::accept(srv, reinterpret_cast<sockaddr *>(&cli_addr), &cli_len);
  11439. if (cli != INVALID_SOCKET) {
  11440. char buf[4096];
  11441. ::recv(cli, buf, sizeof(buf), 0);
  11442. // Malicious response: claim a 20GB body but send only a tiny payload.
  11443. std::string response = "HTTP/1.1 200 OK\r\n"
  11444. "Content-Length: 20000000000\r\n"
  11445. "\r\n"
  11446. "abc";
  11447. ::send(cli,
  11448. #ifdef _WIN32
  11449. static_cast<const char *>(response.c_str()),
  11450. static_cast<int>(response.size()),
  11451. #else
  11452. response.c_str(), response.size(),
  11453. #endif
  11454. 0);
  11455. detail::close_socket(cli);
  11456. }
  11457. detail::close_socket(srv);
  11458. });
  11459. std::this_thread::sleep_for(std::chrono::milliseconds(200));
  11460. {
  11461. Client cli("127.0.0.1", PORT + 2);
  11462. cli.set_read_timeout(5, 0);
  11463. // Default payload_max_length_ is 100MB; a 20GB Content-Length must not
  11464. // result in a 20GB pre-allocation. The Get() call is expected to fail
  11465. // (server claims more bytes than payload_max_length permits), but it must
  11466. // not exhaust memory before getting there.
  11467. auto res = cli.Get("/malicious");
  11468. EXPECT_FALSE(res); // Read fails because body exceeds payload_max_length_
  11469. }
  11470. server_thread.join();
  11471. }
  11472. // Verify that content_receiver bypasses the default payload_max_length,
  11473. // allowing streaming downloads larger than 100MB without requiring an explicit
  11474. // set_payload_max_length call.
  11475. TEST(ClientVulnerabilityTest, ContentReceiverBypassesDefaultPayloadMaxLength) {
  11476. static constexpr size_t DATA_SIZE = 200 * 1024 * 1024; // 200MB from server
  11477. #ifndef _WIN32
  11478. signal(SIGPIPE, SIG_IGN);
  11479. #endif
  11480. auto server_thread = std::thread([] {
  11481. auto srv = ::socket(AF_INET, SOCK_STREAM, 0);
  11482. default_socket_options(srv);
  11483. detail::set_socket_opt_time(srv, SOL_SOCKET, SO_RCVTIMEO, 5, 0);
  11484. detail::set_socket_opt_time(srv, SOL_SOCKET, SO_SNDTIMEO, 5, 0);
  11485. sockaddr_in addr{};
  11486. addr.sin_family = AF_INET;
  11487. addr.sin_port = htons(static_cast<uint16_t>(PORT + 2));
  11488. ::inet_pton(AF_INET, "127.0.0.1", &addr.sin_addr);
  11489. int opt = 1;
  11490. ::setsockopt(srv, SOL_SOCKET, SO_REUSEADDR,
  11491. #ifdef _WIN32
  11492. reinterpret_cast<const char *>(&opt),
  11493. #else
  11494. &opt,
  11495. #endif
  11496. sizeof(opt));
  11497. ::bind(srv, reinterpret_cast<sockaddr *>(&addr), sizeof(addr));
  11498. ::listen(srv, 1);
  11499. sockaddr_in cli_addr{};
  11500. socklen_t cli_len = sizeof(cli_addr);
  11501. auto cli = ::accept(srv, reinterpret_cast<sockaddr *>(&cli_addr), &cli_len);
  11502. if (cli != INVALID_SOCKET) {
  11503. char buf[4096];
  11504. ::recv(cli, buf, sizeof(buf), 0);
  11505. // Response with Content-Length larger than default 100MB limit
  11506. auto content_length = std::to_string(DATA_SIZE);
  11507. std::string response_header = "HTTP/1.1 200 OK\r\n"
  11508. "Content-Length: " +
  11509. content_length +
  11510. "\r\n"
  11511. "Connection: close\r\n"
  11512. "\r\n";
  11513. ::send(cli,
  11514. #ifdef _WIN32
  11515. static_cast<const char *>(response_header.c_str()),
  11516. static_cast<int>(response_header.size()),
  11517. #else
  11518. response_header.c_str(), response_header.size(),
  11519. #endif
  11520. 0);
  11521. std::string chunk(64 * 1024, 'A');
  11522. size_t total_sent = 0;
  11523. while (total_sent < DATA_SIZE) {
  11524. auto to_send = std::min(chunk.size(), DATA_SIZE - total_sent);
  11525. auto sent = ::send(cli,
  11526. #ifdef _WIN32
  11527. static_cast<const char *>(chunk.c_str()),
  11528. static_cast<int>(to_send),
  11529. #else
  11530. chunk.c_str(), to_send,
  11531. #endif
  11532. 0);
  11533. if (sent <= 0) break;
  11534. total_sent += static_cast<size_t>(sent);
  11535. }
  11536. detail::close_socket(cli);
  11537. }
  11538. detail::close_socket(srv);
  11539. });
  11540. std::this_thread::sleep_for(std::chrono::milliseconds(200));
  11541. size_t total_received = 0;
  11542. {
  11543. Client cli("127.0.0.1", PORT + 2);
  11544. cli.set_read_timeout(10, 0);
  11545. // Do NOT call set_payload_max_length — use the default 100MB limit
  11546. auto res =
  11547. cli.Get("/large", [&](const char * /*data*/, size_t data_length) {
  11548. total_received += data_length;
  11549. return true;
  11550. });
  11551. ASSERT_TRUE(res) << "Error: " << to_string(res.error());
  11552. EXPECT_EQ(StatusCode::OK_200, res->status);
  11553. }
  11554. server_thread.join();
  11555. EXPECT_EQ(total_received, DATA_SIZE)
  11556. << "With content_receiver, the client should read all " << DATA_SIZE
  11557. << " bytes despite the default 100MB payload_max_length, but only read "
  11558. << total_received << " bytes.";
  11559. }
  11560. // Verify that an explicit set_payload_max_length smaller than the response is
  11561. // enforced even when a content_receiver is used.
  11562. TEST(ClientVulnerabilityTest,
  11563. ContentReceiverRespectsExplicitPayloadMaxLength150MB) {
  11564. static constexpr size_t DATA_SIZE = 200 * 1024 * 1024; // 200MB from server
  11565. static constexpr size_t EXPLICIT_LIMIT = 150 * 1024 * 1024; // 150MB limit
  11566. #ifndef _WIN32
  11567. signal(SIGPIPE, SIG_IGN);
  11568. #endif
  11569. auto server_thread = std::thread([] {
  11570. auto srv = ::socket(AF_INET, SOCK_STREAM, 0);
  11571. default_socket_options(srv);
  11572. detail::set_socket_opt_time(srv, SOL_SOCKET, SO_RCVTIMEO, 5, 0);
  11573. detail::set_socket_opt_time(srv, SOL_SOCKET, SO_SNDTIMEO, 5, 0);
  11574. sockaddr_in addr{};
  11575. addr.sin_family = AF_INET;
  11576. addr.sin_port = htons(static_cast<uint16_t>(PORT + 2));
  11577. ::inet_pton(AF_INET, "127.0.0.1", &addr.sin_addr);
  11578. int opt = 1;
  11579. ::setsockopt(srv, SOL_SOCKET, SO_REUSEADDR,
  11580. #ifdef _WIN32
  11581. reinterpret_cast<const char *>(&opt),
  11582. #else
  11583. &opt,
  11584. #endif
  11585. sizeof(opt));
  11586. ::bind(srv, reinterpret_cast<sockaddr *>(&addr), sizeof(addr));
  11587. ::listen(srv, 1);
  11588. sockaddr_in cli_addr{};
  11589. socklen_t cli_len = sizeof(cli_addr);
  11590. auto cli = ::accept(srv, reinterpret_cast<sockaddr *>(&cli_addr), &cli_len);
  11591. if (cli != INVALID_SOCKET) {
  11592. char buf[4096];
  11593. ::recv(cli, buf, sizeof(buf), 0);
  11594. auto content_length = std::to_string(DATA_SIZE);
  11595. std::string response_header = "HTTP/1.1 200 OK\r\n"
  11596. "Content-Length: " +
  11597. content_length +
  11598. "\r\n"
  11599. "Connection: close\r\n"
  11600. "\r\n";
  11601. ::send(cli,
  11602. #ifdef _WIN32
  11603. static_cast<const char *>(response_header.c_str()),
  11604. static_cast<int>(response_header.size()),
  11605. #else
  11606. response_header.c_str(), response_header.size(),
  11607. #endif
  11608. 0);
  11609. std::string chunk(64 * 1024, 'A');
  11610. size_t total_sent = 0;
  11611. while (total_sent < DATA_SIZE) {
  11612. auto to_send = std::min(chunk.size(), DATA_SIZE - total_sent);
  11613. auto sent = ::send(cli,
  11614. #ifdef _WIN32
  11615. static_cast<const char *>(chunk.c_str()),
  11616. static_cast<int>(to_send),
  11617. #else
  11618. chunk.c_str(), to_send,
  11619. #endif
  11620. 0);
  11621. if (sent <= 0) break;
  11622. total_sent += static_cast<size_t>(sent);
  11623. }
  11624. detail::close_socket(cli);
  11625. }
  11626. detail::close_socket(srv);
  11627. });
  11628. std::this_thread::sleep_for(std::chrono::milliseconds(200));
  11629. size_t total_received = 0;
  11630. {
  11631. Client cli("127.0.0.1", PORT + 2);
  11632. cli.set_read_timeout(10, 0);
  11633. cli.set_payload_max_length(EXPLICIT_LIMIT); // Explicit 150MB limit
  11634. auto res =
  11635. cli.Get("/large", [&](const char * /*data*/, size_t data_length) {
  11636. total_received += data_length;
  11637. return true;
  11638. });
  11639. // Should fail because 200MB exceeds the explicit 150MB limit
  11640. EXPECT_FALSE(res);
  11641. }
  11642. server_thread.join();
  11643. EXPECT_LE(total_received, EXPLICIT_LIMIT)
  11644. << "Client with content_receiver should respect the explicit "
  11645. << "payload_max_length of " << EXPLICIT_LIMIT << " bytes, but read "
  11646. << total_received << " bytes.";
  11647. }
  11648. // Verify that an explicit set_payload_max_length larger than the response
  11649. // allows the content_receiver to read all data successfully.
  11650. TEST(ClientVulnerabilityTest,
  11651. ContentReceiverRespectsExplicitPayloadMaxLength250MB) {
  11652. static constexpr size_t DATA_SIZE = 200 * 1024 * 1024; // 200MB from server
  11653. static constexpr size_t EXPLICIT_LIMIT = 250 * 1024 * 1024; // 250MB limit
  11654. #ifndef _WIN32
  11655. signal(SIGPIPE, SIG_IGN);
  11656. #endif
  11657. auto server_thread = std::thread([] {
  11658. auto srv = ::socket(AF_INET, SOCK_STREAM, 0);
  11659. default_socket_options(srv);
  11660. detail::set_socket_opt_time(srv, SOL_SOCKET, SO_RCVTIMEO, 5, 0);
  11661. detail::set_socket_opt_time(srv, SOL_SOCKET, SO_SNDTIMEO, 5, 0);
  11662. sockaddr_in addr{};
  11663. addr.sin_family = AF_INET;
  11664. addr.sin_port = htons(static_cast<uint16_t>(PORT + 2));
  11665. ::inet_pton(AF_INET, "127.0.0.1", &addr.sin_addr);
  11666. int opt = 1;
  11667. ::setsockopt(srv, SOL_SOCKET, SO_REUSEADDR,
  11668. #ifdef _WIN32
  11669. reinterpret_cast<const char *>(&opt),
  11670. #else
  11671. &opt,
  11672. #endif
  11673. sizeof(opt));
  11674. ::bind(srv, reinterpret_cast<sockaddr *>(&addr), sizeof(addr));
  11675. ::listen(srv, 1);
  11676. sockaddr_in cli_addr{};
  11677. socklen_t cli_len = sizeof(cli_addr);
  11678. auto cli = ::accept(srv, reinterpret_cast<sockaddr *>(&cli_addr), &cli_len);
  11679. if (cli != INVALID_SOCKET) {
  11680. char buf[4096];
  11681. ::recv(cli, buf, sizeof(buf), 0);
  11682. auto content_length = std::to_string(DATA_SIZE);
  11683. std::string response_header = "HTTP/1.1 200 OK\r\n"
  11684. "Content-Length: " +
  11685. content_length +
  11686. "\r\n"
  11687. "Connection: close\r\n"
  11688. "\r\n";
  11689. ::send(cli,
  11690. #ifdef _WIN32
  11691. static_cast<const char *>(response_header.c_str()),
  11692. static_cast<int>(response_header.size()),
  11693. #else
  11694. response_header.c_str(), response_header.size(),
  11695. #endif
  11696. 0);
  11697. std::string chunk(64 * 1024, 'A');
  11698. size_t total_sent = 0;
  11699. while (total_sent < DATA_SIZE) {
  11700. auto to_send = std::min(chunk.size(), DATA_SIZE - total_sent);
  11701. auto sent = ::send(cli,
  11702. #ifdef _WIN32
  11703. static_cast<const char *>(chunk.c_str()),
  11704. static_cast<int>(to_send),
  11705. #else
  11706. chunk.c_str(), to_send,
  11707. #endif
  11708. 0);
  11709. if (sent <= 0) break;
  11710. total_sent += static_cast<size_t>(sent);
  11711. }
  11712. #ifdef _WIN32
  11713. ::shutdown(cli, SD_SEND);
  11714. #else
  11715. ::shutdown(cli, SHUT_WR);
  11716. #endif
  11717. char drain[1024];
  11718. while (::recv(cli, drain, sizeof(drain), 0) > 0) {}
  11719. detail::close_socket(cli);
  11720. }
  11721. detail::close_socket(srv);
  11722. });
  11723. std::this_thread::sleep_for(std::chrono::milliseconds(200));
  11724. size_t total_received = 0;
  11725. {
  11726. Client cli("127.0.0.1", PORT + 2);
  11727. cli.set_read_timeout(10, 0);
  11728. cli.set_payload_max_length(EXPLICIT_LIMIT); // Explicit 250MB limit
  11729. auto res =
  11730. cli.Get("/large", [&](const char * /*data*/, size_t data_length) {
  11731. total_received += data_length;
  11732. return true;
  11733. });
  11734. ASSERT_TRUE(res) << "Error: " << to_string(res.error());
  11735. EXPECT_EQ(StatusCode::OK_200, res->status);
  11736. }
  11737. server_thread.join();
  11738. EXPECT_EQ(total_received, DATA_SIZE)
  11739. << "With explicit payload_max_length of " << EXPLICIT_LIMIT
  11740. << " bytes (larger than " << DATA_SIZE
  11741. << " bytes response), content_receiver should read all data, but only "
  11742. "read "
  11743. << total_received << " bytes.";
  11744. }
  11745. #if defined(CPPHTTPLIB_ZLIB_SUPPORT) && !defined(_WIN32)
  11746. // Regression test for "zip bomb" attack on the client side: a malicious server
  11747. // sends a small gzip-compressed response that decompresses to a huge payload.
  11748. // The client must enforce payload_max_length on the decompressed size.
  11749. TEST(ClientVulnerabilityTest, ZipBombWithoutContentLength) {
  11750. constexpr size_t DECOMPRESSED_SIZE =
  11751. 10 * 1024 * 1024; // 10MB after decompression
  11752. constexpr size_t CLIENT_READ_LIMIT = 2 * 1024 * 1024; // 2MB safety limit
  11753. // Prepare gzip-compressed data: 10MB of zeros compresses to a few KB
  11754. std::string uncompressed(DECOMPRESSED_SIZE, '\0');
  11755. std::string compressed;
  11756. {
  11757. httplib::detail::gzip_compressor compressor;
  11758. bool ok =
  11759. compressor.compress(uncompressed.data(), uncompressed.size(),
  11760. /*last=*/true, [&](const char *buf, size_t len) {
  11761. compressed.append(buf, len);
  11762. return true;
  11763. });
  11764. ASSERT_TRUE(ok);
  11765. }
  11766. // Sanity: compressed data should be much smaller than the decompressed size
  11767. ASSERT_LT(compressed.size(), DECOMPRESSED_SIZE / 10);
  11768. #ifndef _WIN32
  11769. signal(SIGPIPE, SIG_IGN);
  11770. #endif
  11771. // Set up the listening socket in the main thread so the server is guaranteed
  11772. // to be ready before the client connects (eliminates race condition).
  11773. auto srv = ::socket(AF_INET, SOCK_STREAM, 0);
  11774. default_socket_options(srv);
  11775. detail::set_socket_opt_time(srv, SOL_SOCKET, SO_RCVTIMEO, 5, 0);
  11776. detail::set_socket_opt_time(srv, SOL_SOCKET, SO_SNDTIMEO, 5, 0);
  11777. sockaddr_in addr{};
  11778. addr.sin_family = AF_INET;
  11779. addr.sin_port = htons(static_cast<uint16_t>(PORT + 3));
  11780. ::inet_pton(AF_INET, "127.0.0.1", &addr.sin_addr);
  11781. int opt = 1;
  11782. ::setsockopt(srv, SOL_SOCKET, SO_REUSEADDR,
  11783. #ifdef _WIN32
  11784. reinterpret_cast<const char *>(&opt),
  11785. #else
  11786. &opt,
  11787. #endif
  11788. sizeof(opt));
  11789. ASSERT_EQ(0, ::bind(srv, reinterpret_cast<sockaddr *>(&addr), sizeof(addr)));
  11790. ASSERT_EQ(0, ::listen(srv, 1));
  11791. auto server_thread = std::thread([&compressed, srv] {
  11792. sockaddr_in cli_addr{};
  11793. socklen_t cli_len = sizeof(cli_addr);
  11794. auto cli = ::accept(srv, reinterpret_cast<sockaddr *>(&cli_addr), &cli_len);
  11795. if (cli != INVALID_SOCKET) {
  11796. // Read the full HTTP request (until \r\n\r\n)
  11797. char buf[4096];
  11798. size_t total = 0;
  11799. while (total < sizeof(buf)) {
  11800. auto n = ::recv(cli, buf + total, sizeof(buf) - total, 0);
  11801. if (n <= 0) break;
  11802. total += static_cast<size_t>(n);
  11803. // Check for end of headers
  11804. if (total >= 4) {
  11805. std::string req(buf, total);
  11806. if (req.find("\r\n\r\n") != std::string::npos) break;
  11807. }
  11808. }
  11809. // Malicious response: gzip-compressed body, no Content-Length
  11810. std::string response_header = "HTTP/1.1 200 OK\r\n"
  11811. "Content-Encoding: gzip\r\n"
  11812. "Connection: close\r\n"
  11813. "\r\n";
  11814. ::send(cli,
  11815. #ifdef _WIN32
  11816. static_cast<const char *>(response_header.c_str()),
  11817. static_cast<int>(response_header.size()),
  11818. #else
  11819. response_header.c_str(), response_header.size(),
  11820. #endif
  11821. 0);
  11822. // Send the compressed payload (small on the wire, huge when decompressed)
  11823. size_t total_sent = 0;
  11824. while (total_sent < compressed.size()) {
  11825. auto to_send = std::min(compressed.size() - total_sent,
  11826. static_cast<size_t>(64 * 1024));
  11827. auto sent =
  11828. ::send(cli,
  11829. #ifdef _WIN32
  11830. static_cast<const char *>(compressed.c_str() + total_sent),
  11831. static_cast<int>(to_send),
  11832. #else
  11833. compressed.c_str() + total_sent, to_send,
  11834. #endif
  11835. 0);
  11836. if (sent <= 0) break;
  11837. total_sent += static_cast<size_t>(sent);
  11838. }
  11839. detail::close_socket(cli);
  11840. }
  11841. });
  11842. auto se = detail::scope_exit([&] {
  11843. detail::close_socket(srv);
  11844. server_thread.join();
  11845. });
  11846. size_t total_decompressed = 0;
  11847. {
  11848. Client cli("127.0.0.1", PORT + 3);
  11849. cli.set_read_timeout(5, 0);
  11850. cli.set_decompress(true);
  11851. cli.set_payload_max_length(CLIENT_READ_LIMIT);
  11852. auto stream = cli.open_stream("GET", "/zipbomb");
  11853. ASSERT_TRUE(stream.is_valid());
  11854. char buffer[64 * 1024];
  11855. ssize_t n;
  11856. while ((n = stream.read(buffer, sizeof(buffer))) > 0) {
  11857. total_decompressed += static_cast<size_t>(n);
  11858. }
  11859. }
  11860. // The decompressed size must be capped by payload_max_length. Without
  11861. // protection, the client would decompress the full 10MB from a tiny
  11862. // compressed payload, enabling a zip bomb DoS attack.
  11863. EXPECT_LE(total_decompressed, CLIENT_READ_LIMIT)
  11864. << "Client decompressed " << total_decompressed
  11865. << " bytes from a gzip response. The decompressed size should be "
  11866. << "limited by set_payload_max_length to prevent zip bomb attacks.";
  11867. }
  11868. #endif
  11869. TEST(HostAndPortPropertiesTest, NoSSL) {
  11870. httplib::Client cli("www.google.com", 1234);
  11871. ASSERT_EQ("www.google.com", cli.host());
  11872. ASSERT_EQ(1234, cli.port());
  11873. }
  11874. TEST(HostAndPortPropertiesTest, NoSSLWithSimpleAPI) {
  11875. httplib::Client cli("www.google.com:1234");
  11876. ASSERT_EQ("www.google.com", cli.host());
  11877. ASSERT_EQ(1234, cli.port());
  11878. }
  11879. TEST(HostAndPortPropertiesTest, OverflowPortNumber) {
  11880. // Port number that overflows int — should not crash, client becomes invalid
  11881. httplib::Client cli("http://www.google.com:99999999999999999999");
  11882. ASSERT_FALSE(cli.is_valid());
  11883. }
  11884. TEST(HostAndPortPropertiesTest, PortOutOfRange) {
  11885. // Port 99999 exceeds valid range (1-65535) — should not crash
  11886. httplib::Client cli("http://www.google.com:99999");
  11887. ASSERT_FALSE(cli.is_valid());
  11888. }
  11889. TEST(HostAndPortPropertiesTest, TrailingCharactersInPort) {
  11890. httplib::Client cli("http://www.google.com:80abc");
  11891. ASSERT_FALSE(cli.is_valid());
  11892. }
  11893. #ifdef CPPHTTPLIB_SSL_ENABLED
  11894. TEST(HostAndPortPropertiesTest, SSL) {
  11895. httplib::SSLClient cli("www.google.com");
  11896. ASSERT_EQ("www.google.com", cli.host());
  11897. ASSERT_EQ(443, cli.port());
  11898. }
  11899. TEST(SSLClientTest, UpdateCAStoreWithPem_Online) {
  11900. // Test updating CA store multiple times using PEM-based load_ca_cert_store
  11901. std::string cert;
  11902. read_file(CA_CERT_FILE, cert);
  11903. httplib::SSLClient httplib_client("www.google.com");
  11904. // Load CA store first time
  11905. httplib_client.load_ca_cert_store(cert.data(), cert.size());
  11906. // Load CA store second time (update)
  11907. httplib_client.load_ca_cert_store(cert.data(), cert.size());
  11908. // Verify client is still valid and can make connections
  11909. httplib_client.enable_server_certificate_verification(true);
  11910. auto res = httplib_client.Get("/");
  11911. ASSERT_TRUE(res) << "Error: " << to_string(res.error());
  11912. // Google may return 200 or 301 depending on various factors
  11913. EXPECT_TRUE(res->status == StatusCode::OK_200 ||
  11914. res->status == StatusCode::MovedPermanently_301);
  11915. }
  11916. TEST(SSLClientTest, ServerNameIndication_Online) {
  11917. auto host = "httpbingo.org";
  11918. auto path = std::string{"/get"};
  11919. SSLClient cli(host, 443);
  11920. auto res = cli.Get(path);
  11921. ASSERT_TRUE(res) << "Error: " << to_string(res.error());
  11922. ASSERT_EQ(StatusCode::OK_200, res->status);
  11923. }
  11924. TEST(SSLClientTest, ServerCertificateVerificationError_Online) {
  11925. // Use a site that will cause SSL verification failure due to self-signed cert
  11926. SSLClient cli("self-signed.badssl.com", 443);
  11927. cli.enable_server_certificate_verification(true);
  11928. auto res = cli.Get("/");
  11929. ASSERT_TRUE(!res);
  11930. EXPECT_EQ(Error::SSLServerVerification, res.error());
  11931. // Verify backend error is captured for SSLServerVerification
  11932. // This occurs when certificate verification fails
  11933. // OpenSSL: X509_V_ERR_DEPTH_ZERO_SELF_SIGNED_CERT (18)
  11934. // Mbed TLS: MBEDTLS_X509_BADCERT_NOT_TRUSTED or similar flags
  11935. EXPECT_NE(0UL, res.ssl_backend_error());
  11936. #ifdef CPPHTTPLIB_OPENSSL_SUPPORT
  11937. // For OpenSSL, ssl_error is 0 for verification errors
  11938. EXPECT_EQ(0, res.ssl_error());
  11939. #if !defined(_WIN32) || \
  11940. defined(CPPHTTPLIB_DISABLE_WINDOWS_AUTOMATIC_ROOT_CERTIFICATES_UPDATE)
  11941. // On non-Windows or when Windows Schannel is disabled, the error comes
  11942. // from OpenSSL's verification
  11943. EXPECT_EQ(static_cast<unsigned long>(X509_V_ERR_DEPTH_ZERO_SELF_SIGNED_CERT),
  11944. res.ssl_backend_error());
  11945. #endif
  11946. #endif
  11947. }
  11948. TEST(SSLClientTest, ServerHostnameVerificationError_Online) {
  11949. // Use a site where hostname doesn't match the certificate
  11950. // badssl.com provides wrong.host.badssl.com which has cert for *.badssl.com
  11951. SSLClient cli("wrong.host.badssl.com", 443);
  11952. cli.enable_server_certificate_verification(true);
  11953. cli.enable_server_hostname_verification(true);
  11954. auto res = cli.Get("/");
  11955. ASSERT_TRUE(!res);
  11956. EXPECT_EQ(Error::SSLServerHostnameVerification, res.error());
  11957. // Verify backend error is captured for hostname verification failure
  11958. EXPECT_NE(0UL, res.ssl_backend_error());
  11959. #ifdef CPPHTTPLIB_OPENSSL_SUPPORT
  11960. // For OpenSSL, ssl_error is 0 for verification errors
  11961. EXPECT_EQ(0, res.ssl_error());
  11962. #if !defined(_WIN32) || \
  11963. defined(CPPHTTPLIB_DISABLE_WINDOWS_AUTOMATIC_ROOT_CERTIFICATES_UPDATE)
  11964. // On non-Windows or when Windows Schannel is disabled, the error comes
  11965. // from OpenSSL's hostname verification
  11966. EXPECT_EQ(static_cast<unsigned long>(X509_V_ERR_HOSTNAME_MISMATCH),
  11967. res.ssl_backend_error());
  11968. #endif
  11969. #endif
  11970. }
  11971. #if defined(_WIN32) && defined(CPPHTTPLIB_SSL_ENABLED) && \
  11972. !defined(CPPHTTPLIB_DISABLE_WINDOWS_AUTOMATIC_ROOT_CERTIFICATES_UPDATE)
  11973. TEST(SSLClientTest, WindowsCertificateVerification_DefaultEnabled) {
  11974. SSLClient cli("www.google.com", 443);
  11975. cli.enable_server_certificate_verification(true);
  11976. auto res = cli.Get("/");
  11977. if (res) { EXPECT_NE(StatusCode::InternalServerError_500, res->status); }
  11978. }
  11979. TEST(SSLClientTest, WindowsCertificateVerification_Disabled) {
  11980. SSLClient cli("www.google.com", 443);
  11981. cli.enable_server_certificate_verification(true);
  11982. cli.enable_windows_certificate_verification(false);
  11983. auto res = cli.Get("/");
  11984. if (res) { EXPECT_NE(StatusCode::InternalServerError_500, res->status); }
  11985. }
  11986. // The server sends an intermediate cross-signed by a root Windows trusts,
  11987. // while the leaf's AIA URL leads to one under a root Windows does not trust.
  11988. TEST(SSLClientTest, WindowsCertificateVerification_ServerIntermediates_Online) {
  11989. SSLClient cli("accounts.spotify.com", 443);
  11990. auto res = cli.Get("/");
  11991. ASSERT_TRUE(res) << "Error: " << to_string(res.error())
  11992. << " ssl_backend_error=" << res.ssl_backend_error();
  11993. }
  11994. // Windows, not the backend, decides on the chain: the error is a CryptoAPI
  11995. // policy status, which no backend reports for a self-signed certificate.
  11996. TEST(SSLClientTest, WindowsCertificateVerification_RejectsUntrustedRoot) {
  11997. SSLServer svr(SERVER_CERT2_FILE, SERVER_PRIVATE_KEY_FILE);
  11998. ASSERT_TRUE(svr.is_valid());
  11999. thread t = thread([&]() { ASSERT_TRUE(svr.listen("127.0.0.1", PORT)); });
  12000. auto se = detail::scope_exit([&] {
  12001. svr.stop();
  12002. t.join();
  12003. ASSERT_FALSE(svr.is_running());
  12004. });
  12005. svr.wait_until_ready();
  12006. SSLClient cli("127.0.0.1", PORT);
  12007. cli.set_connection_timeout(30);
  12008. auto res = cli.Get("/");
  12009. ASSERT_FALSE(res);
  12010. EXPECT_EQ(Error::SSLServerVerification, res.error());
  12011. EXPECT_EQ(static_cast<DWORD>(CERT_E_UNTRUSTEDROOT), res.ssl_backend_error());
  12012. }
  12013. #endif
  12014. TEST(SSLClientTest, ServerCertificateVerification1_Online) {
  12015. Client cli("https://google.com");
  12016. auto res = cli.Get("/");
  12017. ASSERT_TRUE(res) << "Error: " << to_string(res.error());
  12018. ASSERT_EQ(StatusCode::MovedPermanently_301, res->status);
  12019. }
  12020. TEST(SSLClientTest, ServerCertificateVerification2_Online) {
  12021. SSLClient cli("google.com");
  12022. cli.set_ca_cert_path(CA_CERT_FILE);
  12023. auto res = cli.Get("/");
  12024. ASSERT_TRUE(res) << "Error: " << to_string(res.error());
  12025. ASSERT_EQ(StatusCode::MovedPermanently_301, res->status);
  12026. }
  12027. TEST(SSLClientTest, ServerCertificateVerification3_Online) {
  12028. SSLClient cli("google.com");
  12029. cli.enable_server_certificate_verification(true);
  12030. cli.set_ca_cert_path("hello");
  12031. auto res = cli.Get("/");
  12032. ASSERT_TRUE(!res);
  12033. EXPECT_EQ(Error::SSLLoadingCerts, res.error());
  12034. // For SSL_CTX operations, ssl_error should be 0, only ssl_backend_error
  12035. // should be set
  12036. EXPECT_EQ(0, res.ssl_error());
  12037. // Verify backend error is captured for SSLLoadingCerts
  12038. // This error occurs when loading CA certificates fails
  12039. EXPECT_NE(0UL, res.ssl_backend_error());
  12040. #ifdef CPPHTTPLIB_OPENSSL_SUPPORT
  12041. // OpenSSL specific error codes:
  12042. // > openssl errstr 0x80000002
  12043. // error:80000002:system library::No such file or directory
  12044. // > openssl errstr 0xA000126
  12045. // error:0A000126:SSL routines::unexpected eof while reading
  12046. EXPECT_TRUE(res.ssl_backend_error() == 0x80000002 ||
  12047. res.ssl_backend_error() == 0xA000126);
  12048. #endif
  12049. }
  12050. TEST(SSLClientTest, ServerCertificateVerification4) {
  12051. SSLServer svr(SERVER_CERT2_FILE, SERVER_PRIVATE_KEY_FILE);
  12052. ASSERT_TRUE(svr.is_valid());
  12053. svr.Get("/test", [&](const Request &, Response &res) {
  12054. res.set_content("test", "text/plain");
  12055. svr.stop();
  12056. ASSERT_TRUE(true);
  12057. });
  12058. thread t = thread([&]() { ASSERT_TRUE(svr.listen("127.0.0.1", PORT)); });
  12059. auto se = detail::scope_exit([&] {
  12060. t.join();
  12061. ASSERT_FALSE(svr.is_running());
  12062. });
  12063. svr.wait_until_ready();
  12064. SSLClient cli("127.0.0.1", PORT);
  12065. cli.set_ca_cert_path(SERVER_CERT2_FILE);
  12066. cli.enable_server_certificate_verification(true);
  12067. cli.set_connection_timeout(30);
  12068. auto res = cli.Get("/test");
  12069. ASSERT_TRUE(res) << "Error: " << to_string(res.error());
  12070. ASSERT_EQ(StatusCode::OK_200, res->status);
  12071. }
  12072. TEST(SSLClientTest, ServerCertificateVerification5_Online) {
  12073. std::string cert;
  12074. read_file(CA_CERT_FILE, cert);
  12075. SSLClient cli("google.com");
  12076. cli.load_ca_cert_store(cert.data(), cert.size());
  12077. const auto res = cli.Get("/");
  12078. ASSERT_TRUE(res) << "Error: " << to_string(res.error());
  12079. ASSERT_EQ(StatusCode::MovedPermanently_301, res->status);
  12080. }
  12081. TEST(SSLClientTest, ServerCertificateVerification6_Online) {
  12082. // clang-format off
  12083. static constexpr char cert[] =
  12084. "GlobalSign Root CA\n"
  12085. "==================\n"
  12086. "-----BEGIN CERTIFICATE-----\n"
  12087. "MIIDdTCCAl2gAwIBAgILBAAAAAABFUtaw5QwDQYJKoZIhvcNAQEFBQAwVzELMAkGA1UEBhMCQkUx\n"
  12088. "GTAXBgNVBAoTEEdsb2JhbFNpZ24gbnYtc2ExEDAOBgNVBAsTB1Jvb3QgQ0ExGzAZBgNVBAMTEkds\n"
  12089. "b2JhbFNpZ24gUm9vdCBDQTAeFw05ODA5MDExMjAwMDBaFw0yODAxMjgxMjAwMDBaMFcxCzAJBgNV\n"
  12090. "BAYTAkJFMRkwFwYDVQQKExBHbG9iYWxTaWduIG52LXNhMRAwDgYDVQQLEwdSb290IENBMRswGQYD\n"
  12091. "VQQDExJHbG9iYWxTaWduIFJvb3QgQ0EwggEiMA0GCSqGSIb3DQEBAQUAA4IBDwAwggEKAoIBAQDa\n"
  12092. "DuaZjc6j40+Kfvvxi4Mla+pIH/EqsLmVEQS98GPR4mdmzxzdzxtIK+6NiY6arymAZavpxy0Sy6sc\n"
  12093. "THAHoT0KMM0VjU/43dSMUBUc71DuxC73/OlS8pF94G3VNTCOXkNz8kHp1Wrjsok6Vjk4bwY8iGlb\n"
  12094. "Kk3Fp1S4bInMm/k8yuX9ifUSPJJ4ltbcdG6TRGHRjcdGsnUOhugZitVtbNV4FpWi6cgKOOvyJBNP\n"
  12095. "c1STE4U6G7weNLWLBYy5d4ux2x8gkasJU26Qzns3dLlwR5EiUWMWea6xrkEmCMgZK9FGqkjWZCrX\n"
  12096. "gzT/LCrBbBlDSgeF59N89iFo7+ryUp9/k5DPAgMBAAGjQjBAMA4GA1UdDwEB/wQEAwIBBjAPBgNV\n"
  12097. "HRMBAf8EBTADAQH/MB0GA1UdDgQWBBRge2YaRQ2XyolQL30EzTSo//z9SzANBgkqhkiG9w0BAQUF\n"
  12098. "AAOCAQEA1nPnfE920I2/7LqivjTFKDK1fPxsnCwrvQmeU79rXqoRSLblCKOzyj1hTdNGCbM+w6Dj\n"
  12099. "Y1Ub8rrvrTnhQ7k4o+YviiY776BQVvnGCv04zcQLcFGUl5gE38NflNUVyRRBnMRddWQVDf9VMOyG\n"
  12100. "j/8N7yy5Y0b2qvzfvGn9LhJIZJrglfCm7ymPAbEVtQwdpf5pLGkkeB6zpxxxYu7KyJesF12KwvhH\n"
  12101. "hm4qxFYxldBniYUr+WymXUadDKqC5JlR3XC321Y9YeRq4VzW9v493kHMB65jUr9TU/Qr6cf9tveC\n"
  12102. "X4XSQRjbgbMEHMUfpIBvFSDJ3gyICh3WZlXi/EjJKSZp4A==\n"
  12103. "-----END CERTIFICATE-----\n";
  12104. // clang-format on
  12105. SSLClient cli("google.com");
  12106. cli.load_ca_cert_store(cert, sizeof(cert));
  12107. const auto res = cli.Get("/");
  12108. ASSERT_TRUE(res) << "Error: " << to_string(res.error());
  12109. ASSERT_EQ(StatusCode::MovedPermanently_301, res->status);
  12110. }
  12111. TEST(SSLClientTest, WildcardHostNameMatch_Online) {
  12112. SSLClient cli("www.youtube.com");
  12113. cli.set_ca_cert_path(CA_CERT_FILE);
  12114. cli.enable_server_certificate_verification(true);
  12115. cli.set_follow_location(true);
  12116. auto res = cli.Get("/");
  12117. ASSERT_TRUE(res) << "Error: " << to_string(res.error());
  12118. ASSERT_EQ(StatusCode::OK_200, res->status);
  12119. }
  12120. TEST(SSLClientTest, WildcardHostNameMatchCase_Online) {
  12121. SSLClient cli("wWw.YouTube.Com");
  12122. cli.set_ca_cert_path(CA_CERT_FILE);
  12123. cli.enable_server_certificate_verification(true);
  12124. cli.enable_server_hostname_verification(true);
  12125. cli.set_follow_location(true);
  12126. auto res = cli.Get("/");
  12127. ASSERT_TRUE(res) << "Error: " << to_string(res.error());
  12128. ASSERT_EQ(StatusCode::OK_200, res->status);
  12129. }
  12130. TEST(SSLClientTest, HostNameMatchCase_Online) {
  12131. SSLClient cli("gOoGlE.COm");
  12132. cli.enable_server_certificate_verification(true);
  12133. cli.enable_server_hostname_verification(true);
  12134. cli.set_follow_location(true);
  12135. auto res = cli.Get("/");
  12136. ASSERT_TRUE(res) << "Error: " << to_string(res.error());
  12137. ASSERT_EQ(StatusCode::OK_200, res->status);
  12138. }
  12139. TEST(SSLClientTest, Issue2004_Online) {
  12140. Client client("https://google.com");
  12141. client.set_follow_location(true);
  12142. auto res = client.Get("/");
  12143. ASSERT_TRUE(res) << "Error: " << to_string(res.error());
  12144. ASSERT_EQ(StatusCode::OK_200, res->status);
  12145. auto body = res->body;
  12146. EXPECT_EQ(body.substr(0, 15), "<!doctype html>");
  12147. }
  12148. TEST(SSLClientTest, ErrorReportingWhenInvalid) {
  12149. // Create SSLClient with invalid cert/key to make is_valid() return false
  12150. SSLClient cli("localhost", 8080, "nonexistent_cert.pem",
  12151. "nonexistent_key.pem");
  12152. // is_valid() should be false due to cert loading failure
  12153. ASSERT_FALSE(cli.is_valid());
  12154. auto res = cli.Get("/");
  12155. ASSERT_FALSE(res);
  12156. EXPECT_EQ(Error::SSLConnection, res.error());
  12157. }
  12158. TEST(SSLClientTest, Issue2251_SwappedClientCertAndKey) {
  12159. // Test for Issue #2251: SSL error not properly reported when client cert
  12160. // and key paths are swapped or mismatched
  12161. // This simulates the scenario where user accidentally swaps the cert and key
  12162. // files
  12163. // Using client cert file as private key and vice versa (completely wrong)
  12164. SSLClient cli("localhost", 8080, "client.key.pem", "client.cert.pem");
  12165. // Should fail validation due to cert/key mismatch
  12166. ASSERT_FALSE(cli.is_valid());
  12167. // Attempt to make a request should fail with proper error
  12168. auto res = cli.Get("/");
  12169. ASSERT_FALSE(res);
  12170. EXPECT_EQ(Error::SSLConnection, res.error());
  12171. // SSL error should be recorded in the Result object (this is the key fix for
  12172. // Issue #2251)
  12173. auto backend_error = res.ssl_backend_error();
  12174. EXPECT_NE(0u, backend_error);
  12175. }
  12176. // Tests cert/key mismatch detection at the TLS context level
  12177. TEST(TlsApiTest, ClientCertKeyMismatch) {
  12178. // Test that using mismatched cert/key causes connection failure.
  12179. // We verify this at the SSLClient level rather than through internal
  12180. // TLS API functions.
  12181. SSLClient cli(HOST, PORT, "client.cert.pem", "key.pem");
  12182. cli.enable_server_certificate_verification(false);
  12183. cli.set_connection_timeout(2);
  12184. // The mismatch should cause a connection or handshake error
  12185. auto res = cli.Get("/test");
  12186. // OpenSSL detects mismatch at context setup, MbedTLS at handshake
  12187. // Either way, the request should fail
  12188. EXPECT_FALSE(res);
  12189. }
  12190. #endif
  12191. #if 0
  12192. TEST(SSLClientTest, SetInterfaceWithINET6) {
  12193. auto cli = std::make_shared<httplib::Client>("https://httpcan.org");
  12194. ASSERT_TRUE(cli != nullptr);
  12195. cli->set_address_family(AF_INET6);
  12196. cli->set_interface("en0");
  12197. auto res = cli->Get("/get");
  12198. ASSERT_TRUE(res) << "Error: " << to_string(res.error());
  12199. ASSERT_EQ(StatusCode::OK_200, res->status);
  12200. }
  12201. #endif
  12202. // ClientCertPresent uses get_peer_cert() - works with all TLS backends
  12203. #ifdef CPPHTTPLIB_SSL_ENABLED
  12204. void ClientCertPresent(
  12205. const std::string &client_cert_file,
  12206. const std::string &client_private_key_file,
  12207. const std::string &client_encrypted_private_key_pass = std::string()) {
  12208. using namespace httplib::tls;
  12209. SSLServer svr(SERVER_CERT_FILE, SERVER_PRIVATE_KEY_FILE, CLIENT_CA_CERT_FILE,
  12210. CLIENT_CA_CERT_DIR);
  12211. ASSERT_TRUE(svr.is_valid());
  12212. svr.Get("/test", [&](const Request &req, Response &res) {
  12213. res.set_content("test", "text/plain");
  12214. auto cert = req.peer_cert();
  12215. ASSERT_TRUE(static_cast<bool>(cert));
  12216. std::string common_name = cert.subject_cn();
  12217. EXPECT_EQ("Common Name", common_name);
  12218. });
  12219. thread t = thread([&]() { ASSERT_TRUE(svr.listen(HOST, PORT)); });
  12220. auto se = detail::scope_exit([&] {
  12221. svr.stop();
  12222. t.join();
  12223. ASSERT_FALSE(svr.is_running());
  12224. });
  12225. svr.wait_until_ready();
  12226. SSLClient cli(HOST, PORT, client_cert_file, client_private_key_file,
  12227. client_encrypted_private_key_pass);
  12228. cli.enable_server_certificate_verification(false);
  12229. cli.set_connection_timeout(30);
  12230. auto res = cli.Get("/test");
  12231. ASSERT_TRUE(res) << "Error: " << to_string(res.error());
  12232. ASSERT_EQ(StatusCode::OK_200, res->status);
  12233. }
  12234. TEST(SSLClientServerTest, ClientCertPresent) {
  12235. ClientCertPresent(CLIENT_CERT_FILE, CLIENT_PRIVATE_KEY_FILE);
  12236. }
  12237. TEST(SSLClientServerTest, ClientEncryptedCertPresent) {
  12238. ClientCertPresent(CLIENT_ENCRYPTED_CERT_FILE,
  12239. CLIENT_ENCRYPTED_PRIVATE_KEY_FILE,
  12240. CLIENT_ENCRYPTED_PRIVATE_KEY_PASS);
  12241. }
  12242. // PEM memory-based constructor tests (works with all TLS backends)
  12243. void PemMemoryClientCertPresent(
  12244. const std::string &client_cert_file,
  12245. const std::string &client_private_key_file,
  12246. const std::string &client_encrypted_private_key_pass = std::string()) {
  12247. // Read PEM files into memory
  12248. std::string server_cert_pem, server_key_pem;
  12249. std::string client_ca_pem;
  12250. std::string client_cert_pem, client_key_pem;
  12251. read_file(SERVER_CERT_FILE, server_cert_pem);
  12252. read_file(SERVER_PRIVATE_KEY_FILE, server_key_pem);
  12253. read_file(CLIENT_CA_CERT_FILE, client_ca_pem);
  12254. read_file(client_cert_file, client_cert_pem);
  12255. read_file(client_private_key_file, client_key_pem);
  12256. // Create server with PEM memory
  12257. SSLServer::PemMemory server_pem = {
  12258. server_cert_pem.c_str(),
  12259. server_cert_pem.size(),
  12260. server_key_pem.c_str(),
  12261. server_key_pem.size(),
  12262. client_ca_pem.c_str(),
  12263. client_ca_pem.size(),
  12264. nullptr // no password for server key
  12265. };
  12266. SSLServer svr(server_pem);
  12267. ASSERT_TRUE(svr.is_valid());
  12268. svr.Get("/test", [&](const Request &, Response &res) {
  12269. res.set_content("test", "text/plain");
  12270. });
  12271. thread t = thread([&]() { ASSERT_TRUE(svr.listen(HOST, PORT)); });
  12272. auto se = detail::scope_exit([&] {
  12273. svr.stop();
  12274. t.join();
  12275. ASSERT_FALSE(svr.is_running());
  12276. });
  12277. svr.wait_until_ready();
  12278. // Create client with PEM memory
  12279. const char *password = client_encrypted_private_key_pass.empty()
  12280. ? nullptr
  12281. : client_encrypted_private_key_pass.c_str();
  12282. SSLClient::PemMemory client_pem = {
  12283. client_cert_pem.c_str(), client_cert_pem.size(), client_key_pem.c_str(),
  12284. client_key_pem.size(), password};
  12285. SSLClient cli(HOST, PORT, client_pem);
  12286. cli.enable_server_certificate_verification(false);
  12287. cli.set_connection_timeout(30);
  12288. auto res = cli.Get("/test");
  12289. ASSERT_TRUE(res) << "Error: " << to_string(res.error());
  12290. ASSERT_EQ(StatusCode::OK_200, res->status);
  12291. }
  12292. TEST(SSLClientServerTest, PemMemoryClientCertPresent) {
  12293. PemMemoryClientCertPresent(CLIENT_CERT_FILE, CLIENT_PRIVATE_KEY_FILE);
  12294. }
  12295. TEST(SSLClientServerTest, PemMemoryClientEncryptedCertPresent) {
  12296. PemMemoryClientCertPresent(CLIENT_ENCRYPTED_CERT_FILE,
  12297. CLIENT_ENCRYPTED_PRIVATE_KEY_FILE,
  12298. CLIENT_ENCRYPTED_PRIVATE_KEY_PASS);
  12299. }
  12300. TEST(SSLClientServerTest, ClientCertMissing) {
  12301. SSLServer svr(SERVER_CERT_FILE, SERVER_PRIVATE_KEY_FILE, CLIENT_CA_CERT_FILE,
  12302. CLIENT_CA_CERT_DIR);
  12303. ASSERT_TRUE(svr.is_valid());
  12304. svr.Get("/test", [&](const Request &, Response &) { ASSERT_TRUE(false); });
  12305. thread t = thread([&]() { ASSERT_TRUE(svr.listen(HOST, PORT)); });
  12306. auto se = detail::scope_exit([&] {
  12307. svr.stop();
  12308. t.join();
  12309. ASSERT_FALSE(svr.is_running());
  12310. });
  12311. svr.wait_until_ready();
  12312. SSLClient cli(HOST, PORT);
  12313. cli.set_connection_timeout(30);
  12314. // cert.pem does not match HOST. Skip the hostname check, which runs before
  12315. // the chain check on Windows, so the result does not depend on the order.
  12316. cli.enable_server_hostname_verification(false);
  12317. auto res = cli.Get("/test");
  12318. ASSERT_TRUE(!res);
  12319. // When client cert is missing and server requires it, connection fails
  12320. // Error type depends on backend implementation
  12321. EXPECT_TRUE(res.error() == Error::SSLServerVerification ||
  12322. res.error() == Error::SSLConnection);
  12323. // Verify backend error is captured
  12324. // Note: This test may have different error codes depending on the exact
  12325. // verification failure
  12326. EXPECT_NE(0UL, res.ssl_backend_error());
  12327. }
  12328. TEST(SSLClientServerTest, TrustDirOptional) {
  12329. SSLServer svr(SERVER_CERT_FILE, SERVER_PRIVATE_KEY_FILE, CLIENT_CA_CERT_FILE);
  12330. ASSERT_TRUE(svr.is_valid());
  12331. svr.Get("/test", [&](const Request &, Response &res) {
  12332. res.set_content("test", "text/plain");
  12333. });
  12334. thread t = thread([&]() { ASSERT_TRUE(svr.listen(HOST, PORT)); });
  12335. auto se = detail::scope_exit([&] {
  12336. svr.stop();
  12337. t.join();
  12338. ASSERT_FALSE(svr.is_running());
  12339. });
  12340. svr.wait_until_ready();
  12341. SSLClient cli(HOST, PORT, CLIENT_CERT_FILE, CLIENT_PRIVATE_KEY_FILE);
  12342. cli.enable_server_certificate_verification(false);
  12343. cli.set_connection_timeout(30);
  12344. auto res = cli.Get("/test");
  12345. ASSERT_TRUE(res) << "Error: " << to_string(res.error());
  12346. ASSERT_EQ(StatusCode::OK_200, res->status);
  12347. }
  12348. TEST(SSLClientServerTest, SSLConnectTimeout) {
  12349. class NoListenSSLServer : public SSLServer {
  12350. public:
  12351. NoListenSSLServer(const char *cert_path, const char *private_key_path,
  12352. const char *client_ca_cert_file_path,
  12353. const char *client_ca_cert_dir_path = nullptr)
  12354. : SSLServer(cert_path, private_key_path, client_ca_cert_file_path,
  12355. client_ca_cert_dir_path),
  12356. stop_(false) {}
  12357. std::atomic_bool stop_;
  12358. private:
  12359. bool process_and_close_socket(socket_t /*sock*/) override {
  12360. // Don't create SSL context
  12361. while (!stop_.load()) {
  12362. std::this_thread::sleep_for(std::chrono::milliseconds(100));
  12363. }
  12364. return true;
  12365. }
  12366. };
  12367. NoListenSSLServer svr(SERVER_CERT_FILE, SERVER_PRIVATE_KEY_FILE,
  12368. CLIENT_CA_CERT_FILE);
  12369. ASSERT_TRUE(svr.is_valid());
  12370. svr.Get("/test", [&](const Request &, Response &res) {
  12371. res.set_content("test", "text/plain");
  12372. });
  12373. thread t = thread([&]() { ASSERT_TRUE(svr.listen(HOST, PORT)); });
  12374. auto se = detail::scope_exit([&] {
  12375. svr.stop_ = true;
  12376. svr.stop();
  12377. t.join();
  12378. ASSERT_FALSE(svr.is_running());
  12379. });
  12380. svr.wait_until_ready();
  12381. SSLClient cli(HOST, PORT, CLIENT_CERT_FILE, CLIENT_PRIVATE_KEY_FILE);
  12382. cli.enable_server_certificate_verification(false);
  12383. cli.set_connection_timeout(1);
  12384. auto res = cli.Get("/test");
  12385. ASSERT_TRUE(!res);
  12386. EXPECT_EQ(Error::SSLConnection, res.error());
  12387. // Timeout results in WantRead error code (maps to backend-specific value)
  12388. EXPECT_NE(0, res.ssl_error());
  12389. }
  12390. TEST(SSLClientServerTest, CustomizeServerSSLCtxGeneric) {
  12391. // Test SSLServer with client certificate verification using the standard
  12392. // constructor (ContextSetupCallback is tested by backend-specific tests)
  12393. SSLServer svr(SERVER_CERT_FILE, SERVER_PRIVATE_KEY_FILE, CLIENT_CA_CERT_FILE,
  12394. CLIENT_CA_CERT_DIR);
  12395. ASSERT_TRUE(svr.is_valid());
  12396. svr.Get("/test", [&](const Request &req, Response &res) {
  12397. res.set_content("test", "text/plain");
  12398. auto cert = req.peer_cert();
  12399. ASSERT_TRUE(static_cast<bool>(cert));
  12400. auto common_name = cert.subject_cn();
  12401. EXPECT_EQ("Common Name", common_name);
  12402. });
  12403. thread t = thread([&]() { ASSERT_TRUE(svr.listen(HOST, PORT)); });
  12404. auto se = detail::scope_exit([&] {
  12405. svr.stop();
  12406. t.join();
  12407. ASSERT_FALSE(svr.is_running());
  12408. });
  12409. svr.wait_until_ready();
  12410. SSLClient cli(HOST, PORT, CLIENT_CERT_FILE, CLIENT_PRIVATE_KEY_FILE);
  12411. cli.enable_server_certificate_verification(false);
  12412. cli.set_connection_timeout(30);
  12413. auto res = cli.Get("/test");
  12414. ASSERT_TRUE(res) << "Error: " << to_string(res.error());
  12415. ASSERT_EQ(StatusCode::OK_200, res->status);
  12416. }
  12417. // Test verify_hostname for both OpenSSL and MbedTLS backends
  12418. // Verifies that wildcard matching and exact matching work consistently
  12419. TEST(SSLClientServerTest, TlsVerifyHostname) {
  12420. using namespace httplib::tls;
  12421. // We need a running server to test against
  12422. SSLServer svr(SERVER_CERT_FILE, SERVER_PRIVATE_KEY_FILE);
  12423. ASSERT_TRUE(svr.is_valid());
  12424. svr.Get("/test", [](const Request &, Response &res) {
  12425. res.set_content("ok", "text/plain");
  12426. });
  12427. thread t([&]() { svr.listen(HOST, PORT); });
  12428. auto se = detail::scope_exit([&] {
  12429. svr.stop();
  12430. t.join();
  12431. });
  12432. svr.wait_until_ready();
  12433. bool verify_callback_called = false;
  12434. bool verify_result_wrong = false;
  12435. SSLClient cli(HOST, PORT);
  12436. cli.enable_server_certificate_verification(true);
  12437. cli.set_ca_cert_path(CA_CERT_FILE);
  12438. cli.set_connection_timeout(5);
  12439. // Note: Test certificate has CN="Common Name", not "localhost"
  12440. bool verify_result_cn = false;
  12441. cli.set_server_certificate_verifier([&](const VerifyContext &ctx) -> bool {
  12442. verify_callback_called = true;
  12443. if (!ctx.cert) return false;
  12444. // Test 1: "Common Name" should match (our test server cert CN)
  12445. verify_result_cn = ctx.check_hostname("Common Name");
  12446. // Test 2: wrong hostname should not match
  12447. verify_result_wrong = ctx.check_hostname("wronghost.example.com");
  12448. return true; // Accept for the purpose of this test
  12449. });
  12450. auto res = cli.Get("/test");
  12451. // The request may succeed or fail depending on cert configuration
  12452. // but the callback should have been called
  12453. ASSERT_TRUE(verify_callback_called)
  12454. << "Verify callback should have been called";
  12455. // CN="Common Name" should match our test certificate
  12456. //
  12457. // BoringSSL intentionally drops CN-based hostname matching per RFC 6125
  12458. // §6.4.4 — only SubjectAltName is consulted. Other backends (OpenSSL,
  12459. // MbedTLS, wolfSSL) still honor the CN fallback, so flip the expectation
  12460. // for BoringSSL builds. OPENSSL_IS_BORINGSSL is defined by BoringSSL's
  12461. // <openssl/base.h>, which is included transitively when
  12462. // CPPHTTPLIB_OPENSSL_SUPPORT is set against a BoringSSL install.
  12463. #if defined(OPENSSL_IS_BORINGSSL)
  12464. EXPECT_FALSE(verify_result_cn)
  12465. << "BoringSSL should reject CN-based hostname matching (SAN-only)";
  12466. #else
  12467. EXPECT_TRUE(verify_result_cn)
  12468. << "verify_hostname should match 'Common Name' (certificate CN)";
  12469. #endif
  12470. // Wrong hostname should not match
  12471. EXPECT_FALSE(verify_result_wrong)
  12472. << "verify_hostname should not match 'wronghost.example.com'";
  12473. }
  12474. // An IP-literal host must only be authenticated via an iPAddress SAN, never via
  12475. // the certificate's Common Name (RFC 9110). This mirrors the OpenSSL backend's
  12476. // X509_check_ip behavior and must hold for every backend.
  12477. TEST(SSLClientServerTest, TlsVerifyHostnameIpNotMatchedByCommonName) {
  12478. using namespace httplib::tls;
  12479. // Certificate CN is the IPv4 literal "127.0.0.1" and it carries no SAN.
  12480. SSLServer svr(SERVER_CERT_IP_CN_FILE, SERVER_PRIVATE_KEY_FILE);
  12481. ASSERT_TRUE(svr.is_valid());
  12482. svr.Get("/test", [](const Request &, Response &res) {
  12483. res.set_content("ok", "text/plain");
  12484. });
  12485. thread t([&]() { svr.listen(HOST, PORT); });
  12486. auto se = detail::scope_exit([&] {
  12487. svr.stop();
  12488. t.join();
  12489. });
  12490. svr.wait_until_ready();
  12491. bool verify_callback_called = false;
  12492. bool ip_matched_via_cn = true;
  12493. SSLClient cli(HOST, PORT);
  12494. cli.enable_server_certificate_verification(true);
  12495. cli.set_ca_cert_path(CA_CERT_FILE);
  12496. cli.set_connection_timeout(5);
  12497. cli.set_server_certificate_verifier([&](const VerifyContext &ctx) -> bool {
  12498. verify_callback_called = true;
  12499. if (!ctx.cert) return false;
  12500. // The IP appears only in the CN, so it must NOT be accepted.
  12501. ip_matched_via_cn = ctx.check_hostname("127.0.0.1");
  12502. return true; // Accept for the purpose of this test
  12503. });
  12504. cli.Get("/test");
  12505. ASSERT_TRUE(verify_callback_called)
  12506. << "Verify callback should have been called";
  12507. EXPECT_FALSE(ip_matched_via_cn)
  12508. << "An IP host must not be authenticated via the certificate CN";
  12509. }
  12510. // IPv6 hosts must be matched against IPv6 iPAddress SANs (and only those).
  12511. TEST(SSLClientServerTest, TlsVerifyHostnameIpv6San) {
  12512. using namespace httplib::tls;
  12513. // Certificate CN is "::1" and it carries an IPv6 SAN for "2001:db8::1".
  12514. SSLServer svr(SERVER_CERT_IPV6_FILE, SERVER_PRIVATE_KEY_FILE);
  12515. ASSERT_TRUE(svr.is_valid());
  12516. svr.Get("/test", [](const Request &, Response &res) {
  12517. res.set_content("ok", "text/plain");
  12518. });
  12519. thread t([&]() { svr.listen(HOST, PORT); });
  12520. auto se = detail::scope_exit([&] {
  12521. svr.stop();
  12522. t.join();
  12523. });
  12524. svr.wait_until_ready();
  12525. bool verify_callback_called = false;
  12526. bool san_matched = false;
  12527. bool wrong_ipv6_matched = true;
  12528. bool cn_ipv6_matched = true;
  12529. SSLClient cli(HOST, PORT);
  12530. cli.enable_server_certificate_verification(true);
  12531. cli.set_ca_cert_path(CA_CERT_FILE);
  12532. cli.set_connection_timeout(5);
  12533. cli.set_server_certificate_verifier([&](const VerifyContext &ctx) -> bool {
  12534. verify_callback_called = true;
  12535. if (!ctx.cert) return false;
  12536. // Matches the IPv6 iPAddress SAN.
  12537. san_matched = ctx.check_hostname("2001:db8::1");
  12538. // A different IPv6 address must not match.
  12539. wrong_ipv6_matched = ctx.check_hostname("2001:db8::2");
  12540. // "::1" lives only in the CN, so it must not be accepted.
  12541. cn_ipv6_matched = ctx.check_hostname("::1");
  12542. return true; // Accept for the purpose of this test
  12543. });
  12544. cli.Get("/test");
  12545. ASSERT_TRUE(verify_callback_called)
  12546. << "Verify callback should have been called";
  12547. EXPECT_TRUE(san_matched)
  12548. << "verify_hostname should match an IPv6 iPAddress SAN";
  12549. EXPECT_FALSE(wrong_ipv6_matched)
  12550. << "verify_hostname should not match a non-matching IPv6 address";
  12551. EXPECT_FALSE(cn_ipv6_matched)
  12552. << "An IPv6 host must not be authenticated via the certificate CN";
  12553. }
  12554. // A SAN entry must only match a host of its own type: the bytes of the dNSName
  12555. // "a.zz" are also 97.46.122.122, and 42.46.122.122 reads as "*.zz".
  12556. TEST(SSLClientServerTest, TlsVerifyHostnameSanType) {
  12557. using namespace httplib::tls;
  12558. // SANs: DNS:a.zz, IP:42.46.122.122
  12559. SSLServer svr(SERVER_CERT_SAN_TYPES_FILE, SERVER_PRIVATE_KEY_FILE);
  12560. ASSERT_TRUE(svr.is_valid());
  12561. svr.Get("/test", [](const Request &, Response &res) {
  12562. res.set_content("ok", "text/plain");
  12563. });
  12564. auto port = svr.bind_to_any_port(HOST);
  12565. thread t([&]() { svr.listen_after_bind(); });
  12566. auto se = detail::scope_exit([&] {
  12567. svr.stop();
  12568. t.join();
  12569. });
  12570. svr.wait_until_ready();
  12571. bool verify_callback_called = false;
  12572. bool dns_san_matched = false;
  12573. bool ip_san_matched = false;
  12574. bool ip_matched_via_dns_san = true;
  12575. bool dns_matched_via_ip_san = true;
  12576. SSLClient cli(HOST, port);
  12577. cli.enable_server_certificate_verification(true);
  12578. cli.set_ca_cert_path(CA_CERT_FILE);
  12579. cli.set_connection_timeout(5);
  12580. cli.set_server_certificate_verifier([&](const VerifyContext &ctx) -> bool {
  12581. verify_callback_called = true;
  12582. if (!ctx.cert) return false;
  12583. dns_san_matched = ctx.check_hostname("a.zz");
  12584. ip_san_matched = ctx.check_hostname("42.46.122.122");
  12585. ip_matched_via_dns_san = ctx.check_hostname("97.46.122.122");
  12586. dns_matched_via_ip_san = ctx.check_hostname("b.zz");
  12587. return true; // Accept for the purpose of this test
  12588. });
  12589. cli.Get("/test");
  12590. ASSERT_TRUE(verify_callback_called)
  12591. << "Verify callback should have been called";
  12592. EXPECT_TRUE(dns_san_matched) << "verify_hostname should match a dNSName SAN";
  12593. EXPECT_TRUE(ip_san_matched)
  12594. << "verify_hostname should match an iPAddress SAN";
  12595. EXPECT_FALSE(ip_matched_via_dns_san)
  12596. << "An IP host must not be authenticated via a dNSName SAN";
  12597. EXPECT_FALSE(dns_matched_via_ip_san)
  12598. << "A DNS host must not be authenticated via an iPAddress SAN";
  12599. }
  12600. // RFC 6125 6.4.3: only the leftmost label of a dNSName may be a wildcard, so
  12601. // "www.*.example.test" names one host and not every host under example.test.
  12602. TEST(SSLClientServerTest, TlsVerifyHostnameWildcardLabel) {
  12603. using namespace httplib::tls;
  12604. // SANs: DNS:*.leftmost.example.test, DNS:www.*.example.test
  12605. SSLServer svr(SERVER_CERT_WILDCARD_SAN_FILE, SERVER_PRIVATE_KEY_FILE);
  12606. ASSERT_TRUE(svr.is_valid());
  12607. svr.Get("/test", [](const Request &, Response &res) {
  12608. res.set_content("ok", "text/plain");
  12609. });
  12610. auto port = svr.bind_to_any_port(HOST);
  12611. thread t([&]() { svr.listen_after_bind(); });
  12612. auto se = detail::scope_exit([&] {
  12613. svr.stop();
  12614. t.join();
  12615. });
  12616. svr.wait_until_ready();
  12617. bool verify_callback_called = false;
  12618. bool leftmost_wildcard_matched = false;
  12619. bool wildcard_spanned_labels = true;
  12620. bool inner_wildcard_matched = true;
  12621. SSLClient cli(HOST, port);
  12622. cli.enable_server_certificate_verification(true);
  12623. cli.set_ca_cert_path(CA_CERT_FILE);
  12624. cli.set_connection_timeout(5);
  12625. cli.set_server_certificate_verifier([&](const VerifyContext &ctx) -> bool {
  12626. verify_callback_called = true;
  12627. if (!ctx.cert) return false;
  12628. leftmost_wildcard_matched = ctx.check_hostname("a.leftmost.example.test");
  12629. wildcard_spanned_labels = ctx.check_hostname("a.b.leftmost.example.test");
  12630. inner_wildcard_matched = ctx.check_hostname("www.evil.example.test");
  12631. return true; // Accept for the purpose of this test
  12632. });
  12633. cli.Get("/test");
  12634. ASSERT_TRUE(verify_callback_called)
  12635. << "Verify callback should have been called";
  12636. EXPECT_TRUE(leftmost_wildcard_matched)
  12637. << "A leftmost wildcard should match a single label";
  12638. EXPECT_FALSE(wildcard_spanned_labels)
  12639. << "A wildcard label must not match more than one label";
  12640. EXPECT_FALSE(inner_wildcard_matched)
  12641. << "A wildcard outside the leftmost label must not be honoured";
  12642. }
  12643. // sans() must report each SAN entry under its own type.
  12644. TEST(SSLClientServerTest, TlsCertSansEntryTypes) {
  12645. using namespace httplib::tls;
  12646. // SANs: DNS:a.zz, IP:42.46.122.122
  12647. SSLServer svr(SERVER_CERT_SAN_TYPES_FILE, SERVER_PRIVATE_KEY_FILE);
  12648. ASSERT_TRUE(svr.is_valid());
  12649. svr.Get("/test", [](const Request &, Response &res) {
  12650. res.set_content("ok", "text/plain");
  12651. });
  12652. auto port = svr.bind_to_any_port(HOST);
  12653. thread t([&]() { svr.listen_after_bind(); });
  12654. auto se = detail::scope_exit([&] {
  12655. svr.stop();
  12656. t.join();
  12657. });
  12658. svr.wait_until_ready();
  12659. bool verify_callback_called = false;
  12660. std::vector<SanEntry> sans;
  12661. SSLClient cli(HOST, port);
  12662. cli.enable_server_certificate_verification(true);
  12663. cli.set_ca_cert_path(CA_CERT_FILE);
  12664. cli.set_connection_timeout(5);
  12665. cli.set_server_certificate_verifier([&](const VerifyContext &ctx) -> bool {
  12666. verify_callback_called = true;
  12667. if (!ctx.cert) return false;
  12668. sans = ctx.sans();
  12669. return true; // Accept for the purpose of this test
  12670. });
  12671. cli.Get("/test");
  12672. ASSERT_TRUE(verify_callback_called)
  12673. << "Verify callback should have been called";
  12674. auto has_san = [&](SanType type, const std::string &value) {
  12675. return std::any_of(sans.begin(), sans.end(), [&](const SanEntry &san) {
  12676. return san.type == type && san.value == value;
  12677. });
  12678. };
  12679. EXPECT_TRUE(has_san(SanType::DNS, "a.zz"))
  12680. << "sans() should report the dNSName SAN";
  12681. EXPECT_TRUE(has_san(SanType::IP, "42.46.122.122"))
  12682. << "sans() should report the iPAddress SAN";
  12683. EXPECT_FALSE(has_san(SanType::IP, "97.46.122.122"))
  12684. << "sans() must not report the dNSName SAN as an address";
  12685. EXPECT_FALSE(has_san(SanType::DNS, "*.zz"))
  12686. << "sans() must not report the iPAddress SAN as a DNS name";
  12687. }
  12688. #endif
  12689. // mbedTLS-specific callback constructor test
  12690. // Tests that the void* callback can customize TLS settings via MbedTlsContext
  12691. #ifdef CPPHTTPLIB_SSL_ENABLED
  12692. TEST(SSLClientServerTest, ClientCAListSentToClient) {
  12693. SSLServer svr(SERVER_CERT_FILE, SERVER_PRIVATE_KEY_FILE, CLIENT_CA_CERT_FILE);
  12694. ASSERT_TRUE(svr.is_valid());
  12695. // Set up a handler to verify client certificate is present
  12696. bool client_cert_verified = false;
  12697. svr.Get("/test", [&](const Request & /*req*/, Response &res) {
  12698. // Verify that client certificate was provided
  12699. client_cert_verified = true;
  12700. res.set_content("success", "text/plain");
  12701. });
  12702. thread t = thread([&]() { ASSERT_TRUE(svr.listen(HOST, PORT)); });
  12703. auto se = detail::scope_exit([&] {
  12704. svr.stop();
  12705. t.join();
  12706. ASSERT_FALSE(svr.is_running());
  12707. });
  12708. svr.wait_until_ready();
  12709. // Client with certificate
  12710. SSLClient cli(HOST, PORT, CLIENT_CERT_FILE, CLIENT_PRIVATE_KEY_FILE);
  12711. cli.enable_server_certificate_verification(false);
  12712. cli.set_connection_timeout(30);
  12713. auto res = cli.Get("/test");
  12714. ASSERT_TRUE(res) << "Error: " << to_string(res.error());
  12715. ASSERT_EQ(StatusCode::OK_200, res->status);
  12716. ASSERT_TRUE(client_cert_verified);
  12717. EXPECT_EQ("success", res->body);
  12718. }
  12719. #endif
  12720. // ClientCAListSetInContext uses get_peer_cert() - works with all TLS
  12721. // backends
  12722. #ifdef CPPHTTPLIB_SSL_ENABLED
  12723. TEST(SSLClientServerTest, ClientCAListSetInContext) {
  12724. using namespace httplib::tls;
  12725. // Test that when client CA cert file is provided,
  12726. // the server properly requests and validates client certificates
  12727. // Create a server with client authentication
  12728. SSLServer svr(SERVER_CERT_FILE, SERVER_PRIVATE_KEY_FILE, CLIENT_CA_CERT_FILE);
  12729. ASSERT_TRUE(svr.is_valid());
  12730. bool handler_called = false;
  12731. svr.Get("/test", [&](const Request &req, Response &res) {
  12732. handler_called = true;
  12733. // Verify that a client certificate was provided
  12734. auto cert = req.peer_cert();
  12735. ASSERT_TRUE(static_cast<bool>(cert));
  12736. // Get the issuer name
  12737. std::string issuer_str = cert.issuer_name();
  12738. ASSERT_FALSE(issuer_str.empty());
  12739. // The client certificate should be issued by our test CA
  12740. EXPECT_TRUE(issuer_str.find("Root CA Name") != std::string::npos);
  12741. res.set_content("authenticated", "text/plain");
  12742. });
  12743. thread t = thread([&]() { ASSERT_TRUE(svr.listen(HOST, PORT)); });
  12744. auto se = detail::scope_exit([&] {
  12745. svr.stop();
  12746. t.join();
  12747. ASSERT_FALSE(svr.is_running());
  12748. });
  12749. svr.wait_until_ready();
  12750. // Connect with a client certificate issued by the CA
  12751. SSLClient cli(HOST, PORT, CLIENT_CERT_FILE, CLIENT_PRIVATE_KEY_FILE);
  12752. cli.enable_server_certificate_verification(false);
  12753. cli.set_connection_timeout(30);
  12754. auto res = cli.Get("/test");
  12755. ASSERT_TRUE(res) << "Error: " << to_string(res.error());
  12756. ASSERT_EQ(StatusCode::OK_200, res->status);
  12757. ASSERT_TRUE(handler_called);
  12758. EXPECT_EQ("authenticated", res->body);
  12759. }
  12760. TEST(TlsCertIntrospectionTest, GetCertSANs) {
  12761. using namespace httplib::tls;
  12762. SSLServer svr(SERVER_CERT_FILE, SERVER_PRIVATE_KEY_FILE);
  12763. ASSERT_TRUE(svr.is_valid());
  12764. svr.Get("/test", [](const Request &, Response &res) {
  12765. res.set_content("ok", "text/plain");
  12766. });
  12767. thread t = thread([&]() { ASSERT_TRUE(svr.listen(HOST, PORT)); });
  12768. auto se = detail::scope_exit([&] {
  12769. svr.stop();
  12770. t.join();
  12771. });
  12772. svr.wait_until_ready();
  12773. SSLClient cli(HOST, PORT);
  12774. cli.enable_server_certificate_verification(false);
  12775. cli.set_connection_timeout(30);
  12776. bool cert_checked = false;
  12777. cli.set_server_certificate_verifier([&](const VerifyContext &ctx) -> bool {
  12778. if (ctx.cert) {
  12779. auto sans = ctx.sans();
  12780. // Test certificate may or may not have SANs - just verify the API
  12781. // works If SANs exist, verify the types are valid
  12782. for (const auto &san : sans) {
  12783. EXPECT_TRUE(san.type == SanType::DNS || san.type == SanType::IP ||
  12784. san.type == SanType::EMAIL || san.type == SanType::URI ||
  12785. san.type == SanType::OTHER);
  12786. EXPECT_FALSE(san.value.empty());
  12787. }
  12788. cert_checked = true;
  12789. }
  12790. return true;
  12791. });
  12792. auto res = cli.Get("/test");
  12793. ASSERT_TRUE(res) << "Error: " << to_string(res.error());
  12794. EXPECT_TRUE(cert_checked);
  12795. }
  12796. TEST(TlsCertIntrospectionTest, GetCertValidity) {
  12797. using namespace httplib::tls;
  12798. SSLServer svr(SERVER_CERT_FILE, SERVER_PRIVATE_KEY_FILE);
  12799. ASSERT_TRUE(svr.is_valid());
  12800. svr.Get("/test", [](const Request &, Response &res) {
  12801. res.set_content("ok", "text/plain");
  12802. });
  12803. thread t = thread([&]() { ASSERT_TRUE(svr.listen(HOST, PORT)); });
  12804. auto se = detail::scope_exit([&] {
  12805. svr.stop();
  12806. t.join();
  12807. });
  12808. svr.wait_until_ready();
  12809. SSLClient cli(HOST, PORT);
  12810. cli.enable_server_certificate_verification(false);
  12811. cli.set_connection_timeout(30);
  12812. bool validity_checked = false;
  12813. cli.set_server_certificate_verifier([&](const VerifyContext &ctx) -> bool {
  12814. if (ctx.cert) {
  12815. time_t not_before = 0, not_after = 0;
  12816. bool result = ctx.validity(not_before, not_after);
  12817. EXPECT_TRUE(result);
  12818. // Verify that not_before < now < not_after for a valid cert
  12819. time_t now = time(nullptr);
  12820. EXPECT_LT(not_before, now);
  12821. EXPECT_GT(not_after, now);
  12822. validity_checked = true;
  12823. }
  12824. return true;
  12825. });
  12826. auto res = cli.Get("/test");
  12827. ASSERT_TRUE(res) << "Error: " << to_string(res.error());
  12828. EXPECT_TRUE(validity_checked);
  12829. }
  12830. TEST(TlsCertIntrospectionTest, GetCertSerial) {
  12831. using namespace httplib::tls;
  12832. SSLServer svr(SERVER_CERT_FILE, SERVER_PRIVATE_KEY_FILE);
  12833. ASSERT_TRUE(svr.is_valid());
  12834. svr.Get("/test", [](const Request &, Response &res) {
  12835. res.set_content("ok", "text/plain");
  12836. });
  12837. thread t = thread([&]() { ASSERT_TRUE(svr.listen(HOST, PORT)); });
  12838. auto se = detail::scope_exit([&] {
  12839. svr.stop();
  12840. t.join();
  12841. });
  12842. svr.wait_until_ready();
  12843. SSLClient cli(HOST, PORT);
  12844. cli.enable_server_certificate_verification(false);
  12845. cli.set_connection_timeout(30);
  12846. bool serial_checked = false;
  12847. cli.set_server_certificate_verifier([&](const VerifyContext &ctx) -> bool {
  12848. if (ctx.cert) {
  12849. std::string serial = ctx.serial();
  12850. EXPECT_FALSE(serial.empty());
  12851. // Serial should be a hex string
  12852. for (char c : serial) {
  12853. EXPECT_TRUE((c >= '0' && c <= '9') || (c >= 'A' && c <= 'F') ||
  12854. (c >= 'a' && c <= 'f'));
  12855. }
  12856. serial_checked = true;
  12857. }
  12858. return true;
  12859. });
  12860. auto res = cli.Get("/test");
  12861. ASSERT_TRUE(res) << "Error: " << to_string(res.error());
  12862. EXPECT_TRUE(serial_checked);
  12863. }
  12864. TEST(SSLClientServerTest, ClientCAListLoadErrorRecorded) {
  12865. // Test 1: Valid CA file - no error should be recorded
  12866. {
  12867. SSLServer svr(SERVER_CERT_FILE, SERVER_PRIVATE_KEY_FILE,
  12868. CLIENT_CA_CERT_FILE);
  12869. ASSERT_TRUE(svr.is_valid());
  12870. // With valid setup, last_ssl_error should be 0
  12871. EXPECT_EQ(0, svr.ssl_last_error());
  12872. }
  12873. // Test 2: Invalid CA file content
  12874. // When SSL_load_client_CA_file fails, last_ssl_error_ should be set
  12875. {
  12876. // Create a temporary file with completely invalid content
  12877. const char *temp_invalid_ca = "./temp_invalid_ca_for_test.txt";
  12878. {
  12879. std::ofstream ofs(temp_invalid_ca);
  12880. ofs << "This is not a certificate file at all\n";
  12881. ofs << "Just plain text content\n";
  12882. }
  12883. // Create server with invalid CA file
  12884. SSLServer svr(SERVER_CERT_FILE, SERVER_PRIVATE_KEY_FILE, temp_invalid_ca);
  12885. // Clean up temporary file
  12886. std::remove(temp_invalid_ca);
  12887. // When there's an SSL error (from either SSL_CTX_load_verify_locations
  12888. // or SSL_load_client_CA_file), last_ssl_error_ should be non-zero
  12889. // Note: SSL_CTX_load_verify_locations typically fails first,
  12890. // but our error handling code path is still exercised
  12891. if (!svr.is_valid()) { EXPECT_NE(0, svr.ssl_last_error()); }
  12892. }
  12893. }
  12894. TEST(VerifyCallbackTest, VerifyContextFields) {
  12895. using namespace httplib::tls;
  12896. SSLServer svr(SERVER_CERT_FILE, SERVER_PRIVATE_KEY_FILE);
  12897. ASSERT_TRUE(svr.is_valid());
  12898. svr.Get("/test", [](const Request &, Response &res) {
  12899. res.set_content("ok", "text/plain");
  12900. });
  12901. thread t = thread([&]() { ASSERT_TRUE(svr.listen(HOST, PORT)); });
  12902. auto se = detail::scope_exit([&] {
  12903. svr.stop();
  12904. t.join();
  12905. });
  12906. svr.wait_until_ready();
  12907. SSLClient cli(HOST, PORT);
  12908. cli.enable_server_certificate_verification(false);
  12909. cli.set_connection_timeout(30);
  12910. int callback_count = 0;
  12911. bool saw_leaf_cert = false;
  12912. cli.set_server_certificate_verifier([&](const VerifyContext &ctx) -> bool {
  12913. if (ctx.cert) {
  12914. callback_count++;
  12915. // We should see at least one certificate (the leaf)
  12916. std::string cn = ctx.subject_cn();
  12917. if (!cn.empty()) { saw_leaf_cert = true; }
  12918. // Verify context fields are populated
  12919. EXPECT_NE(ctx.session, nullptr);
  12920. EXPECT_GE(ctx.depth, 0);
  12921. }
  12922. return true;
  12923. });
  12924. auto res = cli.Get("/test");
  12925. ASSERT_TRUE(res) << "Error: " << to_string(res.error());
  12926. EXPECT_GT(callback_count, 0);
  12927. EXPECT_TRUE(saw_leaf_cert);
  12928. }
  12929. TEST(TlsVerifyErrorTest, GetVerifyErrorString) {
  12930. using httplib::tls::TlsError;
  12931. // Test that verify_error_to_string returns empty for success
  12932. std::string success_str = TlsError::verify_error_to_string(0);
  12933. EXPECT_TRUE(success_str.empty());
  12934. // Test that verify_error_to_string returns non-empty for error codes
  12935. // Using a common error code (certificate expired)
  12936. std::string error_str =
  12937. TlsError::verify_error_to_string(10); // X509_V_ERR_CERT_HAS_EXPIRED
  12938. EXPECT_FALSE(error_str.empty());
  12939. }
  12940. TEST(SessionVerifierTest, CertificateAccepted) {
  12941. SSLServer svr(SERVER_CERT_FILE, SERVER_PRIVATE_KEY_FILE);
  12942. ASSERT_TRUE(svr.is_valid());
  12943. svr.Get("/test", [](const Request &, Response &res) {
  12944. res.set_content("ok", "text/plain");
  12945. });
  12946. thread t = thread([&]() { ASSERT_TRUE(svr.listen(HOST, PORT)); });
  12947. auto se = detail::scope_exit([&] {
  12948. svr.stop();
  12949. t.join();
  12950. });
  12951. svr.wait_until_ready();
  12952. SSLClient cli(HOST, PORT);
  12953. cli.enable_server_certificate_verification(false);
  12954. cli.set_connection_timeout(30);
  12955. bool callback_called = false;
  12956. cli.set_session_verifier([&](tls::session_t session) -> SSLVerifierResponse {
  12957. EXPECT_NE(session, nullptr);
  12958. callback_called = true;
  12959. return SSLVerifierResponse::CertificateAccepted;
  12960. });
  12961. auto res = cli.Get("/test");
  12962. ASSERT_TRUE(res) << "Error: " << to_string(res.error());
  12963. EXPECT_EQ(200, res->status);
  12964. EXPECT_TRUE(callback_called);
  12965. }
  12966. TEST(SessionVerifierTest, CertificateRejected) {
  12967. SSLServer svr(SERVER_CERT_FILE, SERVER_PRIVATE_KEY_FILE);
  12968. ASSERT_TRUE(svr.is_valid());
  12969. svr.Get("/test", [](const Request &, Response &res) {
  12970. res.set_content("ok", "text/plain");
  12971. });
  12972. thread t = thread([&]() { ASSERT_TRUE(svr.listen(HOST, PORT)); });
  12973. auto se = detail::scope_exit([&] {
  12974. svr.stop();
  12975. t.join();
  12976. });
  12977. svr.wait_until_ready();
  12978. SSLClient cli(HOST, PORT);
  12979. cli.enable_server_certificate_verification(false);
  12980. cli.set_connection_timeout(30);
  12981. bool callback_called = false;
  12982. cli.set_session_verifier([&](tls::session_t session) -> SSLVerifierResponse {
  12983. EXPECT_NE(session, nullptr);
  12984. callback_called = true;
  12985. return SSLVerifierResponse::CertificateRejected;
  12986. });
  12987. auto res = cli.Get("/test");
  12988. EXPECT_FALSE(res);
  12989. EXPECT_TRUE(callback_called);
  12990. }
  12991. TEST(SessionVerifierTest, NoDecisionFallsThrough) {
  12992. SSLServer svr(SERVER_CERT_FILE, SERVER_PRIVATE_KEY_FILE);
  12993. ASSERT_TRUE(svr.is_valid());
  12994. svr.Get("/test", [](const Request &, Response &res) {
  12995. res.set_content("ok", "text/plain");
  12996. });
  12997. thread t = thread([&]() { ASSERT_TRUE(svr.listen(HOST, PORT)); });
  12998. auto se = detail::scope_exit([&] {
  12999. svr.stop();
  13000. t.join();
  13001. });
  13002. svr.wait_until_ready();
  13003. // NoDecisionMade with verification disabled should succeed (no default check)
  13004. SSLClient cli(HOST, PORT);
  13005. cli.enable_server_certificate_verification(false);
  13006. cli.set_connection_timeout(30);
  13007. bool callback_called = false;
  13008. cli.set_session_verifier([&](tls::session_t session) -> SSLVerifierResponse {
  13009. EXPECT_NE(session, nullptr);
  13010. callback_called = true;
  13011. return SSLVerifierResponse::NoDecisionMade;
  13012. });
  13013. auto res = cli.Get("/test");
  13014. ASSERT_TRUE(res) << "Error: " << to_string(res.error());
  13015. EXPECT_EQ(200, res->status);
  13016. EXPECT_TRUE(callback_called);
  13017. }
  13018. TEST(SessionVerifierTest, NoDecisionWithVerificationEnabled) {
  13019. SSLServer svr(SERVER_CERT_FILE, SERVER_PRIVATE_KEY_FILE);
  13020. ASSERT_TRUE(svr.is_valid());
  13021. svr.Get("/test", [](const Request &, Response &res) {
  13022. res.set_content("ok", "text/plain");
  13023. });
  13024. thread t = thread([&]() { ASSERT_TRUE(svr.listen(HOST, PORT)); });
  13025. auto se = detail::scope_exit([&] {
  13026. svr.stop();
  13027. t.join();
  13028. });
  13029. svr.wait_until_ready();
  13030. // NoDecisionMade with verification enabled should fail (self-signed cert).
  13031. // Note: On MbedTLS, the handshake itself fails before reaching the verifier,
  13032. // so we only check that the request fails, not whether the callback was
  13033. // called.
  13034. SSLClient cli(HOST, PORT);
  13035. cli.enable_server_certificate_verification(true);
  13036. cli.set_connection_timeout(30);
  13037. cli.set_session_verifier([&](tls::session_t session) -> SSLVerifierResponse {
  13038. EXPECT_NE(session, nullptr);
  13039. return SSLVerifierResponse::NoDecisionMade;
  13040. });
  13041. auto res = cli.Get("/test");
  13042. EXPECT_FALSE(res);
  13043. }
  13044. TEST(SSLClientServerTest, ClientCAListFromPem) {
  13045. // Test SSL server using PemMemory constructor with client CA certificates
  13046. // Read PEM files
  13047. std::string server_cert_pem, server_key_pem, client_ca_pem;
  13048. read_file(SERVER_CERT_FILE, server_cert_pem);
  13049. read_file(SERVER_PRIVATE_KEY_FILE, server_key_pem);
  13050. read_file(CLIENT_CA_CERT_FILE, client_ca_pem);
  13051. // Create SSLServer with PemMemory constructor including client CA
  13052. SSLServer::PemMemory server_pem = {
  13053. server_cert_pem.c_str(),
  13054. server_cert_pem.size(),
  13055. server_key_pem.c_str(),
  13056. server_key_pem.size(),
  13057. client_ca_pem.c_str(),
  13058. client_ca_pem.size(),
  13059. nullptr // no password for server key
  13060. };
  13061. SSLServer svr(server_pem);
  13062. ASSERT_TRUE(svr.is_valid());
  13063. // No SSL error should be recorded for valid setup
  13064. EXPECT_EQ(0, svr.ssl_last_error());
  13065. // Set up server endpoints
  13066. svr.Get("/test-pem-ca", [&](const Request & /*req*/, Response &res) {
  13067. res.set_content("ok", "text/plain");
  13068. });
  13069. // Start server in a thread
  13070. auto server_thread = thread([&]() { svr.listen(HOST, PORT); });
  13071. svr.wait_until_ready();
  13072. // Connect with client certificate (using constructor with paths)
  13073. SSLClient cli(HOST, PORT, CLIENT_CERT_FILE, CLIENT_PRIVATE_KEY_FILE);
  13074. cli.enable_server_certificate_verification(false);
  13075. auto res = cli.Get("/test-pem-ca");
  13076. ASSERT_TRUE(res) << "Error: " << to_string(res.error());
  13077. EXPECT_EQ(200, res->status);
  13078. EXPECT_EQ("ok", res->body);
  13079. svr.stop();
  13080. server_thread.join();
  13081. }
  13082. #endif
  13083. #ifdef _WIN32
  13084. TEST(CleanupTest, WSACleanup) {
  13085. int ret = WSACleanup();
  13086. ASSERT_EQ(0, ret);
  13087. }
  13088. #endif
  13089. #ifndef CPPHTTPLIB_SSL_ENABLED
  13090. TEST(NoSSLSupport, SimpleInterface) {
  13091. ASSERT_ANY_THROW(Client cli("https://yahoo.com"));
  13092. }
  13093. #endif
  13094. #ifndef CPPHTTPLIB_NO_EXCEPTIONS
  13095. TEST(InvalidScheme, SimpleInterface) {
  13096. ASSERT_ANY_THROW(Client cli("scheme://yahoo.com"));
  13097. }
  13098. #endif
  13099. TEST(NoScheme, SimpleInterface) {
  13100. Client cli("yahoo.com:80");
  13101. ASSERT_TRUE(cli.is_valid());
  13102. }
  13103. TEST(SendAPI, SimpleInterface_Online) {
  13104. Client cli("http://yahoo.com");
  13105. Request req;
  13106. req.method = "GET";
  13107. req.path = "/";
  13108. auto res = cli.send(req);
  13109. ASSERT_TRUE(res) << "Error: " << to_string(res.error());
  13110. EXPECT_EQ(StatusCode::MovedPermanently_301, res->status);
  13111. }
  13112. TEST(SendAPI, WithParamsInRequest) {
  13113. Server svr;
  13114. svr.Get("/", [&](const Request &req, Response & /*res*/) {
  13115. EXPECT_TRUE(req.has_param("test"));
  13116. EXPECT_EQ("test_value", req.get_param_value("test"));
  13117. });
  13118. auto t = std::thread([&]() { svr.listen(HOST, PORT); });
  13119. auto se = detail::scope_exit([&] {
  13120. svr.stop();
  13121. t.join();
  13122. ASSERT_FALSE(svr.is_running());
  13123. });
  13124. svr.wait_until_ready();
  13125. Client cli(HOST, PORT);
  13126. {
  13127. Request req;
  13128. req.method = "GET";
  13129. req.path = "/";
  13130. req.params.emplace("test", "test_value");
  13131. auto res = cli.send(req);
  13132. ASSERT_TRUE(res) << "Error: " << to_string(res.error());
  13133. }
  13134. {
  13135. auto res = cli.Get("/", {{"test", "test_value"}}, Headers{});
  13136. ASSERT_TRUE(res) << "Error: " << to_string(res.error());
  13137. }
  13138. }
  13139. TEST(ClientImplMethods, GetSocketTest) {
  13140. httplib::Server svr;
  13141. svr.Get("/", [&](const httplib::Request & /*req*/, httplib::Response &res) {
  13142. res.status = StatusCode::OK_200;
  13143. });
  13144. auto port = svr.bind_to_any_port("127.0.0.1");
  13145. auto thread = std::thread([&]() { svr.listen_after_bind(); });
  13146. auto se = detail::scope_exit([&] {
  13147. svr.stop();
  13148. thread.join();
  13149. ASSERT_FALSE(svr.is_running());
  13150. });
  13151. svr.wait_until_ready();
  13152. {
  13153. httplib::Client cli("127.0.0.1", port);
  13154. cli.set_keep_alive(true);
  13155. // Use the behavior of cpp-httplib of opening the connection
  13156. // only when the first request happens. If that changes,
  13157. // this test would be obsolete.
  13158. EXPECT_EQ(cli.socket(), INVALID_SOCKET);
  13159. // This also implicitly tests the server. But other tests would fail much
  13160. // earlier than this one to be considered.
  13161. auto res = cli.Get("/");
  13162. ASSERT_TRUE(res) << "Error: " << to_string(res.error());
  13163. EXPECT_EQ(StatusCode::OK_200, res->status);
  13164. ASSERT_TRUE(cli.socket() != INVALID_SOCKET);
  13165. }
  13166. }
  13167. #ifdef CPPHTTPLIB_SSL_ENABLED
  13168. TEST(YahooRedirectTest2, SimpleInterface_Online) {
  13169. Client cli("http://yahoo.com");
  13170. auto res = cli.Get("/");
  13171. ASSERT_TRUE(res) << "Error: " << to_string(res.error());
  13172. EXPECT_EQ(StatusCode::MovedPermanently_301, res->status);
  13173. cli.set_follow_location(true);
  13174. res = cli.Get("/");
  13175. ASSERT_TRUE(res) << "Error: " << to_string(res.error());
  13176. EXPECT_EQ(StatusCode::OK_200, res->status);
  13177. EXPECT_EQ("https://www.yahoo.com/", res->location);
  13178. }
  13179. TEST(YahooRedirectTest3, SimpleInterface_Online) {
  13180. Client cli("https://yahoo.com");
  13181. auto res = cli.Get("/");
  13182. ASSERT_TRUE(res) << "Error: " << to_string(res.error());
  13183. EXPECT_EQ(StatusCode::MovedPermanently_301, res->status);
  13184. cli.set_follow_location(true);
  13185. res = cli.Get("/");
  13186. ASSERT_TRUE(res) << "Error: " << to_string(res.error());
  13187. EXPECT_EQ(StatusCode::OK_200, res->status);
  13188. EXPECT_EQ("https://www.yahoo.com/", res->location);
  13189. }
  13190. TEST(YahooRedirectTest3, NewResultInterface_Online) {
  13191. Client cli("https://yahoo.com");
  13192. auto res = cli.Get("/");
  13193. ASSERT_TRUE(res) << "Error: " << to_string(res.error());
  13194. ASSERT_FALSE(!res);
  13195. ASSERT_TRUE(res) << "Error: " << to_string(res.error());
  13196. ASSERT_FALSE(res == nullptr);
  13197. ASSERT_TRUE(res != nullptr);
  13198. EXPECT_EQ(Error::Success, res.error());
  13199. EXPECT_EQ(StatusCode::MovedPermanently_301, res.value().status);
  13200. EXPECT_EQ(StatusCode::MovedPermanently_301, (*res).status);
  13201. EXPECT_EQ(StatusCode::MovedPermanently_301, res->status);
  13202. cli.set_follow_location(true);
  13203. res = cli.Get("/");
  13204. ASSERT_TRUE(res) << "Error: " << to_string(res.error());
  13205. EXPECT_EQ(Error::Success, res.error());
  13206. EXPECT_EQ(StatusCode::OK_200, res.value().status);
  13207. EXPECT_EQ(StatusCode::OK_200, (*res).status);
  13208. EXPECT_EQ(StatusCode::OK_200, res->status);
  13209. EXPECT_EQ("https://www.yahoo.com/", res->location);
  13210. }
  13211. #ifdef CPPHTTPLIB_BROTLI_SUPPORT
  13212. TEST(DecodeWithChunkedEncoding, BrotliEncoding_Online) {
  13213. Client cli("https://cdnjs.cloudflare.com");
  13214. auto res = cli.Get("/ajax/libs/jquery/3.5.1/jquery.js",
  13215. Headers{{"Accept-Encoding", "br"}});
  13216. ASSERT_TRUE(res) << "Error: " << to_string(res.error());
  13217. EXPECT_EQ(StatusCode::OK_200, res->status);
  13218. EXPECT_EQ(287630U, res->body.size());
  13219. EXPECT_EQ("application/javascript; charset=utf-8",
  13220. res->get_header_value("Content-Type"));
  13221. }
  13222. #endif
  13223. // Previously "https://nghttp2.org" "/httpbin/redirect-to"
  13224. #undef REDIR_HOST // Silence compiler warning
  13225. #define REDIR_HOST "https://httpbingo.org"
  13226. TEST(HttpsToHttpRedirectTest, SimpleInterface_Online) {
  13227. Client cli(REDIR_HOST);
  13228. cli.set_follow_location(true);
  13229. auto res =
  13230. cli.Get(REDIR_PATH "?url=http%3A%2F%2Fexample.com&status_code=302");
  13231. ASSERT_TRUE(res) << "Error: " << to_string(res.error());
  13232. EXPECT_EQ(StatusCode::OK_200, res->status);
  13233. }
  13234. TEST(HttpsToHttpRedirectTest2, SimpleInterface_Online) {
  13235. Client cli(REDIR_HOST);
  13236. cli.set_follow_location(true);
  13237. Params params;
  13238. params.emplace("url", "http://example.com");
  13239. params.emplace("status_code", "302");
  13240. auto res = cli.Get(REDIR_PATH, params, Headers{});
  13241. ASSERT_TRUE(res) << "Error: " << to_string(res.error());
  13242. EXPECT_EQ(StatusCode::OK_200, res->status);
  13243. }
  13244. TEST(HttpsToHttpRedirectTest3, SimpleInterface_Online) {
  13245. Client cli(REDIR_HOST);
  13246. cli.set_follow_location(true);
  13247. Params params;
  13248. params.emplace("url", "http://example.com");
  13249. auto res = cli.Get(REDIR_PATH "?status_code=302", params, Headers{});
  13250. ASSERT_TRUE(res) << "Error: " << to_string(res.error());
  13251. EXPECT_EQ(StatusCode::OK_200, res->status);
  13252. }
  13253. TEST(HttpToHttpsRedirectTest, CertFile) {
  13254. auto ssl_port = PORT + 1;
  13255. Server svr;
  13256. ASSERT_TRUE(svr.is_valid());
  13257. svr.Get("/index", [&](const Request &, Response &res) {
  13258. res.set_redirect("https://127.0.0.1:" + std::to_string(ssl_port) +
  13259. "/index");
  13260. svr.stop();
  13261. });
  13262. SSLServer ssl_svr(SERVER_CERT2_FILE, SERVER_PRIVATE_KEY_FILE);
  13263. ASSERT_TRUE(ssl_svr.is_valid());
  13264. ssl_svr.Get("/index", [&](const Request &, Response &res) {
  13265. res.set_content("test", "text/plain");
  13266. ssl_svr.stop();
  13267. });
  13268. thread t = thread([&]() { ASSERT_TRUE(svr.listen("127.0.0.1", PORT)); });
  13269. thread t2 =
  13270. thread([&]() { ASSERT_TRUE(ssl_svr.listen("127.0.0.1", ssl_port)); });
  13271. auto se = detail::scope_exit([&] {
  13272. t2.join();
  13273. t.join();
  13274. ASSERT_FALSE(svr.is_running());
  13275. });
  13276. svr.wait_until_ready();
  13277. ssl_svr.wait_until_ready();
  13278. Client cli("127.0.0.1", PORT);
  13279. cli.set_ca_cert_path(SERVER_CERT2_FILE);
  13280. cli.enable_server_certificate_verification(true);
  13281. cli.set_follow_location(true);
  13282. cli.set_connection_timeout(30);
  13283. auto res = cli.Get("/index");
  13284. ASSERT_TRUE(res) << "Error: " << to_string(res.error());
  13285. ASSERT_EQ(StatusCode::OK_200, res->status);
  13286. }
  13287. TEST(SSLClientRedirectTest, CertFile) {
  13288. auto ssl_port = PORT + 1;
  13289. SSLServer ssl_svr1(SERVER_CERT2_FILE, SERVER_PRIVATE_KEY_FILE);
  13290. ASSERT_TRUE(ssl_svr1.is_valid());
  13291. ssl_svr1.Get("/index", [&](const Request &, Response &res) {
  13292. res.set_redirect("https://127.0.0.1:" + std::to_string(ssl_port) +
  13293. "/index");
  13294. ssl_svr1.stop();
  13295. });
  13296. SSLServer ssl_svr2(SERVER_CERT2_FILE, SERVER_PRIVATE_KEY_FILE);
  13297. ASSERT_TRUE(ssl_svr2.is_valid());
  13298. ssl_svr2.Get("/index", [&](const Request &, Response &res) {
  13299. res.set_content("test", "text/plain");
  13300. ssl_svr2.stop();
  13301. });
  13302. thread t = thread([&]() { ASSERT_TRUE(ssl_svr1.listen("127.0.0.1", PORT)); });
  13303. thread t2 =
  13304. thread([&]() { ASSERT_TRUE(ssl_svr2.listen("127.0.0.1", ssl_port)); });
  13305. auto se = detail::scope_exit([&] {
  13306. t2.join();
  13307. t.join();
  13308. ASSERT_FALSE(ssl_svr1.is_running());
  13309. });
  13310. ssl_svr1.wait_until_ready();
  13311. ssl_svr2.wait_until_ready();
  13312. SSLClient cli("127.0.0.1", PORT);
  13313. std::string cert;
  13314. read_file(SERVER_CERT2_FILE, cert);
  13315. cli.load_ca_cert_store(cert.c_str(), cert.size());
  13316. cli.enable_server_certificate_verification(true);
  13317. cli.set_follow_location(true);
  13318. cli.set_connection_timeout(30);
  13319. auto res = cli.Get("/index");
  13320. ASSERT_TRUE(res) << "Error: " << to_string(res.error());
  13321. ASSERT_EQ(StatusCode::OK_200, res->status);
  13322. }
  13323. #endif
  13324. #ifdef CPPHTTPLIB_SSL_ENABLED
  13325. // Test that set_ca_cert_store() skips system certs (consistent with
  13326. // set_ca_cert_path behavior). When a custom cert store is set, only those certs
  13327. // should be trusted - system certs should NOT be loaded.
  13328. TEST(SSLClientTest, SetCaCertStoreSkipsSystemCerts_Online) {
  13329. // Load a specific cert that is NOT a system CA cert
  13330. std::string cert;
  13331. read_file(SERVER_CERT2_FILE, cert);
  13332. SSLClient cli("google.com");
  13333. cli.load_ca_cert_store(cert.c_str(), cert.size());
  13334. cli.enable_server_certificate_verification(true);
  13335. // This should FAIL because:
  13336. // 1. We loaded only SERVER_CERT2 (a test cert, not a CA for google.com)
  13337. // 2. System certs should NOT be loaded when custom store is set
  13338. // If system certs WERE loaded, this would succeed
  13339. auto res = cli.Get("/");
  13340. ASSERT_FALSE(res);
  13341. EXPECT_EQ(Error::SSLServerVerification, res.error());
  13342. }
  13343. // Same as above, but through the native store handle path. Regression test:
  13344. // set_ca_cert_store() used to leave no trace on the client, so load_certs()
  13345. // merged system certs into the user-provided store.
  13346. TEST(SSLClientTest, SetCaCertStoreNativeSkipsSystemCerts_Online) {
  13347. std::string cert;
  13348. read_file(SERVER_CERT2_FILE, cert);
  13349. SSLClient cli("google.com");
  13350. cli.set_ca_cert_store(tls::create_ca_store(cert.c_str(), cert.size()));
  13351. cli.enable_server_certificate_verification(true);
  13352. auto res = cli.Get("/");
  13353. ASSERT_FALSE(res);
  13354. EXPECT_EQ(Error::SSLServerVerification, res.error());
  13355. }
  13356. // A custom store set via the native handle must still verify a server whose
  13357. // cert it does contain.
  13358. TEST(SSLClientTest, SetCaCertStoreNativeVerifiesLocalServer) {
  13359. SSLServer svr(SERVER_CERT2_FILE, SERVER_PRIVATE_KEY_FILE);
  13360. ASSERT_TRUE(svr.is_valid());
  13361. svr.Get("/test", [&](const Request &, Response &res) {
  13362. res.set_content("test", "text/plain");
  13363. });
  13364. thread t = thread([&]() { ASSERT_TRUE(svr.listen("127.0.0.1", PORT)); });
  13365. auto se = detail::scope_exit([&] {
  13366. svr.stop();
  13367. t.join();
  13368. ASSERT_FALSE(svr.is_running());
  13369. });
  13370. svr.wait_until_ready();
  13371. SSLClient cli("127.0.0.1", PORT);
  13372. std::string cert;
  13373. read_file(SERVER_CERT2_FILE, cert);
  13374. cli.set_ca_cert_store(tls::create_ca_store(cert.c_str(), cert.size()));
  13375. cli.enable_server_certificate_verification(true);
  13376. cli.set_connection_timeout(30);
  13377. auto res = cli.Get("/test");
  13378. ASSERT_TRUE(res) << "Error: " << to_string(res.error());
  13379. ASSERT_EQ(StatusCode::OK_200, res->status);
  13380. }
  13381. // CA certs loaded through the universal Client must be transferred to the
  13382. // client created internally for following an HTTPS redirect. Regression test:
  13383. // Client::load_ca_cert_store() used to bypass the PEM-based path that stores
  13384. // the CA data for redirect transfer.
  13385. TEST(UniversalClientRedirectTest, LoadCaCertStore) {
  13386. auto ssl_port = PORT + 1;
  13387. SSLServer ssl_svr1(SERVER_CERT2_FILE, SERVER_PRIVATE_KEY_FILE);
  13388. ASSERT_TRUE(ssl_svr1.is_valid());
  13389. ssl_svr1.Get("/index", [&](const Request &, Response &res) {
  13390. res.set_redirect("https://127.0.0.1:" + std::to_string(ssl_port) +
  13391. "/index");
  13392. });
  13393. SSLServer ssl_svr2(SERVER_CERT2_FILE, SERVER_PRIVATE_KEY_FILE);
  13394. ASSERT_TRUE(ssl_svr2.is_valid());
  13395. ssl_svr2.Get("/index", [&](const Request &, Response &res) {
  13396. res.set_content("test", "text/plain");
  13397. });
  13398. thread t = thread([&]() { ASSERT_TRUE(ssl_svr1.listen("127.0.0.1", PORT)); });
  13399. thread t2 =
  13400. thread([&]() { ASSERT_TRUE(ssl_svr2.listen("127.0.0.1", ssl_port)); });
  13401. auto se = detail::scope_exit([&] {
  13402. ssl_svr2.stop();
  13403. ssl_svr1.stop();
  13404. t2.join();
  13405. t.join();
  13406. ASSERT_FALSE(ssl_svr1.is_running());
  13407. });
  13408. ssl_svr1.wait_until_ready();
  13409. ssl_svr2.wait_until_ready();
  13410. Client cli("https://127.0.0.1:" + std::to_string(PORT));
  13411. std::string cert;
  13412. read_file(SERVER_CERT2_FILE, cert);
  13413. cli.load_ca_cert_store(cert.c_str(), cert.size());
  13414. cli.enable_server_certificate_verification(true);
  13415. cli.set_follow_location(true);
  13416. cli.set_connection_timeout(30);
  13417. auto res = cli.Get("/index");
  13418. ASSERT_TRUE(res) << "Error: " << to_string(res.error());
  13419. ASSERT_EQ(StatusCode::OK_200, res->status);
  13420. }
  13421. // enable_system_ca(true) loads system CA certs in addition to a custom CA,
  13422. // so a host signed by a system CA verifies even though a custom CA is set
  13423. TEST(SSLClientTest, EnableSystemCaWithCustomCa_Online) {
  13424. std::string cert;
  13425. read_file(SERVER_CERT2_FILE, cert);
  13426. SSLClient cli("google.com");
  13427. cli.load_ca_cert_store(cert.c_str(), cert.size());
  13428. cli.enable_system_ca(true);
  13429. cli.enable_server_certificate_verification(true);
  13430. auto res = cli.Get("/");
  13431. ASSERT_TRUE(res) << "Error: " << to_string(res.error());
  13432. ASSERT_EQ(StatusCode::MovedPermanently_301, res->status);
  13433. }
  13434. // The custom CA remains effective when combined with the system CA
  13435. TEST(SSLClientTest, EnableSystemCaCustomCaVerifiesLocalServer) {
  13436. SSLServer svr(SERVER_CERT2_FILE, SERVER_PRIVATE_KEY_FILE);
  13437. ASSERT_TRUE(svr.is_valid());
  13438. svr.Get("/test", [&](const Request &, Response &res) {
  13439. res.set_content("test", "text/plain");
  13440. });
  13441. thread t = thread([&]() { ASSERT_TRUE(svr.listen("127.0.0.1", PORT)); });
  13442. auto se = detail::scope_exit([&] {
  13443. svr.stop();
  13444. t.join();
  13445. ASSERT_FALSE(svr.is_running());
  13446. });
  13447. svr.wait_until_ready();
  13448. SSLClient cli("127.0.0.1", PORT);
  13449. std::string cert;
  13450. read_file(SERVER_CERT2_FILE, cert);
  13451. cli.load_ca_cert_store(cert.c_str(), cert.size());
  13452. cli.enable_system_ca(true);
  13453. cli.enable_server_certificate_verification(true);
  13454. cli.set_connection_timeout(30);
  13455. auto res = cli.Get("/test");
  13456. ASSERT_TRUE(res) << "Error: " << to_string(res.error());
  13457. ASSERT_EQ(StatusCode::OK_200, res->status);
  13458. }
  13459. // Regression test: for IP hosts the Mbed TLS and wolfSSL backends used to
  13460. // skip chain verification entirely (only the certificate identity was
  13461. // checked), so a server presenting an untrusted certificate with a matching
  13462. // IP SAN was accepted. The chain must be validated for IP hosts too.
  13463. TEST(SSLClientTest, IpHostUntrustedChainFails) {
  13464. SSLServer svr(SERVER_CERT2_FILE, SERVER_PRIVATE_KEY_FILE);
  13465. ASSERT_TRUE(svr.is_valid());
  13466. svr.Get("/test", [&](const Request &, Response &res) {
  13467. res.set_content("test", "text/plain");
  13468. });
  13469. thread t = thread([&]() { ASSERT_TRUE(svr.listen("127.0.0.1", PORT)); });
  13470. auto se = detail::scope_exit([&] {
  13471. svr.stop();
  13472. t.join();
  13473. ASSERT_FALSE(svr.is_running());
  13474. });
  13475. svr.wait_until_ready();
  13476. SSLClient cli("127.0.0.1", PORT);
  13477. std::string cert;
  13478. // A trusted CA that did not sign the server certificate. The server cert
  13479. // (cert2) carries the matching IP SAN, so only chain validation can reject
  13480. // this connection.
  13481. read_file(CLIENT_CA_CERT_FILE, cert);
  13482. cli.load_ca_cert_store(cert.c_str(), cert.size());
  13483. cli.enable_server_certificate_verification(true);
  13484. cli.set_connection_timeout(30);
  13485. auto res = cli.Get("/test");
  13486. ASSERT_FALSE(res);
  13487. }
  13488. // enable_system_ca(false) prevents system CA loading entirely
  13489. TEST(SSLClientTest, DisableSystemCa_Online) {
  13490. SSLClient cli("google.com");
  13491. cli.enable_system_ca(false);
  13492. cli.enable_server_certificate_verification(true);
  13493. auto res = cli.Get("/");
  13494. ASSERT_FALSE(res);
  13495. // OpenSSL reports a verification failure; Mbed TLS fails the handshake
  13496. // itself when the CA chain is empty
  13497. EXPECT_TRUE(res.error() == Error::SSLServerVerification ||
  13498. res.error() == Error::SSLConnection);
  13499. }
  13500. // The universal Client forwards enable_system_ca()
  13501. TEST(UniversalClientTest, EnableSystemCaWithCustomCa_Online) {
  13502. std::string cert;
  13503. read_file(SERVER_CERT2_FILE, cert);
  13504. Client cli("https://google.com");
  13505. cli.load_ca_cert_store(cert.c_str(), cert.size());
  13506. cli.enable_system_ca(true);
  13507. cli.enable_server_certificate_verification(true);
  13508. auto res = cli.Get("/");
  13509. ASSERT_TRUE(res) << "Error: " << to_string(res.error());
  13510. ASSERT_EQ(StatusCode::MovedPermanently_301, res->status);
  13511. }
  13512. // The system CA policy must carry over to the client created internally for
  13513. // following a cross-host HTTPS redirect
  13514. TEST(UniversalClientRedirectTest, EnableSystemCaCarriesOver_Online) {
  13515. SSLServer svr(SERVER_CERT2_FILE, SERVER_PRIVATE_KEY_FILE);
  13516. ASSERT_TRUE(svr.is_valid());
  13517. svr.Get("/index", [&](const Request &, Response &res) {
  13518. res.set_redirect("https://www.google.com/");
  13519. });
  13520. thread t = thread([&]() { ASSERT_TRUE(svr.listen("127.0.0.1", PORT)); });
  13521. auto se = detail::scope_exit([&] {
  13522. svr.stop();
  13523. t.join();
  13524. ASSERT_FALSE(svr.is_running());
  13525. });
  13526. svr.wait_until_ready();
  13527. Client cli("https://127.0.0.1:" + std::to_string(PORT));
  13528. std::string cert;
  13529. read_file(SERVER_CERT2_FILE, cert);
  13530. cli.load_ca_cert_store(cert.c_str(), cert.size());
  13531. cli.enable_system_ca(true);
  13532. cli.enable_server_certificate_verification(true);
  13533. cli.set_follow_location(true);
  13534. cli.set_connection_timeout(30);
  13535. // Receiving any response proves the redirect client completed the TLS
  13536. // handshake with a system-CA-signed host
  13537. auto res = cli.Get("/index");
  13538. ASSERT_TRUE(res) << "Error: " << to_string(res.error());
  13539. }
  13540. TEST(MultipartFormDataTest, LargeData) {
  13541. SSLServer svr(SERVER_CERT_FILE, SERVER_PRIVATE_KEY_FILE);
  13542. svr.Post("/post", [&](const Request &req, Response & /*res*/,
  13543. const ContentReader &content_reader) {
  13544. if (req.is_multipart_form_data()) {
  13545. std::vector<FormData> items;
  13546. content_reader(
  13547. [&](const FormData &file) {
  13548. items.push_back(file);
  13549. return true;
  13550. },
  13551. [&](const char *data, size_t data_length) {
  13552. items.back().content.append(data, data_length);
  13553. return true;
  13554. });
  13555. EXPECT_TRUE(std::string(items[0].name) == "document");
  13556. EXPECT_EQ(size_t(1024 * 1024 * 2), items[0].content.size());
  13557. EXPECT_TRUE(items[0].filename == "2MB_data");
  13558. EXPECT_TRUE(items[0].content_type == "application/octet-stream");
  13559. EXPECT_TRUE(items[1].name == "hello");
  13560. EXPECT_TRUE(items[1].content == "world");
  13561. EXPECT_TRUE(items[1].filename == "");
  13562. EXPECT_TRUE(items[1].content_type == "");
  13563. } else {
  13564. std::string body;
  13565. content_reader([&](const char *data, size_t data_length) {
  13566. body.append(data, data_length);
  13567. return true;
  13568. });
  13569. }
  13570. });
  13571. auto port = svr.bind_to_any_port(HOST);
  13572. auto t = std::thread([&]() { svr.listen_after_bind(); });
  13573. auto se = detail::scope_exit([&] {
  13574. svr.stop();
  13575. t.join();
  13576. ASSERT_FALSE(svr.is_running());
  13577. });
  13578. svr.wait_until_ready();
  13579. {
  13580. std::string data(1024 * 1024 * 2, '.');
  13581. std::stringstream buffer;
  13582. buffer << data;
  13583. SSLClient cli(HOST, port);
  13584. cli.enable_server_certificate_verification(false);
  13585. UploadFormDataItems items{
  13586. {"document", buffer.str(), "2MB_data", "application/octet-stream"},
  13587. {"hello", "world", "", ""},
  13588. };
  13589. auto res = cli.Post("/post", items);
  13590. ASSERT_TRUE(res) << "Error: " << to_string(res.error());
  13591. ASSERT_EQ(StatusCode::OK_200, res->status);
  13592. }
  13593. }
  13594. TEST(MultipartFormDataTest, DataProviderItems) {
  13595. std::random_device seed_gen;
  13596. std::mt19937 random(seed_gen());
  13597. std::string rand1;
  13598. rand1.resize(1000);
  13599. std::generate(rand1.begin(), rand1.end(), [&]() { return random(); });
  13600. std::string rand2;
  13601. rand2.resize(3000);
  13602. std::generate(rand2.begin(), rand2.end(), [&]() { return random(); });
  13603. SSLServer svr(SERVER_CERT_FILE, SERVER_PRIVATE_KEY_FILE);
  13604. svr.Post("/post-none", [&](const Request &req, Response & /*res*/,
  13605. const ContentReader &content_reader) {
  13606. ASSERT_FALSE(req.is_multipart_form_data());
  13607. std::string body;
  13608. content_reader([&](const char *data, size_t data_length) {
  13609. body.append(data, data_length);
  13610. return true;
  13611. });
  13612. EXPECT_EQ(body, "");
  13613. });
  13614. svr.Post("/post-items", [&](const Request &req, Response & /*res*/,
  13615. const ContentReader &content_reader) {
  13616. ASSERT_TRUE(req.is_multipart_form_data());
  13617. std::vector<FormData> items;
  13618. content_reader(
  13619. [&](const FormData &file) {
  13620. items.push_back(file);
  13621. return true;
  13622. },
  13623. [&](const char *data, size_t data_length) {
  13624. items.back().content.append(data, data_length);
  13625. return true;
  13626. });
  13627. ASSERT_TRUE(items.size() == 2);
  13628. EXPECT_EQ(std::string(items[0].name), "name1");
  13629. EXPECT_EQ(items[0].content, "Testing123");
  13630. EXPECT_EQ(items[0].filename, "filename1");
  13631. EXPECT_EQ(items[0].content_type, "application/octet-stream");
  13632. EXPECT_EQ(items[1].name, "name2");
  13633. EXPECT_EQ(items[1].content, "Testing456");
  13634. EXPECT_EQ(items[1].filename, "");
  13635. EXPECT_EQ(items[1].content_type, "");
  13636. });
  13637. svr.Post("/post-providers", [&](const Request &req, Response & /*res*/,
  13638. const ContentReader &content_reader) {
  13639. ASSERT_TRUE(req.is_multipart_form_data());
  13640. std::vector<FormData> items;
  13641. content_reader(
  13642. [&](const FormData &file) {
  13643. items.push_back(file);
  13644. return true;
  13645. },
  13646. [&](const char *data, size_t data_length) {
  13647. items.back().content.append(data, data_length);
  13648. return true;
  13649. });
  13650. ASSERT_TRUE(items.size() == 2);
  13651. EXPECT_EQ(items[0].name, "name3");
  13652. EXPECT_EQ(items[0].content, rand1);
  13653. EXPECT_EQ(items[0].filename, "filename3");
  13654. EXPECT_EQ(items[0].content_type, "");
  13655. EXPECT_EQ(items[1].name, "name4");
  13656. EXPECT_EQ(items[1].content, rand2);
  13657. EXPECT_EQ(items[1].filename, "filename4");
  13658. EXPECT_EQ(items[1].content_type, "");
  13659. });
  13660. svr.Post("/post-both", [&](const Request &req, Response & /*res*/,
  13661. const ContentReader &content_reader) {
  13662. ASSERT_TRUE(req.is_multipart_form_data());
  13663. std::vector<FormData> items;
  13664. content_reader(
  13665. [&](const FormData &file) {
  13666. items.push_back(file);
  13667. return true;
  13668. },
  13669. [&](const char *data, size_t data_length) {
  13670. items.back().content.append(data, data_length);
  13671. return true;
  13672. });
  13673. ASSERT_TRUE(items.size() == 4);
  13674. EXPECT_EQ(std::string(items[0].name), "name1");
  13675. EXPECT_EQ(items[0].content, "Testing123");
  13676. EXPECT_EQ(items[0].filename, "filename1");
  13677. EXPECT_EQ(items[0].content_type, "application/octet-stream");
  13678. EXPECT_EQ(items[1].name, "name2");
  13679. EXPECT_EQ(items[1].content, "Testing456");
  13680. EXPECT_EQ(items[1].filename, "");
  13681. EXPECT_EQ(items[1].content_type, "");
  13682. EXPECT_EQ(items[2].name, "name3");
  13683. EXPECT_EQ(items[2].content, rand1);
  13684. EXPECT_EQ(items[2].filename, "filename3");
  13685. EXPECT_EQ(items[2].content_type, "");
  13686. EXPECT_EQ(items[3].name, "name4");
  13687. EXPECT_EQ(items[3].content, rand2);
  13688. EXPECT_EQ(items[3].filename, "filename4");
  13689. EXPECT_EQ(items[3].content_type, "");
  13690. });
  13691. auto port = svr.bind_to_any_port("localhost");
  13692. auto t = std::thread([&]() { svr.listen_after_bind(); });
  13693. auto se = detail::scope_exit([&] {
  13694. svr.stop();
  13695. t.join();
  13696. ASSERT_FALSE(svr.is_running());
  13697. });
  13698. svr.wait_until_ready();
  13699. {
  13700. SSLClient cli("localhost", port);
  13701. cli.enable_server_certificate_verification(false);
  13702. UploadFormDataItems items{
  13703. {"name1", "Testing123", "filename1", "application/octet-stream"},
  13704. {"name2", "Testing456", "", ""}, // not a file
  13705. };
  13706. {
  13707. auto res = cli.Post("/post-none", {}, {}, {});
  13708. ASSERT_TRUE(res) << "Error: " << to_string(res.error());
  13709. ASSERT_EQ(StatusCode::OK_200, res->status);
  13710. }
  13711. FormDataProviderItems providers;
  13712. {
  13713. auto res =
  13714. cli.Post("/post-items", {}, items, providers); // empty providers
  13715. ASSERT_TRUE(res) << "Error: " << to_string(res.error());
  13716. ASSERT_EQ(StatusCode::OK_200, res->status);
  13717. }
  13718. providers.push_back({"name3",
  13719. [&](size_t offset, httplib::DataSink &sink) -> bool {
  13720. // test the offset is given correctly at each step
  13721. if (!offset)
  13722. sink.os.write(rand1.data(), 30);
  13723. else if (offset == 30)
  13724. sink.os.write(rand1.data() + 30, 300);
  13725. else if (offset == 330)
  13726. sink.os.write(rand1.data() + 330, 670);
  13727. else if (offset == rand1.size())
  13728. sink.done();
  13729. return true;
  13730. },
  13731. "filename3",
  13732. {}});
  13733. providers.push_back({"name4",
  13734. [&](size_t offset, httplib::DataSink &sink) -> bool {
  13735. // test the offset is given correctly at each step
  13736. if (!offset)
  13737. sink.os.write(rand2.data(), 2000);
  13738. else if (offset == 2000)
  13739. sink.os.write(rand2.data() + 2000, 1);
  13740. else if (offset == 2001)
  13741. sink.os.write(rand2.data() + 2001, 999);
  13742. else if (offset == rand2.size())
  13743. sink.done();
  13744. return true;
  13745. },
  13746. "filename4",
  13747. {}});
  13748. {
  13749. auto res = cli.Post("/post-providers", {}, {}, providers);
  13750. ASSERT_TRUE(res) << "Error: " << to_string(res.error());
  13751. ASSERT_EQ(StatusCode::OK_200, res->status);
  13752. }
  13753. {
  13754. auto res = cli.Post("/post-both", {}, items, providers);
  13755. ASSERT_TRUE(res) << "Error: " << to_string(res.error());
  13756. ASSERT_EQ(StatusCode::OK_200, res->status);
  13757. }
  13758. }
  13759. }
  13760. TEST(MultipartFormDataTest, BadHeader) {
  13761. Server svr;
  13762. svr.Post("/post", [&](const Request & /*req*/, Response &res) {
  13763. res.set_content("ok", "text/plain");
  13764. });
  13765. thread t = thread([&] { svr.listen(HOST, PORT); });
  13766. auto se = detail::scope_exit([&] {
  13767. svr.stop();
  13768. t.join();
  13769. ASSERT_FALSE(svr.is_running());
  13770. });
  13771. svr.wait_until_ready();
  13772. const std::string body =
  13773. "This is the preamble. It is to be ignored, though it\r\n"
  13774. "is a handy place for composition agents to include an\r\n"
  13775. "explanatory note to non-MIME conformant readers.\r\n"
  13776. "\r\n"
  13777. "\r\n"
  13778. "--simple boundary\r\n"
  13779. "Content-Disposition: form-data; name=\"field1\"\r\n"
  13780. ": BAD...\r\n"
  13781. "\r\n"
  13782. "value1\r\n"
  13783. "--simple boundary\r\n"
  13784. "Content-Disposition: form-data; name=\"field2\"; "
  13785. "filename=\"example.txt\"\r\n"
  13786. "\r\n"
  13787. "value2\r\n"
  13788. "--simple boundary--\r\n"
  13789. "This is the epilogue. It is also to be ignored.\r\n";
  13790. std::string content_type =
  13791. R"(multipart/form-data; boundary="simple boundary")";
  13792. Client cli(HOST, PORT);
  13793. auto res = cli.Post("/post", body, content_type.c_str());
  13794. ASSERT_TRUE(res) << "Error: " << to_string(res.error());
  13795. EXPECT_EQ(StatusCode::BadRequest_400, res->status);
  13796. }
  13797. TEST(MultipartFormDataTest, WithPreamble) {
  13798. Server svr;
  13799. svr.Post("/post", [&](const Request & /*req*/, Response &res) {
  13800. res.set_content("ok", "text/plain");
  13801. });
  13802. thread t = thread([&] { svr.listen(HOST, PORT); });
  13803. auto se = detail::scope_exit([&] {
  13804. svr.stop();
  13805. t.join();
  13806. ASSERT_FALSE(svr.is_running());
  13807. });
  13808. svr.wait_until_ready();
  13809. const std::string body =
  13810. "This is the preamble. It is to be ignored, though it\r\n"
  13811. "is a handy place for composition agents to include an\r\n"
  13812. "explanatory note to non-MIME conformant readers.\r\n"
  13813. "\r\n"
  13814. "\r\n"
  13815. "--simple boundary\r\n"
  13816. "Content-Disposition: form-data; name=\"field1\"\r\n"
  13817. "\r\n"
  13818. "value1\r\n"
  13819. "--simple boundary\r\n"
  13820. "Content-Disposition: form-data; name=\"field2\"; "
  13821. "filename=\"example.txt\"\r\n"
  13822. "\r\n"
  13823. "value2\r\n"
  13824. "--simple boundary--\r\n"
  13825. "This is the epilogue. It is also to be ignored.\r\n";
  13826. std::string content_type =
  13827. R"(multipart/form-data; boundary="simple boundary")";
  13828. Client cli(HOST, PORT);
  13829. auto res = cli.Post("/post", body, content_type.c_str());
  13830. ASSERT_TRUE(res) << "Error: " << to_string(res.error());
  13831. EXPECT_EQ(StatusCode::OK_200, res->status);
  13832. }
  13833. TEST(MultipartFormDataTest, PostCustomBoundary) {
  13834. SSLServer svr(SERVER_CERT_FILE, SERVER_PRIVATE_KEY_FILE);
  13835. svr.Post("/post_customboundary", [&](const Request &req, Response & /*res*/,
  13836. const ContentReader &content_reader) {
  13837. if (req.is_multipart_form_data()) {
  13838. std::vector<FormData> items;
  13839. content_reader(
  13840. [&](const FormData &file) {
  13841. items.push_back(file);
  13842. return true;
  13843. },
  13844. [&](const char *data, size_t data_length) {
  13845. items.back().content.append(data, data_length);
  13846. return true;
  13847. });
  13848. EXPECT_TRUE(std::string(items[0].name) == "document");
  13849. EXPECT_EQ(size_t(1024 * 1024 * 2), items[0].content.size());
  13850. EXPECT_TRUE(items[0].filename == "2MB_data");
  13851. EXPECT_TRUE(items[0].content_type == "application/octet-stream");
  13852. EXPECT_TRUE(items[1].name == "hello");
  13853. EXPECT_TRUE(items[1].content == "world");
  13854. EXPECT_TRUE(items[1].filename == "");
  13855. EXPECT_TRUE(items[1].content_type == "");
  13856. } else {
  13857. std::string body;
  13858. content_reader([&](const char *data, size_t data_length) {
  13859. body.append(data, data_length);
  13860. return true;
  13861. });
  13862. }
  13863. });
  13864. auto port = svr.bind_to_any_port("localhost");
  13865. auto t = std::thread([&]() { svr.listen_after_bind(); });
  13866. auto se = detail::scope_exit([&] {
  13867. svr.stop();
  13868. t.join();
  13869. ASSERT_FALSE(svr.is_running());
  13870. });
  13871. svr.wait_until_ready();
  13872. {
  13873. std::string data(1024 * 1024 * 2, '.');
  13874. std::stringstream buffer;
  13875. buffer << data;
  13876. SSLClient cli("localhost", port);
  13877. cli.enable_server_certificate_verification(false);
  13878. UploadFormDataItems items{
  13879. {"document", buffer.str(), "2MB_data", "application/octet-stream"},
  13880. {"hello", "world", "", ""},
  13881. };
  13882. auto res = cli.Post("/post_customboundary", {}, items, "abc-abc");
  13883. ASSERT_TRUE(res) << "Error: " << to_string(res.error());
  13884. ASSERT_EQ(StatusCode::OK_200, res->status);
  13885. }
  13886. }
  13887. TEST(MultipartFormDataTest, PostInvalidBoundaryChars) {
  13888. std::string data(1024 * 1024 * 2, '&');
  13889. std::stringstream buffer;
  13890. buffer << data;
  13891. Client cli("https://localhost:8080");
  13892. UploadFormDataItems items{
  13893. {"document", buffer.str(), "2MB_data", "application/octet-stream"},
  13894. {"hello", "world", "", ""},
  13895. };
  13896. for (const char &c : " \t\r\n") {
  13897. auto res =
  13898. cli.Post("/invalid_boundary", {}, items, string("abc123").append(1, c));
  13899. ASSERT_EQ(Error::UnsupportedMultipartBoundaryChars, res.error());
  13900. ASSERT_FALSE(res);
  13901. }
  13902. }
  13903. TEST(MultipartFormDataTest, PutFormData) {
  13904. SSLServer svr(SERVER_CERT_FILE, SERVER_PRIVATE_KEY_FILE);
  13905. svr.Put("/put", [&](const Request &req, const Response & /*res*/,
  13906. const ContentReader &content_reader) {
  13907. if (req.is_multipart_form_data()) {
  13908. std::vector<FormData> items;
  13909. content_reader(
  13910. [&](const FormData &file) {
  13911. items.push_back(file);
  13912. return true;
  13913. },
  13914. [&](const char *data, size_t data_length) {
  13915. items.back().content.append(data, data_length);
  13916. return true;
  13917. });
  13918. EXPECT_TRUE(std::string(items[0].name) == "document");
  13919. EXPECT_EQ(size_t(1024 * 1024 * 2), items[0].content.size());
  13920. EXPECT_TRUE(items[0].filename == "2MB_data");
  13921. EXPECT_TRUE(items[0].content_type == "application/octet-stream");
  13922. EXPECT_TRUE(items[1].name == "hello");
  13923. EXPECT_TRUE(items[1].content == "world");
  13924. EXPECT_TRUE(items[1].filename == "");
  13925. EXPECT_TRUE(items[1].content_type == "");
  13926. } else {
  13927. std::string body;
  13928. content_reader([&](const char *data, size_t data_length) {
  13929. body.append(data, data_length);
  13930. return true;
  13931. });
  13932. }
  13933. });
  13934. auto port = svr.bind_to_any_port("localhost");
  13935. auto t = std::thread([&]() { svr.listen_after_bind(); });
  13936. auto se = detail::scope_exit([&] {
  13937. svr.stop();
  13938. t.join();
  13939. ASSERT_FALSE(svr.is_running());
  13940. });
  13941. svr.wait_until_ready();
  13942. {
  13943. std::string data(1024 * 1024 * 2, '&');
  13944. std::stringstream buffer;
  13945. buffer << data;
  13946. SSLClient cli("localhost", port);
  13947. cli.enable_server_certificate_verification(false);
  13948. UploadFormDataItems items{
  13949. {"document", buffer.str(), "2MB_data", "application/octet-stream"},
  13950. {"hello", "world", "", ""},
  13951. };
  13952. auto res = cli.Put("/put", items);
  13953. ASSERT_TRUE(res) << "Error: " << to_string(res.error());
  13954. ASSERT_EQ(StatusCode::OK_200, res->status);
  13955. }
  13956. }
  13957. TEST(MultipartFormDataTest, PutFormDataCustomBoundary) {
  13958. SSLServer svr(SERVER_CERT_FILE, SERVER_PRIVATE_KEY_FILE);
  13959. svr.Put("/put_customboundary",
  13960. [&](const Request &req, const Response & /*res*/,
  13961. const ContentReader &content_reader) {
  13962. if (req.is_multipart_form_data()) {
  13963. std::vector<FormData> items;
  13964. content_reader(
  13965. [&](const FormData &file) {
  13966. items.push_back(file);
  13967. return true;
  13968. },
  13969. [&](const char *data, size_t data_length) {
  13970. items.back().content.append(data, data_length);
  13971. return true;
  13972. });
  13973. EXPECT_TRUE(std::string(items[0].name) == "document");
  13974. EXPECT_EQ(size_t(1024 * 1024 * 2), items[0].content.size());
  13975. EXPECT_TRUE(items[0].filename == "2MB_data");
  13976. EXPECT_TRUE(items[0].content_type == "application/octet-stream");
  13977. EXPECT_TRUE(items[1].name == "hello");
  13978. EXPECT_TRUE(items[1].content == "world");
  13979. EXPECT_TRUE(items[1].filename == "");
  13980. EXPECT_TRUE(items[1].content_type == "");
  13981. } else {
  13982. std::string body;
  13983. content_reader([&](const char *data, size_t data_length) {
  13984. body.append(data, data_length);
  13985. return true;
  13986. });
  13987. }
  13988. });
  13989. auto port = svr.bind_to_any_port("localhost");
  13990. auto t = std::thread([&]() { svr.listen_after_bind(); });
  13991. auto se = detail::scope_exit([&] {
  13992. svr.stop();
  13993. t.join();
  13994. ASSERT_FALSE(svr.is_running());
  13995. });
  13996. svr.wait_until_ready();
  13997. {
  13998. std::string data(1024 * 1024 * 2, '&');
  13999. std::stringstream buffer;
  14000. buffer << data;
  14001. SSLClient cli("localhost", port);
  14002. cli.enable_server_certificate_verification(false);
  14003. UploadFormDataItems items{
  14004. {"document", buffer.str(), "2MB_data", "application/octet-stream"},
  14005. {"hello", "world", "", ""},
  14006. };
  14007. auto res = cli.Put("/put_customboundary", {}, items, "abc-abc_");
  14008. ASSERT_TRUE(res) << "Error: " << to_string(res.error());
  14009. ASSERT_EQ(StatusCode::OK_200, res->status);
  14010. }
  14011. }
  14012. TEST(MultipartFormDataTest, PutInvalidBoundaryChars) {
  14013. std::string data(1024 * 1024 * 2, '&');
  14014. std::stringstream buffer;
  14015. buffer << data;
  14016. Client cli("https://localhost:8080");
  14017. cli.enable_server_certificate_verification(false);
  14018. UploadFormDataItems items{
  14019. {"document", buffer.str(), "2MB_data", "application/octet-stream"},
  14020. {"hello", "world", "", ""},
  14021. };
  14022. for (const char &c : " \t\r\n") {
  14023. auto res = cli.Put("/put", {}, items, string("abc123").append(1, c));
  14024. ASSERT_EQ(Error::UnsupportedMultipartBoundaryChars, res.error());
  14025. ASSERT_FALSE(res);
  14026. }
  14027. }
  14028. TEST(MultipartFormDataTest, AlternateFilename) {
  14029. auto handled = false;
  14030. Server svr;
  14031. svr.Post("/test", [&](const Request &req, Response &res) {
  14032. ASSERT_EQ(2u, req.form.files.size());
  14033. ASSERT_EQ(1u, req.form.fields.size());
  14034. // Test files
  14035. const auto &file1 = req.form.get_file("file1");
  14036. ASSERT_EQ("file1", file1.name);
  14037. ASSERT_EQ("A.txt", file1.filename);
  14038. ASSERT_EQ("text/plain", file1.content_type);
  14039. ASSERT_EQ("Content of a.txt.\r\n", file1.content);
  14040. const auto &file2 = req.form.get_file("file2");
  14041. ASSERT_EQ("file2", file2.name);
  14042. ASSERT_EQ("a.html", file2.filename);
  14043. ASSERT_EQ("text/html", file2.content_type);
  14044. ASSERT_EQ("<!DOCTYPE html><title>Content of a.html.</title>\r\n",
  14045. file2.content);
  14046. // Test text field
  14047. const auto &text = req.form.get_field("text");
  14048. ASSERT_EQ("text default", text);
  14049. res.set_content("ok", "text/plain");
  14050. handled = true;
  14051. });
  14052. thread t = thread([&] { svr.listen(HOST, PORT); });
  14053. auto se = detail::scope_exit([&] {
  14054. svr.stop();
  14055. t.join();
  14056. ASSERT_FALSE(svr.is_running());
  14057. ASSERT_TRUE(handled);
  14058. });
  14059. svr.wait_until_ready();
  14060. auto req = "POST /test HTTP/1.1\r\n"
  14061. "Content-Type: multipart/form-data;boundary=--------\r\n"
  14062. "Content-Length: 399\r\n"
  14063. "\r\n"
  14064. "----------\r\n"
  14065. "Content-Disposition: form-data; name=\"text\"\r\n"
  14066. "\r\n"
  14067. "text default\r\n"
  14068. "----------\r\n"
  14069. "Content-Disposition: form-data; filename*=\"UTF-8''%41.txt\"; "
  14070. "filename=\"a.txt\"; name=\"file1\"\r\n"
  14071. "Content-Type: text/plain\r\n"
  14072. "\r\n"
  14073. "Content of a.txt.\r\n"
  14074. "\r\n"
  14075. "----------\r\n"
  14076. "Content-Disposition: form-data; name=\"file2\" ;filename = "
  14077. "\"a.html\"\r\n"
  14078. "Content-Type: text/html\r\n"
  14079. "\r\n"
  14080. "<!DOCTYPE html><title>Content of a.html.</title>\r\n"
  14081. "\r\n"
  14082. "------------\r\n";
  14083. ASSERT_TRUE(send_request(1, req));
  14084. }
  14085. TEST(MultipartFormDataTest, AlternateFilenameLongValueAndCaseInsensitive) {
  14086. auto handled = false;
  14087. Server svr;
  14088. svr.Post("/test", [&](const Request &req, Response &res) {
  14089. // Case-insensitive "utf-8''" prefix with a long value
  14090. const auto &file = req.form.get_file("file1");
  14091. ASSERT_EQ("file1", file.name);
  14092. // 8000 chars exercises both the Content-Disposition parser and the
  14093. // filename* parser near the CPPHTTPLIB_HEADER_MAX_LENGTH limit (8192).
  14094. // Prior to the fix, std::regex_match on this header would cause O(N)
  14095. // stack recursion in libstdc++, leading to SIGSEGV.
  14096. std::string expected_filename(8000, 'A');
  14097. ASSERT_EQ(expected_filename, file.filename);
  14098. res.set_content("ok", "text/plain");
  14099. handled = true;
  14100. });
  14101. thread t = thread([&] { svr.listen(HOST, PORT); });
  14102. auto se = detail::scope_exit([&] {
  14103. svr.stop();
  14104. t.join();
  14105. ASSERT_FALSE(svr.is_running());
  14106. ASSERT_TRUE(handled);
  14107. });
  14108. svr.wait_until_ready();
  14109. // Build body with a long filename* value using mixed-case prefix "Utf-8''"
  14110. // Regression test for GHSA-qq6v-r583-3h69
  14111. std::string long_filename(8000, 'A');
  14112. std::string body = "----------\r\n"
  14113. "Content-Disposition: form-data; name=\"file1\"; "
  14114. "filename*=\"Utf-8''" +
  14115. long_filename +
  14116. "\"\r\n"
  14117. "\r\n"
  14118. "hello\r\n"
  14119. "------------\r\n";
  14120. auto req = "POST /test HTTP/1.1\r\n"
  14121. "Content-Type: multipart/form-data;boundary=--------\r\n"
  14122. "Content-Length: " +
  14123. std::to_string(body.size()) + "\r\n\r\n" + body;
  14124. ASSERT_TRUE(send_request(1, req));
  14125. }
  14126. TEST(MultipartFormDataTest, CloseDelimiterWithoutCRLF) {
  14127. auto handled = false;
  14128. Server svr;
  14129. svr.Post("/test", [&](const Request &req, Response &) {
  14130. ASSERT_EQ(2u, req.form.fields.size());
  14131. const auto &text1 = req.form.get_field("text1");
  14132. ASSERT_EQ("text1", text1);
  14133. const auto &text2 = req.form.get_field("text2");
  14134. ASSERT_EQ("text2", text2);
  14135. handled = true;
  14136. });
  14137. thread t = thread([&] { svr.listen(HOST, PORT); });
  14138. auto se = detail::scope_exit([&] {
  14139. svr.stop();
  14140. t.join();
  14141. ASSERT_FALSE(svr.is_running());
  14142. ASSERT_TRUE(handled);
  14143. });
  14144. svr.wait_until_ready();
  14145. auto req = "POST /test HTTP/1.1\r\n"
  14146. "Content-Type: multipart/form-data;boundary=--------\r\n"
  14147. "Content-Length: 146\r\n"
  14148. "\r\n----------\r\n"
  14149. "Content-Disposition: form-data; name=\"text1\"\r\n"
  14150. "\r\n"
  14151. "text1"
  14152. "\r\n----------\r\n"
  14153. "Content-Disposition: form-data; name=\"text2\"\r\n"
  14154. "\r\n"
  14155. "text2"
  14156. "\r\n------------";
  14157. std::string response;
  14158. ASSERT_TRUE(send_request(1, req, &response));
  14159. ASSERT_EQ("200", response.substr(9, 3));
  14160. }
  14161. TEST(MultipartFormDataTest, ContentLength) {
  14162. auto handled = false;
  14163. Server svr;
  14164. svr.Post("/test", [&](const Request &req, Response &) {
  14165. ASSERT_EQ(2u, req.form.fields.size());
  14166. const auto &text1 = req.form.get_field("text1");
  14167. ASSERT_EQ("text1", text1);
  14168. const auto &text2 = req.form.get_field("text2");
  14169. ASSERT_EQ("text2", text2);
  14170. handled = true;
  14171. });
  14172. thread t = thread([&] { svr.listen(HOST, PORT); });
  14173. auto se = detail::scope_exit([&] {
  14174. svr.stop();
  14175. t.join();
  14176. ASSERT_FALSE(svr.is_running());
  14177. ASSERT_TRUE(handled);
  14178. });
  14179. svr.wait_until_ready();
  14180. auto req = "POST /test HTTP/1.1\r\n"
  14181. "Content-Type: multipart/form-data;boundary=--------\r\n"
  14182. "Content-Length: 167\r\n"
  14183. "\r\n----------\r\n"
  14184. "Content-Disposition: form-data; name=\"text1\"\r\n"
  14185. "Content-Length: 5\r\n"
  14186. "\r\n"
  14187. "text1"
  14188. "\r\n----------\r\n"
  14189. "Content-Disposition: form-data; name=\"text2\"\r\n"
  14190. "\r\n"
  14191. "text2"
  14192. "\r\n------------\r\n";
  14193. std::string response;
  14194. ASSERT_TRUE(send_request(1, req, &response));
  14195. ASSERT_EQ("200", response.substr(9, 3));
  14196. }
  14197. TEST(MultipartFormDataTest, AccessPartHeaders) {
  14198. auto handled = false;
  14199. Server svr;
  14200. svr.Post("/test", [&](const Request &req, Response &) {
  14201. ASSERT_EQ(2u, req.form.fields.size());
  14202. const auto &text1 = req.form.get_field("text1");
  14203. ASSERT_EQ("text1", text1);
  14204. // TODO: Add header access for text fields if needed
  14205. const auto &text2 = req.form.get_field("text2");
  14206. ASSERT_EQ("text2", text2);
  14207. // TODO: Header access for text fields needs to be implemented
  14208. // auto &headers = it->second.headers;
  14209. // ASSERT_EQ(3U, headers.size());
  14210. // auto custom_header = headers.find("x-whatever");
  14211. // ASSERT_TRUE(custom_header != headers.end());
  14212. // ASSERT_NE("customvalue", custom_header->second);
  14213. // ASSERT_EQ("CustomValue", custom_header->second);
  14214. // ASSERT_TRUE(headers.find("X-Test") == headers.end()); // text1 header
  14215. handled = true;
  14216. });
  14217. thread t = thread([&] { svr.listen(HOST, PORT); });
  14218. auto se = detail::scope_exit([&] {
  14219. svr.stop();
  14220. t.join();
  14221. ASSERT_FALSE(svr.is_running());
  14222. ASSERT_TRUE(handled);
  14223. });
  14224. svr.wait_until_ready();
  14225. auto req = "POST /test HTTP/1.1\r\n"
  14226. "Content-Type: multipart/form-data;boundary=--------\r\n"
  14227. "Content-Length: 232\r\n"
  14228. "\r\n----------\r\n"
  14229. "Content-Disposition: form-data; name=\"text1\"\r\n"
  14230. "Content-Length: 5\r\n"
  14231. "X-Test: 1\r\n"
  14232. "\r\n"
  14233. "text1"
  14234. "\r\n----------\r\n"
  14235. "Content-Disposition: form-data; name=\"text2\"\r\n"
  14236. "Content-Type: text/plain\r\n"
  14237. "X-Whatever: CustomValue\r\n"
  14238. "\r\n"
  14239. "text2"
  14240. "\r\n------------\r\n"
  14241. "That should be disregarded. Not even read";
  14242. std::string response;
  14243. ASSERT_TRUE(send_request(1, req, &response));
  14244. ASSERT_EQ("200", response.substr(9, 3));
  14245. }
  14246. TEST(MultipartFormDataTest, LargeHeader) {
  14247. auto handled = false;
  14248. Server svr;
  14249. svr.Post("/test", [&](const Request &req, Response &) {
  14250. ASSERT_EQ(1u, req.form.fields.size());
  14251. const auto &text = req.form.get_field("name1");
  14252. ASSERT_EQ("text1", text);
  14253. handled = true;
  14254. });
  14255. thread t = thread([&] { svr.listen(HOST, PORT); });
  14256. auto se = detail::scope_exit([&] {
  14257. svr.stop();
  14258. t.join();
  14259. ASSERT_FALSE(svr.is_running());
  14260. ASSERT_TRUE(handled);
  14261. });
  14262. svr.wait_until_ready();
  14263. auto boundary = std::string("cpp-httplib-multipart-data");
  14264. std::string content = "--" + boundary +
  14265. "\r\n"
  14266. "Content-Disposition: form-data; name=\"name1\"\r\n"
  14267. "\r\n"
  14268. "text1\r\n"
  14269. "--" +
  14270. boundary + "--\r\n";
  14271. std::string header_prefix = "POST /test HTTP/1.1\r\n"
  14272. "Content-Type: multipart/form-data;boundary=" +
  14273. boundary +
  14274. "\r\n"
  14275. "Content-Length: " +
  14276. std::to_string(content.size()) +
  14277. "\r\n"
  14278. "Dummy-Header: ";
  14279. std::string header_suffix = "\r\n"
  14280. "\r\n";
  14281. size_t read_buff_size = 1024u * 4; // SocketStream::read_buff_size_
  14282. size_t header_dummy_size =
  14283. read_buff_size -
  14284. (header_prefix.size() + header_suffix.size() + boundary.size() / 2);
  14285. auto header_dummy = std::string(header_dummy_size, '@');
  14286. auto req = header_prefix + header_dummy + header_suffix + content;
  14287. std::string response;
  14288. ASSERT_TRUE(send_request(1, req, &response));
  14289. ASSERT_EQ("200", response.substr(9, 3));
  14290. }
  14291. TEST(MultipartFormDataTest, UploadItemsHasContentLength) {
  14292. // Verify that Post(path, headers, UploadFormDataItems) sends Content-Length
  14293. // (not chunked Transfer-Encoding) after the streaming refactor.
  14294. auto handled = false;
  14295. Server svr;
  14296. svr.Post("/upload", [&](const Request &req, Response &res) {
  14297. auto cl_it = req.headers.find("Content-Length");
  14298. EXPECT_TRUE(cl_it != req.headers.end());
  14299. auto te_it = req.headers.find("Transfer-Encoding");
  14300. EXPECT_TRUE(te_it == req.headers.end());
  14301. EXPECT_EQ(2u, req.form.fields.size() + req.form.files.size());
  14302. res.set_content("ok", "text/plain");
  14303. handled = true;
  14304. });
  14305. auto port = svr.bind_to_any_port(HOST);
  14306. auto t = thread([&] { svr.listen_after_bind(); });
  14307. auto se = detail::scope_exit([&] {
  14308. svr.stop();
  14309. t.join();
  14310. ASSERT_FALSE(svr.is_running());
  14311. ASSERT_TRUE(handled);
  14312. });
  14313. svr.wait_until_ready();
  14314. UploadFormDataItems items = {
  14315. {"field1", "hello", "", "text/plain"},
  14316. {"file1", "world", "test.txt", "application/octet-stream"},
  14317. };
  14318. Client cli(HOST, port);
  14319. auto res = cli.Post("/upload", {}, items);
  14320. ASSERT_TRUE(res) << "Error: " << to_string(res.error());
  14321. EXPECT_EQ(StatusCode::OK_200, res->status);
  14322. }
  14323. TEST(MultipartFormDataTest, ContentProviderCoalescesWrites) {
  14324. // Verify that make_multipart_content_provider coalesces many small segments
  14325. // into fewer sink.write() calls to avoid TCP packet fragmentation (#2410).
  14326. constexpr size_t kItemCount = 1000;
  14327. UploadFormDataItems items;
  14328. items.reserve(kItemCount);
  14329. for (size_t i = 0; i < kItemCount; i++) {
  14330. items.push_back(
  14331. {"field" + std::to_string(i), "value" + std::to_string(i), "", ""});
  14332. }
  14333. const std::string boundary = "----test-boundary";
  14334. auto content_length = detail::get_multipart_content_length(items, boundary);
  14335. auto provider = detail::make_multipart_content_provider(items, boundary);
  14336. // Drive the provider the same way write_content_with_progress does
  14337. size_t write_count = 0;
  14338. size_t total_bytes = 0;
  14339. DataSink sink;
  14340. size_t offset = 0;
  14341. sink.write = [&](const char *d, size_t l) -> bool {
  14342. (void)d;
  14343. write_count++;
  14344. total_bytes += l;
  14345. offset += l;
  14346. return true;
  14347. };
  14348. sink.is_writable = []() -> bool { return true; };
  14349. while (offset < content_length) {
  14350. ASSERT_TRUE(provider(offset, content_length - offset, sink));
  14351. }
  14352. EXPECT_EQ(content_length, total_bytes);
  14353. // The total number of segments is 3 * kItemCount + 1 = 3001.
  14354. // With buffering into 64KB blocks, write_count should be much smaller.
  14355. auto segment_count = 3 * kItemCount + 1;
  14356. EXPECT_LT(write_count, segment_count / 10);
  14357. }
  14358. TEST(MultipartFormDataTest, ManyItemsEndToEnd) {
  14359. // Integration test: send many UploadFormDataItems and verify the server
  14360. // receives all of them correctly (#2410).
  14361. constexpr size_t kItemCount = 500;
  14362. auto handled = false;
  14363. Server svr;
  14364. svr.Post("/upload", [&](const Request &req, Response &res) {
  14365. EXPECT_EQ(kItemCount, req.form.fields.size());
  14366. for (size_t i = 0; i < kItemCount; i++) {
  14367. auto key = "field" + std::to_string(i);
  14368. auto val = "value" + std::to_string(i);
  14369. auto it = req.form.fields.find(key);
  14370. if (it != req.form.fields.end()) {
  14371. EXPECT_EQ(val, it->second.content);
  14372. } else {
  14373. ADD_FAILURE() << "Missing field: " << key;
  14374. }
  14375. }
  14376. res.set_content("ok", "text/plain");
  14377. handled = true;
  14378. });
  14379. auto port = svr.bind_to_any_port(HOST);
  14380. auto t = thread([&] { svr.listen_after_bind(); });
  14381. auto se = detail::scope_exit([&] {
  14382. svr.stop();
  14383. t.join();
  14384. ASSERT_FALSE(svr.is_running());
  14385. ASSERT_TRUE(handled);
  14386. });
  14387. svr.wait_until_ready();
  14388. UploadFormDataItems items;
  14389. items.reserve(kItemCount);
  14390. for (size_t i = 0; i < kItemCount; i++) {
  14391. items.push_back(
  14392. {"field" + std::to_string(i), "value" + std::to_string(i), "", ""});
  14393. }
  14394. Client cli(HOST, port);
  14395. auto res = cli.Post("/upload", items);
  14396. ASSERT_TRUE(res) << "Error: " << to_string(res.error());
  14397. EXPECT_EQ(StatusCode::OK_200, res->status);
  14398. }
  14399. TEST(MultipartFormDataTest, MakeFileProvider) {
  14400. // Verify make_file_provider sends a file's contents correctly.
  14401. const std::string file_content(4096, 'Z');
  14402. const std::string tmp_path = "./httplib_test_make_file_provider.bin";
  14403. {
  14404. std::ofstream ofs(tmp_path, std::ios::binary);
  14405. ofs.write(file_content.data(),
  14406. static_cast<std::streamsize>(file_content.size()));
  14407. }
  14408. auto handled = false;
  14409. Server svr;
  14410. svr.Post("/upload", [&](const Request &req, Response & /*res*/,
  14411. const ContentReader &content_reader) {
  14412. ASSERT_TRUE(req.is_multipart_form_data());
  14413. std::vector<FormData> items;
  14414. content_reader(
  14415. [&](const FormData &file) {
  14416. items.push_back(file);
  14417. return true;
  14418. },
  14419. [&](const char *data, size_t data_length) {
  14420. items.back().content.append(data, data_length);
  14421. return true;
  14422. });
  14423. ASSERT_EQ(1u, items.size());
  14424. EXPECT_EQ("myfile", items[0].name);
  14425. EXPECT_EQ("data.bin", items[0].filename);
  14426. EXPECT_EQ("application/octet-stream", items[0].content_type);
  14427. EXPECT_EQ(file_content, items[0].content);
  14428. handled = true;
  14429. });
  14430. auto port = svr.bind_to_any_port(HOST);
  14431. auto t = thread([&] { svr.listen_after_bind(); });
  14432. auto se = detail::scope_exit([&] {
  14433. svr.stop();
  14434. t.join();
  14435. ASSERT_FALSE(svr.is_running());
  14436. ASSERT_TRUE(handled);
  14437. std::remove(tmp_path.c_str());
  14438. });
  14439. svr.wait_until_ready();
  14440. FormDataProviderItems providers;
  14441. providers.push_back(make_file_provider("myfile", tmp_path, "data.bin",
  14442. "application/octet-stream"));
  14443. Client cli(HOST, port);
  14444. auto res = cli.Post("/upload", {}, {}, providers);
  14445. ASSERT_TRUE(res) << "Error: " << to_string(res.error());
  14446. EXPECT_EQ(StatusCode::OK_200, res->status);
  14447. }
  14448. TEST(MultipartFormDataTest, ExcessivePartHeaders) {
  14449. // Verify that a multipart part with more than CPPHTTPLIB_HEADER_MAX_COUNT
  14450. // (100) headers is rejected with a 400 Bad Request response.
  14451. Server svr;
  14452. svr.Post("/post", [&](const Request & /*req*/, Response &res) {
  14453. res.set_content("ok", "text/plain");
  14454. });
  14455. thread t = thread([&] { svr.listen(HOST, PORT); });
  14456. auto se = detail::scope_exit([&] {
  14457. svr.stop();
  14458. t.join();
  14459. ASSERT_FALSE(svr.is_running());
  14460. });
  14461. svr.wait_until_ready();
  14462. // Build a multipart part with 101 custom headers (exceeding
  14463. // CPPHTTPLIB_HEADER_MAX_COUNT=100)
  14464. std::stringstream body;
  14465. body << "--simpleboundary\r\n"
  14466. << "Content-Disposition: form-data; name=\"field1\"\r\n";
  14467. for (int i = 0; i < 101; i++) {
  14468. body << "X-Custom-Header-" << i << ": value\r\n";
  14469. }
  14470. body << "\r\n"
  14471. << "value1\r\n"
  14472. << "--simpleboundary--\r\n";
  14473. std::string content_type = "multipart/form-data; boundary=simpleboundary";
  14474. Client cli(HOST, PORT);
  14475. auto res = cli.Post("/post", body.str(), content_type.c_str());
  14476. ASSERT_TRUE(res) << "Error: " << to_string(res.error());
  14477. EXPECT_EQ(StatusCode::BadRequest_400, res->status);
  14478. }
  14479. TEST(MultipartFormDataTest, NoInitialBoundaryParsingIsNotQuadratic) {
  14480. // A body that never contains the declared boundary must not be accumulated
  14481. // while the parser waits for it. Buffering it would also make every read
  14482. // rescan everything seen so far, which is quadratic in the body size.
  14483. Server svr;
  14484. svr.Post("/post", [](const Request & /*req*/, Response &res) {
  14485. res.set_content("ok", "text/plain");
  14486. });
  14487. auto port = svr.bind_to_any_port(HOST);
  14488. thread t = thread([&] { svr.listen_after_bind(); });
  14489. auto se = detail::scope_exit([&] {
  14490. svr.stop();
  14491. t.join();
  14492. ASSERT_FALSE(svr.is_running());
  14493. });
  14494. svr.wait_until_ready();
  14495. Client cli(HOST, port);
  14496. cli.set_read_timeout(60, 0);
  14497. cli.set_write_timeout(60, 0);
  14498. // '-' is the worst case: it matches the first character of the boundary, so
  14499. // every position has to be checked against it.
  14500. auto post_dashes = [&](size_t size) {
  14501. const std::string body(size, '-');
  14502. auto start = std::chrono::steady_clock::now();
  14503. auto res =
  14504. cli.Post("/post", body, "multipart/form-data; boundary=simpleboundary");
  14505. auto ms = std::chrono::duration_cast<std::chrono::milliseconds>(
  14506. std::chrono::steady_clock::now() - start)
  14507. .count();
  14508. EXPECT_TRUE(res) << "Error: " << to_string(res.error());
  14509. if (res) { EXPECT_EQ(StatusCode::BadRequest_400, res->status); }
  14510. return ms;
  14511. };
  14512. // Not named `small`/`large`: <rpcndr.h> defines `small` as a macro on
  14513. // Windows.
  14514. auto ms_4mb = post_dashes(4u * 1024 * 1024);
  14515. auto ms_16mb = post_dashes(16u * 1024 * 1024);
  14516. // Comparing the two sizes rather than checking an absolute duration keeps
  14517. // this meaningful across build types and CI load, both of which move the
  14518. // absolute numbers by more than an order of magnitude. Four times the bytes
  14519. // costs about four times the time when parsing is linear, and about sixteen
  14520. // times when the body is buffered and rescanned.
  14521. ASSERT_GT(ms_4mb, 0) << "timer resolution too coarse to compare";
  14522. EXPECT_LT(ms_16mb, ms_4mb * 10)
  14523. << "4MB took " << ms_4mb << "ms but 16MB took " << ms_16mb
  14524. << "ms, which suggests the body is being buffered and rescanned";
  14525. }
  14526. TEST(MultipartFormDataTest, BoundaryNotFollowedByDelimiterFailsFast) {
  14527. // A boundary can only be followed by CRLF or by "--", so anything else is
  14528. // malformed no matter what comes next. The parser must say so right away
  14529. // instead of buffering the rest of the declared body.
  14530. Server svr;
  14531. svr.Post("/post", [](const Request & /*req*/, Response &res) {
  14532. res.set_content("ok", "text/plain");
  14533. });
  14534. auto port = svr.bind_to_any_port(HOST);
  14535. thread t = thread([&] { svr.listen_after_bind(); });
  14536. auto se = detail::scope_exit([&] {
  14537. svr.stop();
  14538. t.join();
  14539. ASSERT_FALSE(svr.is_running());
  14540. });
  14541. svr.wait_until_ready();
  14542. // Announce a 1 MB body but send only the malformed prefix. A parser that
  14543. // buffers instead of failing would still be waiting for the remaining bytes.
  14544. const std::string body = "--zzzz\r\n"
  14545. "Content-Disposition: form-data; name=\"text1\"\r\n"
  14546. "\r\n"
  14547. "text1"
  14548. "\r\n--zzzzXX";
  14549. const std::string req = "POST /post HTTP/1.1\r\n"
  14550. "Content-Type: multipart/form-data; boundary=zzzz\r\n"
  14551. "Content-Length: 1048576\r\n"
  14552. "\r\n" +
  14553. body;
  14554. std::string response;
  14555. ASSERT_TRUE(send_request(3, req, &response, port));
  14556. ASSERT_GE(response.size(), 12u) << "no response before the read timeout";
  14557. EXPECT_EQ("400", response.substr(9, 3));
  14558. }
  14559. // Posts a multipart body split into two writes, so that the server sees the
  14560. // split at whatever offset the caller chose, and expects the single "text1"
  14561. // field to come through.
  14562. static void expect_split_multipart_ok(const std::string &body1,
  14563. const std::string &body2) {
  14564. auto handled = false;
  14565. Server svr;
  14566. svr.Post("/post", [&](const Request &req, Response &) {
  14567. EXPECT_EQ(1u, req.form.fields.size());
  14568. EXPECT_EQ("text1", req.form.get_field("text1"));
  14569. handled = true;
  14570. });
  14571. auto port = svr.bind_to_any_port(HOST);
  14572. thread t = thread([&] { svr.listen_after_bind(); });
  14573. auto se = detail::scope_exit([&] {
  14574. svr.stop();
  14575. t.join();
  14576. ASSERT_FALSE(svr.is_running());
  14577. ASSERT_TRUE(handled);
  14578. });
  14579. svr.wait_until_ready();
  14580. // "Connection: close" makes the server close once it has answered, so the
  14581. // response drain ends immediately instead of idling until the read timeout.
  14582. const std::string head =
  14583. "POST /post HTTP/1.1\r\n"
  14584. "Content-Type: multipart/form-data; boundary=zzzz\r\n"
  14585. "Connection: close\r\n"
  14586. "Content-Length: " +
  14587. std::to_string(body1.size() + body2.size()) + "\r\n\r\n";
  14588. std::string response;
  14589. ASSERT_TRUE(send_request_in_parts(3, {head + body1, body2}, &response, port));
  14590. ASSERT_GE(response.size(), 12u) << "no response";
  14591. EXPECT_EQ("200", response.substr(9, 3));
  14592. }
  14593. TEST(MultipartFormDataTest, EpilogueSplitAcrossReadsIsIgnored) {
  14594. // RFC 2046: everything after the close-delimiter is an epilogue and is to be
  14595. // ignored, including when it does not arrive in the same read as the
  14596. // close-delimiter itself.
  14597. expect_split_multipart_ok("--zzzz\r\n"
  14598. "Content-Disposition: form-data; name=\"text1\"\r\n"
  14599. "\r\n"
  14600. "text1"
  14601. "\r\n--zzzz--",
  14602. "\r\nthis epilogue must be ignored\r\n");
  14603. }
  14604. TEST(MultipartFormDataTest, InitialBoundarySplitAfterLongPreamble) {
  14605. // The initial boundary may be preceded by a preamble of any length and may
  14606. // straddle a read boundary. Discarding data while waiting for it must not
  14607. // throw away a partial boundary sitting at the end of the buffer.
  14608. expect_split_multipart_ok(std::string(64u * 1024, 'p') + "--zz",
  14609. "zz\r\n"
  14610. "Content-Disposition: form-data; name=\"text1\"\r\n"
  14611. "\r\n"
  14612. "text1"
  14613. "\r\n--zzzz--\r\n");
  14614. }
  14615. TEST(MultipartFormDataTest, BoundaryLengthLimitIsEnforced) {
  14616. // The received boundary was only checked for being non-empty, so it could be
  14617. // as long as a header is allowed to be. The parser scans the body for
  14618. // "--" + boundary, so a body crafted to repeat that delimiter's leading bytes
  14619. // costs a nearly full comparison at nearly every position, making the
  14620. // boundary's length a multiplier on the worst-case parsing cost. RFC 2046
  14621. // 5.1.1 caps a boundary at 70 characters; honoring that caps the multiplier.
  14622. Server svr;
  14623. svr.Post("/post", [](const Request &req, Response &res) {
  14624. EXPECT_EQ(1u, req.form.fields.size());
  14625. EXPECT_EQ("text1", req.form.get_field("text1"));
  14626. res.set_content("ok", "text/plain");
  14627. });
  14628. auto port = svr.bind_to_any_port(HOST);
  14629. thread t = thread([&] { svr.listen_after_bind(); });
  14630. auto se = detail::scope_exit([&] {
  14631. svr.stop();
  14632. t.join();
  14633. ASSERT_FALSE(svr.is_running());
  14634. });
  14635. svr.wait_until_ready();
  14636. Client cli(HOST, port);
  14637. auto post_with_boundary_of_length = [&](size_t len) {
  14638. const std::string boundary(len, 'a');
  14639. const std::string body =
  14640. "--" + boundary +
  14641. "\r\n"
  14642. "Content-Disposition: form-data; name=\"text1\"\r\n"
  14643. "\r\n"
  14644. "text1"
  14645. "\r\n--" +
  14646. boundary + "--\r\n";
  14647. return cli.Post("/post", body, "multipart/form-data; boundary=" + boundary);
  14648. };
  14649. auto res = post_with_boundary_of_length(70);
  14650. ASSERT_TRUE(res) << "Error: " << to_string(res.error());
  14651. EXPECT_EQ(StatusCode::OK_200, res->status);
  14652. res = post_with_boundary_of_length(71);
  14653. ASSERT_TRUE(res) << "Error: " << to_string(res.error());
  14654. EXPECT_EQ(StatusCode::BadRequest_400, res->status);
  14655. }
  14656. TEST(MakeFileBodyTest, Basic) {
  14657. const std::string file_content(4096, 'Z');
  14658. const std::string tmp_path = "./httplib_test_make_file_body.bin";
  14659. {
  14660. std::ofstream ofs(tmp_path, std::ios::binary);
  14661. ofs.write(file_content.data(),
  14662. static_cast<std::streamsize>(file_content.size()));
  14663. }
  14664. auto handled = false;
  14665. Server svr;
  14666. svr.Post("/upload", [&](const Request &req, Response &res) {
  14667. EXPECT_EQ(file_content, req.body);
  14668. handled = true;
  14669. res.status = StatusCode::OK_200;
  14670. });
  14671. auto port = svr.bind_to_any_port(HOST);
  14672. auto t = thread([&] { svr.listen_after_bind(); });
  14673. auto se = detail::scope_exit([&] {
  14674. svr.stop();
  14675. t.join();
  14676. ASSERT_FALSE(svr.is_running());
  14677. ASSERT_TRUE(handled);
  14678. std::remove(tmp_path.c_str());
  14679. });
  14680. svr.wait_until_ready();
  14681. auto fb = make_file_body(tmp_path);
  14682. ASSERT_GT(fb.first, 0u);
  14683. Client cli(HOST, port);
  14684. auto res =
  14685. cli.Post("/upload", fb.first, fb.second, "application/octet-stream");
  14686. ASSERT_TRUE(res) << "Error: " << to_string(res.error());
  14687. EXPECT_EQ(StatusCode::OK_200, res->status);
  14688. }
  14689. TEST(MakeFileBodyTest, TruncatedFileMakesTheProviderFail) {
  14690. const std::string path = "./httplib_test_make_file_body_truncated.bin";
  14691. {
  14692. std::ofstream ofs(path, std::ios::binary);
  14693. const std::string content(100, 'A');
  14694. ofs.write(content.data(), static_cast<std::streamsize>(content.size()));
  14695. }
  14696. auto cleanup = detail::scope_exit([&] { std::remove(path.c_str()); });
  14697. auto body = make_file_body(path);
  14698. ASSERT_EQ(100u, body.first);
  14699. ASSERT_TRUE(static_cast<bool>(body.second));
  14700. // Rewritten shorter after its length was measured - and, on a server, after
  14701. // that length has already gone out as Content-Length.
  14702. {
  14703. std::ofstream ofs(path, std::ios::binary | std::ios::trunc);
  14704. const std::string content(10, 'A');
  14705. ofs.write(content.data(), static_cast<std::streamsize>(content.size()));
  14706. }
  14707. std::string written;
  14708. DataSink sink;
  14709. sink.write = [&](const char *d, size_t l) {
  14710. written.append(d, l);
  14711. return true;
  14712. };
  14713. // The provider has to report failure. write_content_with_progress() advances
  14714. // its offset only by what was written, so a provider that returns true
  14715. // without completing the length it promised is called again straight away,
  14716. // and again.
  14717. EXPECT_FALSE(body.second(0, body.first, sink));
  14718. EXPECT_EQ(std::string(10, 'A'), written);
  14719. }
  14720. TEST(MakeFileBodyTest, WholeFileIsSent) {
  14721. const std::string path = "./httplib_test_make_file_body_whole.bin";
  14722. const std::string content(9000, 'Z'); // spans more than one 8 KiB read
  14723. {
  14724. std::ofstream ofs(path, std::ios::binary);
  14725. ofs.write(content.data(), static_cast<std::streamsize>(content.size()));
  14726. }
  14727. auto cleanup = detail::scope_exit([&] { std::remove(path.c_str()); });
  14728. auto body = make_file_body(path);
  14729. ASSERT_EQ(content.size(), body.first);
  14730. ASSERT_TRUE(static_cast<bool>(body.second));
  14731. std::string written;
  14732. DataSink sink;
  14733. sink.write = [&](const char *d, size_t l) {
  14734. written.append(d, l);
  14735. return true;
  14736. };
  14737. EXPECT_TRUE(body.second(0, body.first, sink));
  14738. EXPECT_EQ(content, written);
  14739. }
  14740. TEST(TaskQueueTest, IncreaseAtomicInteger) {
  14741. static constexpr unsigned int number_of_tasks{1000000};
  14742. std::atomic_uint count{0};
  14743. std::unique_ptr<TaskQueue> task_queue{
  14744. new ThreadPool{CPPHTTPLIB_THREAD_POOL_COUNT}};
  14745. for (unsigned int i = 0; i < number_of_tasks; ++i) {
  14746. auto queued = task_queue->enqueue(
  14747. [&count] { count.fetch_add(1, std::memory_order_relaxed); });
  14748. EXPECT_TRUE(queued);
  14749. }
  14750. #ifdef CPPHTTPLIB_NO_EXCEPTIONS
  14751. task_queue->shutdown();
  14752. #else
  14753. EXPECT_NO_THROW(task_queue->shutdown());
  14754. #endif
  14755. EXPECT_EQ(number_of_tasks, count.load());
  14756. }
  14757. TEST(TaskQueueTest, IncreaseAtomicIntegerWithQueueLimit) {
  14758. static constexpr unsigned int number_of_tasks{1000000};
  14759. static constexpr unsigned int qlimit{2};
  14760. unsigned int queued_count{0};
  14761. std::atomic_uint count{0};
  14762. std::unique_ptr<TaskQueue> task_queue{
  14763. new ThreadPool{/*num_threads=*/1, /*max_threads=*/1, qlimit}};
  14764. for (unsigned int i = 0; i < number_of_tasks; ++i) {
  14765. if (task_queue->enqueue(
  14766. [&count] { count.fetch_add(1, std::memory_order_relaxed); })) {
  14767. queued_count++;
  14768. }
  14769. }
  14770. #ifdef CPPHTTPLIB_NO_EXCEPTIONS
  14771. task_queue->shutdown();
  14772. #else
  14773. EXPECT_NO_THROW(task_queue->shutdown());
  14774. #endif
  14775. EXPECT_EQ(queued_count, count.load());
  14776. EXPECT_TRUE(queued_count <= number_of_tasks);
  14777. EXPECT_TRUE(queued_count >= qlimit);
  14778. }
  14779. TEST(TaskQueueTest, IdleTimeoutAtRuntime) {
  14780. // Use a short idle timeout so a dynamic thread spawns, times out and
  14781. // exits during the test, and the pool keeps working afterwards.
  14782. std::unique_ptr<TaskQueue> task_queue{new ThreadPool{
  14783. /*num_threads=*/1, /*max_threads=*/2, /*max_queued_requests=*/0,
  14784. /*idle_timeout_sec=*/1}};
  14785. std::atomic_uint count{0};
  14786. std::condition_variable cv;
  14787. std::mutex mtx;
  14788. bool release = false;
  14789. // Block the base thread so the second task spawns a dynamic thread.
  14790. EXPECT_TRUE(task_queue->enqueue([&] {
  14791. std::unique_lock<std::mutex> lock(mtx);
  14792. while (!release) {
  14793. cv.wait(lock);
  14794. }
  14795. count++;
  14796. }));
  14797. EXPECT_TRUE(task_queue->enqueue([&] { count++; }));
  14798. // Let the dynamic thread finish its task and exceed the idle timeout.
  14799. std::this_thread::sleep_for(std::chrono::milliseconds(1500));
  14800. {
  14801. std::unique_lock<std::mutex> lock(mtx);
  14802. release = true;
  14803. }
  14804. cv.notify_all();
  14805. // The pool must still accept and run tasks after the dynamic thread exited.
  14806. EXPECT_TRUE(task_queue->enqueue([&] { count++; }));
  14807. task_queue->shutdown();
  14808. EXPECT_EQ(3u, count.load());
  14809. }
  14810. TEST(TaskQueueTest, MaxQueuedRequests) {
  14811. static constexpr unsigned int qlimit{3};
  14812. std::unique_ptr<TaskQueue> task_queue{new ThreadPool{1, 1, qlimit}};
  14813. std::condition_variable sem_cv;
  14814. std::mutex sem_mtx;
  14815. int credits = 0;
  14816. bool queued;
  14817. /* Fill up the queue with tasks that will block until we give them credits to
  14818. * complete. */
  14819. for (unsigned int n = 0; n <= qlimit;) {
  14820. queued = task_queue->enqueue([&sem_mtx, &sem_cv, &credits] {
  14821. std::unique_lock<std::mutex> lock(sem_mtx);
  14822. while (credits <= 0) {
  14823. sem_cv.wait(lock);
  14824. }
  14825. /* Consume the credit and signal the test code if they are all gone. */
  14826. if (--credits == 0) { sem_cv.notify_one(); }
  14827. });
  14828. if (n < qlimit) {
  14829. /* The first qlimit enqueues must succeed. */
  14830. EXPECT_TRUE(queued);
  14831. } else {
  14832. /* The last one will succeed only when the worker thread
  14833. * starts and dequeues the first blocking task. Although
  14834. * not necessary for the correctness of this test, we sleep for
  14835. * a short while to avoid busy waiting. */
  14836. std::this_thread::sleep_for(std::chrono::milliseconds(10));
  14837. }
  14838. if (queued) { n++; }
  14839. }
  14840. /* Further enqueues must fail since the queue is full. */
  14841. for (auto i = 0; i < 4; i++) {
  14842. queued = task_queue->enqueue([] {});
  14843. EXPECT_FALSE(queued);
  14844. }
  14845. /* Give the credits to allow the previous tasks to complete. */
  14846. {
  14847. std::unique_lock<std::mutex> lock(sem_mtx);
  14848. credits += qlimit + 1;
  14849. }
  14850. sem_cv.notify_all();
  14851. /* Wait for all the credits to be consumed. */
  14852. {
  14853. std::unique_lock<std::mutex> lock(sem_mtx);
  14854. while (credits > 0) {
  14855. sem_cv.wait(lock);
  14856. }
  14857. }
  14858. /* Check that we are able again to enqueue at least qlimit tasks. */
  14859. for (unsigned int i = 0; i < qlimit; i++) {
  14860. queued = task_queue->enqueue([] {});
  14861. EXPECT_TRUE(queued);
  14862. }
  14863. #ifdef CPPHTTPLIB_NO_EXCEPTIONS
  14864. task_queue->shutdown();
  14865. #else
  14866. EXPECT_NO_THROW(task_queue->shutdown());
  14867. #endif
  14868. }
  14869. TEST(RedirectTest, SeeOtherDoesNotResendContentProviderBody) {
  14870. Server svr;
  14871. std::string method;
  14872. std::string body;
  14873. auto has_content_length = false;
  14874. auto has_transfer_encoding = false;
  14875. std::atomic<int> bad_requests{0};
  14876. // Leftover body bytes get parsed as a malformed request and answered with
  14877. // 400
  14878. svr.set_logger([&](const Request & /*req*/, const Response &res) {
  14879. if (res.status == StatusCode::BadRequest_400) { bad_requests++; }
  14880. });
  14881. svr.Post("/up", [](const Request & /*req*/, Response &res) {
  14882. res.set_redirect("/down", StatusCode::SeeOther_303);
  14883. });
  14884. svr.Get("/down", [&](const Request &req, Response &res) {
  14885. method = req.method;
  14886. body = req.body;
  14887. has_content_length = req.has_header("Content-Length");
  14888. has_transfer_encoding = req.has_header("Transfer-Encoding");
  14889. res.set_content("ok", "text/plain");
  14890. });
  14891. auto port = svr.bind_to_any_port(HOST);
  14892. auto thread = std::thread([&]() { svr.listen_after_bind(); });
  14893. auto se = detail::scope_exit([&] {
  14894. svr.stop();
  14895. thread.join();
  14896. ASSERT_FALSE(svr.is_running());
  14897. });
  14898. svr.wait_until_ready();
  14899. const std::string payload = "SECRET-BODY";
  14900. auto check = [&](Client &cli, const Result &res) {
  14901. ASSERT_TRUE(res) << "Error: " << to_string(res.error());
  14902. EXPECT_EQ(StatusCode::OK_200, res->status);
  14903. EXPECT_EQ("ok", res->body);
  14904. EXPECT_EQ("GET", method);
  14905. EXPECT_TRUE(body.empty());
  14906. EXPECT_FALSE(has_content_length);
  14907. EXPECT_FALSE(has_transfer_encoding);
  14908. // Nothing of the original body may be left on the connection
  14909. auto res2 = cli.Get("/down");
  14910. ASSERT_TRUE(res2) << "Error: " << to_string(res2.error());
  14911. EXPECT_EQ(StatusCode::OK_200, res2->status);
  14912. EXPECT_EQ("ok", res2->body);
  14913. EXPECT_EQ(0, bad_requests);
  14914. };
  14915. // With content length
  14916. {
  14917. Client cli(HOST, port);
  14918. cli.set_keep_alive(true);
  14919. cli.set_follow_location(true);
  14920. auto res = cli.Post(
  14921. "/up", payload.size(),
  14922. [&](size_t offset, size_t length, DataSink &sink) {
  14923. return sink.write(payload.data() + offset, length);
  14924. },
  14925. "text/plain");
  14926. check(cli, res);
  14927. }
  14928. // Without content length (chunked)
  14929. {
  14930. Client cli(HOST, port);
  14931. cli.set_keep_alive(true);
  14932. cli.set_follow_location(true);
  14933. auto res = cli.Post(
  14934. "/up",
  14935. [&](size_t /*offset*/, DataSink &sink) {
  14936. sink.write(payload.data(), payload.size());
  14937. sink.done();
  14938. return true;
  14939. },
  14940. "text/plain");
  14941. check(cli, res);
  14942. }
  14943. }
  14944. TEST(RedirectTest, LocationPathIsNotDecoded) {
  14945. Server svr;
  14946. std::string target;
  14947. svr.Get(R"(/start/.*)", [](const Request &req, Response &res) {
  14948. // Echo the still-encoded name back in the Location
  14949. const std::string prefix = "/start/";
  14950. res.status = StatusCode::Found_302;
  14951. res.set_header("Location", "/dest/" + req.target.substr(prefix.size()));
  14952. });
  14953. svr.Get(R"(/dest.*)", [&](const Request &req, Response &res) {
  14954. target = req.target;
  14955. res.set_content("ok", "text/plain");
  14956. });
  14957. auto port = svr.bind_to_any_port(HOST);
  14958. auto thread = std::thread([&]() { svr.listen_after_bind(); });
  14959. auto se = detail::scope_exit([&] {
  14960. svr.stop();
  14961. thread.join();
  14962. ASSERT_FALSE(svr.is_running());
  14963. });
  14964. svr.wait_until_ready();
  14965. // Decoding the Location path would turn the first four into a path
  14966. // separator, a query delimiter, a fragment delimiter and a different
  14967. // percent-encoded octet. The rest must keep reaching the server as they are.
  14968. const std::vector<std::string> names = {
  14969. "a%2Fb", "x%3Fy", "x%23y", "a%2520b", "a%20b", "%C3%BC", "a-b_c.d~e",
  14970. };
  14971. for (auto path_encode : {true, false}) {
  14972. Client cli(HOST, port);
  14973. cli.set_follow_location(true);
  14974. cli.set_path_encode(path_encode);
  14975. for (const auto &name : names) {
  14976. target.clear();
  14977. auto res = cli.Get("/start/" + name);
  14978. ASSERT_TRUE(res) << "Error: " << to_string(res.error());
  14979. EXPECT_EQ(StatusCode::OK_200, res->status);
  14980. EXPECT_EQ("/dest/" + name, target);
  14981. }
  14982. }
  14983. }
  14984. TEST(RedirectTest, RedirectToUrlWithQueryParameters) {
  14985. Server svr;
  14986. svr.Get("/", [](const Request & /*req*/, Response &res) {
  14987. res.set_redirect(R"(/hello?key=val%26key2%3Dval2)");
  14988. });
  14989. svr.Get("/hello", [](const Request &req, Response &res) {
  14990. res.set_content(req.get_param_value("key"), "text/plain");
  14991. });
  14992. auto thread = std::thread([&]() { svr.listen(HOST, PORT); });
  14993. auto se = detail::scope_exit([&] {
  14994. svr.stop();
  14995. thread.join();
  14996. ASSERT_FALSE(svr.is_running());
  14997. });
  14998. svr.wait_until_ready();
  14999. {
  15000. Client cli(HOST, PORT);
  15001. cli.set_follow_location(true);
  15002. auto res = cli.Get("/");
  15003. ASSERT_TRUE(res) << "Error: " << to_string(res.error());
  15004. EXPECT_EQ(StatusCode::OK_200, res->status);
  15005. EXPECT_EQ("val&key2=val2", res->body);
  15006. }
  15007. }
  15008. #endif
  15009. TEST(RedirectTest, RedirectToUrlWithPlusInQueryParameters) {
  15010. Server svr;
  15011. svr.Get("/", [](const Request & /*req*/, Response &res) {
  15012. res.set_redirect(R"(/hello?key=AByz09+~-._%20%26%3F%C3%BC%2B)");
  15013. });
  15014. svr.Get("/hello", [](const Request &req, Response &res) {
  15015. res.set_content(req.get_param_value("key"), "text/plain");
  15016. });
  15017. auto thread = std::thread([&]() { svr.listen(HOST, PORT); });
  15018. auto se = detail::scope_exit([&] {
  15019. svr.stop();
  15020. thread.join();
  15021. ASSERT_FALSE(svr.is_running());
  15022. });
  15023. svr.wait_until_ready();
  15024. {
  15025. Client cli(HOST, PORT);
  15026. cli.set_follow_location(true);
  15027. auto res = cli.Get("/");
  15028. ASSERT_TRUE(res) << "Error: " << to_string(res.error());
  15029. EXPECT_EQ(StatusCode::OK_200, res->status);
  15030. EXPECT_EQ("AByz09 ~-._ &?ü+", res->body);
  15031. }
  15032. }
  15033. TEST(RedirectTest, RedirectWithPlusInPath) {
  15034. Server svr;
  15035. svr.Get("/", [](const Request & /*req*/, Response &res) {
  15036. res.set_redirect("/a+b");
  15037. });
  15038. // Route pattern uses regex; escape + as \\+
  15039. svr.Get(R"(/a\+b)", [](const Request &req, Response &res) {
  15040. res.set_content(req.path, "text/plain");
  15041. });
  15042. auto thread = std::thread([&]() { svr.listen(HOST, PORT); });
  15043. auto se = detail::scope_exit([&] {
  15044. svr.stop();
  15045. thread.join();
  15046. ASSERT_FALSE(svr.is_running());
  15047. });
  15048. svr.wait_until_ready();
  15049. {
  15050. Client cli(HOST, PORT);
  15051. cli.set_follow_location(true);
  15052. auto res = cli.Get("/");
  15053. ASSERT_TRUE(res) << "Error: " << to_string(res.error());
  15054. EXPECT_EQ(StatusCode::OK_200, res->status);
  15055. EXPECT_EQ("/a+b", res->body);
  15056. }
  15057. }
  15058. TEST(RedirectTest, ResolveRelativeLocation) {
  15059. // Examples from RFC 3986 section 5.4, base "http://a/b/c/d;p?q".
  15060. const std::vector<std::pair<std::string, std::string>> cases = {
  15061. {"g", "/b/c/g"},
  15062. {"./g", "/b/c/g"},
  15063. {"g/", "/b/c/g/"},
  15064. {"?y", "/b/c/d;p?y"},
  15065. {"g?y", "/b/c/g?y"},
  15066. {"#s", "/b/c/d;p?q#s"},
  15067. {"g#s", "/b/c/g#s"},
  15068. {"g?y#s", "/b/c/g?y#s"},
  15069. {";x", "/b/c/;x"},
  15070. {"g;x", "/b/c/g;x"},
  15071. {".", "/b/c/"},
  15072. {"./", "/b/c/"},
  15073. {"..", "/b/"},
  15074. {"../", "/b/"},
  15075. {"../g", "/b/g"},
  15076. {"../..", "/"},
  15077. {"../../", "/"},
  15078. {"../../g", "/g"},
  15079. {"../../../g", "/g"},
  15080. {"g.", "/b/c/g."},
  15081. {".g", "/b/c/.g"},
  15082. {"g..", "/b/c/g.."},
  15083. {"..g", "/b/c/..g"},
  15084. {"./../g", "/b/g"},
  15085. {"./g/.", "/b/c/g/"},
  15086. {"g/./h", "/b/c/g/h"},
  15087. {"g/../h", "/b/c/h"},
  15088. {"g;x=1/./y", "/b/c/g;x=1/y"},
  15089. {"g;x=1/../y", "/b/c/y"},
  15090. {"g?y/./x", "/b/c/g?y/./x"},
  15091. {"g#s/../x", "/b/c/g#s/../x"},
  15092. // Not relative-path references, so left for parse_url.
  15093. {"/g", "/g"},
  15094. {"//g", "//g"},
  15095. {"http://g/x", "http://g/x"},
  15096. {"g:h", "g:h"},
  15097. };
  15098. for (const auto &c : cases) {
  15099. EXPECT_EQ(c.second,
  15100. detail::resolve_relative_location(c.first, "/b/c/d;p?q"))
  15101. << c.first;
  15102. }
  15103. }
  15104. TEST(RedirectTest, RelativeLocationWithoutLeadingSlash) {
  15105. Server svr;
  15106. svr.Get("/dir/page", [](const Request &req, Response &res) {
  15107. res.set_redirect(req.get_param_value("to"));
  15108. });
  15109. svr.Get("/dir/next", [](const Request &req, Response &res) {
  15110. res.set_content(req.target, "text/plain");
  15111. });
  15112. svr.Get("/other", [](const Request &req, Response &res) {
  15113. res.set_content(req.target, "text/plain");
  15114. });
  15115. auto thread = std::thread([&]() { svr.listen(HOST, PORT); });
  15116. auto se = detail::scope_exit([&] {
  15117. svr.stop();
  15118. thread.join();
  15119. ASSERT_FALSE(svr.is_running());
  15120. });
  15121. svr.wait_until_ready();
  15122. const std::vector<std::pair<std::string, std::string>> cases = {
  15123. {"next", "/dir/next"},
  15124. {"./next?x=1", "/dir/next?x=1"},
  15125. {"../other", "/other"},
  15126. };
  15127. for (const auto &c : cases) {
  15128. Client cli(HOST, PORT);
  15129. cli.set_follow_location(true);
  15130. auto res = cli.Get("/dir/page?to=" + encode_query_component(c.first));
  15131. ASSERT_TRUE(res) << c.first << ": " << to_string(res.error());
  15132. EXPECT_EQ(StatusCode::OK_200, res->status) << c.first;
  15133. EXPECT_EQ(c.second, res->body) << c.first;
  15134. }
  15135. }
  15136. #ifdef CPPHTTPLIB_SSL_ENABLED
  15137. TEST(RedirectTest, Issue2185_Online) {
  15138. SSLClient client("github.com");
  15139. client.set_follow_location(true);
  15140. auto res = client.Get("/Coollab-Art/Coollab/releases/download/1.1.1_UI-Scale/"
  15141. "Coollab-Windows.zip");
  15142. ASSERT_TRUE(res) << "Error: " << to_string(res.error());
  15143. EXPECT_EQ(StatusCode::OK_200, res->status);
  15144. EXPECT_EQ(9920427U, res->body.size());
  15145. }
  15146. #endif
  15147. TEST(VulnerabilityTest, CRLFInjection) {
  15148. Server svr;
  15149. svr.Post("/test1", [](const Request & /*req*/, Response &res) {
  15150. res.set_content("Hello 1", "text/plain");
  15151. });
  15152. svr.Delete("/test2", [](const Request & /*req*/, Response &res) {
  15153. res.set_content("Hello 2", "text/plain");
  15154. });
  15155. svr.Put("/test3", [](const Request & /*req*/, Response &res) {
  15156. res.set_content("Hello 3", "text/plain");
  15157. });
  15158. svr.Patch("/test4", [](const Request & /*req*/, Response &res) {
  15159. res.set_content("Hello 4", "text/plain");
  15160. });
  15161. svr.set_logger([](const Request &req, const Response & /*res*/) {
  15162. for (const auto &x : req.headers) {
  15163. auto key = x.first;
  15164. EXPECT_STRNE("evil", key.c_str());
  15165. }
  15166. });
  15167. auto thread = std::thread([&]() { svr.listen(HOST, PORT); });
  15168. auto se = detail::scope_exit([&] {
  15169. svr.stop();
  15170. thread.join();
  15171. ASSERT_FALSE(svr.is_running());
  15172. });
  15173. svr.wait_until_ready();
  15174. {
  15175. Client cli(HOST, PORT);
  15176. cli.Post("/test1", "A=B",
  15177. "application/x-www-form-urlencoded\r\nevil: hello1");
  15178. cli.Delete("/test2", "A=B", "text/plain\r\nevil: hello2");
  15179. cli.Put("/test3", "text", "text/plain\r\nevil: hello3");
  15180. cli.Patch("/test4", "content", "text/plain\r\nevil: hello4");
  15181. }
  15182. }
  15183. TEST(VulnerabilityTest, CRLFInjectionInHeaders) {
  15184. auto server_thread = std::thread([] {
  15185. auto srv = ::socket(AF_INET, SOCK_STREAM, 0);
  15186. default_socket_options(srv);
  15187. sockaddr_in addr{};
  15188. addr.sin_family = AF_INET;
  15189. addr.sin_port = htons(static_cast<uint16_t>(PORT + 1));
  15190. ::inet_pton(AF_INET, "127.0.0.1", &addr.sin_addr);
  15191. ::bind(srv, reinterpret_cast<sockaddr *>(&addr), sizeof(addr));
  15192. ::listen(srv, 1);
  15193. sockaddr_in cli_addr{};
  15194. socklen_t cli_len = sizeof(cli_addr);
  15195. auto cli = ::accept(srv, reinterpret_cast<sockaddr *>(&cli_addr), &cli_len);
  15196. detail::set_socket_opt_time(cli, SOL_SOCKET, SO_RCVTIMEO, 1, 0);
  15197. std::string buf_all;
  15198. char buf[2048];
  15199. ssize_t n;
  15200. while ((n = ::recv(cli, buf, sizeof(buf), 0)) > 0) {
  15201. buf_all.append(buf, static_cast<size_t>(n));
  15202. size_t pos;
  15203. while ((pos = buf_all.find("\r\n\r\n")) != std::string::npos) {
  15204. auto request_block = buf_all.substr(0, pos + 4); // include separator
  15205. auto e = request_block.find("\r\n");
  15206. if (e != std::string::npos) {
  15207. auto request_line = request_block.substr(0, e);
  15208. std::string msg =
  15209. "CRLF injection detected in request line: '" + request_line + "'";
  15210. EXPECT_FALSE(true) << msg;
  15211. }
  15212. std::string resp = "HTTP/1.1 200 OK\r\nContent-Length: 5\r\n\r\nHello";
  15213. ::send(cli,
  15214. #ifdef _WIN32
  15215. static_cast<const char *>(resp.c_str()),
  15216. static_cast<int>(resp.size()),
  15217. #else
  15218. resp.c_str(), resp.size(),
  15219. #endif
  15220. 0);
  15221. buf_all.erase(0, pos + 4);
  15222. }
  15223. }
  15224. detail::close_socket(cli);
  15225. detail::close_socket(srv);
  15226. });
  15227. std::this_thread::sleep_for(std::chrono::milliseconds(200));
  15228. auto cli = Client("127.0.0.1", PORT + 1);
  15229. auto headers = Headers{
  15230. {"A", "B\r\n\r\nGET /pwned HTTP/1.1\r\nHost: 127.0.0.1:1234\r\n\r\n"},
  15231. {"Connection", "keep-alive"}};
  15232. auto res = cli.Get("/hi", headers);
  15233. EXPECT_FALSE(res);
  15234. EXPECT_EQ(Error::InvalidHeaders, res.error());
  15235. server_thread.join();
  15236. }
  15237. // A request rejected before any byte reaches the socket must fail right away
  15238. // instead of waiting for a response the server will never send.
  15239. TEST(ClientRejectedRequestTest, DoesNotWaitForResponse) {
  15240. // The kernel completes the TCP handshake from the listen backlog, so the
  15241. // client connects, but nothing ever reads, responds or closes.
  15242. auto srv = ::socket(AF_INET, SOCK_STREAM, 0);
  15243. default_socket_options(srv);
  15244. sockaddr_in addr{};
  15245. addr.sin_family = AF_INET;
  15246. addr.sin_port = htons(static_cast<uint16_t>(PORT + 1));
  15247. ::inet_pton(AF_INET, "127.0.0.1", &addr.sin_addr);
  15248. ASSERT_EQ(0, ::bind(srv, reinterpret_cast<sockaddr *>(&addr), sizeof(addr)));
  15249. ASSERT_EQ(0, ::listen(srv, 8));
  15250. auto cli = Client("127.0.0.1", PORT + 1);
  15251. cli.set_read_timeout(10, 0);
  15252. auto elapsed_ms = [](std::chrono::steady_clock::time_point start) {
  15253. return std::chrono::duration_cast<std::chrono::milliseconds>(
  15254. std::chrono::steady_clock::now() - start)
  15255. .count();
  15256. };
  15257. {
  15258. Request req;
  15259. req.method = "GE T";
  15260. req.path = "/";
  15261. auto start = std::chrono::steady_clock::now();
  15262. auto res = cli.send(req);
  15263. EXPECT_FALSE(res);
  15264. EXPECT_EQ(Error::Write, res.error());
  15265. EXPECT_LT(elapsed_ms(start), 1000);
  15266. }
  15267. {
  15268. auto start = std::chrono::steady_clock::now();
  15269. auto res = cli.Get("/", Headers{{"A", "B\r\nEvil: 1"}});
  15270. EXPECT_FALSE(res);
  15271. EXPECT_EQ(Error::InvalidHeaders, res.error());
  15272. EXPECT_LT(elapsed_ms(start), 1000);
  15273. }
  15274. EXPECT_FALSE(cli.is_socket_open());
  15275. detail::close_socket(srv);
  15276. }
  15277. TEST(ClientRejectedRequestTest, OpenStreamSendsNothingOnInvalidHeader) {
  15278. auto srv = ::socket(AF_INET, SOCK_STREAM, 0);
  15279. default_socket_options(srv);
  15280. sockaddr_in addr{};
  15281. addr.sin_family = AF_INET;
  15282. addr.sin_port = htons(static_cast<uint16_t>(PORT + 1));
  15283. ::inet_pton(AF_INET, "127.0.0.1", &addr.sin_addr);
  15284. ASSERT_EQ(0, ::bind(srv, reinterpret_cast<sockaddr *>(&addr), sizeof(addr)));
  15285. ASSERT_EQ(0, ::listen(srv, 1));
  15286. std::string received;
  15287. auto server_thread = std::thread([&] {
  15288. auto sock = ::accept(srv, nullptr, nullptr);
  15289. if (sock == INVALID_SOCKET) { return; }
  15290. detail::set_socket_opt_time(sock, SOL_SOCKET, SO_RCVTIMEO, 2, 0);
  15291. char buf[2048];
  15292. ssize_t n;
  15293. while ((n = ::recv(sock, buf, sizeof(buf), 0)) > 0) {
  15294. received.append(buf, static_cast<size_t>(n));
  15295. }
  15296. detail::close_socket(sock);
  15297. });
  15298. {
  15299. auto cli = Client("127.0.0.1", PORT + 1);
  15300. // "Z" sorts after the default headers, so writing straight to the socket
  15301. // would have sent the request line and those headers before the rejection.
  15302. auto handle =
  15303. cli.open_stream("GET", "/", Params{}, Headers{{"Z", "B\r\nEvil: 1"}});
  15304. EXPECT_FALSE(handle.is_valid());
  15305. EXPECT_EQ(Error::InvalidHeaders, handle.error);
  15306. }
  15307. server_thread.join();
  15308. detail::close_socket(srv);
  15309. EXPECT_TRUE(received.empty()) << received;
  15310. }
  15311. TEST(PathParamsTest, StaticMatch) {
  15312. const auto pattern = "/users/all";
  15313. detail::PathParamsMatcher matcher(pattern);
  15314. Request request;
  15315. request.path = "/users/all";
  15316. ASSERT_TRUE(matcher.match(request));
  15317. std::unordered_map<std::string, std::string> expected_params = {};
  15318. EXPECT_EQ(request.path_params, expected_params);
  15319. }
  15320. TEST(PathParamsTest, StaticMismatch) {
  15321. const auto pattern = "/users/all";
  15322. detail::PathParamsMatcher matcher(pattern);
  15323. Request request;
  15324. request.path = "/users/1";
  15325. ASSERT_FALSE(matcher.match(request));
  15326. }
  15327. TEST(PathParamsTest, SingleParamInTheMiddle) {
  15328. const auto pattern = "/users/:id/subscriptions";
  15329. detail::PathParamsMatcher matcher(pattern);
  15330. Request request;
  15331. request.path = "/users/42/subscriptions";
  15332. ASSERT_TRUE(matcher.match(request));
  15333. std::unordered_map<std::string, std::string> expected_params = {{"id", "42"}};
  15334. EXPECT_EQ(request.path_params, expected_params);
  15335. }
  15336. TEST(PathParamsTest, SingleParamInTheEnd) {
  15337. const auto pattern = "/users/:id";
  15338. detail::PathParamsMatcher matcher(pattern);
  15339. Request request;
  15340. request.path = "/users/24";
  15341. ASSERT_TRUE(matcher.match(request));
  15342. std::unordered_map<std::string, std::string> expected_params = {{"id", "24"}};
  15343. EXPECT_EQ(request.path_params, expected_params);
  15344. }
  15345. TEST(PathParamsTest, SingleParamInTheEndTrailingSlash) {
  15346. const auto pattern = "/users/:id/";
  15347. detail::PathParamsMatcher matcher(pattern);
  15348. Request request;
  15349. request.path = "/users/42/";
  15350. ASSERT_TRUE(matcher.match(request));
  15351. std::unordered_map<std::string, std::string> expected_params = {{"id", "42"}};
  15352. EXPECT_EQ(request.path_params, expected_params);
  15353. }
  15354. TEST(PathParamsTest, EmptyParam) {
  15355. const auto pattern = "/users/:id/";
  15356. detail::PathParamsMatcher matcher(pattern);
  15357. Request request;
  15358. request.path = "/users//";
  15359. ASSERT_TRUE(matcher.match(request));
  15360. std::unordered_map<std::string, std::string> expected_params = {{"id", ""}};
  15361. EXPECT_EQ(request.path_params, expected_params);
  15362. }
  15363. TEST(PathParamsTest, FragmentMismatch) {
  15364. const auto pattern = "/users/:id/";
  15365. detail::PathParamsMatcher matcher(pattern);
  15366. Request request;
  15367. request.path = "/admins/24/";
  15368. ASSERT_FALSE(matcher.match(request));
  15369. }
  15370. TEST(PathParamsTest, ExtraFragments) {
  15371. const auto pattern = "/users/:id";
  15372. detail::PathParamsMatcher matcher(pattern);
  15373. Request request;
  15374. request.path = "/users/42/subscriptions";
  15375. ASSERT_FALSE(matcher.match(request));
  15376. }
  15377. TEST(PathParamsTest, MissingTrailingParam) {
  15378. const auto pattern = "/users/:id";
  15379. detail::PathParamsMatcher matcher(pattern);
  15380. Request request;
  15381. request.path = "/users";
  15382. ASSERT_FALSE(matcher.match(request));
  15383. }
  15384. TEST(PathParamsTest, MissingParamInTheMiddle) {
  15385. const auto pattern = "/users/:id/subscriptions";
  15386. detail::PathParamsMatcher matcher(pattern);
  15387. Request request;
  15388. request.path = "/users/subscriptions";
  15389. ASSERT_FALSE(matcher.match(request));
  15390. }
  15391. TEST(PathParamsTest, MultipleParams) {
  15392. const auto pattern = "/users/:userid/subscriptions/:subid";
  15393. detail::PathParamsMatcher matcher(pattern);
  15394. Request request;
  15395. request.path = "/users/42/subscriptions/2";
  15396. ASSERT_TRUE(matcher.match(request));
  15397. std::unordered_map<std::string, std::string> expected_params = {
  15398. {"userid", "42"}, {"subid", "2"}};
  15399. EXPECT_EQ(request.path_params, expected_params);
  15400. }
  15401. TEST(PathParamsTest, SequenceOfParams) {
  15402. const auto pattern = "/values/:x/:y/:z";
  15403. detail::PathParamsMatcher matcher(pattern);
  15404. Request request;
  15405. request.path = "/values/1/2/3";
  15406. ASSERT_TRUE(matcher.match(request));
  15407. std::unordered_map<std::string, std::string> expected_params = {
  15408. {"x", "1"}, {"y", "2"}, {"z", "3"}};
  15409. EXPECT_EQ(request.path_params, expected_params);
  15410. }
  15411. TEST(PathParamsTest, SemicolonInTheMiddleIsNotAParam) {
  15412. const auto pattern = "/prefix:suffix";
  15413. detail::PathParamsMatcher matcher(pattern);
  15414. Request request;
  15415. request.path = "/prefix:suffix";
  15416. ASSERT_TRUE(matcher.match(request));
  15417. const std::unordered_map<std::string, std::string> expected_params = {};
  15418. EXPECT_EQ(request.path_params, expected_params);
  15419. }
  15420. TEST(RegexMatcherTest, OverlongPathIsRejectedBeforeRegexMatch) {
  15421. // std::regex_match's backtracking (most acute on libstdc++) can exhaust the
  15422. // calling thread's stack on a long enough path for a quantified pattern;
  15423. // RegexMatcher must refuse to run regex matching on paths beyond
  15424. // CPPHTTPLIB_REGEX_ROUTE_PATH_MAX_LENGTH instead of invoking it.
  15425. detail::RegexMatcher matcher("/files/(.*)");
  15426. Request within_limit;
  15427. within_limit.path = "/files/" + std::string(10, 'A');
  15428. EXPECT_TRUE(matcher.match(within_limit));
  15429. Request over_limit;
  15430. over_limit.path =
  15431. "/files/" + std::string(CPPHTTPLIB_REGEX_ROUTE_PATH_MAX_LENGTH, 'A');
  15432. EXPECT_FALSE(matcher.match(over_limit));
  15433. }
  15434. TEST(RegexMatcherTest, ServerSurvivesOverlongPathOnRegexRoute) {
  15435. Server svr;
  15436. svr.Get(R"(/files/(.*))", [](const Request & /*req*/, Response &res) {
  15437. res.set_content("ok", "text/plain");
  15438. });
  15439. auto port = svr.bind_to_any_port(HOST);
  15440. auto thread = std::thread([&]() { svr.listen_after_bind(); });
  15441. auto se = detail::scope_exit([&] {
  15442. svr.stop();
  15443. thread.join();
  15444. ASSERT_FALSE(svr.is_running());
  15445. });
  15446. svr.wait_until_ready();
  15447. // Comfortably past CPPHTTPLIB_REGEX_ROUTE_PATH_MAX_LENGTH, well within the
  15448. // request URI limit; this used to be able to crash the process.
  15449. std::string path =
  15450. "/files/" + std::string(CPPHTTPLIB_REGEX_ROUTE_PATH_MAX_LENGTH * 4, 'A');
  15451. std::string req = "GET " + path +
  15452. " HTTP/1.1\r\n"
  15453. "Host: " +
  15454. std::string(HOST) + ":" + std::to_string(port) +
  15455. "\r\n"
  15456. "Connection: close\r\n"
  15457. "\r\n";
  15458. std::string response;
  15459. ASSERT_TRUE(send_request(5, req, &response, port));
  15460. EXPECT_NE(std::string::npos, response.find("404"));
  15461. }
  15462. TEST(RouteMatcherTest, LiteralPatternsAndRegexPatterns) {
  15463. Server svr;
  15464. auto handler = [](const Request & /*req*/, Response &res) {
  15465. res.set_content("hit", "text/plain");
  15466. };
  15467. // No regex metacharacter, so this one is compared literally
  15468. svr.Get("/literal/route", handler);
  15469. // '.' is a regex metacharacter, so this one must keep regex semantics
  15470. svr.Get("/a.c", handler);
  15471. auto port = svr.bind_to_any_port(HOST);
  15472. std::thread t([&]() { svr.listen_after_bind(); });
  15473. auto se = detail::scope_exit([&] {
  15474. svr.stop();
  15475. t.join();
  15476. ASSERT_FALSE(svr.is_running());
  15477. });
  15478. svr.wait_until_ready();
  15479. Client cli(HOST, port);
  15480. struct {
  15481. const char *path;
  15482. int status;
  15483. } cases[] = {
  15484. {"/literal/route", StatusCode::OK_200},
  15485. {"/literal/routes", StatusCode::NotFound_404},
  15486. {"/literal/rout", StatusCode::NotFound_404},
  15487. {"/abc", StatusCode::OK_200},
  15488. {"/a.c", StatusCode::OK_200},
  15489. };
  15490. for (const auto &x : cases) {
  15491. auto res = cli.Get(x.path);
  15492. ASSERT_TRUE(res) << x.path;
  15493. EXPECT_EQ(x.status, res->status) << x.path;
  15494. }
  15495. }
  15496. TEST(RouteMatcherTest, LongLiteralPatternIsNotSubjectToTheRegexPathLimit) {
  15497. // CPPHTTPLIB_REGEX_ROUTE_PATH_MAX_LENGTH exists to keep std::regex_match
  15498. // from exhausting the stack, so it must only constrain routes that actually
  15499. // run a regular expression. A literal route is matched by comparison and
  15500. // stays usable at any length.
  15501. Server svr;
  15502. const std::string pattern =
  15503. "/files/" + std::string(CPPHTTPLIB_REGEX_ROUTE_PATH_MAX_LENGTH * 2, 'a');
  15504. svr.Get(pattern, [](const Request & /*req*/, Response &res) {
  15505. res.set_content("hit", "text/plain");
  15506. });
  15507. auto port = svr.bind_to_any_port(HOST);
  15508. std::thread t([&]() { svr.listen_after_bind(); });
  15509. auto se = detail::scope_exit([&] {
  15510. svr.stop();
  15511. t.join();
  15512. ASSERT_FALSE(svr.is_running());
  15513. });
  15514. svr.wait_until_ready();
  15515. Client cli(HOST, port);
  15516. auto res = cli.Get(pattern);
  15517. ASSERT_TRUE(res);
  15518. EXPECT_EQ(StatusCode::OK_200, res->status);
  15519. }
  15520. TEST(ParseUrlTest, VariousPatterns) {
  15521. {
  15522. detail::UrlComponents uc;
  15523. ASSERT_TRUE(detail::parse_url("http://example.com:8080/path?q=1#frag", uc));
  15524. EXPECT_EQ("http", uc.scheme);
  15525. EXPECT_EQ("example.com", uc.host);
  15526. EXPECT_EQ("8080", uc.port);
  15527. EXPECT_EQ("/path", uc.path);
  15528. EXPECT_EQ("?q=1", uc.query);
  15529. }
  15530. {
  15531. detail::UrlComponents uc;
  15532. ASSERT_TRUE(detail::parse_url("https://example.com/path", uc));
  15533. EXPECT_EQ("https", uc.scheme);
  15534. EXPECT_EQ("example.com", uc.host);
  15535. EXPECT_TRUE(uc.port.empty());
  15536. EXPECT_EQ("/path", uc.path);
  15537. }
  15538. {
  15539. detail::UrlComponents uc;
  15540. ASSERT_TRUE(detail::parse_url("http://[::1]:8080/path", uc));
  15541. EXPECT_EQ("::1", uc.host);
  15542. EXPECT_EQ("8080", uc.port);
  15543. EXPECT_EQ("/path", uc.path);
  15544. }
  15545. {
  15546. detail::UrlComponents uc;
  15547. ASSERT_FALSE(detail::parse_url("http://[::1/path", uc));
  15548. }
  15549. {
  15550. // Bytes after the IPv6 literal must be a delimiter, not folded into
  15551. // the path while the connection still targets the bracketed host.
  15552. detail::UrlComponents uc;
  15553. ASSERT_FALSE(detail::parse_url("http://[::1]evil.com/", uc));
  15554. }
  15555. {
  15556. detail::UrlComponents uc;
  15557. ASSERT_FALSE(detail::parse_url("http://[::1]evil", uc));
  15558. }
  15559. {
  15560. detail::UrlComponents uc;
  15561. ASSERT_TRUE(detail::parse_url("http://[::1]/path", uc));
  15562. EXPECT_EQ("::1", uc.host);
  15563. EXPECT_TRUE(uc.port.empty());
  15564. EXPECT_EQ("/path", uc.path);
  15565. }
  15566. {
  15567. detail::UrlComponents uc;
  15568. ASSERT_TRUE(detail::parse_url("//example.com/path?q=1", uc));
  15569. EXPECT_TRUE(uc.scheme.empty());
  15570. EXPECT_EQ("example.com", uc.host);
  15571. EXPECT_EQ("/path", uc.path);
  15572. EXPECT_EQ("?q=1", uc.query);
  15573. }
  15574. {
  15575. detail::UrlComponents uc;
  15576. ASSERT_TRUE(detail::parse_url("/path?q=1", uc));
  15577. EXPECT_TRUE(uc.host.empty());
  15578. EXPECT_EQ("/path", uc.path);
  15579. EXPECT_EQ("?q=1", uc.query);
  15580. }
  15581. {
  15582. detail::UrlComponents uc;
  15583. ASSERT_TRUE(detail::parse_url("example.com:8080", uc));
  15584. EXPECT_EQ("example.com", uc.host);
  15585. EXPECT_EQ("8080", uc.port);
  15586. }
  15587. {
  15588. // Unix socket path — must not be parsed as host
  15589. detail::UrlComponents uc;
  15590. ASSERT_TRUE(detail::parse_url("./httplib-server.sock", uc));
  15591. EXPECT_TRUE(uc.host.empty());
  15592. }
  15593. {
  15594. detail::UrlComponents uc;
  15595. ASSERT_TRUE(detail::parse_url("", uc));
  15596. EXPECT_TRUE(uc.host.empty());
  15597. EXPECT_TRUE(uc.path.empty());
  15598. }
  15599. {
  15600. detail::UrlComponents uc;
  15601. ASSERT_FALSE(detail::parse_url("HTTP://example.com/path", uc));
  15602. }
  15603. {
  15604. detail::UrlComponents uc;
  15605. ASSERT_FALSE(detail::parse_url("h2://example.com/path", uc));
  15606. }
  15607. {
  15608. // Accepted by parse_url; callers restrict to http/https
  15609. detail::UrlComponents uc;
  15610. ASSERT_TRUE(detail::parse_url("ftp://example.com/", uc));
  15611. EXPECT_EQ("ftp", uc.scheme);
  15612. }
  15613. {
  15614. detail::UrlComponents uc;
  15615. ASSERT_FALSE(detail::parse_url("http://[::1<script>]/path", uc));
  15616. }
  15617. {
  15618. detail::UrlComponents uc;
  15619. ASSERT_FALSE(detail::parse_url("http://[]/path", uc));
  15620. }
  15621. }
  15622. TEST(ParseUrlTest, FragmentHandling) {
  15623. {
  15624. detail::UrlComponents uc;
  15625. ASSERT_TRUE(detail::parse_url("http://example.com/path#frag", uc));
  15626. EXPECT_EQ("/path", uc.path);
  15627. EXPECT_TRUE(uc.query.empty());
  15628. }
  15629. {
  15630. detail::UrlComponents uc;
  15631. ASSERT_TRUE(detail::parse_url("#frag", uc));
  15632. EXPECT_TRUE(uc.path.empty());
  15633. EXPECT_TRUE(uc.query.empty());
  15634. }
  15635. }
  15636. TEST(ParseUrlTest, UserinfoHandling) {
  15637. // Userinfo with @ but no colon — host includes @
  15638. detail::UrlComponents uc;
  15639. ASSERT_TRUE(detail::parse_url("http://user@host.com/path", uc));
  15640. EXPECT_EQ("user@host.com", uc.host);
  15641. EXPECT_EQ("/path", uc.path);
  15642. }
  15643. TEST(ParseUrlTest, IPv6EdgeCases) {
  15644. {
  15645. detail::UrlComponents uc;
  15646. ASSERT_TRUE(detail::parse_url("[::1]:8080", uc));
  15647. EXPECT_TRUE(uc.scheme.empty());
  15648. EXPECT_EQ("::1", uc.host);
  15649. EXPECT_EQ("8080", uc.port);
  15650. }
  15651. {
  15652. // Zone ID '%25' is not in [a-fA-F0-9:]
  15653. detail::UrlComponents uc;
  15654. ASSERT_FALSE(detail::parse_url("http://[fe80::1%25eth0]:443/path", uc));
  15655. }
  15656. }
  15657. TEST(ParseUrlTest, SchemeEdgeCases) {
  15658. {
  15659. detail::UrlComponents uc;
  15660. ASSERT_FALSE(detail::parse_url("://evil.com/path", uc));
  15661. }
  15662. {
  15663. detail::UrlComponents uc;
  15664. ASSERT_FALSE(detail::parse_url("ht-tp://evil.com/path", uc));
  15665. }
  15666. {
  15667. detail::UrlComponents uc;
  15668. ASSERT_FALSE(detail::parse_url("h.t://evil.com/path", uc));
  15669. }
  15670. }
  15671. TEST(ParseUrlTest, PortEdgeCases) {
  15672. {
  15673. detail::UrlComponents uc;
  15674. ASSERT_TRUE(detail::parse_url("http://example.com:/path", uc));
  15675. EXPECT_TRUE(uc.port.empty());
  15676. EXPECT_EQ("/path", uc.path);
  15677. }
  15678. {
  15679. // parse_url accepts any port string; validation is done by parse_port
  15680. detail::UrlComponents uc;
  15681. ASSERT_TRUE(detail::parse_url("http://example.com:abc/path", uc));
  15682. EXPECT_EQ("abc", uc.port);
  15683. }
  15684. }
  15685. TEST(ParseUrlTest, WebSocketPatterns) {
  15686. {
  15687. detail::UrlComponents uc;
  15688. ASSERT_TRUE(detail::parse_url("ws://echo.example.com:8080/ws", uc));
  15689. EXPECT_EQ("ws", uc.scheme);
  15690. EXPECT_EQ("echo.example.com", uc.host);
  15691. EXPECT_EQ("8080", uc.port);
  15692. EXPECT_EQ("/ws", uc.path);
  15693. }
  15694. {
  15695. detail::UrlComponents uc;
  15696. ASSERT_TRUE(detail::parse_url("wss://echo.example.com/ws", uc));
  15697. EXPECT_EQ("wss", uc.scheme);
  15698. EXPECT_EQ("echo.example.com", uc.host);
  15699. EXPECT_TRUE(uc.port.empty());
  15700. EXPECT_EQ("/ws", uc.path);
  15701. }
  15702. }
  15703. TEST(ParseUrlTest, QueryOnly) {
  15704. detail::UrlComponents uc;
  15705. ASSERT_TRUE(detail::parse_url("?q=1&r=2", uc));
  15706. EXPECT_TRUE(uc.host.empty());
  15707. EXPECT_TRUE(uc.path.empty());
  15708. EXPECT_EQ("?q=1&r=2", uc.query);
  15709. }
  15710. TEST(ParseUrlTest, SchemeRelativeWithPort) {
  15711. detail::UrlComponents uc;
  15712. ASSERT_TRUE(detail::parse_url("//example.com:443/path", uc));
  15713. EXPECT_TRUE(uc.scheme.empty());
  15714. EXPECT_EQ("example.com", uc.host);
  15715. EXPECT_EQ("443", uc.port);
  15716. EXPECT_EQ("/path", uc.path);
  15717. }
  15718. TEST(UniversalClientImplTest, Ipv6LiteralAddress) {
  15719. // If ipv6 regex working, regex match codepath is taken.
  15720. // else port will default to 80 in Client impl
  15721. int clientImplMagicPort = 80;
  15722. int port = 4321;
  15723. // above ports must be different to avoid false negative
  15724. EXPECT_NE(clientImplMagicPort, port);
  15725. std::string ipV6TestURL = "http://[ff06::c3]";
  15726. Client cli(ipV6TestURL + ":" + std::to_string(port), CLIENT_CERT_FILE,
  15727. CLIENT_PRIVATE_KEY_FILE);
  15728. EXPECT_EQ(cli.port(), port);
  15729. }
  15730. TEST(FileSystemTest, FileAndDirExistenceCheck) {
  15731. auto file_path = "./www/dir/index.html";
  15732. auto dir_path = "./www/dir";
  15733. detail::FileStat stat_file(file_path);
  15734. EXPECT_TRUE(stat_file.is_file());
  15735. EXPECT_FALSE(stat_file.is_dir());
  15736. detail::FileStat stat_dir(dir_path);
  15737. EXPECT_FALSE(stat_dir.is_file());
  15738. EXPECT_TRUE(stat_dir.is_dir());
  15739. }
  15740. TEST(MakeHostAndPortStringTest, VariousPatterns) {
  15741. // IPv4 with default HTTP port (80)
  15742. EXPECT_EQ("example.com",
  15743. detail::make_host_and_port_string("example.com", 80, false));
  15744. // IPv4 with default HTTPS port (443)
  15745. EXPECT_EQ("example.com",
  15746. detail::make_host_and_port_string("example.com", 443, true));
  15747. // IPv4 with non-default HTTP port
  15748. EXPECT_EQ("example.com:8080",
  15749. detail::make_host_and_port_string("example.com", 8080, false));
  15750. // IPv4 with non-default HTTPS port
  15751. EXPECT_EQ("example.com:8443",
  15752. detail::make_host_and_port_string("example.com", 8443, true));
  15753. // IPv6 with default HTTP port (80)
  15754. EXPECT_EQ("[::1]", detail::make_host_and_port_string("::1", 80, false));
  15755. // IPv6 with default HTTPS port (443)
  15756. EXPECT_EQ("[::1]", detail::make_host_and_port_string("::1", 443, true));
  15757. // IPv6 with non-default HTTP port
  15758. EXPECT_EQ("[::1]:8080",
  15759. detail::make_host_and_port_string("::1", 8080, false));
  15760. // IPv6 with non-default HTTPS port
  15761. EXPECT_EQ("[::1]:8443", detail::make_host_and_port_string("::1", 8443, true));
  15762. // IPv6 full address with default port
  15763. EXPECT_EQ("[2001:0db8:85a3:0000:0000:8a2e:0370:7334]",
  15764. detail::make_host_and_port_string(
  15765. "2001:0db8:85a3:0000:0000:8a2e:0370:7334", 443, true));
  15766. // IPv6 full address with non-default port
  15767. EXPECT_EQ("[2001:0db8:85a3:0000:0000:8a2e:0370:7334]:9000",
  15768. detail::make_host_and_port_string(
  15769. "2001:0db8:85a3:0000:0000:8a2e:0370:7334", 9000, false));
  15770. // IPv6 localhost with non-default port
  15771. EXPECT_EQ("[::1]:3000",
  15772. detail::make_host_and_port_string("::1", 3000, false));
  15773. // IPv6 with zone ID (link-local address) with default port
  15774. EXPECT_EQ("[fe80::1%eth0]",
  15775. detail::make_host_and_port_string("fe80::1%eth0", 80, false));
  15776. // IPv6 with zone ID (link-local address) with non-default port
  15777. EXPECT_EQ("[fe80::1%eth0]:8080",
  15778. detail::make_host_and_port_string("fe80::1%eth0", 8080, false));
  15779. // Edge case: Port 443 with is_ssl=false (should add port)
  15780. EXPECT_EQ("example.com:443",
  15781. detail::make_host_and_port_string("example.com", 443, false));
  15782. // Edge case: Port 80 with is_ssl=true (should add port)
  15783. EXPECT_EQ("example.com:80",
  15784. detail::make_host_and_port_string("example.com", 80, true));
  15785. // IPv6 edge case: Port 443 with is_ssl=false (should add port)
  15786. EXPECT_EQ("[::1]:443", detail::make_host_and_port_string("::1", 443, false));
  15787. // IPv6 edge case: Port 80 with is_ssl=true (should add port)
  15788. EXPECT_EQ("[::1]:80", detail::make_host_and_port_string("::1", 80, true));
  15789. // Security fix: Already bracketed IPv6 should not get double brackets
  15790. EXPECT_EQ("[::1]", detail::make_host_and_port_string("[::1]", 80, false));
  15791. EXPECT_EQ("[::1]", detail::make_host_and_port_string("[::1]", 443, true));
  15792. EXPECT_EQ("[::1]:8080",
  15793. detail::make_host_and_port_string("[::1]", 8080, false));
  15794. EXPECT_EQ("[2001:db8::1]:8080",
  15795. detail::make_host_and_port_string("[2001:db8::1]", 8080, false));
  15796. EXPECT_EQ("[fe80::1%eth0]",
  15797. detail::make_host_and_port_string("[fe80::1%eth0]", 80, false));
  15798. EXPECT_EQ("[fe80::1%eth0]:8080",
  15799. detail::make_host_and_port_string("[fe80::1%eth0]", 8080, false));
  15800. // Edge case: Empty host (should return as-is)
  15801. EXPECT_EQ("", detail::make_host_and_port_string("", 80, false));
  15802. // Edge case: Colon in hostname (non-IPv6) - will be treated as IPv6
  15803. // This is a known limitation but shouldn't crash
  15804. EXPECT_EQ("[host:name]",
  15805. detail::make_host_and_port_string("host:name", 80, false));
  15806. // Port number edge cases (no validation, but should not crash)
  15807. EXPECT_EQ("example.com:0",
  15808. detail::make_host_and_port_string("example.com", 0, false));
  15809. EXPECT_EQ("example.com:-1",
  15810. detail::make_host_and_port_string("example.com", -1, false));
  15811. EXPECT_EQ("example.com:65535",
  15812. detail::make_host_and_port_string("example.com", 65535, false));
  15813. EXPECT_EQ("example.com:65536",
  15814. detail::make_host_and_port_string("example.com", 65536, false));
  15815. }
  15816. #ifdef CPPHTTPLIB_SSL_ENABLED
  15817. TEST(SSLClientHostHeaderTest, Issue2301_Online) {
  15818. httplib::SSLClient cli("roblox.com", 443);
  15819. cli.set_follow_location(true);
  15820. auto res = cli.Get("/");
  15821. ASSERT_TRUE(res) << "Error: " << to_string(res.error());
  15822. EXPECT_EQ(StatusCode::OK_200, res->status);
  15823. }
  15824. #endif
  15825. TEST(DirtyDataRequestTest, HeadFieldValueContains_CR_LF_NUL) {
  15826. Server svr;
  15827. svr.Get("/test", [&](const Request & /*req*/, Response &res) {
  15828. EXPECT_EQ(res.status, 400);
  15829. });
  15830. auto thread = std::thread([&]() { svr.listen(HOST, PORT); });
  15831. auto se = detail::scope_exit([&] {
  15832. svr.stop();
  15833. thread.join();
  15834. ASSERT_FALSE(svr.is_running());
  15835. });
  15836. svr.wait_until_ready();
  15837. Client cli(HOST, PORT);
  15838. cli.Get("/test", Headers{{"Test", "_\n\r_\n\r_"}});
  15839. }
  15840. TEST(InvalidHeaderCharsTest, is_field_name) {
  15841. EXPECT_TRUE(detail::fields::is_field_name("exampleToken"));
  15842. EXPECT_TRUE(detail::fields::is_field_name("token123"));
  15843. EXPECT_TRUE(detail::fields::is_field_name("!#$%&'*+-.^_`|~"));
  15844. EXPECT_FALSE(detail::fields::is_field_name("example token"));
  15845. EXPECT_FALSE(detail::fields::is_field_name(" example_token"));
  15846. EXPECT_FALSE(detail::fields::is_field_name("example_token "));
  15847. EXPECT_FALSE(detail::fields::is_field_name("token@123"));
  15848. EXPECT_FALSE(detail::fields::is_field_name(""));
  15849. EXPECT_FALSE(detail::fields::is_field_name("example\rtoken"));
  15850. EXPECT_FALSE(detail::fields::is_field_name("example\ntoken"));
  15851. EXPECT_FALSE(detail::fields::is_field_name(std::string("\0", 1)));
  15852. EXPECT_FALSE(detail::fields::is_field_name("example\ttoken"));
  15853. }
  15854. TEST(InvalidHeaderCharsTest, is_field_value) {
  15855. EXPECT_TRUE(detail::fields::is_field_value("exampleToken"));
  15856. EXPECT_TRUE(detail::fields::is_field_value("token123"));
  15857. EXPECT_TRUE(detail::fields::is_field_value("!#$%&'*+-.^_`|~"));
  15858. EXPECT_TRUE(detail::fields::is_field_value("example token"));
  15859. EXPECT_FALSE(detail::fields::is_field_value(" example_token"));
  15860. EXPECT_FALSE(detail::fields::is_field_value("example_token "));
  15861. EXPECT_TRUE(detail::fields::is_field_value("token@123"));
  15862. EXPECT_TRUE(detail::fields::is_field_value(""));
  15863. EXPECT_FALSE(detail::fields::is_field_value("example\rtoken"));
  15864. EXPECT_FALSE(detail::fields::is_field_value("example\ntoken"));
  15865. EXPECT_FALSE(detail::fields::is_field_value(std::string("\0", 1)));
  15866. EXPECT_TRUE(detail::fields::is_field_value("example\ttoken"));
  15867. EXPECT_TRUE(detail::fields::is_field_value("0"));
  15868. }
  15869. TEST(InvalidHeaderCharsTest, OnServer) {
  15870. Server svr;
  15871. svr.Get("/test_name", [&](const Request &req, Response &res) {
  15872. std::string header = "Not Set";
  15873. if (req.has_param("header")) { header = req.get_param_value("header"); }
  15874. res.set_header(header, "value");
  15875. res.set_content("Page Content Page Content", "text/plain");
  15876. });
  15877. svr.Get("/test_value", [&](const Request &req, Response &res) {
  15878. std::string header = "Not Set";
  15879. if (req.has_param("header")) { header = req.get_param_value("header"); }
  15880. res.set_header("X-Test", header);
  15881. res.set_content("Page Content Page Content", "text/plain");
  15882. });
  15883. auto thread = std::thread([&]() { svr.listen(HOST, PORT); });
  15884. auto se = detail::scope_exit([&] {
  15885. svr.stop();
  15886. thread.join();
  15887. ASSERT_FALSE(svr.is_running());
  15888. });
  15889. svr.wait_until_ready();
  15890. Client cli(HOST, PORT);
  15891. {
  15892. auto res = cli.Get(
  15893. R"(/test_name?header=Value%00%0d%0aHEADER_KEY%3aHEADER_VALUE%0d%0a%0d%0aBODY_BODY_BODY)");
  15894. ASSERT_TRUE(res) << "Error: " << to_string(res.error());
  15895. EXPECT_EQ("Page Content Page Content", res->body);
  15896. EXPECT_FALSE(res->has_header("HEADER_KEY"));
  15897. }
  15898. {
  15899. auto res = cli.Get(
  15900. R"(/test_value?header=Value%00%0d%0aHEADER_KEY%3aHEADER_VALUE%0d%0a%0d%0aBODY_BODY_BODY)");
  15901. ASSERT_TRUE(res) << "Error: " << to_string(res.error());
  15902. EXPECT_EQ("Page Content Page Content", res->body);
  15903. EXPECT_FALSE(res->has_header("HEADER_KEY"));
  15904. }
  15905. }
  15906. TEST(InvalidHeaderValueTest, InvalidContentLength) {
  15907. auto handled = false;
  15908. Server svr;
  15909. svr.Post("/test", [&](const Request &, Response &) { handled = true; });
  15910. thread t = thread([&] { svr.listen(HOST, PORT); });
  15911. auto se = detail::scope_exit([&] {
  15912. svr.stop();
  15913. t.join();
  15914. ASSERT_FALSE(svr.is_running());
  15915. ASSERT_FALSE(handled);
  15916. });
  15917. svr.wait_until_ready();
  15918. auto req = "POST /test HTTP/1.1\r\n"
  15919. "Content-Length: x\r\n"
  15920. "\r\n";
  15921. std::string response;
  15922. ASSERT_TRUE(send_request(1, req, &response));
  15923. ASSERT_EQ("HTTP/1.1 400 Bad Request",
  15924. response.substr(0, response.find("\r\n")));
  15925. }
  15926. // RFC 9110 Section 10.1.1: Expect is a comma-separated list, its value is
  15927. // case-insensitive, and a server that receives a 100-continue expectation in
  15928. // an HTTP/1.0 request MUST ignore it.
  15929. static void probe_expect(int port, const std::string &req, bool *got_100) {
  15930. std::string response;
  15931. ASSERT_TRUE(send_request(1, req, &response, port));
  15932. *got_100 = response.find("100 Continue") != std::string::npos;
  15933. }
  15934. class ExpectTokenTest : public ::testing::Test {
  15935. protected:
  15936. void SetUp() override {
  15937. svr_.Post("/p", [](const Request &, Response &res) {
  15938. res.set_content("ok", "text/plain");
  15939. });
  15940. port_ = svr_.bind_to_any_port(HOST);
  15941. thread_ = thread([&]() { svr_.listen_after_bind(); });
  15942. svr_.wait_until_ready();
  15943. }
  15944. void TearDown() override {
  15945. svr_.stop();
  15946. if (thread_.joinable()) { thread_.join(); }
  15947. }
  15948. std::string request(const char *version, const char *expect_value) const {
  15949. return std::string("POST /p ") + version +
  15950. "\r\n"
  15951. "Host: localhost\r\n"
  15952. "Content-Length: 2\r\n"
  15953. "Connection: close\r\n"
  15954. "Expect: " +
  15955. expect_value +
  15956. "\r\n"
  15957. "\r\n"
  15958. "hi";
  15959. }
  15960. Server svr_;
  15961. int port_ = 0;
  15962. thread thread_;
  15963. };
  15964. TEST_F(ExpectTokenTest, Http11GetsTheInterimResponse) {
  15965. bool got_100 = false;
  15966. probe_expect(port_, request("HTTP/1.1", "100-continue"), &got_100);
  15967. EXPECT_TRUE(got_100);
  15968. }
  15969. TEST_F(ExpectTokenTest, Http10ExpectationIsIgnored) {
  15970. bool got_100 = true;
  15971. probe_expect(port_, request("HTTP/1.0", "100-continue"), &got_100);
  15972. EXPECT_FALSE(got_100);
  15973. }
  15974. TEST_F(ExpectTokenTest, ExpectationIsCaseInsensitive) {
  15975. bool got_100 = false;
  15976. probe_expect(port_, request("HTTP/1.1", "100-Continue"), &got_100);
  15977. EXPECT_TRUE(got_100);
  15978. }
  15979. TEST_F(ExpectTokenTest, ExpectationAmongOthersIsRecognized) {
  15980. bool got_100 = false;
  15981. probe_expect(port_, request("HTTP/1.1", "100-continue, foo"), &got_100);
  15982. EXPECT_TRUE(got_100);
  15983. }
  15984. // `100 Continue` is sent only when the server starts reading the body, so a
  15985. // request rejected before that never invites the client to send it. The
  15986. // requests below carry the expectation but withhold the body, as a client
  15987. // waiting for `100 Continue` would.
  15988. // A POST that expects `100 Continue` and withholds its two-byte body.
  15989. static std::string expect_headers_only(const std::string &path) {
  15990. return "POST " + path +
  15991. " HTTP/1.1\r\n"
  15992. "Host: localhost\r\n"
  15993. "Content-Length: 2\r\n"
  15994. "Expect: 100-continue\r\n"
  15995. "\r\n";
  15996. }
  15997. class ExpectLazyContinueTest : public ::testing::Test {
  15998. protected:
  15999. void SetUp() override {
  16000. svr_.set_pre_routing_handler([](const Request &req, Response &res) {
  16001. if (req.path == "/pre-routing") {
  16002. res.status = StatusCode::Unauthorized_401;
  16003. return Server::HandlerResponse::Handled;
  16004. }
  16005. return Server::HandlerResponse::Unhandled;
  16006. });
  16007. svr_.set_pre_request_handler([](const Request &req, Response &res) {
  16008. if (req.matched_route == "/pre-request") {
  16009. res.status = StatusCode::Forbidden_403;
  16010. return Server::HandlerResponse::Handled;
  16011. }
  16012. return Server::HandlerResponse::Unhandled;
  16013. });
  16014. svr_.Post("/pre-routing", [](const Request &, Response &res) {
  16015. res.set_content("ok", "text/plain");
  16016. });
  16017. svr_.Post("/pre-request", [](const Request &, Response &res) {
  16018. res.set_content("ok", "text/plain");
  16019. });
  16020. svr_.Post("/reader-used", [](const Request &, Response &res,
  16021. const ContentReader &content_reader) {
  16022. std::string body;
  16023. content_reader([&](const char *data, size_t len) {
  16024. body.append(data, len);
  16025. return true;
  16026. });
  16027. res.set_content(body, "text/plain");
  16028. });
  16029. svr_.Post("/reader-unused",
  16030. [](const Request &, Response &res, const ContentReader &) {
  16031. res.set_content("ignored", "text/plain");
  16032. });
  16033. port_ = svr_.bind_to_any_port(HOST);
  16034. thread_ = thread([&]() { svr_.listen_after_bind(); });
  16035. svr_.wait_until_ready();
  16036. }
  16037. void TearDown() override {
  16038. svr_.stop();
  16039. if (thread_.joinable()) { thread_.join(); }
  16040. }
  16041. // Sends `req` and reads until the server closes the connection. Returns
  16042. // false if the read had to wait for the client-side timeout instead.
  16043. bool send_until_closed(const std::string &req, std::string *resp) const {
  16044. auto start = std::chrono::steady_clock::now();
  16045. if (!send_request(3, req, resp, port_)) { return false; }
  16046. auto elapsed = std::chrono::steady_clock::now() - start;
  16047. return elapsed < std::chrono::seconds(2);
  16048. }
  16049. // The final response comes without `100 Continue`, and the server closes
  16050. // the connection since the body may or may not follow.
  16051. void expect_final_without_interim(const std::string &path,
  16052. const char *status_line) const {
  16053. std::string resp;
  16054. ASSERT_TRUE(send_until_closed(expect_headers_only(path), &resp));
  16055. EXPECT_EQ(std::string::npos, resp.find("100 Continue"));
  16056. EXPECT_EQ(0u, resp.find(status_line));
  16057. EXPECT_NE(std::string::npos, resp.find("Connection: close"));
  16058. }
  16059. Server svr_;
  16060. int port_ = 0;
  16061. thread thread_;
  16062. };
  16063. TEST_F(ExpectLazyContinueTest, PreRoutingRejectsWithoutInterimResponse) {
  16064. expect_final_without_interim("/pre-routing", "HTTP/1.1 401");
  16065. }
  16066. TEST_F(ExpectLazyContinueTest, PreRequestRejectsWithoutInterimResponse) {
  16067. expect_final_without_interim("/pre-request", "HTTP/1.1 403");
  16068. }
  16069. TEST_F(ExpectLazyContinueTest, UnknownRouteRejectsWithoutInterimResponse) {
  16070. expect_final_without_interim("/nowhere", "HTTP/1.1 404");
  16071. }
  16072. TEST_F(ExpectLazyContinueTest, UnreadContentReaderClosesWithoutInterim) {
  16073. expect_final_without_interim("/reader-unused", "HTTP/1.1 200");
  16074. }
  16075. TEST_F(ExpectLazyContinueTest, ContentReaderGetsInterimResponse) {
  16076. // The body follows once `100 Continue` has had time to arrive.
  16077. auto req = expect_headers_only("/reader-used");
  16078. req.insert(req.size() - 2, "Connection: close\r\n");
  16079. std::string resp;
  16080. ASSERT_TRUE(send_request_in_parts(3, {req, "hi"}, &resp, port_));
  16081. EXPECT_EQ(0u, resp.find("HTTP/1.1 100 Continue"));
  16082. EXPECT_NE(std::string::npos, resp.find("HTTP/1.1 200"));
  16083. EXPECT_NE(std::string::npos, resp.find("hi"));
  16084. }
  16085. TEST_F(ExpectLazyContinueTest, ClientWithholdsBodyWhenRejected) {
  16086. // Large enough for the client to add `Expect: 100-continue` itself.
  16087. const size_t length = CPPHTTPLIB_EXPECT_100_THRESHOLD * 4;
  16088. std::atomic<bool> body_sent{false};
  16089. Client cli(HOST, port_);
  16090. auto res = cli.Post(
  16091. "/pre-request", length,
  16092. [&](size_t /*offset*/, size_t len, DataSink &sink) {
  16093. body_sent = true;
  16094. std::string chunk(len, 'x');
  16095. sink.write(chunk.data(), chunk.size());
  16096. return true;
  16097. },
  16098. "application/octet-stream");
  16099. ASSERT_TRUE(res);
  16100. EXPECT_EQ(StatusCode::Forbidden_403, res->status);
  16101. EXPECT_FALSE(body_sent);
  16102. }
  16103. TEST(Expect100ContinueHandlerTest, ExpectationFailedIsFinalResponse) {
  16104. Server svr;
  16105. svr.set_expect_100_continue_handler([](const Request &, Response &) {
  16106. return StatusCode::ExpectationFailed_417;
  16107. });
  16108. svr.Post("/p", [](const Request &, Response &res) {
  16109. res.set_content("ok", "text/plain");
  16110. });
  16111. auto port = svr.bind_to_any_port(HOST);
  16112. thread t = thread([&] { svr.listen_after_bind(); });
  16113. auto se = detail::scope_exit([&] {
  16114. svr.stop();
  16115. t.join();
  16116. });
  16117. svr.wait_until_ready();
  16118. std::string resp;
  16119. ASSERT_TRUE(send_request(3, expect_headers_only("/p"), &resp, port));
  16120. EXPECT_EQ(0u, resp.find("HTTP/1.1 417"));
  16121. EXPECT_NE(std::string::npos, resp.find("Connection: close"));
  16122. // Exactly one response: the route handler must not run after the 417.
  16123. EXPECT_EQ(std::string::npos, resp.find("HTTP/1.1", 1));
  16124. }
  16125. #ifndef _WIN32
  16126. TEST(Expect100ContinueTest, ServerClosesConnection) {
  16127. static constexpr char reject[] = "Unauthorized";
  16128. static constexpr char accept[] = "Upload accepted";
  16129. constexpr size_t total_size = 10 * 1024 * 1024 * 1024ULL;
  16130. Server svr;
  16131. svr.set_expect_100_continue_handler(
  16132. [](const Request & /*req*/, Response &res) {
  16133. res.status = StatusCode::Unauthorized_401;
  16134. res.set_content(reject, "text/plain");
  16135. return res.status;
  16136. });
  16137. svr.Post("/", [&](const Request & /*req*/, Response &res) {
  16138. res.set_content(accept, "text/plain");
  16139. });
  16140. auto thread = std::thread([&]() { svr.listen(HOST, PORT); });
  16141. auto se = detail::scope_exit([&] {
  16142. svr.stop();
  16143. thread.join();
  16144. ASSERT_FALSE(svr.is_running());
  16145. });
  16146. svr.wait_until_ready();
  16147. {
  16148. const auto curl = std::unique_ptr<CURL, decltype(&curl_easy_cleanup)>{
  16149. curl_easy_init(), &curl_easy_cleanup};
  16150. ASSERT_NE(curl, nullptr);
  16151. curl_easy_setopt(curl.get(), CURLOPT_URL, HOST);
  16152. curl_easy_setopt(curl.get(), CURLOPT_PORT, PORT);
  16153. curl_easy_setopt(curl.get(), CURLOPT_POST, 1L);
  16154. auto list = std::unique_ptr<curl_slist, decltype(&curl_slist_free_all)>{
  16155. curl_slist_append(nullptr, "Content-Type: application/octet-stream"),
  16156. &curl_slist_free_all};
  16157. ASSERT_NE(list, nullptr);
  16158. curl_easy_setopt(curl.get(), CURLOPT_HTTPHEADER, list.get());
  16159. struct read_data {
  16160. size_t read_size;
  16161. size_t total_size;
  16162. } data = {0, total_size};
  16163. using read_callback_t =
  16164. size_t (*)(char *ptr, size_t size, size_t nmemb, void *userdata);
  16165. read_callback_t read_callback = [](char *ptr, size_t size, size_t nmemb,
  16166. void *userdata) -> size_t {
  16167. read_data *d = (read_data *)userdata;
  16168. if (!userdata || d->read_size >= d->total_size) { return 0; }
  16169. std::fill_n(ptr, size * nmemb, 'A');
  16170. d->read_size += size * nmemb;
  16171. return size * nmemb;
  16172. };
  16173. curl_easy_setopt(curl.get(), CURLOPT_READDATA, data);
  16174. curl_easy_setopt(curl.get(), CURLOPT_READFUNCTION, read_callback);
  16175. std::vector<char> buffer;
  16176. curl_easy_setopt(curl.get(), CURLOPT_WRITEDATA, &buffer);
  16177. using write_callback_t =
  16178. size_t (*)(char *ptr, size_t size, size_t nmemb, void *userdata);
  16179. write_callback_t write_callback = [](char *ptr, size_t size, size_t nmemb,
  16180. void *userdata) -> size_t {
  16181. std::vector<char> *buf = (std::vector<char> *)userdata;
  16182. buf->reserve(buf->size() + size * nmemb + 1);
  16183. buf->insert(buf->end(), (char *)ptr, (char *)ptr + size * nmemb);
  16184. return size * nmemb;
  16185. };
  16186. curl_easy_setopt(curl.get(), CURLOPT_WRITEFUNCTION, write_callback);
  16187. {
  16188. const auto res = curl_easy_perform(curl.get());
  16189. ASSERT_EQ(res, CURLE_OK);
  16190. }
  16191. {
  16192. auto response_code = long{};
  16193. const auto res =
  16194. curl_easy_getinfo(curl.get(), CURLINFO_RESPONSE_CODE, &response_code);
  16195. ASSERT_EQ(res, CURLE_OK);
  16196. ASSERT_EQ(response_code, StatusCode::Unauthorized_401);
  16197. }
  16198. {
  16199. auto dl = curl_off_t{};
  16200. const auto res =
  16201. curl_easy_getinfo(curl.get(), CURLINFO_SIZE_DOWNLOAD_T, &dl);
  16202. ASSERT_EQ(res, CURLE_OK);
  16203. ASSERT_EQ(dl, (curl_off_t)sizeof reject - 1);
  16204. }
  16205. {
  16206. buffer.push_back('\0');
  16207. ASSERT_STRCASEEQ(buffer.data(), reject);
  16208. }
  16209. }
  16210. }
  16211. #endif
  16212. #if defined(CPPHTTPLIB_OPENSSL_SUPPORT) && !defined(_WIN32)
  16213. // Regression test for #2458.
  16214. //
  16215. // A large request body (>= CPPHTTPLIB_EXPECT_100_THRESHOLD) makes the client
  16216. // auto-add `Expect: 100-continue`. Over TLS, the server's TLS 1.3 session
  16217. // ticket can make the client socket spuriously readable during the
  16218. // 100-continue wait. If the readiness is mistaken for an incoming response,
  16219. // the client withholds the body and then blocks reading a response that never
  16220. // comes, failing with `Failed to read connection`.
  16221. //
  16222. // A correct client (like curl) sends the body once no `100 Continue` arrives
  16223. // within the timeout. This raw OpenSSL server deliberately never sends
  16224. // `100 Continue`; the client must still deliver the body and receive 200.
  16225. TEST(Expect100ContinueTest, TLSServerOmits100Continue) {
  16226. signal(SIGPIPE, SIG_IGN);
  16227. const auto port = PORT + 4;
  16228. auto srv = ::socket(AF_INET, SOCK_STREAM, 0);
  16229. ASSERT_NE(srv, INVALID_SOCKET);
  16230. int opt = 1;
  16231. ::setsockopt(srv, SOL_SOCKET, SO_REUSEADDR, &opt, sizeof(opt));
  16232. sockaddr_in addr{};
  16233. addr.sin_family = AF_INET;
  16234. addr.sin_port = htons(static_cast<uint16_t>(port));
  16235. ::inet_pton(AF_INET, "127.0.0.1", &addr.sin_addr);
  16236. ASSERT_EQ(0, ::bind(srv, reinterpret_cast<sockaddr *>(&addr), sizeof(addr)));
  16237. ASSERT_EQ(0, ::listen(srv, 1));
  16238. std::atomic<size_t> server_body_bytes{0};
  16239. auto server_thread = std::thread([&] {
  16240. sockaddr_in cli_addr{};
  16241. socklen_t cli_len = sizeof(cli_addr);
  16242. auto cli = ::accept(srv, reinterpret_cast<sockaddr *>(&cli_addr), &cli_len);
  16243. if (cli == INVALID_SOCKET) { return; }
  16244. // Bound the lifetime of the server side so a buggy client (which never
  16245. // sends the body) cannot make this thread block forever on join.
  16246. detail::set_socket_opt_time(cli, SOL_SOCKET, SO_RCVTIMEO, 4, 0);
  16247. SSL_CTX *ctx = SSL_CTX_new(TLS_server_method());
  16248. SSL_CTX_set_min_proto_version(ctx, TLS1_3_VERSION);
  16249. SSL_CTX_use_certificate_file(ctx, SERVER_CERT_FILE, SSL_FILETYPE_PEM);
  16250. SSL_CTX_use_PrivateKey_file(ctx, SERVER_PRIVATE_KEY_FILE, SSL_FILETYPE_PEM);
  16251. SSL *ssl = SSL_new(ctx);
  16252. SSL_set_fd(ssl, static_cast<int>(cli));
  16253. if (SSL_accept(ssl) > 0) {
  16254. // Read the request headers. Reading here also flushes the TLS 1.3
  16255. // session tickets to the client. Deliberately do NOT send
  16256. // `100 Continue`.
  16257. std::string buf;
  16258. char tmp[1024];
  16259. while (buf.find("\r\n\r\n") == std::string::npos) {
  16260. auto n = SSL_read(ssl, tmp, sizeof(tmp));
  16261. if (n <= 0) { break; }
  16262. buf.append(tmp, static_cast<size_t>(n));
  16263. }
  16264. // A correct client sends the body now; count what arrives.
  16265. auto pos = buf.find("\r\n\r\n");
  16266. size_t body = (pos == std::string::npos) ? 0 : buf.size() - (pos + 4);
  16267. while (body < 4096) {
  16268. auto n = SSL_read(ssl, tmp, sizeof(tmp));
  16269. if (n <= 0) { break; }
  16270. body += static_cast<size_t>(n);
  16271. }
  16272. server_body_bytes = body;
  16273. std::string resp = "HTTP/1.1 200 OK\r\nContent-Length: 2\r\n\r\nok";
  16274. SSL_write(ssl, resp.data(), static_cast<int>(resp.size()));
  16275. SSL_shutdown(ssl);
  16276. }
  16277. SSL_free(ssl);
  16278. detail::close_socket(cli);
  16279. SSL_CTX_free(ctx);
  16280. });
  16281. auto se = detail::scope_exit([&] {
  16282. server_thread.join();
  16283. detail::close_socket(srv);
  16284. });
  16285. SSLClient cli("127.0.0.1", port);
  16286. cli.enable_server_certificate_verification(false);
  16287. cli.set_connection_timeout(5, 0);
  16288. cli.set_read_timeout(3, 0); // short, so a hang surfaces quickly
  16289. // Body larger than CPPHTTPLIB_EXPECT_100_THRESHOLD (1024) -> auto Expect.
  16290. std::string body(4096, 'A');
  16291. auto res = cli.Put("/api/test", body, "application/json");
  16292. ASSERT_TRUE(res) << "request failed: " << to_string(res.error());
  16293. EXPECT_EQ(StatusCode::OK_200, res->status);
  16294. EXPECT_EQ(body.size(), server_body_bytes.load());
  16295. }
  16296. #endif
  16297. template <typename S, typename C>
  16298. inline void max_timeout_test(S &svr, C &cli, time_t timeout, time_t threshold) {
  16299. svr.Get("/stream", [&](const Request &, Response &res) {
  16300. auto data = new std::string("01234567890123456789");
  16301. res.set_content_provider(
  16302. data->size(), "text/plain",
  16303. [&, data](size_t offset, size_t length, DataSink &sink) {
  16304. const size_t DATA_CHUNK_SIZE = 4;
  16305. const auto &d = *data;
  16306. std::this_thread::sleep_for(std::chrono::seconds(1));
  16307. sink.write(&d[offset], std::min(length, DATA_CHUNK_SIZE));
  16308. return true;
  16309. },
  16310. [data](bool success) {
  16311. EXPECT_FALSE(success);
  16312. delete data;
  16313. });
  16314. });
  16315. svr.Get("/stream_without_length", [&](const Request &, Response &res) {
  16316. auto i = new size_t(0);
  16317. res.set_content_provider(
  16318. "text/plain",
  16319. [i](size_t, DataSink &sink) {
  16320. if (*i < 5) {
  16321. std::this_thread::sleep_for(std::chrono::seconds(1));
  16322. sink.write("abcd", 4);
  16323. (*i)++;
  16324. } else {
  16325. sink.done();
  16326. }
  16327. return true;
  16328. },
  16329. [i](bool success) {
  16330. EXPECT_FALSE(success);
  16331. delete i;
  16332. });
  16333. });
  16334. svr.Get("/chunked", [&](const Request &, Response &res) {
  16335. auto i = new size_t(0);
  16336. res.set_chunked_content_provider(
  16337. "text/plain",
  16338. [i](size_t, DataSink &sink) {
  16339. if (*i < 5) {
  16340. std::this_thread::sleep_for(std::chrono::seconds(1));
  16341. sink.os << "abcd";
  16342. (*i)++;
  16343. } else {
  16344. sink.done();
  16345. }
  16346. return true;
  16347. },
  16348. [i](bool success) {
  16349. EXPECT_FALSE(success);
  16350. delete i;
  16351. });
  16352. });
  16353. auto listen_thread = std::thread([&svr]() { svr.listen("localhost", PORT); });
  16354. auto se = detail::scope_exit([&] {
  16355. svr.stop();
  16356. listen_thread.join();
  16357. ASSERT_FALSE(svr.is_running());
  16358. });
  16359. svr.wait_until_ready();
  16360. cli.set_max_timeout(std::chrono::milliseconds(timeout));
  16361. {
  16362. auto start = std::chrono::steady_clock::now();
  16363. auto res = cli.Get("/stream");
  16364. auto elapsed = std::chrono::duration_cast<std::chrono::milliseconds>(
  16365. std::chrono::steady_clock::now() - start)
  16366. .count();
  16367. ASSERT_FALSE(res);
  16368. EXPECT_EQ(Error::Read, res.error());
  16369. EXPECT_TRUE(timeout <= elapsed && elapsed < timeout + threshold)
  16370. << "Timeout exceeded by " << (elapsed - timeout) << "ms";
  16371. }
  16372. {
  16373. auto start = std::chrono::steady_clock::now();
  16374. auto res = cli.Get("/stream_without_length");
  16375. auto elapsed = std::chrono::duration_cast<std::chrono::milliseconds>(
  16376. std::chrono::steady_clock::now() - start)
  16377. .count();
  16378. ASSERT_FALSE(res);
  16379. EXPECT_EQ(Error::Read, res.error());
  16380. EXPECT_TRUE(timeout <= elapsed && elapsed < timeout + threshold)
  16381. << "Timeout exceeded by " << (elapsed - timeout) << "ms";
  16382. }
  16383. {
  16384. auto start = std::chrono::steady_clock::now();
  16385. auto res = cli.Get("/chunked", [&](const char *data, size_t data_length) {
  16386. EXPECT_EQ("abcd", string(data, data_length));
  16387. return true;
  16388. });
  16389. auto elapsed = std::chrono::duration_cast<std::chrono::milliseconds>(
  16390. std::chrono::steady_clock::now() - start)
  16391. .count();
  16392. ASSERT_FALSE(res);
  16393. EXPECT_EQ(Error::Read, res.error());
  16394. EXPECT_TRUE(timeout <= elapsed && elapsed < timeout + threshold)
  16395. << "Timeout exceeded by " << (elapsed - timeout) << "ms";
  16396. }
  16397. }
  16398. TEST(MaxTimeoutTest, ContentStream) {
  16399. time_t timeout = 2000;
  16400. time_t threshold = 200;
  16401. Server svr;
  16402. Client cli("localhost", PORT);
  16403. max_timeout_test(svr, cli, timeout, threshold);
  16404. }
  16405. #ifdef CPPHTTPLIB_SSL_ENABLED
  16406. TEST(MaxTimeoutTest, ContentStreamSSL) {
  16407. time_t timeout = 2000;
  16408. time_t threshold = 1200; // SSL_shutdown is slow on some operating systems.
  16409. SSLServer svr(SERVER_CERT_FILE, SERVER_PRIVATE_KEY_FILE);
  16410. SSLClient cli("localhost", PORT);
  16411. cli.enable_server_certificate_verification(false);
  16412. max_timeout_test(svr, cli, timeout, threshold);
  16413. }
  16414. #endif
  16415. class EventDispatcher {
  16416. public:
  16417. EventDispatcher() {}
  16418. bool wait_event(DataSink *sink) {
  16419. unique_lock<mutex> lk(m_);
  16420. int id = id_;
  16421. // Wait with timeout to prevent hanging if client disconnects
  16422. if (!cv_.wait_for(lk, std::chrono::seconds(5),
  16423. [&] { return cid_ == id; })) {
  16424. return false; // Timeout occurred
  16425. }
  16426. sink->write(message_.data(), message_.size());
  16427. return true;
  16428. }
  16429. void send_event(const string &message) {
  16430. lock_guard<mutex> lk(m_);
  16431. cid_ = id_++;
  16432. message_ = message;
  16433. cv_.notify_all();
  16434. }
  16435. private:
  16436. mutex m_;
  16437. condition_variable cv_;
  16438. atomic_int id_{0};
  16439. atomic_int cid_{-1};
  16440. string message_;
  16441. };
  16442. TEST(ClientInThreadTest, Issue2068) {
  16443. EventDispatcher ed;
  16444. Server svr;
  16445. svr.Get("/event1", [&](const Request & /*req*/, Response &res) {
  16446. res.set_chunked_content_provider("text/event-stream",
  16447. [&](size_t /*offset*/, DataSink &sink) {
  16448. return ed.wait_event(&sink);
  16449. });
  16450. });
  16451. auto listen_thread = std::thread([&svr]() { svr.listen(HOST, PORT); });
  16452. svr.wait_until_ready();
  16453. thread event_thread([&] {
  16454. int id = 0;
  16455. while (svr.is_running()) {
  16456. this_thread::sleep_for(chrono::milliseconds(500));
  16457. std::stringstream ss;
  16458. ss << "data: " << id << "\n\n";
  16459. ed.send_event(ss.str());
  16460. id++;
  16461. }
  16462. });
  16463. auto se = detail::scope_exit([&] {
  16464. svr.stop();
  16465. listen_thread.join();
  16466. event_thread.join();
  16467. ASSERT_FALSE(svr.is_running());
  16468. });
  16469. {
  16470. auto client = detail::make_unique<Client>(HOST, PORT);
  16471. client->set_read_timeout(std::chrono::minutes(10));
  16472. std::atomic<bool> stop{false};
  16473. std::thread t([&] {
  16474. client->Get("/event1",
  16475. [&](const char *, size_t) -> bool { return !stop; });
  16476. });
  16477. std::this_thread::sleep_for(std::chrono::seconds(2));
  16478. stop = true;
  16479. client->stop();
  16480. t.join();
  16481. // Reset client after thread has finished
  16482. client.reset();
  16483. }
  16484. }
  16485. TEST(RequestSmugglingTest, DuplicateContentLengthDifferentValues) {
  16486. auto handled = false;
  16487. Server svr;
  16488. svr.Post("/test", [&](const Request &, Response &) { handled = true; });
  16489. thread t = thread([&]() { svr.listen(HOST, PORT); });
  16490. auto se = detail::scope_exit([&] {
  16491. svr.stop();
  16492. t.join();
  16493. ASSERT_FALSE(svr.is_running());
  16494. ASSERT_FALSE(handled);
  16495. });
  16496. svr.wait_until_ready();
  16497. // Two Content-Length headers with different values — must be rejected
  16498. auto req = "POST /test HTTP/1.1\r\n"
  16499. "Content-Length: 5\r\n"
  16500. "Content-Length: 10\r\n"
  16501. "\r\n"
  16502. "hello";
  16503. std::string response;
  16504. ASSERT_TRUE(send_request(1, req, &response));
  16505. ASSERT_EQ("HTTP/1.1 400 Bad Request",
  16506. response.substr(0, response.find("\r\n")));
  16507. }
  16508. TEST(RequestSmugglingTest, DuplicateContentLengthSameValues) {
  16509. auto handled = false;
  16510. Server svr;
  16511. svr.Post("/test", [&](const Request &, Response &res) {
  16512. handled = true;
  16513. res.set_content("ok", "text/plain");
  16514. });
  16515. thread t = thread([&]() { svr.listen(HOST, PORT); });
  16516. auto se = detail::scope_exit([&] {
  16517. svr.stop();
  16518. t.join();
  16519. ASSERT_FALSE(svr.is_running());
  16520. ASSERT_TRUE(handled);
  16521. });
  16522. svr.wait_until_ready();
  16523. // Two Content-Length headers with same value — should be accepted (RFC 9110)
  16524. auto req = "POST /test HTTP/1.1\r\n"
  16525. "Content-Length: 5\r\n"
  16526. "Content-Length: 5\r\n"
  16527. "\r\n"
  16528. "hello";
  16529. std::string response;
  16530. ASSERT_TRUE(send_request(1, req, &response));
  16531. ASSERT_EQ("HTTP/1.1 200 OK", response.substr(0, response.find("\r\n")));
  16532. }
  16533. TEST(HostHeaderValidationTest, AmbiguousOrInvalidHostRejected) {
  16534. Server svr;
  16535. svr.Get("/test", [](const Request &, Response &res) {
  16536. res.set_content("ok", "text/plain");
  16537. });
  16538. auto port = svr.bind_to_any_port(HOST);
  16539. thread t = thread([&] { svr.listen_after_bind(); });
  16540. auto se = detail::scope_exit([&] {
  16541. svr.stop();
  16542. t.join();
  16543. ASSERT_FALSE(svr.is_running());
  16544. });
  16545. svr.wait_until_ready();
  16546. auto status_line = [&](const std::string &host_lines) {
  16547. std::string res;
  16548. send_request(
  16549. 5, "GET /test HTTP/1.1\r\n" + host_lines + "Connection: close\r\n\r\n",
  16550. &res, port);
  16551. return res.substr(0, res.find("\r\n"));
  16552. };
  16553. const char *accepted[] = {
  16554. "Host: localhost\r\n",
  16555. "Host: a.example:8080\r\n",
  16556. "Host: my_service\r\n",
  16557. "Host: [::1]:8080\r\n",
  16558. "Host: [fe80::1%25eth0]\r\n",
  16559. "Host: \r\n", // RFC 9112 §3.2: the target URI has no authority
  16560. };
  16561. for (auto host_lines : accepted) {
  16562. EXPECT_EQ("HTTP/1.1 200 OK", status_line(host_lines)) << host_lines;
  16563. }
  16564. const char *rejected[] = {
  16565. "Host: a.example\r\nHost: b.example\r\n",
  16566. "Host: a.example\r\nHost: a.example\r\n",
  16567. "Host: a@b.example\r\n",
  16568. "Host: a.example/b\r\n",
  16569. "Host: a.example\\b\r\n",
  16570. "Host: a.example?b\r\n",
  16571. "Host: a.example#b\r\n",
  16572. "Host: a.example b.example\r\n",
  16573. };
  16574. for (auto host_lines : rejected) {
  16575. EXPECT_EQ("HTTP/1.1 400 Bad Request", status_line(host_lines))
  16576. << host_lines;
  16577. }
  16578. }
  16579. TEST(HeaderSmugglingTest, ChunkedTrailerHeadersMerged) {
  16580. Server svr;
  16581. svr.Get("/", [](const Request &req, Response &res) {
  16582. EXPECT_EQ(2U, req.trailers.size());
  16583. EXPECT_FALSE(req.has_trailer("[invalid key...]"));
  16584. // Denied
  16585. EXPECT_FALSE(req.has_trailer("Content-Length"));
  16586. EXPECT_FALSE(req.has_trailer("X-Forwarded-For"));
  16587. // Accepted
  16588. EXPECT_TRUE(req.has_trailer("X-Hello"));
  16589. EXPECT_EQ(req.get_trailer_value("X-Hello"), "hello");
  16590. EXPECT_TRUE(req.has_trailer("X-World"));
  16591. EXPECT_EQ(req.get_trailer_value("X-World"), "world");
  16592. res.set_content("ok", "text/plain");
  16593. });
  16594. thread t = thread([&]() { svr.listen(HOST, PORT); });
  16595. auto se = detail::scope_exit([&] {
  16596. svr.stop();
  16597. t.join();
  16598. ASSERT_FALSE(svr.is_running());
  16599. });
  16600. svr.wait_until_ready();
  16601. const std::string req = "GET / HTTP/1.1\r\n"
  16602. "Transfer-Encoding: chunked\r\n"
  16603. "Trailer: X-Hello, X-World, X-AAA, X-BBB\r\n"
  16604. "\r\n"
  16605. "0\r\n"
  16606. "Content-Length: 10\r\n"
  16607. "Host: internal.local\r\n"
  16608. "Content-Type: malicious/content\r\n"
  16609. "Cookie: any\r\n"
  16610. "Set-Cookie: any\r\n"
  16611. "X-Forwarded-For: attacker.com\r\n"
  16612. "X-Real-Ip: 1.1.1.1\r\n"
  16613. "X-Hello: hello\r\n"
  16614. "X-World: world\r\n"
  16615. "\r\n";
  16616. std::string res;
  16617. ASSERT_TRUE(send_request(1, req, &res));
  16618. }
  16619. // RFC 9110 Section 5.2 and 5.3: a comma-separated list field may be sent as
  16620. // several field lines, and the combined value is what has to be parsed. A
  16621. // Trailer field split across lines therefore declares every name it lists;
  16622. // reading only the first line silently drops the trailers the later lines
  16623. // declare. The prohibited-trailer filter still applies to every line.
  16624. TEST(HeaderSmugglingTest, DuplicateTrailerFieldLinesDeclareAllTrailers) {
  16625. Server svr;
  16626. size_t observed_trailer_count = 0;
  16627. std::string observed_hello;
  16628. std::string observed_world;
  16629. bool observed_content_length = true;
  16630. svr.Get("/", [&](const Request &req, Response &res) {
  16631. observed_trailer_count = req.trailers.size();
  16632. observed_hello = req.get_trailer_value("X-Hello");
  16633. observed_world = req.get_trailer_value("X-World");
  16634. observed_content_length = req.has_trailer("Content-Length");
  16635. res.set_content("ok", "text/plain");
  16636. });
  16637. auto port = svr.bind_to_any_port(HOST);
  16638. thread t = thread([&]() { svr.listen_after_bind(); });
  16639. auto se = detail::scope_exit([&] {
  16640. svr.stop();
  16641. t.join();
  16642. ASSERT_FALSE(svr.is_running());
  16643. });
  16644. svr.wait_until_ready();
  16645. const std::string req = "GET / HTTP/1.1\r\n"
  16646. "Transfer-Encoding: chunked\r\n"
  16647. "Trailer: X-Hello\r\n"
  16648. "Trailer: X-World, Content-Length\r\n"
  16649. "\r\n"
  16650. "0\r\n"
  16651. "X-Hello: hello\r\n"
  16652. "X-World: world\r\n"
  16653. "Content-Length: 10\r\n"
  16654. "\r\n";
  16655. std::string res;
  16656. ASSERT_TRUE(send_request(1, req, &res, port));
  16657. EXPECT_EQ("HTTP/1.1 200 OK", res.substr(0, 15));
  16658. // Accepted: both field lines contribute to the declared set
  16659. EXPECT_EQ(2U, observed_trailer_count);
  16660. EXPECT_EQ(observed_hello, "hello");
  16661. EXPECT_EQ(observed_world, "world");
  16662. // Denied: a prohibited name stays prohibited on a later field line
  16663. EXPECT_FALSE(observed_content_length);
  16664. }
  16665. // Undeclared trailer fields must count toward the trailer limit too. Otherwise
  16666. // a peer can keep the trailer-parsing loop running indefinitely by sending an
  16667. // unbounded run of fields that are never declared, because the counter would
  16668. // only advance for declared fields.
  16669. TEST(HeaderSmugglingTest, UndeclaredTrailerFieldsCountTowardLimit) {
  16670. Server svr;
  16671. bool handler_called = false;
  16672. svr.Get("/", [&](const Request & /*req*/, Response &res) {
  16673. handler_called = true;
  16674. res.set_content("ok", "text/plain");
  16675. });
  16676. auto port = svr.bind_to_any_port(HOST);
  16677. thread t = thread([&]() { svr.listen_after_bind(); });
  16678. auto se = detail::scope_exit([&] {
  16679. svr.stop();
  16680. t.join();
  16681. ASSERT_FALSE(svr.is_running());
  16682. });
  16683. svr.wait_until_ready();
  16684. // Declare nothing, then send far more undeclared trailer fields than the
  16685. // header-count limit. Parsing must stop and reject the request rather than
  16686. // read every line.
  16687. std::string req = "GET / HTTP/1.1\r\n"
  16688. "Transfer-Encoding: chunked\r\n"
  16689. "\r\n"
  16690. "0\r\n";
  16691. for (int i = 0; i < CPPHTTPLIB_HEADER_MAX_COUNT + 10; i++) {
  16692. req += "X-Undeclared-" + std::to_string(i) + ": v\r\n";
  16693. }
  16694. req += "\r\n";
  16695. std::string res;
  16696. ASSERT_TRUE(send_request(1, req, &res, port));
  16697. // The request is rejected before the handler runs.
  16698. EXPECT_FALSE(handler_called);
  16699. EXPECT_EQ("HTTP/1.1 400 Bad Request", res.substr(0, res.find("\r\n")));
  16700. }
  16701. // The set of declared trailer names is capped so a peer cannot grow it without
  16702. // bound (an unkeyed hash set would otherwise be a hash-flooding target). A name
  16703. // declared past the cap is not honored, even if the field is actually sent.
  16704. TEST(HeaderSmugglingTest, DeclaredTrailerNamesAreCappedAtHeaderMaxCount) {
  16705. Server svr;
  16706. // One name inside the cap and one past it, so the test tracks the cap rather
  16707. // than a fixed count.
  16708. constexpr int declared_count = CPPHTTPLIB_HEADER_MAX_COUNT + 50;
  16709. const std::string within_cap_name = "X-T-0";
  16710. const std::string past_cap_name = "X-T-" + std::to_string(declared_count - 1);
  16711. bool observed_within_cap = false;
  16712. bool observed_past_cap = false;
  16713. svr.Get("/", [&](const Request &req, Response &res) {
  16714. observed_within_cap = req.has_trailer(within_cap_name);
  16715. observed_past_cap = req.has_trailer(past_cap_name);
  16716. res.set_content("ok", "text/plain");
  16717. });
  16718. auto port = svr.bind_to_any_port(HOST);
  16719. thread t = thread([&]() { svr.listen_after_bind(); });
  16720. auto se = detail::scope_exit([&] {
  16721. svr.stop();
  16722. t.join();
  16723. ASSERT_FALSE(svr.is_running());
  16724. });
  16725. svr.wait_until_ready();
  16726. // Declare more trailer names than the cap in a single Trailer field, then
  16727. // actually send the first (within the cap) and the last (past it).
  16728. std::string trailer_decl = "Trailer: ";
  16729. for (int i = 0; i < declared_count; i++) {
  16730. if (i != 0) { trailer_decl += ", "; }
  16731. trailer_decl += "X-T-" + std::to_string(i);
  16732. }
  16733. trailer_decl += "\r\n";
  16734. const std::string req = "GET / HTTP/1.1\r\n"
  16735. "Transfer-Encoding: chunked\r\n" +
  16736. trailer_decl +
  16737. "\r\n"
  16738. "0\r\n" +
  16739. within_cap_name + ": a\r\n" + past_cap_name +
  16740. ": b\r\n"
  16741. "\r\n";
  16742. std::string res;
  16743. ASSERT_TRUE(send_request(1, req, &res, port));
  16744. EXPECT_EQ("HTTP/1.1 200 OK", res.substr(0, res.find("\r\n")));
  16745. // A name within the cap is honored; one declared past the cap is dropped.
  16746. EXPECT_TRUE(observed_within_cap);
  16747. EXPECT_FALSE(observed_past_cap);
  16748. }
  16749. // A direct client that is not listed in trusted_proxies must not be able to
  16750. // spoof req.remote_addr by sending an arbitrary X-Forwarded-For header. Only
  16751. // the peer address on the actual TCP connection determines whether the
  16752. // header is honored.
  16753. TEST(ForwardedHeadersTest, UntrustedDirectClientCannotSpoofXFF) {
  16754. Server svr;
  16755. // Deliberately does NOT include the loopback address the test client
  16756. // actually connects from, so the direct connection is not a trusted proxy.
  16757. svr.set_trusted_proxies({"203.0.113.66"});
  16758. std::string observed_remote_addr;
  16759. svr.Get("/ip", [&](const Request &req, Response &res) {
  16760. observed_remote_addr = req.remote_addr;
  16761. res.set_content("ok", "text/plain");
  16762. });
  16763. thread t = thread([&]() { svr.listen(HOST, PORT); });
  16764. auto se = detail::scope_exit([&] {
  16765. svr.stop();
  16766. t.join();
  16767. ASSERT_FALSE(svr.is_running());
  16768. });
  16769. svr.wait_until_ready();
  16770. Client cli(HOST, PORT);
  16771. auto res = cli.Get("/ip", Headers{{"X-Forwarded-For", "9.9.9.9"}});
  16772. ASSERT_TRUE(res) << "Error: " << to_string(res.error());
  16773. EXPECT_EQ(StatusCode::OK_200, res->status);
  16774. // The connecting peer is not a trusted proxy, so the spoofed header must be
  16775. // ignored entirely and the real connection-level address retained.
  16776. EXPECT_TRUE(observed_remote_addr == "::1" ||
  16777. observed_remote_addr == "127.0.0.1");
  16778. }
  16779. TEST(ForwardedHeadersTest, NoProxiesSetting) {
  16780. Server svr;
  16781. std::string observed_remote_addr;
  16782. std::string observed_xff;
  16783. svr.Get("/ip", [&](const Request &req, Response &res) {
  16784. observed_remote_addr = req.remote_addr;
  16785. observed_xff = req.get_header_value("X-Forwarded-For");
  16786. res.set_content("ok", "text/plain");
  16787. });
  16788. thread t = thread([&]() { svr.listen(HOST, PORT); });
  16789. auto se = detail::scope_exit([&] {
  16790. svr.stop();
  16791. t.join();
  16792. ASSERT_FALSE(svr.is_running());
  16793. });
  16794. svr.wait_until_ready();
  16795. Client cli(HOST, PORT);
  16796. auto res = cli.Get("/ip", Headers{{"X-Forwarded-For", "203.0.113.66"}});
  16797. ASSERT_TRUE(res) << "Error: " << to_string(res.error());
  16798. EXPECT_EQ(StatusCode::OK_200, res->status);
  16799. EXPECT_EQ(observed_xff, "203.0.113.66");
  16800. EXPECT_TRUE(observed_remote_addr == "::1" ||
  16801. observed_remote_addr == "127.0.0.1");
  16802. }
  16803. TEST(ForwardedHeadersTest, NoForwardedHeaders) {
  16804. Server svr;
  16805. svr.set_trusted_proxies({"203.0.113.66"});
  16806. std::string observed_remote_addr;
  16807. std::string observed_xff;
  16808. svr.Get("/ip", [&](const Request &req, Response &res) {
  16809. observed_remote_addr = req.remote_addr;
  16810. observed_xff = req.get_header_value("X-Forwarded-For");
  16811. res.set_content("ok", "text/plain");
  16812. });
  16813. thread t = thread([&]() { svr.listen(HOST, PORT); });
  16814. auto se = detail::scope_exit([&] {
  16815. svr.stop();
  16816. t.join();
  16817. ASSERT_FALSE(svr.is_running());
  16818. });
  16819. svr.wait_until_ready();
  16820. Client cli(HOST, PORT);
  16821. auto res = cli.Get("/ip");
  16822. ASSERT_TRUE(res) << "Error: " << to_string(res.error());
  16823. EXPECT_EQ(StatusCode::OK_200, res->status);
  16824. EXPECT_EQ(observed_xff, "");
  16825. EXPECT_TRUE(observed_remote_addr == "::1" ||
  16826. observed_remote_addr == "127.0.0.1");
  16827. }
  16828. TEST(ForwardedHeadersTest, SingleTrustedProxy_UsesIPBeforeTrusted) {
  16829. Server svr;
  16830. // Include the loopback address the test client actually connects from, so
  16831. // the direct connection itself is recognized as the trusted proxy hop.
  16832. svr.set_trusted_proxies({"203.0.113.66", "::1", "127.0.0.1"});
  16833. std::string observed_remote_addr;
  16834. std::string observed_xff;
  16835. svr.Get("/ip", [&](const Request &req, Response &res) {
  16836. observed_remote_addr = req.remote_addr;
  16837. observed_xff = req.get_header_value("X-Forwarded-For");
  16838. res.set_content("ok", "text/plain");
  16839. });
  16840. thread t = thread([&]() { svr.listen(HOST, PORT); });
  16841. auto se = detail::scope_exit([&] {
  16842. svr.stop();
  16843. t.join();
  16844. ASSERT_FALSE(svr.is_running());
  16845. });
  16846. svr.wait_until_ready();
  16847. Client cli(HOST, PORT);
  16848. auto res = cli.Get(
  16849. "/ip", Headers{{"X-Forwarded-For", "198.51.100.23, 203.0.113.66"}});
  16850. ASSERT_TRUE(res) << "Error: " << to_string(res.error());
  16851. EXPECT_EQ(StatusCode::OK_200, res->status);
  16852. EXPECT_EQ(observed_xff, "198.51.100.23, 203.0.113.66");
  16853. EXPECT_EQ(observed_remote_addr, "198.51.100.23");
  16854. }
  16855. TEST(ForwardedHeadersTest, MultipleTrustedProxies_UsesClientIP) {
  16856. Server svr;
  16857. svr.set_trusted_proxies({"203.0.113.66", "192.0.2.45", "::1", "127.0.0.1"});
  16858. std::string observed_remote_addr;
  16859. std::string observed_xff;
  16860. svr.Get("/ip", [&](const Request &req, Response &res) {
  16861. observed_remote_addr = req.remote_addr;
  16862. observed_xff = req.get_header_value("X-Forwarded-For");
  16863. res.set_content("ok", "text/plain");
  16864. });
  16865. thread t = thread([&]() { svr.listen(HOST, PORT); });
  16866. auto se = detail::scope_exit([&] {
  16867. svr.stop();
  16868. t.join();
  16869. ASSERT_FALSE(svr.is_running());
  16870. });
  16871. svr.wait_until_ready();
  16872. Client cli(HOST, PORT);
  16873. auto res = cli.Get(
  16874. "/ip",
  16875. Headers{{"X-Forwarded-For", "198.51.100.23, 203.0.113.66, 192.0.2.45"}});
  16876. ASSERT_TRUE(res) << "Error: " << to_string(res.error());
  16877. EXPECT_EQ(StatusCode::OK_200, res->status);
  16878. EXPECT_EQ(observed_xff, "198.51.100.23, 203.0.113.66, 192.0.2.45");
  16879. EXPECT_EQ(observed_remote_addr, "198.51.100.23");
  16880. }
  16881. TEST(ForwardedHeadersTest, TrustedProxyNotInHeader_UsesRightmostIP) {
  16882. Server svr;
  16883. svr.set_trusted_proxies({"192.0.2.45", "::1", "127.0.0.1"});
  16884. std::string observed_remote_addr;
  16885. std::string observed_xff;
  16886. svr.Get("/ip", [&](const Request &req, Response &res) {
  16887. observed_remote_addr = req.remote_addr;
  16888. observed_xff = req.get_header_value("X-Forwarded-For");
  16889. res.set_content("ok", "text/plain");
  16890. });
  16891. thread t = thread([&]() { svr.listen(HOST, PORT); });
  16892. auto se = detail::scope_exit([&] {
  16893. svr.stop();
  16894. t.join();
  16895. ASSERT_FALSE(svr.is_running());
  16896. });
  16897. svr.wait_until_ready();
  16898. Client cli(HOST, PORT);
  16899. auto res = cli.Get(
  16900. "/ip", Headers{{"X-Forwarded-For", "198.51.100.23, 198.51.100.24"}});
  16901. ASSERT_TRUE(res) << "Error: " << to_string(res.error());
  16902. EXPECT_EQ(StatusCode::OK_200, res->status);
  16903. // No listed hop is a trusted proxy, so the rightmost entry (the one written
  16904. // by the closest hop) is used. The leftmost entry is fully client-controlled
  16905. // and must not be selected.
  16906. EXPECT_EQ(observed_xff, "198.51.100.23, 198.51.100.24");
  16907. EXPECT_EQ(observed_remote_addr, "198.51.100.24");
  16908. }
  16909. TEST(ForwardedHeadersTest, SpoofedIPBeforeTrustedProxyIsIgnored) {
  16910. Server svr;
  16911. svr.set_trusted_proxies({"10.0.0.1", "::1", "127.0.0.1"});
  16912. std::string observed_remote_addr;
  16913. svr.Get("/ip", [&](const Request &req, Response &res) {
  16914. observed_remote_addr = req.remote_addr;
  16915. res.set_content("ok", "text/plain");
  16916. });
  16917. thread t = thread([&]() { svr.listen(HOST, PORT); });
  16918. auto se = detail::scope_exit([&] {
  16919. svr.stop();
  16920. t.join();
  16921. ASSERT_FALSE(svr.is_running());
  16922. });
  16923. svr.wait_until_ready();
  16924. // The trusted proxy appends the address it saw (5.6.7.8). The client prepends
  16925. // a forged address and the trusted proxy's own address; the forged value must
  16926. // not win over the address the trusted proxy actually recorded.
  16927. Client cli(HOST, PORT);
  16928. auto res = cli.Get(
  16929. "/ip", Headers{{"X-Forwarded-For", "1.2.3.4, 10.0.0.1, 5.6.7.8"}});
  16930. ASSERT_TRUE(res) << "Error: " << to_string(res.error());
  16931. EXPECT_EQ(StatusCode::OK_200, res->status);
  16932. EXPECT_EQ(observed_remote_addr, "5.6.7.8");
  16933. }
  16934. TEST(ForwardedHeadersTest, LastHopTrusted_SelectsImmediateLeftIP) {
  16935. Server svr;
  16936. svr.set_trusted_proxies({"192.0.2.45", "::1", "127.0.0.1"});
  16937. std::string observed_remote_addr;
  16938. std::string observed_xff;
  16939. svr.Get("/ip", [&](const Request &req, Response &res) {
  16940. observed_remote_addr = req.remote_addr;
  16941. observed_xff = req.get_header_value("X-Forwarded-For");
  16942. res.set_content("ok", "text/plain");
  16943. });
  16944. thread t = thread([&]() { svr.listen(HOST, PORT); });
  16945. auto se = detail::scope_exit([&] {
  16946. svr.stop();
  16947. t.join();
  16948. ASSERT_FALSE(svr.is_running());
  16949. });
  16950. svr.wait_until_ready();
  16951. Client cli(HOST, PORT);
  16952. auto res = cli.Get(
  16953. "/ip",
  16954. Headers{{"X-Forwarded-For", "198.51.100.23, 203.0.113.66, 192.0.2.45"}});
  16955. ASSERT_TRUE(res) << "Error: " << to_string(res.error());
  16956. EXPECT_EQ(StatusCode::OK_200, res->status);
  16957. EXPECT_EQ(observed_xff, "198.51.100.23, 203.0.113.66, 192.0.2.45");
  16958. EXPECT_EQ(observed_remote_addr, "203.0.113.66");
  16959. }
  16960. TEST(ForwardedHeadersTest, HandlesWhitespaceAroundIPs) {
  16961. Server svr;
  16962. svr.set_trusted_proxies({"192.0.2.45", "::1", "127.0.0.1"});
  16963. std::string observed_remote_addr;
  16964. std::string observed_xff;
  16965. svr.Get("/ip", [&](const Request &req, Response &res) {
  16966. observed_remote_addr = req.remote_addr;
  16967. observed_xff = req.get_header_value("X-Forwarded-For");
  16968. res.set_content("ok", "text/plain");
  16969. });
  16970. thread t = thread([&]() { svr.listen(HOST, PORT); });
  16971. auto se = detail::scope_exit([&] {
  16972. svr.stop();
  16973. t.join();
  16974. ASSERT_FALSE(svr.is_running());
  16975. });
  16976. svr.wait_until_ready();
  16977. std::string raw_req =
  16978. "GET /ip HTTP/1.1\r\n"
  16979. "Host: localhost\r\n"
  16980. "X-Forwarded-For: 198.51.100.23 , 203.0.113.66 , 192.0.2.45 \r\n"
  16981. "Connection: close\r\n"
  16982. "\r\n";
  16983. std::string out;
  16984. ASSERT_TRUE(send_request(5, raw_req, &out));
  16985. EXPECT_EQ("HTTP/1.1 200 OK", out.substr(0, 15));
  16986. // Header parser trims surrounding whitespace of the header value
  16987. EXPECT_EQ(observed_xff, "198.51.100.23 , 203.0.113.66 , 192.0.2.45");
  16988. EXPECT_EQ(observed_remote_addr, "203.0.113.66");
  16989. }
  16990. // RFC 9110 Section 5.2 and 5.3: repeated field lines carry the same meaning as
  16991. // one comma-joined value, in the order received. Proxies such as HAProxy append
  16992. // their own X-Forwarded-For as a separate field line rather than extending the
  16993. // one the client sent, so every occurrence has to be taken into account.
  16994. // Reading only the first one hands back the address the client chose.
  16995. TEST(ForwardedHeadersTest, DuplicateFieldLines_JoinsAllOccurrences) {
  16996. Server svr;
  16997. svr.set_trusted_proxies({"192.0.2.45", "::1", "127.0.0.1"});
  16998. std::string observed_remote_addr;
  16999. size_t observed_xff_count = 0;
  17000. svr.Get("/ip", [&](const Request &req, Response &res) {
  17001. observed_remote_addr = req.remote_addr;
  17002. observed_xff_count = req.get_header_value_count("X-Forwarded-For");
  17003. res.set_content("ok", "text/plain");
  17004. });
  17005. auto port = svr.bind_to_any_port(HOST);
  17006. thread t = thread([&]() { svr.listen_after_bind(); });
  17007. auto se = detail::scope_exit([&] {
  17008. svr.stop();
  17009. t.join();
  17010. ASSERT_FALSE(svr.is_running());
  17011. });
  17012. svr.wait_until_ready();
  17013. // The client supplies the first field line; the trusted proxy appends the
  17014. // address it observed as a second one.
  17015. std::string raw_req = "GET /ip HTTP/1.1\r\n"
  17016. "Host: localhost\r\n"
  17017. "X-Forwarded-For: 1.2.3.4\r\n"
  17018. "X-Forwarded-For: 198.51.100.23, 192.0.2.45\r\n"
  17019. "Connection: close\r\n"
  17020. "\r\n";
  17021. std::string out;
  17022. ASSERT_TRUE(send_request(5, raw_req, &out, port));
  17023. EXPECT_EQ("HTTP/1.1 200 OK", out.substr(0, 15));
  17024. EXPECT_EQ(observed_xff_count, 2U);
  17025. EXPECT_EQ(observed_remote_addr, "198.51.100.23");
  17026. // The same chain spread over one field line per hop derives the same client
  17027. // address, i.e. the split and the comma-joined representations agree.
  17028. std::string per_hop_req = "GET /ip HTTP/1.1\r\n"
  17029. "Host: localhost\r\n"
  17030. "X-Forwarded-For: 1.2.3.4\r\n"
  17031. "X-Forwarded-For: 198.51.100.23\r\n"
  17032. "X-Forwarded-For: 192.0.2.45\r\n"
  17033. "Connection: close\r\n"
  17034. "\r\n";
  17035. out.clear();
  17036. ASSERT_TRUE(send_request(5, per_hop_req, &out, port));
  17037. EXPECT_EQ("HTTP/1.1 200 OK", out.substr(0, 15));
  17038. EXPECT_EQ(observed_xff_count, 3U);
  17039. EXPECT_EQ(observed_remote_addr, "198.51.100.23");
  17040. }
  17041. // An X-Forwarded-For header whose value parses to zero IP segments must not
  17042. // crash the server (it used to call front() on an empty vector inside
  17043. // get_client_ip). The connection-level remote address must be retained instead.
  17044. static void run_malformed_xff_test(const std::string &xff_value) {
  17045. Server svr;
  17046. svr.set_trusted_proxies({"192.0.2.45"});
  17047. std::string observed_remote_addr;
  17048. svr.Get("/ip", [&](const Request &req, Response &res) {
  17049. observed_remote_addr = req.remote_addr;
  17050. res.set_content("ok", "text/plain");
  17051. });
  17052. int port = 0;
  17053. thread t = thread([&]() {
  17054. port = svr.bind_to_any_port(HOST);
  17055. svr.listen_after_bind();
  17056. });
  17057. auto se = detail::scope_exit([&] {
  17058. svr.stop();
  17059. t.join();
  17060. ASSERT_FALSE(svr.is_running());
  17061. });
  17062. svr.wait_until_ready();
  17063. Client cli(HOST, port);
  17064. auto res = cli.Get("/ip", Headers{{"X-Forwarded-For", xff_value}});
  17065. ASSERT_TRUE(res) << "Error: " << to_string(res.error());
  17066. EXPECT_EQ(StatusCode::OK_200, res->status);
  17067. EXPECT_TRUE(observed_remote_addr == "::1" ||
  17068. observed_remote_addr == "127.0.0.1");
  17069. }
  17070. TEST(ForwardedHeadersTest, EmptyXForwardedFor_DoesNotCrash) {
  17071. run_malformed_xff_test("");
  17072. }
  17073. TEST(ForwardedHeadersTest, CommaOnlyXForwardedFor_DoesNotCrash) {
  17074. run_malformed_xff_test(",");
  17075. }
  17076. TEST(ForwardedHeadersTest, MultipleCommasXForwardedFor_DoesNotCrash) {
  17077. run_malformed_xff_test(", , ,");
  17078. }
  17079. // The same rule applies to Accept: a request whose acceptable types are spread
  17080. // over several field lines must be negotiated against all of them.
  17081. // RFC 9110 Section 7.6.1: Connection carries a comma-separated list of
  17082. // case-insensitive connection options. Comparing the whole field value against
  17083. // one option misses a client that sends several of them, and misses every
  17084. // casing but the one written in the comparison.
  17085. //
  17086. // Sends req, reads the response, then reuses the same socket for a second
  17087. // request to find out whether the server kept the connection.
  17088. static void probe_connection_reuse(int port, const std::string &req,
  17089. bool *announced_close, bool *reusable) {
  17090. auto error = Error::Success;
  17091. auto sock = detail::create_client_socket(
  17092. HOST, "", port, AF_UNSPEC, false, false, nullptr,
  17093. /*connection_timeout_sec=*/5, 0,
  17094. /*read_timeout_sec=*/1, 0,
  17095. /*write_timeout_sec=*/5, 0, std::string(), error);
  17096. ASSERT_NE(sock, INVALID_SOCKET);
  17097. auto se = detail::scope_exit([&] { detail::close_socket(sock); });
  17098. const std::string second = "GET /keepalive HTTP/1.1\r\n"
  17099. "Host: localhost\r\n"
  17100. "Connection: close\r\n"
  17101. "\r\n";
  17102. std::string first_response;
  17103. std::string second_response;
  17104. detail::process_client_socket(
  17105. sock, 1, 0, 5, 0, 0, std::chrono::steady_clock::time_point::min(),
  17106. [&](Stream &strm) {
  17107. if (strm.write(req.data(), req.size()) !=
  17108. static_cast<ssize_t>(req.size())) {
  17109. return false;
  17110. }
  17111. char buf[512];
  17112. detail::stream_line_reader reader(strm, buf, sizeof(buf));
  17113. // Headers plus the two-byte body of the handler below
  17114. while (reader.getline()) {
  17115. first_response += reader.ptr();
  17116. if (first_response.find("ok") != std::string::npos) { break; }
  17117. }
  17118. if (strm.write(second.data(), second.size()) !=
  17119. static_cast<ssize_t>(second.size())) {
  17120. return true;
  17121. }
  17122. detail::stream_line_reader reader2(strm, buf, sizeof(buf));
  17123. while (reader2.getline()) {
  17124. second_response += reader2.ptr();
  17125. if (second_response.find("ok") != std::string::npos) { break; }
  17126. }
  17127. return true;
  17128. });
  17129. *announced_close =
  17130. first_response.find("Connection: close") != std::string::npos;
  17131. *reusable = second_response.find("HTTP/1.1 200") != std::string::npos;
  17132. }
  17133. class ConnectionTokenTest : public ::testing::Test {
  17134. protected:
  17135. void SetUp() override {
  17136. svr_.Get("/keepalive", [](const Request &, Response &res) {
  17137. res.set_content("ok", "text/plain");
  17138. });
  17139. port_ = svr_.bind_to_any_port(HOST);
  17140. thread_ = thread([&]() { svr_.listen_after_bind(); });
  17141. svr_.wait_until_ready();
  17142. }
  17143. void TearDown() override {
  17144. svr_.stop();
  17145. if (thread_.joinable()) { thread_.join(); }
  17146. }
  17147. Server svr_;
  17148. int port_ = 0;
  17149. thread thread_;
  17150. };
  17151. // "close" alongside another option still closes the connection, and the
  17152. // response says so rather than leaving the peer to discover it.
  17153. TEST_F(ConnectionTokenTest, CloseAmongSeveralOptionsIsHonored) {
  17154. bool announced_close = false;
  17155. bool reusable = true;
  17156. probe_connection_reuse(port_,
  17157. "GET /keepalive HTTP/1.1\r\n"
  17158. "Host: localhost\r\n"
  17159. "Connection: keep-alive, close\r\n"
  17160. "\r\n",
  17161. &announced_close, &reusable);
  17162. EXPECT_TRUE(announced_close);
  17163. EXPECT_FALSE(reusable);
  17164. }
  17165. // "close" split over two field lines is the same list, so it is honored too.
  17166. TEST_F(ConnectionTokenTest, CloseOnALaterFieldLineIsHonored) {
  17167. bool announced_close = false;
  17168. bool reusable = true;
  17169. probe_connection_reuse(port_,
  17170. "GET /keepalive HTTP/1.1\r\n"
  17171. "Host: localhost\r\n"
  17172. "Connection: keep-alive\r\n"
  17173. "Connection: close\r\n"
  17174. "\r\n",
  17175. &announced_close, &reusable);
  17176. EXPECT_TRUE(announced_close);
  17177. EXPECT_FALSE(reusable);
  17178. }
  17179. // Connection options are case-insensitive, so an HTTP/1.0 client asking for
  17180. // keep-alive in the spelling everyone actually sends keeps its connection.
  17181. TEST_F(ConnectionTokenTest, Http10KeepAliveIsCaseInsensitive) {
  17182. bool announced_close = false;
  17183. bool reusable = false;
  17184. probe_connection_reuse(port_,
  17185. "GET /keepalive HTTP/1.0\r\n"
  17186. "Host: localhost\r\n"
  17187. "Connection: keep-alive\r\n"
  17188. "\r\n",
  17189. &announced_close, &reusable);
  17190. EXPECT_FALSE(announced_close);
  17191. EXPECT_TRUE(reusable);
  17192. }
  17193. // A token the value merely contains is not the token itself.
  17194. TEST_F(ConnectionTokenTest, SubstringOfAnOptionIsNotTheOption) {
  17195. bool announced_close = false;
  17196. bool reusable = false;
  17197. probe_connection_reuse(port_,
  17198. "GET /keepalive HTTP/1.1\r\n"
  17199. "Host: localhost\r\n"
  17200. "Connection: notclose\r\n"
  17201. "\r\n",
  17202. &announced_close, &reusable);
  17203. EXPECT_FALSE(announced_close);
  17204. EXPECT_TRUE(reusable);
  17205. }
  17206. TEST(RepeatedFieldLinesTest, AcceptCombinesEveryFieldLine) {
  17207. Server svr;
  17208. std::vector<std::string> observed_types;
  17209. svr.Get("/", [&](const Request &req, Response &res) {
  17210. observed_types = req.accept_content_types;
  17211. res.set_content("ok", "text/plain");
  17212. });
  17213. auto port = svr.bind_to_any_port(HOST);
  17214. thread t = thread([&]() { svr.listen_after_bind(); });
  17215. auto se = detail::scope_exit([&] {
  17216. svr.stop();
  17217. t.join();
  17218. ASSERT_FALSE(svr.is_running());
  17219. });
  17220. svr.wait_until_ready();
  17221. Client cli(HOST, port);
  17222. Headers headers;
  17223. headers.emplace("Accept", "text/plain;q=0.5");
  17224. headers.emplace("Accept", "application/json");
  17225. auto res = cli.Get("/", headers);
  17226. ASSERT_TRUE(res) << "Error: " << to_string(res.error());
  17227. EXPECT_EQ(StatusCode::OK_200, res->status);
  17228. // Sorted by q-value, so the second field line's type comes first
  17229. ASSERT_EQ(2U, observed_types.size());
  17230. EXPECT_EQ("application/json", observed_types[0]);
  17231. EXPECT_EQ("text/plain", observed_types[1]);
  17232. }
  17233. // RFC 9110 Section 5.6.1.2: empty list elements are parsed and ignored, so an
  17234. // empty field line must not contribute a bare comma to the combined value.
  17235. TEST(RepeatedFieldLinesTest, EmptyFieldLineDoesNotInjectComma) {
  17236. Server svr;
  17237. std::vector<std::string> observed_types;
  17238. svr.Get("/", [&](const Request &req, Response &res) {
  17239. observed_types = req.accept_content_types;
  17240. res.set_content("ok", "text/plain");
  17241. });
  17242. auto port = svr.bind_to_any_port(HOST);
  17243. thread t = thread([&]() { svr.listen_after_bind(); });
  17244. auto se = detail::scope_exit([&] {
  17245. svr.stop();
  17246. t.join();
  17247. ASSERT_FALSE(svr.is_running());
  17248. });
  17249. svr.wait_until_ready();
  17250. // Empty first field line, then a real one
  17251. std::string raw_req = "GET / HTTP/1.1\r\n"
  17252. "Host: localhost\r\n"
  17253. "Accept:\r\n"
  17254. "Accept: application/json\r\n"
  17255. "Connection: close\r\n"
  17256. "\r\n";
  17257. std::string out;
  17258. ASSERT_TRUE(send_request(5, raw_req, &out, port));
  17259. EXPECT_EQ("HTTP/1.1 200 OK", out.substr(0, 15));
  17260. ASSERT_EQ(1U, observed_types.size());
  17261. EXPECT_EQ("application/json", observed_types[0]);
  17262. }
  17263. // The skip in get_combined_header_value() is what keeps an empty field line
  17264. // from contributing a bare comma. Only a trailing empty field line exercises
  17265. // it: a leading one is already covered by the "combined is still empty" check,
  17266. // and parse_accept_header() now ignores the empty element either way, so the
  17267. // request-level test above can no longer tell the two apart.
  17268. TEST(RepeatedFieldLinesTest, EmptyFieldLineIsNotCombined) {
  17269. Headers headers;
  17270. headers.emplace("Accept", "text/html");
  17271. headers.emplace("Accept", "");
  17272. EXPECT_EQ("text/html", detail::get_combined_header_value(headers, "Accept"));
  17273. headers.clear();
  17274. headers.emplace("Accept", "");
  17275. headers.emplace("Accept", "application/json");
  17276. EXPECT_EQ("application/json",
  17277. detail::get_combined_header_value(headers, "Accept"));
  17278. }
  17279. #ifdef CPPHTTPLIB_ZLIB_SUPPORT
  17280. // An encoding offered on a later Accept-Encoding field line is still offered.
  17281. TEST(RepeatedFieldLinesTest, AcceptEncodingCombinesEveryFieldLine) {
  17282. Server svr;
  17283. svr.Get("/", [](const Request & /*req*/, Response &res) {
  17284. res.set_content(std::string(1024, 'x'), "text/plain");
  17285. });
  17286. auto port = svr.bind_to_any_port(HOST);
  17287. thread t = thread([&]() { svr.listen_after_bind(); });
  17288. auto se = detail::scope_exit([&] {
  17289. svr.stop();
  17290. t.join();
  17291. ASSERT_FALSE(svr.is_running());
  17292. });
  17293. svr.wait_until_ready();
  17294. Client cli(HOST, port);
  17295. cli.set_decompress(false);
  17296. Headers headers;
  17297. headers.emplace("Accept-Encoding", "identity");
  17298. headers.emplace("Accept-Encoding", "gzip");
  17299. auto res = cli.Get("/", headers);
  17300. ASSERT_TRUE(res) << "Error: " << to_string(res.error());
  17301. EXPECT_EQ(StatusCode::OK_200, res->status);
  17302. EXPECT_EQ("gzip", res->get_header_value("Content-Encoding"));
  17303. }
  17304. #endif
  17305. #ifndef _WIN32
  17306. TEST(ServerRequestParsingTest, RequestWithoutContentLengthOrTransferEncoding) {
  17307. Server svr;
  17308. svr.Post("/post", [&](const Request &req, Response &res) {
  17309. res.set_content(req.body, "text/plain");
  17310. });
  17311. svr.Put("/put", [&](const Request &req, Response &res) {
  17312. res.set_content(req.body, "text/plain");
  17313. });
  17314. svr.Patch("/patch", [&](const Request &req, Response &res) {
  17315. res.set_content(req.body, "text/plain");
  17316. });
  17317. svr.Delete("/delete", [&](const Request &req, Response &res) {
  17318. res.set_content(req.body, "text/plain");
  17319. });
  17320. thread t = thread([&]() { svr.listen(HOST, PORT); });
  17321. auto se = detail::scope_exit([&] {
  17322. svr.stop();
  17323. t.join();
  17324. ASSERT_FALSE(svr.is_running());
  17325. });
  17326. svr.wait_until_ready();
  17327. std::string resp;
  17328. // POST without Content-Length
  17329. ASSERT_TRUE(send_request(5,
  17330. "POST /post HTTP/1.1\r\n"
  17331. "Host: localhost\r\n"
  17332. "Connection: close\r\n"
  17333. "\r\n",
  17334. &resp));
  17335. EXPECT_TRUE(resp.find("HTTP/1.1 200 OK") == 0);
  17336. // PUT without Content-Length
  17337. resp.clear();
  17338. ASSERT_TRUE(send_request(5,
  17339. "PUT /put HTTP/1.1\r\n"
  17340. "Host: localhost\r\n"
  17341. "Connection: close\r\n"
  17342. "\r\n",
  17343. &resp));
  17344. EXPECT_TRUE(resp.find("HTTP/1.1 200 OK") == 0);
  17345. // PATCH without Content-Length
  17346. resp.clear();
  17347. ASSERT_TRUE(send_request(5,
  17348. "PATCH /patch HTTP/1.1\r\n"
  17349. "Host: localhost\r\n"
  17350. "Connection: close\r\n"
  17351. "\r\n",
  17352. &resp));
  17353. EXPECT_TRUE(resp.find("HTTP/1.1 200 OK") == 0);
  17354. // DELETE without Content-Length
  17355. resp.clear();
  17356. ASSERT_TRUE(send_request(5,
  17357. "DELETE /delete HTTP/1.1\r\n"
  17358. "Host: localhost\r\n"
  17359. "Connection: close\r\n"
  17360. "\r\n",
  17361. &resp));
  17362. EXPECT_TRUE(resp.find("HTTP/1.1 200 OK") == 0);
  17363. }
  17364. #endif
  17365. //==============================================================================
  17366. // open_stream() Tests
  17367. //==============================================================================
  17368. inline std::string read_all(ClientImpl::StreamHandle &handle) {
  17369. std::string result;
  17370. char buf[8192];
  17371. ssize_t n;
  17372. while ((n = handle.read(buf, sizeof(buf))) > 0) {
  17373. result.append(buf, static_cast<size_t>(n));
  17374. }
  17375. return result;
  17376. }
  17377. // Mock stream for unit tests
  17378. class MockStream : public Stream {
  17379. public:
  17380. std::string data;
  17381. size_t pos = 0;
  17382. ssize_t error_after = -1; // -1 = no error
  17383. explicit MockStream(const std::string &d, ssize_t err = -1)
  17384. : data(d), error_after(err) {}
  17385. bool is_readable() const override { return true; }
  17386. bool wait_readable() const override { return true; }
  17387. bool wait_writable() const override { return true; }
  17388. ssize_t read(char *ptr, size_t size) override {
  17389. if (error_after >= 0 && pos >= static_cast<size_t>(error_after)) return -1;
  17390. if (pos >= data.size()) return 0;
  17391. size_t limit =
  17392. error_after >= 0 ? static_cast<size_t>(error_after) : data.size();
  17393. size_t to_read = std::min(size, std::min(data.size() - pos, limit - pos));
  17394. std::memcpy(ptr, data.data() + pos, to_read);
  17395. pos += to_read;
  17396. return static_cast<ssize_t>(to_read);
  17397. }
  17398. ssize_t write(const char *, size_t) override { return -1; }
  17399. void get_remote_ip_and_port(std::string &ip, int &port) const override {
  17400. ip = "127.0.0.1";
  17401. port = 0;
  17402. }
  17403. void get_local_ip_and_port(std::string &ip, int &port) const override {
  17404. ip = "127.0.0.1";
  17405. port = 0;
  17406. }
  17407. socket_t socket() const override { return INVALID_SOCKET; }
  17408. time_t duration() const override { return 0; }
  17409. };
  17410. TEST(StreamHandleTest, Basic) {
  17411. ClientImpl::StreamHandle handle;
  17412. EXPECT_FALSE(handle.is_valid());
  17413. handle.response = detail::make_unique<Response>();
  17414. handle.error = Error::Connection;
  17415. EXPECT_FALSE(handle.is_valid());
  17416. handle.error = Error::Success;
  17417. EXPECT_TRUE(handle.is_valid());
  17418. }
  17419. TEST(BodyReaderTest, Basic) {
  17420. MockStream stream("Hello, World!");
  17421. detail::BodyReader reader;
  17422. reader.stream = &stream;
  17423. reader.content_length = 13;
  17424. char buf[32];
  17425. EXPECT_EQ(13, reader.read(buf, sizeof(buf)));
  17426. EXPECT_EQ(0, reader.read(buf, sizeof(buf)));
  17427. EXPECT_TRUE(reader.eof);
  17428. }
  17429. TEST(BodyReaderTest, NoStream) {
  17430. detail::BodyReader reader;
  17431. char buf[32];
  17432. EXPECT_EQ(-1, reader.read(buf, sizeof(buf)));
  17433. EXPECT_EQ(Error::Connection, reader.last_error);
  17434. }
  17435. TEST(BodyReaderTest, Error) {
  17436. MockStream stream("Hello, World!", 5);
  17437. detail::BodyReader reader;
  17438. reader.stream = &stream;
  17439. reader.content_length = 13;
  17440. char buf[32];
  17441. EXPECT_EQ(5, reader.read(buf, sizeof(buf)));
  17442. EXPECT_EQ(-1, reader.read(buf, sizeof(buf)));
  17443. EXPECT_EQ(Error::Read, reader.last_error);
  17444. }
  17445. // Memory buffer mode removed: StreamHandle reads only from socket streams.
  17446. // Mock-based StreamHandle tests relying on private internals are removed.
  17447. class OpenStreamTest : public ::testing::Test {
  17448. protected:
  17449. void SetUp() override {
  17450. svr_.Get("/hello", [](const Request &, Response &res) {
  17451. res.set_content("Hello World!", "text/plain");
  17452. });
  17453. svr_.Get("/large", [](const Request &, Response &res) {
  17454. res.set_content(std::string(10000, 'X'), "text/plain");
  17455. });
  17456. svr_.Get("/unknown-encoding", [](const Request &, Response &res) {
  17457. res.set_content("Hello World!", "image/jpeg");
  17458. res.set_header("Content-Encoding", "UTF-8");
  17459. });
  17460. svr_.Get("/chunked", [](const Request &, Response &res) {
  17461. res.set_chunked_content_provider("text/plain",
  17462. [](size_t offset, DataSink &sink) {
  17463. if (offset < 15) {
  17464. sink.write("chunk", 5);
  17465. return true;
  17466. }
  17467. sink.done();
  17468. return true;
  17469. });
  17470. });
  17471. svr_.Get("/compressible", [](const Request &, Response &res) {
  17472. res.set_chunked_content_provider("text/plain", [](size_t offset,
  17473. DataSink &sink) {
  17474. if (offset < 100 * 1024) {
  17475. std::string chunk(std::min(size_t(8192), 100 * 1024 - offset), 'A');
  17476. sink.write(chunk.data(), chunk.size());
  17477. return true;
  17478. }
  17479. sink.done();
  17480. return true;
  17481. });
  17482. });
  17483. svr_.Get("/streamed-chunked-with-prohibited-trailer",
  17484. [](const Request & /*req*/, Response &res) {
  17485. auto i = new int(0);
  17486. res.set_header("Trailer", "Content-Length, X-Allowed");
  17487. res.set_chunked_content_provider(
  17488. "text/plain",
  17489. [i](size_t /*offset*/, DataSink &sink) {
  17490. switch (*i) {
  17491. case 0: sink.os << "123"; break;
  17492. case 1: sink.os << "456"; break;
  17493. case 2: sink.os << "789"; break;
  17494. case 3: {
  17495. sink.done_with_trailer(
  17496. {{"Content-Length", "5"}, {"X-Allowed", "yes"}});
  17497. } break;
  17498. }
  17499. (*i)++;
  17500. return true;
  17501. },
  17502. [i](bool success) {
  17503. EXPECT_TRUE(success);
  17504. delete i;
  17505. });
  17506. });
  17507. // Echo headers endpoint for header-related tests
  17508. svr_.Get("/echo-headers", [](const Request &req, Response &res) {
  17509. std::string body;
  17510. for (const auto &h : req.headers) {
  17511. body.append(h.first);
  17512. body.push_back(':');
  17513. body.append(h.second);
  17514. body.push_back('\n');
  17515. }
  17516. res.set_content(body, "text/plain");
  17517. });
  17518. svr_.Post("/echo-headers", [](const Request &req, Response &res) {
  17519. std::string body;
  17520. for (const auto &h : req.headers) {
  17521. body.append(h.first);
  17522. body.push_back(':');
  17523. body.append(h.second);
  17524. body.push_back('\n');
  17525. }
  17526. res.set_content(body, "text/plain");
  17527. });
  17528. port_ = svr_.bind_to_any_port("127.0.0.1");
  17529. thread_ = std::thread([this]() { svr_.listen_after_bind(); });
  17530. svr_.wait_until_ready();
  17531. }
  17532. void TearDown() override {
  17533. svr_.stop();
  17534. if (thread_.joinable()) thread_.join();
  17535. }
  17536. Server svr_;
  17537. std::thread thread_;
  17538. int port_ = 0;
  17539. };
  17540. TEST_F(OpenStreamTest, Basic) {
  17541. Client cli("127.0.0.1", port_);
  17542. auto handle = cli.open_stream("GET", "/hello");
  17543. EXPECT_TRUE(handle.is_valid());
  17544. EXPECT_EQ("Hello World!", read_all(handle));
  17545. }
  17546. TEST_F(OpenStreamTest, UnknownContentEncodingIsPassedThrough) {
  17547. Client cli("127.0.0.1", port_);
  17548. auto handle = cli.open_stream("GET", "/unknown-encoding");
  17549. ASSERT_TRUE(handle.is_valid());
  17550. EXPECT_EQ("Hello World!", read_all(handle));
  17551. }
  17552. TEST_F(OpenStreamTest, SmallBuffer) {
  17553. Client cli("127.0.0.1", port_);
  17554. auto handle = cli.open_stream("GET", "/hello");
  17555. std::string result;
  17556. char buf[4];
  17557. ssize_t n;
  17558. while ((n = handle.read(buf, sizeof(buf))) > 0)
  17559. result.append(buf, static_cast<size_t>(n));
  17560. EXPECT_EQ("Hello World!", result);
  17561. }
  17562. TEST_F(OpenStreamTest, DefaultHeaders) {
  17563. Client cli("127.0.0.1", port_);
  17564. // open_stream GET should include Host, User-Agent and Accept-Encoding
  17565. {
  17566. auto handle = cli.open_stream("GET", "/echo-headers");
  17567. ASSERT_TRUE(handle.is_valid());
  17568. auto body = read_all(handle);
  17569. EXPECT_NE(body.find("Host:127.0.0.1:" + std::to_string(port_)),
  17570. std::string::npos);
  17571. EXPECT_NE(body.find("User-Agent:cpp-httplib/" CPPHTTPLIB_VERSION),
  17572. std::string::npos);
  17573. EXPECT_NE(body.find("Accept-Encoding:"), std::string::npos);
  17574. }
  17575. // open_stream POST with body and no explicit content_type should NOT add
  17576. // text/plain Content-Type (behavior differs from non-streaming path), but
  17577. // should include Content-Length
  17578. {
  17579. auto handle = cli.open_stream("POST", "/echo-headers", {}, {}, "hello", "");
  17580. ASSERT_TRUE(handle.is_valid());
  17581. auto body = read_all(handle);
  17582. EXPECT_EQ(body.find("Content-Type: text/plain"), std::string::npos);
  17583. EXPECT_NE(body.find("Content-Length:5"), std::string::npos);
  17584. }
  17585. // open_stream POST with explicit Content-Type should preserve it
  17586. {
  17587. auto handle = cli.open_stream("POST", "/echo-headers", {},
  17588. {{"Content-Type", "application/custom"}},
  17589. "{}", "application/custom");
  17590. ASSERT_TRUE(handle.is_valid());
  17591. auto body = read_all(handle);
  17592. EXPECT_NE(body.find("Content-Type:application/custom"), std::string::npos);
  17593. }
  17594. // User-specified User-Agent must not be overwritten for stream API
  17595. {
  17596. auto handle = cli.open_stream("GET", "/echo-headers", {},
  17597. {{"User-Agent", "MyAgent/1.2"}});
  17598. ASSERT_TRUE(handle.is_valid());
  17599. auto body = read_all(handle);
  17600. EXPECT_NE(body.find("User-Agent:MyAgent/1.2"), std::string::npos);
  17601. }
  17602. }
  17603. TEST_F(OpenStreamTest, Large) {
  17604. Client cli("127.0.0.1", port_);
  17605. auto handle = cli.open_stream("GET", "/large");
  17606. EXPECT_EQ(10000u, read_all(handle).size());
  17607. }
  17608. TEST_F(OpenStreamTest, ConnectionError) {
  17609. Client cli("127.0.0.1", 9999);
  17610. auto handle = cli.open_stream("GET", "/hello");
  17611. EXPECT_FALSE(handle.is_valid());
  17612. }
  17613. TEST_F(OpenStreamTest, Chunked) {
  17614. Client cli("127.0.0.1", port_);
  17615. auto handle = cli.open_stream("GET", "/chunked");
  17616. EXPECT_TRUE(handle.response && handle.response->get_header_value(
  17617. "Transfer-Encoding") == "chunked");
  17618. EXPECT_EQ("chunkchunkchunk", read_all(handle));
  17619. }
  17620. TEST_F(OpenStreamTest, ProhibitedTrailersAreIgnored_Stream) {
  17621. Client cli("127.0.0.1", port_);
  17622. auto handle =
  17623. cli.open_stream("GET", "/streamed-chunked-with-prohibited-trailer");
  17624. ASSERT_TRUE(handle.is_valid());
  17625. // Consume body to allow trailers to be received/parsed
  17626. auto body = read_all(handle);
  17627. // Explicitly parse trailers (ensure trailers are available for assertion)
  17628. handle.parse_trailers_if_needed();
  17629. EXPECT_EQ(std::string("123456789"), body);
  17630. // The response should include a Trailer header declaring both names
  17631. ASSERT_TRUE(handle.response);
  17632. EXPECT_TRUE(handle.response->has_header("Trailer"));
  17633. EXPECT_EQ(std::string("Content-Length, X-Allowed"),
  17634. handle.response->get_header_value("Trailer"));
  17635. // Prohibited trailer must not be present
  17636. EXPECT_FALSE(handle.response->has_trailer("Content-Length"));
  17637. // Allowed trailer should be present
  17638. EXPECT_TRUE(handle.response->has_trailer("X-Allowed"));
  17639. EXPECT_EQ(std::string("yes"),
  17640. handle.response->get_trailer_value("X-Allowed"));
  17641. // Verify trailers are NOT present as regular headers
  17642. EXPECT_EQ(std::string(""),
  17643. handle.response->get_header_value("Content-Length"));
  17644. EXPECT_EQ(std::string(""), handle.response->get_header_value("X-Allowed"));
  17645. }
  17646. static std::thread serve_single_response(std::promise<int> &port_promise,
  17647. const std::string &response) {
  17648. return std::thread([&port_promise, response] {
  17649. auto srv = ::socket(AF_INET, SOCK_STREAM, 0);
  17650. default_socket_options(srv);
  17651. detail::set_socket_opt_time(srv, SOL_SOCKET, SO_RCVTIMEO, 5, 0);
  17652. detail::set_socket_opt_time(srv, SOL_SOCKET, SO_SNDTIMEO, 5, 0);
  17653. sockaddr_in addr{};
  17654. addr.sin_family = AF_INET;
  17655. addr.sin_port = htons(0); // Let OS assign a free port
  17656. ::inet_pton(AF_INET, "127.0.0.1", &addr.sin_addr);
  17657. int opt = 1;
  17658. ::setsockopt(srv, SOL_SOCKET, SO_REUSEADDR,
  17659. #ifdef _WIN32
  17660. reinterpret_cast<const char *>(&opt),
  17661. #else
  17662. &opt,
  17663. #endif
  17664. sizeof(opt));
  17665. if (::bind(srv, reinterpret_cast<sockaddr *>(&addr), sizeof(addr)) != 0 ||
  17666. ::listen(srv, 1) != 0) {
  17667. port_promise.set_value(-1);
  17668. detail::close_socket(srv);
  17669. return;
  17670. }
  17671. socklen_t addr_len = sizeof(addr);
  17672. ::getsockname(srv, reinterpret_cast<sockaddr *>(&addr), &addr_len);
  17673. port_promise.set_value(static_cast<int>(ntohs(addr.sin_port)));
  17674. sockaddr_in cli_addr{};
  17675. socklen_t cli_len = sizeof(cli_addr);
  17676. auto cli = ::accept(srv, reinterpret_cast<sockaddr *>(&cli_addr), &cli_len);
  17677. if (cli != INVALID_SOCKET) {
  17678. // Read the complete HTTP request (until the blank line that terminates
  17679. // headers) before sending the response. If the server closes the socket
  17680. // while the client's request data is still unread in the kernel receive
  17681. // buffer, the TCP stack sends RST instead of FIN. That RST resets the
  17682. // connection on both sides: it discards the client's receive buffer
  17683. // (which already holds our response) and causes any in-progress write on
  17684. // the client to fail with ECONNRESET. Reading all request data first
  17685. // ensures close() emits a graceful FIN.
  17686. {
  17687. char rbuf[256];
  17688. std::string req;
  17689. while (req.find("\r\n\r\n") == std::string::npos) {
  17690. auto n = ::recv(cli, rbuf, sizeof(rbuf), 0);
  17691. if (n <= 0) { break; }
  17692. req.append(rbuf, static_cast<size_t>(n));
  17693. }
  17694. }
  17695. ::send(cli,
  17696. #ifdef _WIN32
  17697. static_cast<const char *>(response.c_str()),
  17698. static_cast<int>(response.size()),
  17699. #else
  17700. response.c_str(), response.size(),
  17701. #endif
  17702. 0);
  17703. detail::close_socket(cli);
  17704. }
  17705. detail::close_socket(srv);
  17706. });
  17707. }
  17708. TEST(OpenStreamMalformedContentLength, InvalidArgument) {
  17709. #ifndef _WIN32
  17710. signal(SIGPIPE, SIG_IGN);
  17711. #endif
  17712. std::promise<int> port_promise;
  17713. auto port_future = port_promise.get_future();
  17714. auto server_thread =
  17715. serve_single_response(port_promise, "HTTP/1.1 200 OK\r\n"
  17716. "Content-Type: text/plain\r\n"
  17717. "Content-Length: not-a-number\r\n"
  17718. "Connection: close\r\n"
  17719. "\r\n"
  17720. "hello");
  17721. auto port = port_future.get();
  17722. ASSERT_GT(port, 0);
  17723. Client cli("127.0.0.1", port);
  17724. auto handle = cli.open_stream("GET", "/");
  17725. EXPECT_FALSE(handle.is_valid());
  17726. server_thread.join();
  17727. }
  17728. TEST(OpenStreamMalformedContentLength, OutOfRange) {
  17729. #ifndef _WIN32
  17730. signal(SIGPIPE, SIG_IGN);
  17731. #endif
  17732. std::promise<int> port_promise;
  17733. auto port_future = port_promise.get_future();
  17734. auto server_thread = serve_single_response(
  17735. port_promise, "HTTP/1.1 200 OK\r\n"
  17736. "Content-Type: text/plain\r\n"
  17737. "Content-Length: 99999999999999999999999999\r\n"
  17738. "Connection: close\r\n"
  17739. "\r\n"
  17740. "hello");
  17741. auto port = port_future.get();
  17742. ASSERT_GT(port, 0);
  17743. // Historically std::stoull would throw std::out_of_range here and crash
  17744. // the process, then parsing silently clamped to a bogus framing length and
  17745. // the stream opened anyway. Now the out-of-range value is flagged invalid,
  17746. // so the stream fails to open, matching the not-a-number case above. The
  17747. // process still must NOT terminate.
  17748. Client cli("127.0.0.1", port);
  17749. auto handle = cli.open_stream("GET", "/");
  17750. EXPECT_FALSE(handle.is_valid());
  17751. server_thread.join();
  17752. }
  17753. // Serves `response` to the single request `fn` makes with a fresh client.
  17754. template <typename Fn>
  17755. static void with_single_response(const std::string &response, Fn fn) {
  17756. #ifndef _WIN32
  17757. signal(SIGPIPE, SIG_IGN);
  17758. #endif
  17759. std::promise<int> port_promise;
  17760. auto port_future = port_promise.get_future();
  17761. auto server_thread = serve_single_response(port_promise, response);
  17762. auto se = detail::scope_exit([&] { server_thread.join(); });
  17763. auto port = port_future.get();
  17764. ASSERT_GT(port, 0);
  17765. Client cli("127.0.0.1", port);
  17766. fn(cli);
  17767. }
  17768. // RFC 9112 §6.3: a response that pairs a non-zero Content-Length with
  17769. // Transfer-Encoding is framed ambiguously. Both read paths delimit its body by
  17770. // the chunked coding and drop Content-Length, so a front-end that trusts
  17771. // Content-Length would disagree about where the body ends (response
  17772. // smuggling). The client must reject such a response.
  17773. TEST(ClientResponseSmugglingTest, ContentLengthAndTransferEncodingRejected) {
  17774. for (const char *te : {"chunked", "gzip, chunked"}) {
  17775. auto response = std::string("HTTP/1.1 200 OK\r\n") +
  17776. "Content-Length: 5\r\n" + "Transfer-Encoding: " + te +
  17777. "\r\n" + "Connection: close\r\n" + "\r\n" +
  17778. "5\r\nhello\r\n0\r\n\r\n";
  17779. with_single_response(response, [&](Client &cli) {
  17780. auto res = cli.Get("/");
  17781. EXPECT_FALSE(static_cast<bool>(res)) << te;
  17782. EXPECT_EQ(Error::Read, res.error()) << te;
  17783. });
  17784. with_single_response(response, [&](Client &cli) {
  17785. auto handle = cli.open_stream("GET", "/");
  17786. EXPECT_FALSE(handle.is_valid()) << te;
  17787. EXPECT_EQ(Error::Read, handle.error) << te;
  17788. });
  17789. }
  17790. }
  17791. // Unambiguous framing stays readable on both paths: chunked alone, and a final
  17792. // coding other than chunked, whose body RFC 9112 §6.3 delimits by the server
  17793. // closing the connection (unlike a request, which must be rejected).
  17794. TEST(ClientResponseSmugglingTest, UnambiguousFramingAccepted) {
  17795. for (const char *response : {"HTTP/1.1 200 OK\r\n"
  17796. "Transfer-Encoding: chunked\r\n"
  17797. "Connection: close\r\n"
  17798. "\r\n"
  17799. "5\r\nhello\r\n0\r\n\r\n",
  17800. "HTTP/1.1 200 OK\r\n"
  17801. "Transfer-Encoding: gzip\r\n"
  17802. "Connection: close\r\n"
  17803. "\r\n"
  17804. "hello"}) {
  17805. with_single_response(response, [&](Client &cli) {
  17806. auto res = cli.Get("/");
  17807. ASSERT_TRUE(static_cast<bool>(res)) << response;
  17808. EXPECT_EQ("hello", res->body);
  17809. });
  17810. with_single_response(response, [&](Client &cli) {
  17811. auto handle = cli.open_stream("GET", "/");
  17812. ASSERT_TRUE(handle.is_valid()) << response;
  17813. EXPECT_EQ("hello", read_all(handle));
  17814. });
  17815. }
  17816. }
  17817. // A response to HEAD, and a 204 or 304 response, carries no body, so its
  17818. // framing headers describe nothing to read and must not be rejected.
  17819. TEST(ClientResponseSmugglingTest, BodylessResponseNotRejected) {
  17820. const std::string framing = "Content-Length: 5\r\n"
  17821. "Transfer-Encoding: chunked\r\n"
  17822. "Connection: close\r\n"
  17823. "\r\n";
  17824. with_single_response("HTTP/1.1 200 OK\r\n" + framing, [](Client &cli) {
  17825. EXPECT_TRUE(static_cast<bool>(cli.Head("/")));
  17826. });
  17827. with_single_response("HTTP/1.1 200 OK\r\n" + framing, [](Client &cli) {
  17828. EXPECT_TRUE(cli.open_stream("HEAD", "/").is_valid());
  17829. });
  17830. for (const char *status : {"204 No Content", "304 Not Modified"}) {
  17831. auto response = std::string("HTTP/1.1 ") + status + "\r\n" + framing;
  17832. with_single_response(response, [&](Client &cli) {
  17833. EXPECT_TRUE(static_cast<bool>(cli.Get("/"))) << status;
  17834. });
  17835. with_single_response(response, [&](Client &cli) {
  17836. EXPECT_TRUE(cli.open_stream("GET", "/").is_valid()) << status;
  17837. });
  17838. }
  17839. }
  17840. // A payload max length of 0 means no limit, however the body is framed.
  17841. TEST(PayloadMaxLengthZeroTest, ClientReadsChunkedAndUnframedResponse) {
  17842. for (const char *response : {"HTTP/1.1 200 OK\r\n"
  17843. "Transfer-Encoding: chunked\r\n"
  17844. "\r\n"
  17845. "5\r\nhello\r\n0\r\n\r\n",
  17846. "HTTP/1.1 200 OK\r\n"
  17847. "Connection: close\r\n"
  17848. "\r\n"
  17849. "hello"}) {
  17850. with_single_response(response, [&](Client &cli) {
  17851. cli.set_payload_max_length(0);
  17852. auto res = cli.Get("/");
  17853. ASSERT_TRUE(res) << response;
  17854. EXPECT_EQ("hello", res->body) << response;
  17855. });
  17856. }
  17857. }
  17858. TEST(PayloadMaxLengthZeroTest, ServerReadsChunkedRequest) {
  17859. Server svr;
  17860. svr.set_payload_max_length(0);
  17861. svr.Post("/echo", [](const Request &req, Response &res) {
  17862. res.set_content(req.body, "text/plain");
  17863. });
  17864. auto port = svr.bind_to_any_port(HOST);
  17865. thread t = thread([&] { svr.listen_after_bind(); });
  17866. auto se = detail::scope_exit([&] {
  17867. svr.stop();
  17868. t.join();
  17869. ASSERT_FALSE(svr.is_running());
  17870. });
  17871. svr.wait_until_ready();
  17872. Client cli(HOST, port);
  17873. auto res = cli.Post(
  17874. "/echo",
  17875. [](size_t /*offset*/, DataSink &sink) {
  17876. sink.write("hello", 5);
  17877. sink.done();
  17878. return true;
  17879. },
  17880. "text/plain");
  17881. ASSERT_TRUE(res);
  17882. EXPECT_EQ(StatusCode::OK_200, res->status);
  17883. EXPECT_EQ("hello", res->body);
  17884. }
  17885. #ifdef CPPHTTPLIB_ZLIB_SUPPORT
  17886. TEST_F(OpenStreamTest, Gzip) {
  17887. Client cli("127.0.0.1", port_);
  17888. auto handle = cli.open_stream("GET", "/compressible", {},
  17889. {{"Accept-Encoding", "gzip"}});
  17890. EXPECT_EQ("gzip", handle.response->get_header_value("Content-Encoding"));
  17891. EXPECT_EQ(100u * 1024u, read_all(handle).size());
  17892. }
  17893. #endif
  17894. #ifdef CPPHTTPLIB_BROTLI_SUPPORT
  17895. TEST_F(OpenStreamTest, Brotli) {
  17896. Client cli("127.0.0.1", port_);
  17897. auto handle =
  17898. cli.open_stream("GET", "/compressible", {}, {{"Accept-Encoding", "br"}});
  17899. EXPECT_EQ("br", handle.response->get_header_value("Content-Encoding"));
  17900. EXPECT_EQ(100u * 1024u, read_all(handle).size());
  17901. }
  17902. #endif
  17903. #ifdef CPPHTTPLIB_ZSTD_SUPPORT
  17904. TEST_F(OpenStreamTest, Zstd) {
  17905. Client cli("127.0.0.1", port_);
  17906. auto handle = cli.open_stream("GET", "/compressible", {},
  17907. {{"Accept-Encoding", "zstd"}});
  17908. EXPECT_EQ("zstd", handle.response->get_header_value("Content-Encoding"));
  17909. EXPECT_EQ(100u * 1024u, read_all(handle).size());
  17910. }
  17911. #endif
  17912. #ifdef CPPHTTPLIB_SSL_ENABLED
  17913. class SSLOpenStreamTest : public ::testing::Test {
  17914. protected:
  17915. SSLOpenStreamTest() : svr_("cert.pem", "key.pem") {}
  17916. void SetUp() override {
  17917. svr_.Get("/hello", [](const Request &, Response &res) {
  17918. res.set_content("Hello SSL World!", "text/plain");
  17919. });
  17920. svr_.Get("/chunked", [](const Request &, Response &res) {
  17921. res.set_chunked_content_provider("text/plain",
  17922. [](size_t offset, DataSink &sink) {
  17923. if (offset < 15) {
  17924. sink.write("chunk", 5);
  17925. return true;
  17926. }
  17927. sink.done();
  17928. return true;
  17929. });
  17930. });
  17931. svr_.Post("/echo", [](const Request &req, Response &res) {
  17932. res.set_content(req.body, req.get_header_value("Content-Type"));
  17933. });
  17934. svr_.Post("/chunked-response", [](const Request &req, Response &res) {
  17935. std::string body = req.body;
  17936. res.set_chunked_content_provider(
  17937. "text/plain", [body](size_t offset, DataSink &sink) {
  17938. if (offset < body.size()) {
  17939. sink.write(body.data() + offset, body.size() - offset);
  17940. }
  17941. sink.done();
  17942. return true;
  17943. });
  17944. });
  17945. port_ = svr_.bind_to_any_port("127.0.0.1");
  17946. thread_ = std::thread([this]() { svr_.listen_after_bind(); });
  17947. svr_.wait_until_ready();
  17948. }
  17949. void TearDown() override {
  17950. svr_.stop();
  17951. if (thread_.joinable()) thread_.join();
  17952. }
  17953. SSLServer svr_;
  17954. std::thread thread_;
  17955. int port_ = 0;
  17956. };
  17957. TEST_F(SSLOpenStreamTest, Basic) {
  17958. SSLClient cli("127.0.0.1", port_);
  17959. cli.enable_server_certificate_verification(false);
  17960. auto handle = cli.open_stream("GET", "/hello");
  17961. ASSERT_TRUE(handle.is_valid());
  17962. EXPECT_EQ("Hello SSL World!", read_all(handle));
  17963. }
  17964. TEST_F(SSLOpenStreamTest, Chunked) {
  17965. SSLClient cli("127.0.0.1", port_);
  17966. cli.enable_server_certificate_verification(false);
  17967. auto handle = cli.open_stream("GET", "/chunked");
  17968. ASSERT_TRUE(handle.is_valid()) << "Error: " << static_cast<int>(handle.error);
  17969. EXPECT_TRUE(handle.response && handle.response->get_header_value(
  17970. "Transfer-Encoding") == "chunked");
  17971. auto body = read_all(handle);
  17972. EXPECT_EQ("chunkchunkchunk", body);
  17973. }
  17974. TEST_F(SSLOpenStreamTest, Post) {
  17975. SSLClient cli("127.0.0.1", port_);
  17976. cli.enable_server_certificate_verification(false);
  17977. auto handle =
  17978. cli.open_stream("POST", "/echo", {}, {}, "Hello SSL POST", "text/plain");
  17979. ASSERT_TRUE(handle.is_valid()) << "Error: " << static_cast<int>(handle.error);
  17980. EXPECT_EQ(200, handle.response->status);
  17981. auto body = read_all(handle);
  17982. EXPECT_EQ("Hello SSL POST", body);
  17983. }
  17984. TEST_F(SSLOpenStreamTest, PostChunked) {
  17985. SSLClient cli("127.0.0.1", port_);
  17986. cli.enable_server_certificate_verification(false);
  17987. auto handle = cli.open_stream("POST", "/chunked-response", {}, {},
  17988. "Chunked SSL Data", "text/plain");
  17989. ASSERT_TRUE(handle.is_valid());
  17990. EXPECT_EQ(200, handle.response->status);
  17991. auto body = read_all(handle);
  17992. EXPECT_EQ("Chunked SSL Data", body);
  17993. }
  17994. // RFC 7230 §3.3: a response body with neither chunked Transfer-Encoding nor
  17995. // Content-Length is terminated by the server closing the connection. When the
  17996. // SSL peer sends a close_notify after the body, the client must treat it as a
  17997. // clean EOF and return a successful response rather than an error.
  17998. TEST(SSLTest, ResponseBodyTerminatedByConnectionClose) {
  17999. SSLServer svr(SERVER_CERT_FILE, SERVER_PRIVATE_KEY_FILE);
  18000. ASSERT_TRUE(svr.is_valid());
  18001. svr.set_keep_alive_max_count(1);
  18002. const std::string expected_body = "Hello from connection-close response!";
  18003. svr.Get("/no-content-length", [&](const Request & /*req*/, Response &res) {
  18004. res.set_content_provider("text/plain",
  18005. [&](size_t offset, DataSink &sink) -> bool {
  18006. if (offset < expected_body.size()) {
  18007. sink.write(expected_body.data() + offset,
  18008. expected_body.size() - offset);
  18009. }
  18010. sink.done();
  18011. return true;
  18012. });
  18013. });
  18014. auto listen_thread = std::thread([&svr] { svr.listen(HOST, PORT); });
  18015. auto se = detail::scope_exit([&] {
  18016. svr.stop();
  18017. listen_thread.join();
  18018. ASSERT_FALSE(svr.is_running());
  18019. });
  18020. svr.wait_until_ready();
  18021. SSLClient cli(HOST, PORT);
  18022. cli.enable_server_certificate_verification(false);
  18023. auto res = cli.Get("/no-content-length");
  18024. ASSERT_TRUE(res) << "Request failed: " << to_string(res.error());
  18025. EXPECT_EQ(StatusCode::OK_200, res->status);
  18026. EXPECT_EQ(expected_body, res->body);
  18027. }
  18028. #endif // CPPHTTPLIB_SSL_ENABLED
  18029. //==============================================================================
  18030. // Parity Tests: ensure streaming and non-streaming APIs produce identical
  18031. // results for various scenarios.
  18032. //==============================================================================
  18033. TEST(ParityTest, GetVsOpenStream) {
  18034. Server svr;
  18035. const std::string path = "/parity";
  18036. const std::string content = "Parity test content: hello world";
  18037. svr.Get(path, [&](const Request & /*req*/, Response &res) {
  18038. res.set_content(content, "text/plain");
  18039. });
  18040. auto t = std::thread([&]() { svr.listen(HOST, PORT); });
  18041. auto se = detail::scope_exit([&] {
  18042. svr.stop();
  18043. t.join();
  18044. ASSERT_FALSE(svr.is_running());
  18045. });
  18046. svr.wait_until_ready();
  18047. Client cli(HOST, PORT);
  18048. // Non-stream path
  18049. auto r1 = cli.Get(path);
  18050. ASSERT_TRUE(r1);
  18051. EXPECT_EQ(StatusCode::OK_200, r1->status);
  18052. // Stream path
  18053. auto h = cli.open_stream("GET", path);
  18054. ASSERT_TRUE(h.is_valid());
  18055. EXPECT_EQ(r1->body, read_all(h));
  18056. }
  18057. // Helper to compress data with provided compressor type T
  18058. template <typename Compressor>
  18059. static std::string compress_payload_for_parity(const std::string &in) {
  18060. std::string out;
  18061. Compressor compressor;
  18062. bool ok = compressor.compress(in.data(), in.size(), /*last=*/true,
  18063. [&](const char *data, size_t n) {
  18064. out.append(data, n);
  18065. return true;
  18066. });
  18067. EXPECT_TRUE(ok);
  18068. return out;
  18069. }
  18070. // Helper function for compression parity tests
  18071. template <typename Compressor>
  18072. static void test_compression_parity(const std::string &original,
  18073. const std::string &path,
  18074. const std::string &encoding) {
  18075. const std::string compressed =
  18076. compress_payload_for_parity<Compressor>(original);
  18077. Server svr;
  18078. svr.Get(path, [&](const Request & /*req*/, Response &res) {
  18079. res.set_content(compressed, "application/octet-stream");
  18080. res.set_header("Content-Encoding", encoding);
  18081. });
  18082. auto t = std::thread([&] { svr.listen(HOST, PORT); });
  18083. auto se = detail::scope_exit([&] {
  18084. svr.stop();
  18085. t.join();
  18086. ASSERT_FALSE(svr.is_running());
  18087. });
  18088. svr.wait_until_ready();
  18089. Client cli(HOST, PORT);
  18090. // Non-streaming
  18091. {
  18092. auto res = cli.Get(path);
  18093. ASSERT_TRUE(res) << "Error: " << to_string(res.error());
  18094. EXPECT_EQ(StatusCode::OK_200, res->status);
  18095. EXPECT_EQ(original, res->body);
  18096. }
  18097. // Streaming
  18098. {
  18099. auto h = cli.open_stream("GET", path);
  18100. ASSERT_TRUE(h.is_valid());
  18101. EXPECT_EQ(original, read_all(h));
  18102. }
  18103. }
  18104. #ifdef CPPHTTPLIB_ZLIB_SUPPORT
  18105. TEST(ParityTest, Gzip) {
  18106. test_compression_parity<detail::gzip_compressor>(
  18107. "The quick brown fox jumps over the lazy dog", "/parity-gzip", "gzip");
  18108. }
  18109. #endif
  18110. #ifdef CPPHTTPLIB_BROTLI_SUPPORT
  18111. TEST(ParityTest, Brotli) {
  18112. test_compression_parity<detail::brotli_compressor>(
  18113. "Hello, brotli parity test payload", "/parity-br", "br");
  18114. }
  18115. #endif
  18116. #ifdef CPPHTTPLIB_ZSTD_SUPPORT
  18117. TEST(ParityTest, Zstd) {
  18118. test_compression_parity<detail::zstd_compressor>(
  18119. "Zstandard parity test payload", "/parity-zstd", "zstd");
  18120. }
  18121. #endif
  18122. //==============================================================================
  18123. // New Stream API Tests
  18124. //==============================================================================
  18125. inline std::string read_body(httplib::stream::Result &result) {
  18126. std::string body;
  18127. while (result.next()) {
  18128. body.append(result.data(), result.size());
  18129. }
  18130. return body;
  18131. }
  18132. TEST(ClientConnectionTest, Basic) {
  18133. httplib::ClientConnection conn;
  18134. EXPECT_FALSE(conn.is_open());
  18135. conn.sock = 1;
  18136. EXPECT_TRUE(conn.is_open());
  18137. httplib::ClientConnection conn2(std::move(conn));
  18138. EXPECT_EQ(INVALID_SOCKET, conn.sock);
  18139. conn2.sock = INVALID_SOCKET;
  18140. }
  18141. // Unified test server for all stream::* tests
  18142. class StreamApiTest : public ::testing::Test {
  18143. protected:
  18144. void SetUp() override {
  18145. svr_.Get("/hello", [](const httplib::Request &, httplib::Response &res) {
  18146. res.set_content("Hello World!", "text/plain");
  18147. });
  18148. svr_.Get("/echo-params",
  18149. [](const httplib::Request &req, httplib::Response &res) {
  18150. std::string r;
  18151. for (const auto &p : req.params) {
  18152. if (!r.empty()) r += "&";
  18153. r += p.first + "=" + p.second;
  18154. }
  18155. res.set_content(r, "text/plain");
  18156. });
  18157. svr_.Post("/echo", [](const httplib::Request &req, httplib::Response &res) {
  18158. res.set_content(req.body, req.get_header_value("Content-Type"));
  18159. });
  18160. svr_.Post("/echo-headers",
  18161. [](const httplib::Request &req, httplib::Response &res) {
  18162. std::string r;
  18163. for (const auto &h : req.headers)
  18164. r += h.first + ": " + h.second + "\n";
  18165. res.set_content(r, "text/plain");
  18166. });
  18167. svr_.Post("/echo-params",
  18168. [](const httplib::Request &req, httplib::Response &res) {
  18169. std::string r = "params:";
  18170. for (const auto &p : req.params)
  18171. r += p.first + "=" + p.second + ";";
  18172. res.set_content(r + " body:" + req.body, "text/plain");
  18173. });
  18174. svr_.Post("/large", [](const httplib::Request &, httplib::Response &res) {
  18175. res.set_content(std::string(100 * 1024, 'X'), "application/octet-stream");
  18176. });
  18177. svr_.Put("/echo", [](const httplib::Request &req, httplib::Response &res) {
  18178. res.set_content("PUT:" + req.body, "text/plain");
  18179. });
  18180. svr_.Patch("/echo",
  18181. [](const httplib::Request &req, httplib::Response &res) {
  18182. res.set_content("PATCH:" + req.body, "text/plain");
  18183. });
  18184. svr_.Delete(
  18185. "/resource", [](const httplib::Request &req, httplib::Response &res) {
  18186. res.set_content(req.body.empty() ? "Deleted" : "Deleted:" + req.body,
  18187. "text/plain");
  18188. });
  18189. svr_.Get("/head-test",
  18190. [](const httplib::Request &, httplib::Response &res) {
  18191. res.set_content("body for HEAD", "text/plain");
  18192. });
  18193. svr_.Options("/options",
  18194. [](const httplib::Request &, httplib::Response &res) {
  18195. res.set_header("Allow", "GET, POST, PUT, DELETE, OPTIONS");
  18196. });
  18197. thread_ = std::thread([this]() { svr_.listen(HOST, PORT); });
  18198. svr_.wait_until_ready();
  18199. }
  18200. void TearDown() override {
  18201. svr_.stop();
  18202. if (thread_.joinable()) thread_.join();
  18203. }
  18204. httplib::Server svr_;
  18205. std::thread thread_;
  18206. };
  18207. // stream::Get tests
  18208. TEST_F(StreamApiTest, GetBasic) {
  18209. httplib::Client cli(HOST, PORT);
  18210. auto result = httplib::stream::Get(cli, "/hello");
  18211. ASSERT_TRUE(result.is_valid());
  18212. EXPECT_EQ(200, result.status());
  18213. EXPECT_EQ("Hello World!", read_body(result));
  18214. }
  18215. TEST_F(StreamApiTest, GetWithParams) {
  18216. httplib::Client cli(HOST, PORT);
  18217. httplib::Params params{{"foo", "bar"}};
  18218. auto result = httplib::stream::Get(cli, "/echo-params", params);
  18219. ASSERT_TRUE(result.is_valid());
  18220. EXPECT_TRUE(read_body(result).find("foo=bar") != std::string::npos);
  18221. }
  18222. TEST_F(StreamApiTest, GetConnectionError) {
  18223. httplib::Client cli(HOST, 9999);
  18224. EXPECT_FALSE(httplib::stream::Get(cli, "/hello").is_valid());
  18225. }
  18226. TEST_F(StreamApiTest, Get404) {
  18227. httplib::Client cli(HOST, PORT);
  18228. auto result = httplib::stream::Get(cli, "/nonexistent");
  18229. EXPECT_TRUE(result.is_valid());
  18230. EXPECT_EQ(404, result.status());
  18231. }
  18232. // stream::Post tests
  18233. TEST_F(StreamApiTest, PostBasic) {
  18234. httplib::Client cli(HOST, PORT);
  18235. auto result = httplib::stream::Post(cli, "/echo", R"({"key":"value"})",
  18236. "application/json");
  18237. ASSERT_TRUE(result.is_valid());
  18238. EXPECT_EQ("application/json", result.get_header_value("Content-Type"));
  18239. EXPECT_EQ(R"({"key":"value"})", read_body(result));
  18240. }
  18241. TEST_F(StreamApiTest, PostWithHeaders) {
  18242. httplib::Client cli(HOST, PORT);
  18243. httplib::Headers headers{{"X-Custom", "value"}};
  18244. auto result = httplib::stream::Post(cli, "/echo-headers", headers, "body",
  18245. "text/plain");
  18246. EXPECT_TRUE(read_body(result).find("X-Custom: value") != std::string::npos);
  18247. }
  18248. TEST_F(StreamApiTest, PostWithParams) {
  18249. httplib::Client cli(HOST, PORT);
  18250. httplib::Params params{{"k", "v"}};
  18251. auto result =
  18252. httplib::stream::Post(cli, "/echo-params", params, "data", "text/plain");
  18253. auto body = read_body(result);
  18254. EXPECT_TRUE(body.find("k=v") != std::string::npos);
  18255. EXPECT_TRUE(body.find("body:data") != std::string::npos);
  18256. }
  18257. TEST_F(StreamApiTest, PostLarge) {
  18258. httplib::Client cli(HOST, PORT);
  18259. auto result = httplib::stream::Post(cli, "/large", "", "text/plain");
  18260. size_t total = 0;
  18261. while (result.next()) {
  18262. total += result.size();
  18263. }
  18264. EXPECT_EQ(100u * 1024u, total);
  18265. }
  18266. // stream::Put/Patch tests
  18267. TEST_F(StreamApiTest, PutAndPatch) {
  18268. httplib::Client cli(HOST, PORT);
  18269. auto put = httplib::stream::Put(cli, "/echo", "test", "text/plain");
  18270. EXPECT_EQ("PUT:test", read_body(put));
  18271. auto patch = httplib::stream::Patch(cli, "/echo", "test", "text/plain");
  18272. EXPECT_EQ("PATCH:test", read_body(patch));
  18273. }
  18274. // stream::Delete tests
  18275. TEST_F(StreamApiTest, Delete) {
  18276. httplib::Client cli(HOST, PORT);
  18277. auto del1 = httplib::stream::Delete(cli, "/resource");
  18278. EXPECT_EQ("Deleted", read_body(del1));
  18279. auto del2 = httplib::stream::Delete(cli, "/resource", "data", "text/plain");
  18280. EXPECT_EQ("Deleted:data", read_body(del2));
  18281. }
  18282. // stream::Head/Options tests
  18283. TEST_F(StreamApiTest, HeadAndOptions) {
  18284. httplib::Client cli(HOST, PORT);
  18285. auto head = httplib::stream::Head(cli, "/head-test");
  18286. EXPECT_TRUE(head.is_valid());
  18287. EXPECT_FALSE(head.get_header_value("Content-Length").empty());
  18288. auto opts = httplib::stream::Options(cli, "/options");
  18289. EXPECT_EQ("GET, POST, PUT, DELETE, OPTIONS", opts.get_header_value("Allow"));
  18290. }
  18291. // SSL stream::* tests
  18292. #ifdef CPPHTTPLIB_SSL_ENABLED
  18293. class SSLStreamApiTest : public ::testing::Test {
  18294. protected:
  18295. void SetUp() override {
  18296. svr_.Get("/hello", [](const httplib::Request &, httplib::Response &res) {
  18297. res.set_content("Hello SSL!", "text/plain");
  18298. });
  18299. svr_.Post("/echo", [](const httplib::Request &req, httplib::Response &res) {
  18300. res.set_content(req.body, "text/plain");
  18301. });
  18302. port_ = svr_.bind_to_any_port("127.0.0.1");
  18303. thread_ = std::thread([this]() { svr_.listen_after_bind(); });
  18304. svr_.wait_until_ready();
  18305. }
  18306. void TearDown() override {
  18307. svr_.stop();
  18308. if (thread_.joinable()) thread_.join();
  18309. }
  18310. httplib::SSLServer svr_{"cert.pem", "key.pem"};
  18311. std::thread thread_;
  18312. int port_ = 0;
  18313. };
  18314. TEST_F(SSLStreamApiTest, GetAndPost) {
  18315. httplib::SSLClient cli("127.0.0.1", port_);
  18316. cli.enable_server_certificate_verification(false);
  18317. auto get = httplib::stream::Get(cli, "/hello");
  18318. EXPECT_EQ("Hello SSL!", read_body(get));
  18319. auto post = httplib::stream::Post(cli, "/echo", "test", "text/plain");
  18320. EXPECT_EQ("test", read_body(post));
  18321. }
  18322. #endif
  18323. // Tests for Error::Timeout and Error::ConnectionClosed error types
  18324. // These errors are set in SocketStream/SSLSocketStream and propagated through
  18325. // BodyReader
  18326. TEST(ErrorHandlingTest, StreamReadTimeout) {
  18327. // Test that read timeout during streaming is detected
  18328. // Use a large content-length response where server delays mid-stream
  18329. Server svr;
  18330. svr.Get("/slow-stream", [](const Request &, Response &res) {
  18331. // Send a large response with delay in the middle
  18332. res.set_content_provider(
  18333. 1000, // content_length
  18334. "text/plain", [](size_t offset, size_t /*length*/, DataSink &sink) {
  18335. if (offset < 100) {
  18336. // Send first 100 bytes immediately
  18337. std::string data(100, 'A');
  18338. sink.write(data.c_str(), data.size());
  18339. return true;
  18340. }
  18341. // Then delay longer than client timeout
  18342. std::this_thread::sleep_for(std::chrono::seconds(3));
  18343. std::string data(900, 'B');
  18344. sink.write(data.c_str(), data.size());
  18345. return true;
  18346. });
  18347. });
  18348. auto port = 8091;
  18349. std::thread t([&]() { svr.listen("localhost", port); });
  18350. svr.wait_until_ready();
  18351. Client cli("localhost", port);
  18352. cli.set_read_timeout(1, 0); // 1 second timeout
  18353. auto handle = cli.open_stream("GET", "/slow-stream");
  18354. ASSERT_TRUE(handle.is_valid());
  18355. char buf[256];
  18356. ssize_t total = 0;
  18357. ssize_t n;
  18358. bool got_error = false;
  18359. while ((n = handle.read(buf, sizeof(buf))) > 0) {
  18360. total += n;
  18361. }
  18362. if (n < 0) {
  18363. got_error = true;
  18364. // Should be timeout or read error
  18365. EXPECT_TRUE(handle.get_read_error() == Error::Timeout ||
  18366. handle.get_read_error() == Error::Read)
  18367. << "Actual error: " << to_string(handle.get_read_error());
  18368. }
  18369. // Either we got an error, or we got less data than expected
  18370. EXPECT_TRUE(got_error || total < 1000)
  18371. << "Expected timeout but got all " << total << " bytes";
  18372. svr.stop();
  18373. t.join();
  18374. }
  18375. TEST(ErrorHandlingTest, StreamConnectionClosed) {
  18376. // Test connection closed detection via BodyReader
  18377. Server svr;
  18378. std::atomic<bool> close_now{false};
  18379. svr.Get("/will-close", [&](const Request &, Response &res) {
  18380. res.set_content_provider(
  18381. 10000, // Large content_length that we won't fully send
  18382. "text/plain", [&](size_t offset, size_t /*length*/, DataSink &sink) {
  18383. if (offset < 100) {
  18384. std::string data(100, 'X');
  18385. sink.write(data.c_str(), data.size());
  18386. return true;
  18387. }
  18388. // Wait for signal then abort
  18389. while (!close_now) {
  18390. std::this_thread::sleep_for(std::chrono::milliseconds(10));
  18391. }
  18392. return false; // Abort - server will close connection
  18393. });
  18394. });
  18395. auto port = 8092;
  18396. std::thread t([&]() { svr.listen("localhost", port); });
  18397. svr.wait_until_ready();
  18398. Client cli("localhost", port);
  18399. auto handle = cli.open_stream("GET", "/will-close");
  18400. ASSERT_TRUE(handle.is_valid());
  18401. char buf[256];
  18402. ssize_t n = handle.read(buf, sizeof(buf)); // First read
  18403. EXPECT_GT(n, 0) << "First read should succeed";
  18404. // Signal server to close
  18405. close_now = true;
  18406. // Keep reading until error or EOF
  18407. while ((n = handle.read(buf, sizeof(buf))) > 0) {
  18408. // Keep reading
  18409. }
  18410. // Should get an error since content_length wasn't satisfied
  18411. if (n < 0) {
  18412. EXPECT_TRUE(handle.get_read_error() == Error::ConnectionClosed ||
  18413. handle.get_read_error() == Error::Read)
  18414. << "Actual error: " << to_string(handle.get_read_error());
  18415. }
  18416. svr.stop();
  18417. t.join();
  18418. }
  18419. #ifdef CPPHTTPLIB_SSL_ENABLED
  18420. TEST(ErrorHandlingTest, SSLStreamReadTimeout) {
  18421. // Test that read timeout during SSL streaming is detected
  18422. SSLServer svr(SERVER_CERT_FILE, SERVER_PRIVATE_KEY_FILE);
  18423. svr.Get("/slow-stream", [](const Request &, Response &res) {
  18424. res.set_content_provider(
  18425. 1000, "text/plain",
  18426. [](size_t offset, size_t /*length*/, DataSink &sink) {
  18427. if (offset < 100) {
  18428. std::string data(100, 'A');
  18429. sink.write(data.c_str(), data.size());
  18430. return true;
  18431. }
  18432. std::this_thread::sleep_for(std::chrono::seconds(3));
  18433. std::string data(900, 'B');
  18434. sink.write(data.c_str(), data.size());
  18435. return true;
  18436. });
  18437. });
  18438. auto port = 8093;
  18439. std::thread t([&]() { svr.listen("localhost", port); });
  18440. svr.wait_until_ready();
  18441. SSLClient cli("localhost", port);
  18442. cli.enable_server_certificate_verification(false);
  18443. cli.set_read_timeout(1, 0); // 1 second timeout
  18444. auto handle = cli.open_stream("GET", "/slow-stream");
  18445. ASSERT_TRUE(handle.is_valid());
  18446. char buf[256];
  18447. ssize_t total = 0;
  18448. ssize_t n;
  18449. bool got_error = false;
  18450. while ((n = handle.read(buf, sizeof(buf))) > 0) {
  18451. total += n;
  18452. }
  18453. if (n < 0) {
  18454. got_error = true;
  18455. EXPECT_TRUE(handle.get_read_error() == Error::Timeout ||
  18456. handle.get_read_error() == Error::Read)
  18457. << "Actual error: " << to_string(handle.get_read_error());
  18458. }
  18459. EXPECT_TRUE(got_error || total < 1000)
  18460. << "Expected timeout but got all " << total << " bytes";
  18461. svr.stop();
  18462. t.join();
  18463. }
  18464. TEST(ErrorHandlingTest, SSLStreamConnectionClosed) {
  18465. // Test SSL connection closed detection
  18466. SSLServer svr(SERVER_CERT_FILE, SERVER_PRIVATE_KEY_FILE);
  18467. std::atomic<bool> close_now{false};
  18468. svr.Get("/will-close", [&](const Request &, Response &res) {
  18469. res.set_content_provider(
  18470. 10000, "text/plain",
  18471. [&](size_t offset, size_t /*length*/, DataSink &sink) {
  18472. if (offset < 100) {
  18473. std::string data(100, 'X');
  18474. sink.write(data.c_str(), data.size());
  18475. return true;
  18476. }
  18477. while (!close_now) {
  18478. std::this_thread::sleep_for(std::chrono::milliseconds(10));
  18479. }
  18480. return false;
  18481. });
  18482. });
  18483. auto port = 8094;
  18484. std::thread t([&]() { svr.listen("localhost", port); });
  18485. svr.wait_until_ready();
  18486. SSLClient cli("localhost", port);
  18487. cli.enable_server_certificate_verification(false);
  18488. auto handle = cli.open_stream("GET", "/will-close");
  18489. ASSERT_TRUE(handle.is_valid());
  18490. char buf[256];
  18491. ssize_t n = handle.read(buf, sizeof(buf)); // First read
  18492. EXPECT_GT(n, 0);
  18493. // Signal server to close
  18494. close_now = true;
  18495. while ((n = handle.read(buf, sizeof(buf))) > 0) {
  18496. // Keep reading
  18497. }
  18498. if (n < 0) {
  18499. EXPECT_TRUE(handle.get_read_error() == Error::ConnectionClosed ||
  18500. handle.get_read_error() == Error::Read)
  18501. << "Actual error: " << to_string(handle.get_read_error());
  18502. }
  18503. svr.stop();
  18504. t.join();
  18505. }
  18506. #endif
  18507. TEST(ETagTest, StaticFileETagAndIfNoneMatch) {
  18508. using namespace httplib;
  18509. // Create a test file
  18510. const char *fname = "etag_testfile.txt";
  18511. const char *content = "etag-content";
  18512. {
  18513. std::ofstream ofs(fname);
  18514. ofs << content;
  18515. ASSERT_TRUE(ofs.good());
  18516. }
  18517. Server svr;
  18518. svr.set_mount_point("/static", ".");
  18519. auto t = std::thread([&]() { svr.listen("localhost", PORT); });
  18520. svr.wait_until_ready();
  18521. Client cli(HOST, PORT);
  18522. // First request: should get 200 with ETag header
  18523. auto res1 = cli.Get("/static/etag_testfile.txt");
  18524. ASSERT_TRUE(res1);
  18525. ASSERT_EQ(200, res1->status);
  18526. ASSERT_TRUE(res1->has_header("ETag"));
  18527. std::string etag = res1->get_header_value("ETag");
  18528. EXPECT_FALSE(etag.empty());
  18529. // Verify ETag format: W/"hex-hex"
  18530. ASSERT_GE(etag.length(), 5u); // Minimum: W/""
  18531. EXPECT_EQ('W', etag[0]);
  18532. EXPECT_EQ('/', etag[1]);
  18533. EXPECT_EQ('"', etag[2]);
  18534. EXPECT_EQ('"', etag.back());
  18535. // Exact match: expect 304 Not Modified
  18536. Headers h2 = {{"If-None-Match", etag}};
  18537. auto res2 = cli.Get("/static/etag_testfile.txt", h2);
  18538. ASSERT_TRUE(res2);
  18539. EXPECT_EQ(304, res2->status);
  18540. // Wildcard match: expect 304 Not Modified
  18541. Headers h3 = {{"If-None-Match", "*"}};
  18542. auto res3 = cli.Get("/static/etag_testfile.txt", h3);
  18543. ASSERT_TRUE(res3);
  18544. EXPECT_EQ(304, res3->status);
  18545. // Non-matching ETag: expect 200
  18546. Headers h4 = {{"If-None-Match", "W/\"deadbeef\""}};
  18547. auto res4 = cli.Get("/static/etag_testfile.txt", h4);
  18548. ASSERT_TRUE(res4);
  18549. EXPECT_EQ(200, res4->status);
  18550. // Multiple ETags with one matching: expect 304
  18551. Headers h5 = {{"If-None-Match", "W/\"other\", " + etag + ", W/\"another\""}};
  18552. auto res5 = cli.Get("/static/etag_testfile.txt", h5);
  18553. ASSERT_TRUE(res5);
  18554. EXPECT_EQ(304, res5->status);
  18555. // The ETag list split over several field lines: RFC 9110 Section 5.3 makes
  18556. // that equivalent to the single comma-separated list above, so the match on
  18557. // the second line must still be found.
  18558. Headers h6;
  18559. h6.emplace("If-None-Match", "W/\"other\"");
  18560. h6.emplace("If-None-Match", etag);
  18561. auto res6 = cli.Get("/static/etag_testfile.txt", h6);
  18562. ASSERT_TRUE(res6);
  18563. EXPECT_EQ(304, res6->status);
  18564. svr.stop();
  18565. t.join();
  18566. std::remove(fname);
  18567. }
  18568. TEST(ETagTest, StaticFileETagIfNoneMatchStarNotFound) {
  18569. using namespace httplib;
  18570. Server svr;
  18571. svr.set_mount_point("/static", ".");
  18572. auto t = std::thread([&]() { svr.listen(HOST, PORT); });
  18573. svr.wait_until_ready();
  18574. Client cli(HOST, PORT);
  18575. // Send If-None-Match: * to a non-existent file
  18576. Headers h = {{"If-None-Match", "*"}};
  18577. auto res = cli.Get("/static/etag_testfile_notfound.txt", h);
  18578. ASSERT_TRUE(res) << "Error: " << to_string(res.error());
  18579. EXPECT_EQ(404, res->status);
  18580. svr.stop();
  18581. t.join();
  18582. }
  18583. TEST(ETagTest, IfNoneMatchBoundaryCheck) {
  18584. using namespace httplib;
  18585. // Create a test file
  18586. const char *fname = "etag_boundary_testfile.txt";
  18587. const char *content = "boundary-test";
  18588. {
  18589. std::ofstream ofs(fname);
  18590. ofs << content;
  18591. ASSERT_TRUE(ofs.good());
  18592. }
  18593. Server svr;
  18594. svr.set_mount_point("/static", ".");
  18595. auto t = std::thread([&]() { svr.listen("localhost", PORT); });
  18596. svr.wait_until_ready();
  18597. Client cli(HOST, PORT);
  18598. // Get the actual ETag
  18599. auto res1 = cli.Get("/static/etag_boundary_testfile.txt");
  18600. ASSERT_TRUE(res1);
  18601. ASSERT_EQ(200, res1->status);
  18602. ASSERT_TRUE(res1->has_header("ETag"));
  18603. std::string etag = res1->get_header_value("ETag");
  18604. // Test 1: Very long ETag value (longer than actual ETag)
  18605. // Should NOT match and return 200 (not trigger out-of-bounds read)
  18606. Headers h1 = {{"If-None-Match", "W/"
  18607. "\"very-long-etag-value-that-is-much-longer-"
  18608. "than-the-actual-etag-value\""}};
  18609. auto res2 = cli.Get("/static/etag_boundary_testfile.txt", h1);
  18610. ASSERT_TRUE(res2);
  18611. EXPECT_EQ(200, res2->status); // Should not match
  18612. // Test 2: Long string followed by wildcard
  18613. // Should match on "*" and return 304 (without out-of-bounds read on the long
  18614. // string)
  18615. Headers h2 = {{"If-None-Match", "W/\"another-very-long-value\", *"}};
  18616. auto res3 = cli.Get("/static/etag_boundary_testfile.txt", h2);
  18617. ASSERT_TRUE(res3);
  18618. EXPECT_EQ(304, res3->status); // Should match on "*"
  18619. // Test 3: Wildcard followed by long string
  18620. // Should match on "*" immediately and return 304
  18621. Headers h3 = {{"If-None-Match", "*, W/\"long-value-after-wildcard\""}};
  18622. auto res4 = cli.Get("/static/etag_boundary_testfile.txt", h3);
  18623. ASSERT_TRUE(res4);
  18624. EXPECT_EQ(304, res4->status); // Should match on "*"
  18625. // Test 4: Multiple long non-matching values
  18626. // Should NOT match and return 200 (test that all comparisons are safe)
  18627. Headers h4 = {{"If-None-Match", "W/\"first-long-non-matching-value\", "
  18628. "W/\"second-long-non-matching-value\", "
  18629. "W/\"third-long-non-matching-value\""}};
  18630. auto res5 = cli.Get("/static/etag_boundary_testfile.txt", h4);
  18631. ASSERT_TRUE(res5);
  18632. EXPECT_EQ(200, res5->status); // Should not match
  18633. // Test 5: Single character that is not "*" (edge case)
  18634. Headers h5 = {{"If-None-Match", "X"}};
  18635. auto res6 = cli.Get("/static/etag_boundary_testfile.txt", h5);
  18636. ASSERT_TRUE(res6);
  18637. EXPECT_EQ(200, res6->status); // Should not match
  18638. svr.stop();
  18639. t.join();
  18640. std::remove(fname);
  18641. }
  18642. TEST(ETagTest, LastModifiedAndIfModifiedSince) {
  18643. using namespace httplib;
  18644. // Create a test file
  18645. const char *fname = "ims_testfile.txt";
  18646. const char *content = "if-modified-since-test";
  18647. {
  18648. std::ofstream ofs(fname);
  18649. ofs << content;
  18650. ASSERT_TRUE(ofs.good());
  18651. }
  18652. Server svr;
  18653. svr.set_mount_point("/static", ".");
  18654. auto t = std::thread([&]() { svr.listen(HOST, PORT); });
  18655. svr.wait_until_ready();
  18656. Client cli(HOST, PORT);
  18657. // First request: should get 200 with Last-Modified header
  18658. auto res1 = cli.Get("/static/ims_testfile.txt");
  18659. ASSERT_TRUE(res1);
  18660. ASSERT_EQ(200, res1->status);
  18661. ASSERT_TRUE(res1->has_header("Last-Modified"));
  18662. std::string last_modified = res1->get_header_value("Last-Modified");
  18663. EXPECT_FALSE(last_modified.empty());
  18664. // If-Modified-Since with same time: expect 304
  18665. Headers h2 = {{"If-Modified-Since", last_modified}};
  18666. auto res2 = cli.Get("/static/ims_testfile.txt", h2);
  18667. ASSERT_TRUE(res2);
  18668. EXPECT_EQ(304, res2->status);
  18669. // If-Modified-Since with future time: expect 304
  18670. Headers h3 = {{"If-Modified-Since", "Sun, 01 Jan 2099 00:00:00 GMT"}};
  18671. auto res3 = cli.Get("/static/ims_testfile.txt", h3);
  18672. ASSERT_TRUE(res3);
  18673. EXPECT_EQ(304, res3->status);
  18674. // If-Modified-Since with past time: expect 200
  18675. Headers h4 = {{"If-Modified-Since", "Sun, 01 Jan 2000 00:00:00 GMT"}};
  18676. auto res4 = cli.Get("/static/ims_testfile.txt", h4);
  18677. ASSERT_TRUE(res4);
  18678. EXPECT_EQ(200, res4->status);
  18679. // If-None-Match takes precedence over If-Modified-Since
  18680. // (send matching ETag with old If-Modified-Since -> should still be 304)
  18681. ASSERT_TRUE(res1->has_header("ETag"));
  18682. std::string etag = res1->get_header_value("ETag");
  18683. Headers h5 = {{"If-None-Match", etag},
  18684. {"If-Modified-Since", "Sun, 01 Jan 2000 00:00:00 GMT"}};
  18685. auto res5 = cli.Get("/static/ims_testfile.txt", h5);
  18686. ASSERT_TRUE(res5);
  18687. EXPECT_EQ(304, res5->status);
  18688. svr.stop();
  18689. t.join();
  18690. std::remove(fname);
  18691. }
  18692. TEST(ETagTest, VaryAcceptEncodingWithCompression) {
  18693. using namespace httplib;
  18694. Server svr;
  18695. // Endpoint that returns compressible content
  18696. svr.Get("/compressible", [](const Request &, Response &res) {
  18697. // Return a large enough body to trigger compression
  18698. std::string body(1000, 'a');
  18699. res.set_content(body, "text/plain");
  18700. });
  18701. auto t = std::thread([&]() { svr.listen(HOST, PORT); });
  18702. svr.wait_until_ready();
  18703. Client cli(HOST, PORT);
  18704. // Request with gzip support: should get Vary header when compressed
  18705. cli.set_compress(true);
  18706. auto res1 = cli.Get("/compressible");
  18707. ASSERT_TRUE(res1);
  18708. EXPECT_EQ(200, res1->status);
  18709. // If Content-Encoding is set, Vary should also be set
  18710. if (res1->has_header("Content-Encoding")) {
  18711. EXPECT_TRUE(res1->has_header("Vary"));
  18712. EXPECT_EQ("Accept-Encoding", res1->get_header_value("Vary"));
  18713. }
  18714. // Request without Accept-Encoding header: should not have compression
  18715. Headers h_no_compress;
  18716. auto res2 = cli.Get("/compressible", h_no_compress);
  18717. ASSERT_TRUE(res2);
  18718. EXPECT_EQ(200, res2->status);
  18719. // Verify Vary header is present when compression is applied
  18720. // (the exact behavior depends on server configuration)
  18721. svr.stop();
  18722. t.join();
  18723. }
  18724. TEST(ETagTest, IfRangeWithETag) {
  18725. using namespace httplib;
  18726. // Create a test file with known content
  18727. const char *fname = "if_range_testfile.txt";
  18728. const std::string content = "0123456789ABCDEFGHIJ"; // 20 bytes
  18729. {
  18730. std::ofstream ofs(fname);
  18731. ofs << content;
  18732. ASSERT_TRUE(ofs.good());
  18733. }
  18734. Server svr;
  18735. svr.set_mount_point("/static", ".");
  18736. auto t = std::thread([&]() { svr.listen(HOST, PORT); });
  18737. svr.wait_until_ready();
  18738. Client cli(HOST, PORT);
  18739. // First request: get ETag
  18740. auto res1 = cli.Get("/static/if_range_testfile.txt");
  18741. ASSERT_TRUE(res1);
  18742. ASSERT_EQ(200, res1->status);
  18743. ASSERT_TRUE(res1->has_header("ETag"));
  18744. std::string etag = res1->get_header_value("ETag");
  18745. // RFC 9110 Section 13.1.5: If-Range requires strong ETag comparison.
  18746. // Since our server generates weak ETags (W/"..."), If-Range with our
  18747. // ETag should NOT result in partial content - it should return full content.
  18748. Headers h2 = {{"Range", "bytes=0-4"}, {"If-Range", etag}};
  18749. auto res2 = cli.Get("/static/if_range_testfile.txt", h2);
  18750. ASSERT_TRUE(res2);
  18751. // Weak ETag in If-Range -> full content (200), not partial (206)
  18752. EXPECT_EQ(200, res2->status);
  18753. EXPECT_EQ(content, res2->body);
  18754. EXPECT_FALSE(res2->has_header("Content-Range"));
  18755. // Range request with non-matching If-Range (ETag): should get 200 (full
  18756. // content)
  18757. Headers h3 = {{"Range", "bytes=0-4"}, {"If-Range", "W/\"wrong-etag\""}};
  18758. auto res3 = cli.Get("/static/if_range_testfile.txt", h3);
  18759. ASSERT_TRUE(res3);
  18760. EXPECT_EQ(200, res3->status);
  18761. EXPECT_EQ(content, res3->body);
  18762. EXPECT_FALSE(res3->has_header("Content-Range"));
  18763. // Range request with strong ETag (hypothetical - our server doesn't generate
  18764. // strong ETags, but if client sends a strong ETag that doesn't match, it
  18765. // should return full content)
  18766. Headers h4 = {{"Range", "bytes=0-4"}, {"If-Range", "\"strong-etag\""}};
  18767. auto res4 = cli.Get("/static/if_range_testfile.txt", h4);
  18768. ASSERT_TRUE(res4);
  18769. EXPECT_EQ(200, res4->status);
  18770. EXPECT_EQ(content, res4->body);
  18771. EXPECT_FALSE(res4->has_header("Content-Range"));
  18772. svr.stop();
  18773. t.join();
  18774. std::remove(fname);
  18775. }
  18776. TEST(ETagTest, IfRangeWithDate) {
  18777. using namespace httplib;
  18778. // Create a test file
  18779. const char *fname = "if_range_date_testfile.txt";
  18780. const std::string content = "ABCDEFGHIJ0123456789"; // 20 bytes
  18781. {
  18782. std::ofstream ofs(fname);
  18783. ofs << content;
  18784. ASSERT_TRUE(ofs.good());
  18785. }
  18786. Server svr;
  18787. svr.set_mount_point("/static", ".");
  18788. auto t = std::thread([&]() { svr.listen(HOST, PORT); });
  18789. svr.wait_until_ready();
  18790. Client cli(HOST, PORT);
  18791. // First request: get Last-Modified
  18792. auto res1 = cli.Get("/static/if_range_date_testfile.txt");
  18793. ASSERT_TRUE(res1);
  18794. ASSERT_EQ(200, res1->status);
  18795. ASSERT_TRUE(res1->has_header("Last-Modified"));
  18796. std::string last_modified = res1->get_header_value("Last-Modified");
  18797. // Range request with matching If-Range (date): should get 206
  18798. Headers h2 = {{"Range", "bytes=5-9"}, {"If-Range", last_modified}};
  18799. auto res2 = cli.Get("/static/if_range_date_testfile.txt", h2);
  18800. ASSERT_TRUE(res2);
  18801. EXPECT_EQ(206, res2->status);
  18802. EXPECT_EQ("FGHIJ", res2->body);
  18803. // Range request with old If-Range date: should get 200 (full content)
  18804. Headers h3 = {{"Range", "bytes=5-9"},
  18805. {"If-Range", "Sun, 01 Jan 2000 00:00:00 GMT"}};
  18806. auto res3 = cli.Get("/static/if_range_date_testfile.txt", h3);
  18807. ASSERT_TRUE(res3);
  18808. EXPECT_EQ(200, res3->status);
  18809. EXPECT_EQ(content, res3->body);
  18810. // Range request with future If-Range date: should get 206
  18811. Headers h4 = {{"Range", "bytes=0-4"},
  18812. {"If-Range", "Sun, 01 Jan 2099 00:00:00 GMT"}};
  18813. auto res4 = cli.Get("/static/if_range_date_testfile.txt", h4);
  18814. ASSERT_TRUE(res4);
  18815. EXPECT_EQ(206, res4->status);
  18816. EXPECT_EQ("ABCDE", res4->body);
  18817. svr.stop();
  18818. t.join();
  18819. std::remove(fname);
  18820. }
  18821. TEST(ETagTest, MalformedIfNoneMatchAndWhitespace) {
  18822. using namespace httplib;
  18823. const char *fname = "etag_malformed.txt";
  18824. const char *content = "malformed-etag";
  18825. {
  18826. std::ofstream ofs(fname);
  18827. ofs << content;
  18828. ASSERT_TRUE(ofs.good());
  18829. }
  18830. Server svr;
  18831. svr.set_mount_point("/static", ".");
  18832. auto t = std::thread([&]() { svr.listen(HOST, PORT); });
  18833. svr.wait_until_ready();
  18834. Client cli(HOST, PORT);
  18835. // baseline: should get 200 and an ETag
  18836. auto res1 = cli.Get("/static/etag_malformed.txt");
  18837. ASSERT_TRUE(res1);
  18838. ASSERT_EQ(200, res1->status);
  18839. ASSERT_TRUE(res1->has_header("ETag"));
  18840. // Malformed ETag value (missing quotes) should be treated as non-matching
  18841. Headers h_bad = {{"If-None-Match", "W/noquotes"}};
  18842. auto res_bad = cli.Get("/static/etag_malformed.txt", h_bad);
  18843. ASSERT_TRUE(res_bad);
  18844. EXPECT_EQ(200, res_bad->status);
  18845. // Whitespace-only header value should be considered invalid / non-matching
  18846. std::string raw_req = "GET /static/etag_malformed.txt HTTP/1.1\r\n"
  18847. "Host: localhost\r\n"
  18848. "If-None-Match: \r\n"
  18849. "Connection: close\r\n"
  18850. "\r\n";
  18851. std::string out;
  18852. ASSERT_TRUE(send_request(5, raw_req, &out));
  18853. EXPECT_EQ("HTTP/1.1 200 OK", out.substr(0, 15));
  18854. svr.stop();
  18855. t.join();
  18856. std::remove(fname);
  18857. }
  18858. TEST(ETagTest, InvalidIfModifiedSinceAndIfRangeDate) {
  18859. using namespace httplib;
  18860. const char *fname = "ims_invalid_format.txt";
  18861. const char *content = "ims-bad-format";
  18862. {
  18863. std::ofstream ofs(fname);
  18864. ofs << content;
  18865. ASSERT_TRUE(ofs.good());
  18866. }
  18867. Server svr;
  18868. svr.set_mount_point("/static", ".");
  18869. auto t = std::thread([&]() { svr.listen(HOST, PORT); });
  18870. svr.wait_until_ready();
  18871. Client cli(HOST, PORT);
  18872. auto res1 = cli.Get("/static/ims_invalid_format.txt");
  18873. ASSERT_TRUE(res1);
  18874. ASSERT_EQ(200, res1->status);
  18875. ASSERT_TRUE(res1->has_header("Last-Modified"));
  18876. // If-Modified-Since with invalid format should not result in 304
  18877. Headers h_bad_date = {{"If-Modified-Since", "not-a-valid-date"}};
  18878. auto res_bad = cli.Get("/static/ims_invalid_format.txt", h_bad_date);
  18879. ASSERT_TRUE(res_bad);
  18880. EXPECT_EQ(200, res_bad->status);
  18881. // If-Range with invalid date format should be treated as mismatch -> full
  18882. // content (200)
  18883. Headers h_ifrange_bad = {{"Range", "bytes=0-3"},
  18884. {"If-Range", "invalid-date"}};
  18885. auto res_ifrange = cli.Get("/static/ims_invalid_format.txt", h_ifrange_bad);
  18886. ASSERT_TRUE(res_ifrange);
  18887. EXPECT_EQ(200, res_ifrange->status);
  18888. svr.stop();
  18889. t.join();
  18890. std::remove(fname);
  18891. }
  18892. TEST(ETagTest, IfRangeWithMalformedETag) {
  18893. using namespace httplib;
  18894. const char *fname = "ifrange_malformed.txt";
  18895. const std::string content = "0123456789";
  18896. {
  18897. std::ofstream ofs(fname);
  18898. ofs << content;
  18899. ASSERT_TRUE(ofs.good());
  18900. }
  18901. Server svr;
  18902. svr.set_mount_point("/static", ".");
  18903. auto t = std::thread([&]() { svr.listen(HOST, PORT); });
  18904. svr.wait_until_ready();
  18905. Client cli(HOST, PORT);
  18906. // First request: get ETag
  18907. auto res1 = cli.Get("/static/ifrange_malformed.txt");
  18908. ASSERT_TRUE(res1);
  18909. ASSERT_EQ(200, res1->status);
  18910. ASSERT_TRUE(res1->has_header("ETag"));
  18911. // If-Range with malformed ETag (no quotes) should be treated as mismatch ->
  18912. // full content (200)
  18913. Headers h_malformed = {{"Range", "bytes=0-4"}, {"If-Range", "W/noquotes"}};
  18914. auto res2 = cli.Get("/static/ifrange_malformed.txt", h_malformed);
  18915. ASSERT_TRUE(res2);
  18916. EXPECT_EQ(200, res2->status);
  18917. EXPECT_EQ(content, res2->body);
  18918. svr.stop();
  18919. t.join();
  18920. std::remove(fname);
  18921. }
  18922. TEST(ETagTest, ExtremeLargeDateValues) {
  18923. using namespace httplib;
  18924. const char *fname = "ims_extreme_date.txt";
  18925. const char *content = "ims-extreme-date";
  18926. {
  18927. std::ofstream ofs(fname);
  18928. ofs << content;
  18929. ASSERT_TRUE(ofs.good());
  18930. }
  18931. Server svr;
  18932. svr.set_mount_point("/static", ".");
  18933. auto t = std::thread([&]() { svr.listen(HOST, PORT); });
  18934. svr.wait_until_ready();
  18935. Client cli(HOST, PORT);
  18936. auto res1 = cli.Get(std::string("/static/") + fname);
  18937. ASSERT_TRUE(res1);
  18938. ASSERT_EQ(200, res1->status);
  18939. ASSERT_TRUE(res1->has_header("Last-Modified"));
  18940. // Extremely large year that may overflow date parsing routines.
  18941. Headers h_large_date = {
  18942. {"If-Modified-Since", "Sun, 01 Jan 99999 00:00:00 GMT"}};
  18943. auto res_bad = cli.Get(std::string("/static/") + fname, h_large_date);
  18944. ASSERT_TRUE(res_bad);
  18945. // Expect server to treat this as invalid/mismatch and return full content
  18946. EXPECT_EQ(200, res_bad->status);
  18947. // If-Range with extremely large date should be treated as mismatch -> full
  18948. // content (200)
  18949. Headers h_ifrange_large = {{"Range", "bytes=0-3"},
  18950. {"If-Range", "Sun, 01 Jan 99999 00:00:00 GMT"}};
  18951. auto res_ifrange = cli.Get(std::string("/static/") + fname, h_ifrange_large);
  18952. ASSERT_TRUE(res_ifrange);
  18953. EXPECT_EQ(200, res_ifrange->status);
  18954. svr.stop();
  18955. t.join();
  18956. std::remove(fname);
  18957. }
  18958. TEST(ETagTest, NegativeFileModificationTime) {
  18959. using namespace httplib;
  18960. const char *fname = "ims_negative_mtime.txt";
  18961. const std::string content = "negative-mtime";
  18962. {
  18963. std::ofstream ofs(fname);
  18964. ofs << content;
  18965. ASSERT_TRUE(ofs.good());
  18966. }
  18967. // Try to set file mtime to a negative value. This may fail on some
  18968. // platforms/filesystems; if it fails, the test will still verify server
  18969. // behaves safely by performing a regular conditional request.
  18970. #if defined(__APPLE__) || defined(__linux__)
  18971. bool set_negative = false;
  18972. do {
  18973. struct timeval times[2];
  18974. // access time: now
  18975. times[0].tv_sec = time(nullptr);
  18976. times[0].tv_usec = 0;
  18977. // modification time: negative (e.g., -1)
  18978. times[1].tv_sec = -1;
  18979. times[1].tv_usec = 0;
  18980. if (utimes(fname, times) == 0) { set_negative = true; }
  18981. } while (0);
  18982. #else
  18983. bool set_negative = false;
  18984. #endif
  18985. Server svr;
  18986. svr.set_mount_point("/static", ".");
  18987. auto t = std::thread([&]() { svr.listen(HOST, PORT); });
  18988. svr.wait_until_ready();
  18989. Client cli(HOST, PORT);
  18990. auto res1 = cli.Get(std::string("/static/") + fname);
  18991. ASSERT_TRUE(res1);
  18992. ASSERT_EQ(200, res1->status);
  18993. bool has_last_modified = res1->has_header("Last-Modified");
  18994. std::string last_modified;
  18995. if (has_last_modified) {
  18996. last_modified = res1->get_header_value("Last-Modified");
  18997. }
  18998. if (set_negative) {
  18999. // If we successfully set a negative mtime, ensure server returns a
  19000. // Last-Modified string (may be empty or normalized). Send If-Modified-Since
  19001. // with an old date and ensure server handles it without crash.
  19002. Headers h_old = {{"If-Modified-Since", "Sun, 01 Jan 1970 00:00:00 GMT"}};
  19003. auto res2 = cli.Get(std::string("/static/") + fname, h_old);
  19004. ASSERT_TRUE(res2);
  19005. // Behavior may vary; at minimum ensure server responds (200 or 304).
  19006. EXPECT_TRUE(res2->status == 200 || res2->status == 304);
  19007. } else {
  19008. // Could not set negative mtime on this platform; fall back to verifying
  19009. // that normal invalid/malformed dates are treated safely (non-304).
  19010. Headers h_bad_date = {
  19011. {"If-Modified-Since", "Sun, 01 Jan 99999 00:00:00 GMT"}};
  19012. auto res_bad = cli.Get(std::string("/static/") + fname, h_bad_date);
  19013. ASSERT_TRUE(res_bad);
  19014. EXPECT_EQ(200, res_bad->status);
  19015. }
  19016. svr.stop();
  19017. t.join();
  19018. std::remove(fname);
  19019. }
  19020. //==============================================================================
  19021. // Integration Tests with Server
  19022. //==============================================================================
  19023. class SSEIntegrationTest : public ::testing::Test {
  19024. protected:
  19025. void SetUp() override {
  19026. stop_server_.store(false);
  19027. events_.clear();
  19028. server_ = httplib::detail::make_unique<Server>();
  19029. setup_server();
  19030. start_server();
  19031. }
  19032. void TearDown() override {
  19033. stop_server_.store(true);
  19034. event_cv_.notify_all();
  19035. server_->stop();
  19036. if (server_thread_.joinable()) { server_thread_.join(); }
  19037. }
  19038. void setup_server() {
  19039. // Simple SSE endpoint
  19040. server_->Get("/events", [this](const Request &req, Response &res) {
  19041. auto last_id = req.get_header_value("Last-Event-ID");
  19042. if (!last_id.empty()) { last_received_event_id_ = last_id; }
  19043. res.set_chunked_content_provider(
  19044. "text/event-stream", [this](size_t /*offset*/, DataSink &sink) {
  19045. std::unique_lock<std::mutex> lock(event_mutex_);
  19046. if (event_cv_.wait_for(
  19047. lock, std::chrono::milliseconds(200), [this] {
  19048. return !events_.empty() || stop_server_.load();
  19049. })) {
  19050. if (stop_server_.load()) { return false; }
  19051. if (!events_.empty()) {
  19052. std::string event = events_.front();
  19053. events_.erase(events_.begin());
  19054. sink.write(event.data(), event.size());
  19055. return true;
  19056. }
  19057. }
  19058. return !stop_server_.load();
  19059. });
  19060. });
  19061. // Endpoint that returns error
  19062. server_->Get("/error-endpoint", [](const Request &, Response &res) {
  19063. res.status = 500;
  19064. res.set_content("Internal Server Error", "text/plain");
  19065. });
  19066. // Endpoint for custom event types
  19067. server_->Get("/custom-events", [](const Request &, Response &res) {
  19068. res.set_chunked_content_provider(
  19069. "text/event-stream", [](size_t offset, DataSink &sink) {
  19070. if (offset == 0) {
  19071. std::string event = "event: update\ndata: updated\n\n"
  19072. "event: delete\ndata: deleted\n\n";
  19073. sink.write(event.data(), event.size());
  19074. }
  19075. return false; // End stream after sending
  19076. });
  19077. });
  19078. }
  19079. void start_server() {
  19080. port_ = server_->bind_to_any_port(HOST);
  19081. server_thread_ = std::thread([this]() { server_->listen_after_bind(); });
  19082. // Wait for server to start
  19083. while (!server_->is_running()) {
  19084. std::this_thread::sleep_for(std::chrono::milliseconds(10));
  19085. }
  19086. }
  19087. int get_port() const { return port_; }
  19088. void send_event(const std::string &event) {
  19089. std::lock_guard<std::mutex> lock(event_mutex_);
  19090. events_.push_back(event);
  19091. event_cv_.notify_all();
  19092. }
  19093. std::unique_ptr<Server> server_;
  19094. std::thread server_thread_;
  19095. std::mutex event_mutex_;
  19096. std::condition_variable event_cv_;
  19097. std::vector<std::string> events_;
  19098. std::atomic<bool> stop_server_{false};
  19099. std::string last_received_event_id_;
  19100. int port_ = 0;
  19101. };
  19102. //==============================================================================
  19103. // SSE Parsing Tests
  19104. //==============================================================================
  19105. class SSEParsingTest : public SSEIntegrationTest {
  19106. protected:
  19107. // Feeds a raw event stream to SSEClient and returns the dispatched messages.
  19108. // A trailing sentinel event tells when the whole stream has been parsed.
  19109. std::vector<sse::SSEMessage> parse(const std::string &stream) {
  19110. auto body = stream + "event: end\ndata: end\n\n";
  19111. server_->Get("/parse", [body](const Request &, Response &res) {
  19112. res.set_content(body, "text/event-stream");
  19113. });
  19114. return collect("/parse");
  19115. }
  19116. // Runs SSEClient against path until an "end" event arrives and returns the
  19117. // messages dispatched before it
  19118. std::vector<sse::SSEMessage> collect(const std::string &path) {
  19119. Client client(HOST, get_port());
  19120. sse::SSEClient sse(client, path);
  19121. std::mutex mutex;
  19122. std::condition_variable cv;
  19123. std::vector<sse::SSEMessage> messages;
  19124. auto done = false;
  19125. sse.on_message([&](const sse::SSEMessage &msg) {
  19126. std::lock_guard<std::mutex> lock(mutex);
  19127. // Ignore a replay from a reconnect that races with stop()
  19128. if (!done) { messages.push_back(msg); }
  19129. });
  19130. sse.on_event("end", [&](const sse::SSEMessage &) {
  19131. std::lock_guard<std::mutex> lock(mutex);
  19132. done = true;
  19133. cv.notify_all();
  19134. });
  19135. sse.set_reconnect_interval(100);
  19136. sse.start_async();
  19137. {
  19138. std::unique_lock<std::mutex> lock(mutex);
  19139. cv.wait_for(lock, std::chrono::seconds(5), [&] { return done; });
  19140. }
  19141. sse.stop();
  19142. EXPECT_TRUE(done);
  19143. return messages;
  19144. }
  19145. };
  19146. TEST_F(SSEParsingTest, SingleLineData) {
  19147. auto msgs = parse("data: hello\n\n");
  19148. ASSERT_EQ(msgs.size(), 1u);
  19149. EXPECT_EQ(msgs[0].data, "hello");
  19150. EXPECT_EQ(msgs[0].event, "message");
  19151. }
  19152. TEST_F(SSEParsingTest, MultiLineData) {
  19153. auto msgs = parse("data: line1\ndata: line2\ndata: line3\n\n");
  19154. ASSERT_EQ(msgs.size(), 1u);
  19155. EXPECT_EQ(msgs[0].data, "line1\nline2\nline3");
  19156. }
  19157. TEST_F(SSEParsingTest, CustomEventType) {
  19158. auto msgs = parse("event: update\ndata: payload\n\n");
  19159. ASSERT_EQ(msgs.size(), 1u);
  19160. EXPECT_EQ(msgs[0].event, "update");
  19161. EXPECT_EQ(msgs[0].data, "payload");
  19162. }
  19163. TEST_F(SSEParsingTest, EventIdHandling) {
  19164. auto msgs = parse("id: 12345\ndata: test\n\n");
  19165. ASSERT_EQ(msgs.size(), 1u);
  19166. EXPECT_EQ(msgs[0].id, "12345");
  19167. }
  19168. TEST_F(SSEParsingTest, EmptyEventId) {
  19169. auto msgs = parse("id:\ndata: test\n\n");
  19170. ASSERT_EQ(msgs.size(), 1u);
  19171. EXPECT_EQ(msgs[0].id, "");
  19172. }
  19173. TEST_F(SSEParsingTest, CommentsIgnored) {
  19174. auto msgs = parse(": this is a comment\ndata: hello\n\n");
  19175. ASSERT_EQ(msgs.size(), 1u);
  19176. EXPECT_EQ(msgs[0].data, "hello");
  19177. EXPECT_EQ(msgs[0].event, "message");
  19178. }
  19179. TEST_F(SSEParsingTest, ColonInValue) {
  19180. auto msgs = parse("data: hello:world:test\n\n");
  19181. ASSERT_EQ(msgs.size(), 1u);
  19182. EXPECT_EQ(msgs[0].data, "hello:world:test");
  19183. }
  19184. TEST_F(SSEParsingTest, FieldNameOnly) {
  19185. // A line without a colon is a field name with an empty value
  19186. auto msgs = parse("data\n\n");
  19187. ASSERT_EQ(msgs.size(), 1u);
  19188. EXPECT_EQ(msgs[0].data, "");
  19189. }
  19190. TEST_F(SSEParsingTest, TrailingCarriageReturn) {
  19191. auto msgs = parse("event: update\r\ndata: hello\r\n\r\n");
  19192. ASSERT_EQ(msgs.size(), 1u);
  19193. EXPECT_EQ(msgs[0].event, "update");
  19194. EXPECT_EQ(msgs[0].data, "hello");
  19195. }
  19196. TEST_F(SSEParsingTest, FieldNameOnlyWithCarriageReturn) {
  19197. auto msgs = parse("data\r\n\r\n");
  19198. ASSERT_EQ(msgs.size(), 1u);
  19199. EXPECT_EQ(msgs[0].data, "");
  19200. }
  19201. TEST_F(SSEParsingTest, CarriageReturnLineEnding) {
  19202. auto msgs = parse("event: update\rdata: hello\r\r");
  19203. ASSERT_EQ(msgs.size(), 1u);
  19204. EXPECT_EQ(msgs[0].event, "update");
  19205. EXPECT_EQ(msgs[0].data, "hello");
  19206. }
  19207. TEST_F(SSEParsingTest, LineEndingSplitAcrossChunks) {
  19208. // Chunk boundaries fall inside every \r\n and right before the first one
  19209. std::vector<std::string> chunks = {"event: update", "\r", "\ndata: hello\r",
  19210. "\n\r", "\nevent: end\ndata: end\n\n"};
  19211. server_->Get("/split", [chunks](const Request &, Response &res) {
  19212. auto i = std::make_shared<size_t>(0);
  19213. res.set_chunked_content_provider(
  19214. "text/event-stream", [chunks, i](size_t /*offset*/, DataSink &sink) {
  19215. if (*i == chunks.size()) {
  19216. sink.done();
  19217. } else {
  19218. sink.write(chunks[*i].data(), chunks[*i].size());
  19219. (*i)++;
  19220. }
  19221. return true;
  19222. });
  19223. });
  19224. auto msgs = collect("/split");
  19225. ASSERT_EQ(msgs.size(), 1u);
  19226. EXPECT_EQ(msgs[0].event, "update");
  19227. EXPECT_EQ(msgs[0].data, "hello");
  19228. }
  19229. TEST_F(SSEParsingTest, LeadingByteOrderMarkIgnored) {
  19230. // Only a BOM at the start of the stream is ignored
  19231. auto msgs = parse("\xEF\xBB\xBF"
  19232. "data: first\n\n"
  19233. "\xEF\xBB\xBF"
  19234. "data: second\n\n");
  19235. ASSERT_EQ(msgs.size(), 1u);
  19236. EXPECT_EQ(msgs[0].data, "first");
  19237. }
  19238. TEST_F(SSEParsingTest, UnknownFieldsIgnored) {
  19239. auto msgs = parse("unknown: value\ndata: hello\n\n");
  19240. ASSERT_EQ(msgs.size(), 1u);
  19241. EXPECT_EQ(msgs[0].data, "hello");
  19242. EXPECT_EQ(msgs[0].event, "message");
  19243. }
  19244. TEST_F(SSEParsingTest, SpaceAfterColonOptional) {
  19245. auto msgs = parse("data: hello\n\ndata:hello\n\n");
  19246. ASSERT_EQ(msgs.size(), 2u);
  19247. EXPECT_EQ(msgs[0].data, "hello");
  19248. EXPECT_EQ(msgs[1].data, "hello");
  19249. }
  19250. TEST_F(SSEParsingTest, EventWithoutDataResetsEventType) {
  19251. // An event without data is not dispatched, and its type must not leak
  19252. // into the next event
  19253. auto msgs = parse("event: update\n\ndata: hello\n\n");
  19254. ASSERT_EQ(msgs.size(), 1u);
  19255. EXPECT_EQ(msgs[0].event, "message");
  19256. EXPECT_EQ(msgs[0].data, "hello");
  19257. }
  19258. TEST_F(SSEParsingTest, EventWithoutDataUpdatesLastEventId) {
  19259. // The first connection sends only an id; the second echoes back the
  19260. // Last-Event-ID it was reconnected with
  19261. std::atomic<int> connection_count{0};
  19262. server_->Get("/id-only", [&](const Request &req, Response &res) {
  19263. if (connection_count++ == 0) {
  19264. res.set_content("id: 42\n\n", "text/event-stream");
  19265. } else {
  19266. res.set_content("data: " + req.get_header_value("Last-Event-ID") +
  19267. "\n\nevent: end\ndata: end\n\n",
  19268. "text/event-stream");
  19269. }
  19270. });
  19271. auto msgs = collect("/id-only");
  19272. ASSERT_EQ(msgs.size(), 1u);
  19273. EXPECT_EQ(msgs[0].data, "42");
  19274. }
  19275. TEST_F(SSEParsingTest, EmptyEventIdClearsLastEventId) {
  19276. // The first connection sets an id and then clears it with an empty one; the
  19277. // second reports whether it was reconnected with a Last-Event-ID
  19278. std::atomic<int> connection_count{0};
  19279. server_->Get("/id-clear", [&](const Request &req, Response &res) {
  19280. if (connection_count++ == 0) {
  19281. res.set_content("id: 1\ndata: first\n\nid:\ndata: second\n\n",
  19282. "text/event-stream");
  19283. } else {
  19284. res.set_content(
  19285. std::string("data: ") +
  19286. (req.has_header("Last-Event-ID") ? "sent" : "not sent") +
  19287. "\n\nevent: end\ndata: end\n\n",
  19288. "text/event-stream");
  19289. }
  19290. });
  19291. auto msgs = collect("/id-clear");
  19292. ASSERT_EQ(msgs.size(), 3u);
  19293. EXPECT_EQ(msgs[0].id, "1");
  19294. EXPECT_EQ(msgs[1].id, "");
  19295. EXPECT_EQ(msgs[2].data, "not sent");
  19296. }
  19297. TEST_F(SSEParsingTest, UnsendableEventIdKeepsLastEventId) {
  19298. // The first connection sets an id and then sends ids that cannot be carried
  19299. // in a header; the second echoes back the Last-Event-ID it was reconnected
  19300. // with
  19301. std::atomic<int> connection_count{0};
  19302. server_->Get("/id-unsendable", [&](const Request &req, Response &res) {
  19303. if (connection_count++ == 0) {
  19304. res.set_content(std::string("id: 42\n\nid: a") + '\0' +
  19305. "b\n\nid: \x01\n\nid: 7\n\nid: 7 \n\n",
  19306. "text/event-stream");
  19307. } else {
  19308. res.set_content("data: " + req.get_header_value("Last-Event-ID") +
  19309. "\n\nevent: end\ndata: end\n\n",
  19310. "text/event-stream");
  19311. }
  19312. });
  19313. auto msgs = collect("/id-unsendable");
  19314. ASSERT_EQ(msgs.size(), 1u);
  19315. EXPECT_EQ(msgs[0].data, "42");
  19316. }
  19317. TEST_F(SSEParsingTest, CompleteEventParsing) {
  19318. auto msgs = parse("event: notification\nid: evt-42\n"
  19319. "data: {\"type\":\"alert\"}\nretry: 1000\n\n");
  19320. ASSERT_EQ(msgs.size(), 1u);
  19321. EXPECT_EQ(msgs[0].event, "notification");
  19322. EXPECT_EQ(msgs[0].id, "evt-42");
  19323. EXPECT_EQ(msgs[0].data, "{\"type\":\"alert\"}");
  19324. }
  19325. TEST(SSEMessageTest, Clear) {
  19326. sse::SSEMessage msg;
  19327. msg.event = "custom";
  19328. msg.data = "some data";
  19329. msg.id = "123";
  19330. msg.clear();
  19331. EXPECT_EQ(msg.event, "message");
  19332. EXPECT_EQ(msg.data, "");
  19333. EXPECT_EQ(msg.id, "");
  19334. }
  19335. //==============================================================================
  19336. // SSE Integration Tests
  19337. //==============================================================================
  19338. // Test: Successful connection and on_open callback
  19339. TEST_F(SSEIntegrationTest, SuccessfulConnection) {
  19340. // Add a simple endpoint that sends one event and closes
  19341. server_->Get("/simple-event", [](const Request &, Response &res) {
  19342. res.set_chunked_content_provider(
  19343. "text/event-stream", [](size_t offset, DataSink &sink) {
  19344. if (offset == 0) {
  19345. std::string event = "data: hello\n\n";
  19346. sink.write(event.data(), event.size());
  19347. }
  19348. return false; // Close stream after sending
  19349. });
  19350. });
  19351. Client client("localhost", get_port());
  19352. sse::SSEClient sse(client, "/simple-event");
  19353. std::atomic<bool> open_called{false};
  19354. std::atomic<bool> message_received{false};
  19355. sse.on_open([&open_called]() { open_called.store(true); });
  19356. sse.on_message([&message_received](const sse::SSEMessage &msg) {
  19357. if (msg.data == "hello") { message_received.store(true); }
  19358. });
  19359. sse.set_reconnect_interval(100);
  19360. sse.set_max_reconnect_attempts(1);
  19361. // Start async
  19362. sse.start_async();
  19363. // Wait for message to be processed
  19364. std::this_thread::sleep_for(std::chrono::milliseconds(500));
  19365. sse.stop();
  19366. EXPECT_TRUE(open_called.load());
  19367. EXPECT_TRUE(message_received.load());
  19368. }
  19369. // Test: on_message callback
  19370. TEST_F(SSEIntegrationTest, OnMessageCallback) {
  19371. // Endpoint that sends multiple events then closes
  19372. server_->Get("/multi-event", [](const Request &, Response &res) {
  19373. res.set_chunked_content_provider(
  19374. "text/event-stream", [](size_t offset, DataSink &sink) {
  19375. if (offset == 0) {
  19376. std::string events = "data: message1\n\ndata: message2\n\n";
  19377. sink.write(events.data(), events.size());
  19378. }
  19379. return false;
  19380. });
  19381. });
  19382. Client client("localhost", get_port());
  19383. sse::SSEClient sse(client, "/multi-event");
  19384. std::vector<std::string> received_messages;
  19385. std::mutex messages_mutex;
  19386. sse.on_message([&](const sse::SSEMessage &msg) {
  19387. std::lock_guard<std::mutex> lock(messages_mutex);
  19388. received_messages.push_back(msg.data);
  19389. });
  19390. sse.set_reconnect_interval(100);
  19391. sse.set_max_reconnect_attempts(1);
  19392. sse.start_async();
  19393. std::this_thread::sleep_for(std::chrono::milliseconds(500));
  19394. sse.stop();
  19395. std::lock_guard<std::mutex> lock(messages_mutex);
  19396. EXPECT_GE(received_messages.size(), 2u);
  19397. if (received_messages.size() >= 2) {
  19398. EXPECT_EQ(received_messages[0], "message1");
  19399. EXPECT_EQ(received_messages[1], "message2");
  19400. }
  19401. }
  19402. // Test: on_event for specific types
  19403. TEST_F(SSEIntegrationTest, OnEventForSpecificTypes) {
  19404. Client client("localhost", get_port());
  19405. sse::SSEClient sse(client, "/custom-events");
  19406. std::atomic<bool> update_received{false};
  19407. std::atomic<bool> delete_received{false};
  19408. sse.on_event("update", [&update_received](const sse::SSEMessage &msg) {
  19409. if (msg.data == "updated") { update_received.store(true); }
  19410. });
  19411. sse.on_event("delete", [&delete_received](const sse::SSEMessage &msg) {
  19412. if (msg.data == "deleted") { delete_received.store(true); }
  19413. });
  19414. sse.set_max_reconnect_attempts(1);
  19415. sse.start_async();
  19416. std::this_thread::sleep_for(std::chrono::milliseconds(300));
  19417. sse.stop();
  19418. EXPECT_TRUE(update_received.load());
  19419. EXPECT_TRUE(delete_received.load());
  19420. }
  19421. // Test: on_error callback on connection failure
  19422. TEST_F(SSEIntegrationTest, OnErrorCallback) {
  19423. // Connect to a non-existent port
  19424. Client client("localhost", 59999);
  19425. sse::SSEClient sse(client, "/events");
  19426. std::atomic<bool> error_called{false};
  19427. Error received_error = Error::Success;
  19428. sse.on_error([&](Error err) {
  19429. error_called.store(true);
  19430. received_error = err;
  19431. });
  19432. sse.set_reconnect_interval(50);
  19433. sse.set_max_reconnect_attempts(1);
  19434. sse.start_async();
  19435. std::this_thread::sleep_for(std::chrono::milliseconds(200));
  19436. sse.stop();
  19437. EXPECT_TRUE(error_called.load());
  19438. EXPECT_NE(received_error, Error::Success);
  19439. }
  19440. // Test: Last-Event-ID header sent on reconnect
  19441. TEST_F(SSEIntegrationTest, LastEventIdHeader) {
  19442. // Endpoint that sends event with ID
  19443. server_->Get("/event-with-id", [](const Request &, Response &res) {
  19444. res.set_chunked_content_provider(
  19445. "text/event-stream", [](size_t offset, DataSink &sink) {
  19446. if (offset == 0) {
  19447. std::string event = "id: evt-123\ndata: test\n\n";
  19448. sink.write(event.data(), event.size());
  19449. }
  19450. return false;
  19451. });
  19452. });
  19453. Client client("localhost", get_port());
  19454. sse::SSEClient sse(client, "/event-with-id");
  19455. std::atomic<bool> id_received{false};
  19456. sse.on_message([&](const sse::SSEMessage &msg) {
  19457. if (!msg.id.empty()) { id_received.store(true); }
  19458. });
  19459. sse.set_reconnect_interval(100);
  19460. sse.set_max_reconnect_attempts(1);
  19461. sse.start_async();
  19462. std::this_thread::sleep_for(std::chrono::milliseconds(500));
  19463. sse.stop();
  19464. EXPECT_TRUE(id_received.load());
  19465. EXPECT_EQ(sse.last_event_id(), "evt-123");
  19466. }
  19467. // Test: Manual stop
  19468. TEST_F(SSEIntegrationTest, ManualStop) {
  19469. // Endpoint that sends one event and stays open briefly
  19470. std::atomic<bool> handler_running{true};
  19471. server_->Get("/stay-open", [&handler_running](const Request &,
  19472. Response &res) {
  19473. res.set_chunked_content_provider(
  19474. "text/event-stream", [&handler_running](size_t offset, DataSink &sink) {
  19475. if (offset == 0) {
  19476. std::string event = "data: connected\n\n";
  19477. sink.write(event.data(), event.size());
  19478. }
  19479. // Keep connection open while handler_running is true
  19480. for (int i = 0; i < 10 && handler_running.load(); ++i) {
  19481. std::this_thread::sleep_for(std::chrono::milliseconds(50));
  19482. }
  19483. return false;
  19484. });
  19485. });
  19486. Client client("localhost", get_port());
  19487. sse::SSEClient sse(client, "/stay-open");
  19488. std::atomic<bool> connected{false};
  19489. sse.on_open([&connected]() { connected.store(true); });
  19490. sse.set_reconnect_interval(100);
  19491. sse.set_max_reconnect_attempts(1);
  19492. sse.start_async();
  19493. // Wait for connection to establish
  19494. for (int i = 0; i < 20 && !connected.load(); ++i) {
  19495. std::this_thread::sleep_for(std::chrono::milliseconds(50));
  19496. }
  19497. EXPECT_TRUE(connected.load());
  19498. EXPECT_TRUE(sse.is_connected());
  19499. // Signal handler to stop
  19500. handler_running.store(false);
  19501. // Stop SSE client
  19502. sse.stop();
  19503. EXPECT_FALSE(sse.is_connected());
  19504. }
  19505. // Test: SSEClient with custom headers
  19506. TEST_F(SSEIntegrationTest, CustomHeaders) {
  19507. // Setup a server endpoint that checks for custom header
  19508. std::atomic<bool> header_received{false};
  19509. server_->Get("/header-check", [&](const Request &req, Response &res) {
  19510. if (req.get_header_value("X-Custom-Header") == "custom-value") {
  19511. header_received.store(true);
  19512. }
  19513. res.set_chunked_content_provider("text/event-stream",
  19514. [](size_t, DataSink &) { return false; });
  19515. });
  19516. Client client("localhost", get_port());
  19517. Headers headers = {{"X-Custom-Header", "custom-value"}};
  19518. sse::SSEClient sse(client, "/header-check", headers);
  19519. sse.set_max_reconnect_attempts(1);
  19520. sse.start_async();
  19521. std::this_thread::sleep_for(std::chrono::milliseconds(200));
  19522. sse.stop();
  19523. EXPECT_TRUE(header_received.load());
  19524. }
  19525. // Test: Reconnect interval configuration
  19526. TEST_F(SSEIntegrationTest, ReconnectIntervalConfiguration) {
  19527. Client client("localhost", get_port());
  19528. sse::SSEClient sse(client, "/events");
  19529. auto &result = sse.set_reconnect_interval(500);
  19530. // Builder pattern should return reference to self
  19531. EXPECT_EQ(&result, &sse);
  19532. }
  19533. // Test: Max reconnect attempts
  19534. TEST_F(SSEIntegrationTest, MaxReconnectAttempts) {
  19535. // Connect to non-existent port to force reconnects
  19536. Client client("localhost", 59998);
  19537. sse::SSEClient sse(client, "/events");
  19538. std::atomic<int> error_count{0};
  19539. sse.on_error([&](Error) { error_count.fetch_add(1); });
  19540. sse.set_reconnect_interval(50);
  19541. sse.set_max_reconnect_attempts(2);
  19542. auto start = std::chrono::steady_clock::now();
  19543. sse.start(); // Blocking call
  19544. auto end = std::chrono::steady_clock::now();
  19545. // Should have stopped after 2 failed attempts
  19546. EXPECT_GE(error_count.load(), 2);
  19547. // Should not have taken too long (max 2 attempts * 50ms + overhead)
  19548. auto duration =
  19549. std::chrono::duration_cast<std::chrono::milliseconds>(end - start);
  19550. #ifdef _WIN32
  19551. // Windows is much slower for socket connection failures
  19552. EXPECT_LT(duration.count(), 7000);
  19553. #else
  19554. EXPECT_LT(duration.count(), 1000);
  19555. #endif
  19556. }
  19557. // Test: Multi-line data in integration
  19558. TEST_F(SSEIntegrationTest, MultiLineDataIntegration) {
  19559. // Endpoint with multi-line data
  19560. server_->Get("/multiline-data", [](const Request &, Response &res) {
  19561. res.set_chunked_content_provider(
  19562. "text/event-stream", [](size_t offset, DataSink &sink) {
  19563. if (offset == 0) {
  19564. std::string event = "data: line1\ndata: line2\ndata: line3\n\n";
  19565. sink.write(event.data(), event.size());
  19566. }
  19567. return false;
  19568. });
  19569. });
  19570. Client client("localhost", get_port());
  19571. sse::SSEClient sse(client, "/multiline-data");
  19572. std::string received_data;
  19573. std::mutex data_mutex;
  19574. sse.on_message([&](const sse::SSEMessage &msg) {
  19575. std::lock_guard<std::mutex> lock(data_mutex);
  19576. received_data = msg.data;
  19577. });
  19578. sse.set_reconnect_interval(100);
  19579. sse.set_max_reconnect_attempts(1);
  19580. sse.start_async();
  19581. std::this_thread::sleep_for(std::chrono::milliseconds(500));
  19582. sse.stop();
  19583. std::lock_guard<std::mutex> lock(data_mutex);
  19584. EXPECT_EQ(received_data, "line1\nline2\nline3");
  19585. }
  19586. TEST_F(SSEIntegrationTest, EmptyDataLines) {
  19587. server_->Get("/empty-data-lines", [](const Request &, Response &res) {
  19588. res.set_chunked_content_provider("text/event-stream", [](size_t offset,
  19589. DataSink &sink) {
  19590. if (offset == 0) {
  19591. const std::string events = "data:\n\ndata:\ndata: hello\n\ndata\n\n";
  19592. sink.write(events.data(), events.size());
  19593. }
  19594. return false;
  19595. });
  19596. });
  19597. Client client("localhost", get_port());
  19598. sse::SSEClient sse(client, "/empty-data-lines");
  19599. std::mutex mutex;
  19600. std::condition_variable cv;
  19601. std::vector<std::string> received;
  19602. sse.on_message([&](const sse::SSEMessage &msg) {
  19603. std::lock_guard<std::mutex> lock(mutex);
  19604. received.push_back(msg.data);
  19605. cv.notify_all();
  19606. });
  19607. sse.set_max_reconnect_attempts(1);
  19608. sse.start_async();
  19609. {
  19610. std::unique_lock<std::mutex> lock(mutex);
  19611. cv.wait_for(lock, std::chrono::seconds(2),
  19612. [&] { return received.size() >= 3; });
  19613. }
  19614. sse.stop();
  19615. ASSERT_GE(received.size(), 3u);
  19616. EXPECT_EQ(received[0], "");
  19617. EXPECT_EQ(received[1], "\nhello");
  19618. EXPECT_EQ(received[2], "");
  19619. }
  19620. // Test: Auto-reconnect after server disconnection
  19621. TEST_F(SSEIntegrationTest, AutoReconnectAfterDisconnect) {
  19622. std::atomic<int> connection_count{0};
  19623. std::atomic<int> message_count{0};
  19624. // Endpoint that sends one event and closes, forcing reconnect
  19625. server_->Get("/reconnect-test",
  19626. [&connection_count](const Request &, Response &res) {
  19627. connection_count.fetch_add(1);
  19628. res.set_chunked_content_provider(
  19629. "text/event-stream", [](size_t offset, DataSink &sink) {
  19630. if (offset == 0) {
  19631. std::string event = "data: hello\n\n";
  19632. sink.write(event.data(), event.size());
  19633. }
  19634. return false; // Close connection after sending
  19635. });
  19636. });
  19637. Client client("localhost", get_port());
  19638. sse::SSEClient sse(client, "/reconnect-test");
  19639. sse.on_message([&message_count](const sse::SSEMessage &) {
  19640. message_count.fetch_add(1);
  19641. });
  19642. sse.set_reconnect_interval(100);
  19643. sse.set_max_reconnect_attempts(3);
  19644. sse.start_async();
  19645. // Wait long enough for multiple reconnects
  19646. std::this_thread::sleep_for(std::chrono::milliseconds(800));
  19647. sse.stop();
  19648. // Should have connected multiple times (initial + reconnects)
  19649. EXPECT_GE(connection_count.load(), 2);
  19650. // Should have received messages from multiple connections
  19651. EXPECT_GE(message_count.load(), 2);
  19652. }
  19653. // Test: A retry field that is not all ASCII digits is ignored
  19654. TEST_F(SSEIntegrationTest, NonDigitRetryFieldIgnored) {
  19655. std::atomic<int> connection_count{0};
  19656. server_->Get("/bad-retry",
  19657. [&connection_count](const Request &, Response &res) {
  19658. connection_count.fetch_add(1);
  19659. res.set_chunked_content_provider(
  19660. "text/event-stream", [](size_t offset, DataSink &sink) {
  19661. if (offset == 0) {
  19662. std::string event = "retry: -1\ndata: hello\n\n";
  19663. sink.write(event.data(), event.size());
  19664. }
  19665. return false;
  19666. });
  19667. });
  19668. Client client("localhost", get_port());
  19669. sse::SSEClient sse(client, "/bad-retry");
  19670. sse.set_reconnect_interval(10000);
  19671. sse.start_async();
  19672. std::this_thread::sleep_for(std::chrono::milliseconds(500));
  19673. sse.stop();
  19674. EXPECT_EQ(connection_count.load(), 1);
  19675. }
  19676. // Test: A retry field of all ASCII digits sets the reconnection time
  19677. TEST_F(SSEIntegrationTest, DigitRetryFieldApplied) {
  19678. std::atomic<int> connection_count{0};
  19679. server_->Get("/zero-retry",
  19680. [&connection_count](const Request &, Response &res) {
  19681. connection_count.fetch_add(1);
  19682. res.set_chunked_content_provider(
  19683. "text/event-stream", [](size_t offset, DataSink &sink) {
  19684. if (offset == 0) {
  19685. std::string event = "retry: 0\ndata: hello\n\n";
  19686. sink.write(event.data(), event.size());
  19687. }
  19688. return false;
  19689. });
  19690. });
  19691. Client client("localhost", get_port());
  19692. sse::SSEClient sse(client, "/zero-retry");
  19693. sse.set_reconnect_interval(10000);
  19694. sse.start_async();
  19695. std::this_thread::sleep_for(std::chrono::milliseconds(500));
  19696. sse.stop();
  19697. // The server-supplied interval is applied, but never below 100ms, so
  19698. // "retry: 0" does not cause a busy reconnect loop
  19699. EXPECT_GE(connection_count.load(), 2);
  19700. EXPECT_LE(connection_count.load(), 10);
  19701. }
  19702. // Test: Last-Event-ID sent on reconnect
  19703. TEST_F(SSEIntegrationTest, LastEventIdSentOnReconnect) {
  19704. std::atomic<int> connection_count{0};
  19705. std::vector<std::string> received_last_event_ids;
  19706. std::mutex id_mutex;
  19707. // Endpoint that checks Last-Event-ID header and sends event with ID
  19708. server_->Get("/reconnect-with-id", [&](const Request &req, Response &res) {
  19709. int conn = connection_count.fetch_add(1);
  19710. // Capture the Last-Event-ID header from each connection
  19711. {
  19712. std::lock_guard<std::mutex> lock(id_mutex);
  19713. received_last_event_ids.push_back(req.get_header_value("Last-Event-ID"));
  19714. }
  19715. res.set_chunked_content_provider(
  19716. "text/event-stream", [conn](size_t offset, DataSink &sink) {
  19717. if (offset == 0) {
  19718. std::string event =
  19719. "id: event-" + std::to_string(conn) + "\ndata: msg\n\n";
  19720. sink.write(event.data(), event.size());
  19721. }
  19722. return false;
  19723. });
  19724. });
  19725. Client client("localhost", get_port());
  19726. sse::SSEClient sse(client, "/reconnect-with-id");
  19727. sse.set_reconnect_interval(100);
  19728. sse.set_max_reconnect_attempts(3);
  19729. sse.start_async();
  19730. // Wait for at least 2 connections
  19731. std::this_thread::sleep_for(std::chrono::milliseconds(500));
  19732. sse.stop();
  19733. // Verify behavior
  19734. std::lock_guard<std::mutex> lock(id_mutex);
  19735. EXPECT_GE(received_last_event_ids.size(), 2u);
  19736. // First connection should have no Last-Event-ID
  19737. if (!received_last_event_ids.empty()) {
  19738. EXPECT_EQ(received_last_event_ids[0], "");
  19739. }
  19740. // Second connection should have Last-Event-ID from first connection
  19741. if (received_last_event_ids.size() >= 2) {
  19742. EXPECT_EQ(received_last_event_ids[1], "event-0");
  19743. }
  19744. }
  19745. // Test: set_headers updates headers used on reconnect
  19746. TEST_F(SSEIntegrationTest, SetHeadersUpdatesOnReconnect) {
  19747. std::vector<std::string> received_tokens;
  19748. std::mutex token_mutex;
  19749. // Endpoint that captures Authorization header
  19750. server_->Get("/auth-check", [&](const Request &req, Response &res) {
  19751. {
  19752. std::lock_guard<std::mutex> lock(token_mutex);
  19753. received_tokens.push_back(req.get_header_value("Authorization"));
  19754. }
  19755. res.set_chunked_content_provider(
  19756. "text/event-stream", [](size_t offset, DataSink &sink) {
  19757. if (offset == 0) {
  19758. std::string event = "data: hello\n\n";
  19759. sink.write(event.data(), event.size());
  19760. }
  19761. return false; // Close connection to trigger reconnect
  19762. });
  19763. });
  19764. Client client("localhost", get_port());
  19765. Headers headers = {{"Authorization", "Bearer old-token"}};
  19766. sse::SSEClient sse(client, "/auth-check", headers);
  19767. // Update headers on each successful connection
  19768. sse.on_open(
  19769. [&sse]() { sse.set_headers({{"Authorization", "Bearer new-token"}}); });
  19770. sse.set_reconnect_interval(100);
  19771. sse.set_max_reconnect_attempts(3);
  19772. sse.start_async();
  19773. std::this_thread::sleep_for(std::chrono::milliseconds(800));
  19774. sse.stop();
  19775. std::lock_guard<std::mutex> lock(token_mutex);
  19776. ASSERT_GE(received_tokens.size(), 2u);
  19777. // First connection uses original header
  19778. EXPECT_EQ(received_tokens[0], "Bearer old-token");
  19779. // Second connection uses updated header from set_headers
  19780. EXPECT_EQ(received_tokens[1], "Bearer new-token");
  19781. }
  19782. // Test: 401 allows reconnection (so on_error can refresh headers)
  19783. TEST_F(SSEIntegrationTest, ReconnectOn401WithHeaderRefresh) {
  19784. std::atomic<int> connection_count{0};
  19785. // Endpoint: returns 401 on first attempt, 200 on second
  19786. server_->Get("/auth-retry", [&](const Request &req, Response &res) {
  19787. int conn = connection_count.fetch_add(1);
  19788. if (conn == 0 || req.get_header_value("Authorization") != "Bearer valid") {
  19789. res.status = StatusCode::Unauthorized_401;
  19790. res.set_content("Unauthorized", "text/plain");
  19791. return;
  19792. }
  19793. res.set_chunked_content_provider(
  19794. "text/event-stream", [](size_t offset, DataSink &sink) {
  19795. if (offset == 0) {
  19796. std::string event = "data: authenticated\n\n";
  19797. sink.write(event.data(), event.size());
  19798. }
  19799. return false;
  19800. });
  19801. });
  19802. Client client("localhost", get_port());
  19803. Headers headers = {{"Authorization", "Bearer expired"}};
  19804. sse::SSEClient sse(client, "/auth-retry", headers);
  19805. std::atomic<bool> message_received{false};
  19806. // Refresh token on error
  19807. sse.on_error(
  19808. [&sse](Error) { sse.set_headers({{"Authorization", "Bearer valid"}}); });
  19809. sse.on_message([&](const sse::SSEMessage &msg) {
  19810. if (msg.data == "authenticated") { message_received.store(true); }
  19811. });
  19812. sse.set_reconnect_interval(100);
  19813. sse.set_max_reconnect_attempts(3);
  19814. sse.start_async();
  19815. std::this_thread::sleep_for(std::chrono::milliseconds(800));
  19816. sse.stop();
  19817. // Should have reconnected after 401 and succeeded with new token
  19818. EXPECT_GE(connection_count.load(), 2);
  19819. EXPECT_TRUE(message_received.load());
  19820. }
  19821. TEST(Issue2318Test, EmptyHostString) {
  19822. {
  19823. httplib::Client cli_empty("", PORT);
  19824. auto res = cli_empty.Get("/");
  19825. ASSERT_FALSE(res);
  19826. EXPECT_EQ(httplib::Error::Connection, res.error());
  19827. }
  19828. {
  19829. httplib::Client cli(" ", PORT);
  19830. auto res = cli.Get("/");
  19831. ASSERT_FALSE(res);
  19832. EXPECT_EQ(httplib::Error::Connection, res.error());
  19833. }
  19834. }
  19835. #ifdef CPPHTTPLIB_ZLIB_SUPPORT
  19836. TEST(ZipBombProtectionTest, DecompressedSizeExceedsLimit) {
  19837. Server svr;
  19838. // Set a small payload limit (1KB)
  19839. svr.set_payload_max_length(1024);
  19840. svr.Post("/test", [&](const Request &req, Response &res) {
  19841. res.set_content("Body size: " + std::to_string(req.body.size()),
  19842. "text/plain");
  19843. });
  19844. auto listen_thread = std::thread([&]() { svr.listen(HOST, PORT); });
  19845. auto se = detail::scope_exit([&] {
  19846. svr.stop();
  19847. listen_thread.join();
  19848. });
  19849. svr.wait_until_ready();
  19850. // Create data that compresses well but exceeds limit when decompressed
  19851. // 8KB of repeated null bytes compresses to a very small size
  19852. std::string original_data(8 * 1024, '\0');
  19853. // Compress the data using gzip
  19854. std::string compressed_data;
  19855. detail::gzip_compressor compressor;
  19856. compressor.compress(original_data.data(), original_data.size(), true,
  19857. [&](const char *data, size_t size) {
  19858. compressed_data.append(data, size);
  19859. return true;
  19860. });
  19861. // Verify compression worked (compressed should be much smaller)
  19862. ASSERT_LT(compressed_data.size(), original_data.size());
  19863. ASSERT_LT(compressed_data.size(), 1024u); // Compressed fits in limit
  19864. // Send compressed data with Content-Encoding: gzip
  19865. Client cli(HOST, PORT);
  19866. Headers headers = {{"Content-Encoding", "gzip"}};
  19867. auto res =
  19868. cli.Post("/test", headers, compressed_data, "application/octet-stream");
  19869. // Server should reject because decompressed size (8KB) exceeds limit (1KB)
  19870. ASSERT_TRUE(res) << "Error: " << to_string(res.error());
  19871. EXPECT_EQ(StatusCode::PayloadTooLarge_413, res->status);
  19872. }
  19873. #endif
  19874. // ============================================================================
  19875. // OpenSSL-Specific Tests
  19876. // ============================================================================
  19877. #ifdef CPPHTTPLIB_OPENSSL_SUPPORT
  19878. X509 *readCertificate(const std::string &strFileName) {
  19879. std::ifstream inStream(strFileName);
  19880. std::string strCertPEM((std::istreambuf_iterator<char>(inStream)),
  19881. std::istreambuf_iterator<char>());
  19882. if (strCertPEM.empty()) return (nullptr);
  19883. BIO *pbCert = BIO_new(BIO_s_mem());
  19884. BIO_write(pbCert, strCertPEM.c_str(), (int)strCertPEM.size());
  19885. X509 *pCert = PEM_read_bio_X509(pbCert, NULL, 0, NULL);
  19886. BIO_free(pbCert);
  19887. return (pCert);
  19888. }
  19889. EVP_PKEY *readPrivateKey(const std::string &strFileName) {
  19890. std::ifstream inStream(strFileName);
  19891. std::string strPrivateKeyPEM((std::istreambuf_iterator<char>(inStream)),
  19892. std::istreambuf_iterator<char>());
  19893. if (strPrivateKeyPEM.empty()) return (nullptr);
  19894. BIO *pbPrivKey = BIO_new(BIO_s_mem());
  19895. BIO_write(pbPrivKey, strPrivateKeyPEM.c_str(), (int)strPrivateKeyPEM.size());
  19896. EVP_PKEY *pPrivateKey = PEM_read_bio_PrivateKey(pbPrivKey, NULL, NULL, NULL);
  19897. BIO_free(pbPrivKey);
  19898. return (pPrivateKey);
  19899. }
  19900. TEST(BindServerTest, UpdateCerts) {
  19901. SSLServer svr(SERVER_CERT_FILE, SERVER_PRIVATE_KEY_FILE, CLIENT_CA_CERT_FILE);
  19902. int port = svr.bind_to_any_port("0.0.0.0");
  19903. ASSERT_TRUE(svr.is_valid());
  19904. ASSERT_TRUE(port > 0);
  19905. X509 *cert = readCertificate(SERVER_CERT_FILE);
  19906. X509 *ca_cert = readCertificate(CLIENT_CA_CERT_FILE);
  19907. EVP_PKEY *key = readPrivateKey(SERVER_PRIVATE_KEY_FILE);
  19908. ASSERT_TRUE(cert != nullptr);
  19909. ASSERT_TRUE(ca_cert != nullptr);
  19910. ASSERT_TRUE(key != nullptr);
  19911. X509_STORE *cert_store = X509_STORE_new();
  19912. X509_STORE_add_cert(cert_store, ca_cert);
  19913. // svr.update_certs(cert, key, cert_store); // deprecated
  19914. svr.update_certs_pem(SERVER_CERT_FILE, SERVER_PRIVATE_KEY_FILE,
  19915. CLIENT_CA_CERT_FILE);
  19916. ASSERT_TRUE(svr.is_valid());
  19917. svr.stop();
  19918. X509_STORE_free(cert_store);
  19919. X509_free(cert);
  19920. X509_free(ca_cert);
  19921. EVP_PKEY_free(key);
  19922. }
  19923. // Test that update_certs() updates client CA list correctly
  19924. TEST(SSLClientServerTest, UpdateCertsSetsClientCAList) {
  19925. // Start with file-based constructor
  19926. SSLServer svr(SERVER_CERT_FILE, SERVER_PRIVATE_KEY_FILE);
  19927. ASSERT_TRUE(svr.is_valid());
  19928. // Initially no client CA list should be set
  19929. auto ssl_ctx = static_cast<SSL_CTX *>(svr.tls_context());
  19930. ASSERT_TRUE(ssl_ctx != nullptr);
  19931. STACK_OF(X509_NAME) *ca_list_before = SSL_CTX_get_client_CA_list(ssl_ctx);
  19932. int count_before = ca_list_before ? sk_X509_NAME_num(ca_list_before) : 0;
  19933. EXPECT_EQ(0, count_before);
  19934. // Now update with client CA (PEM string)
  19935. std::string cert_pem, key_pem, ca_pem;
  19936. read_file(SERVER_CERT_FILE, cert_pem);
  19937. read_file(SERVER_PRIVATE_KEY_FILE, key_pem);
  19938. read_file(CLIENT_CA_CERT_FILE, ca_pem);
  19939. svr.update_certs_pem(cert_pem.c_str(), key_pem.c_str(), ca_pem.c_str());
  19940. ASSERT_TRUE(svr.is_valid());
  19941. // Now client CA list should be set
  19942. STACK_OF(X509_NAME) *ca_list_after = SSL_CTX_get_client_CA_list(ssl_ctx);
  19943. ASSERT_TRUE(ca_list_after != nullptr);
  19944. EXPECT_GT(sk_X509_NAME_num(ca_list_after), 0);
  19945. }
  19946. TEST(SSLClientServerTest, FilePathConstructorSetsClientCAList) {
  19947. // Test that the file-path SSLServer constructor properly sets the client CA
  19948. // list that is sent to clients during the TLS handshake (CertificateRequest)
  19949. SSLServer svr(SERVER_CERT_FILE, SERVER_PRIVATE_KEY_FILE, CLIENT_CA_CERT_FILE);
  19950. ASSERT_TRUE(svr.is_valid());
  19951. auto ssl_ctx = static_cast<SSL_CTX *>(svr.tls_context());
  19952. ASSERT_TRUE(ssl_ctx != nullptr);
  19953. STACK_OF(X509_NAME) *ca_list = SSL_CTX_get_client_CA_list(ssl_ctx);
  19954. ASSERT_TRUE(ca_list != nullptr);
  19955. EXPECT_GT(sk_X509_NAME_num(ca_list), 0);
  19956. }
  19957. #endif
  19958. // ============================================================================
  19959. // MbedTLS-Specific Tests
  19960. // ============================================================================
  19961. #ifdef CPPHTTPLIB_MBEDTLS_SUPPORT
  19962. TEST(SSLClientServerTest, CustomizeServerSSLCtxMbedTLS) {
  19963. using namespace httplib::tls;
  19964. // Track if callback was invoked
  19965. bool callback_invoked = false;
  19966. // The callback receives void* ctx which is actually MbedTlsContext*
  19967. // We can access the mbedtls_ssl_config via the context
  19968. auto setup_callback = [&callback_invoked](void *ctx) {
  19969. callback_invoked = true;
  19970. // Cast to MbedTlsContext* to access the ssl config
  19971. auto *mbedtls_ctx = static_cast<httplib::tls::impl::MbedTlsContext *>(ctx);
  19972. mbedtls_ssl_config *conf = &mbedtls_ctx->conf;
  19973. // Use static variables to hold certificate data (simplified for test)
  19974. static mbedtls_x509_crt own_cert;
  19975. static mbedtls_pk_context own_key;
  19976. static mbedtls_x509_crt ca_chain;
  19977. static bool initialized = false;
  19978. if (!initialized) {
  19979. mbedtls_x509_crt_init(&own_cert);
  19980. mbedtls_pk_init(&own_key);
  19981. mbedtls_x509_crt_init(&ca_chain);
  19982. // Load server certificate
  19983. if (mbedtls_x509_crt_parse_file(&own_cert, SERVER_CERT_FILE) != 0) {
  19984. return false;
  19985. }
  19986. // Load server private key.
  19987. // Mbed TLS 3.x takes an RNG callback here; 2.x and 4.x do not.
  19988. if (mbedtls_pk_parse_keyfile(&own_key, SERVER_PRIVATE_KEY_FILE, nullptr
  19989. #if MBEDTLS_VERSION_MAJOR == 3
  19990. ,
  19991. mbedtls_ctr_drbg_random, nullptr
  19992. #endif
  19993. ) != 0) {
  19994. return false;
  19995. }
  19996. // Load CA chain for client verification
  19997. if (mbedtls_x509_crt_parse_file(&ca_chain, CLIENT_CA_CERT_FILE) != 0) {
  19998. return false;
  19999. }
  20000. initialized = true;
  20001. }
  20002. // Configure the SSL config
  20003. mbedtls_ssl_conf_own_cert(conf, &own_cert, &own_key);
  20004. mbedtls_ssl_conf_ca_chain(conf, &ca_chain, nullptr);
  20005. mbedtls_ssl_conf_authmode(conf, MBEDTLS_SSL_VERIFY_REQUIRED);
  20006. // Set minimum TLS version using mbedTLS native API
  20007. #if MBEDTLS_VERSION_MAJOR >= 3
  20008. mbedtls_ssl_conf_min_tls_version(conf, MBEDTLS_SSL_VERSION_TLS1_2);
  20009. #else
  20010. mbedtls_ssl_conf_min_version(conf, MBEDTLS_SSL_MAJOR_VERSION_3,
  20011. MBEDTLS_SSL_MINOR_VERSION_3);
  20012. #endif
  20013. return true;
  20014. };
  20015. SSLServer svr(setup_callback);
  20016. ASSERT_TRUE(svr.is_valid());
  20017. ASSERT_TRUE(callback_invoked);
  20018. svr.Get("/test", [&](const Request &req, Response &res) {
  20019. res.set_content("test", "text/plain");
  20020. auto cert = req.peer_cert();
  20021. ASSERT_TRUE(static_cast<bool>(cert));
  20022. auto common_name = cert.subject_cn();
  20023. EXPECT_EQ("Common Name", common_name);
  20024. });
  20025. thread t = thread([&]() { ASSERT_TRUE(svr.listen(HOST, PORT)); });
  20026. auto se = detail::scope_exit([&] {
  20027. svr.stop();
  20028. t.join();
  20029. ASSERT_FALSE(svr.is_running());
  20030. });
  20031. svr.wait_until_ready();
  20032. SSLClient cli(HOST, PORT, CLIENT_CERT_FILE, CLIENT_PRIVATE_KEY_FILE);
  20033. cli.enable_server_certificate_verification(false);
  20034. cli.set_connection_timeout(30);
  20035. auto res = cli.Get("/test");
  20036. ASSERT_TRUE(res) << "Error: " << to_string(res.error());
  20037. ASSERT_EQ(StatusCode::OK_200, res->status);
  20038. }
  20039. // Regression test for a use-after-free where ~SSLClient freed the mbedTLS
  20040. // context (owning mbedtls_ssl_config) before shutting down a still-open
  20041. // keep-alive SSL session, which reads through that config in
  20042. // mbedtls_ssl_close_notify.
  20043. TEST(SSLClientServerTest, DestructWithLiveKeepAliveSessionMbedTLS) {
  20044. SSLServer svr(SERVER_CERT_FILE, SERVER_PRIVATE_KEY_FILE);
  20045. ASSERT_TRUE(svr.is_valid());
  20046. svr.Get("/test", [&](const Request & /*req*/, Response &res) {
  20047. res.set_content("test", "text/plain");
  20048. });
  20049. thread t = thread([&]() { ASSERT_TRUE(svr.listen(HOST, PORT)); });
  20050. auto se = detail::scope_exit([&] {
  20051. svr.stop();
  20052. t.join();
  20053. ASSERT_FALSE(svr.is_running());
  20054. });
  20055. svr.wait_until_ready();
  20056. {
  20057. SSLClient cli(HOST, PORT);
  20058. cli.enable_server_certificate_verification(false);
  20059. cli.set_keep_alive(true);
  20060. auto res = cli.Get("/test");
  20061. ASSERT_TRUE(res) << "Error: " << to_string(res.error());
  20062. ASSERT_EQ(StatusCode::OK_200, res->status);
  20063. // cli is destructed here with the keep-alive SSL session still open.
  20064. }
  20065. }
  20066. #endif
  20067. // WebSocket Tests
  20068. TEST(WebSocketTest, RSVBitsMustBeZero) {
  20069. // RFC 6455 Section 5.2: RSV1, RSV2, RSV3 MUST be 0 unless an extension
  20070. // defining the meaning of these bits has been negotiated.
  20071. auto make_frame = [](uint8_t first_byte) {
  20072. std::string frame;
  20073. frame += static_cast<char>(first_byte); // FIN + RSV + opcode
  20074. frame += static_cast<char>(0x05); // mask=0, payload_len=5
  20075. frame += "Hello";
  20076. return frame;
  20077. };
  20078. // RSV1 set (0x40)
  20079. {
  20080. detail::BufferStream strm;
  20081. strm.write(make_frame(0x81 | 0x40).data(), 8); // FIN + RSV1 + Text
  20082. ws::Opcode opcode;
  20083. std::string payload;
  20084. bool fin;
  20085. EXPECT_EQ(
  20086. ws::impl::read_websocket_frame(strm, opcode, payload, fin, false, 1024),
  20087. ws::impl::FrameRead::Fail);
  20088. }
  20089. // RSV2 set (0x20)
  20090. {
  20091. detail::BufferStream strm;
  20092. strm.write(make_frame(0x81 | 0x20).data(), 8); // FIN + RSV2 + Text
  20093. ws::Opcode opcode;
  20094. std::string payload;
  20095. bool fin;
  20096. EXPECT_EQ(
  20097. ws::impl::read_websocket_frame(strm, opcode, payload, fin, false, 1024),
  20098. ws::impl::FrameRead::Fail);
  20099. }
  20100. // RSV3 set (0x10)
  20101. {
  20102. detail::BufferStream strm;
  20103. strm.write(make_frame(0x81 | 0x10).data(), 8); // FIN + RSV3 + Text
  20104. ws::Opcode opcode;
  20105. std::string payload;
  20106. bool fin;
  20107. EXPECT_EQ(
  20108. ws::impl::read_websocket_frame(strm, opcode, payload, fin, false, 1024),
  20109. ws::impl::FrameRead::Fail);
  20110. }
  20111. // No RSV bits set - should succeed
  20112. {
  20113. detail::BufferStream strm;
  20114. strm.write(make_frame(0x81).data(), 8); // FIN + Text, no RSV
  20115. ws::Opcode opcode;
  20116. std::string payload;
  20117. bool fin;
  20118. EXPECT_EQ(
  20119. ws::impl::read_websocket_frame(strm, opcode, payload, fin, false, 1024),
  20120. ws::impl::FrameRead::Ok);
  20121. EXPECT_EQ(ws::Opcode::Text, opcode);
  20122. EXPECT_EQ("Hello", payload);
  20123. EXPECT_TRUE(fin);
  20124. }
  20125. }
  20126. TEST(WebSocketTest, ControlFrameValidation) {
  20127. // RFC 6455 Section 5.5: control frames MUST have FIN=1 and
  20128. // payload length <= 125.
  20129. // Ping with FIN=0 - must be rejected
  20130. {
  20131. detail::BufferStream strm;
  20132. std::string frame;
  20133. frame += static_cast<char>(0x09); // FIN=0, opcode=Ping
  20134. frame += static_cast<char>(0x00); // mask=0, payload_len=0
  20135. strm.write(frame.data(), frame.size());
  20136. ws::Opcode opcode;
  20137. std::string payload;
  20138. bool fin;
  20139. EXPECT_EQ(
  20140. ws::impl::read_websocket_frame(strm, opcode, payload, fin, false, 1024),
  20141. ws::impl::FrameRead::Fail);
  20142. }
  20143. // Close with FIN=0 - must be rejected
  20144. {
  20145. detail::BufferStream strm;
  20146. std::string frame;
  20147. frame += static_cast<char>(0x08); // FIN=0, opcode=Close
  20148. frame += static_cast<char>(0x00); // mask=0, payload_len=0
  20149. strm.write(frame.data(), frame.size());
  20150. ws::Opcode opcode;
  20151. std::string payload;
  20152. bool fin;
  20153. EXPECT_EQ(
  20154. ws::impl::read_websocket_frame(strm, opcode, payload, fin, false, 1024),
  20155. ws::impl::FrameRead::Fail);
  20156. }
  20157. // Ping with payload_len=126 (extended length) - must be rejected
  20158. {
  20159. detail::BufferStream strm;
  20160. std::string frame;
  20161. frame += static_cast<char>(0x89); // FIN=1, opcode=Ping
  20162. frame += static_cast<char>(126); // payload_len=126 (>125)
  20163. frame += static_cast<char>(0x00); // extended length high byte
  20164. frame += static_cast<char>(126); // extended length low byte
  20165. frame += std::string(126, 'x');
  20166. strm.write(frame.data(), frame.size());
  20167. ws::Opcode opcode;
  20168. std::string payload;
  20169. bool fin;
  20170. EXPECT_EQ(
  20171. ws::impl::read_websocket_frame(strm, opcode, payload, fin, false, 1024),
  20172. ws::impl::FrameRead::Fail);
  20173. }
  20174. // Ping with FIN=1 and payload_len=125 - should succeed
  20175. {
  20176. detail::BufferStream strm;
  20177. std::string frame;
  20178. frame += static_cast<char>(0x89); // FIN=1, opcode=Ping
  20179. frame += static_cast<char>(125); // payload_len=125
  20180. frame += std::string(125, 'x');
  20181. strm.write(frame.data(), frame.size());
  20182. ws::Opcode opcode;
  20183. std::string payload;
  20184. bool fin;
  20185. EXPECT_EQ(
  20186. ws::impl::read_websocket_frame(strm, opcode, payload, fin, false, 1024),
  20187. ws::impl::FrameRead::Ok);
  20188. EXPECT_EQ(ws::Opcode::Ping, opcode);
  20189. EXPECT_EQ(125u, payload.size());
  20190. EXPECT_TRUE(fin);
  20191. }
  20192. }
  20193. TEST(WebSocketTest, PayloadLength64BitMSBMustBeZero) {
  20194. // RFC 6455 Section 5.2: the most significant bit of a 64-bit payload
  20195. // length MUST be 0.
  20196. // MSB set - must be rejected
  20197. {
  20198. detail::BufferStream strm;
  20199. std::string frame;
  20200. frame += static_cast<char>(0x81); // FIN=1, opcode=Text
  20201. frame += static_cast<char>(127); // 64-bit extended length
  20202. frame += static_cast<char>(0x80); // MSB set (invalid)
  20203. frame += std::string(7, '\0'); // remaining 7 bytes of length
  20204. strm.write(frame.data(), frame.size());
  20205. ws::Opcode opcode;
  20206. std::string payload;
  20207. bool fin;
  20208. EXPECT_EQ(
  20209. ws::impl::read_websocket_frame(strm, opcode, payload, fin, false, 1024),
  20210. ws::impl::FrameRead::Fail);
  20211. }
  20212. // MSB clear - should pass length parsing (will be rejected by max_len,
  20213. // but that's a different check; use a small length to verify)
  20214. {
  20215. detail::BufferStream strm;
  20216. std::string frame;
  20217. frame += static_cast<char>(0x81); // FIN=1, opcode=Text
  20218. frame += static_cast<char>(127); // 64-bit extended length
  20219. frame += std::string(7, '\0'); // high bytes = 0
  20220. frame += static_cast<char>(0x03); // length = 3
  20221. frame += "abc";
  20222. strm.write(frame.data(), frame.size());
  20223. ws::Opcode opcode;
  20224. std::string payload;
  20225. bool fin;
  20226. EXPECT_EQ(
  20227. ws::impl::read_websocket_frame(strm, opcode, payload, fin, false, 1024),
  20228. ws::impl::FrameRead::Ok);
  20229. EXPECT_EQ(ws::Opcode::Text, opcode);
  20230. EXPECT_EQ("abc", payload);
  20231. }
  20232. }
  20233. TEST(WebSocketTest, InvalidUTF8TextFrame) {
  20234. // RFC 6455 Section 5.6: text frames must contain valid UTF-8.
  20235. // Valid UTF-8
  20236. EXPECT_TRUE(ws::impl::is_valid_utf8("Hello"));
  20237. EXPECT_TRUE(ws::impl::is_valid_utf8("\xC3\xA9")); // é (U+00E9)
  20238. EXPECT_TRUE(ws::impl::is_valid_utf8("\xE3\x81\x82")); // あ (U+3042)
  20239. EXPECT_TRUE(ws::impl::is_valid_utf8("\xF0\x9F\x98\x80")); // 😀 (U+1F600)
  20240. EXPECT_TRUE(ws::impl::is_valid_utf8(""));
  20241. // Invalid UTF-8
  20242. EXPECT_FALSE(ws::impl::is_valid_utf8("\x80")); // Invalid start byte
  20243. EXPECT_FALSE(ws::impl::is_valid_utf8("\xC3\x28")); // Bad continuation
  20244. EXPECT_FALSE(ws::impl::is_valid_utf8("\xC0\xAF")); // Overlong encoding
  20245. EXPECT_FALSE(
  20246. ws::impl::is_valid_utf8("\xED\xA0\x80")); // Surrogate half U+D800
  20247. EXPECT_FALSE(ws::impl::is_valid_utf8("\xF4\x90\x80\x80")); // Beyond U+10FFFF
  20248. }
  20249. TEST(WebSocketTest, ConnectAndDisconnect) {
  20250. Server svr;
  20251. svr.WebSocket("/ws", [](const Request &, ws::WebSocket &ws) {
  20252. std::string msg;
  20253. while (ws.read(msg)) {}
  20254. });
  20255. auto port = svr.bind_to_any_port(HOST);
  20256. std::thread t([&]() { svr.listen_after_bind(); });
  20257. svr.wait_until_ready();
  20258. ws::WebSocketClient client("ws://localhost:" + std::to_string(port) + "/ws");
  20259. auto res = client.connect();
  20260. ASSERT_TRUE(res);
  20261. EXPECT_EQ(Error::Success, res.error());
  20262. EXPECT_EQ(StatusCode::SwitchingProtocol_101, res.status());
  20263. EXPECT_TRUE(res.has_header("Sec-WebSocket-Accept"));
  20264. EXPECT_TRUE(client.is_open());
  20265. client.close();
  20266. EXPECT_FALSE(client.is_open());
  20267. svr.stop();
  20268. t.join();
  20269. }
  20270. TEST(WebSocketTest, ValidURL) {
  20271. ws::WebSocketClient ws1("ws://localhost:8080/path");
  20272. EXPECT_TRUE(ws1.is_valid());
  20273. ws::WebSocketClient ws2("ws://example.com/path");
  20274. EXPECT_TRUE(ws2.is_valid());
  20275. ws::WebSocketClient ws3("ws://example.com:9090/path/to/endpoint");
  20276. EXPECT_TRUE(ws3.is_valid());
  20277. #ifdef CPPHTTPLIB_SSL_ENABLED
  20278. ws::WebSocketClient wss1("wss://example.com/path");
  20279. EXPECT_TRUE(wss1.is_valid());
  20280. ws::WebSocketClient wss2("wss://example.com:443/path");
  20281. EXPECT_TRUE(wss2.is_valid());
  20282. #endif
  20283. }
  20284. TEST(WebSocketTest, InvalidURL) {
  20285. // No scheme
  20286. ws::WebSocketClient ws1("localhost:8080/path");
  20287. EXPECT_FALSE(ws1.is_valid());
  20288. // No path
  20289. ws::WebSocketClient ws2("ws://localhost:8080");
  20290. EXPECT_FALSE(ws2.is_valid());
  20291. // Empty string
  20292. ws::WebSocketClient ws3("");
  20293. EXPECT_FALSE(ws3.is_valid());
  20294. // Missing host
  20295. ws::WebSocketClient ws4("ws://:8080/path");
  20296. EXPECT_FALSE(ws4.is_valid());
  20297. // Port number overflow — should not crash
  20298. ws::WebSocketClient ws5("ws://localhost:99999999999999999999/path");
  20299. EXPECT_FALSE(ws5.is_valid());
  20300. // Port out of range
  20301. ws::WebSocketClient ws6("ws://localhost:99999/path");
  20302. EXPECT_FALSE(ws6.is_valid());
  20303. }
  20304. TEST(WebSocketTest, UnsupportedScheme) {
  20305. #ifdef CPPHTTPLIB_NO_EXCEPTIONS
  20306. ws::WebSocketClient ws1("http://localhost:8080/path");
  20307. EXPECT_FALSE(ws1.is_valid());
  20308. ws::WebSocketClient ws2("https://localhost:8080/path");
  20309. EXPECT_FALSE(ws2.is_valid());
  20310. ws::WebSocketClient ws3("ftp://localhost:8080/path");
  20311. EXPECT_FALSE(ws3.is_valid());
  20312. #else
  20313. EXPECT_THROW(ws::WebSocketClient("http://localhost:8080/path"),
  20314. std::invalid_argument);
  20315. EXPECT_THROW(ws::WebSocketClient("ftp://localhost:8080/path"),
  20316. std::invalid_argument);
  20317. #endif
  20318. }
  20319. TEST(WebSocketTest, ConnectWhenInvalid) {
  20320. ws::WebSocketClient ws("not a valid url");
  20321. EXPECT_FALSE(ws.is_valid());
  20322. auto res = ws.connect();
  20323. EXPECT_FALSE(res);
  20324. EXPECT_EQ(Error::Connection, res.error());
  20325. EXPECT_EQ(-1, res.status());
  20326. }
  20327. TEST(WebSocketTest, ConnectRefusedReportsError) {
  20328. // Grab a port that is free, then close it again so nothing listens there
  20329. Server svr;
  20330. auto port = svr.bind_to_any_port(HOST);
  20331. svr.stop();
  20332. ws::WebSocketClient client("ws://localhost:" + std::to_string(port) + "/ws");
  20333. auto res = client.connect();
  20334. ASSERT_FALSE(res);
  20335. EXPECT_EQ(Error::Connection, res.error());
  20336. EXPECT_EQ(-1, res.status());
  20337. }
  20338. TEST(WebSocketTest, DefaultPort) {
  20339. ws::WebSocketClient ws1("ws://example.com/path");
  20340. EXPECT_TRUE(ws1.is_valid());
  20341. // ws:// defaults to port 80 (verified by successful parse)
  20342. #ifdef CPPHTTPLIB_SSL_ENABLED
  20343. ws::WebSocketClient ws2("wss://example.com/path");
  20344. EXPECT_TRUE(ws2.is_valid());
  20345. // wss:// defaults to port 443 (verified by successful parse)
  20346. #endif
  20347. }
  20348. TEST(WebSocketTest, IPv6LiteralAddress) {
  20349. ws::WebSocketClient ws1("ws://[::1]:8080/path");
  20350. EXPECT_TRUE(ws1.is_valid());
  20351. ws::WebSocketClient ws2("ws://[fe80::1]:3000/ws");
  20352. EXPECT_TRUE(ws2.is_valid());
  20353. }
  20354. TEST(WebSocketTest, ComplexPath) {
  20355. ws::WebSocketClient ws1("ws://localhost:8080/path/to/endpoint");
  20356. EXPECT_TRUE(ws1.is_valid());
  20357. ws::WebSocketClient ws2("ws://localhost:8080/");
  20358. EXPECT_TRUE(ws2.is_valid());
  20359. }
  20360. TEST(WebSocketTest, SpecifyServerIPAddress_AnotherHostname) {
  20361. Server svr;
  20362. svr.WebSocket("/ws", [](const Request &, ws::WebSocket &ws) {
  20363. std::string msg;
  20364. while (ws.read(msg)) {}
  20365. });
  20366. auto port = svr.bind_to_any_port(HOST);
  20367. std::thread t([&]() { svr.listen_after_bind(); });
  20368. svr.wait_until_ready();
  20369. auto another_host = "example.com";
  20370. auto wrong_ip = "192.0.2.1";
  20371. ws::WebSocketClient client("ws://localhost:" + std::to_string(port) + "/ws");
  20372. client.set_hostname_addr_map({{another_host, wrong_ip}});
  20373. ASSERT_TRUE(client.connect());
  20374. EXPECT_TRUE(client.is_open());
  20375. client.close();
  20376. svr.stop();
  20377. t.join();
  20378. }
  20379. TEST(WebSocketTest, SpecifyServerIPAddress_RealHostname) {
  20380. Server svr;
  20381. svr.WebSocket("/ws", [](const Request &, ws::WebSocket &ws) {
  20382. std::string msg;
  20383. while (ws.read(msg)) {}
  20384. });
  20385. auto port = svr.bind_to_any_port(HOST);
  20386. std::thread t([&]() { svr.listen_after_bind(); });
  20387. svr.wait_until_ready();
  20388. auto wrong_ip = "192.0.2.1";
  20389. ws::WebSocketClient client("ws://localhost:" + std::to_string(port) + "/ws");
  20390. client.set_hostname_addr_map({{"localhost", wrong_ip}});
  20391. client.set_connection_timeout(1);
  20392. client.set_read_timeout(1);
  20393. client.set_write_timeout(1);
  20394. EXPECT_FALSE(client.connect());
  20395. EXPECT_FALSE(client.is_open());
  20396. svr.stop();
  20397. t.join();
  20398. }
  20399. TEST(WebSocketTest, SpecifyServerIPAddress_HostnameAsAddrMapValue) {
  20400. // A mapped value that is not an IP literal must be resolved. HOST resolves
  20401. // from the hosts file, so this test needs no external DNS. "target.invalid"
  20402. // (RFC 6761) is only a map key and the Host header value.
  20403. auto host = "target.invalid";
  20404. Server svr;
  20405. std::string received_host;
  20406. svr.WebSocket("/ws", [&](const Request &req, ws::WebSocket &ws) {
  20407. received_host = req.get_header_value("Host");
  20408. std::string msg;
  20409. while (ws.read(msg)) {}
  20410. });
  20411. auto port = svr.bind_to_any_port(HOST);
  20412. std::thread t([&]() { svr.listen_after_bind(); });
  20413. // ASSERT_* below returns from the test body, which would leave t joinable
  20414. // and make ~thread call std::terminate.
  20415. auto se = detail::scope_exit([&] {
  20416. svr.stop();
  20417. if (t.joinable()) { t.join(); }
  20418. });
  20419. svr.wait_until_ready();
  20420. ws::WebSocketClient client("ws://" + std::string(host) + ":" +
  20421. std::to_string(port) + "/ws");
  20422. client.set_hostname_addr_map({{host, HOST}});
  20423. ASSERT_TRUE(client.connect());
  20424. EXPECT_TRUE(client.is_open());
  20425. client.close();
  20426. svr.stop();
  20427. t.join();
  20428. // The mapping only redirects the connection; the identity stays host_.
  20429. EXPECT_EQ(std::string(host) + ":" + std::to_string(port), received_host);
  20430. }
  20431. class WebSocketIntegrationTest : public ::testing::Test {
  20432. protected:
  20433. void SetUp() override {
  20434. server_ = httplib::detail::make_unique<Server>();
  20435. setup_server();
  20436. start_server();
  20437. }
  20438. void TearDown() override {
  20439. server_->stop();
  20440. if (server_thread_.joinable()) { server_thread_.join(); }
  20441. }
  20442. void setup_server() {
  20443. server_->WebSocket("/ws-echo", [](const Request &, ws::WebSocket &ws) {
  20444. std::string msg;
  20445. ws::ReadResult ret;
  20446. while ((ret = ws.read(msg))) {
  20447. if (ret == ws::Binary) {
  20448. ws.send(msg.data(), msg.size());
  20449. } else {
  20450. ws.send(msg);
  20451. }
  20452. }
  20453. });
  20454. server_->WebSocket("/ws-echo-string",
  20455. [](const Request &, ws::WebSocket &ws) {
  20456. std::string msg;
  20457. while (ws.read(msg)) {
  20458. ws.send("echo: " + msg);
  20459. }
  20460. });
  20461. server_->WebSocket(
  20462. "/ws-request-info", [](const Request &req, ws::WebSocket &ws) {
  20463. // Echo back request metadata
  20464. ws.send("path:" + req.path);
  20465. ws.send("header:" + req.get_header_value("X-Test-Header"));
  20466. std::string msg;
  20467. while (ws.read(msg)) {}
  20468. });
  20469. server_->WebSocket("/ws-close", [](const Request &, ws::WebSocket &ws) {
  20470. std::string msg;
  20471. ws.read(msg); // wait for a message
  20472. ws.close();
  20473. });
  20474. server_->WebSocket("/ws-close-status",
  20475. [](const Request &, ws::WebSocket &ws) {
  20476. std::string msg;
  20477. ws.read(msg); // wait for a message
  20478. ws.close(ws::CloseStatus::GoingAway, "shutting down");
  20479. });
  20480. server_->WebSocket(
  20481. "/ws-subprotocol",
  20482. [](const Request &, ws::WebSocket &ws) {
  20483. std::string msg;
  20484. while (ws.read(msg)) {
  20485. ws.send(msg);
  20486. }
  20487. },
  20488. [](const std::vector<std::string> &protocols) -> std::string {
  20489. for (const auto &p : protocols) {
  20490. if (p == "graphql-ws") { return p; }
  20491. }
  20492. return "";
  20493. });
  20494. server_->WebSocket(
  20495. "/ws-subprotocol-unoffered",
  20496. [](const Request &, ws::WebSocket &ws) {
  20497. std::string msg;
  20498. while (ws.read(msg)) {
  20499. ws.send(msg);
  20500. }
  20501. },
  20502. [](const std::vector<std::string> &) -> std::string {
  20503. return "admin";
  20504. });
  20505. }
  20506. void start_server() {
  20507. port_ = server_->bind_to_any_port(HOST);
  20508. server_thread_ = std::thread([this]() { server_->listen_after_bind(); });
  20509. server_->wait_until_ready();
  20510. }
  20511. std::unique_ptr<Server> server_;
  20512. std::thread server_thread_;
  20513. int port_ = 0;
  20514. };
  20515. TEST_F(WebSocketIntegrationTest, TextEcho) {
  20516. ws::WebSocketClient client("ws://localhost:" + std::to_string(port_) +
  20517. "/ws-echo");
  20518. ASSERT_TRUE(client.connect());
  20519. ASSERT_TRUE(client.is_open());
  20520. ASSERT_TRUE(client.send("Hello WebSocket"));
  20521. std::string msg;
  20522. EXPECT_EQ(ws::Text, client.read(msg));
  20523. EXPECT_EQ("Hello WebSocket", msg);
  20524. client.close();
  20525. }
  20526. TEST_F(WebSocketIntegrationTest, BinaryEcho) {
  20527. ws::WebSocketClient client("ws://localhost:" + std::to_string(port_) +
  20528. "/ws-echo");
  20529. ASSERT_TRUE(client.connect());
  20530. std::string binary_data = {'\x00', '\x01', '\x02', '\xFF', '\xFE'};
  20531. ASSERT_TRUE(client.send(binary_data.data(), binary_data.size()));
  20532. std::string msg;
  20533. EXPECT_EQ(ws::Binary, client.read(msg));
  20534. EXPECT_EQ(binary_data, msg);
  20535. client.close();
  20536. }
  20537. TEST_F(WebSocketIntegrationTest, MultipleMessages) {
  20538. ws::WebSocketClient client("ws://localhost:" + std::to_string(port_) +
  20539. "/ws-echo");
  20540. ASSERT_TRUE(client.connect());
  20541. for (int i = 0; i < 10; i++) {
  20542. auto text = "message " + std::to_string(i);
  20543. ASSERT_TRUE(client.send(text));
  20544. std::string msg;
  20545. ASSERT_TRUE(client.read(msg));
  20546. EXPECT_EQ(text, msg);
  20547. }
  20548. client.close();
  20549. }
  20550. TEST_F(WebSocketIntegrationTest, CloseHandshake) {
  20551. ws::WebSocketClient client("ws://localhost:" + std::to_string(port_) +
  20552. "/ws-close");
  20553. ASSERT_TRUE(client.connect());
  20554. // Send a message to trigger the server to close
  20555. ASSERT_TRUE(client.send("trigger close"));
  20556. // The server will close, so read should return false
  20557. std::string msg;
  20558. EXPECT_FALSE(client.read(msg));
  20559. EXPECT_FALSE(client.is_open());
  20560. }
  20561. TEST_F(WebSocketIntegrationTest, LargeMessage) {
  20562. ws::WebSocketClient client("ws://localhost:" + std::to_string(port_) +
  20563. "/ws-echo");
  20564. ASSERT_TRUE(client.connect());
  20565. // 128KB message
  20566. std::string large_data(128 * 1024, 'X');
  20567. ASSERT_TRUE(client.send(large_data));
  20568. std::string msg;
  20569. ASSERT_TRUE(client.read(msg));
  20570. EXPECT_EQ(large_data, msg);
  20571. client.close();
  20572. }
  20573. TEST_F(WebSocketIntegrationTest, ConcurrentSend) {
  20574. ws::WebSocketClient client("ws://localhost:" + std::to_string(port_) +
  20575. "/ws-echo");
  20576. ASSERT_TRUE(client.connect());
  20577. const int num_threads = 4;
  20578. std::vector<std::thread> threads;
  20579. std::atomic<int> send_count{0};
  20580. for (int t = 0; t < num_threads; t++) {
  20581. threads.emplace_back([&client, &send_count, t]() {
  20582. for (int i = 0; i < 5; i++) {
  20583. auto text = "thread" + std::to_string(t) + "_msg" + std::to_string(i);
  20584. if (client.send(text)) { send_count++; }
  20585. }
  20586. });
  20587. }
  20588. for (auto &th : threads) {
  20589. th.join();
  20590. }
  20591. int received = 0;
  20592. std::string msg;
  20593. while (received < send_count.load()) {
  20594. if (!client.read(msg)) { break; }
  20595. received++;
  20596. }
  20597. EXPECT_EQ(send_count.load(), received);
  20598. client.close();
  20599. }
  20600. TEST_F(WebSocketIntegrationTest, ReadString) {
  20601. ws::WebSocketClient client("ws://localhost:" + std::to_string(port_) +
  20602. "/ws-echo-string");
  20603. ASSERT_TRUE(client.connect());
  20604. ASSERT_TRUE(client.send("hello"));
  20605. std::string msg;
  20606. ASSERT_TRUE(client.read(msg));
  20607. EXPECT_EQ("echo: hello", msg);
  20608. ASSERT_TRUE(client.send("world"));
  20609. ASSERT_TRUE(client.read(msg));
  20610. EXPECT_EQ("echo: world", msg);
  20611. client.close();
  20612. }
  20613. TEST_F(WebSocketIntegrationTest, RequestAccess) {
  20614. Headers headers = {{"X-Test-Header", "test-value"}};
  20615. ws::WebSocketClient client(
  20616. "ws://localhost:" + std::to_string(port_) + "/ws-request-info", headers);
  20617. ASSERT_TRUE(client.connect());
  20618. std::string msg;
  20619. ASSERT_TRUE(client.read(msg));
  20620. EXPECT_EQ("path:/ws-request-info", msg);
  20621. ASSERT_TRUE(client.read(msg));
  20622. EXPECT_EQ("header:test-value", msg);
  20623. client.close();
  20624. }
  20625. TEST_F(WebSocketIntegrationTest, ReadTimeout) {
  20626. ws::WebSocketClient client("ws://localhost:" + std::to_string(port_) +
  20627. "/ws-echo");
  20628. client.set_read_timeout(1, 0); // 1 second
  20629. ASSERT_TRUE(client.connect());
  20630. // Don't send anything — server echo handler waits for a message, so read()
  20631. // should time out. The connection survives it: nothing was consumed.
  20632. std::string msg;
  20633. EXPECT_EQ(client.read(msg), ws::Timeout);
  20634. EXPECT_TRUE(client.is_open());
  20635. // And it is still usable afterwards.
  20636. EXPECT_TRUE(client.send("after timeout"));
  20637. EXPECT_EQ(client.read(msg), ws::Text);
  20638. EXPECT_EQ(msg, "after timeout");
  20639. }
  20640. TEST_F(WebSocketIntegrationTest, ReadTimeoutLeavesMessageUntouched) {
  20641. ws::WebSocketClient client("ws://localhost:" + std::to_string(port_) +
  20642. "/ws-echo");
  20643. client.set_read_timeout(1, 0);
  20644. ASSERT_TRUE(client.connect());
  20645. ASSERT_TRUE(client.send("first"));
  20646. std::string msg;
  20647. ASSERT_EQ(client.read(msg), ws::Text);
  20648. ASSERT_EQ(msg, "first");
  20649. // A timeout does not write to msg. This is why `while (ws.read(msg))` must
  20650. // not be used with a read timeout: it would reprocess the previous message.
  20651. EXPECT_EQ(client.read(msg), ws::Timeout);
  20652. EXPECT_EQ(msg, "first");
  20653. }
  20654. TEST_F(WebSocketIntegrationTest, ReadTimeoutSetAfterConnect) {
  20655. ws::WebSocketClient client("ws://localhost:" + std::to_string(port_) +
  20656. "/ws-echo");
  20657. ASSERT_TRUE(client.connect());
  20658. // Setting it once the connection is open reaches the live stream, not just
  20659. // the seed for the next connect().
  20660. client.set_read_timeout(1, 0);
  20661. std::string msg;
  20662. EXPECT_EQ(client.read(msg), ws::Timeout);
  20663. EXPECT_TRUE(client.is_open());
  20664. }
  20665. TEST_F(WebSocketIntegrationTest, MaxPayloadExceeded) {
  20666. ws::WebSocketClient client("ws://localhost:" + std::to_string(port_) +
  20667. "/ws-echo");
  20668. client.set_read_timeout(5, 0);
  20669. ASSERT_TRUE(client.connect());
  20670. // Send a message exceeding CPPHTTPLIB_WEBSOCKET_MAX_PAYLOAD_LENGTH (16MB).
  20671. // The server should reject it and close the connection.
  20672. std::string oversized(CPPHTTPLIB_WEBSOCKET_MAX_PAYLOAD_LENGTH + 1, 'A');
  20673. client.send(oversized);
  20674. // The server's read() should have failed due to payload limit,
  20675. // so our read() should return false (connection closed).
  20676. std::string msg;
  20677. EXPECT_FALSE(client.read(msg));
  20678. }
  20679. TEST_F(WebSocketIntegrationTest, MaxPayloadAtLimit) {
  20680. ws::WebSocketClient client("ws://localhost:" + std::to_string(port_) +
  20681. "/ws-echo");
  20682. client.set_read_timeout(10, 0);
  20683. ASSERT_TRUE(client.connect());
  20684. // Send a message exactly at CPPHTTPLIB_WEBSOCKET_MAX_PAYLOAD_LENGTH (16MB).
  20685. // This should succeed.
  20686. std::string at_limit(CPPHTTPLIB_WEBSOCKET_MAX_PAYLOAD_LENGTH, 'B');
  20687. ASSERT_TRUE(client.send(at_limit));
  20688. std::string msg;
  20689. ASSERT_TRUE(client.read(msg));
  20690. EXPECT_EQ(at_limit.size(), msg.size());
  20691. client.close();
  20692. }
  20693. TEST_F(WebSocketIntegrationTest, ConnectToInvalidPath) {
  20694. ws::WebSocketClient client("ws://localhost:" + std::to_string(port_) +
  20695. "/nonexistent");
  20696. auto res = client.connect();
  20697. EXPECT_FALSE(res);
  20698. EXPECT_EQ(Error::WebSocketHandshake, res.error());
  20699. EXPECT_EQ(StatusCode::NotFound_404, res.status());
  20700. EXPECT_FALSE(client.is_open());
  20701. }
  20702. TEST_F(WebSocketIntegrationTest, EmptyMessage) {
  20703. ws::WebSocketClient client("ws://localhost:" + std::to_string(port_) +
  20704. "/ws-echo");
  20705. ASSERT_TRUE(client.connect());
  20706. ASSERT_TRUE(client.send(""));
  20707. std::string msg;
  20708. EXPECT_EQ(ws::Text, client.read(msg));
  20709. EXPECT_EQ("", msg);
  20710. client.close();
  20711. }
  20712. TEST_F(WebSocketIntegrationTest, Reconnect) {
  20713. ws::WebSocketClient client("ws://localhost:" + std::to_string(port_) +
  20714. "/ws-echo");
  20715. // First connection
  20716. ASSERT_TRUE(client.connect());
  20717. ASSERT_TRUE(client.send("first"));
  20718. std::string msg;
  20719. ASSERT_TRUE(client.read(msg));
  20720. EXPECT_EQ("first", msg);
  20721. client.close();
  20722. EXPECT_FALSE(client.is_open());
  20723. // Reconnect using the same client object
  20724. ASSERT_TRUE(client.connect());
  20725. ASSERT_TRUE(client.is_open());
  20726. ASSERT_TRUE(client.send("second"));
  20727. ASSERT_TRUE(client.read(msg));
  20728. EXPECT_EQ("second", msg);
  20729. client.close();
  20730. }
  20731. TEST_F(WebSocketIntegrationTest, CloseWithStatus) {
  20732. ws::WebSocketClient client("ws://localhost:" + std::to_string(port_) +
  20733. "/ws-close-status");
  20734. ASSERT_TRUE(client.connect());
  20735. // Trigger the server to close with GoingAway status
  20736. ASSERT_TRUE(client.send("trigger"));
  20737. // read() should return false after receiving the close frame
  20738. std::string msg;
  20739. EXPECT_FALSE(client.read(msg));
  20740. EXPECT_FALSE(client.is_open());
  20741. }
  20742. TEST_F(WebSocketIntegrationTest, ClientCloseWithStatus) {
  20743. ws::WebSocketClient client("ws://localhost:" + std::to_string(port_) +
  20744. "/ws-echo");
  20745. ASSERT_TRUE(client.connect());
  20746. client.close(ws::CloseStatus::GoingAway, "client leaving");
  20747. EXPECT_FALSE(client.is_open());
  20748. }
  20749. TEST_F(WebSocketIntegrationTest, SubProtocolNegotiation) {
  20750. Headers headers = {{"Sec-WebSocket-Protocol", "mqtt, graphql-ws"}};
  20751. ws::WebSocketClient client(
  20752. "ws://localhost:" + std::to_string(port_) + "/ws-subprotocol", headers);
  20753. ASSERT_TRUE(client.connect());
  20754. // Server should have selected graphql-ws
  20755. EXPECT_EQ("graphql-ws", client.subprotocol());
  20756. client.close();
  20757. }
  20758. TEST_F(WebSocketIntegrationTest, SubProtocolSplitAcrossFieldLines) {
  20759. Headers headers;
  20760. headers.emplace("Sec-WebSocket-Protocol", "mqtt");
  20761. headers.emplace("Sec-WebSocket-Protocol", "graphql-ws");
  20762. ws::WebSocketClient client(
  20763. "ws://localhost:" + std::to_string(port_) + "/ws-subprotocol", headers);
  20764. ASSERT_TRUE(client.connect());
  20765. // The offer on the second field line counts too, so graphql-ws is selected
  20766. EXPECT_EQ("graphql-ws", client.subprotocol());
  20767. client.close();
  20768. }
  20769. TEST_F(WebSocketIntegrationTest, SubProtocolNoMatch) {
  20770. Headers headers = {{"Sec-WebSocket-Protocol", "mqtt, wamp"}};
  20771. ws::WebSocketClient client(
  20772. "ws://localhost:" + std::to_string(port_) + "/ws-subprotocol", headers);
  20773. ASSERT_TRUE(client.connect());
  20774. // Server should not have selected any subprotocol
  20775. EXPECT_TRUE(client.subprotocol().empty());
  20776. client.close();
  20777. }
  20778. TEST_F(WebSocketIntegrationTest, SubProtocolSelectorReturnsUnoffered) {
  20779. Headers headers = {{"Sec-WebSocket-Protocol", "chat"}};
  20780. ws::WebSocketClient client("ws://localhost:" + std::to_string(port_) +
  20781. "/ws-subprotocol-unoffered",
  20782. headers);
  20783. ASSERT_TRUE(client.connect());
  20784. EXPECT_TRUE(client.subprotocol().empty());
  20785. client.close();
  20786. }
  20787. TEST_F(WebSocketIntegrationTest, SubProtocolNotRequested) {
  20788. // Connect without requesting any subprotocol
  20789. ws::WebSocketClient client("ws://localhost:" + std::to_string(port_) +
  20790. "/ws-subprotocol");
  20791. ASSERT_TRUE(client.connect());
  20792. EXPECT_TRUE(client.subprotocol().empty());
  20793. client.close();
  20794. }
  20795. TEST_F(WebSocketIntegrationTest, SocketSettings) {
  20796. ws::WebSocketClient client("ws://localhost:" + std::to_string(port_) +
  20797. "/ws-echo");
  20798. client.set_tcp_nodelay(true);
  20799. client.set_connection_timeout(3, 0);
  20800. bool socket_options_called = false;
  20801. client.set_socket_options([&](socket_t) { socket_options_called = true; });
  20802. ASSERT_TRUE(client.connect());
  20803. ASSERT_TRUE(client.is_open());
  20804. EXPECT_TRUE(socket_options_called);
  20805. ASSERT_TRUE(client.send("hello"));
  20806. std::string msg;
  20807. auto result = client.read(msg);
  20808. EXPECT_EQ(result, ws::ReadResult::Text);
  20809. EXPECT_EQ(msg, "hello");
  20810. client.close();
  20811. }
  20812. TEST_F(WebSocketIntegrationTest, ChronoTimeoutSetters) {
  20813. ws::WebSocketClient client("ws://localhost:" + std::to_string(port_) +
  20814. "/ws-echo");
  20815. client.set_connection_timeout(std::chrono::seconds(3));
  20816. client.set_write_timeout(std::chrono::seconds(3));
  20817. // A sub-second remainder exercises the seconds/microseconds split.
  20818. client.set_read_timeout(std::chrono::milliseconds(1500));
  20819. ASSERT_TRUE(client.connect());
  20820. auto start = std::chrono::steady_clock::now();
  20821. std::string msg;
  20822. EXPECT_EQ(client.read(msg), ws::ReadResult::Timeout);
  20823. auto elapsed = std::chrono::duration_cast<std::chrono::milliseconds>(
  20824. std::chrono::steady_clock::now() - start)
  20825. .count();
  20826. // Above 1s so that dropping the microseconds half of the split fails here.
  20827. // Ignoring the setter altogether would not reach this line at all: a client
  20828. // waits forever by default.
  20829. EXPECT_GE(elapsed, 1400);
  20830. EXPECT_LT(elapsed, 30000);
  20831. }
  20832. TEST(WebSocketPreRoutingTest, RejectWithoutAuth) {
  20833. Server svr;
  20834. svr.set_pre_routing_handler([](const Request &req, Response &res) {
  20835. if (!req.has_header("Authorization")) {
  20836. res.status = StatusCode::Unauthorized_401;
  20837. res.set_content("Unauthorized", "text/plain");
  20838. return Server::HandlerResponse::Handled;
  20839. }
  20840. return Server::HandlerResponse::Unhandled;
  20841. });
  20842. svr.WebSocket("/ws", [](const Request &, ws::WebSocket &ws) {
  20843. std::string msg;
  20844. while (ws.read(msg)) {
  20845. ws.send(msg);
  20846. }
  20847. });
  20848. auto port = svr.bind_to_any_port("localhost");
  20849. std::thread t([&]() { svr.listen_after_bind(); });
  20850. svr.wait_until_ready();
  20851. // Without Authorization header - should be rejected before upgrade
  20852. ws::WebSocketClient client1("ws://localhost:" + std::to_string(port) + "/ws");
  20853. EXPECT_FALSE(client1.connect());
  20854. // The rejection is framed like any other HTTP response
  20855. {
  20856. Client cli("localhost", port);
  20857. Headers headers = {{"Upgrade", "websocket"},
  20858. {"Connection", "Upgrade"},
  20859. {"Sec-WebSocket-Key", "dGhlIHNhbXBsZSBub25jZQ=="},
  20860. {"Sec-WebSocket-Version", "13"}};
  20861. auto res = cli.Get("/ws", headers);
  20862. ASSERT_TRUE(res);
  20863. EXPECT_EQ(StatusCode::Unauthorized_401, res->status);
  20864. EXPECT_EQ("12", res->get_header_value("Content-Length"));
  20865. EXPECT_EQ("Unauthorized", res->body);
  20866. }
  20867. // With Authorization header - should succeed
  20868. Headers headers = {{"Authorization", "Bearer token123"}};
  20869. ws::WebSocketClient client2("ws://localhost:" + std::to_string(port) + "/ws",
  20870. headers);
  20871. ASSERT_TRUE(client2.connect());
  20872. ASSERT_TRUE(client2.send("hello"));
  20873. std::string msg;
  20874. ASSERT_TRUE(client2.read(msg));
  20875. EXPECT_EQ("hello", msg);
  20876. client2.close();
  20877. svr.stop();
  20878. t.join();
  20879. }
  20880. TEST(WebSocketPreRequestTest, RejectWithoutAuth) {
  20881. Server svr;
  20882. std::atomic<int> pre_request_calls{0};
  20883. std::atomic<bool> route_matched{false};
  20884. svr.set_pre_request_handler([&](const Request &req, Response &res) {
  20885. pre_request_calls++;
  20886. if (req.matched_route == "/ws/:id") { route_matched = true; }
  20887. if (req.get_header_value("Authorization") != "Bearer token123") {
  20888. res.status = StatusCode::Unauthorized_401;
  20889. res.set_content("Unauthorized", "text/plain");
  20890. return Server::HandlerResponse::Handled;
  20891. }
  20892. return Server::HandlerResponse::Unhandled;
  20893. });
  20894. std::atomic<bool> handler_called{false};
  20895. svr.WebSocket("/ws/:id", [&](const Request &req, ws::WebSocket &ws) {
  20896. handler_called = true;
  20897. ws.send(req.matched_route + " " + req.path_params.at("id"));
  20898. });
  20899. auto port = svr.bind_to_any_port("localhost");
  20900. std::thread t([&]() { svr.listen_after_bind(); });
  20901. svr.wait_until_ready();
  20902. // Without Authorization header - should be rejected before upgrade
  20903. ws::WebSocketClient client1("ws://localhost:" + std::to_string(port) +
  20904. "/ws/1");
  20905. EXPECT_FALSE(client1.connect());
  20906. EXPECT_FALSE(handler_called);
  20907. EXPECT_EQ(1, pre_request_calls);
  20908. EXPECT_TRUE(route_matched);
  20909. // The rejection is an ordinary HTTP response, not a protocol switch
  20910. {
  20911. Client cli("localhost", port);
  20912. Headers headers = {{"Upgrade", "websocket"},
  20913. {"Connection", "Upgrade"},
  20914. {"Sec-WebSocket-Key", "dGhlIHNhbXBsZSBub25jZQ=="},
  20915. {"Sec-WebSocket-Version", "13"}};
  20916. auto res = cli.Get("/ws/1", headers);
  20917. ASSERT_TRUE(res);
  20918. EXPECT_EQ(StatusCode::Unauthorized_401, res->status);
  20919. EXPECT_EQ("12", res->get_header_value("Content-Length"));
  20920. EXPECT_EQ("Unauthorized", res->body);
  20921. }
  20922. EXPECT_FALSE(handler_called);
  20923. // With Authorization header - should succeed
  20924. Headers headers = {{"Authorization", "Bearer token123"}};
  20925. ws::WebSocketClient client2(
  20926. "ws://localhost:" + std::to_string(port) + "/ws/2", headers);
  20927. ASSERT_TRUE(client2.connect());
  20928. std::string msg;
  20929. ASSERT_TRUE(client2.read(msg));
  20930. EXPECT_EQ("/ws/:id 2", msg);
  20931. EXPECT_TRUE(handler_called);
  20932. client2.close();
  20933. svr.stop();
  20934. t.join();
  20935. }
  20936. TEST(WebSocketServerTimeoutTest, HandlerSendsWhileNothingArrives) {
  20937. Server svr;
  20938. svr.WebSocket("/ws", [](const Request &, ws::WebSocket &ws) {
  20939. // A read timeout is how a handler gets control back. Without it, a handler
  20940. // parked in read() can never write on the connection it is reading.
  20941. ws.set_read_timeout(std::chrono::milliseconds(100));
  20942. std::string msg;
  20943. while (ws.is_open()) {
  20944. auto r = ws.read(msg);
  20945. if (r == httplib::ws::Timeout) {
  20946. ws.send("tick");
  20947. continue;
  20948. }
  20949. if (r == httplib::ws::Fail) { break; }
  20950. ws.send(msg);
  20951. }
  20952. });
  20953. auto port = svr.bind_to_any_port("localhost");
  20954. std::thread t([&]() { svr.listen_after_bind(); });
  20955. svr.wait_until_ready();
  20956. ws::WebSocketClient client("ws://localhost:" + std::to_string(port) + "/ws");
  20957. client.set_read_timeout(10, 0); // fail rather than hang if no tick arrives
  20958. ASSERT_TRUE(client.connect());
  20959. // The client sends nothing, so anything it receives came out of the
  20960. // handler's timeout path.
  20961. std::string msg;
  20962. ASSERT_EQ(client.read(msg), ws::Text);
  20963. EXPECT_EQ("tick", msg);
  20964. client.close();
  20965. svr.stop();
  20966. t.join();
  20967. }
  20968. // Stream::read may return fewer bytes than asked for. This is that contract at
  20969. // its worst -- one byte per call -- which is what a frame header straddling a
  20970. // read buffer's boundary looks like to the frame parser.
  20971. class WsByteAtATimeStream : public Stream {
  20972. public:
  20973. explicit WsByteAtATimeStream(std::string data) : data_(std::move(data)) {}
  20974. bool is_readable() const override { return true; }
  20975. bool wait_readable() const override { return true; }
  20976. bool wait_writable() const override { return true; }
  20977. ssize_t read(char *ptr, size_t size) override {
  20978. if (size == 0 || pos_ >= data_.size()) { return 0; }
  20979. *ptr = data_[pos_++];
  20980. return 1;
  20981. }
  20982. ssize_t write(const char *, size_t size) override {
  20983. return static_cast<ssize_t>(size);
  20984. }
  20985. void get_remote_ip_and_port(std::string &ip, int &port) const override {
  20986. ip = "127.0.0.1";
  20987. port = 0;
  20988. }
  20989. void get_local_ip_and_port(std::string &ip, int &port) const override {
  20990. ip = "127.0.0.1";
  20991. port = 0;
  20992. }
  20993. socket_t socket() const override { return INVALID_SOCKET; }
  20994. time_t duration() const override { return 0; }
  20995. private:
  20996. std::string data_;
  20997. size_t pos_ = 0;
  20998. };
  20999. TEST(WebSocketFrameTest, MultiByteFieldsSplitAcrossReads) {
  21000. // A 200-byte payload uses the 16-bit extended length, so the header, the
  21001. // length and the mask key are all multi-byte fields here. Each used to be
  21002. // read with a single read() call, which fails as soon as one is split.
  21003. std::string body(200, 'x');
  21004. const uint8_t mask[4] = {0x0a, 0x0b, 0x0c, 0x0d};
  21005. std::string frame;
  21006. frame += static_cast<char>(0x81); // FIN + Text
  21007. frame += static_cast<char>(0x80 | 126); // masked, 16-bit length follows
  21008. frame += static_cast<char>(body.size() >> 8);
  21009. frame += static_cast<char>(body.size() & 0xff);
  21010. for (size_t i = 0; i < 4; i++) {
  21011. frame += static_cast<char>(mask[i]);
  21012. }
  21013. for (size_t i = 0; i < body.size(); i++) {
  21014. frame += static_cast<char>(body[i] ^ mask[i % 4]);
  21015. }
  21016. WsByteAtATimeStream strm(frame);
  21017. ws::Opcode opcode;
  21018. std::string payload;
  21019. bool fin = false;
  21020. ASSERT_EQ(ws::impl::read_websocket_frame(strm, opcode, payload, fin,
  21021. /*expect_masked=*/true, 1024),
  21022. ws::impl::FrameRead::Ok);
  21023. EXPECT_TRUE(fin);
  21024. EXPECT_EQ(opcode, ws::Opcode::Text);
  21025. EXPECT_EQ(payload, body);
  21026. }
  21027. TEST(WebSocketTest, QueryStringInHandshake) {
  21028. Server svr;
  21029. std::mutex mtx;
  21030. std::string received_target;
  21031. std::string received_token;
  21032. svr.WebSocket("/ws", [&](const Request &req, ws::WebSocket &ws) {
  21033. {
  21034. std::lock_guard<std::mutex> lock(mtx);
  21035. received_target = req.target;
  21036. if (req.has_param("token")) {
  21037. received_token = req.get_param_value("token");
  21038. }
  21039. }
  21040. std::string msg;
  21041. while (ws.read(msg)) {
  21042. ws.send(msg);
  21043. }
  21044. });
  21045. auto port = svr.bind_to_any_port("localhost");
  21046. std::thread t([&]() { svr.listen_after_bind(); });
  21047. svr.wait_until_ready();
  21048. ws::WebSocketClient client("ws://localhost:" + std::to_string(port) +
  21049. "/ws?token=ABC&session=123");
  21050. ASSERT_TRUE(client.connect());
  21051. // Round-trip ensures the handler has run and captured the request.
  21052. ASSERT_TRUE(client.send("hello"));
  21053. std::string msg;
  21054. ASSERT_TRUE(client.read(msg));
  21055. EXPECT_EQ("hello", msg);
  21056. client.close();
  21057. {
  21058. std::lock_guard<std::mutex> lock(mtx);
  21059. EXPECT_EQ("/ws?token=ABC&session=123", received_target);
  21060. EXPECT_EQ("ABC", received_token);
  21061. }
  21062. svr.stop();
  21063. t.join();
  21064. }
  21065. // Run a handshake against a throwaway server and hand the request the server
  21066. // received back to the caller, so tests can assert on the headers the client
  21067. // actually put on the wire.
  21068. static void capture_websocket_handshake_request(
  21069. const Headers &client_headers,
  21070. std::function<void(const Request &, int port)> verify) {
  21071. Server svr;
  21072. std::mutex mtx;
  21073. Request received;
  21074. svr.WebSocket("/ws", [&](const Request &req, ws::WebSocket &ws) {
  21075. {
  21076. std::lock_guard<std::mutex> lock(mtx);
  21077. received = req;
  21078. }
  21079. std::string msg;
  21080. while (ws.read(msg)) {
  21081. ws.send(msg);
  21082. }
  21083. });
  21084. auto port = svr.bind_to_any_port("localhost");
  21085. std::thread t([&]() { svr.listen_after_bind(); });
  21086. auto se = detail::scope_exit([&] {
  21087. svr.stop();
  21088. t.join();
  21089. });
  21090. svr.wait_until_ready();
  21091. ws::WebSocketClient client("ws://localhost:" + std::to_string(port) + "/ws",
  21092. client_headers);
  21093. ASSERT_TRUE(client.connect());
  21094. ASSERT_TRUE(client.send("hello"));
  21095. std::string msg;
  21096. ASSERT_TRUE(client.read(msg));
  21097. client.close();
  21098. {
  21099. std::lock_guard<std::mutex> lock(mtx);
  21100. verify(received, port);
  21101. }
  21102. }
  21103. TEST(WebSocketTest, DefaultHeadersInHandshake) {
  21104. capture_websocket_handshake_request({}, [](const Request &req, int port) {
  21105. // Non-default port must be present in the Host header. Default ports
  21106. // (80/443) are omitted; that logic is covered by
  21107. // MakeHostAndPortStringTest.
  21108. EXPECT_EQ("localhost:" + std::to_string(port),
  21109. req.get_header_value("Host"));
  21110. EXPECT_EQ(std::string("cpp-httplib/") + CPPHTTPLIB_VERSION,
  21111. req.get_header_value("User-Agent"));
  21112. EXPECT_FALSE(req.has_header("Accept"));
  21113. EXPECT_FALSE(req.has_header("Accept-Encoding"));
  21114. EXPECT_FALSE(req.has_header("Content-Length"));
  21115. });
  21116. }
  21117. TEST(WebSocketTest, UserHeadersOverrideGeneratedOnesInHandshake) {
  21118. capture_websocket_handshake_request(
  21119. {{"Host", "example.com"},
  21120. {"User-Agent", "custom-agent"},
  21121. {"X-Custom", "value"}},
  21122. [](const Request &req, int) {
  21123. EXPECT_EQ("example.com", req.get_header_value("Host"));
  21124. EXPECT_EQ(1U, req.get_header_value_count("Host"));
  21125. EXPECT_EQ("custom-agent", req.get_header_value("User-Agent"));
  21126. EXPECT_EQ(1U, req.get_header_value_count("User-Agent"));
  21127. EXPECT_EQ("value", req.get_header_value("X-Custom"));
  21128. });
  21129. }
  21130. TEST(WebSocketTest, MandatoryHeadersInHandshakeAreEnforced) {
  21131. capture_websocket_handshake_request(
  21132. {{"Upgrade", "bogus"},
  21133. {"Connection", "close"},
  21134. {"Sec-WebSocket-Key", "AAAAAAAAAAAAAAAAAAAAAA=="},
  21135. {"Sec-WebSocket-Version", "8"}},
  21136. [](const Request &req, int) {
  21137. EXPECT_EQ("websocket", req.get_header_value("Upgrade"));
  21138. EXPECT_EQ(1U, req.get_header_value_count("Upgrade"));
  21139. EXPECT_EQ("Upgrade", req.get_header_value("Connection"));
  21140. EXPECT_EQ(1U, req.get_header_value_count("Connection"));
  21141. EXPECT_EQ("13", req.get_header_value("Sec-WebSocket-Version"));
  21142. EXPECT_EQ(1U, req.get_header_value_count("Sec-WebSocket-Version"));
  21143. EXPECT_EQ(1U, req.get_header_value_count("Sec-WebSocket-Key"));
  21144. EXPECT_NE("AAAAAAAAAAAAAAAAAAAAAA==",
  21145. req.get_header_value("Sec-WebSocket-Key"));
  21146. });
  21147. }
  21148. TEST(WebSocketTest, InvalidHeaderInHandshakeWritesNothing) {
  21149. // A header the client refuses to send must abort the handshake before any
  21150. // part of it reaches the wire; a lone request line would otherwise sit in
  21151. // the peer's buffer as a truncated request.
  21152. auto srv = ::socket(AF_INET, SOCK_STREAM, 0);
  21153. ASSERT_NE(INVALID_SOCKET, srv);
  21154. auto se_srv = detail::scope_exit([&] { detail::close_socket(srv); });
  21155. sockaddr_in addr{};
  21156. addr.sin_family = AF_INET;
  21157. addr.sin_port = 0; // ephemeral, so parallel shards don't collide
  21158. ::inet_pton(AF_INET, "127.0.0.1", &addr.sin_addr);
  21159. ASSERT_EQ(0, ::bind(srv, reinterpret_cast<sockaddr *>(&addr), sizeof(addr)));
  21160. ASSERT_EQ(0, ::listen(srv, 1));
  21161. sockaddr_in bound{};
  21162. socklen_t bound_len = sizeof(bound);
  21163. ASSERT_EQ(
  21164. 0, ::getsockname(srv, reinterpret_cast<sockaddr *>(&bound), &bound_len));
  21165. auto port = ntohs(bound.sin_port);
  21166. ssize_t received = -1;
  21167. std::thread t([&] {
  21168. // Bound every blocking call so a regression fails the test with a bad
  21169. // value instead of hanging the suite.
  21170. fd_set rfds;
  21171. FD_ZERO(&rfds);
  21172. FD_SET(srv, &rfds);
  21173. timeval tv{5, 0};
  21174. if (::select(static_cast<int>(srv + 1), &rfds, nullptr, nullptr, &tv) <=
  21175. 0) {
  21176. return;
  21177. }
  21178. sockaddr_in cli_addr{};
  21179. socklen_t cli_len = sizeof(cli_addr);
  21180. auto cli = ::accept(srv, reinterpret_cast<sockaddr *>(&cli_addr), &cli_len);
  21181. if (cli == INVALID_SOCKET) { return; }
  21182. auto se_cli = detail::scope_exit([&] { detail::close_socket(cli); });
  21183. detail::set_socket_opt_time(cli, SOL_SOCKET, SO_RCVTIMEO, 5, 0);
  21184. char buf[4096];
  21185. received = ::recv(cli, buf, sizeof(buf), 0);
  21186. });
  21187. // The CR/LF makes the value invalid, so check_and_write_headers rejects it.
  21188. // connect() has already shut the socket down by the time it returns false,
  21189. // so the peer sees EOF without waiting for the client to be destroyed.
  21190. ws::WebSocketClient client("ws://127.0.0.1:" + std::to_string(port) + "/ws",
  21191. {{"X-Bad", "a\r\nInjected: 1"}});
  21192. EXPECT_FALSE(client.connect());
  21193. t.join();
  21194. // 0 means the peer saw a clean EOF without a single byte of the handshake.
  21195. EXPECT_EQ(0, received);
  21196. }
  21197. TEST(WebSocketTest, ConnectionHeaderNeedsCompleteUpgradeToken) {
  21198. // RFC 6455 4.2.1: Connection is a token list, so a value that merely
  21199. // contains "upgrade" as a substring is a different token and must not
  21200. // start a WebSocket handshake.
  21201. auto make_request = [](const std::vector<std::string> &connection_values) {
  21202. Request req;
  21203. req.method = "GET";
  21204. req.headers.emplace("Upgrade", "websocket");
  21205. for (const auto &value : connection_values) {
  21206. req.headers.emplace("Connection", value);
  21207. }
  21208. req.headers.emplace("Sec-WebSocket-Key", "dGhlIHNhbXBsZSBub25jZQ==");
  21209. req.headers.emplace("Sec-WebSocket-Version", "13");
  21210. return req;
  21211. };
  21212. EXPECT_TRUE(detail::is_websocket_upgrade(make_request({"Upgrade"})));
  21213. EXPECT_TRUE(detail::is_websocket_upgrade(make_request({"upgrade"})));
  21214. EXPECT_TRUE(
  21215. detail::is_websocket_upgrade(make_request({"keep-alive, Upgrade"})));
  21216. EXPECT_TRUE(
  21217. detail::is_websocket_upgrade(make_request({"Upgrade , keep-alive"})));
  21218. EXPECT_TRUE(
  21219. detail::is_websocket_upgrade(make_request({"keep-alive", "Upgrade"})));
  21220. EXPECT_FALSE(detail::is_websocket_upgrade(make_request({"notupgrade"})));
  21221. EXPECT_FALSE(detail::is_websocket_upgrade(make_request({"upgrade-not"})));
  21222. EXPECT_FALSE(detail::is_websocket_upgrade(make_request({"xupgrade"})));
  21223. EXPECT_FALSE(
  21224. detail::is_websocket_upgrade(make_request({"keep-alive, notupgrade"})));
  21225. EXPECT_FALSE(detail::is_websocket_upgrade(make_request({"close"})));
  21226. EXPECT_FALSE(detail::is_websocket_upgrade(make_request({})));
  21227. }
  21228. TEST(WebSocketTest, UpgradeHeaderNeedsCompleteWebsocketToken) {
  21229. // RFC 9110 7.8 defines Upgrade as a comma-separated list of protocols and
  21230. // asks recipients to match each protocol-name case-insensitively, and RFC
  21231. // 6455 4.2.1 asks for a header field containing the value "websocket". A
  21232. // client naming websocket alongside another protocol, or on a second field
  21233. // line, is offering websocket; a value that merely contains "websocket" as a
  21234. // substring is a different protocol name and is not.
  21235. auto make_request = [](const std::vector<std::string> &upgrade_values) {
  21236. Request req;
  21237. req.method = "GET";
  21238. for (const auto &value : upgrade_values) {
  21239. req.headers.emplace("Upgrade", value);
  21240. }
  21241. req.headers.emplace("Connection", "Upgrade");
  21242. req.headers.emplace("Sec-WebSocket-Key", "dGhlIHNhbXBsZSBub25jZQ==");
  21243. req.headers.emplace("Sec-WebSocket-Version", "13");
  21244. return req;
  21245. };
  21246. EXPECT_TRUE(detail::is_websocket_upgrade(make_request({"websocket"})));
  21247. EXPECT_TRUE(detail::is_websocket_upgrade(make_request({"WebSocket"})));
  21248. EXPECT_TRUE(
  21249. detail::is_websocket_upgrade(make_request({"websocket, HTTP/3.0"})));
  21250. EXPECT_TRUE(
  21251. detail::is_websocket_upgrade(make_request({"HTTP/3.0 , websocket"})));
  21252. EXPECT_TRUE(
  21253. detail::is_websocket_upgrade(make_request({"HTTP/3.0", "websocket"})));
  21254. EXPECT_FALSE(detail::is_websocket_upgrade(make_request({"notwebsocket"})));
  21255. EXPECT_FALSE(detail::is_websocket_upgrade(make_request({"websocket-2"})));
  21256. EXPECT_FALSE(detail::is_websocket_upgrade(make_request({"xwebsocket"})));
  21257. EXPECT_FALSE(
  21258. detail::is_websocket_upgrade(make_request({"HTTP/3.0, notwebsocket"})));
  21259. EXPECT_FALSE(detail::is_websocket_upgrade(make_request({"h2c"})));
  21260. EXPECT_FALSE(detail::is_websocket_upgrade(make_request({})));
  21261. }
  21262. TEST(WebSocketTest, ServerRejectsHandshakeWithoutUpgradeToken) {
  21263. Server svr;
  21264. svr.WebSocket("/ws", [](const Request &, ws::WebSocket &) {});
  21265. auto port = svr.bind_to_any_port("localhost");
  21266. std::thread t([&]() { svr.listen_after_bind(); });
  21267. auto se = detail::scope_exit([&] {
  21268. svr.stop();
  21269. t.join();
  21270. });
  21271. svr.wait_until_ready();
  21272. Headers headers = {{"Upgrade", "websocket"},
  21273. {"Connection", "notupgrade"},
  21274. {"Sec-WebSocket-Key", "dGhlIHNhbXBsZSBub25jZQ=="},
  21275. {"Sec-WebSocket-Version", "13"}};
  21276. Client cli("localhost", port);
  21277. auto res = cli.Get("/ws", headers);
  21278. // The route exists only as a WebSocket route, so a request that fails the
  21279. // handshake check falls through to ordinary routing.
  21280. ASSERT_TRUE(res);
  21281. EXPECT_EQ(StatusCode::NotFound_404, res->status);
  21282. }
  21283. TEST(WebSocketTest, ClientRejectsResponseWithoutUpgradeToken) {
  21284. // The peer answers 101 with a correct Sec-WebSocket-Accept, so the
  21285. // Connection value is the only thing left for the client to reject.
  21286. Server svr;
  21287. svr.Get("/ws", [](const Request &req, Response &res) {
  21288. res.status = StatusCode::SwitchingProtocol_101;
  21289. res.set_header("Upgrade", "websocket");
  21290. res.set_header("Connection", "notupgrade");
  21291. res.set_header("Sec-WebSocket-Accept",
  21292. detail::websocket_accept_key(
  21293. req.get_header_value("Sec-WebSocket-Key")));
  21294. });
  21295. auto port = svr.bind_to_any_port("localhost");
  21296. std::thread t([&]() { svr.listen_after_bind(); });
  21297. auto se = detail::scope_exit([&] {
  21298. svr.stop();
  21299. t.join();
  21300. });
  21301. svr.wait_until_ready();
  21302. ws::WebSocketClient client("ws://localhost:" + std::to_string(port) + "/ws");
  21303. auto res = client.connect();
  21304. EXPECT_FALSE(res);
  21305. EXPECT_EQ(Error::WebSocketHandshake, res.error());
  21306. EXPECT_FALSE(client.is_open());
  21307. }
  21308. TEST(WebSocketTest, ClientRejectsUnofferedSubprotocol) {
  21309. Server svr;
  21310. svr.Get("/ws", [](const Request &req, Response &res) {
  21311. res.status = StatusCode::SwitchingProtocol_101;
  21312. res.set_header("Upgrade", "websocket");
  21313. res.set_header("Connection", "Upgrade");
  21314. res.set_header("Sec-WebSocket-Accept",
  21315. detail::websocket_accept_key(
  21316. req.get_header_value("Sec-WebSocket-Key")));
  21317. res.set_header("Sec-WebSocket-Protocol", "admin");
  21318. });
  21319. auto port = svr.bind_to_any_port("localhost");
  21320. std::thread t([&]() { svr.listen_after_bind(); });
  21321. auto se = detail::scope_exit([&] {
  21322. svr.stop();
  21323. t.join();
  21324. });
  21325. svr.wait_until_ready();
  21326. const auto url = "ws://localhost:" + std::to_string(port) + "/ws";
  21327. // Server selects a subprotocol the client never offered
  21328. {
  21329. Headers headers = {{"Sec-WebSocket-Protocol", "chat"}};
  21330. ws::WebSocketClient client(url, headers);
  21331. auto res = client.connect();
  21332. EXPECT_FALSE(res);
  21333. EXPECT_EQ(Error::WebSocketHandshake, res.error());
  21334. EXPECT_FALSE(client.is_open());
  21335. EXPECT_TRUE(client.subprotocol().empty());
  21336. }
  21337. // Client offered none but the server named one anyway
  21338. {
  21339. ws::WebSocketClient client(url);
  21340. auto res = client.connect();
  21341. EXPECT_FALSE(res);
  21342. EXPECT_EQ(Error::WebSocketHandshake, res.error());
  21343. EXPECT_FALSE(client.is_open());
  21344. EXPECT_TRUE(client.subprotocol().empty());
  21345. }
  21346. }
  21347. TEST(WebSocketTest, HostHeaderOverUnixSocket) {
  21348. // The socket path doubles as the URL host, so it must not contain '/'.
  21349. const char *shard = getenv("GTEST_SHARD_INDEX");
  21350. const std::string sock_path =
  21351. shard ? std::string("httplib-ws-") + shard + ".sock"
  21352. : std::string("httplib-ws.sock");
  21353. std::remove(sock_path.c_str());
  21354. Server svr;
  21355. std::mutex mtx;
  21356. std::string received_host;
  21357. svr.WebSocket("/ws", [&](const Request &req, ws::WebSocket &ws) {
  21358. {
  21359. std::lock_guard<std::mutex> lock(mtx);
  21360. received_host = req.get_header_value("Host");
  21361. }
  21362. std::string msg;
  21363. while (ws.read(msg)) {
  21364. ws.send(msg);
  21365. }
  21366. });
  21367. svr.set_address_family(AF_UNIX);
  21368. std::thread t([&]() { ASSERT_TRUE(svr.listen(sock_path, 80)); });
  21369. auto se = detail::scope_exit([&] {
  21370. svr.stop();
  21371. t.join();
  21372. std::remove(sock_path.c_str());
  21373. });
  21374. svr.wait_until_ready();
  21375. ws::WebSocketClient client("ws://" + sock_path + "/ws");
  21376. client.set_address_family(AF_UNIX);
  21377. ASSERT_TRUE(client.connect());
  21378. ASSERT_TRUE(client.send("hello"));
  21379. std::string msg;
  21380. ASSERT_TRUE(client.read(msg));
  21381. client.close();
  21382. {
  21383. std::lock_guard<std::mutex> lock(mtx);
  21384. // There is no host:port for a Unix socket, so the same "localhost"
  21385. // placeholder the HTTP client uses is expected.
  21386. EXPECT_EQ("localhost", received_host);
  21387. }
  21388. }
  21389. // Two threads must never parse WebSocket frames from the same stream.
  21390. // close() used to read the peer's Close reply with its own frame read, so it
  21391. // raced a reader thread that was in the middle of a payload: the payload loop
  21392. // in read_websocket_frame() keeps reading until payload_len bytes are in hand,
  21393. // so bytes taken by close() were replaced with bytes from further along the
  21394. // stream. The message kept its length and silently changed content.
  21395. //
  21396. // The raw peer below sends a frame header plus part of the payload, waits for
  21397. // the handler to call close(), and only then sends the rest. Whichever thread
  21398. // would win the race for those bytes, the message must arrive intact, because
  21399. // close() must not touch the stream while read() owns it.
  21400. TEST(WebSocketTest, CloseDoesNotStealBytesFromConcurrentRead) {
  21401. #ifndef _WIN32
  21402. signal(SIGPIPE, SIG_IGN);
  21403. #endif
  21404. const size_t payload_len = 120; // fits the 7-bit length field
  21405. const size_t prefix_len = 8;
  21406. const int attempts = 8;
  21407. std::string expected(payload_len, '\0');
  21408. for (size_t i = 0; i < payload_len; i++) {
  21409. expected[i] = static_cast<char>('a' + i % 26);
  21410. }
  21411. std::atomic<bool> peer_stalled{false};
  21412. std::atomic<bool> handler_done{false};
  21413. std::mutex received_mutex;
  21414. std::vector<std::string> received;
  21415. // Bound every wait, so a regression fails the test instead of hanging the
  21416. // suite.
  21417. auto wait_for = [](const std::atomic<bool> &flag) {
  21418. for (int i = 0; i < 500 && !flag; i++) {
  21419. std::this_thread::sleep_for(std::chrono::milliseconds(10));
  21420. }
  21421. };
  21422. Server svr;
  21423. svr.set_websocket_ping_interval(0);
  21424. svr.WebSocket("/ws", [&](const Request &, ws::WebSocket &ws) {
  21425. std::thread reader([&]() {
  21426. std::string msg;
  21427. while (ws.read(msg)) {
  21428. std::lock_guard<std::mutex> guard(received_mutex);
  21429. received.push_back(msg);
  21430. }
  21431. });
  21432. // Wait until the peer stalls mid-payload, so the reader thread is parked
  21433. // inside read_websocket_frame() when close() runs.
  21434. wait_for(peer_stalled);
  21435. ws.close();
  21436. reader.join();
  21437. handler_done = true;
  21438. });
  21439. auto port = svr.bind_to_any_port("127.0.0.1");
  21440. std::thread t([&]() { svr.listen_after_bind(); });
  21441. auto se = detail::scope_exit([&] {
  21442. svr.stop();
  21443. t.join();
  21444. });
  21445. svr.wait_until_ready();
  21446. auto send_bytes = [](socket_t s, const std::string &data) {
  21447. #ifdef _WIN32
  21448. auto n = ::send(s, data.data(), static_cast<int>(data.size()), 0);
  21449. #else
  21450. auto n = ::send(s, data.data(), data.size(), 0);
  21451. #endif
  21452. return n == static_cast<decltype(n)>(data.size());
  21453. };
  21454. // Frame header with an all-zero mask key, so the payload goes out verbatim.
  21455. // Every length used here fits the 7-bit length field.
  21456. auto masked_header = [](uint8_t first_byte, size_t len) {
  21457. std::string h;
  21458. h += static_cast<char>(first_byte);
  21459. h += static_cast<char>(0x80 | len); // masked, 7-bit length
  21460. h.append(4, '\0'); // mask key
  21461. return h;
  21462. };
  21463. for (int attempt = 0; attempt < attempts; attempt++) {
  21464. peer_stalled = false;
  21465. handler_done = false;
  21466. auto sock = ::socket(AF_INET, SOCK_STREAM, 0);
  21467. ASSERT_NE(INVALID_SOCKET, sock) << "attempt " << attempt;
  21468. auto se_sock = detail::scope_exit([&] {
  21469. if (sock != INVALID_SOCKET) { detail::close_socket(sock); }
  21470. });
  21471. detail::set_socket_opt_time(sock, SOL_SOCKET, SO_RCVTIMEO, 5, 0);
  21472. detail::set_socket_opt_time(sock, SOL_SOCKET, SO_SNDTIMEO, 5, 0);
  21473. sockaddr_in addr{};
  21474. addr.sin_family = AF_INET;
  21475. addr.sin_port = htons(static_cast<uint16_t>(port));
  21476. ::inet_pton(AF_INET, "127.0.0.1", &addr.sin_addr);
  21477. ASSERT_EQ(
  21478. 0, ::connect(sock, reinterpret_cast<sockaddr *>(&addr), sizeof(addr)))
  21479. << "attempt " << attempt;
  21480. ASSERT_TRUE(send_bytes(sock,
  21481. "GET /ws HTTP/1.1\r\n"
  21482. "Host: 127.0.0.1\r\n"
  21483. "Upgrade: websocket\r\n"
  21484. "Connection: Upgrade\r\n"
  21485. "Sec-WebSocket-Key: AAAAAAAAAAAAAAAAAAAAAA==\r\n"
  21486. "Sec-WebSocket-Version: 13\r\n"
  21487. "\r\n"))
  21488. << "attempt " << attempt;
  21489. std::string response;
  21490. while (response.find("\r\n\r\n") == std::string::npos) {
  21491. char buf[512];
  21492. auto n = ::recv(sock, buf, static_cast<int>(sizeof(buf)), 0);
  21493. if (n <= 0) { break; }
  21494. response.append(buf, static_cast<size_t>(n));
  21495. }
  21496. ASSERT_NE(std::string::npos, response.find(" 101 "))
  21497. << "attempt " << attempt;
  21498. // Send the header of a Binary message but only the first prefix_len bytes
  21499. // of its payload, leaving the reader thread stalled inside the payload.
  21500. ASSERT_TRUE(send_bytes(sock, masked_header(0x82, payload_len) +
  21501. expected.substr(0, prefix_len)))
  21502. << "attempt " << attempt;
  21503. std::this_thread::sleep_for(std::chrono::milliseconds(50));
  21504. peer_stalled = true;
  21505. // Let close() send its Close frame and park in its own read before the
  21506. // rest of the payload arrives, so both threads are waiting for it.
  21507. std::this_thread::sleep_for(std::chrono::milliseconds(50));
  21508. std::string close_frame = masked_header(0x88, 2); // FIN + Close
  21509. close_frame += static_cast<char>(0x03); // status 1000
  21510. close_frame += static_cast<char>(0xE8);
  21511. ASSERT_TRUE(send_bytes(sock, expected.substr(prefix_len) + close_frame))
  21512. << "attempt " << attempt;
  21513. // Closing the peer releases the reader thread even on the buggy path,
  21514. // where it waits for bytes another thread already consumed.
  21515. std::this_thread::sleep_for(std::chrono::milliseconds(50));
  21516. detail::close_socket(sock);
  21517. sock = INVALID_SOCKET;
  21518. wait_for(handler_done);
  21519. ASSERT_TRUE(handler_done) << "attempt " << attempt;
  21520. }
  21521. std::lock_guard<std::mutex> guard(received_mutex);
  21522. EXPECT_EQ(static_cast<size_t>(attempts), received.size())
  21523. << "a message in flight when close() ran was dropped";
  21524. for (size_t i = 0; i < received.size(); i++) {
  21525. EXPECT_EQ(expected, received[i]) << "message " << i;
  21526. }
  21527. }
  21528. #ifdef CPPHTTPLIB_OPENSSL_SUPPORT
  21529. class WebSocketSSLIntegrationTest : public ::testing::Test {
  21530. protected:
  21531. void SetUp() override {
  21532. server_ = httplib::detail::make_unique<SSLServer>(SERVER_CERT_FILE,
  21533. SERVER_PRIVATE_KEY_FILE);
  21534. server_->WebSocket("/ws-echo", [](const Request &, ws::WebSocket &ws) {
  21535. std::string msg;
  21536. ws::ReadResult ret;
  21537. while ((ret = ws.read(msg))) {
  21538. if (ret == ws::Binary) {
  21539. ws.send(msg.data(), msg.size());
  21540. } else {
  21541. ws.send(msg);
  21542. }
  21543. }
  21544. });
  21545. port_ = server_->bind_to_any_port(HOST);
  21546. server_thread_ = std::thread([this]() { server_->listen_after_bind(); });
  21547. server_->wait_until_ready();
  21548. }
  21549. void TearDown() override {
  21550. server_->stop();
  21551. if (server_thread_.joinable()) { server_thread_.join(); }
  21552. }
  21553. std::unique_ptr<SSLServer> server_;
  21554. std::thread server_thread_;
  21555. int port_ = 0;
  21556. };
  21557. TEST_F(WebSocketSSLIntegrationTest, TextEcho) {
  21558. ws::WebSocketClient client("wss://localhost:" + std::to_string(port_) +
  21559. "/ws-echo");
  21560. client.enable_server_certificate_verification(false);
  21561. ASSERT_TRUE(client.connect());
  21562. ASSERT_TRUE(client.is_open());
  21563. ASSERT_TRUE(client.send("Hello WSS"));
  21564. std::string msg;
  21565. EXPECT_EQ(ws::Text, client.read(msg));
  21566. EXPECT_EQ("Hello WSS", msg);
  21567. client.close();
  21568. }
  21569. // Regression test (GHSA-w7p7-f35j-mw7q): shutdown_and_close() used to free the
  21570. // TLS session before ws_->close() sent the close frame. Because the WebSocket's
  21571. // SSLSocketStream keeps a raw pointer to that session, sending the close frame
  21572. // then read/wrote a freed SSL object (use-after-free). Destroying an open wss
  21573. // client (without calling close() first) is the only path that runs
  21574. // shutdown_and_close() while the WebSocket is still open, so it reproduces the
  21575. // bug exactly.
  21576. //
  21577. // NOTE: the offending read/write happens inside OpenSSL, so ASan only flags it
  21578. // when linked against an instrumented libssl; run under Valgrind to catch it
  21579. // with a stock OpenSSL. The short timeouts keep a regression from wedging the
  21580. // suite (the freed session otherwise stalls on the close handshake) — this test
  21581. // is a memory-tool tripwire, not a pass/fail assertion on stock builds.
  21582. TEST_F(WebSocketSSLIntegrationTest, DestroyWhileOpenSendsCloseOverLiveSession) {
  21583. {
  21584. ws::WebSocketClient client("wss://localhost:" + std::to_string(port_) +
  21585. "/ws-echo");
  21586. client.enable_server_certificate_verification(false);
  21587. client.set_read_timeout(2, 0);
  21588. client.set_write_timeout(2, 0);
  21589. ASSERT_TRUE(client.connect());
  21590. ASSERT_TRUE(client.is_open());
  21591. ASSERT_TRUE(client.send("still open"));
  21592. // Intentionally do NOT call client.close(): leaving scope runs
  21593. // shutdown_and_close() with the WebSocket still open, which must send the
  21594. // close frame while the TLS session is still alive.
  21595. }
  21596. }
  21597. // Regression test (GHSA-w7p7-f35j-mw7q): reconnecting an open wss client runs
  21598. // shutdown_and_close() at the start of connect(), reproducing the same
  21599. // use-after-free within the test body rather than at scope exit. The second
  21600. // connect must succeed and echo, proving the close handshake ran over a live
  21601. // session. See the note above about memory-tool requirements.
  21602. TEST_F(WebSocketSSLIntegrationTest,
  21603. ReconnectWhileOpenSendsCloseOverLiveSession) {
  21604. ws::WebSocketClient client("wss://localhost:" + std::to_string(port_) +
  21605. "/ws-echo");
  21606. client.enable_server_certificate_verification(false);
  21607. client.set_read_timeout(2, 0);
  21608. client.set_write_timeout(2, 0);
  21609. ASSERT_TRUE(client.connect());
  21610. ASSERT_TRUE(client.is_open());
  21611. ASSERT_TRUE(client.send("still open"));
  21612. // Reconnect without closing first: connect() calls shutdown_and_close() on
  21613. // the still-open connection, which must not touch a freed TLS session.
  21614. ASSERT_TRUE(client.connect());
  21615. ASSERT_TRUE(client.is_open());
  21616. ASSERT_TRUE(client.send("after reconnect"));
  21617. std::string msg;
  21618. EXPECT_EQ(ws::Text, client.read(msg));
  21619. EXPECT_EQ("after reconnect", msg);
  21620. client.close();
  21621. }
  21622. #endif
  21623. #ifdef CPPHTTPLIB_SSL_ENABLED
  21624. class WebSocketSSLCATest : public ::testing::Test {
  21625. protected:
  21626. void SetUp() override {
  21627. server_ = httplib::detail::make_unique<SSLServer>(SERVER_CERT2_FILE,
  21628. SERVER_PRIVATE_KEY_FILE);
  21629. server_->WebSocket("/echo", [](const Request &, ws::WebSocket &ws) {
  21630. std::string msg;
  21631. while (ws.read(msg)) {
  21632. ws.send(msg);
  21633. }
  21634. });
  21635. port_ = server_->bind_to_any_port("127.0.0.1");
  21636. server_thread_ = std::thread([this]() { server_->listen_after_bind(); });
  21637. server_->wait_until_ready();
  21638. }
  21639. void TearDown() override {
  21640. server_->stop();
  21641. if (server_thread_.joinable()) { server_thread_.join(); }
  21642. }
  21643. std::string url() const {
  21644. return "wss://127.0.0.1:" + std::to_string(port_) + "/echo";
  21645. }
  21646. std::unique_ptr<SSLServer> server_;
  21647. std::thread server_thread_;
  21648. int port_ = 0;
  21649. };
  21650. // A custom CA loaded as PEM verifies the server with full certificate
  21651. // verification enabled
  21652. TEST_F(WebSocketSSLCATest, LoadCaCertStoreVerifiesServer) {
  21653. ws::WebSocketClient client(url());
  21654. std::string cert;
  21655. read_file(SERVER_CERT2_FILE, cert);
  21656. client.load_ca_cert_store(cert.c_str(), cert.size());
  21657. ASSERT_TRUE(client.connect());
  21658. ASSERT_TRUE(client.send("hello"));
  21659. std::string msg;
  21660. EXPECT_EQ(ws::Text, client.read(msg));
  21661. EXPECT_EQ("hello", msg);
  21662. client.close();
  21663. }
  21664. // A custom CA that does not cover the server must fail verification (the
  21665. // custom CA is exclusive; system certs are not loaded alongside it)
  21666. TEST_F(WebSocketSSLCATest, WrongCustomCaFailsVerification) {
  21667. ws::WebSocketClient client(url());
  21668. std::string cert;
  21669. read_file(CLIENT_CA_CERT_FILE, cert);
  21670. client.load_ca_cert_store(cert.c_str(), cert.size());
  21671. auto res = client.connect();
  21672. ASSERT_FALSE(res);
  21673. EXPECT_EQ(Error::SSLServerVerification, res.error());
  21674. EXPECT_EQ(-1, res.status());
  21675. EXPECT_NE(0u, res.ssl_backend_error());
  21676. }
  21677. // The same CA as a file path rather than PEM in memory
  21678. TEST_F(WebSocketSSLCATest, SetCaCertPathVerifiesServer) {
  21679. ws::WebSocketClient client(url());
  21680. client.set_ca_cert_path(SERVER_CERT2_FILE);
  21681. ASSERT_TRUE(client.connect());
  21682. ASSERT_TRUE(client.send("hello"));
  21683. std::string msg;
  21684. EXPECT_EQ(ws::Text, client.read(msg));
  21685. EXPECT_EQ("hello", msg);
  21686. client.close();
  21687. }
  21688. // ...and a CA file that does not cover the server still fails, so it is the
  21689. // path above that decides the outcome
  21690. TEST_F(WebSocketSSLCATest, WrongCaCertPathFailsVerification) {
  21691. ws::WebSocketClient client(url());
  21692. client.set_ca_cert_path(CLIENT_CA_CERT_FILE);
  21693. ASSERT_FALSE(client.connect());
  21694. }
  21695. // Regression test: reconnecting with a native custom CA store used to reuse
  21696. // a store handle the previous TLS context had already freed (use-after-free
  21697. // under the OpenSSL backend). The context now lives as long as the client.
  21698. TEST_F(WebSocketSSLCATest, ReconnectWithCustomCaStore) {
  21699. ws::WebSocketClient client(url());
  21700. std::string cert;
  21701. read_file(SERVER_CERT2_FILE, cert);
  21702. client.set_ca_cert_store(tls::create_ca_store(cert.c_str(), cert.size()));
  21703. ASSERT_TRUE(client.connect());
  21704. client.close();
  21705. ASSERT_TRUE(client.connect());
  21706. ASSERT_TRUE(client.send("again"));
  21707. std::string msg;
  21708. EXPECT_EQ(ws::Text, client.read(msg));
  21709. EXPECT_EQ("again", msg);
  21710. client.close();
  21711. }
  21712. // Regression test: a certificate with a trusted chain but no identity match
  21713. // for the server IP must be rejected. The Mbed TLS backend used to skip
  21714. // verification entirely for IP hosts, so this connection succeeded there.
  21715. // SERVER_CERT_FILE has no IP SAN (CN only), so trusting it as a CA satisfies
  21716. // chain verification while the identity check must still fail.
  21717. TEST(WebSocketSSLVerifyTest, TrustedChainWrongIdentityFails) {
  21718. SSLServer svr(SERVER_CERT_FILE, SERVER_PRIVATE_KEY_FILE);
  21719. ASSERT_TRUE(svr.is_valid());
  21720. svr.WebSocket("/echo", [](const Request &, ws::WebSocket &ws) {
  21721. std::string msg;
  21722. while (ws.read(msg)) {
  21723. ws.send(msg);
  21724. }
  21725. });
  21726. auto port = svr.bind_to_any_port("127.0.0.1");
  21727. auto t = std::thread([&]() { svr.listen_after_bind(); });
  21728. auto se = detail::scope_exit([&] {
  21729. svr.stop();
  21730. t.join();
  21731. });
  21732. svr.wait_until_ready();
  21733. ws::WebSocketClient client("wss://127.0.0.1:" + std::to_string(port) +
  21734. "/echo");
  21735. std::string cert;
  21736. read_file(SERVER_CERT_FILE, cert);
  21737. client.load_ca_cert_store(cert.c_str(), cert.size());
  21738. ASSERT_FALSE(client.connect());
  21739. }
  21740. // The tests above all connect to an IP literal, for which RFC 6066 forbids
  21741. // SNI, so nothing binds the host name to the TLS session. These bind the
  21742. // server to "localhost" instead, the only shape that exercises the SNI and
  21743. // hostname-verification path with certificate verification left enabled.
  21744. class WebSocketSSLDnsHostTest : public ::testing::Test {
  21745. protected:
  21746. void Start(const char *cert_file) {
  21747. server_ = httplib::detail::make_unique<SSLServer>(cert_file,
  21748. SERVER_PRIVATE_KEY_FILE);
  21749. ASSERT_TRUE(server_->is_valid());
  21750. server_->WebSocket("/echo", [](const Request &, ws::WebSocket &ws) {
  21751. std::string msg;
  21752. while (ws.read(msg)) {
  21753. ws.send(msg);
  21754. }
  21755. });
  21756. port_ = server_->bind_to_any_port("localhost");
  21757. server_thread_ = std::thread([this]() { server_->listen_after_bind(); });
  21758. server_->wait_until_ready();
  21759. }
  21760. void TearDown() override {
  21761. if (server_) { server_->stop(); }
  21762. if (server_thread_.joinable()) { server_thread_.join(); }
  21763. }
  21764. std::string url() const {
  21765. return "wss://localhost:" + std::to_string(port_) + "/echo";
  21766. }
  21767. std::unique_ptr<SSLServer> server_;
  21768. std::thread server_thread_;
  21769. int port_ = 0;
  21770. };
  21771. // cert2 carries a DNS:localhost SAN, so both the chain and the identity check
  21772. // out and the connection is usable
  21773. TEST_F(WebSocketSSLDnsHostTest, TrustedChainMatchingNameVerifies) {
  21774. Start(SERVER_CERT2_FILE);
  21775. ws::WebSocketClient client(url());
  21776. client.set_ca_cert_path(SERVER_CERT2_FILE);
  21777. ASSERT_TRUE(client.connect());
  21778. ASSERT_TRUE(client.send("hello"));
  21779. std::string msg;
  21780. EXPECT_EQ(ws::Text, client.read(msg));
  21781. EXPECT_EQ("hello", msg);
  21782. client.close();
  21783. }
  21784. // cert.pem has a CN but no SAN, so trusting it as a CA satisfies the chain
  21785. // while the identity check must still reject "localhost"
  21786. TEST_F(WebSocketSSLDnsHostTest, TrustedChainWrongNameFails) {
  21787. Start(SERVER_CERT_FILE);
  21788. ws::WebSocketClient client(url());
  21789. client.set_ca_cert_path(SERVER_CERT_FILE);
  21790. auto res = client.connect();
  21791. ASSERT_FALSE(res);
  21792. EXPECT_EQ(Error::SSLServerHostnameVerification, res.error());
  21793. EXPECT_EQ(-1, res.status());
  21794. }
  21795. // Same setup as TrustedChainWrongNameFails, but with hostname verification
  21796. // disabled: the chain is still checked, only the identity check is skipped
  21797. TEST_F(WebSocketSSLDnsHostTest, HostnameVerificationDisabledAcceptsWrongName) {
  21798. Start(SERVER_CERT_FILE);
  21799. ws::WebSocketClient client(url());
  21800. client.set_ca_cert_path(SERVER_CERT_FILE);
  21801. client.enable_server_hostname_verification(false);
  21802. ASSERT_TRUE(client.connect());
  21803. ASSERT_TRUE(client.send("hello"));
  21804. std::string msg;
  21805. EXPECT_EQ(ws::Text, client.read(msg));
  21806. EXPECT_EQ("hello", msg);
  21807. client.close();
  21808. }
  21809. // A CA that did not sign the server certificate fails the chain, even though
  21810. // the name would match
  21811. TEST_F(WebSocketSSLDnsHostTest, UntrustedChainFails) {
  21812. Start(SERVER_CERT2_FILE);
  21813. ws::WebSocketClient client(url());
  21814. client.set_ca_cert_path(CLIENT_CA_CERT_FILE);
  21815. ASSERT_FALSE(client.connect());
  21816. }
  21817. // With verification disabled, neither the chain nor the name is checked
  21818. TEST_F(WebSocketSSLDnsHostTest, VerificationDisabledAcceptsAnyName) {
  21819. Start(SERVER_CERT_FILE);
  21820. ws::WebSocketClient client(url());
  21821. client.enable_server_certificate_verification(false);
  21822. ASSERT_TRUE(client.connect());
  21823. ASSERT_TRUE(client.send("hello"));
  21824. std::string msg;
  21825. EXPECT_EQ(ws::Text, client.read(msg));
  21826. EXPECT_EQ("hello", msg);
  21827. client.close();
  21828. }
  21829. class WebSocketSSLPemMemoryTest : public ::testing::Test {
  21830. protected:
  21831. void SetUp() override {
  21832. server_ = httplib::detail::make_unique<SSLServer>(
  21833. SERVER_CERT_FILE, SERVER_PRIVATE_KEY_FILE, CLIENT_CA_CERT_FILE);
  21834. ASSERT_TRUE(server_->is_valid());
  21835. server_->WebSocket("/ws-echo", [](const Request &, ws::WebSocket &ws) {
  21836. std::string msg;
  21837. while (ws.read(msg)) {
  21838. ws.send(msg);
  21839. }
  21840. });
  21841. port_ = server_->bind_to_any_port("localhost");
  21842. server_thread_ = std::thread([this]() { server_->listen_after_bind(); });
  21843. server_->wait_until_ready();
  21844. }
  21845. void TearDown() override {
  21846. server_->stop();
  21847. if (server_thread_.joinable()) { server_thread_.join(); }
  21848. }
  21849. std::string url() const {
  21850. return "wss://localhost:" + std::to_string(port_) + "/ws-echo";
  21851. }
  21852. void ConnectWithClientCert(const std::string &client_cert_file,
  21853. const std::string &client_private_key_file,
  21854. const char *private_key_password) {
  21855. std::string cert_pem, key_pem;
  21856. read_file(client_cert_file, cert_pem);
  21857. read_file(client_private_key_file, key_pem);
  21858. ws::WebSocketClient::PemMemory pem = {cert_pem.c_str(), cert_pem.size(),
  21859. key_pem.c_str(), key_pem.size(),
  21860. private_key_password};
  21861. ws::WebSocketClient client(url(), pem);
  21862. ASSERT_TRUE(client.is_valid());
  21863. client.enable_server_certificate_verification(false);
  21864. ASSERT_TRUE(client.connect());
  21865. ASSERT_TRUE(client.send("hello"));
  21866. std::string msg;
  21867. EXPECT_EQ(ws::Text, client.read(msg));
  21868. EXPECT_EQ("hello", msg);
  21869. client.close();
  21870. }
  21871. std::unique_ptr<SSLServer> server_;
  21872. std::thread server_thread_;
  21873. int port_ = 0;
  21874. };
  21875. TEST_F(WebSocketSSLPemMemoryTest, ClientCertAccepted) {
  21876. ConnectWithClientCert(CLIENT_CERT_FILE, CLIENT_PRIVATE_KEY_FILE, nullptr);
  21877. }
  21878. // Control for the tests above: the fixture's server really does require a
  21879. // client certificate, so it is the PEM the constructor installed that decides
  21880. // the outcome.
  21881. TEST_F(WebSocketSSLPemMemoryTest, NoClientCertRejected) {
  21882. ws::WebSocketClient client(url());
  21883. ASSERT_TRUE(client.is_valid());
  21884. client.enable_server_certificate_verification(false);
  21885. EXPECT_FALSE(client.connect());
  21886. }
  21887. TEST_F(WebSocketSSLPemMemoryTest, EncryptedClientCertAccepted) {
  21888. ConnectWithClientCert(CLIENT_ENCRYPTED_CERT_FILE,
  21889. CLIENT_ENCRYPTED_PRIVATE_KEY_FILE,
  21890. CLIENT_ENCRYPTED_PRIVATE_KEY_PASS);
  21891. }
  21892. #endif
  21893. #if !defined(_WIN32)
  21894. TEST(SymlinkTest, SymlinkEscapeFromBaseDirectory) {
  21895. auto secret_dir = std::string("./symlink_test_secret");
  21896. auto served_dir = std::string("./symlink_test_served");
  21897. auto secret_file = secret_dir + "/secret.txt";
  21898. auto symlink_path = served_dir + "/escape";
  21899. // Setup: create directories and files
  21900. mkdir(secret_dir.c_str(), 0755);
  21901. mkdir(served_dir.c_str(), 0755);
  21902. {
  21903. std::ofstream ofs(secret_file);
  21904. ofs << "SECRET_DATA";
  21905. }
  21906. // Create symlink using absolute path so it resolves correctly
  21907. #ifdef PATH_MAX
  21908. char abs_secret[PATH_MAX];
  21909. ASSERT_NE(nullptr, realpath(secret_dir.c_str(), abs_secret));
  21910. #else
  21911. auto abs_secret = realpath(secret_dir.c_str(), nullptr);
  21912. auto abs_secret_guard = detail::scope_exit([&]() { std::free(abs_secret); });
  21913. ASSERT_NE(nullptr, abs_secret);
  21914. #endif
  21915. ASSERT_EQ(0, symlink(abs_secret, symlink_path.c_str()));
  21916. auto se = detail::scope_exit([&] {
  21917. unlink(symlink_path.c_str());
  21918. unlink(secret_file.c_str());
  21919. rmdir(served_dir.c_str());
  21920. rmdir(secret_dir.c_str());
  21921. });
  21922. Server svr;
  21923. svr.set_mount_point("/", served_dir);
  21924. auto listen_thread = std::thread([&svr]() { svr.listen("localhost", PORT); });
  21925. auto se2 = detail::scope_exit([&] {
  21926. svr.stop();
  21927. listen_thread.join();
  21928. });
  21929. svr.wait_until_ready();
  21930. Client cli("localhost", PORT);
  21931. // Symlink pointing outside base dir should be blocked
  21932. auto res = cli.Get("/escape/secret.txt");
  21933. ASSERT_TRUE(res) << "Error: " << to_string(res.error());
  21934. EXPECT_EQ(StatusCode::Forbidden_403, res->status);
  21935. }
  21936. #endif
  21937. // Sends `outer_head` (with every "{len}" replaced by the length of an embedded
  21938. // "GET /smuggled" request), reads the first response, and only then sends the
  21939. // embedded request as the body. Returns how many times /smuggled ran.
  21940. //
  21941. // The body is sent AFTER receiving the first response (as in the original
  21942. // PoC) so that the stream_line_reader cannot buffer it together with the
  21943. // headers of the first request.
  21944. static int count_smuggled_requests(const std::string &outer_head,
  21945. std::string &first_response) {
  21946. Server svr;
  21947. svr.set_mount_point("/", "./www");
  21948. std::atomic<int> smuggled_count(0);
  21949. svr.Get("/smuggled", [&](const Request &, Response &res) {
  21950. smuggled_count++;
  21951. res.set_content("oops", "text/plain");
  21952. });
  21953. svr.Post("/post", [&](const Request &req, Response &res) {
  21954. res.set_content(req.body, "text/plain");
  21955. });
  21956. auto port = svr.bind_to_any_port("localhost");
  21957. thread t = thread([&] { svr.listen_after_bind(); });
  21958. auto se = detail::scope_exit([&] {
  21959. svr.stop();
  21960. t.join();
  21961. });
  21962. svr.wait_until_ready();
  21963. auto error = Error::Success;
  21964. auto sock = detail::create_client_socket(
  21965. "localhost", "", port, AF_UNSPEC, false, false, nullptr,
  21966. /*connection_timeout_sec=*/2, 0,
  21967. /*read_timeout_sec=*/2, 0,
  21968. /*write_timeout_sec=*/2, 0, std::string(), error);
  21969. EXPECT_NE(INVALID_SOCKET, sock);
  21970. if (sock == INVALID_SOCKET) { return -1; }
  21971. auto sock_se = detail::scope_exit([&] { detail::close_socket(sock); });
  21972. // The "smuggled" request will be sent as the body of the outer request
  21973. std::string smuggled = "GET /smuggled HTTP/1.1\r\n"
  21974. "Host: localhost\r\n"
  21975. "Connection: close\r\n"
  21976. "\r\n";
  21977. auto head = outer_head;
  21978. auto len = std::to_string(smuggled.size());
  21979. for (auto pos = head.find("{len}"); pos != std::string::npos;
  21980. pos = head.find("{len}", pos + len.size())) {
  21981. head.replace(pos, 5, len);
  21982. }
  21983. // Step 1: Send only the outer request headers (no body yet)
  21984. auto sent = send(sock, head.data(), head.size(), 0);
  21985. EXPECT_EQ(static_cast<ssize_t>(head.size()), sent);
  21986. // Step 2: Read the first response
  21987. char buf[4096];
  21988. for (;;) {
  21989. auto n = recv(sock, buf, sizeof(buf), 0);
  21990. if (n <= 0) break;
  21991. first_response.append(buf, static_cast<size_t>(n));
  21992. // Stop once we have a complete response (headers + body)
  21993. auto hdr_end = first_response.find("\r\n\r\n");
  21994. if (hdr_end != std::string::npos) {
  21995. // Check for Content-Length to know when the body is complete
  21996. auto cl_pos = first_response.find("Content-Length:");
  21997. if (cl_pos != std::string::npos) {
  21998. auto cl_val_start = cl_pos + 15; // length of "Content-Length:"
  21999. auto cl_val_end = first_response.find("\r\n", cl_val_start);
  22000. auto cl = std::stoul(
  22001. first_response.substr(cl_val_start, cl_val_end - cl_val_start));
  22002. if (first_response.size() >= hdr_end + 4 + cl) { break; }
  22003. } else {
  22004. break; // No Content-Length, assume headers-only response
  22005. }
  22006. }
  22007. }
  22008. // Step 3: Now send the body, which looks like a new HTTP request. On a
  22009. // vulnerable server the keep-alive loop reads this as a second request. The
  22010. // server may already have closed the connection, so the result is ignored.
  22011. send(sock, smuggled.data(), smuggled.size(), 0);
  22012. // Half-close so that a server which drained the body sees EOF and closes,
  22013. // instead of the read below waiting for the read timeout.
  22014. #ifdef _WIN32
  22015. ::shutdown(sock, SD_SEND);
  22016. #else
  22017. ::shutdown(sock, SHUT_WR);
  22018. #endif
  22019. // Step 4: Read until the server closes the connection
  22020. for (;;) {
  22021. auto n = recv(sock, buf, sizeof(buf), 0);
  22022. if (n <= 0) break;
  22023. }
  22024. return smuggled_count.load();
  22025. }
  22026. TEST(RequestSmugglingTest, UnconsumedGETBodyOnFileHandler) {
  22027. // A GET request with Content-Length to a static file handler must have its
  22028. // body drained before the keep-alive connection is reused. Otherwise the
  22029. // unread body bytes are interpreted as the next HTTP request.
  22030. std::string first_response;
  22031. EXPECT_EQ(0, count_smuggled_requests("GET /file HTTP/1.1\r\n"
  22032. "Host: localhost\r\n"
  22033. "Content-Length: {len}\r\n"
  22034. "\r\n",
  22035. first_response));
  22036. EXPECT_EQ(0u, first_response.find("HTTP/1.1 200"));
  22037. }
  22038. TEST(RequestSmugglingTest, InvalidContentLengthRejected) {
  22039. // RFC 9112 §6.3: a Content-Length that is not a valid decimal length must
  22040. // be answered with 400 and the connection closed. Treating it as "no body"
  22041. // leaves the body to be parsed as the next request.
  22042. const char *values[] = {"{len}, {len}", "+{len}", "0x2e", "", " {len}x"};
  22043. const char *targets[] = {
  22044. "GET /file", // handler that never reads the body
  22045. "GET /not-found", // no handler matches (404)
  22046. "POST /post", // handler that reads the body
  22047. };
  22048. for (auto target : targets) {
  22049. for (auto value : values) {
  22050. std::string first_response;
  22051. EXPECT_EQ(0, count_smuggled_requests(std::string(target) +
  22052. " HTTP/1.1\r\n"
  22053. "Host: localhost\r\n"
  22054. "Content-Length: " +
  22055. value + "\r\n\r\n",
  22056. first_response))
  22057. << target << " with Content-Length: " << value;
  22058. EXPECT_EQ(0u, first_response.find("HTTP/1.1 400"))
  22059. << target << " with Content-Length: " << value;
  22060. }
  22061. }
  22062. }
  22063. TEST(RequestSmugglingTest, RejectedRequestLineClosesConnection) {
  22064. // A 400 for an unparseable request line leaves the rest of the message
  22065. // unread, so the connection must be closed rather than reused.
  22066. std::string first_response;
  22067. EXPECT_EQ(0, count_smuggled_requests("FOO /file HTTP/1.1\r\n"
  22068. "Host: localhost\r\n"
  22069. "Content-Length: {len}\r\n"
  22070. "\r\n",
  22071. first_response));
  22072. EXPECT_EQ(0u, first_response.find("HTTP/1.1 400"));
  22073. }
  22074. TEST(RequestSmugglingTest, RejectedHeadersCloseConnection) {
  22075. // Same as above for a header block that fails to parse.
  22076. std::string first_response;
  22077. EXPECT_EQ(0, count_smuggled_requests("GET /file HTTP/1.1\r\n"
  22078. "Host: localhost\r\n"
  22079. "Bad Header\r\n"
  22080. "Content-Length: {len}\r\n"
  22081. "\r\n",
  22082. first_response));
  22083. EXPECT_EQ(0u, first_response.find("HTTP/1.1 400"));
  22084. }
  22085. TEST(RequestSmugglingTest, ErrorResponseClosesConnection) {
  22086. // RFC 9112 §9.6: an error response carries "Connection: close", so the
  22087. // server must not read another request on that connection, even when the
  22088. // request had no body to drain.
  22089. std::string first_response;
  22090. EXPECT_EQ(0, count_smuggled_requests("GET /not-found HTTP/1.1\r\n"
  22091. "Host: localhost\r\n"
  22092. "\r\n",
  22093. first_response));
  22094. EXPECT_EQ(0u, first_response.find("HTTP/1.1 404"));
  22095. EXPECT_NE(std::string::npos, first_response.find("Connection: close"));
  22096. }
  22097. TEST(RequestSmugglingTest, ContentLengthAndTransferEncodingRejected) {
  22098. // RFC 9112 §6.3: A request with both Content-Length and Transfer-Encoding
  22099. // must be rejected with 400 Bad Request.
  22100. Server svr;
  22101. svr.Post("/test", [&](const Request &, Response &res) {
  22102. res.set_content("ok", "text/plain");
  22103. });
  22104. thread t = thread([&] { svr.listen(HOST, PORT); });
  22105. auto se = detail::scope_exit([&] {
  22106. svr.stop();
  22107. t.join();
  22108. ASSERT_FALSE(svr.is_running());
  22109. });
  22110. svr.wait_until_ready();
  22111. // Exact "chunked"
  22112. {
  22113. auto req = "POST /test HTTP/1.1\r\n"
  22114. "Host: localhost\r\n"
  22115. "Content-Length: 5\r\n"
  22116. "Transfer-Encoding: chunked\r\n"
  22117. "Connection: close\r\n"
  22118. "\r\n"
  22119. "hello";
  22120. std::string response;
  22121. ASSERT_TRUE(send_request(1, req, &response));
  22122. EXPECT_EQ("HTTP/1.1 400 Bad Request",
  22123. response.substr(0, response.find("\r\n")));
  22124. }
  22125. // Multi-valued Transfer-Encoding (e.g., "gzip, chunked")
  22126. {
  22127. auto req = "POST /test HTTP/1.1\r\n"
  22128. "Host: localhost\r\n"
  22129. "Content-Length: 5\r\n"
  22130. "Transfer-Encoding: gzip, chunked\r\n"
  22131. "Connection: close\r\n"
  22132. "\r\n"
  22133. "hello";
  22134. std::string response;
  22135. ASSERT_TRUE(send_request(1, req, &response));
  22136. EXPECT_EQ("HTTP/1.1 400 Bad Request",
  22137. response.substr(0, response.find("\r\n")));
  22138. }
  22139. }
  22140. TEST(RequestSmugglingTest, NonFinalChunkedTransferEncodingRejected) {
  22141. Server svr;
  22142. svr.Post("/test", [&](const Request &, Response &res) {
  22143. res.set_content("ok", "text/plain");
  22144. });
  22145. thread t = thread([&] { svr.listen(HOST, PORT); });
  22146. auto se = detail::scope_exit([&] {
  22147. svr.stop();
  22148. t.join();
  22149. ASSERT_FALSE(svr.is_running());
  22150. });
  22151. svr.wait_until_ready();
  22152. // RFC 9112 6.3: when chunked is not the final transfer coding the body
  22153. // length cannot be determined, so the server must answer 400 and close
  22154. // rather than treat the request as bodyless and leave the body in the
  22155. // socket for the next request to pick up.
  22156. for (const auto &transfer_encoding : {"gzip", "chunked, gzip"}) {
  22157. auto req = std::string("POST /test HTTP/1.1\r\n") + "Host: localhost\r\n" +
  22158. "Transfer-Encoding: " + transfer_encoding + "\r\n" + "\r\n";
  22159. std::string response;
  22160. ASSERT_TRUE(send_request(1, req, &response));
  22161. EXPECT_EQ("HTTP/1.1 400 Bad Request",
  22162. response.substr(0, response.find("\r\n")))
  22163. << transfer_encoding;
  22164. }
  22165. // RFC 9110 5.3: the codings may also be split across several
  22166. // Transfer-Encoding lines, which combine in the order they were received.
  22167. // "chunked" followed by "gzip" therefore ends in gzip and must be rejected
  22168. // just like the single-line "chunked, gzip" above.
  22169. {
  22170. auto req = "POST /test HTTP/1.1\r\n"
  22171. "Host: localhost\r\n"
  22172. "Transfer-Encoding: chunked\r\n"
  22173. "Transfer-Encoding: gzip\r\n"
  22174. "\r\n"
  22175. "0\r\n\r\n";
  22176. std::string response;
  22177. ASSERT_TRUE(send_request(1, req, &response));
  22178. EXPECT_EQ("HTTP/1.1 400 Bad Request",
  22179. response.substr(0, response.find("\r\n")));
  22180. }
  22181. // A sequence ending in chunked stays valid.
  22182. auto req = "POST /test HTTP/1.1\r\n"
  22183. "Host: localhost\r\n"
  22184. "Transfer-Encoding: gzip, chunked\r\n"
  22185. "Connection: close\r\n"
  22186. "\r\n"
  22187. "0\r\n\r\n";
  22188. std::string response;
  22189. ASSERT_TRUE(send_request(1, req, &response));
  22190. EXPECT_EQ("HTTP/1.1 200 OK", response.substr(0, response.find("\r\n")));
  22191. // ...including when it is spread over several lines.
  22192. auto split_req = "POST /test HTTP/1.1\r\n"
  22193. "Host: localhost\r\n"
  22194. "Transfer-Encoding: gzip\r\n"
  22195. "Transfer-Encoding: chunked\r\n"
  22196. "Connection: close\r\n"
  22197. "\r\n"
  22198. "0\r\n\r\n";
  22199. std::string split_response;
  22200. ASSERT_TRUE(send_request(1, split_req, &split_response));
  22201. EXPECT_EQ("HTTP/1.1 200 OK",
  22202. split_response.substr(0, split_response.find("\r\n")));
  22203. }
  22204. // Regression for issue #2450: a DELETE without Content-Length on a
  22205. // keep-alive connection must not let the post-response drain consume the
  22206. // next request's bytes.
  22207. TEST(KeepAliveTest, DeleteWithoutContentLengthDoesNotEatNextRequest) {
  22208. Server svr;
  22209. std::atomic<int> delete_count(0);
  22210. svr.Delete("/items/:id", [&](const Request &, Response &res) {
  22211. delete_count++;
  22212. res.status = StatusCode::NoContent_204;
  22213. });
  22214. auto port = svr.bind_to_any_port(HOST);
  22215. thread t = thread([&] { svr.listen_after_bind(); });
  22216. auto se = detail::scope_exit([&] {
  22217. svr.stop();
  22218. t.join();
  22219. });
  22220. svr.wait_until_ready();
  22221. auto error = Error::Success;
  22222. auto sock = detail::create_client_socket(
  22223. HOST, "", port, AF_UNSPEC, false, false, nullptr,
  22224. /*connection_timeout_sec=*/2, 0,
  22225. /*read_timeout_sec=*/2, 0,
  22226. /*write_timeout_sec=*/2, 0, std::string(), error);
  22227. ASSERT_NE(INVALID_SOCKET, sock);
  22228. auto sock_se = detail::scope_exit([&] { detail::close_socket(sock); });
  22229. auto send_request_and_read_response = [&](const std::string &req,
  22230. std::string &out) -> bool {
  22231. auto sent = send(sock, req.data(), req.size(), 0);
  22232. if (sent != static_cast<ssize_t>(req.size())) { return false; }
  22233. char buf[4096];
  22234. for (;;) {
  22235. auto n = recv(sock, buf, sizeof(buf), 0);
  22236. if (n <= 0) { return !out.empty(); }
  22237. out.append(buf, static_cast<size_t>(n));
  22238. if (out.find("\r\n\r\n") != std::string::npos) { return true; }
  22239. }
  22240. };
  22241. std::string req1 = "DELETE /items/1 HTTP/1.1\r\n"
  22242. "Host: localhost\r\n"
  22243. "\r\n";
  22244. std::string resp1;
  22245. ASSERT_TRUE(send_request_and_read_response(req1, resp1));
  22246. EXPECT_NE(std::string::npos, resp1.find("HTTP/1.1 204"));
  22247. std::string req2 = "DELETE /items/2 HTTP/1.1\r\n"
  22248. "Host: localhost\r\n"
  22249. "Connection: close\r\n"
  22250. "\r\n";
  22251. std::string resp2;
  22252. ASSERT_TRUE(send_request_and_read_response(req2, resp2));
  22253. EXPECT_NE(std::string::npos, resp2.find("HTTP/1.1 204"));
  22254. EXPECT_EQ(2, delete_count.load());
  22255. }
  22256. TEST(KeepAliveTest, UnconsumedChunkedBodyIsNotDrainedWhenResponseCloses) {
  22257. Server svr;
  22258. svr.Post("/ingest", [&](const Request &, Response &res,
  22259. const ContentReader &content_reader) {
  22260. auto consumed = content_reader([](const char *, size_t) { return false; });
  22261. EXPECT_FALSE(consumed);
  22262. res.status = StatusCode::Conflict_409;
  22263. res.set_header("Connection", "close");
  22264. });
  22265. auto port = svr.bind_to_any_port(HOST);
  22266. thread t = thread([&] { svr.listen_after_bind(); });
  22267. auto se = detail::scope_exit([&] {
  22268. svr.stop();
  22269. t.join();
  22270. });
  22271. svr.wait_until_ready();
  22272. auto error = Error::Success;
  22273. auto sock = detail::create_client_socket(
  22274. HOST, "", port, AF_UNSPEC, false, false, nullptr,
  22275. /*connection_timeout_sec=*/2, 0,
  22276. /*read_timeout_sec=*/1, 0,
  22277. /*write_timeout_sec=*/2, 0, std::string(), error);
  22278. ASSERT_NE(INVALID_SOCKET, sock);
  22279. auto sock_se = detail::scope_exit([&] { detail::close_socket(sock); });
  22280. std::string request = "POST /ingest HTTP/1.1\r\n"
  22281. "Host: localhost\r\n"
  22282. "Transfer-Encoding: chunked\r\n"
  22283. "\r\n"
  22284. "4\r\n"
  22285. "data\r\n";
  22286. auto sent = send(sock, request.data(), request.size(), 0);
  22287. ASSERT_EQ(static_cast<ssize_t>(request.size()), sent);
  22288. std::string response;
  22289. ssize_t received = 0;
  22290. do {
  22291. char buf[4096];
  22292. received = recv(sock, buf, sizeof(buf), 0);
  22293. if (received > 0) { response.append(buf, static_cast<size_t>(received)); }
  22294. } while (received > 0);
  22295. EXPECT_NE(std::string::npos, response.find("HTTP/1.1 409 Conflict"));
  22296. EXPECT_NE(std::string::npos, response.find("Connection: close"));
  22297. EXPECT_EQ(0, received);
  22298. }
  22299. namespace no_proxy_test {
  22300. // Server bound to 127.0.0.1:<dynamic>, listen thread spawned by listen(),
  22301. // auto-stopped + joined on scope exit. Register handlers via svr() BEFORE
  22302. // calling listen().
  22303. class ScopedServer {
  22304. public:
  22305. ScopedServer() { port_ = svr_.bind_to_any_port("127.0.0.1"); }
  22306. ~ScopedServer() {
  22307. svr_.stop();
  22308. if (th_.joinable()) { th_.join(); }
  22309. }
  22310. Server &svr() { return svr_; }
  22311. int port() const { return port_; }
  22312. void listen() {
  22313. th_ = std::thread([this] { svr_.listen_after_bind(); });
  22314. svr_.wait_until_ready();
  22315. }
  22316. private:
  22317. Server svr_;
  22318. std::thread th_;
  22319. int port_ = 0;
  22320. };
  22321. class ProxyAndTargetServers {
  22322. public:
  22323. ProxyAndTargetServers() {
  22324. proxy_mock_.Get(".*", [this](const Request &req, Response &res) {
  22325. proxy_hits_++;
  22326. last_had_proxy_authz_ = req.has_header("Proxy-Authorization");
  22327. res.set_content("via-proxy", "text/plain");
  22328. });
  22329. target_.Get(".*", [this](const Request &req, Response &res) {
  22330. target_hits_++;
  22331. last_had_proxy_authz_ = req.has_header("Proxy-Authorization");
  22332. res.set_content("direct", "text/plain");
  22333. });
  22334. proxy_port_ = proxy_mock_.bind_to_any_port("127.0.0.1");
  22335. target_port_ = target_.bind_to_any_port("127.0.0.1");
  22336. proxy_thread_ = std::thread([this] { proxy_mock_.listen_after_bind(); });
  22337. target_thread_ = std::thread([this] { target_.listen_after_bind(); });
  22338. proxy_mock_.wait_until_ready();
  22339. target_.wait_until_ready();
  22340. }
  22341. ~ProxyAndTargetServers() {
  22342. proxy_mock_.stop();
  22343. target_.stop();
  22344. if (proxy_thread_.joinable()) { proxy_thread_.join(); }
  22345. if (target_thread_.joinable()) { target_thread_.join(); }
  22346. }
  22347. Server &proxy_mock() { return proxy_mock_; }
  22348. Server &target() { return target_; }
  22349. int proxy_port() const { return proxy_port_; }
  22350. int target_port() const { return target_port_; }
  22351. int proxy_hits() const { return proxy_hits_.load(); }
  22352. int target_hits() const { return target_hits_.load(); }
  22353. bool last_had_proxy_authz() const { return last_had_proxy_authz_.load(); }
  22354. void reset_counters() {
  22355. proxy_hits_ = 0;
  22356. target_hits_ = 0;
  22357. last_had_proxy_authz_ = false;
  22358. }
  22359. private:
  22360. Server proxy_mock_;
  22361. Server target_;
  22362. std::thread proxy_thread_;
  22363. std::thread target_thread_;
  22364. int proxy_port_ = 0;
  22365. int target_port_ = 0;
  22366. std::atomic<int> proxy_hits_{0};
  22367. std::atomic<int> target_hits_{0};
  22368. std::atomic<bool> last_had_proxy_authz_{false};
  22369. };
  22370. inline std::unique_ptr<Client> make_client(const std::string &host,
  22371. ProxyAndTargetServers &s) {
  22372. auto cli = detail::make_unique<Client>(host, s.target_port());
  22373. cli->set_hostname_addr_map({{host, "127.0.0.1"}});
  22374. cli->set_proxy("127.0.0.1", s.proxy_port());
  22375. return cli;
  22376. }
  22377. } // namespace no_proxy_test
  22378. using no_proxy_test::make_client;
  22379. using no_proxy_test::ProxyAndTargetServers;
  22380. TEST(NoProxyTest, ExactHostnameBypasses) {
  22381. ProxyAndTargetServers s;
  22382. auto cli = make_client("example.com", s);
  22383. cli->set_no_proxy({"example.com"});
  22384. auto res = cli->Get("/");
  22385. ASSERT_TRUE(res) << "Error: " << to_string(res.error());
  22386. EXPECT_EQ(0, s.proxy_hits());
  22387. EXPECT_EQ(1, s.target_hits());
  22388. }
  22389. TEST(NoProxyTest, SubdomainBypasses) {
  22390. ProxyAndTargetServers s;
  22391. auto cli = make_client("foo.example.com", s);
  22392. cli->set_no_proxy({"example.com"});
  22393. auto res = cli->Get("/");
  22394. ASSERT_TRUE(res) << "Error: " << to_string(res.error());
  22395. EXPECT_EQ(0, s.proxy_hits());
  22396. EXPECT_EQ(1, s.target_hits());
  22397. }
  22398. TEST(NoProxyTest, EvilExampleDoesNotMatchExample) {
  22399. // Regression guard: "evilexample.com" must not be considered a subdomain
  22400. // of "example.com". Without the dot-boundary rule, a naive endsWith
  22401. // check would let traffic bypass the proxy and leak credentials direct
  22402. // to the attacker host.
  22403. ProxyAndTargetServers s;
  22404. auto cli = make_client("evilexample.com", s);
  22405. cli->set_no_proxy({"example.com"});
  22406. auto res = cli->Get("/");
  22407. ASSERT_TRUE(res) << "Error: " << to_string(res.error());
  22408. EXPECT_GE(s.proxy_hits(), 1);
  22409. EXPECT_EQ(0, s.target_hits());
  22410. }
  22411. TEST(NoProxyTest, ExampleDotEvilDoesNotMatchExample) {
  22412. ProxyAndTargetServers s;
  22413. auto cli = make_client("example.com.evil.com", s);
  22414. cli->set_no_proxy({"example.com"});
  22415. auto res = cli->Get("/");
  22416. ASSERT_TRUE(res) << "Error: " << to_string(res.error());
  22417. EXPECT_GE(s.proxy_hits(), 1);
  22418. EXPECT_EQ(0, s.target_hits());
  22419. }
  22420. TEST(NoProxyTest, LeadingDotPatternMatchesBareDomain) {
  22421. ProxyAndTargetServers s;
  22422. auto cli = make_client("example.com", s);
  22423. cli->set_no_proxy({".example.com"});
  22424. auto res = cli->Get("/");
  22425. ASSERT_TRUE(res) << "Error: " << to_string(res.error());
  22426. EXPECT_EQ(0, s.proxy_hits());
  22427. EXPECT_EQ(1, s.target_hits());
  22428. }
  22429. TEST(NoProxyTest, CaseInsensitiveHostname) {
  22430. ProxyAndTargetServers s;
  22431. auto cli = make_client("Example.COM", s);
  22432. cli->set_no_proxy({"EXAMPLE.com"});
  22433. auto res = cli->Get("/");
  22434. ASSERT_TRUE(res) << "Error: " << to_string(res.error());
  22435. EXPECT_EQ(0, s.proxy_hits());
  22436. EXPECT_EQ(1, s.target_hits());
  22437. }
  22438. TEST(NoProxyTest, TrailingDotIsNormalized) {
  22439. ProxyAndTargetServers s;
  22440. auto cli = make_client("example.com.", s);
  22441. cli->set_no_proxy({"example.com"});
  22442. auto res = cli->Get("/");
  22443. ASSERT_TRUE(res) << "Error: " << to_string(res.error());
  22444. EXPECT_EQ(0, s.proxy_hits());
  22445. EXPECT_EQ(1, s.target_hits());
  22446. }
  22447. TEST(NoProxyTest, TrailingDotOnEntryIsNormalized) {
  22448. // Trailing dots must be normalized on BOTH sides — host and entry.
  22449. // An implementation that only strips the host-side trailing dot would
  22450. // fail to match host "example.com" against entry "example.com." because
  22451. // a literal substring search would compare 11 chars against 12.
  22452. ProxyAndTargetServers s;
  22453. auto cli = make_client("example.com", s);
  22454. cli->set_no_proxy({"example.com."});
  22455. auto res = cli->Get("/");
  22456. ASSERT_TRUE(res) << "Error: " << to_string(res.error());
  22457. EXPECT_EQ(0, s.proxy_hits());
  22458. EXPECT_EQ(1, s.target_hits());
  22459. }
  22460. TEST(NoProxyTest, WildcardBypassesEverything) {
  22461. ProxyAndTargetServers s;
  22462. auto cli = make_client("anything.invalid.test", s);
  22463. cli->set_no_proxy({"*"});
  22464. auto res = cli->Get("/");
  22465. ASSERT_TRUE(res) << "Error: " << to_string(res.error());
  22466. EXPECT_EQ(0, s.proxy_hits());
  22467. EXPECT_EQ(1, s.target_hits());
  22468. }
  22469. TEST(NoProxyTest, IPv4LiteralExactMatch) {
  22470. ProxyAndTargetServers s;
  22471. Client cli("127.0.0.1", s.target_port());
  22472. cli.set_proxy("127.0.0.1", s.proxy_port());
  22473. cli.set_no_proxy({"127.0.0.1"});
  22474. auto res = cli.Get("/");
  22475. ASSERT_TRUE(res) << "Error: " << to_string(res.error());
  22476. EXPECT_EQ(0, s.proxy_hits());
  22477. EXPECT_EQ(1, s.target_hits());
  22478. }
  22479. TEST(NoProxyTest, IPv6LiteralExactMatchAcrossEquivalentForms) {
  22480. ProxyAndTargetServers s;
  22481. Client cli("0:0:0:0:0:0:0:1", s.target_port());
  22482. cli.set_hostname_addr_map({{"0:0:0:0:0:0:0:1", "127.0.0.1"}});
  22483. cli.set_proxy("127.0.0.1", s.proxy_port());
  22484. cli.set_no_proxy({"::1"});
  22485. auto res = cli.Get("/");
  22486. ASSERT_TRUE(res) << "Error: " << to_string(res.error());
  22487. EXPECT_EQ(0, s.proxy_hits());
  22488. EXPECT_EQ(1, s.target_hits());
  22489. }
  22490. TEST(NoProxyTest, BareIPv6LiteralMatchesIPv6Cidr) {
  22491. // Regression guard: a bare IPv6 host literal (no surrounding brackets)
  22492. // must still be recognized as IPv6 for CIDR matching. Implementations
  22493. // that detect IPv6 only when the host begins with '[' would parse the
  22494. // host as a hostname and miss the match.
  22495. ProxyAndTargetServers s;
  22496. Client cli("fe80::1", s.target_port());
  22497. cli.set_hostname_addr_map({{"fe80::1", "127.0.0.1"}});
  22498. cli.set_proxy("127.0.0.1", s.proxy_port());
  22499. cli.set_no_proxy({"fe80::/10"});
  22500. auto res = cli.Get("/");
  22501. ASSERT_TRUE(res) << "Error: " << to_string(res.error());
  22502. EXPECT_EQ(0, s.proxy_hits());
  22503. EXPECT_EQ(1, s.target_hits());
  22504. }
  22505. TEST(NoProxyTest, BracketedIPv6EntryAccepted) {
  22506. ProxyAndTargetServers s;
  22507. Client cli("::1", s.target_port());
  22508. cli.set_hostname_addr_map({{"::1", "127.0.0.1"}});
  22509. cli.set_proxy("127.0.0.1", s.proxy_port());
  22510. cli.set_no_proxy({"[::1]"});
  22511. auto res = cli.Get("/");
  22512. ASSERT_TRUE(res) << "Error: " << to_string(res.error());
  22513. EXPECT_EQ(0, s.proxy_hits());
  22514. EXPECT_EQ(1, s.target_hits());
  22515. }
  22516. TEST(NoProxyTest, BracketedIPv6CidrEntryAccepted) {
  22517. ProxyAndTargetServers s;
  22518. Client cli("fe80::1", s.target_port());
  22519. cli.set_hostname_addr_map({{"fe80::1", "127.0.0.1"}});
  22520. cli.set_proxy("127.0.0.1", s.proxy_port());
  22521. cli.set_no_proxy({"[fe80::]/10"});
  22522. auto res = cli.Get("/");
  22523. ASSERT_TRUE(res) << "Error: " << to_string(res.error());
  22524. EXPECT_EQ(0, s.proxy_hits());
  22525. EXPECT_EQ(1, s.target_hits());
  22526. }
  22527. TEST(NoProxyTest, IPv4MappedIPv6IsNotCrossMatchedAgainstIPv4Entry) {
  22528. // Policy: keep address families separate. "::ffff:1.2.3.4" must NOT
  22529. // satisfy a NO_PROXY entry of "1.2.3.4". This avoids subtle bypass
  22530. // tricks via address-family conversion.
  22531. ProxyAndTargetServers s;
  22532. Client cli("::ffff:127.0.0.1", s.target_port());
  22533. cli.set_hostname_addr_map({{"::ffff:127.0.0.1", "127.0.0.1"}});
  22534. cli.set_proxy("127.0.0.1", s.proxy_port());
  22535. cli.set_no_proxy({"127.0.0.1"});
  22536. auto res = cli.Get("/");
  22537. ASSERT_TRUE(res) << "Error: " << to_string(res.error());
  22538. EXPECT_GE(s.proxy_hits(), 1);
  22539. EXPECT_EQ(0, s.target_hits());
  22540. }
  22541. TEST(NoProxyTest, IPv4CidrMatch) {
  22542. ProxyAndTargetServers s;
  22543. Client cli("127.0.0.1", s.target_port());
  22544. cli.set_proxy("127.0.0.1", s.proxy_port());
  22545. cli.set_no_proxy({"127.0.0.0/8"});
  22546. auto res = cli.Get("/");
  22547. ASSERT_TRUE(res) << "Error: " << to_string(res.error());
  22548. EXPECT_EQ(0, s.proxy_hits());
  22549. EXPECT_EQ(1, s.target_hits());
  22550. }
  22551. TEST(NoProxyTest, IPv4CidrNonMatch) {
  22552. ProxyAndTargetServers s;
  22553. Client cli("127.0.0.1", s.target_port());
  22554. cli.set_proxy("127.0.0.1", s.proxy_port());
  22555. cli.set_no_proxy({"10.0.0.0/8"});
  22556. auto res = cli.Get("/");
  22557. ASSERT_TRUE(res) << "Error: " << to_string(res.error());
  22558. EXPECT_GE(s.proxy_hits(), 1);
  22559. EXPECT_EQ(0, s.target_hits());
  22560. }
  22561. TEST(NoProxyTest, IPv4CidrPrefixZeroMatchesAll) {
  22562. // Prefix 0 must not trigger the (1u << 32) shift UB. Result: every
  22563. // IPv4 target matches.
  22564. ProxyAndTargetServers s;
  22565. Client cli("127.0.0.1", s.target_port());
  22566. cli.set_proxy("127.0.0.1", s.proxy_port());
  22567. cli.set_no_proxy({"0.0.0.0/0"});
  22568. auto res = cli.Get("/");
  22569. ASSERT_TRUE(res) << "Error: " << to_string(res.error());
  22570. EXPECT_EQ(0, s.proxy_hits());
  22571. EXPECT_EQ(1, s.target_hits());
  22572. }
  22573. TEST(NoProxyTest, IPv4CidrSingleHostNoSlash) {
  22574. ProxyAndTargetServers s;
  22575. Client cli("127.0.0.1", s.target_port());
  22576. cli.set_proxy("127.0.0.1", s.proxy_port());
  22577. cli.set_no_proxy({"127.0.0.1"});
  22578. auto res = cli.Get("/");
  22579. ASSERT_TRUE(res) << "Error: " << to_string(res.error());
  22580. EXPECT_EQ(0, s.proxy_hits());
  22581. EXPECT_EQ(1, s.target_hits());
  22582. }
  22583. TEST(NoProxyTest, MalformedCidrPrefixIsDropped) {
  22584. ProxyAndTargetServers s;
  22585. Client cli("127.0.0.1", s.target_port());
  22586. cli.set_proxy("127.0.0.1", s.proxy_port());
  22587. cli.set_no_proxy({"127.0.0.0/33"});
  22588. auto res = cli.Get("/");
  22589. ASSERT_TRUE(res) << "Error: " << to_string(res.error());
  22590. EXPECT_GE(s.proxy_hits(), 1);
  22591. EXPECT_EQ(0, s.target_hits());
  22592. }
  22593. TEST(NoProxyTest, TrailingSlashCidrIsRejected) {
  22594. // Empty prefix after the slash must be rejected, not silently treated as /32.
  22595. ProxyAndTargetServers s;
  22596. Client cli("127.0.0.1", s.target_port());
  22597. cli.set_proxy("127.0.0.1", s.proxy_port());
  22598. cli.set_no_proxy({"127.0.0.1/"});
  22599. auto res = cli.Get("/");
  22600. ASSERT_TRUE(res) << "Error: " << to_string(res.error());
  22601. EXPECT_GE(s.proxy_hits(), 1);
  22602. EXPECT_EQ(0, s.target_hits());
  22603. }
  22604. TEST(NoProxyTest, ProxyAuthorizationSuppressedWhenBypassed) {
  22605. ProxyAndTargetServers s;
  22606. auto cli = make_client("internal.corp", s);
  22607. cli->set_proxy_basic_auth("u", "p");
  22608. cli->set_no_proxy({"internal.corp"});
  22609. auto res = cli->Get("/");
  22610. ASSERT_TRUE(res) << "Error: " << to_string(res.error());
  22611. EXPECT_EQ(1, s.target_hits());
  22612. EXPECT_EQ(0, s.proxy_hits());
  22613. EXPECT_FALSE(s.last_had_proxy_authz())
  22614. << "Proxy-Authorization must not be sent direct to the target";
  22615. }
  22616. TEST(NoProxyTest, ProxyAuthorizationSentWhenNotBypassed) {
  22617. ProxyAndTargetServers s;
  22618. auto cli = make_client("public.example", s);
  22619. cli->set_proxy_basic_auth("u", "p");
  22620. cli->set_no_proxy({"internal.corp"}); // does not match
  22621. auto res = cli->Get("/");
  22622. ASSERT_TRUE(res) << "Error: " << to_string(res.error());
  22623. EXPECT_GE(s.proxy_hits(), 1);
  22624. EXPECT_TRUE(s.last_had_proxy_authz());
  22625. }
  22626. TEST(NoProxyTest, EmptyNoProxyKeepsProxyOn) {
  22627. ProxyAndTargetServers s;
  22628. auto cli = make_client("anything.test", s);
  22629. auto res = cli->Get("/");
  22630. ASSERT_TRUE(res) << "Error: " << to_string(res.error());
  22631. EXPECT_GE(s.proxy_hits(), 1);
  22632. EXPECT_EQ(0, s.target_hits());
  22633. }
  22634. TEST(NoProxyTest, PortSpecificEntryRejected) {
  22635. ProxyAndTargetServers s;
  22636. auto cli = make_client("example.com", s);
  22637. cli->set_no_proxy({"example.com:8080"});
  22638. auto res = cli->Get("/");
  22639. ASSERT_TRUE(res) << "Error: " << to_string(res.error());
  22640. EXPECT_GE(s.proxy_hits(), 1);
  22641. EXPECT_EQ(0, s.target_hits());
  22642. }
  22643. TEST(NoProxyTest, EmptyAndWhitespaceEntriesDropped) {
  22644. ProxyAndTargetServers s;
  22645. auto cli = make_client("anything.test", s);
  22646. cli->set_no_proxy({"", " ", "\t"});
  22647. auto res = cli->Get("/");
  22648. ASSERT_TRUE(res) << "Error: " << to_string(res.error());
  22649. EXPECT_GE(s.proxy_hits(), 1);
  22650. EXPECT_EQ(0, s.target_hits());
  22651. }
  22652. TEST(NoProxyTest, ValidEntryWithSurroundingWhitespaceStillMatches) {
  22653. // An entry with leading/trailing whitespace must still match — env-style
  22654. // values are commonly pasted with stray spaces and an implementation
  22655. // that feeds the raw token directly to inet_pton would fail to match
  22656. // valid CIDRs because of the spaces.
  22657. ProxyAndTargetServers s;
  22658. Client cli("127.0.0.1", s.target_port());
  22659. cli.set_proxy("127.0.0.1", s.proxy_port());
  22660. cli.set_no_proxy({" 127.0.0.0/8 "});
  22661. auto res = cli.Get("/");
  22662. ASSERT_TRUE(res) << "Error: " << to_string(res.error());
  22663. EXPECT_EQ(0, s.proxy_hits());
  22664. EXPECT_EQ(1, s.target_hits());
  22665. }
  22666. TEST(NoProxyTest, RedirectToBypassedHostStripsProxyAndProxyAuth) {
  22667. // Analog of GHSA-6hrp-7fq9-3qv2: redirect to a NO_PROXY-matched host must
  22668. // go direct and must NOT carry Proxy-Authorization.
  22669. std::atomic<int> proxy_hits{0};
  22670. std::atomic<int> target_hits{0};
  22671. std::atomic<bool> target_saw_authz{false};
  22672. no_proxy_test::ScopedServer proxy_mock, target;
  22673. proxy_mock.svr().Get(".*", [&](const Request &, Response &res) {
  22674. proxy_hits++;
  22675. res.status = 302;
  22676. res.set_header("Location", "http://127.0.0.1:" +
  22677. std::to_string(target.port()) + "/landed");
  22678. });
  22679. target.svr().Get(".*", [&](const Request &req, Response &res) {
  22680. target_hits++;
  22681. if (req.has_header("Proxy-Authorization")) { target_saw_authz = true; }
  22682. res.set_content("direct", "text/plain");
  22683. });
  22684. proxy_mock.listen();
  22685. target.listen();
  22686. Client cli("public.example", target.port());
  22687. cli.set_hostname_addr_map({{"public.example", "127.0.0.1"}});
  22688. cli.set_proxy("127.0.0.1", proxy_mock.port());
  22689. cli.set_proxy_basic_auth("u", "p");
  22690. cli.set_no_proxy({"127.0.0.1"});
  22691. cli.set_follow_location(true);
  22692. auto res = cli.Get("/redir");
  22693. ASSERT_TRUE(res) << "Error: " << to_string(res.error());
  22694. EXPECT_GE(proxy_hits.load(), 1);
  22695. EXPECT_GE(target_hits.load(), 1);
  22696. EXPECT_FALSE(target_saw_authz.load());
  22697. }
  22698. #ifdef CPPHTTPLIB_SSL_ENABLED
  22699. TEST(NoProxyTest, BypassedTargetReturning407DoesNotLeakProxyDigestCredentials) {
  22700. // Direct origin replying 407 must not trigger the digest retry; otherwise
  22701. // proxy creds would be sent to the (possibly hostile) origin.
  22702. std::atomic<int> target_hits{0};
  22703. std::atomic<bool> target_saw_proxy_authz{false};
  22704. no_proxy_test::ScopedServer target;
  22705. target.svr().Get(".*", [&](const Request &req, Response &res) {
  22706. target_hits++;
  22707. if (req.has_header("Proxy-Authorization")) {
  22708. target_saw_proxy_authz = true;
  22709. }
  22710. res.status = StatusCode::ProxyAuthenticationRequired_407;
  22711. res.set_header("Proxy-Authenticate", "Digest realm=\"evil\", qop=\"auth\", "
  22712. "nonce=\"abc\", algorithm=MD5");
  22713. });
  22714. target.listen();
  22715. // The proxy address is set to the target's port: the bypass MUST kick in;
  22716. // if it doesn't, the test still routes "via proxy" to the same server and
  22717. // the Proxy-Authorization assertion below catches the leak.
  22718. Client cli("evil.example", target.port());
  22719. cli.set_hostname_addr_map({{"evil.example", "127.0.0.1"}});
  22720. cli.set_proxy("127.0.0.1", target.port());
  22721. cli.set_proxy_digest_auth("proxy-user", "proxy-pass");
  22722. cli.set_no_proxy({"evil.example"});
  22723. auto res = cli.Get("/x");
  22724. ASSERT_TRUE(res) << "Error: " << to_string(res.error());
  22725. EXPECT_EQ(StatusCode::ProxyAuthenticationRequired_407, res->status);
  22726. EXPECT_EQ(1, target_hits.load());
  22727. EXPECT_FALSE(target_saw_proxy_authz.load());
  22728. }
  22729. #endif
  22730. TEST(NoProxyTest, MultiHopRedirectThroughBypassedHostKeepsProxy) {
  22731. // A (via proxy) → B (NO_PROXY-matched, direct) → C must re-engage the proxy.
  22732. std::atomic<int> proxy_hits{0};
  22733. std::atomic<int> bypass_hits{0};
  22734. std::atomic<bool> proxy_saw_c_url{false};
  22735. no_proxy_test::ScopedServer proxy_mock, bypass_server;
  22736. proxy_mock.svr().Get(".*", [&](const Request &req, Response &res) {
  22737. proxy_hits++;
  22738. if (req.path.find("/start") != std::string::npos) {
  22739. res.status = 302;
  22740. res.set_header("Location", "http://127.0.0.1:" +
  22741. std::to_string(bypass_server.port()) +
  22742. "/middle");
  22743. return;
  22744. }
  22745. if (req.path.find("/end") != std::string::npos) {
  22746. proxy_saw_c_url = true;
  22747. res.set_content("c-via-proxy", "text/plain");
  22748. return;
  22749. }
  22750. res.set_content("unexpected", "text/plain");
  22751. });
  22752. // public.example's "advertised" port is arbitrary (the request never lands
  22753. // there — it goes through the proxy), but use a dynamic value to stay
  22754. // friendly with sharded parallel runs.
  22755. int public_port = bypass_server.port();
  22756. bypass_server.svr().Get(".*", [&](const Request &, Response &res) {
  22757. bypass_hits++;
  22758. res.status = 302;
  22759. res.set_header("Location", "http://public.example:" +
  22760. std::to_string(public_port) + "/end");
  22761. });
  22762. proxy_mock.listen();
  22763. bypass_server.listen();
  22764. Client cli("public.example", public_port);
  22765. cli.set_hostname_addr_map({{"public.example", "127.0.0.1"}});
  22766. cli.set_proxy("127.0.0.1", proxy_mock.port());
  22767. cli.set_no_proxy({"127.0.0.1"});
  22768. cli.set_follow_location(true);
  22769. auto res = cli.Get("/start");
  22770. ASSERT_TRUE(res) << "Error: " << to_string(res.error());
  22771. EXPECT_EQ(StatusCode::OK_200, res->status);
  22772. EXPECT_EQ("c-via-proxy", res->body);
  22773. EXPECT_GE(proxy_hits.load(), 2);
  22774. EXPECT_GE(bypass_hits.load(), 1);
  22775. EXPECT_TRUE(proxy_saw_c_url.load());
  22776. }
  22777. TEST(NoProxyTest, KeepAliveSocketInvalidatedOnSetNoProxy) {
  22778. // Mid-session set_no_proxy must drop any keep-alive socket so the next
  22779. // request reconnects to the correct endpoint.
  22780. std::atomic<int> proxy_hits{0};
  22781. std::atomic<int> target_hits{0};
  22782. no_proxy_test::ScopedServer proxy_mock, target;
  22783. proxy_mock.svr().Get(".*", [&](const Request &, Response &res) {
  22784. proxy_hits++;
  22785. res.set_content("via-proxy", "text/plain");
  22786. });
  22787. target.svr().Get(".*", [&](const Request &, Response &res) {
  22788. target_hits++;
  22789. res.set_content("direct", "text/plain");
  22790. });
  22791. proxy_mock.listen();
  22792. target.listen();
  22793. Client cli("public.example", target.port());
  22794. cli.set_hostname_addr_map({{"public.example", "127.0.0.1"}});
  22795. cli.set_proxy("127.0.0.1", proxy_mock.port());
  22796. cli.set_keep_alive(true);
  22797. auto res1 = cli.Get("/a");
  22798. ASSERT_TRUE(res1);
  22799. EXPECT_EQ("via-proxy", res1->body);
  22800. EXPECT_EQ(1, proxy_hits.load());
  22801. EXPECT_EQ(0, target_hits.load());
  22802. cli.set_no_proxy({"public.example"});
  22803. auto res2 = cli.Get("/b");
  22804. ASSERT_TRUE(res2);
  22805. EXPECT_EQ("direct", res2->body);
  22806. EXPECT_EQ(1, proxy_hits.load());
  22807. EXPECT_EQ(1, target_hits.load());
  22808. }
  22809. #if defined(CPPHTTPLIB_SSL_ENABLED) && !defined(_WIN32)
  22810. namespace proxy_tunnel_test {
  22811. // SSLServer counterpart to no_proxy_test::ScopedServer.
  22812. class ScopedSSLServer {
  22813. public:
  22814. ScopedSSLServer() : svr_(SERVER_CERT_FILE, SERVER_PRIVATE_KEY_FILE) {
  22815. port_ = svr_.bind_to_any_port("127.0.0.1");
  22816. }
  22817. ~ScopedSSLServer() {
  22818. svr_.stop();
  22819. if (th_.joinable()) { th_.join(); }
  22820. }
  22821. SSLServer &svr() { return svr_; }
  22822. int port() const { return port_; }
  22823. void listen() {
  22824. th_ = std::thread([this] { svr_.listen_after_bind(); });
  22825. svr_.wait_until_ready();
  22826. }
  22827. private:
  22828. SSLServer svr_;
  22829. std::thread th_;
  22830. int port_ = 0;
  22831. };
  22832. // Accepts CONNECT, replies 200, byte-forwards to forward_port.
  22833. class ScopedConnectProxy {
  22834. public:
  22835. explicit ScopedConnectProxy(int forward_port) : forward_port_(forward_port) {
  22836. listen_fd_ = ::socket(AF_INET, SOCK_STREAM, 0);
  22837. if (listen_fd_ < 0) { return; }
  22838. int yes = 1;
  22839. ::setsockopt(listen_fd_, SOL_SOCKET, SO_REUSEADDR, &yes, sizeof(yes));
  22840. sockaddr_in a{};
  22841. a.sin_family = AF_INET;
  22842. a.sin_addr.s_addr = htonl(INADDR_LOOPBACK);
  22843. a.sin_port = 0;
  22844. if (::bind(listen_fd_, reinterpret_cast<sockaddr *>(&a), sizeof(a)) != 0) {
  22845. return;
  22846. }
  22847. socklen_t alen = sizeof(a);
  22848. if (::getsockname(listen_fd_, reinterpret_cast<sockaddr *>(&a), &alen) !=
  22849. 0) {
  22850. return;
  22851. }
  22852. port_ = ntohs(a.sin_port);
  22853. if (::listen(listen_fd_, 1) != 0) { return; }
  22854. th_ = std::thread([this] { run(); });
  22855. }
  22856. ~ScopedConnectProxy() {
  22857. stop_ = true;
  22858. if (listen_fd_ >= 0) {
  22859. ::shutdown(listen_fd_, SHUT_RDWR);
  22860. ::close(listen_fd_);
  22861. }
  22862. if (th_.joinable()) { th_.join(); }
  22863. }
  22864. int port() const { return port_; }
  22865. int connect_hits() const { return connect_hits_.load(); }
  22866. // Head of the last CONNECT request, as the proxy saw it on the wire.
  22867. std::string connect_request() const {
  22868. std::lock_guard<std::mutex> lock(connect_request_mutex_);
  22869. return connect_request_;
  22870. }
  22871. private:
  22872. void run() {
  22873. while (!stop_.load()) {
  22874. fd_set rfds;
  22875. FD_ZERO(&rfds);
  22876. FD_SET(listen_fd_, &rfds);
  22877. timeval tv{0, 100 * 1000};
  22878. int sel = ::select(listen_fd_ + 1, &rfds, nullptr, nullptr, &tv);
  22879. if (sel <= 0) { continue; }
  22880. int client_fd = ::accept(listen_fd_, nullptr, nullptr);
  22881. if (client_fd < 0) { continue; }
  22882. std::string req;
  22883. char buf[2048];
  22884. while (req.find("\r\n\r\n") == std::string::npos) {
  22885. ssize_t n = ::recv(client_fd, buf, sizeof(buf), 0);
  22886. if (n <= 0) { break; }
  22887. req.append(buf, static_cast<size_t>(n));
  22888. }
  22889. if (req.compare(0, 7, "CONNECT") != 0) {
  22890. ::close(client_fd);
  22891. continue;
  22892. }
  22893. connect_hits_++;
  22894. {
  22895. std::lock_guard<std::mutex> lock(connect_request_mutex_);
  22896. connect_request_ = req;
  22897. }
  22898. const char *ok = "HTTP/1.1 200 Connection established\r\n\r\n";
  22899. ::send(client_fd, ok, std::strlen(ok), 0);
  22900. int origin_fd = ::socket(AF_INET, SOCK_STREAM, 0);
  22901. sockaddr_in o{};
  22902. o.sin_family = AF_INET;
  22903. o.sin_addr.s_addr = htonl(INADDR_LOOPBACK);
  22904. o.sin_port = htons(static_cast<unsigned short>(forward_port_));
  22905. if (::connect(origin_fd, reinterpret_cast<sockaddr *>(&o), sizeof(o)) !=
  22906. 0) {
  22907. ::close(client_fd);
  22908. ::close(origin_fd);
  22909. continue;
  22910. }
  22911. auto forward = [](int from, int to) {
  22912. char b[8192];
  22913. for (;;) {
  22914. ssize_t n = ::recv(from, b, sizeof(b), 0);
  22915. if (n <= 0) { break; }
  22916. ssize_t off = 0;
  22917. while (off < n) {
  22918. ssize_t s = ::send(to, b + off, static_cast<size_t>(n - off), 0);
  22919. if (s <= 0) {
  22920. off = n;
  22921. break;
  22922. }
  22923. off += s;
  22924. }
  22925. }
  22926. ::shutdown(to, SHUT_WR);
  22927. };
  22928. std::thread t1([&] { forward(client_fd, origin_fd); });
  22929. std::thread t2([&] { forward(origin_fd, client_fd); });
  22930. t1.join();
  22931. t2.join();
  22932. ::close(client_fd);
  22933. ::close(origin_fd);
  22934. }
  22935. }
  22936. int forward_port_ = -1;
  22937. int listen_fd_ = -1;
  22938. int port_ = 0;
  22939. std::thread th_;
  22940. std::atomic<bool> stop_{false};
  22941. std::atomic<int> connect_hits_{0};
  22942. mutable std::mutex connect_request_mutex_;
  22943. std::string connect_request_;
  22944. };
  22945. // Sends one request through the CONNECT proxy to the TLS origin with a
  22946. // credential configured for each hop, and checks that each credential reaches
  22947. // only the hop it was configured for: the proxy's on the CONNECT request, the
  22948. // origin's (every header in origin_headers) on the tunnelled request.
  22949. void CredentialsStayWithTheirHop(
  22950. const std::function<void(SSLClient &)> &set_credentials,
  22951. const std::string &scheme,
  22952. const std::vector<std::string> &origin_headers = {"Authorization"}) {
  22953. std::atomic<int> origin_hits{0};
  22954. std::atomic<bool> origin_saw_proxy_authz{false};
  22955. std::atomic<bool> origin_saw_headers{false};
  22956. ScopedSSLServer origin;
  22957. origin.svr().Get(".*", [&](const Request &req, Response &res) {
  22958. origin_hits++;
  22959. origin_saw_proxy_authz = req.has_header("Proxy-Authorization");
  22960. origin_saw_headers =
  22961. std::all_of(origin_headers.begin(), origin_headers.end(),
  22962. [&](const std::string &h) { return req.has_header(h); });
  22963. res.set_content("ok", "text/plain");
  22964. });
  22965. origin.listen();
  22966. ScopedConnectProxy proxy(origin.port());
  22967. ASSERT_NE(0, proxy.port());
  22968. // Pinned to 127.0.0.1 for the same reason as the test below.
  22969. SSLClient cli("127.0.0.1", origin.port());
  22970. cli.enable_server_certificate_verification(false);
  22971. cli.set_proxy("127.0.0.1", proxy.port());
  22972. set_credentials(cli);
  22973. auto res = cli.Get("/x");
  22974. ASSERT_TRUE(res) << "Error: " << to_string(res.error());
  22975. EXPECT_EQ(StatusCode::OK_200, res->status);
  22976. EXPECT_EQ(1, origin_hits.load());
  22977. EXPECT_EQ(1, proxy.connect_hits());
  22978. EXPECT_TRUE(origin_saw_headers.load());
  22979. EXPECT_FALSE(origin_saw_proxy_authz.load())
  22980. << "Proxy-Authorization must not be sent inside the tunnel";
  22981. auto connect_req = proxy.connect_request();
  22982. EXPECT_NE(std::string::npos,
  22983. connect_req.find("\r\nProxy-Authorization: " + scheme + " "));
  22984. for (const auto &h : origin_headers) {
  22985. EXPECT_EQ(std::string::npos, connect_req.find("\r\n" + h + ": "))
  22986. << h << " must not be sent to the proxy on CONNECT";
  22987. }
  22988. }
  22989. } // namespace proxy_tunnel_test
  22990. TEST(ProxyTunnelTest, BasicCredentialsStayWithTheirHop) {
  22991. proxy_tunnel_test::CredentialsStayWithTheirHop(
  22992. [](SSLClient &cli) {
  22993. cli.set_proxy_basic_auth("proxy-user", "proxy-pass");
  22994. cli.set_basic_auth("origin-user", "origin-pass");
  22995. },
  22996. "Basic");
  22997. }
  22998. TEST(ProxyTunnelTest, BearerCredentialsStayWithTheirHop) {
  22999. proxy_tunnel_test::CredentialsStayWithTheirHop(
  23000. [](SSLClient &cli) {
  23001. cli.set_proxy_bearer_token_auth("proxy-token");
  23002. cli.set_bearer_token_auth("origin-token");
  23003. },
  23004. "Bearer");
  23005. }
  23006. TEST(ProxyTunnelTest, DefaultHeadersStayOffConnect) {
  23007. proxy_tunnel_test::CredentialsStayWithTheirHop(
  23008. [](SSLClient &cli) {
  23009. cli.set_proxy_basic_auth("proxy-user", "proxy-pass");
  23010. cli.set_default_headers({{"Authorization", "Bearer origin-token"},
  23011. {"Cookie", "sid=origin-session"},
  23012. {"X-Api-Key", "origin-key"}});
  23013. },
  23014. "Basic", {"Authorization", "Cookie", "X-Api-Key"});
  23015. }
  23016. TEST(ProxyTunnelTest, OriginReturning407InsideTunnelDoesNotLeakProxyDigest) {
  23017. // Origin inside a CONNECT tunnel replying 407 must not trigger the digest
  23018. // retry; otherwise proxy creds would be sent to the origin.
  23019. std::atomic<int> origin_hits{0};
  23020. std::atomic<bool> origin_saw_proxy_authz{false};
  23021. proxy_tunnel_test::ScopedSSLServer origin;
  23022. origin.svr().Get(".*", [&](const Request &req, Response &res) {
  23023. origin_hits++;
  23024. if (req.has_header("Proxy-Authorization")) {
  23025. origin_saw_proxy_authz = true;
  23026. }
  23027. res.status = StatusCode::ProxyAuthenticationRequired_407;
  23028. res.set_header("Proxy-Authenticate",
  23029. "Digest realm=\"evil\", qop=\"auth\", nonce=\"abc\", "
  23030. "algorithm=MD5");
  23031. });
  23032. origin.listen();
  23033. proxy_tunnel_test::ScopedConnectProxy proxy(origin.port());
  23034. ASSERT_NE(0, proxy.port());
  23035. // Pin to 127.0.0.1: the proxy listens on 127.0.0.1 only, while "localhost"
  23036. // may resolve to ::1 first. A concurrent test (e.g. another gtest shard)
  23037. // holding ::1 with the same ephemeral port number would hijack the CONNECT
  23038. // and answer with its own status, making this test flaky.
  23039. SSLClient cli("127.0.0.1", origin.port());
  23040. cli.enable_server_certificate_verification(false);
  23041. cli.set_proxy("127.0.0.1", proxy.port());
  23042. cli.set_proxy_digest_auth("proxy-user", "proxy-pass");
  23043. auto res = cli.Get("/x");
  23044. ASSERT_TRUE(res) << "Error: " << to_string(res.error());
  23045. EXPECT_EQ(StatusCode::ProxyAuthenticationRequired_407, res->status);
  23046. EXPECT_EQ(1, origin_hits.load());
  23047. EXPECT_FALSE(origin_saw_proxy_authz.load());
  23048. EXPECT_EQ(1, proxy.connect_hits());
  23049. }
  23050. #endif