test.cc 971 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283284285286287288289290291292293294295296297298299300301302303304305306307308309310311312313314315316317318319320321322323324325326327328329330331332333334335336337338339340341342343344345346347348349350351352353354355356357358359360361362363364365366367368369370371372373374375376377378379380381382383384385386387388389390391392393394395396397398399400401402403404405406407408409410411412413414415416417418419420421422423424425426427428429430431432433434435436437438439440441442443444445446447448449450451452453454455456457458459460461462463464465466467468469470471472473474475476477478479480481482483484485486487488489490491492493494495496497498499500501502503504505506507508509510511512513514515516517518519520521522523524525526527528529530531532533534535536537538539540541542543544545546547548549550551552553554555556557558559560561562563564565566567568569570571572573574575576577578579580581582583584585586587588589590591592593594595596597598599600601602603604605606607608609610611612613614615616617618619620621622623624625626627628629630631632633634635636637638639640641642643644645646647648649650651652653654655656657658659660661662663664665666667668669670671672673674675676677678679680681682683684685686687688689690691692693694695696697698699700701702703704705706707708709710711712713714715716717718719720721722723724725726727728729730731732733734735736737738739740741742743744745746747748749750751752753754755756757758759760761762763764765766767768769770771772773774775776777778779780781782783784785786787788789790791792793794795796797798799800801802803804805806807808809810811812813814815816817818819820821822823824825826827828829830831832833834835836837838839840841842843844845846847848849850851852853854855856857858859860861862863864865866867868869870871872873874875876877878879880881882883884885886887888889890891892893894895896897898899900901902903904905906907908909910911912913914915916917918919920921922923924925926927928929930931932933934935936937938939940941942943944945946947948949950951952953954955956957958959960961962963964965966967968969970971972973974975976977978979980981982983984985986987988989990991992993994995996997998999100010011002100310041005100610071008100910101011101210131014101510161017101810191020102110221023102410251026102710281029103010311032103310341035103610371038103910401041104210431044104510461047104810491050105110521053105410551056105710581059106010611062106310641065106610671068106910701071107210731074107510761077107810791080108110821083108410851086108710881089109010911092109310941095109610971098109911001101110211031104110511061107110811091110111111121113111411151116111711181119112011211122112311241125112611271128112911301131113211331134113511361137113811391140114111421143114411451146114711481149115011511152115311541155115611571158115911601161116211631164116511661167116811691170117111721173117411751176117711781179118011811182118311841185118611871188118911901191119211931194119511961197119811991200120112021203120412051206120712081209121012111212121312141215121612171218121912201221122212231224122512261227122812291230123112321233123412351236123712381239124012411242124312441245124612471248124912501251125212531254125512561257125812591260126112621263126412651266126712681269127012711272127312741275127612771278127912801281128212831284128512861287128812891290129112921293129412951296129712981299130013011302130313041305130613071308130913101311131213131314131513161317131813191320132113221323132413251326132713281329133013311332133313341335133613371338133913401341134213431344134513461347134813491350135113521353135413551356135713581359136013611362136313641365136613671368136913701371137213731374137513761377137813791380138113821383138413851386138713881389139013911392139313941395139613971398139914001401140214031404140514061407140814091410141114121413141414151416141714181419142014211422142314241425142614271428142914301431143214331434143514361437143814391440144114421443144414451446144714481449145014511452145314541455145614571458145914601461146214631464146514661467146814691470147114721473147414751476147714781479148014811482148314841485148614871488148914901491149214931494149514961497149814991500150115021503150415051506150715081509151015111512151315141515151615171518151915201521152215231524152515261527152815291530153115321533153415351536153715381539154015411542154315441545154615471548154915501551155215531554155515561557155815591560156115621563156415651566156715681569157015711572157315741575157615771578157915801581158215831584158515861587158815891590159115921593159415951596159715981599160016011602160316041605160616071608160916101611161216131614161516161617161816191620162116221623162416251626162716281629163016311632163316341635163616371638163916401641164216431644164516461647164816491650165116521653165416551656165716581659166016611662166316641665166616671668166916701671167216731674167516761677167816791680168116821683168416851686168716881689169016911692169316941695169616971698169917001701170217031704170517061707170817091710171117121713171417151716171717181719172017211722172317241725172617271728172917301731173217331734173517361737173817391740174117421743174417451746174717481749175017511752175317541755175617571758175917601761176217631764176517661767176817691770177117721773177417751776177717781779178017811782178317841785178617871788178917901791179217931794179517961797179817991800180118021803180418051806180718081809181018111812181318141815181618171818181918201821182218231824182518261827182818291830183118321833183418351836183718381839184018411842184318441845184618471848184918501851185218531854185518561857185818591860186118621863186418651866186718681869187018711872187318741875187618771878187918801881188218831884188518861887188818891890189118921893189418951896189718981899190019011902190319041905190619071908190919101911191219131914191519161917191819191920192119221923192419251926192719281929193019311932193319341935193619371938193919401941194219431944194519461947194819491950195119521953195419551956195719581959196019611962196319641965196619671968196919701971197219731974197519761977197819791980198119821983198419851986198719881989199019911992199319941995199619971998199920002001200220032004200520062007200820092010201120122013201420152016201720182019202020212022202320242025202620272028202920302031203220332034203520362037203820392040204120422043204420452046204720482049205020512052205320542055205620572058205920602061206220632064206520662067206820692070207120722073207420752076207720782079208020812082208320842085208620872088208920902091209220932094209520962097209820992100210121022103210421052106210721082109211021112112211321142115211621172118211921202121212221232124212521262127212821292130213121322133213421352136213721382139214021412142214321442145214621472148214921502151215221532154215521562157215821592160216121622163216421652166216721682169217021712172217321742175217621772178217921802181218221832184218521862187218821892190219121922193219421952196219721982199220022012202220322042205220622072208220922102211221222132214221522162217221822192220222122222223222422252226222722282229223022312232223322342235223622372238223922402241224222432244224522462247224822492250225122522253225422552256225722582259226022612262226322642265226622672268226922702271227222732274227522762277227822792280228122822283228422852286228722882289229022912292229322942295229622972298229923002301230223032304230523062307230823092310231123122313231423152316231723182319232023212322232323242325232623272328232923302331233223332334233523362337233823392340234123422343234423452346234723482349235023512352235323542355235623572358235923602361236223632364236523662367236823692370237123722373237423752376237723782379238023812382238323842385238623872388238923902391239223932394239523962397239823992400240124022403240424052406240724082409241024112412241324142415241624172418241924202421242224232424242524262427242824292430243124322433243424352436243724382439244024412442244324442445244624472448244924502451245224532454245524562457245824592460246124622463246424652466246724682469247024712472247324742475247624772478247924802481248224832484248524862487248824892490249124922493249424952496249724982499250025012502250325042505250625072508250925102511251225132514251525162517251825192520252125222523252425252526252725282529253025312532253325342535253625372538253925402541254225432544254525462547254825492550255125522553255425552556255725582559256025612562256325642565256625672568256925702571257225732574257525762577257825792580258125822583258425852586258725882589259025912592259325942595259625972598259926002601260226032604260526062607260826092610261126122613261426152616261726182619262026212622262326242625262626272628262926302631263226332634263526362637263826392640264126422643264426452646264726482649265026512652265326542655265626572658265926602661266226632664266526662667266826692670267126722673267426752676267726782679268026812682268326842685268626872688268926902691269226932694269526962697269826992700270127022703270427052706270727082709271027112712271327142715271627172718271927202721272227232724272527262727272827292730273127322733273427352736273727382739274027412742274327442745274627472748274927502751275227532754275527562757275827592760276127622763276427652766276727682769277027712772277327742775277627772778277927802781278227832784278527862787278827892790279127922793279427952796279727982799280028012802280328042805280628072808280928102811281228132814281528162817281828192820282128222823282428252826282728282829283028312832283328342835283628372838283928402841284228432844284528462847284828492850285128522853285428552856285728582859286028612862286328642865286628672868286928702871287228732874287528762877287828792880288128822883288428852886288728882889289028912892289328942895289628972898289929002901290229032904290529062907290829092910291129122913291429152916291729182919292029212922292329242925292629272928292929302931293229332934293529362937293829392940294129422943294429452946294729482949295029512952295329542955295629572958295929602961296229632964296529662967296829692970297129722973297429752976297729782979298029812982298329842985298629872988298929902991299229932994299529962997299829993000300130023003300430053006300730083009301030113012301330143015301630173018301930203021302230233024302530263027302830293030303130323033303430353036303730383039304030413042304330443045304630473048304930503051305230533054305530563057305830593060306130623063306430653066306730683069307030713072307330743075307630773078307930803081308230833084308530863087308830893090309130923093309430953096309730983099310031013102310331043105310631073108310931103111311231133114311531163117311831193120312131223123312431253126312731283129313031313132313331343135313631373138313931403141314231433144314531463147314831493150315131523153315431553156315731583159316031613162316331643165316631673168316931703171317231733174317531763177317831793180318131823183318431853186318731883189319031913192319331943195319631973198319932003201320232033204320532063207320832093210321132123213321432153216321732183219322032213222322332243225322632273228322932303231323232333234323532363237323832393240324132423243324432453246324732483249325032513252325332543255325632573258325932603261326232633264326532663267326832693270327132723273327432753276327732783279328032813282328332843285328632873288328932903291329232933294329532963297329832993300330133023303330433053306330733083309331033113312331333143315331633173318331933203321332233233324332533263327332833293330333133323333333433353336333733383339334033413342334333443345334633473348334933503351335233533354335533563357335833593360336133623363336433653366336733683369337033713372337333743375337633773378337933803381338233833384338533863387338833893390339133923393339433953396339733983399340034013402340334043405340634073408340934103411341234133414341534163417341834193420342134223423342434253426342734283429343034313432343334343435343634373438343934403441344234433444344534463447344834493450345134523453345434553456345734583459346034613462346334643465346634673468346934703471347234733474347534763477347834793480348134823483348434853486348734883489349034913492349334943495349634973498349935003501350235033504350535063507350835093510351135123513351435153516351735183519352035213522352335243525352635273528352935303531353235333534353535363537353835393540354135423543354435453546354735483549355035513552355335543555355635573558355935603561356235633564356535663567356835693570357135723573357435753576357735783579358035813582358335843585358635873588358935903591359235933594359535963597359835993600360136023603360436053606360736083609361036113612361336143615361636173618361936203621362236233624362536263627362836293630363136323633363436353636363736383639364036413642364336443645364636473648364936503651365236533654365536563657365836593660366136623663366436653666366736683669367036713672367336743675367636773678367936803681368236833684368536863687368836893690369136923693369436953696369736983699370037013702370337043705370637073708370937103711371237133714371537163717371837193720372137223723372437253726372737283729373037313732373337343735373637373738373937403741374237433744374537463747374837493750375137523753375437553756375737583759376037613762376337643765376637673768376937703771377237733774377537763777377837793780378137823783378437853786378737883789379037913792379337943795379637973798379938003801380238033804380538063807380838093810381138123813381438153816381738183819382038213822382338243825382638273828382938303831383238333834383538363837383838393840384138423843384438453846384738483849385038513852385338543855385638573858385938603861386238633864386538663867386838693870387138723873387438753876387738783879388038813882388338843885388638873888388938903891389238933894389538963897389838993900390139023903390439053906390739083909391039113912391339143915391639173918391939203921392239233924392539263927392839293930393139323933393439353936393739383939394039413942394339443945394639473948394939503951395239533954395539563957395839593960396139623963396439653966396739683969397039713972397339743975397639773978397939803981398239833984398539863987398839893990399139923993399439953996399739983999400040014002400340044005400640074008400940104011401240134014401540164017401840194020402140224023402440254026402740284029403040314032403340344035403640374038403940404041404240434044404540464047404840494050405140524053405440554056405740584059406040614062406340644065406640674068406940704071407240734074407540764077407840794080408140824083408440854086408740884089409040914092409340944095409640974098409941004101410241034104410541064107410841094110411141124113411441154116411741184119412041214122412341244125412641274128412941304131413241334134413541364137413841394140414141424143414441454146414741484149415041514152415341544155415641574158415941604161416241634164416541664167416841694170417141724173417441754176417741784179418041814182418341844185418641874188418941904191419241934194419541964197419841994200420142024203420442054206420742084209421042114212421342144215421642174218421942204221422242234224422542264227422842294230423142324233423442354236423742384239424042414242424342444245424642474248424942504251425242534254425542564257425842594260426142624263426442654266426742684269427042714272427342744275427642774278427942804281428242834284428542864287428842894290429142924293429442954296429742984299430043014302430343044305430643074308430943104311431243134314431543164317431843194320432143224323432443254326432743284329433043314332433343344335433643374338433943404341434243434344434543464347434843494350435143524353435443554356435743584359436043614362436343644365436643674368436943704371437243734374437543764377437843794380438143824383438443854386438743884389439043914392439343944395439643974398439944004401440244034404440544064407440844094410441144124413441444154416441744184419442044214422442344244425442644274428442944304431443244334434443544364437443844394440444144424443444444454446444744484449445044514452445344544455445644574458445944604461446244634464446544664467446844694470447144724473447444754476447744784479448044814482448344844485448644874488448944904491449244934494449544964497449844994500450145024503450445054506450745084509451045114512451345144515451645174518451945204521452245234524452545264527452845294530453145324533453445354536453745384539454045414542454345444545454645474548454945504551455245534554455545564557455845594560456145624563456445654566456745684569457045714572457345744575457645774578457945804581458245834584458545864587458845894590459145924593459445954596459745984599460046014602460346044605460646074608460946104611461246134614461546164617461846194620462146224623462446254626462746284629463046314632463346344635463646374638463946404641464246434644464546464647464846494650465146524653465446554656465746584659466046614662466346644665466646674668466946704671467246734674467546764677467846794680468146824683468446854686468746884689469046914692469346944695469646974698469947004701470247034704470547064707470847094710471147124713471447154716471747184719472047214722472347244725472647274728472947304731473247334734473547364737473847394740474147424743474447454746474747484749475047514752475347544755475647574758475947604761476247634764476547664767476847694770477147724773477447754776477747784779478047814782478347844785478647874788478947904791479247934794479547964797479847994800480148024803480448054806480748084809481048114812481348144815481648174818481948204821482248234824482548264827482848294830483148324833483448354836483748384839484048414842484348444845484648474848484948504851485248534854485548564857485848594860486148624863486448654866486748684869487048714872487348744875487648774878487948804881488248834884488548864887488848894890489148924893489448954896489748984899490049014902490349044905490649074908490949104911491249134914491549164917491849194920492149224923492449254926492749284929493049314932493349344935493649374938493949404941494249434944494549464947494849494950495149524953495449554956495749584959496049614962496349644965496649674968496949704971497249734974497549764977497849794980498149824983498449854986498749884989499049914992499349944995499649974998499950005001500250035004500550065007500850095010501150125013501450155016501750185019502050215022502350245025502650275028502950305031503250335034503550365037503850395040504150425043504450455046504750485049505050515052505350545055505650575058505950605061506250635064506550665067506850695070507150725073507450755076507750785079508050815082508350845085508650875088508950905091509250935094509550965097509850995100510151025103510451055106510751085109511051115112511351145115511651175118511951205121512251235124512551265127512851295130513151325133513451355136513751385139514051415142514351445145514651475148514951505151515251535154515551565157515851595160516151625163516451655166516751685169517051715172517351745175517651775178517951805181518251835184518551865187518851895190519151925193519451955196519751985199520052015202520352045205520652075208520952105211521252135214521552165217521852195220522152225223522452255226522752285229523052315232523352345235523652375238523952405241524252435244524552465247524852495250525152525253525452555256525752585259526052615262526352645265526652675268526952705271527252735274527552765277527852795280528152825283528452855286528752885289529052915292529352945295529652975298529953005301530253035304530553065307530853095310531153125313531453155316531753185319532053215322532353245325532653275328532953305331533253335334533553365337533853395340534153425343534453455346534753485349535053515352535353545355535653575358535953605361536253635364536553665367536853695370537153725373537453755376537753785379538053815382538353845385538653875388538953905391539253935394539553965397539853995400540154025403540454055406540754085409541054115412541354145415541654175418541954205421542254235424542554265427542854295430543154325433543454355436543754385439544054415442544354445445544654475448544954505451545254535454545554565457545854595460546154625463546454655466546754685469547054715472547354745475547654775478547954805481548254835484548554865487548854895490549154925493549454955496549754985499550055015502550355045505550655075508550955105511551255135514551555165517551855195520552155225523552455255526552755285529553055315532553355345535553655375538553955405541554255435544554555465547554855495550555155525553555455555556555755585559556055615562556355645565556655675568556955705571557255735574557555765577557855795580558155825583558455855586558755885589559055915592559355945595559655975598559956005601560256035604560556065607560856095610561156125613561456155616561756185619562056215622562356245625562656275628562956305631563256335634563556365637563856395640564156425643564456455646564756485649565056515652565356545655565656575658565956605661566256635664566556665667566856695670567156725673567456755676567756785679568056815682568356845685568656875688568956905691569256935694569556965697569856995700570157025703570457055706570757085709571057115712571357145715571657175718571957205721572257235724572557265727572857295730573157325733573457355736573757385739574057415742574357445745574657475748574957505751575257535754575557565757575857595760576157625763576457655766576757685769577057715772577357745775577657775778577957805781578257835784578557865787578857895790579157925793579457955796579757985799580058015802580358045805580658075808580958105811581258135814581558165817581858195820582158225823582458255826582758285829583058315832583358345835583658375838583958405841584258435844584558465847584858495850585158525853585458555856585758585859586058615862586358645865586658675868586958705871587258735874587558765877587858795880588158825883588458855886588758885889589058915892589358945895589658975898589959005901590259035904590559065907590859095910591159125913591459155916591759185919592059215922592359245925592659275928592959305931593259335934593559365937593859395940594159425943594459455946594759485949595059515952595359545955595659575958595959605961596259635964596559665967596859695970597159725973597459755976597759785979598059815982598359845985598659875988598959905991599259935994599559965997599859996000600160026003600460056006600760086009601060116012601360146015601660176018601960206021602260236024602560266027602860296030603160326033603460356036603760386039604060416042604360446045604660476048604960506051605260536054605560566057605860596060606160626063606460656066606760686069607060716072607360746075607660776078607960806081608260836084608560866087608860896090609160926093609460956096609760986099610061016102610361046105610661076108610961106111611261136114611561166117611861196120612161226123612461256126612761286129613061316132613361346135613661376138613961406141614261436144614561466147614861496150615161526153615461556156615761586159616061616162616361646165616661676168616961706171617261736174617561766177617861796180618161826183618461856186618761886189619061916192619361946195619661976198619962006201620262036204620562066207620862096210621162126213621462156216621762186219622062216222622362246225622662276228622962306231623262336234623562366237623862396240624162426243624462456246624762486249625062516252625362546255625662576258625962606261626262636264626562666267626862696270627162726273627462756276627762786279628062816282628362846285628662876288628962906291629262936294629562966297629862996300630163026303630463056306630763086309631063116312631363146315631663176318631963206321632263236324632563266327632863296330633163326333633463356336633763386339634063416342634363446345634663476348634963506351635263536354635563566357635863596360636163626363636463656366636763686369637063716372637363746375637663776378637963806381638263836384638563866387638863896390639163926393639463956396639763986399640064016402640364046405640664076408640964106411641264136414641564166417641864196420642164226423642464256426642764286429643064316432643364346435643664376438643964406441644264436444644564466447644864496450645164526453645464556456645764586459646064616462646364646465646664676468646964706471647264736474647564766477647864796480648164826483648464856486648764886489649064916492649364946495649664976498649965006501650265036504650565066507650865096510651165126513651465156516651765186519652065216522652365246525652665276528652965306531653265336534653565366537653865396540654165426543654465456546654765486549655065516552655365546555655665576558655965606561656265636564656565666567656865696570657165726573657465756576657765786579658065816582658365846585658665876588658965906591659265936594659565966597659865996600660166026603660466056606660766086609661066116612661366146615661666176618661966206621662266236624662566266627662866296630663166326633663466356636663766386639664066416642664366446645664666476648664966506651665266536654665566566657665866596660666166626663666466656666666766686669667066716672667366746675667666776678667966806681668266836684668566866687668866896690669166926693669466956696669766986699670067016702670367046705670667076708670967106711671267136714671567166717671867196720672167226723672467256726672767286729673067316732673367346735673667376738673967406741674267436744674567466747674867496750675167526753675467556756675767586759676067616762676367646765676667676768676967706771677267736774677567766777677867796780678167826783678467856786678767886789679067916792679367946795679667976798679968006801680268036804680568066807680868096810681168126813681468156816681768186819682068216822682368246825682668276828682968306831683268336834683568366837683868396840684168426843684468456846684768486849685068516852685368546855685668576858685968606861686268636864686568666867686868696870687168726873687468756876687768786879688068816882688368846885688668876888688968906891689268936894689568966897689868996900690169026903690469056906690769086909691069116912691369146915691669176918691969206921692269236924692569266927692869296930693169326933693469356936693769386939694069416942694369446945694669476948694969506951695269536954695569566957695869596960696169626963696469656966696769686969697069716972697369746975697669776978697969806981698269836984698569866987698869896990699169926993699469956996699769986999700070017002700370047005700670077008700970107011701270137014701570167017701870197020702170227023702470257026702770287029703070317032703370347035703670377038703970407041704270437044704570467047704870497050705170527053705470557056705770587059706070617062706370647065706670677068706970707071707270737074707570767077707870797080708170827083708470857086708770887089709070917092709370947095709670977098709971007101710271037104710571067107710871097110711171127113711471157116711771187119712071217122712371247125712671277128712971307131713271337134713571367137713871397140714171427143714471457146714771487149715071517152715371547155715671577158715971607161716271637164716571667167716871697170717171727173717471757176717771787179718071817182718371847185718671877188718971907191719271937194719571967197719871997200720172027203720472057206720772087209721072117212721372147215721672177218721972207221722272237224722572267227722872297230723172327233723472357236723772387239724072417242724372447245724672477248724972507251725272537254725572567257725872597260726172627263726472657266726772687269727072717272727372747275727672777278727972807281728272837284728572867287728872897290729172927293729472957296729772987299730073017302730373047305730673077308730973107311731273137314731573167317731873197320732173227323732473257326732773287329733073317332733373347335733673377338733973407341734273437344734573467347734873497350735173527353735473557356735773587359736073617362736373647365736673677368736973707371737273737374737573767377737873797380738173827383738473857386738773887389739073917392739373947395739673977398739974007401740274037404740574067407740874097410741174127413741474157416741774187419742074217422742374247425742674277428742974307431743274337434743574367437743874397440744174427443744474457446744774487449745074517452745374547455745674577458745974607461746274637464746574667467746874697470747174727473747474757476747774787479748074817482748374847485748674877488748974907491749274937494749574967497749874997500750175027503750475057506750775087509751075117512751375147515751675177518751975207521752275237524752575267527752875297530753175327533753475357536753775387539754075417542754375447545754675477548754975507551755275537554755575567557755875597560756175627563756475657566756775687569757075717572757375747575757675777578757975807581758275837584758575867587758875897590759175927593759475957596759775987599760076017602760376047605760676077608760976107611761276137614761576167617761876197620762176227623762476257626762776287629763076317632763376347635763676377638763976407641764276437644764576467647764876497650765176527653765476557656765776587659766076617662766376647665766676677668766976707671767276737674767576767677767876797680768176827683768476857686768776887689769076917692769376947695769676977698769977007701770277037704770577067707770877097710771177127713771477157716771777187719772077217722772377247725772677277728772977307731773277337734773577367737773877397740774177427743774477457746774777487749775077517752775377547755775677577758775977607761776277637764776577667767776877697770777177727773777477757776777777787779778077817782778377847785778677877788778977907791779277937794779577967797779877997800780178027803780478057806780778087809781078117812781378147815781678177818781978207821782278237824782578267827782878297830783178327833783478357836783778387839784078417842784378447845784678477848784978507851785278537854785578567857785878597860786178627863786478657866786778687869787078717872787378747875787678777878787978807881788278837884788578867887788878897890789178927893789478957896789778987899790079017902790379047905790679077908790979107911791279137914791579167917791879197920792179227923792479257926792779287929793079317932793379347935793679377938793979407941794279437944794579467947794879497950795179527953795479557956795779587959796079617962796379647965796679677968796979707971797279737974797579767977797879797980798179827983798479857986798779887989799079917992799379947995799679977998799980008001800280038004800580068007800880098010801180128013801480158016801780188019802080218022802380248025802680278028802980308031803280338034803580368037803880398040804180428043804480458046804780488049805080518052805380548055805680578058805980608061806280638064806580668067806880698070807180728073807480758076807780788079808080818082808380848085808680878088808980908091809280938094809580968097809880998100810181028103810481058106810781088109811081118112811381148115811681178118811981208121812281238124812581268127812881298130813181328133813481358136813781388139814081418142814381448145814681478148814981508151815281538154815581568157815881598160816181628163816481658166816781688169817081718172817381748175817681778178817981808181818281838184818581868187818881898190819181928193819481958196819781988199820082018202820382048205820682078208820982108211821282138214821582168217821882198220822182228223822482258226822782288229823082318232823382348235823682378238823982408241824282438244824582468247824882498250825182528253825482558256825782588259826082618262826382648265826682678268826982708271827282738274827582768277827882798280828182828283828482858286828782888289829082918292829382948295829682978298829983008301830283038304830583068307830883098310831183128313831483158316831783188319832083218322832383248325832683278328832983308331833283338334833583368337833883398340834183428343834483458346834783488349835083518352835383548355835683578358835983608361836283638364836583668367836883698370837183728373837483758376837783788379838083818382838383848385838683878388838983908391839283938394839583968397839883998400840184028403840484058406840784088409841084118412841384148415841684178418841984208421842284238424842584268427842884298430843184328433843484358436843784388439844084418442844384448445844684478448844984508451845284538454845584568457845884598460846184628463846484658466846784688469847084718472847384748475847684778478847984808481848284838484848584868487848884898490849184928493849484958496849784988499850085018502850385048505850685078508850985108511851285138514851585168517851885198520852185228523852485258526852785288529853085318532853385348535853685378538853985408541854285438544854585468547854885498550855185528553855485558556855785588559856085618562856385648565856685678568856985708571857285738574857585768577857885798580858185828583858485858586858785888589859085918592859385948595859685978598859986008601860286038604860586068607860886098610861186128613861486158616861786188619862086218622862386248625862686278628862986308631863286338634863586368637863886398640864186428643864486458646864786488649865086518652865386548655865686578658865986608661866286638664866586668667866886698670867186728673867486758676867786788679868086818682868386848685868686878688868986908691869286938694869586968697869886998700870187028703870487058706870787088709871087118712871387148715871687178718871987208721872287238724872587268727872887298730873187328733873487358736873787388739874087418742874387448745874687478748874987508751875287538754875587568757875887598760876187628763876487658766876787688769877087718772877387748775877687778778877987808781878287838784878587868787878887898790879187928793879487958796879787988799880088018802880388048805880688078808880988108811881288138814881588168817881888198820882188228823882488258826882788288829883088318832883388348835883688378838883988408841884288438844884588468847884888498850885188528853885488558856885788588859886088618862886388648865886688678868886988708871887288738874887588768877887888798880888188828883888488858886888788888889889088918892889388948895889688978898889989008901890289038904890589068907890889098910891189128913891489158916891789188919892089218922892389248925892689278928892989308931893289338934893589368937893889398940894189428943894489458946894789488949895089518952895389548955895689578958895989608961896289638964896589668967896889698970897189728973897489758976897789788979898089818982898389848985898689878988898989908991899289938994899589968997899889999000900190029003900490059006900790089009901090119012901390149015901690179018901990209021902290239024902590269027902890299030903190329033903490359036903790389039904090419042904390449045904690479048904990509051905290539054905590569057905890599060906190629063906490659066906790689069907090719072907390749075907690779078907990809081908290839084908590869087908890899090909190929093909490959096909790989099910091019102910391049105910691079108910991109111911291139114911591169117911891199120912191229123912491259126912791289129913091319132913391349135913691379138913991409141914291439144914591469147914891499150915191529153915491559156915791589159916091619162916391649165916691679168916991709171917291739174917591769177917891799180918191829183918491859186918791889189919091919192919391949195919691979198919992009201920292039204920592069207920892099210921192129213921492159216921792189219922092219222922392249225922692279228922992309231923292339234923592369237923892399240924192429243924492459246924792489249925092519252925392549255925692579258925992609261926292639264926592669267926892699270927192729273927492759276927792789279928092819282928392849285928692879288928992909291929292939294929592969297929892999300930193029303930493059306930793089309931093119312931393149315931693179318931993209321932293239324932593269327932893299330933193329333933493359336933793389339934093419342934393449345934693479348934993509351935293539354935593569357935893599360936193629363936493659366936793689369937093719372937393749375937693779378937993809381938293839384938593869387938893899390939193929393939493959396939793989399940094019402940394049405940694079408940994109411941294139414941594169417941894199420942194229423942494259426942794289429943094319432943394349435943694379438943994409441944294439444944594469447944894499450945194529453945494559456945794589459946094619462946394649465946694679468946994709471947294739474947594769477947894799480948194829483948494859486948794889489949094919492949394949495949694979498949995009501950295039504950595069507950895099510951195129513951495159516951795189519952095219522952395249525952695279528952995309531953295339534953595369537953895399540954195429543954495459546954795489549955095519552955395549555955695579558955995609561956295639564956595669567956895699570957195729573957495759576957795789579958095819582958395849585958695879588958995909591959295939594959595969597959895999600960196029603960496059606960796089609961096119612961396149615961696179618961996209621962296239624962596269627962896299630963196329633963496359636963796389639964096419642964396449645964696479648964996509651965296539654965596569657965896599660966196629663966496659666966796689669967096719672967396749675967696779678967996809681968296839684968596869687968896899690969196929693969496959696969796989699970097019702970397049705970697079708970997109711971297139714971597169717971897199720972197229723972497259726972797289729973097319732973397349735973697379738973997409741974297439744974597469747974897499750975197529753975497559756975797589759976097619762976397649765976697679768976997709771977297739774977597769777977897799780978197829783978497859786978797889789979097919792979397949795979697979798979998009801980298039804980598069807980898099810981198129813981498159816981798189819982098219822982398249825982698279828982998309831983298339834983598369837983898399840984198429843984498459846984798489849985098519852985398549855985698579858985998609861986298639864986598669867986898699870987198729873987498759876987798789879988098819882988398849885988698879888988998909891989298939894989598969897989898999900990199029903990499059906990799089909991099119912991399149915991699179918991999209921992299239924992599269927992899299930993199329933993499359936993799389939994099419942994399449945994699479948994999509951995299539954995599569957995899599960996199629963996499659966996799689969997099719972997399749975997699779978997999809981998299839984998599869987998899899990999199929993999499959996999799989999100001000110002100031000410005100061000710008100091001010011100121001310014100151001610017100181001910020100211002210023100241002510026100271002810029100301003110032100331003410035100361003710038100391004010041100421004310044100451004610047100481004910050100511005210053100541005510056100571005810059100601006110062100631006410065100661006710068100691007010071100721007310074100751007610077100781007910080100811008210083100841008510086100871008810089100901009110092100931009410095100961009710098100991010010101101021010310104101051010610107101081010910110101111011210113101141011510116101171011810119101201012110122101231012410125101261012710128101291013010131101321013310134101351013610137101381013910140101411014210143101441014510146101471014810149101501015110152101531015410155101561015710158101591016010161101621016310164101651016610167101681016910170101711017210173101741017510176101771017810179101801018110182101831018410185101861018710188101891019010191101921019310194101951019610197101981019910200102011020210203102041020510206102071020810209102101021110212102131021410215102161021710218102191022010221102221022310224102251022610227102281022910230102311023210233102341023510236102371023810239102401024110242102431024410245102461024710248102491025010251102521025310254102551025610257102581025910260102611026210263102641026510266102671026810269102701027110272102731027410275102761027710278102791028010281102821028310284102851028610287102881028910290102911029210293102941029510296102971029810299103001030110302103031030410305103061030710308103091031010311103121031310314103151031610317103181031910320103211032210323103241032510326103271032810329103301033110332103331033410335103361033710338103391034010341103421034310344103451034610347103481034910350103511035210353103541035510356103571035810359103601036110362103631036410365103661036710368103691037010371103721037310374103751037610377103781037910380103811038210383103841038510386103871038810389103901039110392103931039410395103961039710398103991040010401104021040310404104051040610407104081040910410104111041210413104141041510416104171041810419104201042110422104231042410425104261042710428104291043010431104321043310434104351043610437104381043910440104411044210443104441044510446104471044810449104501045110452104531045410455104561045710458104591046010461104621046310464104651046610467104681046910470104711047210473104741047510476104771047810479104801048110482104831048410485104861048710488104891049010491104921049310494104951049610497104981049910500105011050210503105041050510506105071050810509105101051110512105131051410515105161051710518105191052010521105221052310524105251052610527105281052910530105311053210533105341053510536105371053810539105401054110542105431054410545105461054710548105491055010551105521055310554105551055610557105581055910560105611056210563105641056510566105671056810569105701057110572105731057410575105761057710578105791058010581105821058310584105851058610587105881058910590105911059210593105941059510596105971059810599106001060110602106031060410605106061060710608106091061010611106121061310614106151061610617106181061910620106211062210623106241062510626106271062810629106301063110632106331063410635106361063710638106391064010641106421064310644106451064610647106481064910650106511065210653106541065510656106571065810659106601066110662106631066410665106661066710668106691067010671106721067310674106751067610677106781067910680106811068210683106841068510686106871068810689106901069110692106931069410695106961069710698106991070010701107021070310704107051070610707107081070910710107111071210713107141071510716107171071810719107201072110722107231072410725107261072710728107291073010731107321073310734107351073610737107381073910740107411074210743107441074510746107471074810749107501075110752107531075410755107561075710758107591076010761107621076310764107651076610767107681076910770107711077210773107741077510776107771077810779107801078110782107831078410785107861078710788107891079010791107921079310794107951079610797107981079910800108011080210803108041080510806108071080810809108101081110812108131081410815108161081710818108191082010821108221082310824108251082610827108281082910830108311083210833108341083510836108371083810839108401084110842108431084410845108461084710848108491085010851108521085310854108551085610857108581085910860108611086210863108641086510866108671086810869108701087110872108731087410875108761087710878108791088010881108821088310884108851088610887108881088910890108911089210893108941089510896108971089810899109001090110902109031090410905109061090710908109091091010911109121091310914109151091610917109181091910920109211092210923109241092510926109271092810929109301093110932109331093410935109361093710938109391094010941109421094310944109451094610947109481094910950109511095210953109541095510956109571095810959109601096110962109631096410965109661096710968109691097010971109721097310974109751097610977109781097910980109811098210983109841098510986109871098810989109901099110992109931099410995109961099710998109991100011001110021100311004110051100611007110081100911010110111101211013110141101511016110171101811019110201102111022110231102411025110261102711028110291103011031110321103311034110351103611037110381103911040110411104211043110441104511046110471104811049110501105111052110531105411055110561105711058110591106011061110621106311064110651106611067110681106911070110711107211073110741107511076110771107811079110801108111082110831108411085110861108711088110891109011091110921109311094110951109611097110981109911100111011110211103111041110511106111071110811109111101111111112111131111411115111161111711118111191112011121111221112311124111251112611127111281112911130111311113211133111341113511136111371113811139111401114111142111431114411145111461114711148111491115011151111521115311154111551115611157111581115911160111611116211163111641116511166111671116811169111701117111172111731117411175111761117711178111791118011181111821118311184111851118611187111881118911190111911119211193111941119511196111971119811199112001120111202112031120411205112061120711208112091121011211112121121311214112151121611217112181121911220112211122211223112241122511226112271122811229112301123111232112331123411235112361123711238112391124011241112421124311244112451124611247112481124911250112511125211253112541125511256112571125811259112601126111262112631126411265112661126711268112691127011271112721127311274112751127611277112781127911280112811128211283112841128511286112871128811289112901129111292112931129411295112961129711298112991130011301113021130311304113051130611307113081130911310113111131211313113141131511316113171131811319113201132111322113231132411325113261132711328113291133011331113321133311334113351133611337113381133911340113411134211343113441134511346113471134811349113501135111352113531135411355113561135711358113591136011361113621136311364113651136611367113681136911370113711137211373113741137511376113771137811379113801138111382113831138411385113861138711388113891139011391113921139311394113951139611397113981139911400114011140211403114041140511406114071140811409114101141111412114131141411415114161141711418114191142011421114221142311424114251142611427114281142911430114311143211433114341143511436114371143811439114401144111442114431144411445114461144711448114491145011451114521145311454114551145611457114581145911460114611146211463114641146511466114671146811469114701147111472114731147411475114761147711478114791148011481114821148311484114851148611487114881148911490114911149211493114941149511496114971149811499115001150111502115031150411505115061150711508115091151011511115121151311514115151151611517115181151911520115211152211523115241152511526115271152811529115301153111532115331153411535115361153711538115391154011541115421154311544115451154611547115481154911550115511155211553115541155511556115571155811559115601156111562115631156411565115661156711568115691157011571115721157311574115751157611577115781157911580115811158211583115841158511586115871158811589115901159111592115931159411595115961159711598115991160011601116021160311604116051160611607116081160911610116111161211613116141161511616116171161811619116201162111622116231162411625116261162711628116291163011631116321163311634116351163611637116381163911640116411164211643116441164511646116471164811649116501165111652116531165411655116561165711658116591166011661116621166311664116651166611667116681166911670116711167211673116741167511676116771167811679116801168111682116831168411685116861168711688116891169011691116921169311694116951169611697116981169911700117011170211703117041170511706117071170811709117101171111712117131171411715117161171711718117191172011721117221172311724117251172611727117281172911730117311173211733117341173511736117371173811739117401174111742117431174411745117461174711748117491175011751117521175311754117551175611757117581175911760117611176211763117641176511766117671176811769117701177111772117731177411775117761177711778117791178011781117821178311784117851178611787117881178911790117911179211793117941179511796117971179811799118001180111802118031180411805118061180711808118091181011811118121181311814118151181611817118181181911820118211182211823118241182511826118271182811829118301183111832118331183411835118361183711838118391184011841118421184311844118451184611847118481184911850118511185211853118541185511856118571185811859118601186111862118631186411865118661186711868118691187011871118721187311874118751187611877118781187911880118811188211883118841188511886118871188811889118901189111892118931189411895118961189711898118991190011901119021190311904119051190611907119081190911910119111191211913119141191511916119171191811919119201192111922119231192411925119261192711928119291193011931119321193311934119351193611937119381193911940119411194211943119441194511946119471194811949119501195111952119531195411955119561195711958119591196011961119621196311964119651196611967119681196911970119711197211973119741197511976119771197811979119801198111982119831198411985119861198711988119891199011991119921199311994119951199611997119981199912000120011200212003120041200512006120071200812009120101201112012120131201412015120161201712018120191202012021120221202312024120251202612027120281202912030120311203212033120341203512036120371203812039120401204112042120431204412045120461204712048120491205012051120521205312054120551205612057120581205912060120611206212063120641206512066120671206812069120701207112072120731207412075120761207712078120791208012081120821208312084120851208612087120881208912090120911209212093120941209512096120971209812099121001210112102121031210412105121061210712108121091211012111121121211312114121151211612117121181211912120121211212212123121241212512126121271212812129121301213112132121331213412135121361213712138121391214012141121421214312144121451214612147121481214912150121511215212153121541215512156121571215812159121601216112162121631216412165121661216712168121691217012171121721217312174121751217612177121781217912180121811218212183121841218512186121871218812189121901219112192121931219412195121961219712198121991220012201122021220312204122051220612207122081220912210122111221212213122141221512216122171221812219122201222112222122231222412225122261222712228122291223012231122321223312234122351223612237122381223912240122411224212243122441224512246122471224812249122501225112252122531225412255122561225712258122591226012261122621226312264122651226612267122681226912270122711227212273122741227512276122771227812279122801228112282122831228412285122861228712288122891229012291122921229312294122951229612297122981229912300123011230212303123041230512306123071230812309123101231112312123131231412315123161231712318123191232012321123221232312324123251232612327123281232912330123311233212333123341233512336123371233812339123401234112342123431234412345123461234712348123491235012351123521235312354123551235612357123581235912360123611236212363123641236512366123671236812369123701237112372123731237412375123761237712378123791238012381123821238312384123851238612387123881238912390123911239212393123941239512396123971239812399124001240112402124031240412405124061240712408124091241012411124121241312414124151241612417124181241912420124211242212423124241242512426124271242812429124301243112432124331243412435124361243712438124391244012441124421244312444124451244612447124481244912450124511245212453124541245512456124571245812459124601246112462124631246412465124661246712468124691247012471124721247312474124751247612477124781247912480124811248212483124841248512486124871248812489124901249112492124931249412495124961249712498124991250012501125021250312504125051250612507125081250912510125111251212513125141251512516125171251812519125201252112522125231252412525125261252712528125291253012531125321253312534125351253612537125381253912540125411254212543125441254512546125471254812549125501255112552125531255412555125561255712558125591256012561125621256312564125651256612567125681256912570125711257212573125741257512576125771257812579125801258112582125831258412585125861258712588125891259012591125921259312594125951259612597125981259912600126011260212603126041260512606126071260812609126101261112612126131261412615126161261712618126191262012621126221262312624126251262612627126281262912630126311263212633126341263512636126371263812639126401264112642126431264412645126461264712648126491265012651126521265312654126551265612657126581265912660126611266212663126641266512666126671266812669126701267112672126731267412675126761267712678126791268012681126821268312684126851268612687126881268912690126911269212693126941269512696126971269812699127001270112702127031270412705127061270712708127091271012711127121271312714127151271612717127181271912720127211272212723127241272512726127271272812729127301273112732127331273412735127361273712738127391274012741127421274312744127451274612747127481274912750127511275212753127541275512756127571275812759127601276112762127631276412765127661276712768127691277012771127721277312774127751277612777127781277912780127811278212783127841278512786127871278812789127901279112792127931279412795127961279712798127991280012801128021280312804128051280612807128081280912810128111281212813128141281512816128171281812819128201282112822128231282412825128261282712828128291283012831128321283312834128351283612837128381283912840128411284212843128441284512846128471284812849128501285112852128531285412855128561285712858128591286012861128621286312864128651286612867128681286912870128711287212873128741287512876128771287812879128801288112882128831288412885128861288712888128891289012891128921289312894128951289612897128981289912900129011290212903129041290512906129071290812909129101291112912129131291412915129161291712918129191292012921129221292312924129251292612927129281292912930129311293212933129341293512936129371293812939129401294112942129431294412945129461294712948129491295012951129521295312954129551295612957129581295912960129611296212963129641296512966129671296812969129701297112972129731297412975129761297712978129791298012981129821298312984129851298612987129881298912990129911299212993129941299512996129971299812999130001300113002130031300413005130061300713008130091301013011130121301313014130151301613017130181301913020130211302213023130241302513026130271302813029130301303113032130331303413035130361303713038130391304013041130421304313044130451304613047130481304913050130511305213053130541305513056130571305813059130601306113062130631306413065130661306713068130691307013071130721307313074130751307613077130781307913080130811308213083130841308513086130871308813089130901309113092130931309413095130961309713098130991310013101131021310313104131051310613107131081310913110131111311213113131141311513116131171311813119131201312113122131231312413125131261312713128131291313013131131321313313134131351313613137131381313913140131411314213143131441314513146131471314813149131501315113152131531315413155131561315713158131591316013161131621316313164131651316613167131681316913170131711317213173131741317513176131771317813179131801318113182131831318413185131861318713188131891319013191131921319313194131951319613197131981319913200132011320213203132041320513206132071320813209132101321113212132131321413215132161321713218132191322013221132221322313224132251322613227132281322913230132311323213233132341323513236132371323813239132401324113242132431324413245132461324713248132491325013251132521325313254132551325613257132581325913260132611326213263132641326513266132671326813269132701327113272132731327413275132761327713278132791328013281132821328313284132851328613287132881328913290132911329213293132941329513296132971329813299133001330113302133031330413305133061330713308133091331013311133121331313314133151331613317133181331913320133211332213323133241332513326133271332813329133301333113332133331333413335133361333713338133391334013341133421334313344133451334613347133481334913350133511335213353133541335513356133571335813359133601336113362133631336413365133661336713368133691337013371133721337313374133751337613377133781337913380133811338213383133841338513386133871338813389133901339113392133931339413395133961339713398133991340013401134021340313404134051340613407134081340913410134111341213413134141341513416134171341813419134201342113422134231342413425134261342713428134291343013431134321343313434134351343613437134381343913440134411344213443134441344513446134471344813449134501345113452134531345413455134561345713458134591346013461134621346313464134651346613467134681346913470134711347213473134741347513476134771347813479134801348113482134831348413485134861348713488134891349013491134921349313494134951349613497134981349913500135011350213503135041350513506135071350813509135101351113512135131351413515135161351713518135191352013521135221352313524135251352613527135281352913530135311353213533135341353513536135371353813539135401354113542135431354413545135461354713548135491355013551135521355313554135551355613557135581355913560135611356213563135641356513566135671356813569135701357113572135731357413575135761357713578135791358013581135821358313584135851358613587135881358913590135911359213593135941359513596135971359813599136001360113602136031360413605136061360713608136091361013611136121361313614136151361613617136181361913620136211362213623136241362513626136271362813629136301363113632136331363413635136361363713638136391364013641136421364313644136451364613647136481364913650136511365213653136541365513656136571365813659136601366113662136631366413665136661366713668136691367013671136721367313674136751367613677136781367913680136811368213683136841368513686136871368813689136901369113692136931369413695136961369713698136991370013701137021370313704137051370613707137081370913710137111371213713137141371513716137171371813719137201372113722137231372413725137261372713728137291373013731137321373313734137351373613737137381373913740137411374213743137441374513746137471374813749137501375113752137531375413755137561375713758137591376013761137621376313764137651376613767137681376913770137711377213773137741377513776137771377813779137801378113782137831378413785137861378713788137891379013791137921379313794137951379613797137981379913800138011380213803138041380513806138071380813809138101381113812138131381413815138161381713818138191382013821138221382313824138251382613827138281382913830138311383213833138341383513836138371383813839138401384113842138431384413845138461384713848138491385013851138521385313854138551385613857138581385913860138611386213863138641386513866138671386813869138701387113872138731387413875138761387713878138791388013881138821388313884138851388613887138881388913890138911389213893138941389513896138971389813899139001390113902139031390413905139061390713908139091391013911139121391313914139151391613917139181391913920139211392213923139241392513926139271392813929139301393113932139331393413935139361393713938139391394013941139421394313944139451394613947139481394913950139511395213953139541395513956139571395813959139601396113962139631396413965139661396713968139691397013971139721397313974139751397613977139781397913980139811398213983139841398513986139871398813989139901399113992139931399413995139961399713998139991400014001140021400314004140051400614007140081400914010140111401214013140141401514016140171401814019140201402114022140231402414025140261402714028140291403014031140321403314034140351403614037140381403914040140411404214043140441404514046140471404814049140501405114052140531405414055140561405714058140591406014061140621406314064140651406614067140681406914070140711407214073140741407514076140771407814079140801408114082140831408414085140861408714088140891409014091140921409314094140951409614097140981409914100141011410214103141041410514106141071410814109141101411114112141131411414115141161411714118141191412014121141221412314124141251412614127141281412914130141311413214133141341413514136141371413814139141401414114142141431414414145141461414714148141491415014151141521415314154141551415614157141581415914160141611416214163141641416514166141671416814169141701417114172141731417414175141761417714178141791418014181141821418314184141851418614187141881418914190141911419214193141941419514196141971419814199142001420114202142031420414205142061420714208142091421014211142121421314214142151421614217142181421914220142211422214223142241422514226142271422814229142301423114232142331423414235142361423714238142391424014241142421424314244142451424614247142481424914250142511425214253142541425514256142571425814259142601426114262142631426414265142661426714268142691427014271142721427314274142751427614277142781427914280142811428214283142841428514286142871428814289142901429114292142931429414295142961429714298142991430014301143021430314304143051430614307143081430914310143111431214313143141431514316143171431814319143201432114322143231432414325143261432714328143291433014331143321433314334143351433614337143381433914340143411434214343143441434514346143471434814349143501435114352143531435414355143561435714358143591436014361143621436314364143651436614367143681436914370143711437214373143741437514376143771437814379143801438114382143831438414385143861438714388143891439014391143921439314394143951439614397143981439914400144011440214403144041440514406144071440814409144101441114412144131441414415144161441714418144191442014421144221442314424144251442614427144281442914430144311443214433144341443514436144371443814439144401444114442144431444414445144461444714448144491445014451144521445314454144551445614457144581445914460144611446214463144641446514466144671446814469144701447114472144731447414475144761447714478144791448014481144821448314484144851448614487144881448914490144911449214493144941449514496144971449814499145001450114502145031450414505145061450714508145091451014511145121451314514145151451614517145181451914520145211452214523145241452514526145271452814529145301453114532145331453414535145361453714538145391454014541145421454314544145451454614547145481454914550145511455214553145541455514556145571455814559145601456114562145631456414565145661456714568145691457014571145721457314574145751457614577145781457914580145811458214583145841458514586145871458814589145901459114592145931459414595145961459714598145991460014601146021460314604146051460614607146081460914610146111461214613146141461514616146171461814619146201462114622146231462414625146261462714628146291463014631146321463314634146351463614637146381463914640146411464214643146441464514646146471464814649146501465114652146531465414655146561465714658146591466014661146621466314664146651466614667146681466914670146711467214673146741467514676146771467814679146801468114682146831468414685146861468714688146891469014691146921469314694146951469614697146981469914700147011470214703147041470514706147071470814709147101471114712147131471414715147161471714718147191472014721147221472314724147251472614727147281472914730147311473214733147341473514736147371473814739147401474114742147431474414745147461474714748147491475014751147521475314754147551475614757147581475914760147611476214763147641476514766147671476814769147701477114772147731477414775147761477714778147791478014781147821478314784147851478614787147881478914790147911479214793147941479514796147971479814799148001480114802148031480414805148061480714808148091481014811148121481314814148151481614817148181481914820148211482214823148241482514826148271482814829148301483114832148331483414835148361483714838148391484014841148421484314844148451484614847148481484914850148511485214853148541485514856148571485814859148601486114862148631486414865148661486714868148691487014871148721487314874148751487614877148781487914880148811488214883148841488514886148871488814889148901489114892148931489414895148961489714898148991490014901149021490314904149051490614907149081490914910149111491214913149141491514916149171491814919149201492114922149231492414925149261492714928149291493014931149321493314934149351493614937149381493914940149411494214943149441494514946149471494814949149501495114952149531495414955149561495714958149591496014961149621496314964149651496614967149681496914970149711497214973149741497514976149771497814979149801498114982149831498414985149861498714988149891499014991149921499314994149951499614997149981499915000150011500215003150041500515006150071500815009150101501115012150131501415015150161501715018150191502015021150221502315024150251502615027150281502915030150311503215033150341503515036150371503815039150401504115042150431504415045150461504715048150491505015051150521505315054150551505615057150581505915060150611506215063150641506515066150671506815069150701507115072150731507415075150761507715078150791508015081150821508315084150851508615087150881508915090150911509215093150941509515096150971509815099151001510115102151031510415105151061510715108151091511015111151121511315114151151511615117151181511915120151211512215123151241512515126151271512815129151301513115132151331513415135151361513715138151391514015141151421514315144151451514615147151481514915150151511515215153151541515515156151571515815159151601516115162151631516415165151661516715168151691517015171151721517315174151751517615177151781517915180151811518215183151841518515186151871518815189151901519115192151931519415195151961519715198151991520015201152021520315204152051520615207152081520915210152111521215213152141521515216152171521815219152201522115222152231522415225152261522715228152291523015231152321523315234152351523615237152381523915240152411524215243152441524515246152471524815249152501525115252152531525415255152561525715258152591526015261152621526315264152651526615267152681526915270152711527215273152741527515276152771527815279152801528115282152831528415285152861528715288152891529015291152921529315294152951529615297152981529915300153011530215303153041530515306153071530815309153101531115312153131531415315153161531715318153191532015321153221532315324153251532615327153281532915330153311533215333153341533515336153371533815339153401534115342153431534415345153461534715348153491535015351153521535315354153551535615357153581535915360153611536215363153641536515366153671536815369153701537115372153731537415375153761537715378153791538015381153821538315384153851538615387153881538915390153911539215393153941539515396153971539815399154001540115402154031540415405154061540715408154091541015411154121541315414154151541615417154181541915420154211542215423154241542515426154271542815429154301543115432154331543415435154361543715438154391544015441154421544315444154451544615447154481544915450154511545215453154541545515456154571545815459154601546115462154631546415465154661546715468154691547015471154721547315474154751547615477154781547915480154811548215483154841548515486154871548815489154901549115492154931549415495154961549715498154991550015501155021550315504155051550615507155081550915510155111551215513155141551515516155171551815519155201552115522155231552415525155261552715528155291553015531155321553315534155351553615537155381553915540155411554215543155441554515546155471554815549155501555115552155531555415555155561555715558155591556015561155621556315564155651556615567155681556915570155711557215573155741557515576155771557815579155801558115582155831558415585155861558715588155891559015591155921559315594155951559615597155981559915600156011560215603156041560515606156071560815609156101561115612156131561415615156161561715618156191562015621156221562315624156251562615627156281562915630156311563215633156341563515636156371563815639156401564115642156431564415645156461564715648156491565015651156521565315654156551565615657156581565915660156611566215663156641566515666156671566815669156701567115672156731567415675156761567715678156791568015681156821568315684156851568615687156881568915690156911569215693156941569515696156971569815699157001570115702157031570415705157061570715708157091571015711157121571315714157151571615717157181571915720157211572215723157241572515726157271572815729157301573115732157331573415735157361573715738157391574015741157421574315744157451574615747157481574915750157511575215753157541575515756157571575815759157601576115762157631576415765157661576715768157691577015771157721577315774157751577615777157781577915780157811578215783157841578515786157871578815789157901579115792157931579415795157961579715798157991580015801158021580315804158051580615807158081580915810158111581215813158141581515816158171581815819158201582115822158231582415825158261582715828158291583015831158321583315834158351583615837158381583915840158411584215843158441584515846158471584815849158501585115852158531585415855158561585715858158591586015861158621586315864158651586615867158681586915870158711587215873158741587515876158771587815879158801588115882158831588415885158861588715888158891589015891158921589315894158951589615897158981589915900159011590215903159041590515906159071590815909159101591115912159131591415915159161591715918159191592015921159221592315924159251592615927159281592915930159311593215933159341593515936159371593815939159401594115942159431594415945159461594715948159491595015951159521595315954159551595615957159581595915960159611596215963159641596515966159671596815969159701597115972159731597415975159761597715978159791598015981159821598315984159851598615987159881598915990159911599215993159941599515996159971599815999160001600116002160031600416005160061600716008160091601016011160121601316014160151601616017160181601916020160211602216023160241602516026160271602816029160301603116032160331603416035160361603716038160391604016041160421604316044160451604616047160481604916050160511605216053160541605516056160571605816059160601606116062160631606416065160661606716068160691607016071160721607316074160751607616077160781607916080160811608216083160841608516086160871608816089160901609116092160931609416095160961609716098160991610016101161021610316104161051610616107161081610916110161111611216113161141611516116161171611816119161201612116122161231612416125161261612716128161291613016131161321613316134161351613616137161381613916140161411614216143161441614516146161471614816149161501615116152161531615416155161561615716158161591616016161161621616316164161651616616167161681616916170161711617216173161741617516176161771617816179161801618116182161831618416185161861618716188161891619016191161921619316194161951619616197161981619916200162011620216203162041620516206162071620816209162101621116212162131621416215162161621716218162191622016221162221622316224162251622616227162281622916230162311623216233162341623516236162371623816239162401624116242162431624416245162461624716248162491625016251162521625316254162551625616257162581625916260162611626216263162641626516266162671626816269162701627116272162731627416275162761627716278162791628016281162821628316284162851628616287162881628916290162911629216293162941629516296162971629816299163001630116302163031630416305163061630716308163091631016311163121631316314163151631616317163181631916320163211632216323163241632516326163271632816329163301633116332163331633416335163361633716338163391634016341163421634316344163451634616347163481634916350163511635216353163541635516356163571635816359163601636116362163631636416365163661636716368163691637016371163721637316374163751637616377163781637916380163811638216383163841638516386163871638816389163901639116392163931639416395163961639716398163991640016401164021640316404164051640616407164081640916410164111641216413164141641516416164171641816419164201642116422164231642416425164261642716428164291643016431164321643316434164351643616437164381643916440164411644216443164441644516446164471644816449164501645116452164531645416455164561645716458164591646016461164621646316464164651646616467164681646916470164711647216473164741647516476164771647816479164801648116482164831648416485164861648716488164891649016491164921649316494164951649616497164981649916500165011650216503165041650516506165071650816509165101651116512165131651416515165161651716518165191652016521165221652316524165251652616527165281652916530165311653216533165341653516536165371653816539165401654116542165431654416545165461654716548165491655016551165521655316554165551655616557165581655916560165611656216563165641656516566165671656816569165701657116572165731657416575165761657716578165791658016581165821658316584165851658616587165881658916590165911659216593165941659516596165971659816599166001660116602166031660416605166061660716608166091661016611166121661316614166151661616617166181661916620166211662216623166241662516626166271662816629166301663116632166331663416635166361663716638166391664016641166421664316644166451664616647166481664916650166511665216653166541665516656166571665816659166601666116662166631666416665166661666716668166691667016671166721667316674166751667616677166781667916680166811668216683166841668516686166871668816689166901669116692166931669416695166961669716698166991670016701167021670316704167051670616707167081670916710167111671216713167141671516716167171671816719167201672116722167231672416725167261672716728167291673016731167321673316734167351673616737167381673916740167411674216743167441674516746167471674816749167501675116752167531675416755167561675716758167591676016761167621676316764167651676616767167681676916770167711677216773167741677516776167771677816779167801678116782167831678416785167861678716788167891679016791167921679316794167951679616797167981679916800168011680216803168041680516806168071680816809168101681116812168131681416815168161681716818168191682016821168221682316824168251682616827168281682916830168311683216833168341683516836168371683816839168401684116842168431684416845168461684716848168491685016851168521685316854168551685616857168581685916860168611686216863168641686516866168671686816869168701687116872168731687416875168761687716878168791688016881168821688316884168851688616887168881688916890168911689216893168941689516896168971689816899169001690116902169031690416905169061690716908169091691016911169121691316914169151691616917169181691916920169211692216923169241692516926169271692816929169301693116932169331693416935169361693716938169391694016941169421694316944169451694616947169481694916950169511695216953169541695516956169571695816959169601696116962169631696416965169661696716968169691697016971169721697316974169751697616977169781697916980169811698216983169841698516986169871698816989169901699116992169931699416995169961699716998169991700017001170021700317004170051700617007170081700917010170111701217013170141701517016170171701817019170201702117022170231702417025170261702717028170291703017031170321703317034170351703617037170381703917040170411704217043170441704517046170471704817049170501705117052170531705417055170561705717058170591706017061170621706317064170651706617067170681706917070170711707217073170741707517076170771707817079170801708117082170831708417085170861708717088170891709017091170921709317094170951709617097170981709917100171011710217103171041710517106171071710817109171101711117112171131711417115171161711717118171191712017121171221712317124171251712617127171281712917130171311713217133171341713517136171371713817139171401714117142171431714417145171461714717148171491715017151171521715317154171551715617157171581715917160171611716217163171641716517166171671716817169171701717117172171731717417175171761717717178171791718017181171821718317184171851718617187171881718917190171911719217193171941719517196171971719817199172001720117202172031720417205172061720717208172091721017211172121721317214172151721617217172181721917220172211722217223172241722517226172271722817229172301723117232172331723417235172361723717238172391724017241172421724317244172451724617247172481724917250172511725217253172541725517256172571725817259172601726117262172631726417265172661726717268172691727017271172721727317274172751727617277172781727917280172811728217283172841728517286172871728817289172901729117292172931729417295172961729717298172991730017301173021730317304173051730617307173081730917310173111731217313173141731517316173171731817319173201732117322173231732417325173261732717328173291733017331173321733317334173351733617337173381733917340173411734217343173441734517346173471734817349173501735117352173531735417355173561735717358173591736017361173621736317364173651736617367173681736917370173711737217373173741737517376173771737817379173801738117382173831738417385173861738717388173891739017391173921739317394173951739617397173981739917400174011740217403174041740517406174071740817409174101741117412174131741417415174161741717418174191742017421174221742317424174251742617427174281742917430174311743217433174341743517436174371743817439174401744117442174431744417445174461744717448174491745017451174521745317454174551745617457174581745917460174611746217463174641746517466174671746817469174701747117472174731747417475174761747717478174791748017481174821748317484174851748617487174881748917490174911749217493174941749517496174971749817499175001750117502175031750417505175061750717508175091751017511175121751317514175151751617517175181751917520175211752217523175241752517526175271752817529175301753117532175331753417535175361753717538175391754017541175421754317544175451754617547175481754917550175511755217553175541755517556175571755817559175601756117562175631756417565175661756717568175691757017571175721757317574175751757617577175781757917580175811758217583175841758517586175871758817589175901759117592175931759417595175961759717598175991760017601176021760317604176051760617607176081760917610176111761217613176141761517616176171761817619176201762117622176231762417625176261762717628176291763017631176321763317634176351763617637176381763917640176411764217643176441764517646176471764817649176501765117652176531765417655176561765717658176591766017661176621766317664176651766617667176681766917670176711767217673176741767517676176771767817679176801768117682176831768417685176861768717688176891769017691176921769317694176951769617697176981769917700177011770217703177041770517706177071770817709177101771117712177131771417715177161771717718177191772017721177221772317724177251772617727177281772917730177311773217733177341773517736177371773817739177401774117742177431774417745177461774717748177491775017751177521775317754177551775617757177581775917760177611776217763177641776517766177671776817769177701777117772177731777417775177761777717778177791778017781177821778317784177851778617787177881778917790177911779217793177941779517796177971779817799178001780117802178031780417805178061780717808178091781017811178121781317814178151781617817178181781917820178211782217823178241782517826178271782817829178301783117832178331783417835178361783717838178391784017841178421784317844178451784617847178481784917850178511785217853178541785517856178571785817859178601786117862178631786417865178661786717868178691787017871178721787317874178751787617877178781787917880178811788217883178841788517886178871788817889178901789117892178931789417895178961789717898178991790017901179021790317904179051790617907179081790917910179111791217913179141791517916179171791817919179201792117922179231792417925179261792717928179291793017931179321793317934179351793617937179381793917940179411794217943179441794517946179471794817949179501795117952179531795417955179561795717958179591796017961179621796317964179651796617967179681796917970179711797217973179741797517976179771797817979179801798117982179831798417985179861798717988179891799017991179921799317994179951799617997179981799918000180011800218003180041800518006180071800818009180101801118012180131801418015180161801718018180191802018021180221802318024180251802618027180281802918030180311803218033180341803518036180371803818039180401804118042180431804418045180461804718048180491805018051180521805318054180551805618057180581805918060180611806218063180641806518066180671806818069180701807118072180731807418075180761807718078180791808018081180821808318084180851808618087180881808918090180911809218093180941809518096180971809818099181001810118102181031810418105181061810718108181091811018111181121811318114181151811618117181181811918120181211812218123181241812518126181271812818129181301813118132181331813418135181361813718138181391814018141181421814318144181451814618147181481814918150181511815218153181541815518156181571815818159181601816118162181631816418165181661816718168181691817018171181721817318174181751817618177181781817918180181811818218183181841818518186181871818818189181901819118192181931819418195181961819718198181991820018201182021820318204182051820618207182081820918210182111821218213182141821518216182171821818219182201822118222182231822418225182261822718228182291823018231182321823318234182351823618237182381823918240182411824218243182441824518246182471824818249182501825118252182531825418255182561825718258182591826018261182621826318264182651826618267182681826918270182711827218273182741827518276182771827818279182801828118282182831828418285182861828718288182891829018291182921829318294182951829618297182981829918300183011830218303183041830518306183071830818309183101831118312183131831418315183161831718318183191832018321183221832318324183251832618327183281832918330183311833218333183341833518336183371833818339183401834118342183431834418345183461834718348183491835018351183521835318354183551835618357183581835918360183611836218363183641836518366183671836818369183701837118372183731837418375183761837718378183791838018381183821838318384183851838618387183881838918390183911839218393183941839518396183971839818399184001840118402184031840418405184061840718408184091841018411184121841318414184151841618417184181841918420184211842218423184241842518426184271842818429184301843118432184331843418435184361843718438184391844018441184421844318444184451844618447184481844918450184511845218453184541845518456184571845818459184601846118462184631846418465184661846718468184691847018471184721847318474184751847618477184781847918480184811848218483184841848518486184871848818489184901849118492184931849418495184961849718498184991850018501185021850318504185051850618507185081850918510185111851218513185141851518516185171851818519185201852118522185231852418525185261852718528185291853018531185321853318534185351853618537185381853918540185411854218543185441854518546185471854818549185501855118552185531855418555185561855718558185591856018561185621856318564185651856618567185681856918570185711857218573185741857518576185771857818579185801858118582185831858418585185861858718588185891859018591185921859318594185951859618597185981859918600186011860218603186041860518606186071860818609186101861118612186131861418615186161861718618186191862018621186221862318624186251862618627186281862918630186311863218633186341863518636186371863818639186401864118642186431864418645186461864718648186491865018651186521865318654186551865618657186581865918660186611866218663186641866518666186671866818669186701867118672186731867418675186761867718678186791868018681186821868318684186851868618687186881868918690186911869218693186941869518696186971869818699187001870118702187031870418705187061870718708187091871018711187121871318714187151871618717187181871918720187211872218723187241872518726187271872818729187301873118732187331873418735187361873718738187391874018741187421874318744187451874618747187481874918750187511875218753187541875518756187571875818759187601876118762187631876418765187661876718768187691877018771187721877318774187751877618777187781877918780187811878218783187841878518786187871878818789187901879118792187931879418795187961879718798187991880018801188021880318804188051880618807188081880918810188111881218813188141881518816188171881818819188201882118822188231882418825188261882718828188291883018831188321883318834188351883618837188381883918840188411884218843188441884518846188471884818849188501885118852188531885418855188561885718858188591886018861188621886318864188651886618867188681886918870188711887218873188741887518876188771887818879188801888118882188831888418885188861888718888188891889018891188921889318894188951889618897188981889918900189011890218903189041890518906189071890818909189101891118912189131891418915189161891718918189191892018921189221892318924189251892618927189281892918930189311893218933189341893518936189371893818939189401894118942189431894418945189461894718948189491895018951189521895318954189551895618957189581895918960189611896218963189641896518966189671896818969189701897118972189731897418975189761897718978189791898018981189821898318984189851898618987189881898918990189911899218993189941899518996189971899818999190001900119002190031900419005190061900719008190091901019011190121901319014190151901619017190181901919020190211902219023190241902519026190271902819029190301903119032190331903419035190361903719038190391904019041190421904319044190451904619047190481904919050190511905219053190541905519056190571905819059190601906119062190631906419065190661906719068190691907019071190721907319074190751907619077190781907919080190811908219083190841908519086190871908819089190901909119092190931909419095190961909719098190991910019101191021910319104191051910619107191081910919110191111911219113191141911519116191171911819119191201912119122191231912419125191261912719128191291913019131191321913319134191351913619137191381913919140191411914219143191441914519146191471914819149191501915119152191531915419155191561915719158191591916019161191621916319164191651916619167191681916919170191711917219173191741917519176191771917819179191801918119182191831918419185191861918719188191891919019191191921919319194191951919619197191981919919200192011920219203192041920519206192071920819209192101921119212192131921419215192161921719218192191922019221192221922319224192251922619227192281922919230192311923219233192341923519236192371923819239192401924119242192431924419245192461924719248192491925019251192521925319254192551925619257192581925919260192611926219263192641926519266192671926819269192701927119272192731927419275192761927719278192791928019281192821928319284192851928619287192881928919290192911929219293192941929519296192971929819299193001930119302193031930419305193061930719308193091931019311193121931319314193151931619317193181931919320193211932219323193241932519326193271932819329193301933119332193331933419335193361933719338193391934019341193421934319344193451934619347193481934919350193511935219353193541935519356193571935819359193601936119362193631936419365193661936719368193691937019371193721937319374193751937619377193781937919380193811938219383193841938519386193871938819389193901939119392193931939419395193961939719398193991940019401194021940319404194051940619407194081940919410194111941219413194141941519416194171941819419194201942119422194231942419425194261942719428194291943019431194321943319434194351943619437194381943919440194411944219443194441944519446194471944819449194501945119452194531945419455194561945719458194591946019461194621946319464194651946619467194681946919470194711947219473194741947519476194771947819479194801948119482194831948419485194861948719488194891949019491194921949319494194951949619497194981949919500195011950219503195041950519506195071950819509195101951119512195131951419515195161951719518195191952019521195221952319524195251952619527195281952919530195311953219533195341953519536195371953819539195401954119542195431954419545195461954719548195491955019551195521955319554195551955619557195581955919560195611956219563195641956519566195671956819569195701957119572195731957419575195761957719578195791958019581195821958319584195851958619587195881958919590195911959219593195941959519596195971959819599196001960119602196031960419605196061960719608196091961019611196121961319614196151961619617196181961919620196211962219623196241962519626196271962819629196301963119632196331963419635196361963719638196391964019641196421964319644196451964619647196481964919650196511965219653196541965519656196571965819659196601966119662196631966419665196661966719668196691967019671196721967319674196751967619677196781967919680196811968219683196841968519686196871968819689196901969119692196931969419695196961969719698196991970019701197021970319704197051970619707197081970919710197111971219713197141971519716197171971819719197201972119722197231972419725197261972719728197291973019731197321973319734197351973619737197381973919740197411974219743197441974519746197471974819749197501975119752197531975419755197561975719758197591976019761197621976319764197651976619767197681976919770197711977219773197741977519776197771977819779197801978119782197831978419785197861978719788197891979019791197921979319794197951979619797197981979919800198011980219803198041980519806198071980819809198101981119812198131981419815198161981719818198191982019821198221982319824198251982619827198281982919830198311983219833198341983519836198371983819839198401984119842198431984419845198461984719848198491985019851198521985319854198551985619857198581985919860198611986219863198641986519866198671986819869198701987119872198731987419875198761987719878198791988019881198821988319884198851988619887198881988919890198911989219893198941989519896198971989819899199001990119902199031990419905199061990719908199091991019911199121991319914199151991619917199181991919920199211992219923199241992519926199271992819929199301993119932199331993419935199361993719938199391994019941199421994319944199451994619947199481994919950199511995219953199541995519956199571995819959199601996119962199631996419965199661996719968199691997019971199721997319974199751997619977199781997919980199811998219983199841998519986199871998819989199901999119992199931999419995199961999719998199992000020001200022000320004200052000620007200082000920010200112001220013200142001520016200172001820019200202002120022200232002420025200262002720028200292003020031200322003320034200352003620037200382003920040200412004220043200442004520046200472004820049200502005120052200532005420055200562005720058200592006020061200622006320064200652006620067200682006920070200712007220073200742007520076200772007820079200802008120082200832008420085200862008720088200892009020091200922009320094200952009620097200982009920100201012010220103201042010520106201072010820109201102011120112201132011420115201162011720118201192012020121201222012320124201252012620127201282012920130201312013220133201342013520136201372013820139201402014120142201432014420145201462014720148201492015020151201522015320154201552015620157201582015920160201612016220163201642016520166201672016820169201702017120172201732017420175201762017720178201792018020181201822018320184201852018620187201882018920190201912019220193201942019520196201972019820199202002020120202202032020420205202062020720208202092021020211202122021320214202152021620217202182021920220202212022220223202242022520226202272022820229202302023120232202332023420235202362023720238202392024020241202422024320244202452024620247202482024920250202512025220253202542025520256202572025820259202602026120262202632026420265202662026720268202692027020271202722027320274202752027620277202782027920280202812028220283202842028520286202872028820289202902029120292202932029420295202962029720298202992030020301203022030320304203052030620307203082030920310203112031220313203142031520316203172031820319203202032120322203232032420325203262032720328203292033020331203322033320334203352033620337203382033920340203412034220343203442034520346203472034820349203502035120352203532035420355203562035720358203592036020361203622036320364203652036620367203682036920370203712037220373203742037520376203772037820379203802038120382203832038420385203862038720388203892039020391203922039320394203952039620397203982039920400204012040220403204042040520406204072040820409204102041120412204132041420415204162041720418204192042020421204222042320424204252042620427204282042920430204312043220433204342043520436204372043820439204402044120442204432044420445204462044720448204492045020451204522045320454204552045620457204582045920460204612046220463204642046520466204672046820469204702047120472204732047420475204762047720478204792048020481204822048320484204852048620487204882048920490204912049220493204942049520496204972049820499205002050120502205032050420505205062050720508205092051020511205122051320514205152051620517205182051920520205212052220523205242052520526205272052820529205302053120532205332053420535205362053720538205392054020541205422054320544205452054620547205482054920550205512055220553205542055520556205572055820559205602056120562205632056420565205662056720568205692057020571205722057320574205752057620577205782057920580205812058220583205842058520586205872058820589205902059120592205932059420595205962059720598205992060020601206022060320604206052060620607206082060920610206112061220613206142061520616206172061820619206202062120622206232062420625206262062720628206292063020631206322063320634206352063620637206382063920640206412064220643206442064520646206472064820649206502065120652206532065420655206562065720658206592066020661206622066320664206652066620667206682066920670206712067220673206742067520676206772067820679206802068120682206832068420685206862068720688206892069020691206922069320694206952069620697206982069920700207012070220703207042070520706207072070820709207102071120712207132071420715207162071720718207192072020721207222072320724207252072620727207282072920730207312073220733207342073520736207372073820739207402074120742207432074420745207462074720748207492075020751207522075320754207552075620757207582075920760207612076220763207642076520766207672076820769207702077120772207732077420775207762077720778207792078020781207822078320784207852078620787207882078920790207912079220793207942079520796207972079820799208002080120802208032080420805208062080720808208092081020811208122081320814208152081620817208182081920820208212082220823208242082520826208272082820829208302083120832208332083420835208362083720838208392084020841208422084320844208452084620847208482084920850208512085220853208542085520856208572085820859208602086120862208632086420865208662086720868208692087020871208722087320874208752087620877208782087920880208812088220883208842088520886208872088820889208902089120892208932089420895208962089720898208992090020901209022090320904209052090620907209082090920910209112091220913209142091520916209172091820919209202092120922209232092420925209262092720928209292093020931209322093320934209352093620937209382093920940209412094220943209442094520946209472094820949209502095120952209532095420955209562095720958209592096020961209622096320964209652096620967209682096920970209712097220973209742097520976209772097820979209802098120982209832098420985209862098720988209892099020991209922099320994209952099620997209982099921000210012100221003210042100521006210072100821009210102101121012210132101421015210162101721018210192102021021210222102321024210252102621027210282102921030210312103221033210342103521036210372103821039210402104121042210432104421045210462104721048210492105021051210522105321054210552105621057210582105921060210612106221063210642106521066210672106821069210702107121072210732107421075210762107721078210792108021081210822108321084210852108621087210882108921090210912109221093210942109521096210972109821099211002110121102211032110421105211062110721108211092111021111211122111321114211152111621117211182111921120211212112221123211242112521126211272112821129211302113121132211332113421135211362113721138211392114021141211422114321144211452114621147211482114921150211512115221153211542115521156211572115821159211602116121162211632116421165211662116721168211692117021171211722117321174211752117621177211782117921180211812118221183211842118521186211872118821189211902119121192211932119421195211962119721198211992120021201212022120321204212052120621207212082120921210212112121221213212142121521216212172121821219212202122121222212232122421225212262122721228212292123021231212322123321234212352123621237212382123921240212412124221243212442124521246212472124821249212502125121252212532125421255212562125721258212592126021261212622126321264212652126621267212682126921270212712127221273212742127521276212772127821279212802128121282212832128421285212862128721288212892129021291212922129321294212952129621297212982129921300213012130221303213042130521306213072130821309213102131121312213132131421315213162131721318213192132021321213222132321324213252132621327213282132921330213312133221333213342133521336213372133821339213402134121342213432134421345213462134721348213492135021351213522135321354213552135621357213582135921360213612136221363213642136521366213672136821369213702137121372213732137421375213762137721378213792138021381213822138321384213852138621387213882138921390213912139221393213942139521396213972139821399214002140121402214032140421405214062140721408214092141021411214122141321414214152141621417214182141921420214212142221423214242142521426214272142821429214302143121432214332143421435214362143721438214392144021441214422144321444214452144621447214482144921450214512145221453214542145521456214572145821459214602146121462214632146421465214662146721468214692147021471214722147321474214752147621477214782147921480214812148221483214842148521486214872148821489214902149121492214932149421495214962149721498214992150021501215022150321504215052150621507215082150921510215112151221513215142151521516215172151821519215202152121522215232152421525215262152721528215292153021531215322153321534215352153621537215382153921540215412154221543215442154521546215472154821549215502155121552215532155421555215562155721558215592156021561215622156321564215652156621567215682156921570215712157221573215742157521576215772157821579215802158121582215832158421585215862158721588215892159021591215922159321594215952159621597215982159921600216012160221603216042160521606216072160821609216102161121612216132161421615216162161721618216192162021621216222162321624216252162621627216282162921630216312163221633216342163521636216372163821639216402164121642216432164421645216462164721648216492165021651216522165321654216552165621657216582165921660216612166221663216642166521666216672166821669216702167121672216732167421675216762167721678216792168021681216822168321684216852168621687216882168921690216912169221693216942169521696216972169821699217002170121702217032170421705217062170721708217092171021711217122171321714217152171621717217182171921720217212172221723217242172521726217272172821729217302173121732217332173421735217362173721738217392174021741217422174321744217452174621747217482174921750217512175221753217542175521756217572175821759217602176121762217632176421765217662176721768217692177021771217722177321774217752177621777217782177921780217812178221783217842178521786217872178821789217902179121792217932179421795217962179721798217992180021801218022180321804218052180621807218082180921810218112181221813218142181521816218172181821819218202182121822218232182421825218262182721828218292183021831218322183321834218352183621837218382183921840218412184221843218442184521846218472184821849218502185121852218532185421855218562185721858218592186021861218622186321864218652186621867218682186921870218712187221873218742187521876218772187821879218802188121882218832188421885218862188721888218892189021891218922189321894218952189621897218982189921900219012190221903219042190521906219072190821909219102191121912219132191421915219162191721918219192192021921219222192321924219252192621927219282192921930219312193221933219342193521936219372193821939219402194121942219432194421945219462194721948219492195021951219522195321954219552195621957219582195921960219612196221963219642196521966219672196821969219702197121972219732197421975219762197721978219792198021981219822198321984219852198621987219882198921990219912199221993219942199521996219972199821999220002200122002220032200422005220062200722008220092201022011220122201322014220152201622017220182201922020220212202222023220242202522026220272202822029220302203122032220332203422035220362203722038220392204022041220422204322044220452204622047220482204922050220512205222053220542205522056220572205822059220602206122062220632206422065220662206722068220692207022071220722207322074220752207622077220782207922080220812208222083220842208522086220872208822089220902209122092220932209422095220962209722098220992210022101221022210322104221052210622107221082210922110221112211222113221142211522116221172211822119221202212122122221232212422125221262212722128221292213022131221322213322134221352213622137221382213922140221412214222143221442214522146221472214822149221502215122152221532215422155221562215722158221592216022161221622216322164221652216622167221682216922170221712217222173221742217522176221772217822179221802218122182221832218422185221862218722188221892219022191221922219322194221952219622197221982219922200222012220222203222042220522206222072220822209222102221122212222132221422215222162221722218222192222022221222222222322224222252222622227222282222922230222312223222233222342223522236222372223822239222402224122242222432224422245222462224722248222492225022251222522225322254222552225622257222582225922260222612226222263222642226522266222672226822269222702227122272222732227422275222762227722278222792228022281222822228322284222852228622287222882228922290222912229222293222942229522296222972229822299223002230122302223032230422305223062230722308223092231022311223122231322314223152231622317223182231922320223212232222323223242232522326223272232822329223302233122332223332233422335223362233722338223392234022341223422234322344223452234622347223482234922350223512235222353223542235522356223572235822359223602236122362223632236422365223662236722368223692237022371223722237322374223752237622377223782237922380223812238222383223842238522386223872238822389223902239122392223932239422395223962239722398223992240022401224022240322404224052240622407224082240922410224112241222413224142241522416224172241822419224202242122422224232242422425224262242722428224292243022431224322243322434224352243622437224382243922440224412244222443224442244522446224472244822449224502245122452224532245422455224562245722458224592246022461224622246322464224652246622467224682246922470224712247222473224742247522476224772247822479224802248122482224832248422485224862248722488224892249022491224922249322494224952249622497224982249922500225012250222503225042250522506225072250822509225102251122512225132251422515225162251722518225192252022521225222252322524225252252622527225282252922530225312253222533225342253522536225372253822539225402254122542225432254422545225462254722548225492255022551225522255322554225552255622557225582255922560225612256222563225642256522566225672256822569225702257122572225732257422575225762257722578225792258022581225822258322584225852258622587225882258922590225912259222593225942259522596225972259822599226002260122602226032260422605226062260722608226092261022611226122261322614226152261622617226182261922620226212262222623226242262522626226272262822629226302263122632226332263422635226362263722638226392264022641226422264322644226452264622647226482264922650226512265222653226542265522656226572265822659226602266122662226632266422665226662266722668226692267022671226722267322674226752267622677226782267922680226812268222683226842268522686226872268822689226902269122692226932269422695226962269722698226992270022701227022270322704227052270622707227082270922710227112271222713227142271522716227172271822719227202272122722227232272422725227262272722728227292273022731227322273322734227352273622737227382273922740227412274222743227442274522746227472274822749227502275122752227532275422755227562275722758227592276022761227622276322764227652276622767227682276922770227712277222773227742277522776227772277822779227802278122782227832278422785227862278722788227892279022791227922279322794227952279622797227982279922800228012280222803228042280522806228072280822809228102281122812228132281422815228162281722818228192282022821228222282322824228252282622827228282282922830228312283222833228342283522836228372283822839228402284122842228432284422845228462284722848228492285022851228522285322854228552285622857228582285922860228612286222863228642286522866228672286822869228702287122872228732287422875228762287722878228792288022881228822288322884228852288622887228882288922890228912289222893228942289522896228972289822899229002290122902229032290422905229062290722908229092291022911229122291322914229152291622917229182291922920229212292222923229242292522926229272292822929229302293122932229332293422935229362293722938229392294022941229422294322944229452294622947229482294922950229512295222953229542295522956229572295822959229602296122962229632296422965229662296722968229692297022971229722297322974229752297622977229782297922980229812298222983229842298522986229872298822989229902299122992229932299422995229962299722998229992300023001230022300323004230052300623007230082300923010230112301223013230142301523016230172301823019230202302123022230232302423025230262302723028230292303023031230322303323034230352303623037230382303923040230412304223043230442304523046230472304823049230502305123052230532305423055230562305723058230592306023061230622306323064230652306623067230682306923070230712307223073230742307523076230772307823079230802308123082230832308423085230862308723088230892309023091230922309323094230952309623097230982309923100231012310223103231042310523106231072310823109231102311123112231132311423115231162311723118231192312023121231222312323124231252312623127231282312923130231312313223133231342313523136231372313823139231402314123142231432314423145231462314723148231492315023151231522315323154231552315623157231582315923160231612316223163231642316523166231672316823169231702317123172231732317423175231762317723178231792318023181231822318323184231852318623187231882318923190231912319223193231942319523196231972319823199232002320123202232032320423205232062320723208232092321023211232122321323214232152321623217232182321923220232212322223223232242322523226232272322823229232302323123232232332323423235232362323723238232392324023241232422324323244232452324623247232482324923250232512325223253232542325523256232572325823259232602326123262232632326423265232662326723268232692327023271232722327323274232752327623277232782327923280232812328223283232842328523286232872328823289232902329123292232932329423295232962329723298232992330023301233022330323304233052330623307233082330923310233112331223313233142331523316233172331823319233202332123322233232332423325233262332723328233292333023331233322333323334233352333623337233382333923340233412334223343233442334523346233472334823349233502335123352233532335423355233562335723358233592336023361233622336323364233652336623367233682336923370233712337223373233742337523376233772337823379233802338123382233832338423385233862338723388233892339023391233922339323394233952339623397233982339923400234012340223403234042340523406234072340823409234102341123412234132341423415234162341723418234192342023421234222342323424234252342623427234282342923430234312343223433234342343523436234372343823439234402344123442234432344423445234462344723448234492345023451234522345323454234552345623457234582345923460234612346223463234642346523466234672346823469234702347123472234732347423475234762347723478234792348023481234822348323484234852348623487234882348923490234912349223493234942349523496234972349823499235002350123502235032350423505235062350723508235092351023511235122351323514235152351623517235182351923520235212352223523235242352523526235272352823529235302353123532235332353423535235362353723538235392354023541235422354323544235452354623547235482354923550235512355223553235542355523556235572355823559235602356123562235632356423565235662356723568235692357023571235722357323574235752357623577235782357923580235812358223583235842358523586235872358823589235902359123592235932359423595235962359723598235992360023601236022360323604236052360623607236082360923610236112361223613236142361523616236172361823619236202362123622236232362423625236262362723628236292363023631236322363323634236352363623637236382363923640236412364223643236442364523646236472364823649236502365123652236532365423655236562365723658236592366023661236622366323664236652366623667236682366923670236712367223673236742367523676236772367823679236802368123682236832368423685236862368723688236892369023691236922369323694236952369623697236982369923700237012370223703237042370523706237072370823709237102371123712237132371423715237162371723718237192372023721237222372323724237252372623727237282372923730237312373223733237342373523736237372373823739237402374123742237432374423745237462374723748237492375023751237522375323754237552375623757237582375923760237612376223763237642376523766237672376823769237702377123772237732377423775237762377723778237792378023781237822378323784237852378623787237882378923790237912379223793237942379523796237972379823799238002380123802238032380423805238062380723808238092381023811238122381323814238152381623817238182381923820238212382223823238242382523826238272382823829238302383123832238332383423835238362383723838238392384023841238422384323844238452384623847238482384923850238512385223853238542385523856238572385823859238602386123862238632386423865238662386723868238692387023871238722387323874238752387623877238782387923880238812388223883238842388523886238872388823889238902389123892238932389423895238962389723898238992390023901239022390323904239052390623907239082390923910239112391223913239142391523916239172391823919239202392123922239232392423925239262392723928239292393023931239322393323934239352393623937239382393923940239412394223943239442394523946239472394823949239502395123952239532395423955239562395723958239592396023961239622396323964239652396623967239682396923970239712397223973239742397523976239772397823979239802398123982239832398423985239862398723988239892399023991239922399323994239952399623997239982399924000240012400224003240042400524006240072400824009240102401124012240132401424015240162401724018240192402024021240222402324024240252402624027240282402924030240312403224033240342403524036240372403824039240402404124042240432404424045240462404724048240492405024051240522405324054240552405624057240582405924060240612406224063240642406524066240672406824069240702407124072240732407424075240762407724078240792408024081240822408324084240852408624087240882408924090240912409224093240942409524096240972409824099241002410124102241032410424105241062410724108241092411024111241122411324114241152411624117241182411924120241212412224123241242412524126241272412824129241302413124132241332413424135241362413724138241392414024141241422414324144241452414624147241482414924150241512415224153241542415524156241572415824159241602416124162241632416424165241662416724168241692417024171241722417324174241752417624177241782417924180241812418224183241842418524186241872418824189241902419124192241932419424195241962419724198241992420024201242022420324204242052420624207242082420924210242112421224213242142421524216242172421824219242202422124222242232422424225242262422724228242292423024231242322423324234242352423624237242382423924240242412424224243242442424524246242472424824249242502425124252242532425424255242562425724258242592426024261242622426324264242652426624267242682426924270242712427224273242742427524276242772427824279242802428124282242832428424285242862428724288242892429024291242922429324294242952429624297242982429924300243012430224303243042430524306243072430824309243102431124312243132431424315243162431724318243192432024321243222432324324243252432624327243282432924330243312433224333243342433524336243372433824339243402434124342243432434424345243462434724348243492435024351243522435324354243552435624357243582435924360243612436224363243642436524366243672436824369243702437124372243732437424375243762437724378243792438024381243822438324384243852438624387243882438924390243912439224393243942439524396243972439824399244002440124402244032440424405244062440724408244092441024411244122441324414244152441624417244182441924420244212442224423244242442524426244272442824429244302443124432244332443424435244362443724438244392444024441244422444324444244452444624447244482444924450244512445224453244542445524456244572445824459244602446124462244632446424465244662446724468244692447024471244722447324474244752447624477244782447924480244812448224483244842448524486244872448824489244902449124492244932449424495244962449724498244992450024501245022450324504245052450624507245082450924510245112451224513245142451524516245172451824519245202452124522245232452424525245262452724528245292453024531245322453324534245352453624537245382453924540245412454224543245442454524546245472454824549245502455124552245532455424555245562455724558245592456024561245622456324564245652456624567245682456924570245712457224573245742457524576245772457824579245802458124582245832458424585245862458724588245892459024591245922459324594245952459624597245982459924600246012460224603246042460524606246072460824609246102461124612246132461424615246162461724618246192462024621246222462324624246252462624627246282462924630246312463224633246342463524636246372463824639246402464124642246432464424645246462464724648246492465024651246522465324654246552465624657246582465924660246612466224663246642466524666246672466824669246702467124672246732467424675246762467724678246792468024681246822468324684246852468624687246882468924690246912469224693246942469524696246972469824699247002470124702247032470424705247062470724708247092471024711247122471324714247152471624717247182471924720247212472224723247242472524726247272472824729247302473124732247332473424735247362473724738247392474024741247422474324744247452474624747247482474924750247512475224753247542475524756247572475824759247602476124762247632476424765247662476724768247692477024771247722477324774247752477624777247782477924780247812478224783247842478524786247872478824789247902479124792247932479424795247962479724798247992480024801248022480324804248052480624807248082480924810248112481224813248142481524816248172481824819248202482124822248232482424825248262482724828248292483024831248322483324834248352483624837248382483924840248412484224843248442484524846248472484824849248502485124852248532485424855248562485724858248592486024861248622486324864248652486624867248682486924870248712487224873248742487524876248772487824879248802488124882248832488424885248862488724888248892489024891248922489324894248952489624897248982489924900249012490224903249042490524906249072490824909249102491124912249132491424915249162491724918249192492024921249222492324924249252492624927249282492924930249312493224933249342493524936249372493824939249402494124942249432494424945249462494724948249492495024951249522495324954249552495624957249582495924960249612496224963249642496524966249672496824969249702497124972249732497424975249762497724978249792498024981249822498324984249852498624987249882498924990249912499224993249942499524996249972499824999250002500125002250032500425005250062500725008250092501025011250122501325014250152501625017250182501925020250212502225023250242502525026250272502825029250302503125032250332503425035250362503725038250392504025041250422504325044250452504625047250482504925050250512505225053250542505525056250572505825059250602506125062250632506425065250662506725068250692507025071250722507325074250752507625077250782507925080250812508225083250842508525086250872508825089250902509125092250932509425095250962509725098250992510025101251022510325104251052510625107251082510925110251112511225113251142511525116251172511825119251202512125122251232512425125251262512725128251292513025131251322513325134251352513625137251382513925140251412514225143251442514525146251472514825149251502515125152251532515425155251562515725158251592516025161251622516325164251652516625167251682516925170251712517225173251742517525176251772517825179251802518125182251832518425185251862518725188251892519025191251922519325194251952519625197251982519925200252012520225203252042520525206252072520825209252102521125212252132521425215252162521725218252192522025221252222522325224252252522625227252282522925230252312523225233252342523525236252372523825239252402524125242252432524425245252462524725248252492525025251252522525325254252552525625257252582525925260252612526225263252642526525266252672526825269252702527125272252732527425275252762527725278252792528025281252822528325284252852528625287252882528925290252912529225293252942529525296252972529825299253002530125302253032530425305253062530725308253092531025311253122531325314253152531625317253182531925320253212532225323253242532525326253272532825329253302533125332253332533425335253362533725338253392534025341253422534325344253452534625347253482534925350253512535225353253542535525356253572535825359253602536125362253632536425365253662536725368253692537025371253722537325374253752537625377253782537925380253812538225383253842538525386253872538825389253902539125392253932539425395253962539725398253992540025401254022540325404254052540625407254082540925410254112541225413254142541525416254172541825419254202542125422254232542425425254262542725428254292543025431254322543325434254352543625437254382543925440254412544225443254442544525446254472544825449254502545125452254532545425455254562545725458254592546025461254622546325464254652546625467254682546925470254712547225473254742547525476254772547825479254802548125482254832548425485254862548725488254892549025491254922549325494254952549625497254982549925500255012550225503255042550525506255072550825509255102551125512255132551425515255162551725518255192552025521255222552325524255252552625527255282552925530255312553225533255342553525536255372553825539255402554125542255432554425545255462554725548255492555025551255522555325554255552555625557255582555925560255612556225563255642556525566255672556825569255702557125572255732557425575255762557725578255792558025581255822558325584255852558625587255882558925590255912559225593255942559525596255972559825599256002560125602256032560425605256062560725608256092561025611256122561325614256152561625617256182561925620256212562225623256242562525626256272562825629256302563125632256332563425635256362563725638256392564025641256422564325644256452564625647256482564925650256512565225653256542565525656256572565825659256602566125662256632566425665256662566725668256692567025671256722567325674256752567625677256782567925680256812568225683256842568525686256872568825689256902569125692256932569425695256962569725698256992570025701257022570325704257052570625707257082570925710257112571225713257142571525716257172571825719257202572125722257232572425725257262572725728257292573025731257322573325734257352573625737257382573925740257412574225743257442574525746257472574825749257502575125752257532575425755257562575725758257592576025761257622576325764257652576625767257682576925770257712577225773257742577525776257772577825779257802578125782257832578425785257862578725788257892579025791257922579325794257952579625797257982579925800258012580225803258042580525806258072580825809258102581125812258132581425815258162581725818258192582025821258222582325824258252582625827258282582925830258312583225833258342583525836258372583825839258402584125842258432584425845258462584725848258492585025851258522585325854258552585625857258582585925860258612586225863258642586525866258672586825869258702587125872258732587425875258762587725878258792588025881258822588325884258852588625887258882588925890258912589225893258942589525896258972589825899259002590125902259032590425905259062590725908259092591025911259122591325914259152591625917259182591925920259212592225923259242592525926259272592825929259302593125932259332593425935259362593725938259392594025941259422594325944259452594625947259482594925950259512595225953259542595525956259572595825959259602596125962259632596425965259662596725968259692597025971259722597325974259752597625977259782597925980259812598225983259842598525986259872598825989259902599125992259932599425995259962599725998259992600026001260022600326004260052600626007260082600926010260112601226013260142601526016260172601826019260202602126022260232602426025260262602726028260292603026031260322603326034260352603626037260382603926040260412604226043260442604526046260472604826049260502605126052260532605426055260562605726058260592606026061260622606326064260652606626067260682606926070260712607226073260742607526076260772607826079260802608126082260832608426085260862608726088260892609026091260922609326094260952609626097260982609926100261012610226103261042610526106261072610826109261102611126112261132611426115261162611726118261192612026121261222612326124261252612626127261282612926130261312613226133261342613526136261372613826139261402614126142261432614426145261462614726148261492615026151261522615326154261552615626157261582615926160261612616226163261642616526166261672616826169261702617126172261732617426175261762617726178261792618026181261822618326184261852618626187261882618926190261912619226193261942619526196261972619826199262002620126202262032620426205262062620726208262092621026211262122621326214262152621626217262182621926220262212622226223262242622526226262272622826229262302623126232262332623426235262362623726238262392624026241262422624326244262452624626247262482624926250262512625226253262542625526256262572625826259262602626126262262632626426265262662626726268262692627026271262722627326274262752627626277262782627926280262812628226283262842628526286262872628826289262902629126292262932629426295262962629726298262992630026301263022630326304263052630626307263082630926310263112631226313263142631526316263172631826319263202632126322263232632426325263262632726328263292633026331263322633326334263352633626337263382633926340263412634226343263442634526346263472634826349263502635126352263532635426355263562635726358263592636026361263622636326364263652636626367263682636926370263712637226373263742637526376263772637826379263802638126382263832638426385263862638726388263892639026391263922639326394263952639626397263982639926400264012640226403264042640526406264072640826409264102641126412264132641426415264162641726418264192642026421264222642326424264252642626427264282642926430264312643226433264342643526436264372643826439264402644126442264432644426445264462644726448264492645026451264522645326454264552645626457264582645926460264612646226463264642646526466264672646826469264702647126472264732647426475264762647726478264792648026481264822648326484264852648626487264882648926490264912649226493264942649526496264972649826499265002650126502265032650426505265062650726508265092651026511265122651326514265152651626517265182651926520265212652226523265242652526526265272652826529265302653126532265332653426535265362653726538265392654026541265422654326544265452654626547265482654926550265512655226553265542655526556265572655826559265602656126562265632656426565265662656726568265692657026571265722657326574265752657626577265782657926580265812658226583265842658526586265872658826589265902659126592265932659426595265962659726598265992660026601266022660326604266052660626607266082660926610266112661226613266142661526616266172661826619266202662126622266232662426625266262662726628266292663026631266322663326634266352663626637266382663926640266412664226643266442664526646266472664826649266502665126652266532665426655266562665726658266592666026661266622666326664266652666626667266682666926670266712667226673266742667526676266772667826679266802668126682266832668426685266862668726688266892669026691266922669326694266952669626697266982669926700267012670226703267042670526706267072670826709267102671126712267132671426715267162671726718267192672026721267222672326724267252672626727267282672926730267312673226733267342673526736267372673826739267402674126742267432674426745267462674726748267492675026751267522675326754267552675626757267582675926760267612676226763267642676526766267672676826769267702677126772267732677426775267762677726778267792678026781267822678326784267852678626787267882678926790267912679226793267942679526796267972679826799268002680126802268032680426805268062680726808268092681026811268122681326814268152681626817268182681926820268212682226823268242682526826268272682826829268302683126832268332683426835268362683726838268392684026841268422684326844268452684626847268482684926850268512685226853268542685526856268572685826859268602686126862268632686426865268662686726868268692687026871268722687326874268752687626877268782687926880268812688226883268842688526886268872688826889268902689126892268932689426895268962689726898268992690026901269022690326904269052690626907269082690926910269112691226913269142691526916269172691826919269202692126922269232692426925269262692726928269292693026931269322693326934269352693626937269382693926940269412694226943269442694526946269472694826949269502695126952269532695426955269562695726958269592696026961269622696326964269652696626967269682696926970269712697226973269742697526976269772697826979269802698126982269832698426985269862698726988269892699026991269922699326994269952699626997269982699927000270012700227003270042700527006270072700827009270102701127012270132701427015270162701727018270192702027021270222702327024270252702627027270282702927030270312703227033270342703527036270372703827039270402704127042270432704427045270462704727048270492705027051270522705327054270552705627057270582705927060270612706227063270642706527066270672706827069270702707127072270732707427075270762707727078270792708027081270822708327084270852708627087270882708927090270912709227093270942709527096270972709827099271002710127102271032710427105271062710727108271092711027111271122711327114271152711627117271182711927120271212712227123271242712527126271272712827129271302713127132271332713427135271362713727138271392714027141271422714327144271452714627147271482714927150271512715227153271542715527156271572715827159271602716127162271632716427165271662716727168271692717027171271722717327174271752717627177271782717927180271812718227183271842718527186271872718827189271902719127192271932719427195271962719727198271992720027201272022720327204272052720627207272082720927210272112721227213272142721527216272172721827219272202722127222272232722427225272262722727228272292723027231272322723327234272352723627237272382723927240272412724227243272442724527246272472724827249272502725127252272532725427255272562725727258272592726027261272622726327264272652726627267272682726927270272712727227273272742727527276272772727827279272802728127282272832728427285272862728727288272892729027291272922729327294272952729627297272982729927300273012730227303273042730527306273072730827309273102731127312273132731427315273162731727318273192732027321273222732327324273252732627327273282732927330273312733227333273342733527336273372733827339273402734127342273432734427345273462734727348273492735027351273522735327354273552735627357273582735927360273612736227363273642736527366273672736827369273702737127372273732737427375273762737727378273792738027381273822738327384273852738627387273882738927390273912739227393273942739527396273972739827399274002740127402274032740427405274062740727408274092741027411274122741327414274152741627417274182741927420274212742227423274242742527426274272742827429274302743127432274332743427435274362743727438274392744027441274422744327444274452744627447274482744927450274512745227453274542745527456274572745827459274602746127462274632746427465274662746727468274692747027471274722747327474274752747627477274782747927480274812748227483274842748527486274872748827489274902749127492274932749427495274962749727498274992750027501275022750327504275052750627507275082750927510275112751227513275142751527516275172751827519275202752127522275232752427525275262752727528275292753027531275322753327534275352753627537275382753927540275412754227543275442754527546275472754827549275502755127552275532755427555275562755727558275592756027561275622756327564275652756627567275682756927570275712757227573275742757527576275772757827579275802758127582275832758427585275862758727588275892759027591275922759327594275952759627597275982759927600276012760227603276042760527606276072760827609276102761127612276132761427615276162761727618276192762027621276222762327624276252762627627276282762927630276312763227633276342763527636276372763827639276402764127642276432764427645276462764727648276492765027651276522765327654276552765627657276582765927660276612766227663276642766527666276672766827669276702767127672276732767427675276762767727678276792768027681276822768327684276852768627687276882768927690276912769227693276942769527696276972769827699277002770127702277032770427705277062770727708277092771027711277122771327714277152771627717277182771927720277212772227723277242772527726277272772827729277302773127732277332773427735277362773727738277392774027741277422774327744277452774627747277482774927750277512775227753277542775527756277572775827759277602776127762277632776427765277662776727768277692777027771277722777327774277752777627777277782777927780277812778227783277842778527786277872778827789277902779127792277932779427795277962779727798277992780027801278022780327804278052780627807278082780927810278112781227813278142781527816278172781827819278202782127822278232782427825278262782727828278292783027831278322783327834278352783627837278382783927840278412784227843278442784527846278472784827849278502785127852278532785427855278562785727858278592786027861278622786327864278652786627867278682786927870278712787227873278742787527876278772787827879278802788127882278832788427885278862788727888278892789027891278922789327894278952789627897278982789927900279012790227903279042790527906279072790827909279102791127912279132791427915279162791727918279192792027921279222792327924279252792627927279282792927930279312793227933279342793527936279372793827939279402794127942279432794427945279462794727948279492795027951279522795327954279552795627957279582795927960279612796227963279642796527966279672796827969279702797127972279732797427975279762797727978279792798027981279822798327984279852798627987279882798927990279912799227993279942799527996279972799827999280002800128002280032800428005280062800728008280092801028011280122801328014280152801628017280182801928020280212802228023280242802528026280272802828029280302803128032280332803428035280362803728038280392804028041280422804328044280452804628047280482804928050280512805228053280542805528056280572805828059280602806128062280632806428065280662806728068280692807028071280722807328074280752807628077280782807928080280812808228083280842808528086280872808828089280902809128092280932809428095280962809728098280992810028101281022810328104281052810628107281082810928110281112811228113281142811528116281172811828119281202812128122281232812428125281262812728128281292813028131281322813328134281352813628137281382813928140281412814228143281442814528146281472814828149281502815128152281532815428155281562815728158281592816028161281622816328164281652816628167281682816928170281712817228173281742817528176281772817828179281802818128182281832818428185281862818728188281892819028191281922819328194281952819628197281982819928200282012820228203282042820528206282072820828209282102821128212282132821428215282162821728218282192822028221282222822328224282252822628227282282822928230282312823228233282342823528236282372823828239282402824128242282432824428245282462824728248282492825028251282522825328254282552825628257282582825928260282612826228263282642826528266282672826828269282702827128272282732827428275282762827728278282792828028281282822828328284282852828628287282882828928290282912829228293282942829528296282972829828299283002830128302283032830428305283062830728308283092831028311283122831328314283152831628317283182831928320283212832228323283242832528326283272832828329283302833128332283332833428335283362833728338283392834028341283422834328344283452834628347283482834928350283512835228353283542835528356283572835828359283602836128362283632836428365283662836728368283692837028371283722837328374283752837628377283782837928380283812838228383283842838528386283872838828389283902839128392283932839428395283962839728398283992840028401284022840328404284052840628407284082840928410284112841228413284142841528416284172841828419284202842128422284232842428425284262842728428284292843028431284322843328434284352843628437284382843928440284412844228443284442844528446284472844828449284502845128452284532845428455284562845728458284592846028461284622846328464284652846628467284682846928470284712847228473284742847528476284772847828479284802848128482284832848428485284862848728488284892849028491284922849328494284952849628497284982849928500285012850228503285042850528506285072850828509285102851128512285132851428515285162851728518285192852028521285222852328524285252852628527285282852928530285312853228533285342853528536285372853828539285402854128542285432854428545285462854728548285492855028551285522855328554285552855628557285582855928560285612856228563285642856528566285672856828569285702857128572285732857428575285762857728578285792858028581285822858328584285852858628587285882858928590285912859228593285942859528596285972859828599286002860128602286032860428605286062860728608286092861028611286122861328614286152861628617286182861928620286212862228623286242862528626286272862828629286302863128632286332863428635286362863728638286392864028641286422864328644286452864628647286482864928650286512865228653286542865528656286572865828659286602866128662286632866428665286662866728668286692867028671286722867328674286752867628677286782867928680286812868228683286842868528686286872868828689286902869128692286932869428695286962869728698286992870028701287022870328704287052870628707287082870928710287112871228713287142871528716287172871828719287202872128722287232872428725287262872728728287292873028731287322873328734287352873628737287382873928740287412874228743287442874528746287472874828749287502875128752287532875428755287562875728758287592876028761287622876328764287652876628767287682876928770287712877228773287742877528776287772877828779287802878128782287832878428785287862878728788287892879028791287922879328794287952879628797287982879928800288012880228803288042880528806288072880828809288102881128812288132881428815288162881728818288192882028821288222882328824288252882628827288282882928830288312883228833288342883528836288372883828839288402884128842288432884428845288462884728848288492885028851288522885328854288552885628857288582885928860288612886228863288642886528866288672886828869288702887128872288732887428875288762887728878288792888028881288822888328884288852888628887288882888928890288912889228893288942889528896288972889828899289002890128902289032890428905289062890728908289092891028911289122891328914289152891628917289182891928920289212892228923289242892528926289272892828929289302893128932289332893428935289362893728938289392894028941289422894328944289452894628947289482894928950289512895228953289542895528956289572895828959289602896128962289632896428965289662896728968289692897028971289722897328974289752897628977289782897928980289812898228983289842898528986289872898828989289902899128992289932899428995289962899728998289992900029001290022900329004290052900629007290082900929010290112901229013290142901529016290172901829019290202902129022290232902429025290262902729028290292903029031290322903329034290352903629037290382903929040290412904229043290442904529046290472904829049290502905129052290532905429055290562905729058290592906029061290622906329064290652906629067290682906929070290712907229073290742907529076290772907829079290802908129082290832908429085290862908729088290892909029091290922909329094290952909629097290982909929100291012910229103291042910529106291072910829109291102911129112291132911429115291162911729118291192912029121291222912329124291252912629127291282912929130291312913229133291342913529136291372913829139291402914129142291432914429145291462914729148291492915029151291522915329154291552915629157291582915929160291612916229163291642916529166291672916829169291702917129172291732917429175291762917729178291792918029181291822918329184291852918629187291882918929190291912919229193291942919529196291972919829199292002920129202292032920429205292062920729208292092921029211292122921329214292152921629217292182921929220292212922229223292242922529226292272922829229292302923129232292332923429235292362923729238292392924029241292422924329244292452924629247292482924929250292512925229253292542925529256292572925829259292602926129262292632926429265292662926729268292692927029271292722927329274292752927629277292782927929280292812928229283292842928529286292872928829289292902929129292292932929429295292962929729298292992930029301293022930329304293052930629307293082930929310293112931229313293142931529316293172931829319293202932129322293232932429325293262932729328293292933029331293322933329334293352933629337293382933929340293412934229343293442934529346293472934829349293502935129352293532935429355293562935729358293592936029361293622936329364293652936629367293682936929370293712937229373293742937529376293772937829379293802938129382293832938429385293862938729388293892939029391293922939329394293952939629397293982939929400294012940229403294042940529406294072940829409294102941129412294132941429415294162941729418294192942029421294222942329424294252942629427294282942929430294312943229433294342943529436294372943829439294402944129442294432944429445294462944729448294492945029451294522945329454294552945629457294582945929460294612946229463294642946529466294672946829469294702947129472294732947429475294762947729478294792948029481294822948329484294852948629487294882948929490294912949229493294942949529496294972949829499295002950129502295032950429505295062950729508295092951029511295122951329514295152951629517295182951929520295212952229523295242952529526295272952829529295302953129532295332953429535295362953729538295392954029541295422954329544295452954629547295482954929550295512955229553295542955529556295572955829559295602956129562295632956429565295662956729568295692957029571295722957329574295752957629577295782957929580295812958229583295842958529586295872958829589295902959129592295932959429595295962959729598295992960029601296022960329604296052960629607296082960929610296112961229613296142961529616296172961829619296202962129622296232962429625296262962729628296292963029631296322963329634296352963629637296382963929640296412964229643296442964529646296472964829649296502965129652296532965429655296562965729658296592966029661296622966329664296652966629667296682966929670296712967229673296742967529676296772967829679296802968129682296832968429685296862968729688296892969029691296922969329694296952969629697296982969929700297012970229703297042970529706297072970829709297102971129712297132971429715297162971729718297192972029721297222972329724297252972629727297282972929730297312973229733297342973529736297372973829739297402974129742297432974429745297462974729748297492975029751297522975329754297552975629757297582975929760297612976229763297642976529766297672976829769297702977129772297732977429775297762977729778297792978029781297822978329784297852978629787297882978929790297912979229793297942979529796297972979829799298002980129802298032980429805298062980729808298092981029811298122981329814298152981629817298182981929820298212982229823298242982529826298272982829829298302983129832298332983429835298362983729838298392984029841298422984329844298452984629847298482984929850298512985229853298542985529856298572985829859298602986129862298632986429865298662986729868298692987029871298722987329874298752987629877298782987929880298812988229883298842988529886298872988829889298902989129892298932989429895298962989729898298992990029901299022990329904299052990629907299082990929910
  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 definitions are linked from httplib.cc.
  66. ca_store_t create_ca_store(const char *pem, size_t len);
  67. bool set_verify_callback(ctx_t ctx, VerifyCallback callback);
  68. } // namespace tls
  69. } // namespace httplib
  70. #endif
  71. using namespace std;
  72. using namespace httplib;
  73. const char *HOST = "localhost";
  74. static int get_base_port() {
  75. const char *shard = getenv("GTEST_SHARD_INDEX");
  76. return shard ? 11234 + std::atoi(shard) * 100 : 1234;
  77. }
  78. // NOTE: PORT is only for legacy fixtures (ServerTest, etc.).
  79. // New standalone tests MUST use svr.bind_to_any_port() instead.
  80. const int PORT = get_base_port();
  81. const string LONG_QUERY_VALUE = string(25000, '@');
  82. const string LONG_QUERY_URL = "/long-query-value?key=" + LONG_QUERY_VALUE;
  83. const string TOO_LONG_QUERY_VALUE = string(35000, '@');
  84. const string TOO_LONG_QUERY_URL =
  85. "/too-long-query-value?key=" + TOO_LONG_QUERY_VALUE;
  86. const std::string JSON_DATA = "{\"hello\":\"world\"}";
  87. const string LARGE_DATA = string(1024 * 1024 * 100, '@'); // 100MB
  88. FormData &get_file_value(std::vector<FormData> &items, const char *key) {
  89. auto it = std::find_if(items.begin(), items.end(), [&](const FormData &file) {
  90. return file.name == key;
  91. });
  92. #ifdef CPPHTTPLIB_NO_EXCEPTIONS
  93. return *it;
  94. #else
  95. if (it != items.end()) { return *it; }
  96. throw std::runtime_error("invalid multipart form data name error");
  97. #endif
  98. }
  99. static void read_file(const std::string &path, std::string &out) {
  100. std::ifstream fs(path, std::ios_base::binary);
  101. if (!fs) {
  102. #ifdef CPPHTTPLIB_NO_EXCEPTIONS
  103. return;
  104. #else
  105. throw std::runtime_error("File not found: " + path);
  106. #endif
  107. }
  108. fs.seekg(0, std::ios_base::end);
  109. auto size = fs.tellg();
  110. fs.seekg(0);
  111. out.resize(static_cast<size_t>(size));
  112. fs.read(&out[0], static_cast<std::streamsize>(size));
  113. }
  114. class UnixSocketTest : public ::testing::Test {
  115. protected:
  116. void TearDown() override { std::remove(pathname_.c_str()); }
  117. void client_GET(const std::string &addr) {
  118. httplib::Client cli{addr};
  119. cli.set_address_family(AF_UNIX);
  120. ASSERT_TRUE(cli.is_valid());
  121. const auto &result = cli.Get(pattern_);
  122. ASSERT_TRUE(result) << "error: " << result.error();
  123. const auto &resp = result.value();
  124. EXPECT_EQ(resp.status, StatusCode::OK_200);
  125. EXPECT_EQ(resp.body, content_);
  126. }
  127. static std::string make_sock_path() {
  128. const char *shard = getenv("GTEST_SHARD_INDEX");
  129. return shard ? std::string("./httplib-server-") + shard + ".sock"
  130. : "./httplib-server.sock";
  131. }
  132. const std::string pathname_{make_sock_path()};
  133. const std::string pattern_{"/hi"};
  134. const std::string content_{"Hello World!"};
  135. };
  136. TEST_F(UnixSocketTest, pathname) {
  137. httplib::Server svr;
  138. svr.Get(pattern_, [&](const httplib::Request &, httplib::Response &res) {
  139. res.set_content(content_, "text/plain");
  140. });
  141. std::thread t{[&] {
  142. ASSERT_TRUE(svr.set_address_family(AF_UNIX).listen(pathname_, 80));
  143. }};
  144. auto se = detail::scope_exit([&] {
  145. svr.stop();
  146. t.join();
  147. ASSERT_FALSE(svr.is_running());
  148. });
  149. svr.wait_until_ready();
  150. ASSERT_TRUE(svr.is_running());
  151. client_GET(pathname_);
  152. // ".//x.sock", which is not taken for a URL
  153. client_GET("./" + pathname_.substr(1));
  154. }
  155. #if defined(__linux__) || \
  156. /* __APPLE__ */ (defined(SOL_LOCAL) && defined(SO_PEERPID))
  157. TEST_F(UnixSocketTest, PeerPid) {
  158. httplib::Server svr;
  159. std::string remote_port_val;
  160. svr.Get(pattern_, [&](const httplib::Request &req, httplib::Response &res) {
  161. res.set_content(content_, "text/plain");
  162. remote_port_val = std::to_string(req.remote_port);
  163. });
  164. std::thread t{[&] {
  165. ASSERT_TRUE(svr.set_address_family(AF_UNIX).listen(pathname_, 80));
  166. }};
  167. auto se = detail::scope_exit([&] {
  168. svr.stop();
  169. t.join();
  170. ASSERT_FALSE(svr.is_running());
  171. });
  172. svr.wait_until_ready();
  173. ASSERT_TRUE(svr.is_running());
  174. client_GET(pathname_);
  175. EXPECT_EQ(std::to_string(getpid()), remote_port_val);
  176. }
  177. #endif
  178. #ifdef __linux__
  179. TEST_F(UnixSocketTest, abstract) {
  180. constexpr char svr_path[]{"\x00httplib-server.sock"};
  181. const std::string abstract_addr{svr_path, sizeof(svr_path) - 1};
  182. httplib::Server svr;
  183. svr.Get(pattern_, [&](const httplib::Request &, httplib::Response &res) {
  184. res.set_content(content_, "text/plain");
  185. });
  186. std::thread t{[&] {
  187. ASSERT_TRUE(svr.set_address_family(AF_UNIX).listen(abstract_addr, 80));
  188. }};
  189. auto se = detail::scope_exit([&] {
  190. svr.stop();
  191. t.join();
  192. ASSERT_FALSE(svr.is_running());
  193. });
  194. svr.wait_until_ready();
  195. ASSERT_TRUE(svr.is_running());
  196. client_GET(abstract_addr);
  197. }
  198. #endif
  199. TEST_F(UnixSocketTest, HostHeaderAutoSet) {
  200. httplib::Server svr;
  201. std::string received_host_header;
  202. svr.Get(pattern_, [&](const httplib::Request &req, httplib::Response &res) {
  203. // Capture the Host header sent by the client
  204. auto host_iter = req.headers.find("Host");
  205. if (host_iter != req.headers.end()) {
  206. received_host_header = host_iter->second;
  207. }
  208. res.set_content(content_, "text/plain");
  209. });
  210. std::thread t{[&] {
  211. ASSERT_TRUE(svr.set_address_family(AF_UNIX).listen(pathname_, 80));
  212. }};
  213. auto se = detail::scope_exit([&] {
  214. svr.stop();
  215. t.join();
  216. ASSERT_FALSE(svr.is_running());
  217. });
  218. svr.wait_until_ready();
  219. ASSERT_TRUE(svr.is_running());
  220. // Test that Host header is automatically set to "localhost" for Unix socket
  221. // connections
  222. httplib::Client cli{pathname_};
  223. cli.set_address_family(AF_UNIX);
  224. ASSERT_TRUE(cli.is_valid());
  225. const auto &result = cli.Get(pattern_);
  226. ASSERT_TRUE(result) << "error: " << result.error();
  227. const auto &resp = result.value();
  228. EXPECT_EQ(resp.status, StatusCode::OK_200);
  229. EXPECT_EQ(resp.body, content_);
  230. // Verify that Host header was automatically set to "localhost"
  231. EXPECT_EQ(received_host_header, "localhost");
  232. }
  233. #ifndef _WIN32
  234. TEST(SocketStream, wait_writable_UNIX) {
  235. int fds[2];
  236. ASSERT_EQ(0, socketpair(AF_UNIX, SOCK_STREAM, 0, fds));
  237. const auto asSocketStream = [&](socket_t fd,
  238. std::function<bool(Stream &)> func) {
  239. return detail::process_client_socket(
  240. fd, 0, 0, 0, 0, 0, std::chrono::steady_clock::time_point::min(), func);
  241. };
  242. asSocketStream(fds[0], [&](Stream &s0) {
  243. EXPECT_EQ(s0.socket(), fds[0]);
  244. EXPECT_TRUE(s0.wait_writable());
  245. EXPECT_TRUE(s0.is_peer_alive());
  246. EXPECT_EQ(0, close(fds[1]));
  247. EXPECT_FALSE(s0.is_peer_alive());
  248. return true;
  249. });
  250. EXPECT_EQ(0, close(fds[0]));
  251. }
  252. TEST(SocketStream, wait_writable_INET) {
  253. sockaddr_in addr;
  254. memset(&addr, 0, sizeof(addr));
  255. addr.sin_family = AF_INET;
  256. addr.sin_port = htons(static_cast<uint16_t>(PORT + 1));
  257. addr.sin_addr.s_addr = htonl(INADDR_LOOPBACK);
  258. int disconnected_svr_sock = -1;
  259. std::thread svr{[&] {
  260. const int s = socket(AF_INET, SOCK_STREAM, 0);
  261. ASSERT_LE(0, s);
  262. // PORT + 1 is shared with the SSL redirect tests and with
  263. // VulnerabilityTest.CRLFInjectionInHeaders, all of which set this. Without
  264. // it, a TIME_WAIT one of them left behind makes bind() fail here, and
  265. // because that happens on a worker thread the ASSERT does not stop the
  266. // test: it runs on and fails at the disconnected_svr_sock check instead.
  267. default_socket_options(s);
  268. ASSERT_EQ(0, ::bind(s, reinterpret_cast<sockaddr *>(&addr), sizeof(addr)));
  269. ASSERT_EQ(0, listen(s, 1));
  270. ASSERT_LE(0, disconnected_svr_sock = accept(s, nullptr, nullptr));
  271. ASSERT_EQ(0, close(s));
  272. }};
  273. std::this_thread::sleep_for(std::chrono::milliseconds(100));
  274. std::thread cli{[&] {
  275. const int s = socket(AF_INET, SOCK_STREAM, 0);
  276. ASSERT_LE(0, s);
  277. ASSERT_EQ(0, connect(s, reinterpret_cast<sockaddr *>(&addr), sizeof(addr)));
  278. ASSERT_EQ(0, close(s));
  279. }};
  280. cli.join();
  281. svr.join();
  282. ASSERT_NE(disconnected_svr_sock, -1);
  283. const auto asSocketStream = [&](socket_t fd,
  284. std::function<bool(Stream &)> func) {
  285. return detail::process_client_socket(
  286. fd, 0, 0, 0, 0, 0, std::chrono::steady_clock::time_point::min(), func);
  287. };
  288. asSocketStream(disconnected_svr_sock, [&](Stream &ss) {
  289. EXPECT_EQ(ss.socket(), disconnected_svr_sock);
  290. // wait_writable() returns true because select_write() only checks if the
  291. // send buffer has space. Peer disconnection is detected later by send().
  292. EXPECT_TRUE(ss.wait_writable());
  293. return true;
  294. });
  295. ASSERT_EQ(0, close(disconnected_svr_sock));
  296. }
  297. #endif // #ifndef _WIN32
  298. TEST(SetSocketOptTest, TcpNoDelay) {
  299. auto sock = ::socket(AF_INET, SOCK_STREAM, 0);
  300. ASSERT_NE(sock, INVALID_SOCKET);
  301. EXPECT_TRUE(set_socket_opt(sock, IPPROTO_TCP, TCP_NODELAY, 1));
  302. int val = 0;
  303. socklen_t len = sizeof(val);
  304. ASSERT_EQ(0, ::getsockopt(sock, IPPROTO_TCP, TCP_NODELAY,
  305. reinterpret_cast<char *>(&val), &len));
  306. EXPECT_NE(val, 0);
  307. detail::close_socket(sock);
  308. }
  309. TEST(AcceptErrorTest, RetryableFailuresAreClassifiedPerPlatform) {
  310. // accept() reports failures through WSAGetLastError() on Windows and through
  311. // errno everywhere else. Asking the wrong one is what made the accept loop
  312. // treat every recoverable failure as fatal on Windows.
  313. struct Classification {
  314. bool resource;
  315. bool transient;
  316. };
  317. auto classify = [](int err) {
  318. #ifdef _WIN32
  319. WSASetLastError(err);
  320. #else
  321. errno = err;
  322. #endif
  323. // Read both before asserting: an assertion may clobber the error slot.
  324. Classification c;
  325. c.resource = detail::is_accept_resource_error();
  326. c.transient = detail::is_accept_transient_error();
  327. return c;
  328. };
  329. #ifdef _WIN32
  330. const std::vector<int> resource_errors = {WSAEMFILE, WSAENOBUFS};
  331. const std::vector<int> transient_errors = {WSAEINTR, WSAEWOULDBLOCK,
  332. WSAECONNRESET, WSAECONNABORTED};
  333. const std::vector<int> fatal_errors = {WSAENOTSOCK, WSAEINVAL, WSAEOPNOTSUPP};
  334. #else
  335. const std::vector<int> resource_errors = {EMFILE, ENFILE, ENOBUFS, ENOMEM};
  336. const std::vector<int> transient_errors = {EINTR, EAGAIN, EWOULDBLOCK,
  337. ECONNABORTED};
  338. const std::vector<int> fatal_errors = {EBADF, EINVAL, ENOTSOCK};
  339. #endif
  340. for (auto err : resource_errors) {
  341. const auto c = classify(err);
  342. EXPECT_TRUE(c.resource) << "error " << err;
  343. EXPECT_FALSE(c.transient) << "error " << err;
  344. }
  345. for (auto err : transient_errors) {
  346. const auto c = classify(err);
  347. EXPECT_TRUE(c.transient) << "error " << err;
  348. EXPECT_FALSE(c.resource) << "error " << err;
  349. }
  350. for (auto err : fatal_errors) {
  351. const auto c = classify(err);
  352. EXPECT_FALSE(c.resource) << "error " << err;
  353. EXPECT_FALSE(c.transient) << "error " << err;
  354. }
  355. #ifdef _WIN32
  356. WSASetLastError(0);
  357. #else
  358. errno = 0;
  359. #endif
  360. }
  361. TEST(ClientTest, MoveConstructible) {
  362. EXPECT_FALSE(std::is_copy_constructible<Client>::value);
  363. EXPECT_TRUE(std::is_nothrow_move_constructible<Client>::value);
  364. }
  365. TEST(ClientTest, MoveAssignable) {
  366. EXPECT_FALSE(std::is_copy_assignable<Client>::value);
  367. EXPECT_TRUE(std::is_nothrow_move_assignable<Client>::value);
  368. }
  369. #ifdef _WIN32
  370. TEST(StartupTest, WSAStartup) {
  371. WSADATA wsaData;
  372. int ret = WSAStartup(0x0002, &wsaData);
  373. ASSERT_EQ(0, ret);
  374. }
  375. #endif
  376. TEST(DecodePathTest, PercentCharacter) {
  377. EXPECT_EQ(
  378. decode_path_component(
  379. R"(descrip=Gastos%20%C3%A1%C3%A9%C3%AD%C3%B3%C3%BA%C3%B1%C3%91%206)"),
  380. U8("descrip=Gastos áéíóúñÑ 6"));
  381. }
  382. TEST(DecodePathTest, PercentCharacterNUL) {
  383. string expected;
  384. expected.push_back('x');
  385. expected.push_back('\0');
  386. expected.push_back('x');
  387. EXPECT_EQ(decode_path_component("x%00x"), expected);
  388. }
  389. TEST(DecodePathTest, UnicodeEncoding) {
  390. // %u0041 = 'A' (1-byte UTF-8)
  391. EXPECT_EQ("A", decode_path_component("%u0041"));
  392. // %u00E9 = 'é' (2-byte UTF-8)
  393. EXPECT_EQ(U8("é"), decode_path_component("%u00E9"));
  394. // %u3042 = 'あ' (3-byte UTF-8)
  395. EXPECT_EQ(U8("あ"), decode_path_component("%u3042"));
  396. // %uFFFF = max 4-digit hex (3-byte UTF-8, must not overflow buff[4])
  397. EXPECT_FALSE(decode_path_component("%uFFFF").empty());
  398. // %uD800 = surrogate (invalid, kept as it is rather than joining its
  399. // neighbours)
  400. EXPECT_EQ("%uD800", decode_path_component("%uD800"));
  401. EXPECT_EQ("/ad%uD800min", decode_path_component("/ad%uD800min"));
  402. }
  403. TEST(DecodeQueryTest, RejectsNonHexEscapes) {
  404. // A sign or whitespace inside the two-character escape window must not be
  405. // accepted as a valid percent-encoding; the sequence is passed through
  406. // literally, matching decode_uri_component / decode_path_component.
  407. EXPECT_EQ("%-1", decode_query_component("%-1", false));
  408. EXPECT_EQ("%-0", decode_query_component("%-0", false));
  409. EXPECT_EQ("%+5", decode_query_component("%+5", false));
  410. EXPECT_EQ("% 5", decode_query_component("% 5", false));
  411. // Well-formed escapes still decode.
  412. EXPECT_EQ("-", decode_query_component("%2D", false));
  413. EXPECT_EQ("A", decode_query_component("%41", false));
  414. }
  415. TEST(SanitizeFilenameTest, VariousPatterns) {
  416. // Path traversal
  417. EXPECT_EQ("passwd", httplib::sanitize_filename("../../../etc/passwd"));
  418. EXPECT_EQ("passwd", httplib::sanitize_filename("..\\..\\etc\\passwd"));
  419. EXPECT_EQ("file.txt", httplib::sanitize_filename("path/to\\..\\file.txt"));
  420. // Normal and edge cases
  421. EXPECT_EQ("photo.jpg", httplib::sanitize_filename("photo.jpg"));
  422. EXPECT_EQ("filename.txt",
  423. httplib::sanitize_filename("/path/to/filename.txt"));
  424. EXPECT_EQ(".gitignore", httplib::sanitize_filename(".gitignore"));
  425. EXPECT_EQ("", httplib::sanitize_filename(".."));
  426. EXPECT_EQ("", httplib::sanitize_filename(""));
  427. // Null bytes stripped
  428. EXPECT_EQ("safe.txt",
  429. httplib::sanitize_filename(std::string("safe\0.txt", 9)));
  430. // Whitespace-only rejected
  431. EXPECT_EQ("", httplib::sanitize_filename(" "));
  432. }
  433. // Forward declaration (see the base64_encode note below): split builds move the
  434. // definition into httplib.cc, so re-declaring it here lets the test link.
  435. namespace httplib {
  436. namespace detail {
  437. bool is_chunked_transfer_encoding(const Headers &headers);
  438. } // namespace detail
  439. } // namespace httplib
  440. TEST(ChunkedTransferEncodingTest, DetectsChunkedAsFinalCoding) {
  441. // Build a Headers with the given Transfer-Encoding lines (nullptr = none).
  442. auto make = [](std::initializer_list<const char *> lines) {
  443. Headers h;
  444. for (auto te : lines) {
  445. if (te) { h.emplace("Transfer-Encoding", te); }
  446. }
  447. return h;
  448. };
  449. // Sole coding, matched case-insensitively.
  450. EXPECT_TRUE(detail::is_chunked_transfer_encoding(make({"chunked"})));
  451. EXPECT_TRUE(detail::is_chunked_transfer_encoding(make({"Chunked"})));
  452. EXPECT_TRUE(detail::is_chunked_transfer_encoding(make({"CHUNKED"})));
  453. // RFC 9112 6.1: chunked as the final coding of a list still frames the body.
  454. EXPECT_TRUE(detail::is_chunked_transfer_encoding(make({"gzip, chunked"})));
  455. EXPECT_TRUE(detail::is_chunked_transfer_encoding(make({"gzip,chunked"})));
  456. EXPECT_TRUE(detail::is_chunked_transfer_encoding(make({"gzip, Chunked "})));
  457. // Single line: chunked absent, or not the final coding -> not chunk-framed.
  458. EXPECT_FALSE(detail::is_chunked_transfer_encoding(make({"gzip"})));
  459. EXPECT_FALSE(detail::is_chunked_transfer_encoding(make({"chunked, gzip"})));
  460. EXPECT_FALSE(detail::is_chunked_transfer_encoding(make({""})));
  461. EXPECT_FALSE(detail::is_chunked_transfer_encoding(make({nullptr})));
  462. // RFC 9110 5.3: multiple Transfer-Encoding lines combine, in the order they
  463. // were received, into one list. Headers preserves that order, so the answer
  464. // is decided by the last coding of the last line and the order the lines
  465. // arrived in is significant.
  466. EXPECT_TRUE(detail::is_chunked_transfer_encoding(make({"gzip", "chunked"})));
  467. EXPECT_FALSE(detail::is_chunked_transfer_encoding(make({"chunked", "gzip"})));
  468. EXPECT_FALSE(detail::is_chunked_transfer_encoding(make({"gzip", "deflate"})));
  469. // The split can fall anywhere in the list.
  470. EXPECT_TRUE(
  471. detail::is_chunked_transfer_encoding(make({"deflate", "gzip, chunked"})));
  472. EXPECT_FALSE(
  473. detail::is_chunked_transfer_encoding(make({"gzip, chunked", "deflate"})));
  474. // A trailing line naming no coding leaves the list ending in nothing, so it
  475. // must not inherit the chunked from the line before it.
  476. EXPECT_FALSE(detail::is_chunked_transfer_encoding(make({"chunked", ""})));
  477. }
  478. // Forward declarations (see the base64_encode note below).
  479. namespace httplib {
  480. namespace detail {
  481. bool parse_status_line(const char *line, std::string &version, int &status,
  482. std::string &reason);
  483. std::string file_extension(const std::string &path);
  484. std::string
  485. find_content_type(const std::string &path,
  486. const std::map<std::string, std::string> &user_data,
  487. const std::string &default_content_type);
  488. bool can_compress_content_type(const std::string &content_type);
  489. bool is_prohibited_header_name(const std::string &name);
  490. #ifdef CPPHTTPLIB_SSL_ENABLED
  491. bool match_hostname(const std::string &pattern, const std::string &hostname);
  492. #endif
  493. } // namespace detail
  494. } // namespace httplib
  495. TEST(ParseStatusLineTest, ParsesVersionStatusAndReason) {
  496. struct {
  497. const char *line;
  498. const char *version;
  499. int status;
  500. const char *reason;
  501. } cases[] = {
  502. {"HTTP/1.1 200 OK\r\n", "HTTP/1.1", 200, "OK"},
  503. {"HTTP/1.0 404 Not Found\r\n", "HTTP/1.0", 404, "Not Found"},
  504. // The reason phrase may be empty, or left out along with its space.
  505. {"HTTP/1.1 204 \r\n", "HTTP/1.1", 204, ""},
  506. {"HTTP/1.1 304\r\n", "HTTP/1.1", 304, ""},
  507. };
  508. for (const auto &c : cases) {
  509. std::string version;
  510. int status = 0;
  511. std::string reason = "unset";
  512. EXPECT_TRUE(detail::parse_status_line(c.line, version, status, reason))
  513. << c.line;
  514. EXPECT_EQ(c.version, version);
  515. EXPECT_EQ(c.status, status);
  516. EXPECT_EQ(c.reason, reason);
  517. }
  518. }
  519. TEST(ParseStatusLineTest, RejectsMalformedLines) {
  520. const char *lines[] = {
  521. "HTTP/2 200 OK\r\n",
  522. "HTTP/1.2 200 OK\r\n",
  523. "HTTP/1.1 20 OK\r\n",
  524. "HTTP/1.1 2000 OK\r\n",
  525. "HTTP/1.1 2x0 OK\r\n",
  526. "HTTP/1.1 200 OK\r\n",
  527. "HTTP/1.1 200OK\r\n",
  528. "HTTP/1.1 200 O\rK\r\n",
  529. "HTTP/1.1 200 OK",
  530. "HTTP/1.1 200 OK\r\nX",
  531. "",
  532. #ifndef CPPHTTPLIB_ALLOW_LF_AS_LINE_TERMINATOR
  533. "HTTP/1.1 200 OK\n",
  534. #endif
  535. };
  536. for (auto line : lines) {
  537. std::string version;
  538. int status = 0;
  539. std::string reason;
  540. EXPECT_FALSE(detail::parse_status_line(line, version, status, reason))
  541. << line;
  542. }
  543. }
  544. TEST(ParseStatusLineTest, AcceptsAReasonPhraseAsLongAsALine) {
  545. // Long enough to overflow the stack when matched with std::regex.
  546. auto long_reason = std::string(CPPHTTPLIB_MAX_LINE_LENGTH - 15, 'A');
  547. auto line = "HTTP/1.1 200 " + long_reason + "\r\n";
  548. std::string version;
  549. int status = 0;
  550. std::string reason;
  551. EXPECT_TRUE(detail::parse_status_line(line.c_str(), version, status, reason));
  552. EXPECT_EQ(200, status);
  553. EXPECT_EQ(long_reason, reason);
  554. }
  555. TEST(FileExtensionTest, TakesTheAlphanumericSuffix) {
  556. EXPECT_EQ("txt", detail::file_extension("a.txt"));
  557. EXPECT_EQ("gz", detail::file_extension("/dir/a.tar.gz"));
  558. EXPECT_EQ("htaccess", detail::file_extension(".htaccess"));
  559. EXPECT_EQ("", detail::file_extension("noext"));
  560. EXPECT_EQ("", detail::file_extension("a."));
  561. EXPECT_EQ("", detail::file_extension("dir.d/file"));
  562. EXPECT_EQ("", detail::file_extension("a.b-c"));
  563. // Long enough to overflow the stack when matched with std::regex.
  564. auto long_ext = std::string(CPPHTTPLIB_MAX_LINE_LENGTH, 'a');
  565. EXPECT_EQ(long_ext, detail::file_extension("a." + long_ext));
  566. }
  567. #ifdef CPPHTTPLIB_SSL_ENABLED
  568. TEST(MatchHostnameTest, FollowsX509CheckHost) {
  569. EXPECT_TRUE(detail::match_hostname("*.example.com", "www.example.com"));
  570. EXPECT_TRUE(detail::match_hostname("www*.example.com", "www1.example.com"));
  571. EXPECT_TRUE(detail::match_hostname("www.example.com", "WWW.example.com."));
  572. // A wildcard needs two labels after it, in the leftmost label only
  573. EXPECT_FALSE(detail::match_hostname("*.com", "example.com"));
  574. EXPECT_FALSE(detail::match_hostname("*", "localhost"));
  575. EXPECT_FALSE(detail::match_hostname("vic*.test", "victim.test"));
  576. EXPECT_FALSE(detail::match_hostname("www.*.com", "www.a.com"));
  577. EXPECT_FALSE(
  578. detail::match_hostname("xn--*.example.com", "xn--a.example.com"));
  579. // No name may have an empty label
  580. EXPECT_FALSE(detail::match_hostname("*.example.com", "a..example.com"));
  581. EXPECT_FALSE(detail::match_hostname("a..example.com", "a.example.com"));
  582. }
  583. #endif
  584. TEST(CaseIgnoreHashTest, IgnoresCaseAndTakesLongKeys) {
  585. detail::case_ignore::hash hash;
  586. EXPECT_EQ(hash("Content-Type"), hash("content-TYPE"));
  587. EXPECT_NE(hash("Content-Type"), hash("Content-Length"));
  588. // Long enough to overflow the stack if hashed one call per character.
  589. EXPECT_EQ(hash(std::string(1 << 20, 'A')), hash(std::string(1 << 20, 'a')));
  590. }
  591. TEST(FindContentTypeTest, ComparesWholeExtensions) {
  592. EXPECT_EQ("text/html", detail::find_content_type("/a.html", {}, ""));
  593. EXPECT_EQ("image/svg+xml", detail::find_content_type("/a.svg", {}, ""));
  594. EXPECT_EQ("text/javascript", detail::find_content_type("/a.js", {}, ""));
  595. EXPECT_EQ("text/html", detail::find_content_type("/INDEX.HTML", {}, ""));
  596. // Same 26-bit hash as html, svg and js.
  597. EXPECT_EQ("", detail::find_content_type("/a.qo2yh", {}, ""));
  598. EXPECT_EQ("", detail::find_content_type("/a.q4g", {}, ""));
  599. EXPECT_EQ("", detail::find_content_type("/a.l5", {}, ""));
  600. }
  601. TEST(CanCompressContentTypeTest, ComparesWholeTypes) {
  602. EXPECT_TRUE(detail::can_compress_content_type("application/json"));
  603. EXPECT_TRUE(detail::can_compress_content_type("text/plain; charset=utf-8"));
  604. EXPECT_FALSE(detail::can_compress_content_type("text/event-stream"));
  605. EXPECT_FALSE(detail::can_compress_content_type("image/png"));
  606. EXPECT_TRUE(detail::can_compress_content_type("Application/JSON"));
  607. EXPECT_FALSE(detail::can_compress_content_type("Text/Event-Stream"));
  608. // Same 26-bit hash as application/json.
  609. EXPECT_FALSE(detail::can_compress_content_type("VY_LQ"));
  610. }
  611. TEST(MultipartFormDataTest, MediaTypeIgnoresCase) {
  612. Request req;
  613. req.set_header("Content-Type", "Multipart/Form-Data; Boundary=x");
  614. EXPECT_TRUE(req.is_multipart_form_data());
  615. std::string boundary;
  616. EXPECT_TRUE(detail::parse_multipart_boundary(
  617. req.get_header_value("Content-Type"), boundary));
  618. EXPECT_EQ("x", boundary);
  619. }
  620. TEST(ProhibitedHeaderNameTest, ComparesWholeNames) {
  621. EXPECT_TRUE(detail::is_prohibited_header_name("REMOTE_ADDR"));
  622. EXPECT_TRUE(detail::is_prohibited_header_name("LOCAL_PORT"));
  623. EXPECT_FALSE(detail::is_prohibited_header_name("Host"));
  624. EXPECT_TRUE(detail::is_prohibited_header_name("remote_addr"));
  625. // Same 26-bit hash as REMOTE_ADDR.
  626. EXPECT_FALSE(detail::is_prohibited_header_name("IIJRp"));
  627. }
  628. // Forward declaration: in split builds split.py strips `inline` and moves the
  629. // definition into httplib.cc, so detail::base64_encode is not visible from the
  630. // public httplib.h. Re-declaring it here lets the tests link against the symbol
  631. // in both header-only and split builds.
  632. namespace httplib {
  633. namespace detail {
  634. std::string base64_encode(const std::string &in);
  635. } // namespace detail
  636. } // namespace httplib
  637. TEST(Base64EncodeTest, KnownAnswers) {
  638. // RFC 4648 test vectors. Inputs of four bytes or more exercise the round
  639. // where the accumulator's top bit is already set before the next shift.
  640. EXPECT_EQ("", detail::base64_encode(""));
  641. EXPECT_EQ("Zg==", detail::base64_encode("f"));
  642. EXPECT_EQ("Zm8=", detail::base64_encode("fo"));
  643. EXPECT_EQ("Zm9v", detail::base64_encode("foo"));
  644. EXPECT_EQ("Zm9vYg==", detail::base64_encode("foob"));
  645. EXPECT_EQ("Zm9vYmE=", detail::base64_encode("fooba"));
  646. EXPECT_EQ("Zm9vYmFy", detail::base64_encode("foobar"));
  647. // High bytes keep the top bit set across several rounds.
  648. EXPECT_EQ("AAECA//+wIB/", detail::base64_encode(std::string(
  649. "\x00\x01\x02\x03\xff\xfe\xc0\x80\x7f", 9)));
  650. }
  651. TEST(EncodeQueryParamTest, ParseUnescapedChararactersTest) {
  652. string unescapedCharacters = "-_.!~*'()";
  653. EXPECT_EQ(httplib::encode_uri_component(unescapedCharacters), "-_.!~*'()");
  654. }
  655. TEST(EncodeQueryParamTest, ParseReservedCharactersTest) {
  656. string reservedCharacters = ";,/?:@&=+$";
  657. EXPECT_EQ(httplib::encode_uri_component(reservedCharacters),
  658. "%3B%2C%2F%3F%3A%40%26%3D%2B%24");
  659. }
  660. TEST(ClientQueryOrder, PreserveOrder) {
  661. // This test reproduces Issue #2259: client may reorder query parameters
  662. // when sending a GET request. The expected behavior is that the client
  663. // preserves the original query string order when the caller supplied it
  664. // as part of the path.
  665. Server svr;
  666. svr.Get("/", [&](const Request &req, Response &res) {
  667. // Echo back the raw target so the test can assert ordering
  668. res.set_content(req.target, "text/plain");
  669. });
  670. std::thread t{[&] { svr.listen(HOST, PORT); }};
  671. auto se = detail::scope_exit([&] {
  672. svr.stop();
  673. t.join();
  674. ASSERT_FALSE(svr.is_running());
  675. });
  676. svr.wait_until_ready();
  677. Client cli(HOST, PORT);
  678. ASSERT_TRUE(cli.is_valid());
  679. const std::string original = "/?z=1&y=2&x=3&c=7&b=8&a=9";
  680. auto res = cli.Get(original);
  681. ASSERT_TRUE(res) << "Error: " << to_string(res.error());
  682. // Expect the echoed target to exactly match the original path (order
  683. // preserved)
  684. EXPECT_EQ(res->body, original);
  685. }
  686. TEST(EncodeQueryParamTest, TestUTF8Characters) {
  687. string chineseCharacters = U8("中国語");
  688. string russianCharacters = U8("дом");
  689. string brazilianCharacters = U8("óculos");
  690. EXPECT_EQ(httplib::encode_uri_component(chineseCharacters),
  691. "%E4%B8%AD%E5%9B%BD%E8%AA%9E");
  692. EXPECT_EQ(httplib::encode_uri_component(russianCharacters),
  693. "%D0%B4%D0%BE%D0%BC");
  694. EXPECT_EQ(httplib::encode_uri_component(brazilianCharacters), "%C3%B3culos");
  695. }
  696. TEST(EncodeUriComponentTest, ParseUnescapedChararactersTest) {
  697. string unescapedCharacters = "-_.!~*'()";
  698. EXPECT_EQ(httplib::encode_uri_component(unescapedCharacters), "-_.!~*'()");
  699. }
  700. TEST(EncodeUriComponentTest, ParseReservedCharactersTest) {
  701. string reservedCharacters = ";,/?:@&=+$";
  702. EXPECT_EQ(httplib::encode_uri_component(reservedCharacters),
  703. "%3B%2C%2F%3F%3A%40%26%3D%2B%24");
  704. }
  705. TEST(EncodeUriComponentTest, TestUTF8Characters) {
  706. string chineseCharacters = U8("中国語");
  707. string russianCharacters = U8("дом");
  708. string brazilianCharacters = U8("óculos");
  709. EXPECT_EQ(httplib::encode_uri_component(chineseCharacters),
  710. "%E4%B8%AD%E5%9B%BD%E8%AA%9E");
  711. EXPECT_EQ(httplib::encode_uri_component(russianCharacters),
  712. "%D0%B4%D0%BE%D0%BC");
  713. EXPECT_EQ(httplib::encode_uri_component(brazilianCharacters), "%C3%B3culos");
  714. }
  715. TEST(EncodeUriComponentTest, TestPathComponentEncoding) {
  716. // Issue #2082 use case: encoding path component with ampersand
  717. string pathWithAmpersand = "Piri Tommy Villiers - on & on";
  718. EXPECT_EQ(httplib::encode_uri_component(pathWithAmpersand),
  719. "Piri%20Tommy%20Villiers%20-%20on%20%26%20on");
  720. }
  721. TEST(EncodeUriTest, ParseUnescapedChararactersTest) {
  722. string unescapedCharacters = "-_.!~*'()";
  723. EXPECT_EQ(httplib::encode_uri(unescapedCharacters), "-_.!~*'()");
  724. }
  725. TEST(EncodeUriTest, ParseReservedCharactersTest) {
  726. string reservedCharacters = ";,/?:@&=+$#";
  727. EXPECT_EQ(httplib::encode_uri(reservedCharacters), ";,/?:@&=+$#");
  728. }
  729. TEST(EncodeUriTest, TestUTF8Characters) {
  730. string chineseCharacters = U8("中国語");
  731. string russianCharacters = U8("дом");
  732. string brazilianCharacters = U8("óculos");
  733. EXPECT_EQ(httplib::encode_uri(chineseCharacters),
  734. "%E4%B8%AD%E5%9B%BD%E8%AA%9E");
  735. EXPECT_EQ(httplib::encode_uri(russianCharacters), "%D0%B4%D0%BE%D0%BC");
  736. EXPECT_EQ(httplib::encode_uri(brazilianCharacters), "%C3%B3culos");
  737. }
  738. TEST(EncodeUriTest, TestCompleteUri) {
  739. string uri =
  740. "https://example.com/path/to/resource?query=value&param=test#fragment";
  741. EXPECT_EQ(
  742. httplib::encode_uri(uri),
  743. "https://example.com/path/to/resource?query=value&param=test#fragment");
  744. }
  745. TEST(EncodeUriTest, TestUriWithSpacesAndSpecialChars) {
  746. string uri =
  747. "https://example.com/path with spaces/file name.html?q=hello world";
  748. EXPECT_EQ(httplib::encode_uri(uri),
  749. "https://example.com/path%20with%20spaces/"
  750. "file%20name.html?q=hello%20world");
  751. }
  752. TEST(DecodeUriComponentTest, ParseEncodedChararactersTest) {
  753. string encodedString = "%3B%2C%2F%3F%3A%40%26%3D%2B%24";
  754. EXPECT_EQ(httplib::decode_uri_component(encodedString), ";,/?:@&=+$");
  755. }
  756. TEST(DecodeUriComponentTest, ParseUnescapedChararactersTest) {
  757. string unescapedCharacters = "-_.!~*'()";
  758. EXPECT_EQ(httplib::decode_uri_component(unescapedCharacters), "-_.!~*'()");
  759. }
  760. TEST(DecodeUriComponentTest, TestUTF8Characters) {
  761. string encodedChinese = "%E4%B8%AD%E5%9B%BD%E8%AA%9E";
  762. string encodedRussian = "%D0%B4%D0%BE%D0%BC";
  763. string encodedBrazilian = "%C3%B3culos";
  764. EXPECT_EQ(httplib::decode_uri_component(encodedChinese), U8("中国語"));
  765. EXPECT_EQ(httplib::decode_uri_component(encodedRussian), U8("дом"));
  766. EXPECT_EQ(httplib::decode_uri_component(encodedBrazilian), U8("óculos"));
  767. }
  768. TEST(DecodeUriComponentTest, TestPathComponentDecoding) {
  769. string encodedPath = "Piri%20Tommy%20Villiers%20-%20on%20%26%20on";
  770. EXPECT_EQ(httplib::decode_uri_component(encodedPath),
  771. "Piri Tommy Villiers - on & on");
  772. }
  773. TEST(DecodeUriTest, ParseEncodedChararactersTest) {
  774. string encodedString = "%20%22%3C%3E%5C%5E%60%7B%7D%7C";
  775. EXPECT_EQ(httplib::decode_uri(encodedString), " \"<>\\^`{}|");
  776. }
  777. TEST(DecodeUriTest, ParseUnescapedChararactersTest) {
  778. string unescapedCharacters = "-_.!~*'();,/?:@&=+$#";
  779. EXPECT_EQ(httplib::decode_uri(unescapedCharacters), "-_.!~*'();,/?:@&=+$#");
  780. }
  781. TEST(DecodeUriTest, TestUTF8Characters) {
  782. string encodedChinese = "%E4%B8%AD%E5%9B%BD%E8%AA%9E";
  783. string encodedRussian = "%D0%B4%D0%BE%D0%BC";
  784. string encodedBrazilian = "%C3%B3culos";
  785. EXPECT_EQ(httplib::decode_uri(encodedChinese), U8("中国語"));
  786. EXPECT_EQ(httplib::decode_uri(encodedRussian), U8("дом"));
  787. EXPECT_EQ(httplib::decode_uri(encodedBrazilian), U8("óculos"));
  788. }
  789. TEST(DecodeUriTest, TestCompleteUri) {
  790. string encodedUri = "https://example.com/path%20with%20spaces/"
  791. "file%20name.html?q=hello%20world";
  792. EXPECT_EQ(
  793. httplib::decode_uri(encodedUri),
  794. "https://example.com/path with spaces/file name.html?q=hello world");
  795. }
  796. TEST(DecodeUriTest, TestRoundTripWithEncodeUri) {
  797. string original =
  798. "https://example.com/path with spaces/file name.html?q=hello world";
  799. string encoded = httplib::encode_uri(original);
  800. string decoded = httplib::decode_uri(encoded);
  801. EXPECT_EQ(decoded, original);
  802. }
  803. TEST(DecodeUriTest, KeepsReservedCharacterEscapes) {
  804. // decode_uri is the inverse of encode_uri: an escaped reserved character
  805. // stays encoded so it is not promoted into a real delimiter, while
  806. // non-reserved escapes still decode (like JS decodeURI).
  807. EXPECT_EQ(httplib::decode_uri("%2F"), "%2F");
  808. EXPECT_EQ(httplib::decode_uri("%23"), "%23");
  809. EXPECT_EQ(httplib::decode_uri("%3F%3A%40%26%3D%2B%24%2C%3B"),
  810. "%3F%3A%40%26%3D%2B%24%2C%3B");
  811. EXPECT_EQ(httplib::decode_uri("%2D"), "-");
  812. EXPECT_EQ(httplib::decode_uri("%20"), " ");
  813. EXPECT_EQ(httplib::decode_uri("http://example.com/a%2Fb"),
  814. "http://example.com/a%2Fb");
  815. // decode_uri_component still decodes the reserved character.
  816. EXPECT_EQ(httplib::decode_uri_component("%2F"), "/");
  817. }
  818. TEST(DecodeUriComponentTest, TestRoundTripWithEncodeUriComponent) {
  819. string original = "Piri Tommy Villiers - on & on";
  820. string encoded = httplib::encode_uri_component(original);
  821. string decoded = httplib::decode_uri_component(encoded);
  822. EXPECT_EQ(decoded, original);
  823. }
  824. TEST(TrimTests, TrimStringTests) {
  825. EXPECT_EQ("abc", detail::trim_copy("abc"));
  826. EXPECT_EQ("abc", detail::trim_copy(" abc "));
  827. EXPECT_TRUE(detail::trim_copy("").empty());
  828. }
  829. TEST(AsciiTest, LocaleIndependentClassification) {
  830. // detail::is_ascii_digit/alpha/alnum replace the <cctype> classifiers,
  831. // which consult the global C locale: std::isalnum(0xC5) can return true
  832. // once an embedder calls setlocale() (observed on macOS). The is_ascii_*
  833. // helpers must classify every byte by the ASCII grammar alone.
  834. for (int i = 0; i < 256; i++) {
  835. auto c = static_cast<char>(i);
  836. auto is_digit = i >= '0' && i <= '9';
  837. auto is_upper = i >= 'A' && i <= 'Z';
  838. auto is_lower = i >= 'a' && i <= 'z';
  839. EXPECT_EQ(is_digit, detail::is_ascii_digit(c)) << "byte " << i;
  840. EXPECT_EQ(is_upper || is_lower, detail::is_ascii_alpha(c)) << "byte " << i;
  841. EXPECT_EQ(is_digit || is_upper || is_lower, detail::is_ascii_alnum(c))
  842. << "byte " << i;
  843. }
  844. // Regression check for the reported byte: 0xC5 is not alphanumeric.
  845. EXPECT_FALSE(detail::is_ascii_alnum(static_cast<char>(0xC5)));
  846. // Non-ASCII bytes must be percent-encoded, never passed through as
  847. // alphanumeric.
  848. EXPECT_EQ("%C5", httplib::encode_uri_component("\xC5"));
  849. }
  850. TEST(FromCharsTest, Double) {
  851. // detail::from_chars(double) recognizes exactly the HTTP quality-value
  852. // grammar (RFC 9110 12.4.2): a non-negative decimal "1*DIGIT [ '.' *DIGIT ]"
  853. // with no sign, exponent, or "inf"/"nan", parsed locale-independently.
  854. auto parse = [](const std::string &s, double &v) {
  855. return detail::from_chars(s.data(), s.data() + s.size(), v);
  856. };
  857. double v = -1.0;
  858. // Representative quality values.
  859. EXPECT_EQ(parse("0", v).ec, std::errc{});
  860. EXPECT_DOUBLE_EQ(v, 0.0);
  861. EXPECT_EQ(parse("1", v).ec, std::errc{});
  862. EXPECT_DOUBLE_EQ(v, 1.0);
  863. EXPECT_EQ(parse("0.8", v).ec, std::errc{});
  864. EXPECT_DOUBLE_EQ(v, 0.8);
  865. EXPECT_EQ(parse("0.001", v).ec, std::errc{});
  866. EXPECT_DOUBLE_EQ(v, 0.001);
  867. EXPECT_EQ(parse("1.000", v).ec, std::errc{});
  868. EXPECT_DOUBLE_EQ(v, 1.0);
  869. // A missing integer or fractional part is tolerated.
  870. EXPECT_EQ(parse(".5", v).ec, std::errc{});
  871. EXPECT_DOUBLE_EQ(v, 0.5);
  872. EXPECT_EQ(parse("5.", v).ec, std::errc{});
  873. EXPECT_DOUBLE_EQ(v, 5.0);
  874. // Values outside [0, 1] still parse; the caller range-checks them.
  875. EXPECT_EQ(parse("123.456", v).ec, std::errc{});
  876. EXPECT_DOUBLE_EQ(v, 123.456);
  877. // Stops at the first byte that is not part of the number and reports where.
  878. std::string trailing = "0.9, text/html";
  879. auto r = parse(trailing, v);
  880. EXPECT_EQ(r.ec, std::errc{});
  881. EXPECT_DOUBLE_EQ(v, 0.9);
  882. EXPECT_EQ(*r.ptr, ',');
  883. // Sign and exponent are NOT part of the grammar: '+'/'-' are rejected
  884. // outright, and an 'e'/'E' simply ends the number.
  885. EXPECT_EQ(parse("-3.25", v).ec, std::errc::invalid_argument);
  886. EXPECT_EQ(parse("+2.5", v).ec, std::errc::invalid_argument);
  887. std::string exp_input = "1.5e3";
  888. r = parse(exp_input, v);
  889. EXPECT_EQ(r.ec, std::errc{});
  890. EXPECT_DOUBLE_EQ(v, 1.5);
  891. EXPECT_EQ(*r.ptr, 'e');
  892. // Invalid inputs.
  893. EXPECT_EQ(parse("", v).ec, std::errc::invalid_argument);
  894. EXPECT_EQ(parse(".", v).ec, std::errc::invalid_argument);
  895. EXPECT_EQ(parse("abc", v).ec, std::errc::invalid_argument);
  896. EXPECT_EQ(parse("nan", v).ec, std::errc::invalid_argument);
  897. EXPECT_EQ(parse("inf", v).ec, std::errc::invalid_argument);
  898. // Pathological but well-formed inputs must stay bounded (no overflow, no
  899. // out-of-bounds table access) and stay within [0, 1] for the caller.
  900. EXPECT_EQ(parse(std::string("0.") + std::string(500, '0'), v).ec,
  901. std::errc{});
  902. EXPECT_DOUBLE_EQ(v, 0.0);
  903. EXPECT_EQ(parse(std::string("0.") + std::string(500, '9'), v).ec,
  904. std::errc{});
  905. EXPECT_GE(v, 0.0);
  906. EXPECT_LE(v, 1.0);
  907. EXPECT_EQ(parse(std::string(500, '9'), v).ec, std::errc{});
  908. EXPECT_GT(v, 1.0); // huge integer: finite, > 1, so the caller rejects it
  909. }
  910. TEST(ParseAcceptHeaderTest, BasicAcceptParsing) {
  911. // Simple case without quality values
  912. std::vector<std::string> result1;
  913. EXPECT_TRUE(detail::parse_accept_header(
  914. "text/html,application/json,text/plain", result1));
  915. EXPECT_EQ(result1.size(), 3U);
  916. EXPECT_EQ(result1[0], "text/html");
  917. EXPECT_EQ(result1[1], "application/json");
  918. EXPECT_EQ(result1[2], "text/plain");
  919. // With quality values
  920. std::vector<std::string> result2;
  921. EXPECT_TRUE(detail::parse_accept_header(
  922. "text/html;q=0.9,application/json;q=1.0,text/plain;q=0.8", result2));
  923. EXPECT_EQ(result2.size(), 3U);
  924. EXPECT_EQ(result2[0], "application/json"); // highest q value
  925. EXPECT_EQ(result2[1], "text/html");
  926. EXPECT_EQ(result2[2], "text/plain"); // lowest q value
  927. }
  928. TEST(ParseAcceptHeaderTest, MixedQualityValues) {
  929. // Mixed with and without quality values
  930. std::vector<std::string> result;
  931. EXPECT_TRUE(detail::parse_accept_header(
  932. "text/html,application/json;q=0.5,text/plain;q=0.8", result));
  933. EXPECT_EQ(result.size(), 3U);
  934. EXPECT_EQ(result[0], "text/html"); // no q value means 1.0
  935. EXPECT_EQ(result[1], "text/plain"); // q=0.8
  936. EXPECT_EQ(result[2], "application/json"); // q=0.5
  937. }
  938. TEST(ParseAcceptHeaderTest, EdgeCases) {
  939. // Empty header
  940. std::vector<std::string> empty_result;
  941. EXPECT_TRUE(detail::parse_accept_header("", empty_result));
  942. EXPECT_TRUE(empty_result.empty());
  943. // Single type
  944. std::vector<std::string> single_result;
  945. EXPECT_TRUE(detail::parse_accept_header("application/json", single_result));
  946. EXPECT_EQ(single_result.size(), 1U);
  947. EXPECT_EQ(single_result[0], "application/json");
  948. // Wildcard types
  949. std::vector<std::string> wildcard_result;
  950. EXPECT_TRUE(detail::parse_accept_header(
  951. "text/*;q=0.5,*/*;q=0.1,application/json", wildcard_result));
  952. EXPECT_EQ(wildcard_result.size(), 3U);
  953. EXPECT_EQ(wildcard_result[0], "application/json");
  954. EXPECT_EQ(wildcard_result[1], "text/*");
  955. EXPECT_EQ(wildcard_result[2], "*/*");
  956. }
  957. TEST(ParseAcceptHeaderTest, RealWorldExamples) {
  958. // Common browser Accept header
  959. std::vector<std::string> browser_result;
  960. EXPECT_TRUE(
  961. detail::parse_accept_header("text/html,application/xhtml+xml,application/"
  962. "xml;q=0.9,image/webp,image/apng,*/*;q=0.8",
  963. browser_result));
  964. EXPECT_EQ(browser_result.size(), 6U);
  965. EXPECT_EQ(browser_result[0], "text/html"); // q=1.0 (default)
  966. EXPECT_EQ(browser_result[1], "application/xhtml+xml"); // q=1.0 (default)
  967. EXPECT_EQ(browser_result[2], "image/webp"); // q=1.0 (default)
  968. EXPECT_EQ(browser_result[3], "image/apng"); // q=1.0 (default)
  969. EXPECT_EQ(browser_result[4], "application/xml"); // q=0.9
  970. EXPECT_EQ(browser_result[5], "*/*"); // q=0.8
  971. // API client header
  972. std::vector<std::string> api_result;
  973. EXPECT_TRUE(detail::parse_accept_header(
  974. "application/json;q=0.9,application/xml;q=0.8,text/plain;q=0.1",
  975. api_result));
  976. EXPECT_EQ(api_result.size(), 3U);
  977. EXPECT_EQ(api_result[0], "application/json");
  978. EXPECT_EQ(api_result[1], "application/xml");
  979. EXPECT_EQ(api_result[2], "text/plain");
  980. }
  981. TEST(ParseAcceptHeaderTest, SpecialCases) {
  982. // Quality value with 3 decimal places
  983. std::vector<std::string> decimal_result;
  984. EXPECT_TRUE(detail::parse_accept_header(
  985. "text/html;q=0.123,application/json;q=0.456", decimal_result));
  986. EXPECT_EQ(decimal_result.size(), 2U);
  987. EXPECT_EQ(decimal_result[0], "application/json"); // Higher q value
  988. EXPECT_EQ(decimal_result[1], "text/html");
  989. // Zero quality (should still be included but with lowest priority)
  990. std::vector<std::string> zero_q_result;
  991. EXPECT_TRUE(detail::parse_accept_header("text/html;q=0,application/json;q=1",
  992. zero_q_result));
  993. EXPECT_EQ(zero_q_result.size(), 2U);
  994. EXPECT_EQ(zero_q_result[0], "application/json"); // q=1
  995. EXPECT_EQ(zero_q_result[1], "text/html"); // q=0
  996. // No spaces around commas
  997. std::vector<std::string> no_space_result;
  998. EXPECT_TRUE(detail::parse_accept_header(
  999. "text/html;q=0.9,application/json;q=0.8,text/plain;q=0.7",
  1000. no_space_result));
  1001. EXPECT_EQ(no_space_result.size(), 3U);
  1002. EXPECT_EQ(no_space_result[0], "text/html");
  1003. EXPECT_EQ(no_space_result[1], "application/json");
  1004. EXPECT_EQ(no_space_result[2], "text/plain");
  1005. }
  1006. TEST(ParseAcceptHeaderTest, QualityValueLocaleIndependence) {
  1007. // Quality values always use '.' as the decimal separator, so parsing must
  1008. // not depend on the process locale. An embedding application may have
  1009. // switched to a locale that uses ',' via setlocale(LC_ALL, "").
  1010. const char *cur = std::setlocale(LC_NUMERIC, nullptr);
  1011. std::string saved = cur ? cur : "C";
  1012. const char *comma_locales[] = {"de_DE.UTF-8", "de_DE.utf8", "nl_NL.UTF-8",
  1013. "fr_FR.UTF-8"};
  1014. bool switched = false;
  1015. for (const auto loc : comma_locales) {
  1016. if (std::setlocale(LC_NUMERIC, loc) != nullptr &&
  1017. std::localeconv()->decimal_point[0] == ',') {
  1018. switched = true;
  1019. break;
  1020. }
  1021. }
  1022. if (!switched) {
  1023. std::setlocale(LC_NUMERIC, saved.c_str());
  1024. GTEST_SKIP() << "no comma-decimal locale available on this host";
  1025. }
  1026. // The higher-weighted type appears later in the list, so a correct parse
  1027. // must reorder it ahead of the earlier, lower-weighted one. A locale-
  1028. // sensitive parse reads both weights as 0 and leaves the original order.
  1029. std::vector<std::string> result;
  1030. EXPECT_TRUE(detail::parse_accept_header(
  1031. "application/json;q=0.1,text/html;q=0.9", result));
  1032. ASSERT_EQ(result.size(), 2U);
  1033. EXPECT_EQ(result[0], "text/html");
  1034. EXPECT_EQ(result[1], "application/json");
  1035. std::setlocale(LC_NUMERIC, saved.c_str());
  1036. }
  1037. TEST(ParseAcceptHeaderTest, InvalidCases) {
  1038. std::vector<std::string> result;
  1039. // Invalid quality value (> 1.0)
  1040. EXPECT_FALSE(
  1041. detail::parse_accept_header("text/html;q=1.5,application/json", result));
  1042. // Invalid quality value (< 0.0)
  1043. EXPECT_FALSE(
  1044. detail::parse_accept_header("text/html;q=-0.1,application/json", result));
  1045. // Invalid quality value (not a number)
  1046. EXPECT_FALSE(detail::parse_accept_header(
  1047. "text/html;q=invalid,application/json", result));
  1048. // A valid numeric prefix does not make the entire quality value valid.
  1049. EXPECT_FALSE(detail::parse_accept_header(
  1050. "text/html;q=0.5junk,application/json", result));
  1051. // Empty quality value
  1052. EXPECT_FALSE(
  1053. detail::parse_accept_header("text/html;q=,application/json", result));
  1054. // Invalid media type format (no slash and not wildcard)
  1055. EXPECT_FALSE(
  1056. detail::parse_accept_header("invalidtype,application/json", result));
  1057. // Valid cases should still work
  1058. EXPECT_TRUE(detail::parse_accept_header("*/*", result));
  1059. EXPECT_EQ(result.size(), 1U);
  1060. EXPECT_EQ(result[0], "*/*");
  1061. EXPECT_TRUE(detail::parse_accept_header("*", result));
  1062. EXPECT_EQ(result.size(), 1U);
  1063. EXPECT_EQ(result[0], "*");
  1064. EXPECT_TRUE(detail::parse_accept_header("text/*", result));
  1065. EXPECT_EQ(result.size(), 1U);
  1066. EXPECT_EQ(result[0], "text/*");
  1067. }
  1068. // RFC 9110 Section 5.6.1.2: a recipient has to parse and ignore empty list
  1069. // elements, so a leading, trailing or doubled comma is a legal Accept value
  1070. // and must not be answered with 400 Bad Request.
  1071. TEST(ParseAcceptHeaderTest, EmptyListElementsAreIgnored) {
  1072. struct {
  1073. const char *value;
  1074. std::vector<std::string> expected;
  1075. } cases[] = {
  1076. {",application/json", {"application/json"}},
  1077. {"text/html,", {"text/html"}},
  1078. {"text/html,,*/*", {"text/html", "*/*"}},
  1079. // An empty element may be spelled with whitespace in it
  1080. {"text/html, , application/json", {"text/html", "application/json"}},
  1081. // Nothing but empty elements is an empty list, which means the same
  1082. // thing as no Accept header at all
  1083. {",,,", {}},
  1084. // Quality values still apply across ignored empty elements
  1085. {",text/html;q=0.5,,application/json", {"application/json", "text/html"}},
  1086. };
  1087. for (const auto &c : cases) {
  1088. std::vector<std::string> result;
  1089. EXPECT_TRUE(detail::parse_accept_header(c.value, result))
  1090. << "value: " << c.value;
  1091. EXPECT_EQ(c.expected, result) << "value: " << c.value;
  1092. }
  1093. // An invalid entry is still rejected when empty elements surround it
  1094. std::vector<std::string> result;
  1095. EXPECT_FALSE(detail::parse_accept_header(",invalidtype,", result));
  1096. }
  1097. // RFC 9110 Section 5.6.6: a parameter value may be a quoted-string, and a ','
  1098. // or ';' inside one does not end the list element or the parameter. Section
  1099. // 5.6.4: nor does a '"' that a backslash escapes end the quoted-string.
  1100. TEST(ParseAcceptHeaderTest, DelimitersInQuotedParameterValues) {
  1101. struct {
  1102. const char *value;
  1103. std::vector<std::string> expected;
  1104. } cases[] = {
  1105. {"text/html;profile=\"a,b\",application/json",
  1106. {"text/html", "application/json"}},
  1107. // A "q=" inside a quoted value is not the weight
  1108. {"text/html;profile=\"a;q=0.1\",application/json;q=0.5",
  1109. {"text/html", "application/json"}},
  1110. // The weight after a quoted value still applies
  1111. {"text/html;profile=\"a,b;q=0.1\";q=0.8,application/json;q=0.9",
  1112. {"application/json", "text/html"}},
  1113. {"text/html;profile=\"a\\\",b\";q=0.8,application/json;q=0.9",
  1114. {"application/json", "text/html"}},
  1115. {"text/html;profile=\"a\\\"b\",application/json",
  1116. {"text/html", "application/json"}},
  1117. // An escaped backslash does not escape the '"' after it
  1118. {"text/html;profile=\"a\\\\\",application/json",
  1119. {"text/html", "application/json"}},
  1120. };
  1121. for (const auto &c : cases) {
  1122. std::vector<std::string> result;
  1123. EXPECT_TRUE(detail::parse_accept_header(c.value, result))
  1124. << "value: " << c.value;
  1125. EXPECT_EQ(c.expected, result) << "value: " << c.value;
  1126. }
  1127. }
  1128. TEST(ParseAcceptHeaderTest, ContentTypesPopulatedAndInvalidHeaderHandling) {
  1129. Server svr;
  1130. svr.Get("/accept_ok", [&](const Request &req, Response &res) {
  1131. EXPECT_EQ(req.accept_content_types.size(), 3U);
  1132. EXPECT_EQ(req.accept_content_types[0], "application/json");
  1133. EXPECT_EQ(req.accept_content_types[1], "text/html");
  1134. EXPECT_EQ(req.accept_content_types[2], "*/*");
  1135. res.set_content("ok", "text/plain");
  1136. });
  1137. svr.Get("/accept_bad_request", [&](const Request & /*req*/, Response &res) {
  1138. EXPECT_TRUE(false);
  1139. res.set_content("bad request", "text/plain");
  1140. });
  1141. auto listen_thread = std::thread([&svr]() { svr.listen("localhost", PORT); });
  1142. auto se = detail::scope_exit([&] {
  1143. svr.stop();
  1144. listen_thread.join();
  1145. ASSERT_FALSE(svr.is_running());
  1146. });
  1147. svr.wait_until_ready();
  1148. Client cli("localhost", PORT);
  1149. {
  1150. auto res = cli.Get(
  1151. "/accept_ok",
  1152. Headers{{"Accept", "application/json, text/html;q=0.8, */*;q=0.1"}});
  1153. ASSERT_TRUE(res) << "Error: " << to_string(res.error());
  1154. EXPECT_EQ(StatusCode::OK_200, res->status);
  1155. }
  1156. {
  1157. auto res = cli.Get("/accept_bad_request",
  1158. Headers{{"Accept", "text/html;q=abc,application/json"}});
  1159. ASSERT_TRUE(res) << "Error: " << to_string(res.error());
  1160. EXPECT_EQ(StatusCode::BadRequest_400, res->status);
  1161. }
  1162. }
  1163. TEST(ServerStartHandlerTest, CalledOnceWhenReady) {
  1164. Server svr;
  1165. svr.Get("/", [](const Request & /*req*/, Response &res) {
  1166. res.set_content("ok", "text/plain");
  1167. });
  1168. std::atomic<int> start_count{0};
  1169. std::atomic<bool> running_when_called{false};
  1170. svr.set_start_handler([&]() {
  1171. running_when_called = svr.is_running();
  1172. start_count++;
  1173. });
  1174. auto port = svr.bind_to_any_port(HOST);
  1175. std::thread t([&]() { svr.listen_after_bind(); });
  1176. auto se = detail::scope_exit([&] {
  1177. svr.stop();
  1178. t.join();
  1179. ASSERT_FALSE(svr.is_running());
  1180. });
  1181. svr.wait_until_ready();
  1182. // A successful request proves the accept loop is running, which the start
  1183. // handler precedes; so by now the handler must have run exactly once.
  1184. Client cli(HOST, port);
  1185. cli.set_connection_timeout(std::chrono::seconds(5));
  1186. auto res = cli.Get("/");
  1187. ASSERT_TRUE(res) << "Error: " << to_string(res.error());
  1188. EXPECT_EQ(StatusCode::OK_200, res->status);
  1189. EXPECT_EQ(1, start_count.load());
  1190. EXPECT_TRUE(running_when_called.load());
  1191. }
  1192. TEST(DivideTest, DivideStringTests) {
  1193. auto divide = [](const std::string &str, char d) {
  1194. std::string lhs;
  1195. std::string rhs;
  1196. detail::divide(str, d,
  1197. [&](const char *lhs_data, std::size_t lhs_size,
  1198. const char *rhs_data, std::size_t rhs_size) {
  1199. lhs.assign(lhs_data, lhs_size);
  1200. rhs.assign(rhs_data, rhs_size);
  1201. });
  1202. return std::make_pair(std::move(lhs), std::move(rhs));
  1203. };
  1204. {
  1205. const auto res = divide("", '=');
  1206. EXPECT_EQ(res.first, "");
  1207. EXPECT_EQ(res.second, "");
  1208. }
  1209. {
  1210. const auto res = divide("=", '=');
  1211. EXPECT_EQ(res.first, "");
  1212. EXPECT_EQ(res.second, "");
  1213. }
  1214. {
  1215. const auto res = divide(" ", '=');
  1216. EXPECT_EQ(res.first, " ");
  1217. EXPECT_EQ(res.second, "");
  1218. }
  1219. {
  1220. const auto res = divide("a", '=');
  1221. EXPECT_EQ(res.first, "a");
  1222. EXPECT_EQ(res.second, "");
  1223. }
  1224. {
  1225. const auto res = divide("a=", '=');
  1226. EXPECT_EQ(res.first, "a");
  1227. EXPECT_EQ(res.second, "");
  1228. }
  1229. {
  1230. const auto res = divide("=b", '=');
  1231. EXPECT_EQ(res.first, "");
  1232. EXPECT_EQ(res.second, "b");
  1233. }
  1234. {
  1235. const auto res = divide("a=b", '=');
  1236. EXPECT_EQ(res.first, "a");
  1237. EXPECT_EQ(res.second, "b");
  1238. }
  1239. {
  1240. const auto res = divide("a=b=", '=');
  1241. EXPECT_EQ(res.first, "a");
  1242. EXPECT_EQ(res.second, "b=");
  1243. }
  1244. {
  1245. const auto res = divide("a=b=c", '=');
  1246. EXPECT_EQ(res.first, "a");
  1247. EXPECT_EQ(res.second, "b=c");
  1248. }
  1249. }
  1250. TEST(SplitTest, ParseQueryString) {
  1251. string s = "key1=val1&key2=val2&key3=val3";
  1252. Params dic;
  1253. detail::split(s.c_str(), s.c_str() + s.size(), '&',
  1254. [&](const char *b, const char *e) {
  1255. string key, val;
  1256. detail::split(b, e, '=', [&](const char *b2, const char *e2) {
  1257. if (key.empty()) {
  1258. key.assign(b2, e2);
  1259. } else {
  1260. val.assign(b2, e2);
  1261. }
  1262. });
  1263. dic.emplace(key, val);
  1264. });
  1265. EXPECT_EQ("val1", dic.find("key1")->second);
  1266. EXPECT_EQ("val2", dic.find("key2")->second);
  1267. EXPECT_EQ("val3", dic.find("key3")->second);
  1268. }
  1269. TEST(SplitTest, ParseInvalidQueryTests) {
  1270. {
  1271. string s = " ";
  1272. Params dict;
  1273. detail::parse_query_text(s, dict);
  1274. EXPECT_TRUE(dict.empty());
  1275. }
  1276. {
  1277. string s = " = =";
  1278. Params dict;
  1279. detail::parse_query_text(s, dict);
  1280. EXPECT_TRUE(dict.empty());
  1281. }
  1282. }
  1283. TEST(ParseQueryTest, ParseQueryString) {
  1284. {
  1285. std::string s = "key1=val1&key2=val2&key3=val3";
  1286. Params dic;
  1287. detail::parse_query_text(s, dic);
  1288. EXPECT_EQ("val1", dic.find("key1")->second);
  1289. EXPECT_EQ("val2", dic.find("key2")->second);
  1290. EXPECT_EQ("val3", dic.find("key3")->second);
  1291. }
  1292. {
  1293. std::string s = "key1&key2=val1&key3=val1=val2&key4=val1=val2=val3";
  1294. Params dic;
  1295. detail::parse_query_text(s, dic);
  1296. EXPECT_EQ("", dic.find("key1")->second);
  1297. EXPECT_EQ("val1", dic.find("key2")->second);
  1298. EXPECT_EQ("val1=val2", dic.find("key3")->second);
  1299. EXPECT_EQ("val1=val2=val3", dic.find("key4")->second);
  1300. }
  1301. }
  1302. TEST(ParamsToQueryTest, ConvertParamsToQuery) {
  1303. Params dic;
  1304. EXPECT_EQ(detail::params_to_query_str(dic), "");
  1305. dic.emplace("key1", "val1");
  1306. EXPECT_EQ(detail::params_to_query_str(dic), "key1=val1");
  1307. dic.emplace("key2", "val2");
  1308. dic.emplace("key3", "val3");
  1309. EXPECT_EQ(detail::params_to_query_str(dic), "key1=val1&key2=val2&key3=val3");
  1310. }
  1311. TEST(AppendQueryParamsTest, JoinsAnExistingQuery) {
  1312. Params params;
  1313. params.emplace("a", "1");
  1314. EXPECT_EQ("/p?a=1", append_query_params("/p", params));
  1315. EXPECT_EQ("/p?x=0&a=1", append_query_params("/p?x=0", params));
  1316. EXPECT_EQ("/p?&a=1", append_query_params("/p?", params));
  1317. EXPECT_EQ("?x=0&a=1", append_query_params("?x=0", params));
  1318. // Long enough to overflow the stack when matched with std::regex.
  1319. auto long_query = std::string(CPPHTTPLIB_MAX_LINE_LENGTH, 'x');
  1320. EXPECT_EQ("/p?" + long_query + "&a=1",
  1321. append_query_params("/p?" + long_query, params));
  1322. }
  1323. // Joins every entry of a Headers or Params into "key=value " so a whole
  1324. // traversal can be compared in one assertion. Both are instantiations of the
  1325. // same insertion-ordered container, so one helper serves both.
  1326. template <typename Map> static std::string entries_to_string(const Map &m) {
  1327. std::string s;
  1328. for (const auto &entry : m) {
  1329. s += entry.first + "=" + entry.second + " ";
  1330. }
  1331. return s;
  1332. }
  1333. TEST(ParamsOrderTest, QueryIsBuiltInInsertionOrderNotSorted) {
  1334. // Params used to be a std::multimap, which sorted by name and handed the
  1335. // caller's query back alphabetised. A client signing its query string could
  1336. // not reproduce the order it asked for.
  1337. Params dic;
  1338. dic.emplace("zulu", "1");
  1339. dic.emplace("alpha", "2");
  1340. dic.emplace("mike", "3");
  1341. EXPECT_EQ("zulu=1&alpha=2&mike=3", detail::params_to_query_str(dic));
  1342. EXPECT_EQ("/p?zulu=1&alpha=2&mike=3", append_query_params("/p", dic));
  1343. }
  1344. TEST(ParamsOrderTest, ParsingKeepsTheOrderReceived) {
  1345. Params dic;
  1346. detail::parse_query_text("zulu=1&alpha=2&mike=3", dic);
  1347. EXPECT_EQ("zulu=1 alpha=2 mike=3 ", entries_to_string(dic));
  1348. }
  1349. TEST(ParamsOrderTest, RepeatedNamesKeepTheirOrder) {
  1350. Request req;
  1351. detail::parse_query_text("tag=first&other=x&tag=second&tag=third",
  1352. req.params);
  1353. EXPECT_EQ(3U, req.get_param_value_count("tag"));
  1354. EXPECT_EQ("first", req.get_param_value("tag"));
  1355. EXPECT_EQ("first", req.get_param_value("tag", 0));
  1356. EXPECT_EQ("second", req.get_param_value("tag", 1));
  1357. EXPECT_EQ("third", req.get_param_value("tag", 2));
  1358. EXPECT_EQ("", req.get_param_value("tag", 3));
  1359. }
  1360. TEST(ParamsOrderTest, LookupStaysCaseSensitive) {
  1361. // Params shares its container with Headers, which matches field names
  1362. // case-insensitively. Parameter names must not pick that up.
  1363. Params dic;
  1364. dic.emplace("Key", "upper");
  1365. dic.emplace("key", "lower");
  1366. EXPECT_EQ(2U, dic.size());
  1367. EXPECT_EQ(1U, dic.count("Key"));
  1368. EXPECT_EQ(1U, dic.count("key"));
  1369. EXPECT_EQ("upper", dic.find("Key")->second);
  1370. EXPECT_EQ("lower", dic.find("key")->second);
  1371. EXPECT_TRUE(dic.find("KEY") == dic.end());
  1372. }
  1373. TEST(ParamsOrderTest, ServerSeesTheOrderTheClientSent) {
  1374. Server svr;
  1375. std::string order;
  1376. svr.Get("/order", [&](const Request &req, Response &res) {
  1377. order = entries_to_string(req.params);
  1378. res.set_content("ok", "text/plain");
  1379. });
  1380. auto port = svr.bind_to_any_port(HOST);
  1381. thread t = thread([&] { svr.listen_after_bind(); });
  1382. auto se = detail::scope_exit([&] {
  1383. svr.stop();
  1384. t.join();
  1385. ASSERT_FALSE(svr.is_running());
  1386. });
  1387. svr.wait_until_ready();
  1388. Client cli(HOST, port);
  1389. auto res = cli.Get("/order?zulu=1&alpha=2&tag=x&mike=3&tag=y");
  1390. ASSERT_TRUE(res);
  1391. EXPECT_EQ("zulu=1 alpha=2 tag=x mike=3 tag=y ", order);
  1392. }
  1393. TEST(MultipartOrderTest, PartsKeepTheOrderSent) {
  1394. Server svr;
  1395. std::string field_order, file_order;
  1396. svr.Post("/order", [&](const Request &req, Response &res) {
  1397. for (const auto &field : req.form.fields) {
  1398. field_order += field.first + "=" + field.second.content + " ";
  1399. }
  1400. for (const auto &file : req.form.files) {
  1401. file_order += file.first + "=" + file.second.filename + " ";
  1402. }
  1403. res.set_content("ok", "text/plain");
  1404. });
  1405. auto port = svr.bind_to_any_port(HOST);
  1406. thread t = thread([&] { svr.listen_after_bind(); });
  1407. auto se = detail::scope_exit([&] {
  1408. svr.stop();
  1409. t.join();
  1410. ASSERT_FALSE(svr.is_running());
  1411. });
  1412. svr.wait_until_ready();
  1413. UploadFormDataItems items = {
  1414. {"zulu", "1", "", ""},
  1415. {"alpha", "2", "", ""},
  1416. {"mike", "3", "", ""},
  1417. {"zebra", "z", "z.txt", "text/plain"},
  1418. {"apple", "a", "a.txt", "text/plain"},
  1419. };
  1420. Client cli(HOST, port);
  1421. auto res = cli.Post("/order", items);
  1422. ASSERT_TRUE(res);
  1423. EXPECT_EQ("zulu=1 alpha=2 mike=3 ", field_order);
  1424. EXPECT_EQ("zebra=z.txt apple=a.txt ", file_order);
  1425. }
  1426. TEST(MultipartOrderTest, RepeatedNamesKeepTheirOrder) {
  1427. Server svr;
  1428. std::vector<std::string> values;
  1429. std::string first, second, out_of_range, order;
  1430. svr.Post("/repeated", [&](const Request &req, Response &res) {
  1431. values = req.form.get_fields("tag");
  1432. first = req.form.get_field("tag", 0);
  1433. second = req.form.get_field("tag", 1);
  1434. out_of_range = req.form.get_field("tag", 2);
  1435. for (const auto &field : req.form.fields) {
  1436. order += field.first + "=" + field.second.content + " ";
  1437. }
  1438. res.set_content("ok", "text/plain");
  1439. });
  1440. auto port = svr.bind_to_any_port(HOST);
  1441. thread t = thread([&] { svr.listen_after_bind(); });
  1442. auto se = detail::scope_exit([&] {
  1443. svr.stop();
  1444. t.join();
  1445. ASSERT_FALSE(svr.is_running());
  1446. });
  1447. svr.wait_until_ready();
  1448. // "other" sits between the two "tag" parts, so the entries sharing a name are
  1449. // not adjacent in the container.
  1450. UploadFormDataItems items = {
  1451. {"tag", "first", "", ""},
  1452. {"other", "x", "", ""},
  1453. {"tag", "second", "", ""},
  1454. };
  1455. Client cli(HOST, port);
  1456. auto res = cli.Post("/repeated", items);
  1457. ASSERT_TRUE(res);
  1458. ASSERT_EQ(2U, values.size());
  1459. EXPECT_EQ("first", values[0]);
  1460. EXPECT_EQ("second", values[1]);
  1461. EXPECT_EQ("first", first);
  1462. EXPECT_EQ("second", second);
  1463. // std::multimap already kept entries sharing a name in insertion order, so
  1464. // everything above passes without this change too. The whole traversal is
  1465. // what tells the two apart: sorting by name would hoist "other" to the front
  1466. // and the two "tag" parts would end up adjacent.
  1467. EXPECT_EQ("tag=first other=x tag=second ", order);
  1468. // Advancing past the last entry of a name used to run off the container;
  1469. // the container's saturating increment makes it return the default instead.
  1470. EXPECT_EQ("", out_of_range);
  1471. }
  1472. TEST(MultipartFormDataTest, BackslashesInNamesSurvive) {
  1473. Server svr;
  1474. std::string file_names;
  1475. svr.Post("/upload", [&](const Request &req, Response &res) {
  1476. for (const auto &file : req.form.files) {
  1477. file_names += file.first + "|" + file.second.filename + " ";
  1478. }
  1479. res.set_content("ok", "text/plain");
  1480. });
  1481. auto port = svr.bind_to_any_port(HOST);
  1482. thread t = thread([&] { svr.listen_after_bind(); });
  1483. auto se = detail::scope_exit([&] {
  1484. svr.stop();
  1485. t.join();
  1486. ASSERT_FALSE(svr.is_running());
  1487. });
  1488. svr.wait_until_ready();
  1489. // A trailing backslash would otherwise escape the closing quote.
  1490. UploadFormDataItems items = {
  1491. {"dir\\", "x", "a.txt", "text/plain"},
  1492. {"b", "y", "a\\\\b.txt", "text/plain"},
  1493. };
  1494. Client cli(HOST, port);
  1495. auto res = cli.Post("/upload", items);
  1496. ASSERT_TRUE(res);
  1497. EXPECT_EQ("dir\\|a.txt b|a\\\\b.txt ", file_names);
  1498. }
  1499. TEST(MultipartOrderTest, ContentSurvivesContainerGrowth) {
  1500. // Server::read_content() keeps a FormFields::iterator alive across the
  1501. // content callbacks that fill the part it points at. The container is
  1502. // vector-backed, so a later emplace can reallocate and invalidate an older
  1503. // iterator; 64 parts grow the vector through seven reallocations, which
  1504. // checks that every part's content still lands in its own entry.
  1505. const size_t part_count = 64;
  1506. // One formula for both the parts sent and the values expected back, so the
  1507. // two cannot drift apart.
  1508. auto name_of = [](size_t i) { return "f" + std::to_string(i); };
  1509. auto content_of = [](size_t i) {
  1510. return std::string(64, static_cast<char>('a' + (i % 26)));
  1511. };
  1512. Server svr;
  1513. std::vector<std::pair<std::string, std::string>> received;
  1514. svr.Post("/many", [&](const Request &req, Response &res) {
  1515. for (const auto &field : req.form.fields) {
  1516. received.emplace_back(field.first, field.second.content);
  1517. }
  1518. res.set_content("ok", "text/plain");
  1519. });
  1520. auto port = svr.bind_to_any_port(HOST);
  1521. thread t = thread([&] { svr.listen_after_bind(); });
  1522. auto se = detail::scope_exit([&] {
  1523. svr.stop();
  1524. t.join();
  1525. ASSERT_FALSE(svr.is_running());
  1526. });
  1527. svr.wait_until_ready();
  1528. UploadFormDataItems items;
  1529. for (size_t i = 0; i < part_count; i++) {
  1530. items.push_back({name_of(i), content_of(i), "", ""});
  1531. }
  1532. Client cli(HOST, port);
  1533. auto res = cli.Post("/many", items);
  1534. ASSERT_TRUE(res);
  1535. ASSERT_EQ(part_count, received.size());
  1536. for (size_t i = 0; i < part_count; i++) {
  1537. EXPECT_EQ(name_of(i), received[i].first) << "part " << i;
  1538. EXPECT_EQ(content_of(i), received[i].second) << "part " << i;
  1539. }
  1540. }
  1541. TEST(ParseMultipartBoundaryTest, DefaultValue) {
  1542. string content_type = "multipart/form-data; boundary=something";
  1543. string boundary;
  1544. auto ret = detail::parse_multipart_boundary(content_type, boundary);
  1545. EXPECT_TRUE(ret);
  1546. EXPECT_EQ(boundary, "something");
  1547. }
  1548. TEST(ParseMultipartBoundaryTest, ValueWithQuote) {
  1549. string content_type = "multipart/form-data; boundary=\"gc0pJq0M:08jU534c0p\"";
  1550. string boundary;
  1551. auto ret = detail::parse_multipart_boundary(content_type, boundary);
  1552. EXPECT_TRUE(ret);
  1553. EXPECT_EQ(boundary, "gc0pJq0M:08jU534c0p");
  1554. }
  1555. TEST(ParseMultipartBoundaryTest, ValueWithCharset) {
  1556. string content_type =
  1557. "multipart/mixed; boundary=THIS_STRING_SEPARATES;charset=UTF-8";
  1558. string boundary;
  1559. auto ret = detail::parse_multipart_boundary(content_type, boundary);
  1560. EXPECT_TRUE(ret);
  1561. EXPECT_EQ(boundary, "THIS_STRING_SEPARATES");
  1562. }
  1563. TEST(ParseMultipartBoundaryTest, ValueWithQuotesAndCharset) {
  1564. string content_type =
  1565. "multipart/mixed; boundary=\"cpp-httplib-multipart-data\"; charset=UTF-8";
  1566. string boundary;
  1567. auto ret = detail::parse_multipart_boundary(content_type, boundary);
  1568. EXPECT_TRUE(ret);
  1569. EXPECT_EQ(boundary, "cpp-httplib-multipart-data");
  1570. }
  1571. TEST(ParseMultipartBoundaryTest, LongestAllowedValue) {
  1572. const string boundary(70, 'a');
  1573. string content_type = "multipart/form-data; boundary=" + boundary;
  1574. string parsed;
  1575. auto ret = detail::parse_multipart_boundary(content_type, parsed);
  1576. EXPECT_TRUE(ret);
  1577. EXPECT_EQ(parsed, boundary);
  1578. }
  1579. TEST(ParseMultipartBoundaryTest, ValueLongerThanRFCLimit) {
  1580. // RFC 2046 5.1.1 caps a boundary at 70 characters.
  1581. string content_type = "multipart/form-data; boundary=" + string(71, 'a');
  1582. string parsed;
  1583. auto ret = detail::parse_multipart_boundary(content_type, parsed);
  1584. EXPECT_FALSE(ret);
  1585. }
  1586. TEST(ParseMultipartBoundaryTest, QuotedValueIsMeasuredAfterUnquoting) {
  1587. // The limit applies to the unquoted value, so a quoted 70 character boundary
  1588. // is 72 characters on the wire and still valid.
  1589. const string boundary(70, 'a');
  1590. string content_type = "multipart/form-data; boundary=\"" + boundary + "\"";
  1591. string parsed;
  1592. EXPECT_TRUE(detail::parse_multipart_boundary(content_type, parsed));
  1593. EXPECT_EQ(parsed, boundary);
  1594. content_type = "multipart/form-data; boundary=\"" + string(71, 'a') + "\"";
  1595. parsed.clear();
  1596. EXPECT_FALSE(detail::parse_multipart_boundary(content_type, parsed));
  1597. }
  1598. TEST(ParseMultipartBoundaryTest, QuotedValueWithEqualsSign) {
  1599. // RFC 2046 5.1.1 allows '=' in a boundary, so a MIME sender has to quote it.
  1600. // The parameter parser must not treat that '=' as the key/value separator.
  1601. string content_type =
  1602. "multipart/mixed; boundary=\"----=_NextPart_000_0000_01D9\"; "
  1603. "charset=UTF-8";
  1604. string parsed;
  1605. EXPECT_TRUE(detail::parse_multipart_boundary(content_type, parsed));
  1606. EXPECT_EQ(parsed, "----=_NextPart_000_0000_01D9");
  1607. }
  1608. TEST(ParseMultipartBoundaryTest, QuotedValueWithSemicolon) {
  1609. // A ';' inside the quoted-string is part of the value, not a parameter
  1610. // separator, so it must not truncate the boundary.
  1611. string content_type = "multipart/mixed; boundary=\"a;b\"; charset=UTF-8";
  1612. string parsed;
  1613. EXPECT_TRUE(detail::parse_multipart_boundary(content_type, parsed));
  1614. EXPECT_EQ(parsed, "a;b");
  1615. }
  1616. TEST(ParseMultipartBoundaryTest, QuotedPairsAreUnescaped) {
  1617. string parsed;
  1618. EXPECT_TRUE(detail::parse_multipart_boundary(
  1619. "multipart/form-data; boundary=\"a\\\\b\"", parsed));
  1620. EXPECT_EQ("a\\b", parsed);
  1621. EXPECT_TRUE(detail::parse_multipart_boundary(
  1622. "multipart/form-data; boundary=\"a\\\"b\"", parsed));
  1623. EXPECT_EQ("a\"b", parsed);
  1624. }
  1625. TEST(ParseDispositionParamsTest, QuotedValues) {
  1626. // RFC 9110 Section 5.6.6: a parameter value may be a quoted-string, and
  1627. // ';' and '=' are ordinary characters inside one.
  1628. struct {
  1629. const char *value;
  1630. std::vector<std::pair<const char *, const char *>> expected;
  1631. } cases[] = {
  1632. {"name=\"file1\"; filename=\"a.txt\"",
  1633. {{"name", "file1"}, {"filename", "a.txt"}}},
  1634. // Whitespace around '=' and ';' is still trimmed
  1635. {"name=\"file2\" ;filename = \"a.html\"",
  1636. {{"name", "file2"}, {"filename", "a.html"}}},
  1637. // '=' inside the value used to leave only the text after the last one
  1638. {"name=\"file1\"; filename=\"report=v2.pdf\"",
  1639. {{"name", "file1"}, {"filename", "report=v2.pdf"}}},
  1640. {"name=\"x=y\"", {{"name", "x=y"}}},
  1641. // ';' inside the value used to truncate the pair and leave a bogus one
  1642. {"name=\"file3\"; filename=\"a;b.txt\"",
  1643. {{"name", "file3"}, {"filename", "a;b.txt"}}},
  1644. // An unquoted value keeps working, and so does filename*
  1645. {"filename*=UTF-8''%41.txt; filename=\"a.txt\"",
  1646. {{"filename*", "UTF-8''%41.txt"}, {"filename", "a.txt"}}},
  1647. // A parameter with no key is dropped rather than turned into one whose
  1648. // key is the value
  1649. {"=nokey; name=\"file5\"", {{"name", "file5"}}},
  1650. // An escaped quote does not end the value
  1651. {"name=\"a\\\"; filename=evil.php\"",
  1652. {{"name", "a\"; filename=evil.php"}}},
  1653. // Other backslashes, as in a Windows path, are kept
  1654. {"name=\"f\"; filename=\"C:\\dir\\a.txt\"",
  1655. {{"name", "f"}, {"filename", "C:\\dir\\a.txt"}}},
  1656. };
  1657. for (const auto &c : cases) {
  1658. Params params;
  1659. detail::parse_disposition_params(c.value, params);
  1660. for (const auto &kv : c.expected) {
  1661. auto it = params.find(kv.first);
  1662. ASSERT_NE(it, params.end())
  1663. << "value: " << c.value << ", key: " << kv.first;
  1664. EXPECT_EQ(kv.second, it->second) << "value: " << c.value;
  1665. }
  1666. EXPECT_EQ(c.expected.size(), params.size()) << "value: " << c.value;
  1667. }
  1668. }
  1669. TEST(MultipartFormDataTest, PartArrivingAByteAtATime) {
  1670. Server svr;
  1671. std::string filename;
  1672. std::string content;
  1673. svr.Post("/upload", [&](const Request &req, Response &) {
  1674. const auto &file = req.form.get_file("file");
  1675. filename = file.filename;
  1676. content = file.content;
  1677. });
  1678. auto thread = std::thread([&]() { svr.listen(HOST, PORT); });
  1679. auto se = detail::scope_exit([&] {
  1680. svr.stop();
  1681. thread.join();
  1682. ASSERT_FALSE(svr.is_running());
  1683. });
  1684. svr.wait_until_ready();
  1685. std::string body = "--B\r\n"
  1686. "Content-Disposition: form-data; name=\"file\"; "
  1687. "filename=\"a.txt\"\r\n"
  1688. "Content-Type: text/plain\r\n"
  1689. "\r\n"
  1690. "hello\r\n"
  1691. "--B--\r\n";
  1692. Client cli(HOST, PORT);
  1693. auto res = cli.Post(
  1694. "/upload",
  1695. [&](size_t offset, DataSink &sink) {
  1696. if (offset < body.size()) {
  1697. sink.write(&body[offset], 1);
  1698. } else {
  1699. sink.done();
  1700. }
  1701. return true;
  1702. },
  1703. "multipart/form-data; boundary=B");
  1704. ASSERT_TRUE(res) << "Error: " << to_string(res.error());
  1705. EXPECT_EQ(StatusCode::OK_200, res->status);
  1706. EXPECT_EQ("a.txt", filename);
  1707. EXPECT_EQ("hello", content);
  1708. }
  1709. TEST(ParseDispositionParamsTest, QuotedValuesSurviveTheRoundTrip) {
  1710. // escape_multipart_field() only escapes '"', CR and LF, so a name or
  1711. // filename holding '=' or ';' reaches the server's parameter parser as is.
  1712. Server svr;
  1713. std::string field_value, file_name, file_filename;
  1714. bool has_field = false, has_file = false;
  1715. svr.Post("/quoted", [&](const Request &req, Response &res) {
  1716. has_field = req.form.has_field("x=y");
  1717. field_value = req.form.get_field("x=y");
  1718. has_file = req.form.has_file("file1");
  1719. const auto &file = req.form.get_file("file1");
  1720. file_name = file.name;
  1721. file_filename = file.filename;
  1722. res.set_content("ok", "text/plain");
  1723. });
  1724. auto port = svr.bind_to_any_port(HOST);
  1725. thread t = thread([&] { svr.listen_after_bind(); });
  1726. auto se = detail::scope_exit([&] {
  1727. svr.stop();
  1728. t.join();
  1729. ASSERT_FALSE(svr.is_running());
  1730. });
  1731. svr.wait_until_ready();
  1732. UploadFormDataItems items = {
  1733. {"x=y", "field-value", "", ""},
  1734. {"file1", "pdf-bytes", "a;b=report.pdf", "application/pdf"},
  1735. };
  1736. Client cli(HOST, port);
  1737. auto res = cli.Post("/quoted", items);
  1738. ASSERT_TRUE(res) << "Error: " << to_string(res.error());
  1739. ASSERT_EQ(StatusCode::OK_200, res->status);
  1740. EXPECT_TRUE(has_field);
  1741. EXPECT_EQ("field-value", field_value);
  1742. EXPECT_TRUE(has_file);
  1743. EXPECT_EQ("file1", file_name);
  1744. EXPECT_EQ("a;b=report.pdf", file_filename);
  1745. }
  1746. TEST(GetHeaderValueTest, DefaultValue) {
  1747. Headers headers = {{"Dummy", "Dummy"}};
  1748. auto val = detail::get_header_value(headers, "Content-Type", "text/plain", 0);
  1749. EXPECT_STREQ("text/plain", val);
  1750. }
  1751. TEST(GetHeaderValueTest, DefaultValueInt) {
  1752. Headers headers = {{"Dummy", "Dummy"}};
  1753. auto val = detail::get_header_value_u64(headers, "Content-Length", 100, 0);
  1754. EXPECT_EQ(100ull, val);
  1755. }
  1756. TEST(GetHeaderValueTest, RegularValue) {
  1757. Headers headers = {{"Content-Type", "text/html"}, {"Dummy", "Dummy"}};
  1758. auto val = detail::get_header_value(headers, "Content-Type", "text/plain", 0);
  1759. EXPECT_STREQ("text/html", val);
  1760. }
  1761. TEST(GetHeaderValueTest, RegularValueWithDifferentCase) {
  1762. Headers headers = {{"Content-Type", "text/html"}, {"Dummy", "Dummy"}};
  1763. auto val = detail::get_header_value(headers, "content-type", "text/plain", 0);
  1764. EXPECT_STREQ("text/html", val);
  1765. }
  1766. TEST(GetHeaderValueTest, SetContent) {
  1767. Response res;
  1768. res.set_content("html", "text/html");
  1769. EXPECT_EQ("text/html", res.get_header_value("Content-Type"));
  1770. res.set_content("text", "text/plain");
  1771. EXPECT_EQ(1U, res.get_header_value_count("Content-Type"));
  1772. EXPECT_EQ("text/plain", res.get_header_value("Content-Type"));
  1773. }
  1774. TEST(GetHeaderValueTest, RegularValueInt) {
  1775. Headers headers = {{"Content-Length", "100"}, {"Dummy", "Dummy"}};
  1776. auto val = detail::get_header_value_u64(headers, "Content-Length", 0, 0);
  1777. EXPECT_EQ(100ull, val);
  1778. }
  1779. TEST(GetHeaderValueTest, RegularInvalidValueInt) {
  1780. Headers headers = {{"Content-Length", "x"}};
  1781. auto is_invalid_value = false;
  1782. auto val = detail::get_header_value_u64(headers, "Content-Length", 0, 0,
  1783. is_invalid_value);
  1784. EXPECT_EQ(0ull, val);
  1785. EXPECT_TRUE(is_invalid_value);
  1786. }
  1787. TEST(GetHeaderValueTest, OutOfRangeValueInt) {
  1788. // An all-digit value that overflows size_t must be reported as invalid, not
  1789. // silently saturated/truncated: parsing at size_t width would otherwise wrap
  1790. // a large length to a small one on 32-bit builds, leaving the framing length
  1791. // wrong while is_invalid_value stayed false.
  1792. Headers headers = {{"Content-Length", "99999999999999999999999999"}};
  1793. auto is_invalid_value = false;
  1794. detail::get_header_value_u64(headers, "Content-Length", 0, 0,
  1795. is_invalid_value);
  1796. EXPECT_TRUE(is_invalid_value);
  1797. // A well-formed length is unaffected.
  1798. Headers ok = {{"Content-Length", "1234"}};
  1799. is_invalid_value = false;
  1800. auto val = detail::get_header_value_u64(ok, "Content-Length", 0, 0,
  1801. is_invalid_value);
  1802. EXPECT_EQ(1234ull, val);
  1803. EXPECT_FALSE(is_invalid_value);
  1804. }
  1805. TEST(GetHeaderValueTest, Range) {
  1806. {
  1807. Headers headers = {make_range_header({{1, -1}})};
  1808. auto val = detail::get_header_value(headers, "Range", 0, 0);
  1809. EXPECT_STREQ("bytes=1-", val);
  1810. }
  1811. {
  1812. Headers headers = {make_range_header({{-1, 1}})};
  1813. auto val = detail::get_header_value(headers, "Range", 0, 0);
  1814. EXPECT_STREQ("bytes=-1", val);
  1815. }
  1816. {
  1817. Headers headers = {make_range_header({{1, 10}})};
  1818. auto val = detail::get_header_value(headers, "Range", 0, 0);
  1819. EXPECT_STREQ("bytes=1-10", val);
  1820. }
  1821. {
  1822. Headers headers = {make_range_header({{1, 10}, {100, -1}})};
  1823. auto val = detail::get_header_value(headers, "Range", 0, 0);
  1824. EXPECT_STREQ("bytes=1-10, 100-", val);
  1825. }
  1826. {
  1827. Headers headers = {make_range_header({{1, 10}, {100, 200}})};
  1828. auto val = detail::get_header_value(headers, "Range", 0, 0);
  1829. EXPECT_STREQ("bytes=1-10, 100-200", val);
  1830. }
  1831. {
  1832. Headers headers = {make_range_header({{0, 0}, {-1, 1}})};
  1833. auto val = detail::get_header_value(headers, "Range", 0, 0);
  1834. EXPECT_STREQ("bytes=0-0, -1", val);
  1835. }
  1836. }
  1837. TEST(BearerTokenAuthTest, SchemeValidation) {
  1838. // A value shorter than "Bearer " must not throw from the fixed-length
  1839. // substr, and a non-Bearer scheme must not be reported as a token.
  1840. struct {
  1841. const char *value;
  1842. const char *expected;
  1843. } cases[] = {
  1844. {"x", ""},
  1845. {"Basic QWxhZGRpbjpvcGVuIHNlc2FtZQ==", ""},
  1846. {"Bearer abc123", "abc123"},
  1847. {"bearer abc123", "abc123"}, // scheme match is case-insensitive
  1848. };
  1849. for (const auto &c : cases) {
  1850. Request req;
  1851. req.set_header("Authorization", c.value);
  1852. EXPECT_EQ(c.expected, get_bearer_token_auth(req)) << "value: " << c.value;
  1853. }
  1854. }
  1855. TEST(HeadersOrderTest, DuplicateFieldsKeepInsertionOrder) {
  1856. // RFC 9110 5.3: the order of fields sharing a name is significant. This used
  1857. // to depend on the standard library (libstdc++ handed back duplicates in
  1858. // reverse insertion order, libc++ in insertion order).
  1859. Request req;
  1860. req.set_header("Accept-Encoding", "gzip");
  1861. req.set_header("Accept-Encoding", "deflate");
  1862. req.set_header("Accept-Encoding", "br");
  1863. EXPECT_EQ(3U, req.get_header_value_count("Accept-Encoding"));
  1864. EXPECT_EQ("gzip", req.get_header_value("Accept-Encoding"));
  1865. EXPECT_EQ("gzip", req.get_header_value("Accept-Encoding", "", 0));
  1866. EXPECT_EQ("deflate", req.get_header_value("Accept-Encoding", "", 1));
  1867. EXPECT_EQ("br", req.get_header_value("Accept-Encoding", "", 2));
  1868. }
  1869. TEST(HeadersOrderTest, IdBeyondTheLastDuplicateYieldsDefault) {
  1870. Request req;
  1871. req.set_header("X-Test", "only");
  1872. EXPECT_EQ("only", req.get_header_value("X-Test", "def", 0));
  1873. EXPECT_EQ("def", req.get_header_value("X-Test", "def", 1));
  1874. EXPECT_EQ("def", req.get_header_value("X-Test", "def", 99));
  1875. EXPECT_EQ("def", req.get_header_value("X-Missing", "def", 3));
  1876. }
  1877. TEST(HeadersOrderTest, HugeIdYieldsDefault) {
  1878. Request req;
  1879. req.set_header("X-First", "1");
  1880. req.set_header("X-Test", "2");
  1881. req.params.emplace("first", "1");
  1882. req.params.emplace("test", "2");
  1883. req.form.fields.emplace("first", FormField{"first", "1", {}});
  1884. req.form.fields.emplace("test", FormField{"test", "2", {}});
  1885. req.form.files.emplace("first", FormData{"first", "1", "", "", {}});
  1886. req.form.files.emplace("test", FormData{"test", "2", "", "", {}});
  1887. // The second one is negative when read as a signed value
  1888. const auto max_id = (std::numeric_limits<size_t>::max)();
  1889. for (auto id : {max_id / 2, max_id}) {
  1890. EXPECT_EQ("def", req.get_header_value("X-Test", "def", id));
  1891. EXPECT_EQ(7U, req.get_header_value_u64("X-Test", 7, id));
  1892. EXPECT_EQ("", req.get_param_value("test", id));
  1893. EXPECT_EQ("", req.form.get_field("test", id));
  1894. EXPECT_EQ("", req.form.get_file("test", id).content);
  1895. }
  1896. }
  1897. TEST(HeadersOrderTest, TraversalFollowsInsertionOrder) {
  1898. Headers headers;
  1899. headers.emplace("Host", "example.com");
  1900. headers.emplace("Accept-Encoding", "gzip");
  1901. headers.emplace("User-Agent", "test");
  1902. headers.emplace("Accept-Encoding", "deflate");
  1903. EXPECT_EQ("Host=example.com Accept-Encoding=gzip User-Agent=test "
  1904. "Accept-Encoding=deflate ",
  1905. entries_to_string(headers));
  1906. }
  1907. TEST(HeadersOrderTest, LookupIsCaseInsensitiveAndPicksTheFirstField) {
  1908. Headers headers = {{"Content-Type", "text/html"},
  1909. {"CONTENT-TYPE", "text/xml"}};
  1910. EXPECT_EQ(2U, headers.count("content-type"));
  1911. auto it = headers.find("content-type");
  1912. ASSERT_TRUE(it != headers.end());
  1913. EXPECT_EQ("text/html", it->second);
  1914. }
  1915. TEST(HeadersOrderTest, ErasingAnEqualRangeSparesInterleavedFields) {
  1916. // The fields sharing a name are not adjacent, so an equal_range() erase must
  1917. // drop only those fields and leave everything positioned between them.
  1918. Headers headers = {{"A", "1"}, {"X", "x"}, {"A", "2"},
  1919. {"Y", "y"}, {"A", "3"}, {"Z", "z"}};
  1920. auto rng = headers.equal_range("a");
  1921. headers.erase(rng.first, rng.second);
  1922. EXPECT_EQ("X=x Y=y Z=z ", entries_to_string(headers));
  1923. }
  1924. TEST(HeadersOrderTest, ErasingByNameKeepsTheRemainingOrder) {
  1925. Headers headers = {
  1926. {"A", "1"}, {"B", "2"}, {"a", "3"}, {"C", "4"}, {"A", "5"}};
  1927. EXPECT_EQ(3U, headers.erase("A"));
  1928. EXPECT_EQ(0U, headers.count("A"));
  1929. EXPECT_EQ("B=2 C=4 ", entries_to_string(headers));
  1930. }
  1931. TEST(HeadersOrderTest, EmplaceFrontPrepends) {
  1932. Headers headers = {{"Accept", "*/*"}, {"User-Agent", "test"}};
  1933. headers.emplace_front("Host", "example.com");
  1934. EXPECT_EQ("Host=example.com Accept=*/* User-Agent=test ",
  1935. entries_to_string(headers));
  1936. }
  1937. TEST(ParseHeaderValueTest, Range) {
  1938. {
  1939. Ranges ranges;
  1940. auto ret = detail::parse_range_header("bytes=1-", ranges);
  1941. EXPECT_TRUE(ret);
  1942. EXPECT_EQ(1u, ranges.size());
  1943. EXPECT_EQ(1u, ranges[0].first);
  1944. EXPECT_EQ(-1, ranges[0].second);
  1945. }
  1946. {
  1947. Ranges ranges;
  1948. auto ret = detail::parse_range_header("bytes=-1", ranges);
  1949. EXPECT_TRUE(ret);
  1950. EXPECT_EQ(1u, ranges.size());
  1951. EXPECT_EQ(-1, ranges[0].first);
  1952. EXPECT_EQ(1u, ranges[0].second);
  1953. }
  1954. {
  1955. Ranges ranges;
  1956. auto ret = detail::parse_range_header("bytes=1-10", ranges);
  1957. EXPECT_TRUE(ret);
  1958. EXPECT_EQ(1u, ranges.size());
  1959. EXPECT_EQ(1u, ranges[0].first);
  1960. EXPECT_EQ(10u, ranges[0].second);
  1961. }
  1962. {
  1963. Ranges ranges;
  1964. auto ret = detail::parse_range_header("bytes=10-1", ranges);
  1965. EXPECT_FALSE(ret);
  1966. }
  1967. {
  1968. Ranges ranges;
  1969. auto ret = detail::parse_range_header("bytes=1-10, 100-", ranges);
  1970. EXPECT_TRUE(ret);
  1971. EXPECT_EQ(2u, ranges.size());
  1972. EXPECT_EQ(1u, ranges[0].first);
  1973. EXPECT_EQ(10u, ranges[0].second);
  1974. EXPECT_EQ(100u, ranges[1].first);
  1975. EXPECT_EQ(-1, ranges[1].second);
  1976. }
  1977. {
  1978. Ranges ranges;
  1979. auto ret =
  1980. detail::parse_range_header("bytes=1-10, 100-200, 300-400", ranges);
  1981. EXPECT_TRUE(ret);
  1982. EXPECT_EQ(3u, ranges.size());
  1983. EXPECT_EQ(1u, ranges[0].first);
  1984. EXPECT_EQ(10u, ranges[0].second);
  1985. EXPECT_EQ(100u, ranges[1].first);
  1986. EXPECT_EQ(200u, ranges[1].second);
  1987. EXPECT_EQ(300u, ranges[2].first);
  1988. EXPECT_EQ(400u, ranges[2].second);
  1989. }
  1990. {
  1991. Ranges ranges;
  1992. EXPECT_FALSE(detail::parse_range_header("bytes", ranges));
  1993. EXPECT_FALSE(detail::parse_range_header("bytes=", ranges));
  1994. EXPECT_FALSE(detail::parse_range_header("bytes=0", ranges));
  1995. EXPECT_FALSE(detail::parse_range_header("bytes=-", ranges));
  1996. EXPECT_FALSE(detail::parse_range_header("bytes= ", ranges));
  1997. EXPECT_FALSE(detail::parse_range_header("bytes=,", ranges));
  1998. EXPECT_FALSE(detail::parse_range_header("bytes=,,", ranges));
  1999. EXPECT_FALSE(detail::parse_range_header("bytes=,,,", ranges));
  2000. EXPECT_FALSE(detail::parse_range_header("bytes=a-b", ranges));
  2001. EXPECT_FALSE(detail::parse_range_header("bytes=1-0", ranges));
  2002. EXPECT_FALSE(detail::parse_range_header("bytes=0--1", ranges));
  2003. EXPECT_FALSE(detail::parse_range_header("bytes=0- 1", ranges));
  2004. EXPECT_FALSE(detail::parse_range_header("bytes=0 -1", ranges));
  2005. // Overflows ssize_t; must not be read as the suffix range "bytes=-100".
  2006. EXPECT_FALSE(
  2007. detail::parse_range_header("bytes=9223372036854775808-100", ranges));
  2008. EXPECT_TRUE(ranges.empty());
  2009. }
  2010. {
  2011. // RFC 9110 14.1.2: a last-byte-pos greater than the content length is the
  2012. // remainder of the representation, so it stays accepted.
  2013. Ranges ranges;
  2014. auto ret =
  2015. detail::parse_range_header("bytes=0-99999999999999999999", ranges);
  2016. EXPECT_TRUE(ret);
  2017. ASSERT_EQ(1u, ranges.size());
  2018. EXPECT_EQ(0, ranges[0].first);
  2019. EXPECT_EQ(-1, ranges[0].second);
  2020. }
  2021. // RFC 9110 14.1: range unit names are case-insensitive.
  2022. for (const auto &s : {"Bytes=1-10", "BYTES=1-10", "bYtEs=1-10"}) {
  2023. Ranges ranges;
  2024. EXPECT_TRUE(detail::parse_range_header(s, ranges)) << s;
  2025. EXPECT_EQ((Ranges{{1, 10}}), ranges) << s;
  2026. }
  2027. }
  2028. TEST(ParseAcceptEncoding1, AcceptEncoding) {
  2029. Request req;
  2030. req.set_header("Accept-Encoding", "gzip");
  2031. Response res;
  2032. res.set_header("Content-Type", "text/plain");
  2033. auto ret = detail::encoding_type(req, res);
  2034. #ifdef CPPHTTPLIB_ZLIB_SUPPORT
  2035. EXPECT_TRUE(ret == detail::EncodingType::Gzip);
  2036. #else
  2037. EXPECT_TRUE(ret == detail::EncodingType::None);
  2038. #endif
  2039. }
  2040. TEST(ParseAcceptEncoding2, AcceptEncoding) {
  2041. Request req;
  2042. req.set_header("Accept-Encoding", "gzip, deflate, br, zstd");
  2043. Response res;
  2044. res.set_header("Content-Type", "text/plain");
  2045. auto ret = detail::encoding_type(req, res);
  2046. #ifdef CPPHTTPLIB_BROTLI_SUPPORT
  2047. EXPECT_TRUE(ret == detail::EncodingType::Brotli);
  2048. #elif CPPHTTPLIB_ZLIB_SUPPORT
  2049. EXPECT_TRUE(ret == detail::EncodingType::Gzip);
  2050. #elif CPPHTTPLIB_ZSTD_SUPPORT
  2051. EXPECT_TRUE(ret == detail::EncodingType::Zstd);
  2052. #else
  2053. EXPECT_TRUE(ret == detail::EncodingType::None);
  2054. #endif
  2055. }
  2056. TEST(ParseAcceptEncoding3, AcceptEncoding) {
  2057. Request req;
  2058. req.set_header("Accept-Encoding",
  2059. "br;q=1.0, gzip;q=0.8, zstd;q=0.8, *;q=0.1");
  2060. Response res;
  2061. res.set_header("Content-Type", "text/plain");
  2062. auto ret = detail::encoding_type(req, res);
  2063. #ifdef CPPHTTPLIB_BROTLI_SUPPORT
  2064. EXPECT_TRUE(ret == detail::EncodingType::Brotli);
  2065. #elif CPPHTTPLIB_ZLIB_SUPPORT
  2066. EXPECT_TRUE(ret == detail::EncodingType::Gzip);
  2067. #elif CPPHTTPLIB_ZSTD_SUPPORT
  2068. EXPECT_TRUE(ret == detail::EncodingType::Zstd);
  2069. #else
  2070. EXPECT_TRUE(ret == detail::EncodingType::None);
  2071. #endif
  2072. }
  2073. TEST(ParseAcceptEncoding4, AcceptEncodingQZero) {
  2074. // All supported encodings rejected with q=0 should return None
  2075. Request req;
  2076. req.set_header("Accept-Encoding", "gzip;q=0, br;q=0, zstd;q=0, deflate");
  2077. Response res;
  2078. res.set_header("Content-Type", "text/plain");
  2079. auto ret = detail::encoding_type(req, res);
  2080. EXPECT_TRUE(ret == detail::EncodingType::None);
  2081. }
  2082. TEST(ParseAcceptEncoding5, AcceptEncodingQZeroVariants) {
  2083. // q=0.0, q=0.00, q=0.000 should also be treated as rejected
  2084. Request req;
  2085. req.set_header("Accept-Encoding", "gzip;q=0.000, br;q=0.0, zstd;q=0.00");
  2086. Response res;
  2087. res.set_header("Content-Type", "text/plain");
  2088. auto ret = detail::encoding_type(req, res);
  2089. EXPECT_TRUE(ret == detail::EncodingType::None);
  2090. }
  2091. TEST(ParseAcceptEncodingTest, RejectsTrailingQualityCharacters) {
  2092. Request req;
  2093. req.set_header("Accept-Encoding", "gzip;q=0.5junk");
  2094. Response res;
  2095. res.set_header("Content-Type", "text/plain");
  2096. EXPECT_EQ(detail::EncodingType::None, detail::encoding_type(req, res));
  2097. }
  2098. TEST(ParseAcceptEncoding6, AcceptEncodingXGzipQZero) {
  2099. // x-gzip;q=0 should not cause "gzip" to be incorrectly detected
  2100. Request req;
  2101. req.set_header("Accept-Encoding", "x-gzip;q=0");
  2102. Response res;
  2103. res.set_header("Content-Type", "text/plain");
  2104. auto ret = detail::encoding_type(req, res);
  2105. EXPECT_TRUE(ret == detail::EncodingType::None);
  2106. }
  2107. TEST(ParseAcceptEncoding7, AcceptEncodingCaseInsensitive) {
  2108. // RFC 7231: Accept-Encoding values are case-insensitive
  2109. Request req;
  2110. req.set_header("Accept-Encoding", "GZIP, BR, ZSTD");
  2111. Response res;
  2112. res.set_header("Content-Type", "text/plain");
  2113. auto ret = detail::encoding_type(req, res);
  2114. #ifdef CPPHTTPLIB_BROTLI_SUPPORT
  2115. EXPECT_TRUE(ret == detail::EncodingType::Brotli);
  2116. #elif CPPHTTPLIB_ZLIB_SUPPORT
  2117. EXPECT_TRUE(ret == detail::EncodingType::Gzip);
  2118. #elif CPPHTTPLIB_ZSTD_SUPPORT
  2119. EXPECT_TRUE(ret == detail::EncodingType::Zstd);
  2120. #else
  2121. EXPECT_TRUE(ret == detail::EncodingType::None);
  2122. #endif
  2123. }
  2124. TEST(ParseAcceptEncoding8, AcceptEncodingQValuePriority) {
  2125. // q value should determine priority, not hardcoded order
  2126. Request req;
  2127. req.set_header("Accept-Encoding", "br;q=0.5, gzip;q=1.0, zstd;q=0.8");
  2128. Response res;
  2129. res.set_header("Content-Type", "text/plain");
  2130. auto ret = detail::encoding_type(req, res);
  2131. // gzip has highest q=1.0, so it should be selected even though
  2132. // br and zstd are also supported
  2133. #ifdef CPPHTTPLIB_ZLIB_SUPPORT
  2134. EXPECT_TRUE(ret == detail::EncodingType::Gzip);
  2135. #elif CPPHTTPLIB_ZSTD_SUPPORT
  2136. EXPECT_TRUE(ret == detail::EncodingType::Zstd);
  2137. #elif CPPHTTPLIB_BROTLI_SUPPORT
  2138. EXPECT_TRUE(ret == detail::EncodingType::Brotli);
  2139. #else
  2140. EXPECT_TRUE(ret == detail::EncodingType::None);
  2141. #endif
  2142. }
  2143. TEST(BufferStreamTest, read) {
  2144. detail::BufferStream strm1;
  2145. Stream &strm = strm1;
  2146. EXPECT_EQ(5, strm.write("hello"));
  2147. char buf[512];
  2148. EXPECT_EQ(2, strm.read(buf, 2));
  2149. EXPECT_EQ('h', buf[0]);
  2150. EXPECT_EQ('e', buf[1]);
  2151. EXPECT_EQ(2, strm.read(buf, 2));
  2152. EXPECT_EQ('l', buf[0]);
  2153. EXPECT_EQ('l', buf[1]);
  2154. EXPECT_EQ(1, strm.read(buf, 1));
  2155. EXPECT_EQ('o', buf[0]);
  2156. EXPECT_EQ(0, strm.read(buf, 1));
  2157. }
  2158. TEST(HostnameToIPConversionTest, HTTPWatch_Online) {
  2159. auto host = "www.httpwatch.com";
  2160. auto ip = hosted_at(host);
  2161. EXPECT_EQ("23.96.13.243", ip);
  2162. std::vector<std::string> addrs;
  2163. hosted_at(host, addrs);
  2164. EXPECT_EQ(1u, addrs.size());
  2165. }
  2166. #if 0 // It depends on each test environment...
  2167. TEST(HostnameToIPConversionTest, YouTube_Online) {
  2168. auto host = "www.youtube.com";
  2169. std::vector<std::string> addrs;
  2170. hosted_at(host, addrs);
  2171. EXPECT_EQ(20u, addrs.size());
  2172. auto it = std::find(addrs.begin(), addrs.end(), "2607:f8b0:4006:809::200e");
  2173. EXPECT_TRUE(it != addrs.end());
  2174. }
  2175. #endif
  2176. class ChunkedEncodingTest : public ::testing::Test {
  2177. protected:
  2178. ChunkedEncodingTest()
  2179. : cli_(HOST, PORT)
  2180. #ifdef CPPHTTPLIB_SSL_ENABLED
  2181. ,
  2182. svr_(SERVER_CERT_FILE, SERVER_PRIVATE_KEY_FILE)
  2183. #endif
  2184. {
  2185. cli_.set_connection_timeout(2);
  2186. #ifdef CPPHTTPLIB_SSL_ENABLED
  2187. cli_.enable_server_certificate_verification(false);
  2188. #endif
  2189. }
  2190. virtual void SetUp() {
  2191. read_file("./image.jpg", image_data_);
  2192. svr_.Get("/hi", [&](const Request & /*req*/, Response &res) {
  2193. res.set_content("Hello World!", "text/plain");
  2194. });
  2195. svr_.Get(
  2196. "/chunked", [this](const httplib::Request &, httplib::Response &res) {
  2197. res.set_chunked_content_provider(
  2198. "image/jpeg", [this](size_t offset, httplib::DataSink &sink) {
  2199. size_t remaining = image_data_.size() - offset;
  2200. if (remaining == 0) {
  2201. sink.done();
  2202. } else {
  2203. constexpr size_t CHUNK_SIZE = 1024;
  2204. size_t send_size = std::min(CHUNK_SIZE, remaining);
  2205. sink.write(&image_data_[offset], send_size);
  2206. std::this_thread::sleep_for(std::chrono::milliseconds(10));
  2207. }
  2208. return true;
  2209. });
  2210. });
  2211. t_ = thread([&]() { ASSERT_TRUE(svr_.listen(HOST, PORT)); });
  2212. svr_.wait_until_ready();
  2213. }
  2214. virtual void TearDown() {
  2215. svr_.stop();
  2216. if (!request_threads_.empty()) {
  2217. std::this_thread::sleep_for(std::chrono::seconds(1));
  2218. for (auto &t : request_threads_) {
  2219. t.join();
  2220. }
  2221. }
  2222. t_.join();
  2223. }
  2224. #ifdef CPPHTTPLIB_SSL_ENABLED
  2225. SSLClient cli_;
  2226. SSLServer svr_;
  2227. #else
  2228. Client cli_;
  2229. Server svr_;
  2230. #endif
  2231. thread t_;
  2232. std::vector<thread> request_threads_;
  2233. std::string image_data_;
  2234. };
  2235. TEST_F(ChunkedEncodingTest, NormalGet) {
  2236. auto res = cli_.Get("/chunked");
  2237. ASSERT_TRUE(res) << "Error: " << to_string(res.error());
  2238. std::string out;
  2239. read_file("./image.jpg", out);
  2240. EXPECT_EQ(StatusCode::OK_200, res->status);
  2241. EXPECT_EQ(out, res->body);
  2242. }
  2243. TEST_F(ChunkedEncodingTest, WithContentReceiver) {
  2244. std::string body;
  2245. auto res = cli_.Get("/chunked", [&](const char *data, size_t data_length) {
  2246. body.append(data, data_length);
  2247. return true;
  2248. });
  2249. ASSERT_TRUE(res) << "Error: " << to_string(res.error());
  2250. std::string out;
  2251. read_file("./image.jpg", out);
  2252. EXPECT_EQ(StatusCode::OK_200, res->status);
  2253. EXPECT_EQ(out, body);
  2254. }
  2255. TEST_F(ChunkedEncodingTest, WithResponseHandlerAndContentReceiver) {
  2256. std::string body;
  2257. auto res = cli_.Get(
  2258. "/chunked",
  2259. [&](const Response &response) {
  2260. EXPECT_EQ(StatusCode::OK_200, response.status);
  2261. return true;
  2262. },
  2263. [&](const char *data, size_t data_length) {
  2264. body.append(data, data_length);
  2265. return true;
  2266. });
  2267. ASSERT_TRUE(res) << "Error: " << to_string(res.error());
  2268. std::string out;
  2269. read_file("./image.jpg", out);
  2270. EXPECT_EQ(StatusCode::OK_200, res->status);
  2271. EXPECT_EQ(out, body);
  2272. }
  2273. TEST(RangeTest, FromHTTPBin_Online) {
  2274. auto host = "httpbingo.org";
  2275. auto path = std::string{"/range/32"};
  2276. #ifdef CPPHTTPLIB_SSL_ENABLED
  2277. auto port = 443;
  2278. SSLClient cli(host, port);
  2279. #else
  2280. auto port = 80;
  2281. Client cli(host, port);
  2282. #endif
  2283. cli.set_connection_timeout(5);
  2284. {
  2285. auto res = cli.Get(path);
  2286. ASSERT_TRUE(res) << "Error: " << to_string(res.error());
  2287. EXPECT_EQ("abcdefghijklmnopqrstuvwxyzabcdef", res->body);
  2288. EXPECT_EQ(StatusCode::OK_200, res->status);
  2289. }
  2290. {
  2291. Headers headers = {make_range_header({{1, -1}})};
  2292. auto res = cli.Get(path, headers);
  2293. ASSERT_TRUE(res) << "Error: " << to_string(res.error());
  2294. EXPECT_EQ("bcdefghijklmnopqrstuvwxyzabcdef", res->body);
  2295. EXPECT_EQ(StatusCode::PartialContent_206, res->status);
  2296. }
  2297. {
  2298. Headers headers = {make_range_header({{1, 10}})};
  2299. auto res = cli.Get(path, headers);
  2300. ASSERT_TRUE(res) << "Error: " << to_string(res.error());
  2301. EXPECT_EQ("bcdefghijk", res->body);
  2302. EXPECT_EQ(StatusCode::PartialContent_206, res->status);
  2303. }
  2304. // go-httpbin (httpbingo.org) returns 206 even when the range covers the
  2305. // entire resource, while the original httpbin returned 200. Both are
  2306. // acceptable per RFC 9110 §15.3.7, so we accept either status code.
  2307. {
  2308. Headers headers = {make_range_header({{0, 31}})};
  2309. auto res = cli.Get(path, headers);
  2310. ASSERT_TRUE(res) << "Error: " << to_string(res.error());
  2311. EXPECT_EQ("abcdefghijklmnopqrstuvwxyzabcdef", res->body);
  2312. EXPECT_TRUE(res->status == StatusCode::OK_200 ||
  2313. res->status == StatusCode::PartialContent_206);
  2314. }
  2315. {
  2316. Headers headers = {make_range_header({{0, -1}})};
  2317. auto res = cli.Get(path, headers);
  2318. ASSERT_TRUE(res) << "Error: " << to_string(res.error());
  2319. EXPECT_EQ("abcdefghijklmnopqrstuvwxyzabcdef", res->body);
  2320. EXPECT_TRUE(res->status == StatusCode::OK_200 ||
  2321. res->status == StatusCode::PartialContent_206);
  2322. }
  2323. // go-httpbin returns 206 with clamped range for over-range requests,
  2324. // while the original httpbin returned 416. Both behaviors are observed
  2325. // in real servers, so we only verify the request succeeds.
  2326. {
  2327. Headers headers = {make_range_header({{0, 32}})};
  2328. auto res = cli.Get(path, headers);
  2329. ASSERT_TRUE(res) << "Error: " << to_string(res.error());
  2330. }
  2331. }
  2332. TEST(GetAddrInfoDanglingRefTest, LongTimeout) {
  2333. auto host = "unresolvableaddress.local";
  2334. auto path = std::string{"/"};
  2335. #ifdef CPPHTTPLIB_SSL_ENABLED
  2336. auto port = 443;
  2337. SSLClient cli(host, port);
  2338. #else
  2339. auto port = 80;
  2340. Client cli(host, port);
  2341. #endif
  2342. cli.set_connection_timeout(1);
  2343. {
  2344. auto res = cli.Get(path);
  2345. ASSERT_FALSE(res);
  2346. }
  2347. std::this_thread::sleep_for(std::chrono::seconds(8));
  2348. }
  2349. #if defined(__linux__) && defined(__GLIBC__) && \
  2350. defined(CPPHTTPLIB_USE_NON_BLOCKING_GETADDRINFO)
  2351. // Forward declaration: in split builds split.py strips `inline` and moves the
  2352. // definition into httplib.cc, so detail::getaddrinfo_with_timeout is not
  2353. // visible from the public httplib.h. Re-declaring it here lets the tests link
  2354. // against the symbol in both header-only and split builds.
  2355. namespace httplib {
  2356. namespace detail {
  2357. int getaddrinfo_with_timeout(const char *node, const char *service,
  2358. const struct addrinfo *hints,
  2359. struct addrinfo **res, time_t timeout_sec);
  2360. } // namespace detail
  2361. } // namespace httplib
  2362. // Reproducer for https://github.com/yhirose/cpp-httplib/issues/2431.
  2363. //
  2364. // On Linux/glibc, getaddrinfo_with_timeout() runs the lookup via
  2365. // getaddrinfo_a(GAI_NOWAIT) using a stack-local `struct gaicb`. When the
  2366. // gai_suspend() call hits the connection timeout the function calls
  2367. // gai_cancel() and returns immediately. gai_cancel() is non-blocking and
  2368. // can return EAI_NOTCANCELED, in which case the resolver worker thread is
  2369. // still alive and still references the now-destroyed stack frame.
  2370. //
  2371. // Triggering the bug requires DNS to actually hang (UDP/53 dropped, etc.),
  2372. // so these tests are gated on CPPHTTPLIB_TEST_ISSUE_2431=1 and are skipped
  2373. // during normal runs. test/run_issue_2431_repro.sh sets up the environment
  2374. // and runs them in a container.
  2375. namespace {
  2376. bool should_run_issue_2431_tests() {
  2377. const char *v = getenv("CPPHTTPLIB_TEST_ISSUE_2431");
  2378. return v && *v && std::string(v) != "0";
  2379. }
  2380. std::string unique_unresolvable_host(int n) {
  2381. // .invalid is reserved (RFC 6761) and is never served by real DNS, but
  2382. // glibc still asks the configured nameserver — which is exactly the path
  2383. // we want to exercise. A unique label per call avoids the resolver cache.
  2384. auto t = std::chrono::steady_clock::now().time_since_epoch().count();
  2385. return "h-" + std::to_string(::getpid()) + "-" + std::to_string(t) + "-" +
  2386. std::to_string(n) + ".invalid";
  2387. }
  2388. } // namespace
  2389. TEST(GetAddrInfoAsyncCancelTest, DirectCallSingleThread) {
  2390. if (!should_run_issue_2431_tests()) {
  2391. GTEST_SKIP()
  2392. << "Set CPPHTTPLIB_TEST_ISSUE_2431=1 (and sinkhole DNS) to run";
  2393. }
  2394. for (int i = 0; i < 8; ++i) {
  2395. struct addrinfo hints;
  2396. memset(&hints, 0, sizeof(hints));
  2397. hints.ai_family = AF_UNSPEC;
  2398. hints.ai_socktype = SOCK_STREAM;
  2399. auto host = unique_unresolvable_host(i);
  2400. struct addrinfo *result = nullptr;
  2401. int rc = detail::getaddrinfo_with_timeout(host.c_str(), "80", &hints,
  2402. &result, /*timeout_sec=*/1);
  2403. if (rc == 0 && result) { freeaddrinfo(result); }
  2404. }
  2405. // Give orphaned getaddrinfo_a worker threads a chance to write into the
  2406. // stack region they still believe holds their gaicb.
  2407. std::this_thread::sleep_for(std::chrono::seconds(3));
  2408. }
  2409. TEST(GetAddrInfoAsyncCancelTest, DirectCallMultiThread) {
  2410. if (!should_run_issue_2431_tests()) {
  2411. GTEST_SKIP()
  2412. << "Set CPPHTTPLIB_TEST_ISSUE_2431=1 (and sinkhole DNS) to run";
  2413. }
  2414. std::atomic<bool> stop{false};
  2415. std::vector<std::thread> threads;
  2416. for (int t = 0; t < 8; ++t) {
  2417. threads.emplace_back([t, &stop] {
  2418. int i = 0;
  2419. while (!stop.load(std::memory_order_relaxed)) {
  2420. struct addrinfo hints;
  2421. memset(&hints, 0, sizeof(hints));
  2422. hints.ai_family = AF_UNSPEC;
  2423. hints.ai_socktype = SOCK_STREAM;
  2424. auto host = unique_unresolvable_host(t * 100000 + i++);
  2425. struct addrinfo *result = nullptr;
  2426. int rc = detail::getaddrinfo_with_timeout(host.c_str(), "80", &hints,
  2427. &result, /*timeout_sec=*/1);
  2428. if (rc == 0 && result) { freeaddrinfo(result); }
  2429. }
  2430. });
  2431. }
  2432. std::this_thread::sleep_for(std::chrono::seconds(8));
  2433. stop.store(true, std::memory_order_relaxed);
  2434. for (auto &th : threads) {
  2435. th.join();
  2436. }
  2437. std::this_thread::sleep_for(std::chrono::seconds(3));
  2438. }
  2439. TEST(GetAddrInfoAsyncCancelTest, ClientGetMultiThread) {
  2440. if (!should_run_issue_2431_tests()) {
  2441. GTEST_SKIP()
  2442. << "Set CPPHTTPLIB_TEST_ISSUE_2431=1 (and sinkhole DNS) to run";
  2443. }
  2444. std::atomic<bool> stop{false};
  2445. std::vector<std::thread> threads;
  2446. for (int t = 0; t < 8; ++t) {
  2447. threads.emplace_back([t, &stop] {
  2448. int i = 0;
  2449. while (!stop.load(std::memory_order_relaxed)) {
  2450. auto host = unique_unresolvable_host(t * 100000 + i++);
  2451. Client cli(host, 80);
  2452. cli.set_connection_timeout(1, 0);
  2453. cli.set_read_timeout(1, 0);
  2454. cli.set_write_timeout(1, 0);
  2455. (void)cli.Get("/");
  2456. }
  2457. });
  2458. }
  2459. std::this_thread::sleep_for(std::chrono::seconds(8));
  2460. stop.store(true, std::memory_order_relaxed);
  2461. for (auto &th : threads) {
  2462. th.join();
  2463. }
  2464. std::this_thread::sleep_for(std::chrono::seconds(3));
  2465. }
  2466. #endif // __linux__ && __GLIBC__ && CPPHTTPLIB_USE_NON_BLOCKING_GETADDRINFO
  2467. TEST(ConnectionErrorTest, InvalidHost) {
  2468. auto host = "-abcde.com";
  2469. #ifdef CPPHTTPLIB_SSL_ENABLED
  2470. auto port = 443;
  2471. SSLClient cli(host, port);
  2472. #else
  2473. auto port = 80;
  2474. Client cli(host, port);
  2475. #endif
  2476. cli.set_connection_timeout(std::chrono::seconds(2));
  2477. auto res = cli.Get("/");
  2478. ASSERT_TRUE(!res);
  2479. EXPECT_EQ(Error::Connection, res.error());
  2480. }
  2481. TEST(ConnectionErrorTest, InvalidHost2) {
  2482. auto host = "httpcan.org/";
  2483. #ifdef CPPHTTPLIB_SSL_ENABLED
  2484. SSLClient cli(host);
  2485. #else
  2486. Client cli(host);
  2487. #endif
  2488. cli.set_connection_timeout(std::chrono::seconds(2));
  2489. auto res = cli.Get("/");
  2490. ASSERT_TRUE(!res);
  2491. EXPECT_EQ(Error::Connection, res.error());
  2492. }
  2493. TEST(ConnectionErrorTest, InvalidHostCheckResultErrorToString) {
  2494. auto host = "httpcan.org/";
  2495. #ifdef CPPHTTPLIB_SSL_ENABLED
  2496. SSLClient cli(host);
  2497. #else
  2498. Client cli(host);
  2499. #endif
  2500. cli.set_connection_timeout(std::chrono::seconds(2));
  2501. auto res = cli.Get("/");
  2502. ASSERT_TRUE(!res);
  2503. stringstream s;
  2504. s << "error code: " << res.error();
  2505. EXPECT_EQ("error code: Could not establish connection (2)", s.str());
  2506. }
  2507. TEST(ConnectionErrorTest, InvalidPort) {
  2508. auto host = "localhost";
  2509. auto port = 44380;
  2510. #ifdef CPPHTTPLIB_SSL_ENABLED
  2511. SSLClient cli(host, port);
  2512. #else
  2513. Client cli(host, port);
  2514. #endif
  2515. cli.set_connection_timeout(std::chrono::seconds(2));
  2516. auto res = cli.Get("/");
  2517. ASSERT_TRUE(!res);
  2518. EXPECT_TRUE(Error::Connection == res.error() ||
  2519. Error::ConnectionTimeout == res.error());
  2520. }
  2521. TEST(ConnectionErrorTest, Timeout_Online) {
  2522. auto host = "google.com";
  2523. #ifdef CPPHTTPLIB_SSL_ENABLED
  2524. auto port = 44380;
  2525. SSLClient cli(host, port);
  2526. #else
  2527. auto port = 8080;
  2528. Client cli(host, port);
  2529. #endif
  2530. cli.set_connection_timeout(std::chrono::seconds(2));
  2531. // only probe one address type so that the error reason
  2532. // correlates to the timed-out IPv4, not the unsupported
  2533. // IPv6 connection attempt
  2534. cli.set_address_family(AF_INET);
  2535. auto res = cli.Get("/");
  2536. ASSERT_TRUE(!res);
  2537. EXPECT_EQ(Error::ConnectionTimeout, res.error());
  2538. }
  2539. TEST(CancelTest, NoCancel_Online) {
  2540. auto host = "httpbingo.org";
  2541. auto path = std::string{"/range/32"};
  2542. #ifdef CPPHTTPLIB_SSL_ENABLED
  2543. auto port = 443;
  2544. SSLClient cli(host, port);
  2545. #else
  2546. auto port = 80;
  2547. Client cli(host, port);
  2548. #endif
  2549. cli.set_connection_timeout(std::chrono::seconds(5));
  2550. auto res = cli.Get(path, [](uint64_t, uint64_t) { return true; });
  2551. ASSERT_TRUE(res) << "Error: " << to_string(res.error());
  2552. EXPECT_EQ("abcdefghijklmnopqrstuvwxyzabcdef", res->body);
  2553. EXPECT_EQ(StatusCode::OK_200, res->status);
  2554. }
  2555. TEST(CancelTest, WithCancelSmallPayload_Online) {
  2556. // Use /bytes with a large payload so that the DownloadProgress callback
  2557. // (which only fires for Content-Length responses) is invoked before the
  2558. // entire body is received, giving cancellation a chance to fire.
  2559. auto host = "httpbingo.org";
  2560. auto path = std::string{"/bytes/524288"};
  2561. #ifdef CPPHTTPLIB_SSL_ENABLED
  2562. auto port = 443;
  2563. SSLClient cli(host, port);
  2564. #else
  2565. auto port = 80;
  2566. Client cli(host, port);
  2567. #endif
  2568. auto res = cli.Get(path, [](uint64_t, uint64_t) { return false; });
  2569. cli.set_connection_timeout(std::chrono::seconds(5));
  2570. ASSERT_TRUE(!res);
  2571. EXPECT_EQ(Error::Canceled, res.error());
  2572. }
  2573. TEST(CancelTest, WithCancelLargePayload_Online) {
  2574. auto host = "httpbingo.org";
  2575. auto path = std::string{"/bytes/524288"};
  2576. #ifdef CPPHTTPLIB_SSL_ENABLED
  2577. auto port = 443;
  2578. SSLClient cli(host, port);
  2579. #else
  2580. auto port = 80;
  2581. Client cli(host, port);
  2582. #endif
  2583. cli.set_connection_timeout(std::chrono::seconds(5));
  2584. uint32_t count = 0;
  2585. auto res =
  2586. cli.Get(path, [&count](uint64_t, uint64_t) { return (count++ == 0); });
  2587. ASSERT_TRUE(!res);
  2588. EXPECT_EQ(Error::Canceled, res.error());
  2589. }
  2590. TEST(CancelTest, NoCancelPost) {
  2591. Server svr;
  2592. svr.Post("/", [&](const Request & /*req*/, Response &res) {
  2593. res.set_content("Hello World!", "text/plain");
  2594. });
  2595. auto thread = std::thread([&]() { svr.listen(HOST, PORT); });
  2596. auto se = detail::scope_exit([&] {
  2597. svr.stop();
  2598. thread.join();
  2599. ASSERT_FALSE(svr.is_running());
  2600. });
  2601. svr.wait_until_ready();
  2602. Client cli(HOST, PORT);
  2603. cli.set_connection_timeout(std::chrono::seconds(5));
  2604. auto res =
  2605. cli.Post("/", Headers(), JSON_DATA.data(), JSON_DATA.size(),
  2606. "application/json", [](uint64_t, uint64_t) { return true; });
  2607. ASSERT_TRUE(res) << "Error: " << to_string(res.error());
  2608. EXPECT_EQ("Hello World!", res->body);
  2609. EXPECT_EQ(StatusCode::OK_200, res->status);
  2610. }
  2611. TEST(CancelTest, WithCancelSmallPayloadPost) {
  2612. Server svr;
  2613. svr.Post("/", [&](const Request & /*req*/, Response &res) {
  2614. res.set_content("Hello World!", "text/plain");
  2615. });
  2616. auto thread = std::thread([&]() { svr.listen(HOST, PORT); });
  2617. auto se = detail::scope_exit([&] {
  2618. svr.stop();
  2619. thread.join();
  2620. ASSERT_FALSE(svr.is_running());
  2621. });
  2622. svr.wait_until_ready();
  2623. Client cli(HOST, PORT);
  2624. cli.set_connection_timeout(std::chrono::seconds(5));
  2625. auto res =
  2626. cli.Post("/", Headers(), JSON_DATA.data(), JSON_DATA.size(),
  2627. "application/json", [](uint64_t, uint64_t) { return false; });
  2628. ASSERT_TRUE(!res);
  2629. EXPECT_EQ(Error::Canceled, res.error());
  2630. }
  2631. TEST(CancelTest, WithCancelLargePayloadPost) {
  2632. Server svr;
  2633. svr.set_payload_max_length(200 * 1024 * 1024);
  2634. svr.Post("/", [&](const Request & /*req*/, Response &res) {
  2635. res.set_content(LARGE_DATA, "text/plain");
  2636. });
  2637. auto thread = std::thread([&]() { svr.listen(HOST, PORT); });
  2638. auto se = detail::scope_exit([&] {
  2639. svr.stop();
  2640. thread.join();
  2641. ASSERT_FALSE(svr.is_running());
  2642. });
  2643. svr.wait_until_ready();
  2644. Client cli(HOST, PORT);
  2645. cli.set_payload_max_length(200 * 1024 * 1024);
  2646. cli.set_connection_timeout(std::chrono::seconds(5));
  2647. auto res =
  2648. cli.Post("/", Headers(), JSON_DATA.data(), JSON_DATA.size(),
  2649. "application/json", [](uint64_t, uint64_t) { return false; });
  2650. ASSERT_TRUE(!res);
  2651. EXPECT_EQ(Error::Canceled, res.error());
  2652. }
  2653. TEST(CancelTest, NoCancelPut) {
  2654. Server svr;
  2655. svr.Put("/", [&](const Request & /*req*/, Response &res) {
  2656. res.set_content("Hello World!", "text/plain");
  2657. });
  2658. auto thread = std::thread([&]() { svr.listen(HOST, PORT); });
  2659. auto se = detail::scope_exit([&] {
  2660. svr.stop();
  2661. thread.join();
  2662. ASSERT_FALSE(svr.is_running());
  2663. });
  2664. svr.wait_until_ready();
  2665. Client cli(HOST, PORT);
  2666. cli.set_connection_timeout(std::chrono::seconds(5));
  2667. auto res =
  2668. cli.Put("/", Headers(), JSON_DATA.data(), JSON_DATA.size(),
  2669. "application/json", [](uint64_t, uint64_t) { return true; });
  2670. ASSERT_TRUE(res) << "Error: " << to_string(res.error());
  2671. EXPECT_EQ("Hello World!", res->body);
  2672. EXPECT_EQ(StatusCode::OK_200, res->status);
  2673. }
  2674. TEST(CancelTest, WithCancelSmallPayloadPut) {
  2675. Server svr;
  2676. svr.Put("/", [&](const Request & /*req*/, Response &res) {
  2677. res.set_content("Hello World!", "text/plain");
  2678. });
  2679. auto thread = std::thread([&]() { svr.listen(HOST, PORT); });
  2680. auto se = detail::scope_exit([&] {
  2681. svr.stop();
  2682. thread.join();
  2683. ASSERT_FALSE(svr.is_running());
  2684. });
  2685. svr.wait_until_ready();
  2686. Client cli(HOST, PORT);
  2687. cli.set_connection_timeout(std::chrono::seconds(5));
  2688. auto res =
  2689. cli.Put("/", Headers(), JSON_DATA.data(), JSON_DATA.size(),
  2690. "application/json", [](uint64_t, uint64_t) { return false; });
  2691. ASSERT_TRUE(!res);
  2692. EXPECT_EQ(Error::Canceled, res.error());
  2693. }
  2694. TEST(CancelTest, WithCancelLargePayloadPut) {
  2695. Server svr;
  2696. svr.set_payload_max_length(200 * 1024 * 1024);
  2697. svr.Put("/", [&](const Request & /*req*/, Response &res) {
  2698. res.set_content(LARGE_DATA, "text/plain");
  2699. });
  2700. auto thread = std::thread([&]() { svr.listen(HOST, PORT); });
  2701. auto se = detail::scope_exit([&] {
  2702. svr.stop();
  2703. thread.join();
  2704. ASSERT_FALSE(svr.is_running());
  2705. });
  2706. svr.wait_until_ready();
  2707. Client cli(HOST, PORT);
  2708. cli.set_payload_max_length(200 * 1024 * 1024);
  2709. cli.set_connection_timeout(std::chrono::seconds(5));
  2710. auto res =
  2711. cli.Put("/", Headers(), JSON_DATA.data(), JSON_DATA.size(),
  2712. "application/json", [](uint64_t, uint64_t) { return false; });
  2713. ASSERT_TRUE(!res);
  2714. EXPECT_EQ(Error::Canceled, res.error());
  2715. }
  2716. TEST(CancelTest, NoCancelPatch) {
  2717. Server svr;
  2718. svr.Patch("/", [&](const Request & /*req*/, Response &res) {
  2719. res.set_content("Hello World!", "text/plain");
  2720. });
  2721. auto thread = std::thread([&]() { svr.listen(HOST, PORT); });
  2722. auto se = detail::scope_exit([&] {
  2723. svr.stop();
  2724. thread.join();
  2725. ASSERT_FALSE(svr.is_running());
  2726. });
  2727. svr.wait_until_ready();
  2728. Client cli(HOST, PORT);
  2729. cli.set_connection_timeout(std::chrono::seconds(5));
  2730. auto res =
  2731. cli.Patch("/", Headers(), JSON_DATA.data(), JSON_DATA.size(),
  2732. "application/json", [](uint64_t, uint64_t) { return true; });
  2733. ASSERT_TRUE(res) << "Error: " << to_string(res.error());
  2734. EXPECT_EQ("Hello World!", res->body);
  2735. EXPECT_EQ(StatusCode::OK_200, res->status);
  2736. }
  2737. TEST(CancelTest, WithCancelSmallPayloadPatch) {
  2738. Server svr;
  2739. svr.Patch("/", [&](const Request & /*req*/, Response &res) {
  2740. res.set_content("Hello World!", "text/plain");
  2741. });
  2742. auto thread = std::thread([&]() { svr.listen(HOST, PORT); });
  2743. auto se = detail::scope_exit([&] {
  2744. svr.stop();
  2745. thread.join();
  2746. ASSERT_FALSE(svr.is_running());
  2747. });
  2748. svr.wait_until_ready();
  2749. Client cli(HOST, PORT);
  2750. cli.set_connection_timeout(std::chrono::seconds(5));
  2751. auto res =
  2752. cli.Patch("/", Headers(), JSON_DATA.data(), JSON_DATA.size(),
  2753. "application/json", [](uint64_t, uint64_t) { return false; });
  2754. ASSERT_TRUE(!res);
  2755. EXPECT_EQ(Error::Canceled, res.error());
  2756. }
  2757. TEST(CancelTest, WithCancelLargePayloadPatch) {
  2758. Server svr;
  2759. svr.set_payload_max_length(200 * 1024 * 1024);
  2760. svr.Patch("/", [&](const Request & /*req*/, Response &res) {
  2761. res.set_content(LARGE_DATA, "text/plain");
  2762. });
  2763. auto thread = std::thread([&]() { svr.listen(HOST, PORT); });
  2764. auto se = detail::scope_exit([&] {
  2765. svr.stop();
  2766. thread.join();
  2767. ASSERT_FALSE(svr.is_running());
  2768. });
  2769. svr.wait_until_ready();
  2770. Client cli(HOST, PORT);
  2771. cli.set_payload_max_length(200 * 1024 * 1024);
  2772. cli.set_connection_timeout(std::chrono::seconds(5));
  2773. auto res =
  2774. cli.Patch("/", Headers(), JSON_DATA.data(), JSON_DATA.size(),
  2775. "application/json", [](uint64_t, uint64_t) { return false; });
  2776. ASSERT_TRUE(!res);
  2777. EXPECT_EQ(Error::Canceled, res.error());
  2778. }
  2779. TEST(CancelTest, NoCancelDelete) {
  2780. Server svr;
  2781. svr.Delete("/", [&](const Request & /*req*/, Response &res) {
  2782. res.set_content("Hello World!", "text/plain");
  2783. });
  2784. auto thread = std::thread([&]() { svr.listen(HOST, PORT); });
  2785. auto se = detail::scope_exit([&] {
  2786. svr.stop();
  2787. thread.join();
  2788. ASSERT_FALSE(svr.is_running());
  2789. });
  2790. svr.wait_until_ready();
  2791. Client cli(HOST, PORT);
  2792. cli.set_connection_timeout(std::chrono::seconds(5));
  2793. auto res =
  2794. cli.Delete("/", Headers(), JSON_DATA.data(), JSON_DATA.size(),
  2795. "application/json", [](uint64_t, uint64_t) { return true; });
  2796. ASSERT_TRUE(res) << "Error: " << to_string(res.error());
  2797. EXPECT_EQ("Hello World!", res->body);
  2798. EXPECT_EQ(StatusCode::OK_200, res->status);
  2799. }
  2800. TEST(CancelTest, WithCancelSmallPayloadDelete) {
  2801. Server svr;
  2802. svr.Delete("/", [&](const Request & /*req*/, Response &res) {
  2803. res.set_content("Hello World!", "text/plain");
  2804. });
  2805. auto thread = std::thread([&]() { svr.listen(HOST, PORT); });
  2806. auto se = detail::scope_exit([&] {
  2807. svr.stop();
  2808. thread.join();
  2809. ASSERT_FALSE(svr.is_running());
  2810. });
  2811. svr.wait_until_ready();
  2812. Client cli(HOST, PORT);
  2813. cli.set_connection_timeout(std::chrono::seconds(5));
  2814. auto res =
  2815. cli.Delete("/", Headers(), JSON_DATA.data(), JSON_DATA.size(),
  2816. "application/json", [](uint64_t, uint64_t) { return false; });
  2817. ASSERT_TRUE(!res);
  2818. EXPECT_EQ(Error::Canceled, res.error());
  2819. }
  2820. TEST(CancelTest, WithCancelLargePayloadDelete) {
  2821. Server svr;
  2822. svr.set_payload_max_length(200 * 1024 * 1024);
  2823. svr.Delete("/", [&](const Request & /*req*/, Response &res) {
  2824. res.set_content(LARGE_DATA, "text/plain");
  2825. });
  2826. auto thread = std::thread([&]() { svr.listen(HOST, PORT); });
  2827. auto se = detail::scope_exit([&] {
  2828. svr.stop();
  2829. thread.join();
  2830. ASSERT_FALSE(svr.is_running());
  2831. });
  2832. svr.wait_until_ready();
  2833. Client cli(HOST, PORT);
  2834. cli.set_payload_max_length(200 * 1024 * 1024);
  2835. cli.set_connection_timeout(std::chrono::seconds(5));
  2836. auto res =
  2837. cli.Delete("/", Headers(), JSON_DATA.data(), JSON_DATA.size(),
  2838. "application/json", [](uint64_t, uint64_t) { return false; });
  2839. ASSERT_TRUE(!res);
  2840. EXPECT_EQ(Error::Canceled, res.error());
  2841. }
  2842. static std::string remove_whitespace(const std::string &input) {
  2843. std::string output;
  2844. output.reserve(input.size());
  2845. std::copy_if(input.begin(), input.end(), std::back_inserter(output),
  2846. [](unsigned char c) { return !std::isspace(c); });
  2847. return output;
  2848. }
  2849. TEST(BaseAuthTest, FromHTTPWatch_Online) {
  2850. auto host = "httpbingo.org";
  2851. auto path = std::string{"/basic-auth/hello/world"};
  2852. #ifdef CPPHTTPLIB_SSL_ENABLED
  2853. auto port = 443;
  2854. SSLClient cli(host, port);
  2855. #else
  2856. auto port = 80;
  2857. Client cli(host, port);
  2858. #endif
  2859. {
  2860. auto res = cli.Get(path);
  2861. ASSERT_TRUE(res) << "Error: " << to_string(res.error());
  2862. EXPECT_EQ(StatusCode::Unauthorized_401, res->status);
  2863. }
  2864. {
  2865. auto res = cli.Get(
  2866. path, Headers{make_basic_authentication_header("hello", "world")});
  2867. ASSERT_TRUE(res) << "Error: " << to_string(res.error());
  2868. auto body = remove_whitespace(res->body);
  2869. EXPECT_TRUE(body.find("\"authenticated\":true") != std::string::npos);
  2870. EXPECT_TRUE(body.find("\"user\":\"hello\"") != std::string::npos);
  2871. EXPECT_EQ(StatusCode::OK_200, res->status);
  2872. }
  2873. {
  2874. cli.set_basic_auth("hello", "world");
  2875. auto res = cli.Get(path);
  2876. ASSERT_TRUE(res) << "Error: " << to_string(res.error());
  2877. auto body = remove_whitespace(res->body);
  2878. EXPECT_TRUE(body.find("\"authenticated\":true") != std::string::npos);
  2879. EXPECT_TRUE(body.find("\"user\":\"hello\"") != std::string::npos);
  2880. EXPECT_EQ(StatusCode::OK_200, res->status);
  2881. }
  2882. {
  2883. cli.set_basic_auth("hello", "bad");
  2884. auto res = cli.Get(path);
  2885. ASSERT_TRUE(res) << "Error: " << to_string(res.error());
  2886. EXPECT_EQ(StatusCode::Unauthorized_401, res->status);
  2887. }
  2888. {
  2889. cli.set_basic_auth("bad", "world");
  2890. auto res = cli.Get(path);
  2891. ASSERT_TRUE(res) << "Error: " << to_string(res.error());
  2892. EXPECT_EQ(StatusCode::Unauthorized_401, res->status);
  2893. }
  2894. }
  2895. #ifdef CPPHTTPLIB_SSL_ENABLED
  2896. TEST(DigestAuthTest, FromHTTPWatch_Online) {
  2897. auto host = "httpbingo.org";
  2898. auto unauth_path = std::string{"/digest-auth/auth/hello/world"};
  2899. auto paths = std::vector<std::string>{
  2900. "/digest-auth/auth/hello/world/MD5",
  2901. "/digest-auth/auth/hello/world/SHA-256",
  2902. };
  2903. auto port = 443;
  2904. SSLClient cli(host, port);
  2905. {
  2906. auto res = cli.Get(unauth_path);
  2907. ASSERT_TRUE(res) << "Error: " << to_string(res.error());
  2908. EXPECT_EQ(StatusCode::Unauthorized_401, res->status);
  2909. }
  2910. {
  2911. cli.set_digest_auth("hello", "world");
  2912. for (const auto &path : paths) {
  2913. auto res = cli.Get(path.c_str());
  2914. ASSERT_TRUE(res) << "Error: " << to_string(res.error());
  2915. auto body = remove_whitespace(res->body);
  2916. EXPECT_TRUE(body.find("\"authenticated\":true") != std::string::npos);
  2917. EXPECT_TRUE(body.find("\"user\":\"hello\"") != std::string::npos);
  2918. EXPECT_EQ(StatusCode::OK_200, res->status);
  2919. }
  2920. cli.set_digest_auth("hello", "bad");
  2921. for (const auto &path : paths) {
  2922. auto res = cli.Get(path.c_str());
  2923. ASSERT_TRUE(res) << "Error: " << to_string(res.error());
  2924. EXPECT_EQ(StatusCode::Unauthorized_401, res->status);
  2925. }
  2926. }
  2927. }
  2928. // RFC 9110 Section 11.6.1: a WWW-Authenticate field value is a
  2929. // comma-separated list of challenges, and each challenge may itself carry a
  2930. // comma-separated auth-param list, so a server can legally offer Basic
  2931. // before Digest, either as two field lines or packed into one. Runs one 401
  2932. // -> Digest-retry round trip with the given field lines (get_combined_header_
  2933. // value() joins them in receipt order) and checks that the retry carries a
  2934. // well-formed Digest Authorization header naming expected_realm.
  2935. static void
  2936. run_digest_challenge_list_test(const std::vector<std::string> &challenges,
  2937. const std::string &expected_realm) {
  2938. std::atomic<int> hits{0};
  2939. Server svr;
  2940. svr.Get("/x", [&](const Request &req, Response &res) {
  2941. if (++hits == 1) {
  2942. res.status = StatusCode::Unauthorized_401;
  2943. for (const auto &challenge : challenges) {
  2944. res.set_header("WWW-Authenticate", challenge);
  2945. }
  2946. } else {
  2947. auto authorization = req.get_header_value("Authorization");
  2948. EXPECT_EQ(0u, authorization.rfind("Digest ", 0));
  2949. EXPECT_NE(std::string::npos,
  2950. authorization.find("realm=\"" + expected_realm + "\""));
  2951. EXPECT_EQ(std::string::npos, authorization.find("Basic"));
  2952. res.set_content("ok", "text/plain");
  2953. }
  2954. });
  2955. auto port = svr.bind_to_any_port(HOST);
  2956. std::thread t([&]() { svr.listen_after_bind(); });
  2957. auto se = detail::scope_exit([&] {
  2958. svr.stop();
  2959. t.join();
  2960. });
  2961. svr.wait_until_ready();
  2962. Client cli(HOST, port);
  2963. cli.set_digest_auth("hello", "world");
  2964. auto res = cli.Get("/x");
  2965. ASSERT_TRUE(res) << "Error: " << to_string(res.error());
  2966. EXPECT_EQ(2, hits.load());
  2967. }
  2968. static const char *kBasicChallenge = "Basic realm=\"decoy\"";
  2969. static const char *kDigestChallenge =
  2970. "Digest realm=\"testrealm\", qop=\"auth\", nonce=\"abc123\", "
  2971. "algorithm=MD5";
  2972. TEST(DigestAuthTest, BasicChallengeListedBeforeDigest) {
  2973. run_digest_challenge_list_test({kBasicChallenge, kDigestChallenge},
  2974. "testrealm");
  2975. }
  2976. // Same challenge list with the schemes in the opposite order, to make sure
  2977. // the fix above didn't just special-case "Basic first".
  2978. TEST(DigestAuthTest, DigestChallengeListedBeforeBasic) {
  2979. run_digest_challenge_list_test({kDigestChallenge, kBasicChallenge},
  2980. "testrealm");
  2981. }
  2982. // A comma inside a quoted auth-param value must not be mistaken for the
  2983. // separator between two challenges (or two auth-params).
  2984. TEST(DigestAuthTest, RealmContainingCommaIsNotSplit) {
  2985. run_digest_challenge_list_test(
  2986. {"Digest realm=\"test,realm\", qop=\"auth\", nonce=\"abc123\", "
  2987. "algorithm=MD5"},
  2988. "test,realm");
  2989. }
  2990. // RFC 7616 3.4: uri is the request-target as sent, which is encoded, carries
  2991. // the params and leaves out the fragment.
  2992. TEST(DigestAuthTest, UriIsTheRequestTargetSent) {
  2993. Server svr;
  2994. std::string uri, target;
  2995. svr.Get("/a b", [&](const Request &req, Response &res) {
  2996. auto auth = req.get_header_value("Authorization");
  2997. if (auth.empty()) {
  2998. res.status = StatusCode::Unauthorized_401;
  2999. res.set_header("WWW-Authenticate",
  3000. "Digest realm=\"r\", qop=\"auth\", nonce=\"n\"");
  3001. return;
  3002. }
  3003. auto b = auth.find("uri=\"") + 5;
  3004. uri = auth.substr(b, auth.find('"', b) - b);
  3005. target = req.target;
  3006. });
  3007. auto port = svr.bind_to_any_port(HOST);
  3008. std::thread t([&]() { svr.listen_after_bind(); });
  3009. auto se = detail::scope_exit([&] {
  3010. svr.stop();
  3011. t.join();
  3012. });
  3013. svr.wait_until_ready();
  3014. Client cli(HOST, port);
  3015. cli.set_digest_auth("hello", "world");
  3016. auto res = cli.Get("/a b#f", Params{{"x", "1"}}, Headers{});
  3017. ASSERT_TRUE(res) << "Error: " << to_string(res.error());
  3018. EXPECT_EQ("/a%20b?x=1", target);
  3019. EXPECT_EQ(target, uri);
  3020. }
  3021. // RFC 7616 Section 3.3 requires realm and nonce on every Digest challenge.
  3022. // make_digest_authentication_header() dereferences both unconditionally, so
  3023. // a server sending a challenge missing either one must not be treated as
  3024. // usable -- doing so used to crash the client with std::out_of_range.
  3025. static void run_digest_challenge_missing_field_test(const char *challenge) {
  3026. Server svr;
  3027. svr.Get("/x", [&](const Request & /*req*/, Response &res) {
  3028. res.status = StatusCode::Unauthorized_401;
  3029. res.set_header("WWW-Authenticate", challenge);
  3030. });
  3031. auto port = svr.bind_to_any_port(HOST);
  3032. std::thread t([&]() { svr.listen_after_bind(); });
  3033. auto se = detail::scope_exit([&] {
  3034. svr.stop();
  3035. t.join();
  3036. });
  3037. svr.wait_until_ready();
  3038. Client cli(HOST, port);
  3039. cli.set_digest_auth("hello", "world");
  3040. auto res = cli.Get("/x");
  3041. ASSERT_TRUE(res) << "Error: " << to_string(res.error());
  3042. EXPECT_EQ(StatusCode::Unauthorized_401, res->status);
  3043. }
  3044. TEST(DigestAuthTest, ChallengeMissingRealmAndNonceDoesNotCrash) {
  3045. run_digest_challenge_missing_field_test("Digest qop=\"auth\"");
  3046. }
  3047. TEST(DigestAuthTest, ChallengeMissingNonceDoesNotCrash) {
  3048. run_digest_challenge_missing_field_test("Digest realm=\"r\", qop=\"auth\"");
  3049. }
  3050. TEST(DigestAuthTest, ChallengeMissingRealmDoesNotCrash) {
  3051. run_digest_challenge_missing_field_test("Digest nonce=\"n\", qop=\"auth\"");
  3052. }
  3053. // A hostile server can put a '"' in realm/nonce/opaque, or a non-token
  3054. // algorithm, in its challenge. parse_www_authenticate() de-escapes quoted-pairs
  3055. // when storing the values, so the header builder has to re-escape them (and
  3056. // keep algorithm a bare token); otherwise the value breaks out of its
  3057. // quoted-string and injects extra auth-params into the client's Authorization.
  3058. TEST(DigestAuthTest, EscapesInjectedAuthParams) {
  3059. std::atomic<int> hits{0};
  3060. std::string authorization;
  3061. Server svr;
  3062. svr.Get("/x", [&](const Request &req, Response &res) {
  3063. if (++hits == 1) {
  3064. res.status = StatusCode::Unauthorized_401;
  3065. // On the wire the quotes embedded in the values are backslash-escaped.
  3066. res.set_header("WWW-Authenticate",
  3067. "Digest realm=\"testrealm\", "
  3068. "nonce=\"n\\\"; injected=\\\"x\", "
  3069. "algorithm=\"MD5, injected2=\\\"y\\\"\", qop=\"auth\"");
  3070. } else {
  3071. authorization = req.get_header_value("Authorization");
  3072. res.set_content("ok", "text/plain");
  3073. }
  3074. });
  3075. auto port = svr.bind_to_any_port(HOST);
  3076. std::thread t([&]() { svr.listen_after_bind(); });
  3077. auto se = detail::scope_exit([&] {
  3078. svr.stop();
  3079. t.join();
  3080. });
  3081. svr.wait_until_ready();
  3082. Client cli(HOST, port);
  3083. cli.set_digest_auth("hello", "world");
  3084. auto res = cli.Get("/x");
  3085. ASSERT_TRUE(res) << "Error: " << to_string(res.error());
  3086. EXPECT_EQ(2, hits.load());
  3087. EXPECT_EQ(0u, authorization.rfind("Digest ", 0));
  3088. // The nonce (de-escaped to n"; injected="x ) must be re-escaped so it stays
  3089. // inside its quoted-string rather than starting an "injected" auth-param.
  3090. EXPECT_NE(std::string::npos,
  3091. authorization.find("nonce=\"n\\\"; injected=\\\"x\""));
  3092. // A non-token algorithm falls back to a bare MD5 token, dropping the payload.
  3093. EXPECT_EQ(std::string::npos, authorization.find("injected2"));
  3094. }
  3095. #endif
  3096. TEST(SpecifyServerIPAddressTest, AnotherHostname_Online) {
  3097. auto host = "google.com";
  3098. auto another_host = "example.com";
  3099. auto wrong_ip = "0.0.0.0";
  3100. #ifdef CPPHTTPLIB_SSL_ENABLED
  3101. SSLClient cli(host);
  3102. #else
  3103. Client cli(host);
  3104. #endif
  3105. cli.set_hostname_addr_map({{another_host, wrong_ip}});
  3106. auto res = cli.Get("/");
  3107. ASSERT_TRUE(res) << "Error: " << to_string(res.error());
  3108. ASSERT_EQ(StatusCode::MovedPermanently_301, res->status);
  3109. }
  3110. TEST(SpecifyServerIPAddressTest, RealHostname_Online) {
  3111. auto host = "google.com";
  3112. auto wrong_ip = "0.0.0.0";
  3113. #ifdef CPPHTTPLIB_SSL_ENABLED
  3114. SSLClient cli(host);
  3115. #else
  3116. Client cli(host);
  3117. #endif
  3118. cli.set_hostname_addr_map({{host, wrong_ip}});
  3119. auto res = cli.Get("/");
  3120. ASSERT_TRUE(!res);
  3121. EXPECT_EQ(Error::Connection, res.error());
  3122. }
  3123. TEST(SpecifyServerIPAddressTest, HostnameAsAddrMapValue) {
  3124. // A mapped value that is not an IP literal must be resolved. "localhost"
  3125. // resolves from the hosts file, so this test needs no external DNS.
  3126. // "target.invalid" (RFC 6761) is only a map key and the Host header value.
  3127. auto host = "target.invalid";
  3128. Server svr;
  3129. std::string received_host;
  3130. svr.Get("/hi", [&](const Request &req, Response &res) {
  3131. received_host = req.get_header_value("Host");
  3132. res.set_content("Hello World!", "text/plain");
  3133. });
  3134. auto port = svr.bind_to_any_port(HOST);
  3135. auto thread = std::thread([&]() { svr.listen_after_bind(); });
  3136. auto se = detail::scope_exit([&] {
  3137. svr.stop();
  3138. thread.join();
  3139. ASSERT_FALSE(svr.is_running());
  3140. });
  3141. svr.wait_until_ready();
  3142. Client cli(host, port);
  3143. cli.set_hostname_addr_map({{host, HOST}});
  3144. auto res = cli.Get("/hi");
  3145. ASSERT_TRUE(res) << "Error: " << to_string(res.error());
  3146. EXPECT_EQ(StatusCode::OK_200, res->status);
  3147. // The mapping only redirects the connection; the identity stays host_.
  3148. EXPECT_EQ(std::string(host) + ":" + std::to_string(port), received_host);
  3149. }
  3150. TEST(SpecifyServerIPAddressTest, IPAddressAsAddrMapValue) {
  3151. // A mapped value that is an IP literal keeps the AI_NUMERICHOST path.
  3152. auto host = "target.invalid";
  3153. Server svr;
  3154. svr.Get("/hi", [](const Request & /*req*/, Response &res) {
  3155. res.set_content("Hello World!", "text/plain");
  3156. });
  3157. auto port = svr.bind_to_any_port("127.0.0.1");
  3158. auto thread = std::thread([&]() { svr.listen_after_bind(); });
  3159. auto se = detail::scope_exit([&] {
  3160. svr.stop();
  3161. thread.join();
  3162. ASSERT_FALSE(svr.is_running());
  3163. });
  3164. svr.wait_until_ready();
  3165. Client cli(host, port);
  3166. cli.set_hostname_addr_map({{host, "127.0.0.1"}});
  3167. auto res = cli.Get("/hi");
  3168. ASSERT_TRUE(res) << "Error: " << to_string(res.error());
  3169. EXPECT_EQ(StatusCode::OK_200, res->status);
  3170. }
  3171. TEST(SpecifyServerIPAddressTest, EmptyAddrMapValueIsIgnored) {
  3172. // An empty mapped value must leave host_ as the connection target. Without
  3173. // that guard the empty value would become the host argument, getaddrinfo
  3174. // would be called with a null node, and (no AI_PASSIVE) it would resolve to
  3175. // loopback - silently connecting somewhere the caller never asked for.
  3176. // The server listens on loopback, so such a fallback would succeed and is
  3177. // therefore observable as a failure of this test.
  3178. auto blackhole = "192.0.2.1"; // TEST-NET-1, never routable
  3179. Server svr;
  3180. svr.Get("/hi", [](const Request & /*req*/, Response &res) {
  3181. res.set_content("Hello World!", "text/plain");
  3182. });
  3183. auto port = svr.bind_to_any_port(HOST);
  3184. auto thread = std::thread([&]() { svr.listen_after_bind(); });
  3185. auto se = detail::scope_exit([&] {
  3186. svr.stop();
  3187. thread.join();
  3188. ASSERT_FALSE(svr.is_running());
  3189. });
  3190. svr.wait_until_ready();
  3191. Client cli(blackhole, port);
  3192. cli.set_hostname_addr_map({{blackhole, ""}});
  3193. cli.set_connection_timeout(1);
  3194. auto res = cli.Get("/hi");
  3195. EXPECT_FALSE(res) << "empty mapping must not redirect to loopback";
  3196. }
  3197. TEST(AbsoluteRedirectTest, Redirect_Online) {
  3198. auto host = "httpbingo.org";
  3199. auto path = std::string{"/absolute-redirect/3"};
  3200. #ifdef CPPHTTPLIB_SSL_ENABLED
  3201. SSLClient cli(host);
  3202. #else
  3203. Client cli(host);
  3204. #endif
  3205. cli.set_follow_location(true);
  3206. auto res = cli.Get(path);
  3207. ASSERT_TRUE(res) << "Error: " << to_string(res.error());
  3208. EXPECT_EQ(StatusCode::OK_200, res->status);
  3209. }
  3210. TEST(RedirectTest, Redirect_Online) {
  3211. auto host = "httpbingo.org";
  3212. auto path = std::string{"/redirect/3"};
  3213. #ifdef CPPHTTPLIB_SSL_ENABLED
  3214. SSLClient cli(host);
  3215. #else
  3216. Client cli(host);
  3217. #endif
  3218. cli.set_follow_location(true);
  3219. auto res = cli.Get(path);
  3220. ASSERT_TRUE(res) << "Error: " << to_string(res.error());
  3221. EXPECT_EQ(StatusCode::OK_200, res->status);
  3222. }
  3223. TEST(RelativeRedirectTest, Redirect_Online) {
  3224. auto host = "httpbingo.org";
  3225. auto path = std::string{"/relative-redirect/3"};
  3226. #ifdef CPPHTTPLIB_SSL_ENABLED
  3227. SSLClient cli(host);
  3228. #else
  3229. Client cli(host);
  3230. #endif
  3231. cli.set_follow_location(true);
  3232. auto res = cli.Get(path);
  3233. ASSERT_TRUE(res) << "Error: " << to_string(res.error());
  3234. EXPECT_EQ(StatusCode::OK_200, res->status);
  3235. }
  3236. TEST(TooManyRedirectTest, Redirect_Online) {
  3237. auto host = "httpbingo.org";
  3238. auto path = std::string{"/redirect/21"};
  3239. #ifdef CPPHTTPLIB_SSL_ENABLED
  3240. SSLClient cli(host);
  3241. #else
  3242. Client cli(host);
  3243. #endif
  3244. cli.set_follow_location(true);
  3245. auto res = cli.Get(path);
  3246. ASSERT_TRUE(!res);
  3247. EXPECT_EQ(Error::ExceedRedirectCount, res.error());
  3248. }
  3249. #ifdef CPPHTTPLIB_SSL_ENABLED
  3250. TEST(YahooRedirectTest, Redirect_Online) {
  3251. Client cli("yahoo.com");
  3252. auto res = cli.Get("/");
  3253. ASSERT_TRUE(res) << "Error: " << to_string(res.error());
  3254. EXPECT_EQ(StatusCode::MovedPermanently_301, res->status);
  3255. cli.set_follow_location(true);
  3256. res = cli.Get("/");
  3257. ASSERT_TRUE(res) << "Error: " << to_string(res.error());
  3258. EXPECT_EQ(StatusCode::OK_200, res->status);
  3259. EXPECT_EQ("https://www.yahoo.com/", res->location);
  3260. }
  3261. // Previously "nghttp2.org" "/httpbin/redirect-to"
  3262. #define REDIR_HOST "httpbingo.org"
  3263. #define REDIR_PATH "/redirect-to"
  3264. TEST(HttpsToHttpRedirectTest, Redirect_Online) {
  3265. SSLClient cli(REDIR_HOST);
  3266. cli.set_follow_location(true);
  3267. auto res =
  3268. cli.Get(REDIR_PATH "?url=http%3A%2F%2Fexample.com&status_code=302");
  3269. ASSERT_TRUE(res) << "Error: " << to_string(res.error());
  3270. EXPECT_EQ(StatusCode::OK_200, res->status);
  3271. }
  3272. TEST(HttpsToHttpRedirectTest2, Redirect_Online) {
  3273. SSLClient cli(REDIR_HOST);
  3274. cli.set_follow_location(true);
  3275. Params params;
  3276. params.emplace("url", "http://example.com");
  3277. params.emplace("status_code", "302");
  3278. auto res = cli.Get(REDIR_PATH, params, Headers{});
  3279. ASSERT_TRUE(res) << "Error: " << to_string(res.error());
  3280. EXPECT_EQ(StatusCode::OK_200, res->status);
  3281. }
  3282. TEST(HttpsToHttpRedirectTest3, Redirect_Online) {
  3283. SSLClient cli(REDIR_HOST);
  3284. cli.set_follow_location(true);
  3285. Params params;
  3286. params.emplace("url", "http://example.com");
  3287. auto res = cli.Get(REDIR_PATH "?status_code=302", params, Headers{});
  3288. ASSERT_TRUE(res) << "Error: " << to_string(res.error());
  3289. EXPECT_EQ(StatusCode::OK_200, res->status);
  3290. }
  3291. TEST(UrlWithSpace, Redirect_Online) {
  3292. SSLClient cli("edge.forgecdn.net");
  3293. cli.set_follow_location(true);
  3294. auto res = cli.Get("/files/2595/310/Neat 1.4-17.jar");
  3295. ASSERT_TRUE(res) << "Error: " << to_string(res.error());
  3296. EXPECT_EQ(StatusCode::OK_200, res->status);
  3297. EXPECT_EQ(18527U, res->get_header_value_u64("Content-Length"));
  3298. }
  3299. #endif
  3300. #if !defined(_WIN32) && !defined(_WIN64)
  3301. TEST(ReceiveSignals, Signal) {
  3302. auto setupSignalHandlers = []() {
  3303. struct sigaction act;
  3304. sigemptyset(&act.sa_mask);
  3305. act.sa_flags = SA_SIGINFO;
  3306. act.sa_sigaction = [](int sig, siginfo_t *, void *) {
  3307. switch (sig) {
  3308. case SIGINT:
  3309. default: break;
  3310. }
  3311. };
  3312. ::sigaction(SIGINT, &act, nullptr);
  3313. };
  3314. Server svr;
  3315. int port = 0;
  3316. auto thread = std::thread([&]() {
  3317. setupSignalHandlers();
  3318. port = svr.bind_to_any_port(HOST);
  3319. svr.listen_after_bind();
  3320. });
  3321. auto se = detail::scope_exit([&] {
  3322. svr.stop();
  3323. thread.join();
  3324. ASSERT_FALSE(svr.is_running());
  3325. });
  3326. svr.wait_until_ready();
  3327. ASSERT_TRUE(svr.is_running());
  3328. pthread_kill(thread.native_handle(), SIGINT);
  3329. std::this_thread::sleep_for(std::chrono::milliseconds(100));
  3330. ASSERT_TRUE(svr.is_running());
  3331. }
  3332. #endif
  3333. TEST(RedirectToDifferentPort, Redirect) {
  3334. Server svr1;
  3335. svr1.Get("/1", [&](const Request & /*req*/, Response &res) {
  3336. res.set_content("Hello World!", "text/plain");
  3337. });
  3338. int svr1_port = 0;
  3339. auto thread1 = std::thread([&]() {
  3340. svr1_port = svr1.bind_to_any_port(HOST);
  3341. svr1.listen_after_bind();
  3342. });
  3343. Server svr2;
  3344. svr2.Get("/2", [&](const Request & /*req*/, Response &res) {
  3345. res.set_redirect("http://localhost:" + std::to_string(svr1_port) + "/1");
  3346. });
  3347. int svr2_port = 0;
  3348. auto thread2 = std::thread([&]() {
  3349. svr2_port = svr2.bind_to_any_port(HOST);
  3350. svr2.listen_after_bind();
  3351. });
  3352. auto se = detail::scope_exit([&] {
  3353. svr2.stop();
  3354. thread2.join();
  3355. svr1.stop();
  3356. thread1.join();
  3357. ASSERT_FALSE(svr2.is_running());
  3358. ASSERT_FALSE(svr1.is_running());
  3359. });
  3360. svr1.wait_until_ready();
  3361. svr2.wait_until_ready();
  3362. Client cli("localhost", svr2_port);
  3363. cli.set_follow_location(true);
  3364. auto res = cli.Get("/2");
  3365. ASSERT_TRUE(res) << "Error: " << to_string(res.error());
  3366. EXPECT_EQ(StatusCode::OK_200, res->status);
  3367. EXPECT_EQ("Hello World!", res->body);
  3368. }
  3369. // GET /redir on one server redirects to /target on another port, so the
  3370. // client follows it with a new client.
  3371. static Result
  3372. GetThroughRedirectToDifferentPort(Server::Handler target,
  3373. const std::function<void(Client &)> &setup,
  3374. const Headers &headers = Headers()) {
  3375. Server target_svr;
  3376. target_svr.Get("/target", target);
  3377. int target_port = 0;
  3378. auto target_thread = std::thread([&]() {
  3379. target_port = target_svr.bind_to_any_port(HOST);
  3380. target_svr.listen_after_bind();
  3381. });
  3382. Server origin_svr;
  3383. origin_svr.Get("/redir", [&](const Request &, Response &res) {
  3384. res.set_redirect(
  3385. "http://localhost:" + std::to_string(target_port) + "/target", 302);
  3386. });
  3387. int origin_port = 0;
  3388. auto origin_thread = std::thread([&]() {
  3389. origin_port = origin_svr.bind_to_any_port(HOST);
  3390. origin_svr.listen_after_bind();
  3391. });
  3392. auto se = detail::scope_exit([&] {
  3393. origin_svr.stop();
  3394. origin_thread.join();
  3395. target_svr.stop();
  3396. target_thread.join();
  3397. });
  3398. target_svr.wait_until_ready();
  3399. origin_svr.wait_until_ready();
  3400. Client cli("localhost", origin_port);
  3401. cli.set_follow_location(true);
  3402. setup(cli);
  3403. return cli.Get("/redir", headers);
  3404. }
  3405. static void
  3406. TestDoNotForwardCredentialsOnRedirect(std::function<void(Client &)> set_auth) {
  3407. std::string captured_authorization;
  3408. auto result = GetThroughRedirectToDifferentPort(
  3409. [&](const Request &req, Response &res) {
  3410. captured_authorization = req.get_header_value("Authorization");
  3411. res.set_content("OK", "text/plain");
  3412. },
  3413. set_auth);
  3414. ASSERT_TRUE(result) << "Error: " << to_string(result.error());
  3415. EXPECT_EQ(StatusCode::OK_200, result->status);
  3416. // RFC 9110: credentials MUST NOT be forwarded to a different host
  3417. EXPECT_TRUE(captured_authorization.empty());
  3418. }
  3419. TEST(RedirectToDifferentPort, DoNotForwardCredentialsBasicAuth) {
  3420. TestDoNotForwardCredentialsOnRedirect(
  3421. [](Client &cli) { cli.set_basic_auth("admin", "secret"); });
  3422. }
  3423. TEST(RedirectToDifferentPort, DoNotForwardCredentialsBearerToken) {
  3424. TestDoNotForwardCredentialsOnRedirect(
  3425. [](Client &cli) { cli.set_bearer_token_auth("my-secret-token"); });
  3426. }
  3427. TEST(RedirectToDifferentPort, DoNotForwardCookie) {
  3428. std::string captured_cookie;
  3429. auto result = GetThroughRedirectToDifferentPort(
  3430. [&](const Request &req, Response &res) {
  3431. captured_cookie = req.get_header_value("Cookie");
  3432. res.set_content("OK", "text/plain");
  3433. },
  3434. [](Client &) {}, {{"Cookie", "session_id=SECRET; auth=PRIVATE"}});
  3435. ASSERT_TRUE(result) << "Error: " << to_string(result.error());
  3436. EXPECT_EQ(StatusCode::OK_200, result->status);
  3437. // Cookie MUST NOT be forwarded to a different host (GHSA-22mf-w2v3-r2jv)
  3438. EXPECT_TRUE(captured_cookie.empty());
  3439. }
  3440. TEST(RedirectToSamePort, ForwardCookie) {
  3441. // A same-origin redirect (same scheme/host/port) should preserve the Cookie
  3442. // header so that ordinary session flows keep working.
  3443. Server svr;
  3444. std::string captured_cookie;
  3445. svr.Get("/redir", [&](const Request & /*req*/, Response &res) {
  3446. res.set_redirect("/target", 302);
  3447. });
  3448. svr.Get("/target", [&](const Request &req, Response &res) {
  3449. captured_cookie = req.get_header_value("Cookie");
  3450. res.set_content("OK", "text/plain");
  3451. });
  3452. auto port = svr.bind_to_any_port(HOST);
  3453. auto thread = std::thread([&]() { svr.listen_after_bind(); });
  3454. auto se = detail::scope_exit([&] {
  3455. svr.stop();
  3456. thread.join();
  3457. ASSERT_FALSE(svr.is_running());
  3458. });
  3459. svr.wait_until_ready();
  3460. Client cli(HOST, port);
  3461. cli.set_follow_location(true);
  3462. Headers headers = {{"Cookie", "session_id=SECRET"}};
  3463. auto res = cli.Get("/redir", headers);
  3464. ASSERT_TRUE(res) << "Error: " << to_string(res.error());
  3465. EXPECT_EQ(StatusCode::OK_200, res->status);
  3466. EXPECT_EQ("session_id=SECRET", captured_cookie);
  3467. }
  3468. TEST(RedirectToDifferentPort, ForwardDefaultHeadersButNotCredentials) {
  3469. std::string authorization;
  3470. std::string trace_id;
  3471. auto result = GetThroughRedirectToDifferentPort(
  3472. [&](const Request &req, Response &res) {
  3473. authorization = req.get_header_value("Authorization");
  3474. trace_id = req.get_header_value("X-Trace-Id");
  3475. res.set_content("OK", "text/plain");
  3476. },
  3477. [](Client &cli) {
  3478. cli.set_default_headers(
  3479. {{"Authorization", "Bearer SECRET"}, {"X-Trace-Id", "42"}});
  3480. });
  3481. ASSERT_TRUE(result) << "Error: " << to_string(result.error());
  3482. EXPECT_EQ(StatusCode::OK_200, result->status);
  3483. // Like a header given with the request, a default one goes along unless it
  3484. // carries credentials (RFC 9110 15.4).
  3485. EXPECT_TRUE(authorization.empty());
  3486. EXPECT_EQ("42", trace_id);
  3487. }
  3488. TEST(RedirectToDifferentPort, KeepPayloadMaxLength) {
  3489. auto result = GetThroughRedirectToDifferentPort(
  3490. [](const Request &, Response &res) {
  3491. res.set_content(std::string(2048, 'x'), "text/plain");
  3492. },
  3493. [](Client &cli) { cli.set_payload_max_length(1024); });
  3494. EXPECT_FALSE(result);
  3495. }
  3496. TEST(RedirectToDifferentPort, KeepMaxTimeout) {
  3497. auto result = GetThroughRedirectToDifferentPort(
  3498. [](const Request &req, Response &res) {
  3499. // Answer after a second, or once the client gives up.
  3500. for (auto i = 0; i < 100 && !req.is_connection_closed(); i++) {
  3501. std::this_thread::sleep_for(std::chrono::milliseconds(10));
  3502. }
  3503. res.set_content("late", "text/plain");
  3504. },
  3505. [](Client &cli) { cli.set_max_timeout(std::chrono::milliseconds(200)); });
  3506. ASSERT_FALSE(result);
  3507. EXPECT_EQ(Error::Read, result.error());
  3508. }
  3509. #ifdef CPPHTTPLIB_SSL_ENABLED
  3510. TEST(RedirectToDifferentPort, DoNotAnswerChallengeFromRedirectTarget) {
  3511. auto result = GetThroughRedirectToDifferentPort(
  3512. [](const Request &, Response &res) {
  3513. res.status = StatusCode::Unauthorized_401;
  3514. res.set_header("WWW-Authenticate",
  3515. "Digest realm=\"r\", nonce=\"n\", qop=\"auth\"");
  3516. },
  3517. [](Client &cli) { cli.set_digest_auth("user", "pass"); });
  3518. ASSERT_TRUE(result) << "Error: " << to_string(result.error());
  3519. EXPECT_EQ(StatusCode::Unauthorized_401, result->status);
  3520. }
  3521. #endif
  3522. TEST(RedirectToDifferentPort, OverflowPortNumber) {
  3523. Server svr;
  3524. svr.Get("/redir", [&](const Request & /*req*/, Response &res) {
  3525. // Port number that overflows int — should not crash
  3526. res.set_redirect("http://localhost:99999999999999999999/target");
  3527. });
  3528. auto port = svr.bind_to_any_port(HOST);
  3529. auto thread = std::thread([&]() { svr.listen_after_bind(); });
  3530. auto se = detail::scope_exit([&] {
  3531. svr.stop();
  3532. thread.join();
  3533. ASSERT_FALSE(svr.is_running());
  3534. });
  3535. svr.wait_until_ready();
  3536. Client cli(HOST, port);
  3537. cli.set_follow_location(true);
  3538. auto res = cli.Get("/redir");
  3539. // Should fail gracefully, not crash (no valid response due to bad port)
  3540. EXPECT_FALSE(res);
  3541. }
  3542. TEST(RedirectToDifferentPort, TrailingCharactersInPort) {
  3543. Server svr;
  3544. auto port = svr.bind_to_any_port(HOST);
  3545. svr.Get("/redir", [&](const Request & /*req*/, Response &res) {
  3546. // The server's own port followed by junk must not be followed
  3547. res.set_redirect("http://" + std::string(HOST) + ":" +
  3548. std::to_string(port) + "junk/target");
  3549. });
  3550. svr.Get("/target", [&](const Request & /*req*/, Response &res) {
  3551. res.set_content("target", "text/plain");
  3552. });
  3553. auto thread = std::thread([&]() { svr.listen_after_bind(); });
  3554. auto se = detail::scope_exit([&] {
  3555. svr.stop();
  3556. thread.join();
  3557. ASSERT_FALSE(svr.is_running());
  3558. });
  3559. svr.wait_until_ready();
  3560. Client cli(HOST, port);
  3561. cli.set_follow_location(true);
  3562. auto res = cli.Get("/redir");
  3563. EXPECT_FALSE(res);
  3564. }
  3565. TEST(RedirectFromPageWithContent, Redirect) {
  3566. Server svr;
  3567. svr.Get("/1", [&](const Request & /*req*/, Response &res) {
  3568. res.set_content("___", "text/plain");
  3569. res.set_redirect("/2");
  3570. });
  3571. svr.Get("/2", [&](const Request & /*req*/, Response &res) {
  3572. res.set_content("Hello World!", "text/plain");
  3573. });
  3574. auto th = std::thread([&]() { svr.listen("localhost", PORT); });
  3575. auto se = detail::scope_exit([&] {
  3576. svr.stop();
  3577. th.join();
  3578. ASSERT_FALSE(svr.is_running());
  3579. });
  3580. svr.wait_until_ready();
  3581. {
  3582. Client cli("localhost", PORT);
  3583. cli.set_follow_location(true);
  3584. std::string body;
  3585. auto res = cli.Get("/1", [&](const char *data, size_t data_length) {
  3586. body.append(data, data_length);
  3587. return true;
  3588. });
  3589. ASSERT_TRUE(res) << "Error: " << to_string(res.error());
  3590. EXPECT_EQ(StatusCode::OK_200, res->status);
  3591. EXPECT_EQ("Hello World!", body);
  3592. }
  3593. {
  3594. Client cli("localhost", PORT);
  3595. std::string body;
  3596. auto res = cli.Get("/1", [&](const char *data, size_t data_length) {
  3597. body.append(data, data_length);
  3598. return true;
  3599. });
  3600. ASSERT_TRUE(res) << "Error: " << to_string(res.error());
  3601. EXPECT_EQ(StatusCode::Found_302, res->status);
  3602. EXPECT_EQ("___", body);
  3603. }
  3604. }
  3605. TEST(RedirectFromPageWithContentIP6, Redirect) {
  3606. Server svr;
  3607. auto port_str = std::to_string(PORT);
  3608. auto redirect_url = "http://[::1]:" + port_str + "/2";
  3609. auto expected_host = "[::1]:" + port_str;
  3610. svr.Get("/1", [&](const Request & /*req*/, Response &res) {
  3611. res.set_content("___", "text/plain");
  3612. // res.set_redirect("/2");
  3613. res.set_redirect(redirect_url);
  3614. });
  3615. svr.Get("/2", [&](const Request &req, Response &res) {
  3616. auto host_header = req.headers.find("Host");
  3617. ASSERT_TRUE(host_header != req.headers.end());
  3618. EXPECT_EQ(expected_host, host_header->second);
  3619. res.set_content("Hello World!", "text/plain");
  3620. });
  3621. auto th = std::thread([&]() { svr.listen("::1", PORT); });
  3622. auto se = detail::scope_exit([&] {
  3623. svr.stop();
  3624. th.join();
  3625. ASSERT_FALSE(svr.is_running());
  3626. });
  3627. // When IPV6 support isn't available svr.listen("::1", PORT) never
  3628. // actually starts anything, so the condition !svr.is_running() will
  3629. // always remain true, and the loop never stops.
  3630. // This basically counts how many milliseconds have passed since the
  3631. // call to svr.listen(), and if after 5 seconds nothing started yet
  3632. // aborts the test.
  3633. for (unsigned int milliseconds = 0; !svr.is_running(); milliseconds++) {
  3634. std::this_thread::sleep_for(std::chrono::milliseconds(1));
  3635. ASSERT_LT(milliseconds, 5000U);
  3636. }
  3637. {
  3638. Client cli("::1", PORT);
  3639. cli.set_follow_location(true);
  3640. std::string body;
  3641. auto res = cli.Get("/1", [&](const char *data, size_t data_length) {
  3642. body.append(data, data_length);
  3643. return true;
  3644. });
  3645. ASSERT_TRUE(res) << "Error: " << to_string(res.error());
  3646. EXPECT_EQ(StatusCode::OK_200, res->status);
  3647. EXPECT_EQ("Hello World!", body);
  3648. }
  3649. {
  3650. Client cli("::1", PORT);
  3651. std::string body;
  3652. auto res = cli.Get("/1", [&](const char *data, size_t data_length) {
  3653. body.append(data, data_length);
  3654. return true;
  3655. });
  3656. ASSERT_TRUE(res) << "Error: " << to_string(res.error());
  3657. EXPECT_EQ(StatusCode::Found_302, res->status);
  3658. EXPECT_EQ("___", body);
  3659. }
  3660. }
  3661. TEST(PathUrlEncodeTest, PathUrlEncode) {
  3662. Server svr;
  3663. svr.Get("/foo", [](const Request &req, Response &res) {
  3664. auto a = req.params.find("a");
  3665. if (a != req.params.end()) {
  3666. res.set_content((*a).second, "text/plain");
  3667. res.status = StatusCode::OK_200;
  3668. } else {
  3669. res.status = StatusCode::BadRequest_400;
  3670. }
  3671. });
  3672. auto thread = std::thread([&]() { svr.listen(HOST, PORT); });
  3673. auto se = detail::scope_exit([&] {
  3674. svr.stop();
  3675. thread.join();
  3676. ASSERT_FALSE(svr.is_running());
  3677. });
  3678. svr.wait_until_ready();
  3679. {
  3680. Client cli(HOST, PORT);
  3681. cli.set_path_encode(false);
  3682. auto res = cli.Get("/foo?a=explicitly+encoded");
  3683. ASSERT_TRUE(res) << "Error: " << to_string(res.error());
  3684. EXPECT_EQ(StatusCode::OK_200, res->status);
  3685. // This expects it back with a space, as the `+` won't have been
  3686. // url-encoded, and server-side the params get decoded turning `+`
  3687. // into spaces.
  3688. EXPECT_EQ("explicitly encoded", res->body);
  3689. }
  3690. }
  3691. TEST(PathUrlEncodeTest, PreEncodedQueryNotReencoded) {
  3692. // When path encoding is disabled the client must transmit the supplied
  3693. // query verbatim. Decoding-then-re-encoding it (the previous behavior)
  3694. // corrupts pre-encoded binary payloads: e.g. `%20` would be turned into
  3695. // `+`, which a strict RFC 3986 server decodes back as `+` (0x2B) rather
  3696. // than a space (0x20). Assert on the raw wire target to catch this.
  3697. Server svr;
  3698. const std::string expected_target = "/foo?q=a%20b%2Cc%24d%3Bx&a=%00%FF";
  3699. svr.Get("/foo", [&](const Request &req, Response &res) {
  3700. EXPECT_EQ(expected_target, req.target);
  3701. res.status = StatusCode::OK_200;
  3702. });
  3703. auto thread = std::thread([&]() { svr.listen(HOST, PORT); });
  3704. auto se = detail::scope_exit([&] {
  3705. svr.stop();
  3706. thread.join();
  3707. ASSERT_FALSE(svr.is_running());
  3708. });
  3709. svr.wait_until_ready();
  3710. {
  3711. Client cli(HOST, PORT);
  3712. cli.set_path_encode(false);
  3713. auto res = cli.Get(expected_target.c_str());
  3714. ASSERT_TRUE(res) << "Error: " << to_string(res.error());
  3715. EXPECT_EQ(StatusCode::OK_200, res->status);
  3716. }
  3717. }
  3718. TEST(PathUrlEncodeTest, StreamingMatchesBufferedTarget) {
  3719. // `open_stream()` used to skip the path encoding that the buffered send
  3720. // path applies, so the same `path` produced different bytes in the request
  3721. // line depending on which API was used. Assert the two agree.
  3722. Server svr;
  3723. std::string target;
  3724. svr.Get(".*", [&](const Request &req, Response &res) {
  3725. target = req.target;
  3726. res.status = StatusCode::OK_200;
  3727. });
  3728. auto port = svr.bind_to_any_port(HOST);
  3729. auto thread = std::thread([&]() { svr.listen_after_bind(); });
  3730. auto se = detail::scope_exit([&] {
  3731. svr.stop();
  3732. thread.join();
  3733. ASSERT_FALSE(svr.is_running());
  3734. });
  3735. svr.wait_until_ready();
  3736. struct {
  3737. const char *path;
  3738. const char *expected;
  3739. } cases[] = {
  3740. {"/a b?x=1", "/a%20b?x=1"},
  3741. {"/\xE6\x97\xA5\xE6\x9C\xAC", "/%E6%97%A5%E6%9C%AC"},
  3742. {"/a,b;c+d", "/a%2Cb%3Bc%2Bd"},
  3743. };
  3744. for (const auto &c : cases) {
  3745. Client cli(HOST, port);
  3746. target.clear();
  3747. auto res = cli.Get(c.path);
  3748. ASSERT_TRUE(res) << "Error: " << to_string(res.error());
  3749. EXPECT_EQ(c.expected, target) << "buffered path: " << c.path;
  3750. auto buffered_target = target;
  3751. target.clear();
  3752. auto handle = cli.open_stream("GET", c.path);
  3753. EXPECT_TRUE(handle.is_valid())
  3754. << "streaming path: " << c.path << ", " << to_string(handle.error);
  3755. EXPECT_EQ(buffered_target, target) << "streaming path: " << c.path;
  3756. }
  3757. }
  3758. TEST(PathUrlEncodeTest, StreamingPreEncodedQueryNotReencoded) {
  3759. // The `set_path_encode(false)` contract — transmit the supplied target
  3760. // verbatim — must hold for the streaming API too.
  3761. Server svr;
  3762. const std::string expected_target = "/foo?q=a%20b%2Cc%24d%3Bx&a=%00%FF";
  3763. std::string target;
  3764. svr.Get("/foo", [&](const Request &req, Response &res) {
  3765. target = req.target;
  3766. res.status = StatusCode::OK_200;
  3767. });
  3768. auto port = svr.bind_to_any_port(HOST);
  3769. auto thread = std::thread([&]() { svr.listen_after_bind(); });
  3770. auto se = detail::scope_exit([&] {
  3771. svr.stop();
  3772. thread.join();
  3773. ASSERT_FALSE(svr.is_running());
  3774. });
  3775. svr.wait_until_ready();
  3776. {
  3777. Client cli(HOST, port);
  3778. cli.set_path_encode(false);
  3779. auto handle = cli.open_stream("GET", expected_target);
  3780. EXPECT_TRUE(handle.is_valid()) << to_string(handle.error);
  3781. EXPECT_EQ(expected_target, target);
  3782. }
  3783. }
  3784. TEST(PathUrlEncodeTest, StreamingCRLFInTargetIsEncoded) {
  3785. // With path encoding enabled a CR/LF in the target is percent-encoded
  3786. // rather than rejected, matching the buffered send path. The CR/LF guard in
  3787. // write_request_line still backstops `set_path_encode(false)`, which is
  3788. // covered by StreamingCRLFRejectedWhenPathEncodeDisabled.
  3789. Server svr;
  3790. // Captured before routing: the decoded path contains a newline, which a
  3791. // `.*` handler pattern would not match (`.` excludes `\n` in std::regex).
  3792. std::string target;
  3793. svr.set_pre_routing_handler([&](const Request &req, Response &res) {
  3794. target = req.target;
  3795. res.status = StatusCode::OK_200;
  3796. return Server::HandlerResponse::Handled;
  3797. });
  3798. auto port = svr.bind_to_any_port(HOST);
  3799. auto thread = std::thread([&]() { svr.listen_after_bind(); });
  3800. auto se = detail::scope_exit([&] {
  3801. svr.stop();
  3802. thread.join();
  3803. ASSERT_FALSE(svr.is_running());
  3804. });
  3805. svr.wait_until_ready();
  3806. {
  3807. Client cli(HOST, port);
  3808. auto handle = cli.open_stream("GET", "/a\r\nX-Injected: 1");
  3809. EXPECT_TRUE(handle.is_valid()) << to_string(handle.error);
  3810. EXPECT_EQ("/a%0D%0AX-Injected:%201", target);
  3811. }
  3812. }
  3813. TEST(PathUrlEncodeTest, ControlCharsInPathAreEncoded) {
  3814. // Every control character is percent-encoded, not just CR/LF, so the target
  3815. // passes the request-target check in write_request_line.
  3816. Server svr;
  3817. std::string target;
  3818. svr.set_pre_routing_handler([&](const Request &req, Response &res) {
  3819. target = req.target;
  3820. res.status = StatusCode::OK_200;
  3821. return Server::HandlerResponse::Handled;
  3822. });
  3823. auto port = svr.bind_to_any_port(HOST);
  3824. auto thread = std::thread([&]() { svr.listen_after_bind(); });
  3825. auto se = detail::scope_exit([&] {
  3826. svr.stop();
  3827. thread.join();
  3828. ASSERT_FALSE(svr.is_running());
  3829. });
  3830. svr.wait_until_ready();
  3831. {
  3832. Client cli(HOST, port);
  3833. auto res = cli.Get("/a\tb\x1b\x7f");
  3834. ASSERT_TRUE(res) << "Error: " << to_string(res.error());
  3835. EXPECT_EQ("/a%09b%1B%7F", target);
  3836. }
  3837. }
  3838. TEST(PathUrlEncodeTest, StreamingCRLFRejectedWhenPathEncodeDisabled) {
  3839. // Nothing may reach the wire: a raw CR/LF target would split the request
  3840. // line and inject headers.
  3841. Server svr;
  3842. // Pre-routing so that "not called" means nothing reached the server at all,
  3843. // rather than merely failing to match a handler pattern.
  3844. auto handler_called = false;
  3845. svr.set_pre_routing_handler([&](const Request & /*req*/, Response &res) {
  3846. handler_called = true;
  3847. res.status = StatusCode::OK_200;
  3848. return Server::HandlerResponse::Handled;
  3849. });
  3850. auto port = svr.bind_to_any_port(HOST);
  3851. auto thread = std::thread([&]() { svr.listen_after_bind(); });
  3852. auto se = detail::scope_exit([&] {
  3853. svr.stop();
  3854. thread.join();
  3855. ASSERT_FALSE(svr.is_running());
  3856. });
  3857. svr.wait_until_ready();
  3858. {
  3859. Client cli(HOST, port);
  3860. cli.set_path_encode(false);
  3861. auto handle = cli.open_stream("GET", "/a\r\nX-Injected: 1");
  3862. EXPECT_FALSE(handle.is_valid());
  3863. EXPECT_EQ(Error::Write, handle.error);
  3864. EXPECT_FALSE(handler_called);
  3865. }
  3866. }
  3867. TEST(PathUrlEncodeTest, RequestParamsBranchSelection) {
  3868. // Which of the two branches runs is decided by whether the query component
  3869. // is empty, not by whether `req.path` contains a `?`: a trailing `?` yields
  3870. // an empty query and must still fall back to building one from
  3871. // `req.params`, while a non-empty query must win over `req.params`.
  3872. Server svr;
  3873. std::string target;
  3874. svr.Get("/foo", [&](const Request &req, Response &res) {
  3875. target = req.target;
  3876. res.status = StatusCode::OK_200;
  3877. });
  3878. auto port = svr.bind_to_any_port(HOST);
  3879. auto thread = std::thread([&]() { svr.listen_after_bind(); });
  3880. auto se = detail::scope_exit([&] {
  3881. svr.stop();
  3882. thread.join();
  3883. ASSERT_FALSE(svr.is_running());
  3884. });
  3885. svr.wait_until_ready();
  3886. {
  3887. // Trailing `?` -> empty query component -> `req.params` is used.
  3888. Client cli(HOST, port);
  3889. Request req;
  3890. req.method = "GET";
  3891. req.path = "/foo?";
  3892. req.params.emplace("a", "1");
  3893. target.clear();
  3894. auto res = cli.send(req);
  3895. ASSERT_TRUE(res) << "Error: " << to_string(res.error());
  3896. EXPECT_EQ("/foo?a=1", target);
  3897. }
  3898. {
  3899. // Non-empty query in `req.path` -> `req.params` is not appended.
  3900. Client cli(HOST, port);
  3901. Request req;
  3902. req.method = "GET";
  3903. req.path = "/foo?b=2";
  3904. req.params.emplace("a", "1");
  3905. target.clear();
  3906. auto res = cli.send(req);
  3907. ASSERT_TRUE(res) << "Error: " << to_string(res.error());
  3908. EXPECT_EQ("/foo?b=2", target);
  3909. }
  3910. }
  3911. TEST(PathUrlEncodeTest, IncludePercentEncodingLF) {
  3912. Server svr;
  3913. svr.Get("/", [](const Request &req, Response &) {
  3914. EXPECT_EQ("\x0A", req.get_param_value("something"));
  3915. });
  3916. auto thread = std::thread([&]() { svr.listen(HOST, PORT); });
  3917. auto se = detail::scope_exit([&] {
  3918. svr.stop();
  3919. thread.join();
  3920. ASSERT_FALSE(svr.is_running());
  3921. });
  3922. svr.wait_until_ready();
  3923. {
  3924. Client cli(HOST, PORT);
  3925. cli.set_path_encode(false);
  3926. auto res = cli.Get("/?something=%0A");
  3927. ASSERT_TRUE(res) << "Error: " << to_string(res.error());
  3928. EXPECT_EQ(StatusCode::OK_200, res->status);
  3929. }
  3930. }
  3931. TEST(BindServerTest, BindDualStack) {
  3932. Server svr;
  3933. svr.Get("/1", [&](const Request & /*req*/, Response &res) {
  3934. res.set_content("Hello World!", "text/plain");
  3935. });
  3936. auto thread = std::thread([&]() { svr.listen("::", PORT); });
  3937. auto se = detail::scope_exit([&] {
  3938. svr.stop();
  3939. thread.join();
  3940. ASSERT_FALSE(svr.is_running());
  3941. });
  3942. svr.wait_until_ready();
  3943. {
  3944. Client cli("127.0.0.1", PORT);
  3945. auto res = cli.Get("/1");
  3946. ASSERT_TRUE(res) << "Error: " << to_string(res.error());
  3947. EXPECT_EQ(StatusCode::OK_200, res->status);
  3948. EXPECT_EQ("Hello World!", res->body);
  3949. }
  3950. {
  3951. Client cli("::1", PORT);
  3952. auto res = cli.Get("/1");
  3953. ASSERT_TRUE(res) << "Error: " << to_string(res.error());
  3954. EXPECT_EQ(StatusCode::OK_200, res->status);
  3955. EXPECT_EQ("Hello World!", res->body);
  3956. }
  3957. }
  3958. TEST(BindServerTest, BindAndListenSeparately) {
  3959. Server svr;
  3960. int port = svr.bind_to_any_port("0.0.0.0");
  3961. ASSERT_TRUE(svr.is_valid());
  3962. ASSERT_TRUE(port > 0);
  3963. svr.stop();
  3964. }
  3965. // Reports whether anything is still listening on a loopback port. A plain
  3966. // connect() is used instead of a Client request because a socket left bound by
  3967. // mistake accepts the connection into its backlog and never answers, which
  3968. // would hang the test instead of failing it.
  3969. static bool is_loopback_port_accepting(int port) {
  3970. sockaddr_in addr{};
  3971. addr.sin_family = AF_INET;
  3972. addr.sin_port = htons(static_cast<uint16_t>(port));
  3973. addr.sin_addr.s_addr = htonl(INADDR_LOOPBACK);
  3974. socket_t sock = ::socket(AF_INET, SOCK_STREAM, 0);
  3975. EXPECT_NE(sock, INVALID_SOCKET);
  3976. if (sock == INVALID_SOCKET) { return false; }
  3977. auto ret = ::connect(sock, reinterpret_cast<sockaddr *>(&addr),
  3978. static_cast<socklen_t>(sizeof(addr)));
  3979. detail::close_socket(sock);
  3980. return ret == 0;
  3981. }
  3982. TEST(BindServerTest, StopClosesBoundSocketWithoutListen) {
  3983. Server svr;
  3984. auto port = svr.bind_to_any_port("127.0.0.1");
  3985. ASSERT_TRUE(port > 0);
  3986. svr.stop();
  3987. // bind_to_any_port() already called listen(2), so until stop() closed the
  3988. // descriptor the port kept accepting connections into the backlog. ASSERT
  3989. // rather than EXPECT: with the socket still open, the listen_after_bind()
  3990. // below blocks forever in the accept loop.
  3991. ASSERT_FALSE(is_loopback_port_accepting(port));
  3992. // Nothing is left to accept on, so listen_after_bind() must report failure
  3993. // instead of returning success without ever serving.
  3994. EXPECT_FALSE(svr.listen_after_bind());
  3995. // The failed listen marks the server decommissioned, so a waiter returns
  3996. // instead of spinning forever.
  3997. svr.wait_until_ready();
  3998. }
  3999. #ifdef CPPHTTPLIB_SSL_ENABLED
  4000. TEST(BindServerTest, BindAndListenSeparatelySSL) {
  4001. SSLServer svr(SERVER_CERT_FILE, SERVER_PRIVATE_KEY_FILE, CLIENT_CA_CERT_FILE,
  4002. CLIENT_CA_CERT_DIR);
  4003. int port = svr.bind_to_any_port("0.0.0.0");
  4004. ASSERT_TRUE(svr.is_valid());
  4005. ASSERT_TRUE(port > 0);
  4006. svr.stop();
  4007. }
  4008. // SSLServer::is_valid() overrides the base version, so it has to chain to it
  4009. // or a rejected CustomRoute() registration would not stop the server binding.
  4010. TEST(BindServerTest, SSLServerIsInvalidAfterRejectedCustomRoute) {
  4011. SSLServer svr(SERVER_CERT_FILE, SERVER_PRIVATE_KEY_FILE, CLIENT_CA_CERT_FILE,
  4012. CLIENT_CA_CERT_DIR);
  4013. ASSERT_TRUE(svr.is_valid());
  4014. svr.CustomRoute("GET", "/x", [](const Request &, Response &) {});
  4015. EXPECT_FALSE(svr.is_valid());
  4016. EXPECT_TRUE(svr.bind_to_any_port("0.0.0.0") < 0);
  4017. }
  4018. TEST(BindServerTest, BindAndListenSeparatelySSLEncryptedKey) {
  4019. SSLServer svr(SERVER_ENCRYPTED_CERT_FILE, SERVER_ENCRYPTED_PRIVATE_KEY_FILE,
  4020. nullptr, nullptr, SERVER_ENCRYPTED_PRIVATE_KEY_PASS);
  4021. int port = svr.bind_to_any_port("0.0.0.0");
  4022. ASSERT_TRUE(svr.is_valid());
  4023. ASSERT_TRUE(port > 0);
  4024. svr.stop();
  4025. }
  4026. TEST(BindServerTest, UpdateCertsPem) {
  4027. SSLServer svr(SERVER_CERT_FILE, SERVER_PRIVATE_KEY_FILE, CLIENT_CA_CERT_FILE);
  4028. int port = svr.bind_to_any_port("0.0.0.0");
  4029. ASSERT_TRUE(svr.is_valid());
  4030. ASSERT_TRUE(port > 0);
  4031. // Read PEM files
  4032. std::string cert_pem, key_pem, ca_pem;
  4033. read_file(SERVER_CERT_FILE, cert_pem);
  4034. read_file(SERVER_PRIVATE_KEY_FILE, key_pem);
  4035. read_file(CLIENT_CA_CERT_FILE, ca_pem);
  4036. // Update server certificates using PEM API
  4037. ASSERT_TRUE(
  4038. svr.update_certs_pem(cert_pem.c_str(), key_pem.c_str(), ca_pem.c_str()));
  4039. ASSERT_TRUE(svr.is_valid());
  4040. svr.stop();
  4041. }
  4042. TEST(SSLClientServerTest, UpdateCertsPemWithClientAuth) {
  4043. // Start server with client CA (enables client auth)
  4044. SSLServer svr(SERVER_CERT_FILE, SERVER_PRIVATE_KEY_FILE, CLIENT_CA_CERT_FILE);
  4045. ASSERT_TRUE(svr.is_valid());
  4046. bool handler_called = false;
  4047. svr.Get("/test", [&](const Request &req, Response &res) {
  4048. handler_called = true;
  4049. // Verify client certificate is present
  4050. auto cert = req.peer_cert();
  4051. EXPECT_TRUE(static_cast<bool>(cert));
  4052. res.set_content("ok", "text/plain");
  4053. });
  4054. thread t = thread([&]() { ASSERT_TRUE(svr.listen(HOST, PORT)); });
  4055. auto se = detail::scope_exit([&] {
  4056. svr.stop();
  4057. t.join();
  4058. ASSERT_FALSE(svr.is_running());
  4059. });
  4060. svr.wait_until_ready();
  4061. // Read PEM files
  4062. std::string cert_pem, key_pem, ca_pem;
  4063. read_file(SERVER_CERT_FILE, cert_pem);
  4064. read_file(SERVER_PRIVATE_KEY_FILE, key_pem);
  4065. read_file(CLIENT_CA_CERT_FILE, ca_pem);
  4066. // Update server certificates and client CA using PEM API while server running
  4067. ASSERT_TRUE(
  4068. svr.update_certs_pem(cert_pem.c_str(), key_pem.c_str(), ca_pem.c_str()));
  4069. // Connect with client certificate
  4070. SSLClient cli(HOST, PORT, CLIENT_CERT_FILE, CLIENT_PRIVATE_KEY_FILE);
  4071. cli.enable_server_certificate_verification(false);
  4072. cli.set_connection_timeout(30);
  4073. auto res = cli.Get("/test");
  4074. ASSERT_TRUE(res) << "Error: " << to_string(res.error());
  4075. ASSERT_EQ(StatusCode::OK_200, res->status);
  4076. ASSERT_TRUE(handler_called);
  4077. EXPECT_EQ("ok", res->body);
  4078. }
  4079. // Puts a CA that did not sign the client's certificate in the old one's place.
  4080. static bool replace_client_ca(SSLServer &svr) {
  4081. std::string cert_pem, key_pem, ca_pem;
  4082. read_file(SERVER_CERT_FILE, cert_pem);
  4083. read_file(SERVER_PRIVATE_KEY_FILE, key_pem);
  4084. read_file(SERVER_CERT2_FILE, ca_pem);
  4085. return svr.update_certs_pem(cert_pem.c_str(), key_pem.c_str(),
  4086. ca_pem.c_str());
  4087. }
  4088. TEST(SSLClientServerTest, UpdateCertsPemReplacesClientCA) {
  4089. SSLServer svr(SERVER_CERT_FILE, SERVER_PRIVATE_KEY_FILE, CLIENT_CA_CERT_FILE);
  4090. ASSERT_TRUE(svr.is_valid());
  4091. svr.Get("/test", [](const Request &, Response &res) {
  4092. res.set_content("ok", "text/plain");
  4093. });
  4094. thread t = thread([&]() { ASSERT_TRUE(svr.listen(HOST, PORT)); });
  4095. auto se = detail::scope_exit([&] {
  4096. svr.stop();
  4097. t.join();
  4098. ASSERT_FALSE(svr.is_running());
  4099. });
  4100. svr.wait_until_ready();
  4101. auto get = [] {
  4102. SSLClient cli(HOST, PORT, CLIENT_CERT_FILE, CLIENT_PRIVATE_KEY_FILE);
  4103. cli.enable_server_certificate_verification(false);
  4104. return cli.Get("/test");
  4105. };
  4106. ASSERT_TRUE(get());
  4107. ASSERT_TRUE(replace_client_ca(svr));
  4108. EXPECT_FALSE(get());
  4109. }
  4110. TEST(SSLClientServerTest, ThrowingVerifyCallbackRejectsTheCertificate) {
  4111. SSLServer svr(SERVER_CERT_FILE, SERVER_PRIVATE_KEY_FILE, CLIENT_CA_CERT_FILE);
  4112. ASSERT_TRUE(svr.is_valid());
  4113. tls::set_verify_callback(svr.tls_context(),
  4114. [](const tls::VerifyContext &) -> bool {
  4115. throw std::runtime_error("verify");
  4116. });
  4117. svr.Get("/test", [](const Request &, Response &res) {
  4118. res.set_content("ok", "text/plain");
  4119. });
  4120. thread t = thread([&]() { ASSERT_TRUE(svr.listen(HOST, PORT)); });
  4121. auto se = detail::scope_exit([&] {
  4122. svr.stop();
  4123. t.join();
  4124. ASSERT_FALSE(svr.is_running());
  4125. });
  4126. svr.wait_until_ready();
  4127. auto get = [] {
  4128. SSLClient cli(HOST, PORT, CLIENT_CERT_FILE, CLIENT_PRIVATE_KEY_FILE);
  4129. cli.enable_server_certificate_verification(false);
  4130. return cli.Get("/test");
  4131. };
  4132. EXPECT_FALSE(get());
  4133. // The handshake is over, so an update does not wait for it.
  4134. std::string cert_pem, key_pem;
  4135. read_file(SERVER_CERT_FILE, cert_pem);
  4136. read_file(SERVER_PRIVATE_KEY_FILE, key_pem);
  4137. EXPECT_TRUE(svr.update_certs_pem(cert_pem.c_str(), key_pem.c_str()));
  4138. tls::set_verify_callback(svr.tls_context(), [](const tls::VerifyContext &v) {
  4139. return v.preverify_ok;
  4140. });
  4141. auto res = get();
  4142. ASSERT_TRUE(res) << "Error: " << to_string(res.error());
  4143. EXPECT_EQ("ok", res->body);
  4144. }
  4145. #ifdef CPPHTTPLIB_OPENSSL_SUPPORT
  4146. // Sends each request over a new connection with a client certificate,
  4147. // resuming the session of the one before when there is one.
  4148. class ResumingClient {
  4149. public:
  4150. ResumingClient() : ctx_(SSL_CTX_new(TLS_client_method())) {
  4151. SSL_CTX_use_certificate_file(ctx_, CLIENT_CERT_FILE, SSL_FILETYPE_PEM);
  4152. SSL_CTX_use_PrivateKey_file(ctx_, CLIENT_PRIVATE_KEY_FILE,
  4153. SSL_FILETYPE_PEM);
  4154. }
  4155. ~ResumingClient() {
  4156. SSL_SESSION_free(session_);
  4157. SSL_CTX_free(ctx_);
  4158. }
  4159. // Tells whether the request was answered.
  4160. bool get() {
  4161. auto error = Error::Success;
  4162. auto sock = detail::create_client_socket(
  4163. HOST, "", PORT, AF_UNSPEC, false, false, nullptr,
  4164. /*connection_timeout_sec=*/5, 0,
  4165. /*read_timeout_sec=*/5, 0,
  4166. /*write_timeout_sec=*/5, 0, std::string(), error);
  4167. if (sock == INVALID_SOCKET) { return false; }
  4168. auto sock_se = detail::scope_exit([&] { detail::close_socket(sock); });
  4169. auto ssl = SSL_new(ctx_);
  4170. auto ssl_se = detail::scope_exit([&] { SSL_free(ssl); });
  4171. SSL_set_fd(ssl, static_cast<int>(sock));
  4172. if (session_) { SSL_set_session(ssl, session_); }
  4173. if (SSL_connect(ssl) != 1) { return false; }
  4174. reused_ = SSL_session_reused(ssl) == 1;
  4175. // Reading the response also takes in a TLS 1.3 session ticket.
  4176. std::string req = "GET /test HTTP/1.1\r\nHost: x\r\n"
  4177. "Connection: close\r\n\r\n";
  4178. SSL_write(ssl, req.data(), static_cast<int>(req.size()));
  4179. std::string res;
  4180. char buf[256];
  4181. int n;
  4182. while ((n = SSL_read(ssl, buf, sizeof(buf))) > 0) {
  4183. res.append(buf, static_cast<size_t>(n));
  4184. }
  4185. // Without a proper shutdown, OpenSSL marks the session not resumable.
  4186. SSL_shutdown(ssl);
  4187. SSL_SESSION_free(session_);
  4188. session_ = SSL_get1_session(ssl);
  4189. return res.find("200 OK") != std::string::npos;
  4190. }
  4191. // Whether the last connection resumed a session
  4192. bool reused() const { return reused_; }
  4193. private:
  4194. SSL_CTX *ctx_;
  4195. SSL_SESSION *session_ = nullptr;
  4196. bool reused_ = false;
  4197. };
  4198. // A client that resumes its session gets through, but not once the client CA
  4199. // has changed, as a resumed session does not show the certificate again.
  4200. TEST(SSLClientServerTest, ClientResumesSessionUntilClientCAChanges) {
  4201. SSLServer svr(SERVER_CERT_FILE, SERVER_PRIVATE_KEY_FILE, CLIENT_CA_CERT_FILE);
  4202. ASSERT_TRUE(svr.is_valid());
  4203. svr.Get("/test", [](const Request &, Response &res) {
  4204. res.set_content("ok", "text/plain");
  4205. });
  4206. thread t = thread([&]() { ASSERT_TRUE(svr.listen(HOST, PORT)); });
  4207. auto se = detail::scope_exit([&] {
  4208. svr.stop();
  4209. t.join();
  4210. ASSERT_FALSE(svr.is_running());
  4211. });
  4212. svr.wait_until_ready();
  4213. ResumingClient cli;
  4214. ASSERT_TRUE(cli.get());
  4215. ASSERT_TRUE(cli.get());
  4216. EXPECT_TRUE(cli.reused());
  4217. ASSERT_TRUE(replace_client_ca(svr));
  4218. EXPECT_FALSE(cli.get());
  4219. }
  4220. // A resumed session does not show the certificate again, so the server does
  4221. // not resume one with a verify callback to run on it.
  4222. TEST(SSLClientServerTest, NoSessionResumptionWithVerifyCallback) {
  4223. SSLServer svr(SERVER_CERT_FILE, SERVER_PRIVATE_KEY_FILE, CLIENT_CA_CERT_FILE);
  4224. ASSERT_TRUE(svr.is_valid());
  4225. tls::set_verify_callback(svr.tls_context(), [](const tls::VerifyContext &v) {
  4226. return v.preverify_ok;
  4227. });
  4228. svr.Get("/test", [](const Request &, Response &res) {
  4229. res.set_content("ok", "text/plain");
  4230. });
  4231. thread t = thread([&]() { ASSERT_TRUE(svr.listen(HOST, PORT)); });
  4232. auto se = detail::scope_exit([&] {
  4233. svr.stop();
  4234. t.join();
  4235. ASSERT_FALSE(svr.is_running());
  4236. });
  4237. svr.wait_until_ready();
  4238. ResumingClient cli;
  4239. ASSERT_TRUE(cli.get());
  4240. ASSERT_TRUE(cli.get());
  4241. EXPECT_FALSE(cli.reused());
  4242. }
  4243. #endif
  4244. #ifdef CPPHTTPLIB_WOLFSSL_SUPPORT
  4245. // wolfSSL shares its session cache between contexts, so a resumed session
  4246. // could carry a client certificate checked against another server's CA, or
  4247. // against a client CA since replaced.
  4248. TEST(SSLClientServerTest, ClientSessionIsNotResumedPastItsCA) {
  4249. SSLServer svr(SERVER_CERT_FILE, SERVER_PRIVATE_KEY_FILE, CLIENT_CA_CERT_FILE);
  4250. ASSERT_TRUE(svr.is_valid());
  4251. // Trusts a CA that did not sign the client's certificate.
  4252. SSLServer other(SERVER_CERT_FILE, SERVER_PRIVATE_KEY_FILE, SERVER_CERT2_FILE);
  4253. ASSERT_TRUE(other.is_valid());
  4254. for (auto s : {&svr, &other}) {
  4255. s->Get("/test", [](const Request &, Response &res) {
  4256. res.set_content("ok", "text/plain");
  4257. });
  4258. }
  4259. thread t = thread([&]() { ASSERT_TRUE(svr.listen(HOST, PORT)); });
  4260. thread t2 = thread([&]() { ASSERT_TRUE(other.listen(HOST, PORT + 1)); });
  4261. auto se = detail::scope_exit([&] {
  4262. other.stop();
  4263. svr.stop();
  4264. t2.join();
  4265. t.join();
  4266. });
  4267. svr.wait_until_ready();
  4268. other.wait_until_ready();
  4269. auto ctx = wolfSSL_CTX_new(wolfTLSv1_2_client_method());
  4270. auto ctx_se = detail::scope_exit([&] { wolfSSL_CTX_free(ctx); });
  4271. wolfSSL_CTX_set_verify(ctx, WOLFSSL_VERIFY_NONE, nullptr);
  4272. ASSERT_EQ(WOLFSSL_SUCCESS, wolfSSL_CTX_use_certificate_file(
  4273. ctx, CLIENT_CERT_FILE, WOLFSSL_FILETYPE_PEM));
  4274. ASSERT_EQ(WOLFSSL_SUCCESS,
  4275. wolfSSL_CTX_use_PrivateKey_file(ctx, CLIENT_PRIVATE_KEY_FILE,
  4276. WOLFSSL_FILETYPE_PEM));
  4277. WOLFSSL_SESSION *session = nullptr;
  4278. auto session_se = detail::scope_exit([&] {
  4279. if (session) { wolfSSL_SESSION_free(session); }
  4280. });
  4281. // A request over a new connection, resuming `session` when there is one and
  4282. // keeping the connection's own in its place. Tells whether it was answered.
  4283. auto get = [&](int port) {
  4284. auto error = Error::Success;
  4285. auto sock = detail::create_client_socket(
  4286. HOST, "", port, AF_UNSPEC, false, false, nullptr,
  4287. /*connection_timeout_sec=*/5, 0,
  4288. /*read_timeout_sec=*/5, 0,
  4289. /*write_timeout_sec=*/5, 0, std::string(), error);
  4290. if (sock == INVALID_SOCKET) { return false; }
  4291. auto sock_se = detail::scope_exit([&] { detail::close_socket(sock); });
  4292. auto ssl = wolfSSL_new(ctx);
  4293. auto ssl_se = detail::scope_exit([&] { wolfSSL_free(ssl); });
  4294. wolfSSL_set_fd(ssl, static_cast<int>(sock));
  4295. if (session) { wolfSSL_set_session(ssl, session); }
  4296. if (wolfSSL_connect(ssl) != WOLFSSL_SUCCESS) { return false; }
  4297. std::string req = "GET /test HTTP/1.1\r\nHost: x\r\n"
  4298. "Connection: close\r\n\r\n";
  4299. wolfSSL_write(ssl, req.data(), static_cast<int>(req.size()));
  4300. std::string res;
  4301. char buf[256];
  4302. int n;
  4303. while ((n = wolfSSL_read(ssl, buf, sizeof(buf))) > 0) {
  4304. res.append(buf, static_cast<size_t>(n));
  4305. }
  4306. wolfSSL_shutdown(ssl);
  4307. if (session) { wolfSSL_SESSION_free(session); }
  4308. session = wolfSSL_get1_session(ssl);
  4309. return res.find("200 OK") != std::string::npos;
  4310. };
  4311. ASSERT_TRUE(get(PORT));
  4312. EXPECT_FALSE(get(PORT + 1));
  4313. ASSERT_TRUE(get(PORT));
  4314. ASSERT_TRUE(replace_client_ca(svr));
  4315. EXPECT_FALSE(get(PORT));
  4316. }
  4317. #endif
  4318. TEST(SSLClientServerTest, UpdateCertsPemWaitsForHandshakeInProgress) {
  4319. SSLServer svr(SERVER_CERT_FILE, SERVER_PRIVATE_KEY_FILE);
  4320. ASSERT_TRUE(svr.is_valid());
  4321. svr.Get("/test", [](const Request &, Response &res) {
  4322. res.set_content("ok", "text/plain");
  4323. });
  4324. thread t = thread([&]() { ASSERT_TRUE(svr.listen(HOST, PORT)); });
  4325. auto se = detail::scope_exit([&] {
  4326. svr.stop();
  4327. t.join();
  4328. ASSERT_FALSE(svr.is_running());
  4329. });
  4330. svr.wait_until_ready();
  4331. // A connection that sends no ClientHello keeps its handshake in progress,
  4332. // once the server has had a moment to start it.
  4333. auto error = Error::Success;
  4334. auto sock = detail::create_client_socket(
  4335. HOST, "", PORT, AF_UNSPEC, false, false, nullptr,
  4336. /*connection_timeout_sec=*/5, 0,
  4337. /*read_timeout_sec=*/5, 0,
  4338. /*write_timeout_sec=*/5, 0, std::string(), error);
  4339. ASSERT_NE(INVALID_SOCKET, sock);
  4340. std::this_thread::sleep_for(std::chrono::milliseconds(500));
  4341. std::string cert_pem, key_pem;
  4342. read_file(SERVER_CERT_FILE, cert_pem);
  4343. read_file(SERVER_PRIVATE_KEY_FILE, key_pem);
  4344. auto update = std::async(std::launch::async, [&]() {
  4345. return svr.update_certs_pem(cert_pem.c_str(), key_pem.c_str());
  4346. });
  4347. EXPECT_EQ(std::future_status::timeout,
  4348. update.wait_for(std::chrono::milliseconds(200)));
  4349. detail::close_socket(sock);
  4350. EXPECT_TRUE(update.get());
  4351. SSLClient cli(HOST, PORT);
  4352. cli.enable_server_certificate_verification(false);
  4353. auto res = cli.Get("/test");
  4354. ASSERT_TRUE(res) << "Error: " << to_string(res.error());
  4355. EXPECT_EQ(StatusCode::OK_200, res->status);
  4356. }
  4357. #endif
  4358. TEST(ErrorHandlerTest, ContentLength) {
  4359. Server svr;
  4360. svr.set_error_handler([](const Request & /*req*/, Response &res) {
  4361. res.status = StatusCode::OK_200;
  4362. res.set_content("abcdefghijklmnopqrstuvwxyz",
  4363. "text/html"); // <= Content-Length still 13
  4364. });
  4365. svr.Get("/hi", [](const Request & /*req*/, Response &res) {
  4366. res.set_content("Hello World!\n", "text/plain");
  4367. res.status = 524;
  4368. });
  4369. auto thread = std::thread([&]() { svr.listen(HOST, PORT); });
  4370. auto se = detail::scope_exit([&] {
  4371. svr.stop();
  4372. thread.join();
  4373. ASSERT_FALSE(svr.is_running());
  4374. });
  4375. svr.wait_until_ready();
  4376. {
  4377. Client cli(HOST, PORT);
  4378. auto res = cli.Get("/hi", Headers{{"Accept-Encoding", ""}});
  4379. ASSERT_TRUE(res) << "Error: " << to_string(res.error());
  4380. EXPECT_EQ(StatusCode::OK_200, res->status);
  4381. EXPECT_EQ("text/html", res->get_header_value("Content-Type"));
  4382. EXPECT_EQ("26", res->get_header_value("Content-Length"));
  4383. EXPECT_EQ("abcdefghijklmnopqrstuvwxyz", res->body);
  4384. }
  4385. }
  4386. #ifndef CPPHTTPLIB_NO_EXCEPTIONS
  4387. TEST(ExceptionTest, WithoutExceptionHandler) {
  4388. Server svr;
  4389. svr.Get("/exception", [&](const Request & /*req*/, Response & /*res*/) {
  4390. throw std::runtime_error("exception...");
  4391. });
  4392. svr.Get("/unknown", [&](const Request & /*req*/, Response & /*res*/) {
  4393. throw std::runtime_error("exception\r\n...");
  4394. });
  4395. auto listen_thread = std::thread([&svr]() { svr.listen("localhost", PORT); });
  4396. auto se = detail::scope_exit([&] {
  4397. svr.stop();
  4398. listen_thread.join();
  4399. ASSERT_FALSE(svr.is_running());
  4400. });
  4401. svr.wait_until_ready();
  4402. Client cli("localhost", PORT);
  4403. {
  4404. auto res = cli.Get("/exception");
  4405. ASSERT_TRUE(res) << "Error: " << to_string(res.error());
  4406. EXPECT_EQ(StatusCode::InternalServerError_500, res->status);
  4407. EXPECT_FALSE(res->has_header("EXCEPTION_WHAT"));
  4408. }
  4409. {
  4410. auto res = cli.Get("/unknown");
  4411. ASSERT_TRUE(res) << "Error: " << to_string(res.error());
  4412. EXPECT_EQ(StatusCode::InternalServerError_500, res->status);
  4413. EXPECT_FALSE(res->has_header("EXCEPTION_WHAT"));
  4414. }
  4415. }
  4416. TEST(ExceptionTest, WithExceptionHandler) {
  4417. Server svr;
  4418. svr.set_exception_handler([](const Request & /*req*/, Response &res,
  4419. std::exception_ptr ep) {
  4420. EXPECT_FALSE(ep == nullptr);
  4421. try {
  4422. std::rethrow_exception(ep);
  4423. } catch (std::exception &e) {
  4424. EXPECT_EQ("abc", std::string(e.what()));
  4425. } catch (...) {}
  4426. res.status = StatusCode::InternalServerError_500;
  4427. res.set_content("abcdefghijklmnopqrstuvwxyz",
  4428. "text/html"); // <= Content-Length still 13 at this point
  4429. });
  4430. svr.Get("/hi", [](const Request & /*req*/, Response &res) {
  4431. res.set_content("Hello World!\n", "text/plain");
  4432. throw std::runtime_error("abc");
  4433. });
  4434. auto thread = std::thread([&]() { svr.listen(HOST, PORT); });
  4435. auto se = detail::scope_exit([&] {
  4436. svr.stop();
  4437. thread.join();
  4438. ASSERT_FALSE(svr.is_running());
  4439. });
  4440. svr.wait_until_ready();
  4441. for (size_t i = 0; i < 10; i++) {
  4442. Client cli(HOST, PORT);
  4443. for (size_t j = 0; j < 100; j++) {
  4444. auto res = cli.Get("/hi", Headers{{"Accept-Encoding", ""}});
  4445. ASSERT_TRUE(res) << "Error: " << to_string(res.error());
  4446. EXPECT_EQ(StatusCode::InternalServerError_500, res->status);
  4447. EXPECT_EQ("text/html", res->get_header_value("Content-Type"));
  4448. EXPECT_EQ("26", res->get_header_value("Content-Length"));
  4449. EXPECT_EQ("abcdefghijklmnopqrstuvwxyz", res->body);
  4450. }
  4451. cli.set_keep_alive(true);
  4452. for (size_t j = 0; j < 100; j++) {
  4453. auto res = cli.Get("/hi", Headers{{"Accept-Encoding", ""}});
  4454. ASSERT_TRUE(res) << "Error: " << to_string(res.error());
  4455. EXPECT_EQ(StatusCode::InternalServerError_500, res->status);
  4456. EXPECT_EQ("text/html", res->get_header_value("Content-Type"));
  4457. EXPECT_EQ("26", res->get_header_value("Content-Length"));
  4458. EXPECT_EQ("abcdefghijklmnopqrstuvwxyz", res->body);
  4459. }
  4460. }
  4461. }
  4462. TEST(ExceptionTest, AndErrorHandler) {
  4463. Server svr;
  4464. svr.set_error_handler([](const Request & /*req*/, Response &res) {
  4465. if (res.body.empty()) { res.set_content("NOT_FOUND", "text/html"); }
  4466. });
  4467. svr.set_exception_handler(
  4468. [](const Request & /*req*/, Response &res, std::exception_ptr ep) {
  4469. EXPECT_FALSE(ep == nullptr);
  4470. try {
  4471. std::rethrow_exception(ep);
  4472. } catch (std::exception &e) {
  4473. res.set_content(e.what(), "text/html");
  4474. } catch (...) {}
  4475. res.status = StatusCode::InternalServerError_500;
  4476. });
  4477. svr.Get("/exception", [](const Request & /*req*/, Response & /*res*/) {
  4478. throw std::runtime_error("EXCEPTION");
  4479. });
  4480. svr.Get("/error", [](const Request & /*req*/, Response &res) {
  4481. res.set_content("ERROR", "text/html");
  4482. res.status = StatusCode::InternalServerError_500;
  4483. });
  4484. auto thread = std::thread([&]() { svr.listen(HOST, PORT); });
  4485. auto se = detail::scope_exit([&] {
  4486. svr.stop();
  4487. thread.join();
  4488. ASSERT_FALSE(svr.is_running());
  4489. });
  4490. svr.wait_until_ready();
  4491. Client cli(HOST, PORT);
  4492. {
  4493. auto res = cli.Get("/exception");
  4494. ASSERT_TRUE(res) << "Error: " << to_string(res.error());
  4495. EXPECT_EQ("text/html", res->get_header_value("Content-Type"));
  4496. EXPECT_EQ("EXCEPTION", res->body);
  4497. }
  4498. {
  4499. auto res = cli.Get("/error");
  4500. ASSERT_TRUE(res) << "Error: " << to_string(res.error());
  4501. EXPECT_EQ(StatusCode::InternalServerError_500, res->status);
  4502. EXPECT_EQ("ERROR", res->body);
  4503. }
  4504. {
  4505. auto res = cli.Get("/invalid");
  4506. ASSERT_TRUE(res) << "Error: " << to_string(res.error());
  4507. EXPECT_EQ(StatusCode::NotFound_404, res->status);
  4508. EXPECT_EQ("NOT_FOUND", res->body);
  4509. }
  4510. }
  4511. #endif
  4512. #ifndef CPPHTTPLIB_NO_EXCEPTIONS
  4513. // process_request() wraps only routing() in a try/catch, so an exception from
  4514. // any other user callback used to unwind into the task queue - which does not
  4515. // catch - and terminate the process. Each test below runs the server on a
  4516. // single worker thread: a guard that catches the exception but still loses the
  4517. // thread would otherwise be hidden by a spare worker serving the follow-up
  4518. // request. Note that a regression here aborts the whole test binary rather
  4519. // than failing one test.
  4520. TEST(ServerExceptionTest, ThrowingContentProviderDoesNotKillTheServer) {
  4521. Server svr;
  4522. svr.new_task_queue = [] { return new ThreadPool(1); };
  4523. std::atomic<int> reported{0};
  4524. svr.set_error_logger([&](const Error &err, const Request * /*req*/) {
  4525. if (err == Error::UserCallbackException) { reported++; }
  4526. });
  4527. svr.Get("/throw", [](const Request & /*req*/, Response &res) {
  4528. res.set_content_provider(
  4529. 1024, "text/plain",
  4530. [](size_t /*offset*/, size_t /*length*/, DataSink &sink) -> bool {
  4531. sink.write("hello", 5);
  4532. throw std::runtime_error("from the content provider");
  4533. });
  4534. });
  4535. svr.Get("/ok", [](const Request & /*req*/, Response &res) {
  4536. res.set_content("ok", "text/plain");
  4537. });
  4538. auto port = svr.bind_to_any_port(HOST);
  4539. auto listen_thread = std::thread([&svr]() { svr.listen_after_bind(); });
  4540. auto se = detail::scope_exit([&] {
  4541. svr.stop();
  4542. listen_thread.join();
  4543. ASSERT_FALSE(svr.is_running());
  4544. });
  4545. svr.wait_until_ready();
  4546. {
  4547. Client cli(HOST, port);
  4548. cli.set_read_timeout(5, 0);
  4549. EXPECT_FALSE(cli.Get("/throw"));
  4550. }
  4551. EXPECT_TRUE(svr.is_running());
  4552. EXPECT_EQ(1, reported.load());
  4553. // A request on a fresh connection is still served.
  4554. {
  4555. Client cli(HOST, port);
  4556. auto res = cli.Get("/ok");
  4557. ASSERT_TRUE(res) << "Error: " << to_string(res.error());
  4558. EXPECT_EQ(StatusCode::OK_200, res->status);
  4559. EXPECT_EQ("ok", res->body);
  4560. }
  4561. }
  4562. TEST(ServerExceptionTest, ThrowingPostRoutingHandlerDoesNotKillTheServer) {
  4563. Server svr;
  4564. svr.new_task_queue = [] { return new ThreadPool(1); };
  4565. std::atomic<bool> should_throw{true};
  4566. svr.Get("/hi", [](const Request & /*req*/, Response &res) {
  4567. res.set_content("hi", "text/plain");
  4568. });
  4569. svr.set_post_routing_handler(
  4570. [&](const Request & /*req*/, Response & /*res*/) {
  4571. if (should_throw) {
  4572. throw std::runtime_error("from the post-routing handler");
  4573. }
  4574. });
  4575. auto port = svr.bind_to_any_port(HOST);
  4576. auto listen_thread = std::thread([&svr]() { svr.listen_after_bind(); });
  4577. auto se = detail::scope_exit([&] {
  4578. svr.stop();
  4579. listen_thread.join();
  4580. ASSERT_FALSE(svr.is_running());
  4581. });
  4582. svr.wait_until_ready();
  4583. {
  4584. Client cli(HOST, port);
  4585. cli.set_read_timeout(5, 0);
  4586. EXPECT_FALSE(cli.Get("/hi"));
  4587. }
  4588. EXPECT_TRUE(svr.is_running());
  4589. should_throw = false;
  4590. {
  4591. Client cli(HOST, port);
  4592. auto res = cli.Get("/hi");
  4593. ASSERT_TRUE(res) << "Error: " << to_string(res.error());
  4594. EXPECT_EQ(StatusCode::OK_200, res->status);
  4595. EXPECT_EQ("hi", res->body);
  4596. }
  4597. }
  4598. TEST(ServerExceptionTest, ThrowingErrorLoggerDoesNotReopenTheGuard) {
  4599. // The guard reports the caught exception through the error logger, which is
  4600. // a user callback too. A logger that throws has to be contained as well, or
  4601. // the process would terminate from inside the catch.
  4602. Server svr;
  4603. svr.new_task_queue = [] { return new ThreadPool(1); };
  4604. std::atomic<int> reported{0};
  4605. svr.set_error_logger([&](const Error &err, const Request * /*req*/) {
  4606. if (err == Error::UserCallbackException) {
  4607. reported++;
  4608. throw std::runtime_error("from the error logger");
  4609. }
  4610. });
  4611. svr.Get("/throw", [](const Request & /*req*/, Response &res) {
  4612. res.set_content_provider(
  4613. 1024, "text/plain",
  4614. [](size_t /*offset*/, size_t /*length*/, DataSink &sink) -> bool {
  4615. sink.write("hello", 5);
  4616. throw std::runtime_error("from the content provider");
  4617. });
  4618. });
  4619. svr.Get("/ok", [](const Request & /*req*/, Response &res) {
  4620. res.set_content("ok", "text/plain");
  4621. });
  4622. auto port = svr.bind_to_any_port(HOST);
  4623. auto listen_thread = std::thread([&svr]() { svr.listen_after_bind(); });
  4624. auto se = detail::scope_exit([&] {
  4625. svr.stop();
  4626. listen_thread.join();
  4627. ASSERT_FALSE(svr.is_running());
  4628. });
  4629. svr.wait_until_ready();
  4630. {
  4631. Client cli(HOST, port);
  4632. cli.set_read_timeout(5, 0);
  4633. EXPECT_FALSE(cli.Get("/throw"));
  4634. }
  4635. EXPECT_TRUE(svr.is_running());
  4636. EXPECT_EQ(1, reported.load());
  4637. {
  4638. Client cli(HOST, port);
  4639. auto res = cli.Get("/ok");
  4640. ASSERT_TRUE(res) << "Error: " << to_string(res.error());
  4641. EXPECT_EQ(StatusCode::OK_200, res->status);
  4642. EXPECT_EQ("ok", res->body);
  4643. }
  4644. }
  4645. TEST(ServerExceptionTest, ThrowingWebSocketHandlerDoesNotKillTheServer) {
  4646. // A WebSocket handler runs on the upgrade path after the 101 has been sent,
  4647. // so the exception unwinds through the ws::WebSocket object on its way to
  4648. // the guard. None of the HTTP cases above cross that.
  4649. Server svr;
  4650. svr.new_task_queue = [] { return new ThreadPool(1); };
  4651. std::atomic<int> reported{0};
  4652. svr.set_error_logger([&](const Error &err, const Request * /*req*/) {
  4653. if (err == Error::UserCallbackException) { reported++; }
  4654. });
  4655. svr.WebSocket("/ws", [](const Request & /*req*/, ws::WebSocket & /*ws*/) {
  4656. throw std::runtime_error("from the WebSocket handler");
  4657. });
  4658. svr.Get("/ok", [](const Request & /*req*/, Response &res) {
  4659. res.set_content("ok", "text/plain");
  4660. });
  4661. auto port = svr.bind_to_any_port(HOST);
  4662. auto listen_thread = std::thread([&svr]() { svr.listen_after_bind(); });
  4663. auto se = detail::scope_exit([&] {
  4664. svr.stop();
  4665. listen_thread.join();
  4666. ASSERT_FALSE(svr.is_running());
  4667. });
  4668. svr.wait_until_ready();
  4669. {
  4670. ws::WebSocketClient client("ws://localhost:" + std::to_string(port) +
  4671. "/ws");
  4672. auto res = client.connect();
  4673. ASSERT_TRUE(res) << "Error: " << to_string(res.error());
  4674. // The server dropped the connection instead of dying.
  4675. std::string msg;
  4676. EXPECT_FALSE(client.read(msg));
  4677. client.close();
  4678. }
  4679. EXPECT_TRUE(svr.is_running());
  4680. EXPECT_EQ(1, reported.load());
  4681. {
  4682. Client cli(HOST, port);
  4683. auto res = cli.Get("/ok");
  4684. ASSERT_TRUE(res) << "Error: " << to_string(res.error());
  4685. EXPECT_EQ(StatusCode::OK_200, res->status);
  4686. EXPECT_EQ("ok", res->body);
  4687. }
  4688. }
  4689. #ifdef CPPHTTPLIB_SSL_ENABLED
  4690. TEST(ServerExceptionTest, ThrowingContentProviderDoesNotKillTheSSLServer) {
  4691. // SSLServer::process_and_close_socket() is a separate overload with its own
  4692. // guard, so it is exercised on its own.
  4693. SSLServer svr(SERVER_CERT_FILE, SERVER_PRIVATE_KEY_FILE);
  4694. ASSERT_TRUE(svr.is_valid());
  4695. svr.new_task_queue = [] { return new ThreadPool(1); };
  4696. std::atomic<int> reported{0};
  4697. svr.set_error_logger([&](const Error &err, const Request * /*req*/) {
  4698. if (err == Error::UserCallbackException) { reported++; }
  4699. });
  4700. svr.Get("/throw", [](const Request & /*req*/, Response &res) {
  4701. res.set_content_provider(
  4702. 1024, "text/plain",
  4703. [](size_t /*offset*/, size_t /*length*/, DataSink &sink) -> bool {
  4704. sink.write("hello", 5);
  4705. throw std::runtime_error("from the content provider");
  4706. });
  4707. });
  4708. svr.Get("/ok", [](const Request & /*req*/, Response &res) {
  4709. res.set_content("ok", "text/plain");
  4710. });
  4711. auto port = svr.bind_to_any_port(HOST);
  4712. auto listen_thread = std::thread([&svr]() { svr.listen_after_bind(); });
  4713. auto se = detail::scope_exit([&] {
  4714. svr.stop();
  4715. listen_thread.join();
  4716. ASSERT_FALSE(svr.is_running());
  4717. });
  4718. svr.wait_until_ready();
  4719. {
  4720. SSLClient cli(HOST, port);
  4721. cli.enable_server_certificate_verification(false);
  4722. cli.set_read_timeout(5, 0);
  4723. EXPECT_FALSE(cli.Get("/throw"));
  4724. }
  4725. EXPECT_TRUE(svr.is_running());
  4726. EXPECT_EQ(1, reported.load());
  4727. {
  4728. SSLClient cli(HOST, port);
  4729. cli.enable_server_certificate_verification(false);
  4730. auto res = cli.Get("/ok");
  4731. ASSERT_TRUE(res) << "Error: " << to_string(res.error());
  4732. EXPECT_EQ(StatusCode::OK_200, res->status);
  4733. EXPECT_EQ("ok", res->body);
  4734. }
  4735. }
  4736. #endif
  4737. #endif
  4738. TEST(NoContentTest, ContentLength) {
  4739. Server svr;
  4740. svr.Get("/hi", [](const Request & /*req*/, Response &res) {
  4741. res.status = StatusCode::NoContent_204;
  4742. });
  4743. auto thread = std::thread([&]() { svr.listen(HOST, PORT); });
  4744. auto se = detail::scope_exit([&] {
  4745. svr.stop();
  4746. thread.join();
  4747. ASSERT_FALSE(svr.is_running());
  4748. });
  4749. svr.wait_until_ready();
  4750. {
  4751. Client cli(HOST, PORT);
  4752. auto res = cli.Get("/hi");
  4753. ASSERT_TRUE(res) << "Error: " << to_string(res.error());
  4754. EXPECT_EQ(StatusCode::NoContent_204, res->status);
  4755. // RFC 9110 8.6: none in a 204 response
  4756. EXPECT_FALSE(res->has_header("Content-Length"));
  4757. }
  4758. }
  4759. TEST(ResponseFramingTest, HandlerFramingHeadersAreReplaced) {
  4760. Server svr;
  4761. svr.Get("/body", [](const Request & /*req*/, Response &res) {
  4762. res.set_header("Content-Length", "5");
  4763. res.set_content("hello world", "text/plain");
  4764. });
  4765. svr.Get("/chunked", [](const Request & /*req*/, Response &res) {
  4766. // A body that reads as the last chunk, were it taken as chunked
  4767. res.set_header("Transfer-Encoding", "chunked");
  4768. res.set_content("0\r\n\r\n", "text/plain");
  4769. });
  4770. svr.Get("/provider", [](const Request & /*req*/, Response &res) {
  4771. res.set_header("Content-Length", "2");
  4772. res.set_content_provider(5, "text/plain",
  4773. [](size_t offset, size_t length, DataSink &sink) {
  4774. sink.write(&"hello"[offset], length);
  4775. return true;
  4776. });
  4777. });
  4778. svr.Get("/empty", [](const Request & /*req*/, Response &res) {
  4779. res.set_header("Content-Length", "1234");
  4780. });
  4781. thread t = thread([&] { svr.listen(HOST, PORT); });
  4782. auto se = detail::scope_exit([&] {
  4783. svr.stop();
  4784. t.join();
  4785. ASSERT_FALSE(svr.is_running());
  4786. });
  4787. svr.wait_until_ready();
  4788. Client cli(HOST, PORT);
  4789. cli.set_read_timeout(1, 0);
  4790. auto expect_body = [&](const Result &res, const std::string &body) {
  4791. ASSERT_TRUE(res) << "Error: " << to_string(res.error());
  4792. EXPECT_EQ(body, res->body);
  4793. EXPECT_EQ(1u, res->get_header_value_count("Content-Length"));
  4794. EXPECT_FALSE(res->has_header("Transfer-Encoding"));
  4795. };
  4796. Headers identity{{"Accept-Encoding", ""}};
  4797. expect_body(cli.Get("/body", identity), "hello world");
  4798. expect_body(cli.Get("/chunked", identity), "0\r\n\r\n");
  4799. expect_body(cli.Get("/body",
  4800. Headers{{"Accept-Encoding", ""}, {"Range", "bytes=0-1"}}),
  4801. "he");
  4802. expect_body(cli.Get("/provider", identity), "hello");
  4803. expect_body(cli.Get("/empty", identity), "");
  4804. // A HEAD response may give the length of the body a GET would get.
  4805. auto res = cli.Head("/empty");
  4806. ASSERT_TRUE(res) << "Error: " << to_string(res.error());
  4807. EXPECT_EQ("1234", res->get_header_value("Content-Length"));
  4808. }
  4809. TEST(ResponseFramingTest, PostRoutingHandlerChangesAreFramed) {
  4810. Server svr;
  4811. svr.Get("/", [](const Request & /*req*/, Response &res) {
  4812. res.set_content("short", "text/plain");
  4813. });
  4814. svr.set_post_routing_handler([](const Request & /*req*/, Response &res) {
  4815. res.body += " with a footer";
  4816. res.set_header("Transfer-Encoding", "chunked");
  4817. });
  4818. thread t = thread([&] { svr.listen(HOST, PORT); });
  4819. auto se = detail::scope_exit([&] {
  4820. svr.stop();
  4821. t.join();
  4822. ASSERT_FALSE(svr.is_running());
  4823. });
  4824. svr.wait_until_ready();
  4825. Client cli(HOST, PORT);
  4826. cli.set_read_timeout(1, 0);
  4827. auto res = cli.Get("/", Headers{{"Accept-Encoding", ""}});
  4828. ASSERT_TRUE(res) << "Error: " << to_string(res.error());
  4829. EXPECT_EQ("short with a footer", res->body);
  4830. EXPECT_EQ("19", res->get_header_value("Content-Length"));
  4831. EXPECT_FALSE(res->has_header("Transfer-Encoding"));
  4832. }
  4833. TEST(ResponseFramingTest, BodyWithoutLengthEndsWithTheConnection) {
  4834. Server svr;
  4835. svr.Get("/", [](const Request & /*req*/, Response &res) {
  4836. res.set_header("Content-Length", "3");
  4837. res.set_content_provider("text/plain", [](size_t, DataSink &sink) {
  4838. sink.write("abc", 3);
  4839. sink.done();
  4840. return true;
  4841. });
  4842. });
  4843. thread t = thread([&] { svr.listen(HOST, PORT); });
  4844. auto se = detail::scope_exit([&] {
  4845. svr.stop();
  4846. t.join();
  4847. ASSERT_FALSE(svr.is_running());
  4848. });
  4849. svr.wait_until_ready();
  4850. Client cli(HOST, PORT);
  4851. cli.set_keep_alive(true);
  4852. auto res = cli.Get("/");
  4853. ASSERT_TRUE(res) << "Error: " << to_string(res.error());
  4854. EXPECT_EQ("abc", res->body);
  4855. EXPECT_FALSE(res->has_header("Content-Length"));
  4856. EXPECT_EQ("close", res->get_header_value("Connection"));
  4857. EXPECT_FALSE(res->has_header("Keep-Alive"));
  4858. // No body to delimit
  4859. auto head = cli.Head("/");
  4860. ASSERT_TRUE(head) << "Error: " << to_string(head.error());
  4861. EXPECT_FALSE(head->has_header("Connection"));
  4862. }
  4863. TEST(RoutingHandlerTest, PreAndPostRoutingHandlers) {
  4864. #ifdef CPPHTTPLIB_SSL_ENABLED
  4865. SSLServer svr(SERVER_CERT_FILE, SERVER_PRIVATE_KEY_FILE);
  4866. ASSERT_TRUE(svr.is_valid());
  4867. #else
  4868. Server svr;
  4869. #endif
  4870. svr.set_pre_routing_handler([](const Request &req, Response &res) {
  4871. if (req.path == "/routing_handler") {
  4872. res.set_header("PRE_ROUTING", "on");
  4873. res.set_content("Routing Handler", "text/plain");
  4874. return httplib::Server::HandlerResponse::Handled;
  4875. }
  4876. return httplib::Server::HandlerResponse::Unhandled;
  4877. });
  4878. svr.set_error_handler([](const Request & /*req*/, Response &res) {
  4879. res.set_content("Error", "text/html");
  4880. });
  4881. svr.set_post_routing_handler([](const Request &req, Response &res) {
  4882. if (req.path == "/routing_handler") {
  4883. res.set_header("POST_ROUTING", "on");
  4884. }
  4885. });
  4886. svr.Get("/hi", [](const Request & /*req*/, Response &res) {
  4887. res.set_content("Hello World!\n", "text/plain");
  4888. });
  4889. auto thread = std::thread([&]() { svr.listen(HOST, PORT); });
  4890. auto se = detail::scope_exit([&] {
  4891. svr.stop();
  4892. thread.join();
  4893. ASSERT_FALSE(svr.is_running());
  4894. });
  4895. svr.wait_until_ready();
  4896. {
  4897. #ifdef CPPHTTPLIB_SSL_ENABLED
  4898. SSLClient cli(HOST, PORT);
  4899. cli.enable_server_certificate_verification(false);
  4900. #else
  4901. Client cli(HOST, PORT);
  4902. #endif
  4903. auto res = cli.Get("/routing_handler");
  4904. ASSERT_TRUE(res) << "Error: " << to_string(res.error());
  4905. EXPECT_EQ(StatusCode::OK_200, res->status);
  4906. EXPECT_EQ("Routing Handler", res->body);
  4907. EXPECT_EQ(1U, res->get_header_value_count("PRE_ROUTING"));
  4908. EXPECT_EQ("on", res->get_header_value("PRE_ROUTING"));
  4909. EXPECT_EQ(1U, res->get_header_value_count("POST_ROUTING"));
  4910. EXPECT_EQ("on", res->get_header_value("POST_ROUTING"));
  4911. }
  4912. {
  4913. #ifdef CPPHTTPLIB_SSL_ENABLED
  4914. SSLClient cli(HOST, PORT);
  4915. cli.enable_server_certificate_verification(false);
  4916. #else
  4917. Client cli(HOST, PORT);
  4918. #endif
  4919. auto res = cli.Get("/hi");
  4920. ASSERT_TRUE(res) << "Error: " << to_string(res.error());
  4921. EXPECT_EQ(StatusCode::OK_200, res->status);
  4922. EXPECT_EQ("Hello World!\n", res->body);
  4923. EXPECT_EQ(0U, res->get_header_value_count("PRE_ROUTING"));
  4924. EXPECT_EQ(0U, res->get_header_value_count("POST_ROUTING"));
  4925. }
  4926. {
  4927. #ifdef CPPHTTPLIB_SSL_ENABLED
  4928. SSLClient cli(HOST, PORT);
  4929. cli.enable_server_certificate_verification(false);
  4930. #else
  4931. Client cli(HOST, PORT);
  4932. #endif
  4933. auto res = cli.Get("/aaa");
  4934. ASSERT_TRUE(res) << "Error: " << to_string(res.error());
  4935. EXPECT_EQ(StatusCode::NotFound_404, res->status);
  4936. EXPECT_EQ("Error", res->body);
  4937. EXPECT_EQ(0U, res->get_header_value_count("PRE_ROUTING"));
  4938. EXPECT_EQ(0U, res->get_header_value_count("POST_ROUTING"));
  4939. }
  4940. }
  4941. TEST(RequestHandlerTest, PreRequestHandler) {
  4942. auto route_path = "/user/:user";
  4943. Server svr;
  4944. svr.Get("/hi", [](const Request &, Response &res) {
  4945. res.set_content("hi", "text/plain");
  4946. });
  4947. svr.Get(route_path, [](const Request &req, Response &res) {
  4948. res.set_content(req.path_params.at("user"), "text/plain");
  4949. });
  4950. svr.set_pre_request_handler([&](const Request &req, Response &res) {
  4951. if (req.matched_route == route_path) {
  4952. auto user = req.path_params.at("user");
  4953. if (user != "john") {
  4954. res.status = StatusCode::Forbidden_403;
  4955. res.set_content("error", "text/html");
  4956. return Server::HandlerResponse::Handled;
  4957. }
  4958. }
  4959. return Server::HandlerResponse::Unhandled;
  4960. });
  4961. auto thread = std::thread([&]() { svr.listen(HOST, PORT); });
  4962. auto se = detail::scope_exit([&] {
  4963. svr.stop();
  4964. thread.join();
  4965. ASSERT_FALSE(svr.is_running());
  4966. });
  4967. svr.wait_until_ready();
  4968. Client cli(HOST, PORT);
  4969. {
  4970. auto res = cli.Get("/hi");
  4971. ASSERT_TRUE(res) << "Error: " << to_string(res.error());
  4972. EXPECT_EQ(StatusCode::OK_200, res->status);
  4973. EXPECT_EQ("hi", res->body);
  4974. }
  4975. {
  4976. auto res = cli.Get("/user/john");
  4977. ASSERT_TRUE(res) << "Error: " << to_string(res.error());
  4978. EXPECT_EQ(StatusCode::OK_200, res->status);
  4979. EXPECT_EQ("john", res->body);
  4980. }
  4981. {
  4982. auto res = cli.Get("/user/invalid-user");
  4983. ASSERT_TRUE(res) << "Error: " << to_string(res.error());
  4984. EXPECT_EQ(StatusCode::Forbidden_403, res->status);
  4985. EXPECT_EQ("error", res->body);
  4986. }
  4987. }
  4988. // The pre-request handler must run before the request body is read, so a
  4989. // rejected request never forces the server to buffer a (potentially large)
  4990. // body. Here the posted body is larger than the payload limit: if the body
  4991. // were read first the server would answer 413, but because the pre-request
  4992. // handler runs first it answers 403 and the body is never read.
  4993. TEST(RequestHandlerTest, PreRequestHandlerRunsBeforeBodyIsRead) {
  4994. Server svr;
  4995. svr.set_payload_max_length(8);
  4996. auto handler_ran = false;
  4997. svr.Post("/reject", [&](const Request &req, Response &res) {
  4998. handler_ran = true;
  4999. res.set_content(req.body, "text/plain");
  5000. });
  5001. svr.Post("/accept", [](const Request &req, Response &res) {
  5002. res.set_content(req.body, "text/plain");
  5003. });
  5004. svr.set_pre_request_handler([](const Request &req, Response &res) {
  5005. if (req.matched_route == "/reject") {
  5006. res.status = StatusCode::Forbidden_403;
  5007. res.set_content("denied", "text/plain");
  5008. return Server::HandlerResponse::Handled;
  5009. }
  5010. return Server::HandlerResponse::Unhandled;
  5011. });
  5012. auto thread = std::thread([&]() { svr.listen(HOST, PORT); });
  5013. auto se = detail::scope_exit([&] {
  5014. svr.stop();
  5015. thread.join();
  5016. ASSERT_FALSE(svr.is_running());
  5017. });
  5018. svr.wait_until_ready();
  5019. Client cli(HOST, PORT);
  5020. // Body (10 bytes) exceeds the 8-byte limit, yet the pre-request handler
  5021. // rejects with 403 before the body is read, so 413 is never reached.
  5022. {
  5023. auto res = cli.Post("/reject", "0123456789", "text/plain");
  5024. ASSERT_TRUE(res) << "Error: " << to_string(res.error());
  5025. EXPECT_EQ(StatusCode::Forbidden_403, res->status);
  5026. EXPECT_EQ("denied", res->body);
  5027. EXPECT_FALSE(handler_ran);
  5028. }
  5029. // An approved route still reads the body and enforces the payload limit.
  5030. {
  5031. auto res = cli.Post("/accept", "0123456789", "text/plain");
  5032. ASSERT_TRUE(res) << "Error: " << to_string(res.error());
  5033. EXPECT_EQ(StatusCode::PayloadTooLarge_413, res->status);
  5034. }
  5035. }
  5036. TEST(UserDataTest, BasicOperations) {
  5037. httplib::UserData ud;
  5038. // Initially empty
  5039. EXPECT_FALSE(ud.has("key"));
  5040. EXPECT_EQ(nullptr, ud.get<int>("key"));
  5041. // set and get
  5042. ud.set("key", 42);
  5043. EXPECT_TRUE(ud.has("key"));
  5044. auto *p = ud.get<int>("key");
  5045. ASSERT_NE(nullptr, p);
  5046. EXPECT_EQ(42, *p);
  5047. // Type mismatch → nullptr
  5048. EXPECT_EQ(nullptr, ud.get<std::string>("key"));
  5049. // Overwrite with different type
  5050. ud.set("key", std::string("hello"));
  5051. EXPECT_EQ(nullptr, ud.get<int>("key"));
  5052. auto *s = ud.get<std::string>("key");
  5053. ASSERT_NE(nullptr, s);
  5054. EXPECT_EQ("hello", *s);
  5055. // erase
  5056. ud.erase("key");
  5057. EXPECT_FALSE(ud.has("key"));
  5058. // clear
  5059. ud.set("a", 1);
  5060. ud.set("b", 2);
  5061. ud.clear();
  5062. EXPECT_FALSE(ud.has("a"));
  5063. EXPECT_FALSE(ud.has("b"));
  5064. }
  5065. TEST(RequestHandlerTest, ResponseUserDataInPreRouting) {
  5066. struct AuthCtx {
  5067. std::string user_id;
  5068. };
  5069. Server svr;
  5070. svr.set_pre_routing_handler([](const Request & /*req*/, Response &res) {
  5071. res.user_data.set("auth", AuthCtx{"alice"});
  5072. return Server::HandlerResponse::Unhandled;
  5073. });
  5074. svr.Get("/me", [](const Request & /*req*/, Response &res) {
  5075. auto *ctx = res.user_data.get<AuthCtx>("auth");
  5076. ASSERT_NE(nullptr, ctx);
  5077. res.set_content("Hello " + ctx->user_id, "text/plain");
  5078. });
  5079. auto thread = std::thread([&]() { svr.listen(HOST, PORT); });
  5080. auto se = detail::scope_exit([&] {
  5081. svr.stop();
  5082. thread.join();
  5083. ASSERT_FALSE(svr.is_running());
  5084. });
  5085. svr.wait_until_ready();
  5086. Client cli(HOST, PORT);
  5087. auto res = cli.Get("/me");
  5088. ASSERT_TRUE(res) << "Error: " << to_string(res.error());
  5089. EXPECT_EQ(StatusCode::OK_200, res->status);
  5090. EXPECT_EQ("Hello alice", res->body);
  5091. }
  5092. TEST(RequestHandlerTest, ResponseUserDataInPreRequest) {
  5093. struct RoleCtx {
  5094. std::string role;
  5095. };
  5096. Server svr;
  5097. svr.set_pre_request_handler([](const Request & /*req*/, Response &res) {
  5098. res.user_data.set("role", RoleCtx{"admin"});
  5099. return Server::HandlerResponse::Unhandled;
  5100. });
  5101. svr.Get("/role", [](const Request & /*req*/, Response &res) {
  5102. auto *ctx = res.user_data.get<RoleCtx>("role");
  5103. ASSERT_NE(nullptr, ctx);
  5104. res.set_content(ctx->role, "text/plain");
  5105. });
  5106. auto thread = std::thread([&]() { svr.listen(HOST, PORT); });
  5107. auto se = detail::scope_exit([&] {
  5108. svr.stop();
  5109. thread.join();
  5110. ASSERT_FALSE(svr.is_running());
  5111. });
  5112. svr.wait_until_ready();
  5113. Client cli(HOST, PORT);
  5114. auto res = cli.Get("/role");
  5115. ASSERT_TRUE(res) << "Error: " << to_string(res.error());
  5116. EXPECT_EQ(StatusCode::OK_200, res->status);
  5117. EXPECT_EQ("admin", res->body);
  5118. }
  5119. TEST(InvalidFormatTest, StatusCode) {
  5120. Server svr;
  5121. svr.Get("/hi", [](const Request & /*req*/, Response &res) {
  5122. res.set_content("Hello World!\n", "text/plain");
  5123. res.status = 9999; // Status should be a three-digit code...
  5124. });
  5125. auto thread = std::thread([&]() { svr.listen(HOST, PORT); });
  5126. auto se = detail::scope_exit([&] {
  5127. svr.stop();
  5128. thread.join();
  5129. ASSERT_FALSE(svr.is_running());
  5130. });
  5131. svr.wait_until_ready();
  5132. {
  5133. Client cli(HOST, PORT);
  5134. auto res = cli.Get("/hi");
  5135. ASSERT_FALSE(res);
  5136. }
  5137. }
  5138. TEST(URLFragmentTest, WithFragment) {
  5139. Server svr;
  5140. svr.Get("/hi", [](const Request &req, Response & /*res*/) {
  5141. EXPECT_TRUE(req.target == "/hi");
  5142. });
  5143. auto thread = std::thread([&]() { svr.listen(HOST, PORT); });
  5144. auto se = detail::scope_exit([&] {
  5145. svr.stop();
  5146. thread.join();
  5147. ASSERT_FALSE(svr.is_running());
  5148. });
  5149. svr.wait_until_ready();
  5150. {
  5151. Client cli(HOST, PORT);
  5152. auto res = cli.Get("/hi#key1=val1=key2=val2");
  5153. EXPECT_TRUE(res);
  5154. EXPECT_EQ(StatusCode::OK_200, res->status);
  5155. res = cli.Get("/hi%23key1=val1=key2=val2");
  5156. EXPECT_TRUE(res);
  5157. EXPECT_EQ(StatusCode::NotFound_404, res->status);
  5158. }
  5159. }
  5160. TEST(URLFragmentTest, ParamsGoBeforeTheFragment) {
  5161. EXPECT_EQ("/a?b=1#f", append_query_params("/a#f", {{"b", "1"}}));
  5162. EXPECT_EQ("/a?q=0&b=1#f", append_query_params("/a?q=0#f", {{"b", "1"}}));
  5163. Server svr;
  5164. std::vector<std::string> targets;
  5165. svr.Get("/hi", [&](const Request &req, Response & /*res*/) {
  5166. targets.push_back(req.target);
  5167. });
  5168. auto thread = std::thread([&]() { svr.listen(HOST, PORT); });
  5169. auto se = detail::scope_exit([&] {
  5170. svr.stop();
  5171. thread.join();
  5172. ASSERT_FALSE(svr.is_running());
  5173. });
  5174. svr.wait_until_ready();
  5175. Client cli(HOST, PORT);
  5176. EXPECT_TRUE(cli.Get("/hi#f", Params{{"a", "1"}}, Headers{}));
  5177. EXPECT_TRUE(cli.Get("/hi?q=0#f", Params{{"a", "1"}}, Headers{}));
  5178. EXPECT_TRUE(cli.open_stream("GET", "/hi#f", {{"a", "1"}}).is_valid());
  5179. // A '?' after the '#' belongs to the fragment, not to the query.
  5180. Request req;
  5181. req.method = "GET";
  5182. req.path = "/hi#f?x=1";
  5183. req.params.emplace("a", "1");
  5184. Response res;
  5185. auto error = Error::Success;
  5186. EXPECT_TRUE(cli.send(req, res, error));
  5187. EXPECT_EQ((std::vector<std::string>{"/hi?a=1", "/hi?q=0&a=1", "/hi?a=1",
  5188. "/hi?a=1"}),
  5189. targets);
  5190. }
  5191. TEST(HeaderWriter, SetHeaderWriter) {
  5192. Server svr;
  5193. svr.set_header_writer([](Stream &strm, Headers &hdrs) {
  5194. hdrs.emplace("CustomServerHeader", "CustomServerValue");
  5195. return detail::write_headers(strm, hdrs);
  5196. });
  5197. svr.Get("/hi", [](const Request &req, Response &res) {
  5198. auto it = req.headers.find("CustomClientHeader");
  5199. EXPECT_TRUE(it != req.headers.end());
  5200. EXPECT_EQ(it->second, "CustomClientValue");
  5201. res.set_content("Hello World!\n", "text/plain");
  5202. });
  5203. auto thread = std::thread([&]() { svr.listen(HOST, PORT); });
  5204. auto se = detail::scope_exit([&] {
  5205. svr.stop();
  5206. thread.join();
  5207. ASSERT_FALSE(svr.is_running());
  5208. });
  5209. svr.wait_until_ready();
  5210. {
  5211. Client cli(HOST, PORT);
  5212. cli.set_header_writer([](Stream &strm, Headers &hdrs) {
  5213. hdrs.emplace("CustomClientHeader", "CustomClientValue");
  5214. return detail::write_headers(strm, hdrs);
  5215. });
  5216. auto res = cli.Get("/hi");
  5217. EXPECT_TRUE(res);
  5218. EXPECT_EQ(StatusCode::OK_200, res->status);
  5219. auto it = res->headers.find("CustomServerHeader");
  5220. EXPECT_TRUE(it != res->headers.end());
  5221. EXPECT_EQ(it->second, "CustomServerValue");
  5222. }
  5223. }
  5224. class ServerTest : public ::testing::Test {
  5225. protected:
  5226. ServerTest()
  5227. : cli_(HOST, PORT)
  5228. #ifdef CPPHTTPLIB_SSL_ENABLED
  5229. ,
  5230. svr_(SERVER_CERT_FILE, SERVER_PRIVATE_KEY_FILE)
  5231. #endif
  5232. {
  5233. #ifdef CPPHTTPLIB_SSL_ENABLED
  5234. cli_.enable_server_certificate_verification(false);
  5235. #endif
  5236. // Allow LARGE_DATA (100MB) responses
  5237. cli_.set_payload_max_length(200 * 1024 * 1024);
  5238. }
  5239. virtual void SetUp() {
  5240. // Allow LARGE_DATA (100MB) tests to pass with new 100MB default limit
  5241. svr_.set_payload_max_length(200 * 1024 * 1024);
  5242. svr_.set_mount_point("/", "./www");
  5243. svr_.set_mount_point("/mount", "./www2");
  5244. svr_.set_file_extension_and_mimetype_mapping("abcde", "text/abcde");
  5245. svr_.Get("/hi",
  5246. [&](const Request & /*req*/, Response &res) {
  5247. res.set_content("Hello World!", "text/plain");
  5248. })
  5249. .Get("/file_content",
  5250. [&](const Request & /*req*/, Response &res) {
  5251. res.set_file_content("./www/dir/test.html");
  5252. })
  5253. .Get("/file_content_with_content_type",
  5254. [&](const Request & /*req*/, Response &res) {
  5255. res.set_file_content("./www/file", "text/plain");
  5256. })
  5257. .Get("/invalid_file_content",
  5258. [&](const Request & /*req*/, Response &res) {
  5259. res.set_file_content("./www/dir/invalid_file_path");
  5260. })
  5261. .Get("/http_response_splitting",
  5262. [&](const Request & /*req*/, Response &res) {
  5263. res.set_header("a", "1\r\nSet-Cookie: a=1");
  5264. EXPECT_EQ(0U, res.headers.size());
  5265. EXPECT_FALSE(res.has_header("a"));
  5266. res.set_header("a", "1\nSet-Cookie: a=1");
  5267. EXPECT_EQ(0U, res.headers.size());
  5268. EXPECT_FALSE(res.has_header("a"));
  5269. res.set_header("a", "1\rSet-Cookie: a=1");
  5270. EXPECT_EQ(0U, res.headers.size());
  5271. EXPECT_FALSE(res.has_header("a"));
  5272. res.set_header("a\r\nb", "0");
  5273. EXPECT_EQ(0U, res.headers.size());
  5274. EXPECT_FALSE(res.has_header("a"));
  5275. res.set_header("a\rb", "0");
  5276. EXPECT_EQ(0U, res.headers.size());
  5277. EXPECT_FALSE(res.has_header("a"));
  5278. res.set_header("a\nb", "0");
  5279. EXPECT_EQ(0U, res.headers.size());
  5280. EXPECT_FALSE(res.has_header("a"));
  5281. res.set_redirect("1\r\nSet-Cookie: a=1");
  5282. EXPECT_EQ(0U, res.headers.size());
  5283. EXPECT_FALSE(res.has_header("Location"));
  5284. })
  5285. .Get("/slow",
  5286. [&](const Request & /*req*/, Response &res) {
  5287. std::this_thread::sleep_for(std::chrono::seconds(4));
  5288. res.set_content("slow", "text/plain");
  5289. })
  5290. #if 0
  5291. .Post("/slowpost",
  5292. [&](const Request & /*req*/, Response &res) {
  5293. std::this_thread::sleep_for(std::chrono::seconds(2));
  5294. res.set_content("slow", "text/plain");
  5295. })
  5296. #endif
  5297. .Get("/remote_addr",
  5298. [&](const Request &req, Response &res) {
  5299. ASSERT_FALSE(req.has_header("REMOTE_ADDR"));
  5300. ASSERT_FALSE(req.has_header("REMOTE_PORT"));
  5301. #ifndef CPPHTTPLIB_NO_EXCEPTIONS
  5302. ASSERT_ANY_THROW(req.get_header_value("REMOTE_ADDR"));
  5303. ASSERT_ANY_THROW(req.get_header_value("REMOTE_PORT"));
  5304. #endif
  5305. res.set_content(req.remote_addr, "text/plain");
  5306. })
  5307. .Get("/local_addr",
  5308. [&](const Request &req, Response &res) {
  5309. ASSERT_FALSE(req.has_header("LOCAL_ADDR"));
  5310. ASSERT_FALSE(req.has_header("LOCAL_PORT"));
  5311. #ifndef CPPHTTPLIB_NO_EXCEPTIONS
  5312. ASSERT_ANY_THROW(req.get_header_value("LOCAL_ADDR"));
  5313. ASSERT_ANY_THROW(req.get_header_value("LOCAL_PORT"));
  5314. #endif
  5315. auto local_addr = req.local_addr;
  5316. auto local_port = std::to_string(req.local_port);
  5317. res.set_content(local_addr.append(":").append(local_port),
  5318. "text/plain");
  5319. })
  5320. .Get("/endwith%",
  5321. [&](const Request & /*req*/, Response &res) {
  5322. res.set_content("Hello World!", "text/plain");
  5323. })
  5324. .Get("/a\\+\\+b",
  5325. [&](const Request &req, Response &res) {
  5326. ASSERT_TRUE(req.has_param("a +b"));
  5327. auto val = req.get_param_value("a +b");
  5328. res.set_content(val, "text/plain");
  5329. })
  5330. .Get("/", [&](const Request & /*req*/,
  5331. Response &res) { res.set_redirect("/hi"); })
  5332. .Post("/1",
  5333. [](const Request & /*req*/, Response &res) {
  5334. res.set_redirect("/2", StatusCode::SeeOther_303);
  5335. })
  5336. .Get("/2",
  5337. [](const Request & /*req*/, Response &res) {
  5338. res.set_content("redirected.", "text/plain");
  5339. res.status = StatusCode::OK_200;
  5340. })
  5341. .Post("/person",
  5342. [&](const Request &req, Response &res) {
  5343. if (req.has_param("name") && req.has_param("note")) {
  5344. persons_[req.get_param_value("name")] =
  5345. req.get_param_value("note");
  5346. } else {
  5347. res.status = StatusCode::BadRequest_400;
  5348. }
  5349. })
  5350. .Put("/person",
  5351. [&](const Request &req, Response &res) {
  5352. if (req.has_param("name") && req.has_param("note")) {
  5353. persons_[req.get_param_value("name")] =
  5354. req.get_param_value("note");
  5355. } else {
  5356. res.status = StatusCode::BadRequest_400;
  5357. }
  5358. })
  5359. .Get("/person/(.*)",
  5360. [&](const Request &req, Response &res) {
  5361. string name = req.matches[1];
  5362. if (persons_.find(name) != persons_.end()) {
  5363. auto note = persons_[name];
  5364. res.set_content(note, "text/plain");
  5365. } else {
  5366. res.status = StatusCode::NotFound_404;
  5367. }
  5368. })
  5369. .Delete("/person",
  5370. [&](const Request &req, Response &res) {
  5371. if (req.has_param("name")) {
  5372. string name = req.get_param_value("name");
  5373. if (persons_.find(name) != persons_.end()) {
  5374. persons_.erase(name);
  5375. res.set_content("DELETED", "text/plain");
  5376. } else {
  5377. res.status = StatusCode::NotFound_404;
  5378. }
  5379. } else {
  5380. res.status = StatusCode::BadRequest_400;
  5381. }
  5382. })
  5383. .Post("/x-www-form-urlencoded-json",
  5384. [&](const Request &req, Response &res) {
  5385. auto json = req.get_param_value("json");
  5386. ASSERT_EQ(JSON_DATA, json);
  5387. res.set_content(json, "appliation/json");
  5388. res.status = StatusCode::OK_200;
  5389. })
  5390. .Get("/streamed-chunked",
  5391. [&](const Request & /*req*/, Response &res) {
  5392. res.set_chunked_content_provider(
  5393. "text/plain", [](size_t /*offset*/, DataSink &sink) {
  5394. sink.os << "123";
  5395. sink.os << "456";
  5396. sink.os << "789";
  5397. sink.done();
  5398. return true;
  5399. });
  5400. })
  5401. .Get("/streamed-chunked-with-prohibited-trailer",
  5402. [&](const Request & /*req*/, Response &res) {
  5403. auto i = new int(0);
  5404. // Declare both a prohibited trailer (Content-Length) and an
  5405. // allowed one
  5406. res.set_header("Trailer", "Content-Length, X-Allowed");
  5407. res.set_chunked_content_provider(
  5408. "text/plain",
  5409. [i](size_t /*offset*/, DataSink &sink) {
  5410. switch (*i) {
  5411. case 0: sink.os << "123"; break;
  5412. case 1: sink.os << "456"; break;
  5413. case 2: sink.os << "789"; break;
  5414. case 3: {
  5415. sink.done_with_trailer(
  5416. {{"Content-Length", "5"}, {"X-Allowed", "yes"}});
  5417. } break;
  5418. }
  5419. (*i)++;
  5420. return true;
  5421. },
  5422. [i](bool success) {
  5423. EXPECT_TRUE(success);
  5424. delete i;
  5425. });
  5426. })
  5427. .Get("/streamed-chunked2",
  5428. [&](const Request & /*req*/, Response &res) {
  5429. auto i = new int(0);
  5430. res.set_chunked_content_provider(
  5431. "text/plain",
  5432. [i](size_t /*offset*/, DataSink &sink) {
  5433. switch (*i) {
  5434. case 0: sink.os << "123"; break;
  5435. case 1: sink.os << "456"; break;
  5436. case 2: sink.os << "789"; break;
  5437. case 3: sink.done(); break;
  5438. }
  5439. (*i)++;
  5440. return true;
  5441. },
  5442. [i](bool success) {
  5443. EXPECT_TRUE(success);
  5444. delete i;
  5445. });
  5446. })
  5447. .Get("/streamed-chunked-with-trailer",
  5448. [&](const Request & /*req*/, Response &res) {
  5449. auto i = new int(0);
  5450. res.set_header("Trailer", "Dummy1, Dummy2");
  5451. res.set_chunked_content_provider(
  5452. "text/plain",
  5453. [i](size_t /*offset*/, DataSink &sink) {
  5454. switch (*i) {
  5455. case 0: sink.os << "123"; break;
  5456. case 1: sink.os << "456"; break;
  5457. case 2: sink.os << "789"; break;
  5458. case 3: {
  5459. sink.done_with_trailer(
  5460. {{"Dummy1", "DummyVal1"}, {"Dummy2", "DummyVal2"}});
  5461. } break;
  5462. }
  5463. (*i)++;
  5464. return true;
  5465. },
  5466. [i](bool success) {
  5467. EXPECT_TRUE(success);
  5468. delete i;
  5469. });
  5470. })
  5471. .Get("/streamed",
  5472. [&](const Request & /*req*/, Response &res) {
  5473. res.set_content_provider(
  5474. 6, "text/plain",
  5475. [](size_t offset, size_t /*length*/, DataSink &sink) {
  5476. sink.os << (offset < 3 ? "a" : "b");
  5477. return true;
  5478. });
  5479. })
  5480. .Get("/streamed-without-length",
  5481. [&](const Request & /*req*/, Response &res) {
  5482. auto data = new std::string("abcdefg");
  5483. res.set_content_provider(
  5484. "text/plain",
  5485. [data](size_t offset, DataSink &sink) {
  5486. if (offset < data->size()) {
  5487. sink.os << data->substr(offset);
  5488. }
  5489. sink.done();
  5490. return true;
  5491. },
  5492. [data](bool success) {
  5493. EXPECT_TRUE(success);
  5494. delete data;
  5495. });
  5496. })
  5497. .Get("/streamed-with-range",
  5498. [&](const Request &req, Response &res) {
  5499. auto data = new std::string("abcdefg");
  5500. // An explicit status keeps the server from picking the 206 it
  5501. // would otherwise choose for a ranged request, so the response
  5502. // is not a partial representation.
  5503. auto status = req.get_param_value("status");
  5504. if (status == "200") {
  5505. res.status = StatusCode::OK_200;
  5506. } else if (status == "403") {
  5507. res.status = StatusCode::Forbidden_403;
  5508. }
  5509. res.set_content_provider(
  5510. data->size(), "text/plain",
  5511. [data](size_t offset, size_t length, DataSink &sink) {
  5512. size_t DATA_CHUNK_SIZE = 4;
  5513. const auto &d = *data;
  5514. auto out_len =
  5515. std::min(static_cast<size_t>(length), DATA_CHUNK_SIZE);
  5516. auto ret =
  5517. sink.write(&d[static_cast<size_t>(offset)], out_len);
  5518. EXPECT_TRUE(ret);
  5519. return true;
  5520. },
  5521. [data, &req](bool success) {
  5522. EXPECT_EQ(success, !req.has_param("error"));
  5523. delete data;
  5524. });
  5525. })
  5526. .Get("/streamed-cancel",
  5527. [&](const Request & /*req*/, Response &res) {
  5528. res.set_content_provider(
  5529. size_t(-1), "text/plain",
  5530. [](size_t /*offset*/, size_t /*length*/, DataSink &sink) {
  5531. sink.os << "data_chunk";
  5532. return true;
  5533. });
  5534. })
  5535. .Get("/regex-with-delimiter",
  5536. [&](const Request &req, Response & /*res*/) {
  5537. ASSERT_TRUE(req.has_param("key"));
  5538. EXPECT_EQ("^(?.*(value))", req.get_param_value("key"));
  5539. })
  5540. .Get("/with-range",
  5541. [&](const Request & /*req*/, Response &res) {
  5542. res.set_content("abcdefg", "text/plain");
  5543. })
  5544. .Get("/test-start-time",
  5545. [&](const Request &req, Response & /*res*/) {
  5546. EXPECT_NE(req.start_time_,
  5547. std::chrono::steady_clock::time_point::min());
  5548. })
  5549. .Get("/with-range-customized-response",
  5550. [&](const Request & /*req*/, Response &res) {
  5551. res.status = StatusCode::BadRequest_400;
  5552. res.set_content(JSON_DATA, "application/json");
  5553. })
  5554. .Post("/chunked",
  5555. [&](const Request &req, Response & /*res*/) {
  5556. EXPECT_EQ(req.body, "dechunked post body");
  5557. })
  5558. .Post("/large-chunked",
  5559. [&](const Request &req, Response & /*res*/) {
  5560. std::string expected(6 * 30 * 1024u, 'a');
  5561. EXPECT_EQ(req.body, expected);
  5562. })
  5563. .Post("/multipart",
  5564. [&](const Request &req, Response & /*res*/) {
  5565. EXPECT_EQ(4u, req.form.get_field_count("text1") +
  5566. req.form.get_field_count("text2") +
  5567. req.form.get_field_count("file3") +
  5568. req.form.get_field_count("file4"));
  5569. EXPECT_EQ(2u, req.form.get_file_count("file1") +
  5570. req.form.get_file_count("file2"));
  5571. ASSERT_TRUE(!req.form.has_file("???"));
  5572. ASSERT_TRUE(!req.form.has_field("???"));
  5573. ASSERT_TRUE(req.body.empty());
  5574. {
  5575. const auto &text = req.form.get_field("text1");
  5576. EXPECT_EQ("text default", text);
  5577. }
  5578. {
  5579. const auto &text = req.form.get_field("text2");
  5580. EXPECT_EQ("aωb", text);
  5581. }
  5582. {
  5583. const auto &file = req.form.get_file("file1");
  5584. EXPECT_EQ("hello.txt", file.filename);
  5585. EXPECT_EQ("text/plain", file.content_type);
  5586. EXPECT_EQ("h\ne\n\nl\nl\no\n", file.content);
  5587. }
  5588. {
  5589. const auto &file = req.form.get_file("file2");
  5590. EXPECT_EQ("world.json", file.filename);
  5591. EXPECT_EQ("application/json", file.content_type);
  5592. EXPECT_EQ("{\n \"world\", true\n}\n", file.content);
  5593. }
  5594. {
  5595. const auto &text = req.form.get_field("file3");
  5596. EXPECT_EQ(0u, text.size());
  5597. }
  5598. {
  5599. const auto &text = req.form.get_field("file4");
  5600. EXPECT_EQ(0u, text.size());
  5601. }
  5602. })
  5603. .Post("/multipart/multi_file_values",
  5604. [&](const Request &req, Response & /*res*/) {
  5605. EXPECT_EQ(3u, req.form.get_field_count("text") +
  5606. req.form.get_field_count("multi_text1"));
  5607. EXPECT_EQ(2u, req.form.get_file_count("multi_file1"));
  5608. ASSERT_TRUE(!req.form.has_file("???"));
  5609. ASSERT_TRUE(!req.form.has_field("???"));
  5610. ASSERT_TRUE(req.body.empty());
  5611. {
  5612. const auto &text = req.form.get_field("text");
  5613. EXPECT_EQ("default text", text);
  5614. }
  5615. {
  5616. const auto &text1_values = req.form.get_fields("multi_text1");
  5617. EXPECT_EQ(2u, text1_values.size());
  5618. EXPECT_EQ("aaaaa", text1_values[0]);
  5619. EXPECT_EQ("bbbbb", text1_values[1]);
  5620. }
  5621. {
  5622. const auto &file1_values = req.form.get_files("multi_file1");
  5623. EXPECT_EQ(2u, file1_values.size());
  5624. auto file1 = file1_values[0];
  5625. EXPECT_EQ(file1.filename, "hello.txt");
  5626. EXPECT_EQ(file1.content_type, "text/plain");
  5627. EXPECT_EQ("h\ne\n\nl\nl\no\n", file1.content);
  5628. auto file2 = file1_values[1];
  5629. EXPECT_EQ(file2.filename, "world.json");
  5630. EXPECT_EQ(file2.content_type, "application/json");
  5631. EXPECT_EQ("{\n \"world\", true\n}\n", file2.content);
  5632. }
  5633. })
  5634. .Post("/empty",
  5635. [&](const Request &req, Response &res) {
  5636. EXPECT_EQ(req.body, "");
  5637. EXPECT_EQ("text/plain", req.get_header_value("Content-Type"));
  5638. EXPECT_EQ("0", req.get_header_value("Content-Length"));
  5639. res.set_content("empty", "text/plain");
  5640. })
  5641. .Post("/empty-no-content-type",
  5642. [&](const Request &req, Response &res) {
  5643. EXPECT_EQ(req.body, "");
  5644. EXPECT_FALSE(req.has_header("Content-Type"));
  5645. EXPECT_EQ("0", req.get_header_value("Content-Length"));
  5646. res.set_content("empty-no-content-type", "text/plain");
  5647. })
  5648. .Post("/path-only",
  5649. [&](const Request &req, Response &res) {
  5650. EXPECT_EQ(req.body, "");
  5651. EXPECT_EQ("", req.get_header_value("Content-Type"));
  5652. EXPECT_EQ("0", req.get_header_value("Content-Length"));
  5653. res.set_content("path-only", "text/plain");
  5654. })
  5655. .Post("/path-headers-only",
  5656. [&](const Request &req, Response &res) {
  5657. EXPECT_EQ(req.body, "");
  5658. EXPECT_EQ("", req.get_header_value("Content-Type"));
  5659. EXPECT_EQ("0", req.get_header_value("Content-Length"));
  5660. EXPECT_EQ("world", req.get_header_value("hello"));
  5661. EXPECT_EQ("world2", req.get_header_value("hello2"));
  5662. res.set_content("path-headers-only", "text/plain");
  5663. })
  5664. .Post("/post-large",
  5665. [&](const Request &req, Response &res) {
  5666. EXPECT_EQ(req.body, LARGE_DATA);
  5667. res.set_content(req.body, "text/plain");
  5668. })
  5669. .Post("/post-loopback",
  5670. [&](const Request &, Response &res,
  5671. ContentReader const &content_reader) {
  5672. std::string body;
  5673. content_reader([&](const char *data, size_t data_length) {
  5674. body.append(data, data_length);
  5675. return true;
  5676. });
  5677. res.set_content(body, "text/plain");
  5678. })
  5679. .Put("/put-loopback",
  5680. [&](const Request &, Response &res,
  5681. ContentReader const &content_reader) {
  5682. std::string body;
  5683. content_reader([&](const char *data, size_t data_length) {
  5684. body.append(data, data_length);
  5685. return true;
  5686. });
  5687. res.set_content(body, "text/plain");
  5688. })
  5689. .Patch("/patch-loopback",
  5690. [&](const Request &, Response &res,
  5691. ContentReader const &content_reader) {
  5692. std::string body;
  5693. content_reader([&](const char *data, size_t data_length) {
  5694. body.append(data, data_length);
  5695. return true;
  5696. });
  5697. res.set_content(body, "text/plain");
  5698. })
  5699. .Put("/empty-no-content-type",
  5700. [&](const Request &req, Response &res) {
  5701. EXPECT_EQ(req.body, "");
  5702. EXPECT_FALSE(req.has_header("Content-Type"));
  5703. EXPECT_EQ("0", req.get_header_value("Content-Length"));
  5704. res.set_content("empty-no-content-type", "text/plain");
  5705. })
  5706. .Put("/put",
  5707. [&](const Request &req, Response &res) {
  5708. EXPECT_EQ(req.body, "PUT");
  5709. res.set_content(req.body, "text/plain");
  5710. })
  5711. .Put("/put-large",
  5712. [&](const Request &req, Response &res) {
  5713. EXPECT_EQ(req.body, LARGE_DATA);
  5714. res.set_content(req.body, "text/plain");
  5715. })
  5716. .Patch("/patch",
  5717. [&](const Request &req, Response &res) {
  5718. EXPECT_EQ(req.body, "PATCH");
  5719. res.set_content(req.body, "text/plain");
  5720. })
  5721. .Delete("/delete",
  5722. [&](const Request & /*req*/, Response &res) {
  5723. res.set_content("DELETE", "text/plain");
  5724. })
  5725. .Delete("/delete-body",
  5726. [&](const Request &req, Response &res) {
  5727. EXPECT_EQ(req.body, "content");
  5728. res.set_content(req.body, "text/plain");
  5729. })
  5730. .Options(R"(\*)",
  5731. [&](const Request & /*req*/, Response &res) {
  5732. res.set_header("Allow", "GET, POST, HEAD, OPTIONS");
  5733. })
  5734. .CustomRoute("PROPFIND", "/dav/:id",
  5735. [&](const Request &req, Response &res) {
  5736. res.set_header("x-body-size",
  5737. std::to_string(req.body.size()));
  5738. res.set_header("x-matched-route", req.matched_route);
  5739. res.set_header("x-dav-id", req.path_params.at("id"));
  5740. res.status = StatusCode::MultiStatus_207;
  5741. res.set_content(req.body, "application/xml");
  5742. })
  5743. .CustomRoute("PROPFIND", R"(/dav-re/(\d+))",
  5744. [&](const Request &req, Response &res) {
  5745. res.set_header("x-dav-match", req.matches[1]);
  5746. res.status = StatusCode::MultiStatus_207;
  5747. })
  5748. .CustomRoute("MKCOL", "/dav-mkcol",
  5749. [&](const Request &req, Response &res) {
  5750. EXPECT_TRUE(req.body.empty());
  5751. res.status = StatusCode::Created_201;
  5752. })
  5753. .CustomRoute(
  5754. "REPORT", "/dav-report",
  5755. [&](const Request & /*req*/, Response &res,
  5756. const ContentReader &content_reader) {
  5757. std::string body;
  5758. content_reader([&](const char *data, size_t data_length) {
  5759. body.append(data, data_length);
  5760. return true;
  5761. });
  5762. res.set_header("x-body-size", std::to_string(body.size()));
  5763. res.status = StatusCode::MultiStatus_207;
  5764. res.set_content(body, "application/xml");
  5765. })
  5766. .Get("/request-target",
  5767. [&](const Request &req, Response & /*res*/) {
  5768. EXPECT_EQ("/request-target?aaa=bbb&ccc=ddd", req.target);
  5769. EXPECT_EQ("bbb", req.get_param_value("aaa"));
  5770. EXPECT_EQ("ddd", req.get_param_value("ccc"));
  5771. })
  5772. .Get("/long-query-value",
  5773. [&](const Request &req, Response & /*res*/) {
  5774. EXPECT_EQ(LONG_QUERY_URL, req.target);
  5775. EXPECT_EQ(LONG_QUERY_VALUE, req.get_param_value("key"));
  5776. })
  5777. .Get("/too-long-query-value",
  5778. [&](const Request &req, Response & /*res*/) {
  5779. EXPECT_EQ(TOO_LONG_QUERY_URL, req.target);
  5780. EXPECT_EQ(TOO_LONG_QUERY_VALUE, req.get_param_value("key"));
  5781. })
  5782. .Get("/array-param",
  5783. [&](const Request &req, Response & /*res*/) {
  5784. EXPECT_EQ(3u, req.get_param_value_count("array"));
  5785. EXPECT_EQ("value1", req.get_param_value("array", 0));
  5786. EXPECT_EQ("value2", req.get_param_value("array", 1));
  5787. EXPECT_EQ("value3", req.get_param_value("array", 2));
  5788. })
  5789. .Get("/array-param-values",
  5790. [&](const Request &req, Response & /*res*/) {
  5791. auto values = req.get_param_values("array");
  5792. EXPECT_EQ(3u, values.size());
  5793. EXPECT_EQ("value1", values[0]);
  5794. EXPECT_EQ("value2", values[1]);
  5795. EXPECT_EQ("value3", values[2]);
  5796. auto empty = req.get_param_values("nonexistent");
  5797. EXPECT_TRUE(empty.empty());
  5798. })
  5799. .Post("/validate-no-multiple-headers",
  5800. [&](const Request &req, Response & /*res*/) {
  5801. EXPECT_EQ(1u, req.get_header_value_count("Content-Length"));
  5802. EXPECT_EQ("5", req.get_header_value("Content-Length"));
  5803. })
  5804. .Post("/content_receiver",
  5805. [&](const Request &req, Response &res,
  5806. const ContentReader &content_reader) {
  5807. if (req.is_multipart_form_data()) {
  5808. std::vector<FormData> items;
  5809. content_reader(
  5810. [&](const FormData &file) {
  5811. items.push_back(file);
  5812. return true;
  5813. },
  5814. [&](const char *data, size_t data_length) {
  5815. items.back().content.append(data, data_length);
  5816. return true;
  5817. });
  5818. EXPECT_EQ(5u, items.size());
  5819. {
  5820. const auto &file = get_file_value(items, "text1");
  5821. EXPECT_TRUE(file.filename.empty());
  5822. EXPECT_EQ("text default", file.content);
  5823. }
  5824. {
  5825. const auto &file = get_file_value(items, "text2");
  5826. EXPECT_TRUE(file.filename.empty());
  5827. EXPECT_EQ("aωb", file.content);
  5828. }
  5829. {
  5830. const auto &file = get_file_value(items, "file1");
  5831. EXPECT_EQ("hello.txt", file.filename);
  5832. EXPECT_EQ("text/plain", file.content_type);
  5833. EXPECT_EQ("h\ne\n\nl\nl\no\n", file.content);
  5834. }
  5835. {
  5836. const auto &file = get_file_value(items, "file2");
  5837. EXPECT_EQ("world.json", file.filename);
  5838. EXPECT_EQ("application/json", file.content_type);
  5839. EXPECT_EQ(R"({\n "world": true\n}\n)", file.content);
  5840. }
  5841. {
  5842. const auto &file = get_file_value(items, "file3");
  5843. EXPECT_TRUE(file.filename.empty());
  5844. EXPECT_EQ("application/octet-stream", file.content_type);
  5845. EXPECT_EQ(0u, file.content.size());
  5846. }
  5847. } else {
  5848. std::string body;
  5849. content_reader([&](const char *data, size_t data_length) {
  5850. EXPECT_EQ(7U, data_length);
  5851. body.append(data, data_length);
  5852. return true;
  5853. });
  5854. EXPECT_EQ(body, "content");
  5855. res.set_content(body, "text/plain");
  5856. }
  5857. })
  5858. .Put("/content_receiver",
  5859. [&](const Request & /*req*/, Response &res,
  5860. const ContentReader &content_reader) {
  5861. std::string body;
  5862. content_reader([&](const char *data, size_t data_length) {
  5863. body.append(data, data_length);
  5864. return true;
  5865. });
  5866. EXPECT_EQ(body, "content");
  5867. res.set_content(body, "text/plain");
  5868. })
  5869. .Patch("/content_receiver",
  5870. [&](const Request & /*req*/, Response &res,
  5871. const ContentReader &content_reader) {
  5872. std::string body;
  5873. content_reader([&](const char *data, size_t data_length) {
  5874. body.append(data, data_length);
  5875. return true;
  5876. });
  5877. EXPECT_EQ(body, "content");
  5878. res.set_content(body, "text/plain");
  5879. })
  5880. .Post("/query-string-and-body",
  5881. [&](const Request &req, Response & /*res*/) {
  5882. ASSERT_TRUE(req.has_param("key"));
  5883. EXPECT_EQ(req.get_param_value("key"), "value");
  5884. EXPECT_EQ(req.body, "content");
  5885. })
  5886. .Get("/last-request",
  5887. [&](const Request &req, Response & /*res*/) {
  5888. EXPECT_EQ("close", req.get_header_value("Connection"));
  5889. })
  5890. .Get(R"(/redirect/(\d+))",
  5891. [&](const Request &req, Response &res) {
  5892. auto num = std::stoi(req.matches[1]) + 1;
  5893. std::string url = "/redirect/" + std::to_string(num);
  5894. res.set_redirect(url);
  5895. })
  5896. .Post("/binary",
  5897. [&](const Request &req, Response &res) {
  5898. EXPECT_EQ(4U, req.body.size());
  5899. EXPECT_EQ("application/octet-stream",
  5900. req.get_header_value("Content-Type"));
  5901. EXPECT_EQ("4", req.get_header_value("Content-Length"));
  5902. res.set_content(req.body, "application/octet-stream");
  5903. })
  5904. .Put("/binary",
  5905. [&](const Request &req, Response &res) {
  5906. EXPECT_EQ(4U, req.body.size());
  5907. EXPECT_EQ("application/octet-stream",
  5908. req.get_header_value("Content-Type"));
  5909. EXPECT_EQ("4", req.get_header_value("Content-Length"));
  5910. res.set_content(req.body, "application/octet-stream");
  5911. })
  5912. .Patch("/binary",
  5913. [&](const Request &req, Response &res) {
  5914. EXPECT_EQ(4U, req.body.size());
  5915. EXPECT_EQ("application/octet-stream",
  5916. req.get_header_value("Content-Type"));
  5917. EXPECT_EQ("4", req.get_header_value("Content-Length"));
  5918. res.set_content(req.body, "application/octet-stream");
  5919. })
  5920. .Delete("/binary",
  5921. [&](const Request &req, Response &res) {
  5922. EXPECT_EQ(4U, req.body.size());
  5923. EXPECT_EQ("application/octet-stream",
  5924. req.get_header_value("Content-Type"));
  5925. EXPECT_EQ("4", req.get_header_value("Content-Length"));
  5926. res.set_content(req.body, "application/octet-stream");
  5927. })
  5928. .Get("/issue1772",
  5929. [&](const Request & /*req*/, Response &res) {
  5930. res.status = 401;
  5931. res.set_header("WWW-Authenticate", "Basic realm=123456");
  5932. })
  5933. .Delete("/issue609",
  5934. [](const httplib::Request &, httplib::Response &res,
  5935. const httplib::ContentReader &) {
  5936. res.set_content("ok", "text/plain");
  5937. })
  5938. #if defined(CPPHTTPLIB_ZLIB_SUPPORT) || defined(CPPHTTPLIB_BROTLI_SUPPORT) || \
  5939. defined(CPPHTTPLIB_ZSTD_SUPPORT)
  5940. .Get("/compress",
  5941. [&](const Request & /*req*/, Response &res) {
  5942. res.set_content(
  5943. "12345678901234567890123456789012345678901234567890123456789"
  5944. "01234567890123456789012345678901234567890",
  5945. "text/plain");
  5946. })
  5947. .Get("/compress-with-charset",
  5948. [&](const Request & /*req*/, Response &res) {
  5949. res.set_content(
  5950. "12345678901234567890123456789012345678901234567890123456789"
  5951. "01234567890123456789012345678901234567890",
  5952. "application/json; charset=utf-8");
  5953. })
  5954. .Get("/nocompress",
  5955. [&](const Request & /*req*/, Response &res) {
  5956. res.set_content(
  5957. "12345678901234567890123456789012345678901234567890123456789"
  5958. "01234567890123456789012345678901234567890",
  5959. "application/octet-stream");
  5960. })
  5961. .Post("/compress-multipart",
  5962. [&](const Request &req, Response & /*res*/) {
  5963. EXPECT_EQ(2u, req.form.fields.size());
  5964. ASSERT_TRUE(!req.form.has_field("???"));
  5965. {
  5966. const auto &text = req.form.get_field("key1");
  5967. EXPECT_EQ("test", text);
  5968. }
  5969. {
  5970. const auto &text = req.form.get_field("key2");
  5971. EXPECT_EQ("--abcdefg123", text);
  5972. }
  5973. })
  5974. #endif
  5975. ;
  5976. persons_["john"] = "programmer";
  5977. t_ = thread([&]() { ASSERT_TRUE(svr_.listen(HOST, PORT)); });
  5978. svr_.wait_until_ready();
  5979. }
  5980. virtual void TearDown() {
  5981. svr_.stop();
  5982. if (!request_threads_.empty()) {
  5983. std::this_thread::sleep_for(std::chrono::seconds(1));
  5984. for (auto &t : request_threads_) {
  5985. t.join();
  5986. }
  5987. }
  5988. t_.join();
  5989. }
  5990. map<string, string> persons_;
  5991. #ifdef CPPHTTPLIB_SSL_ENABLED
  5992. SSLClient cli_;
  5993. SSLServer svr_;
  5994. #else
  5995. Client cli_;
  5996. Server svr_;
  5997. #endif
  5998. thread t_;
  5999. std::vector<thread> request_threads_;
  6000. };
  6001. TEST_F(ServerTest, GetMethod200) {
  6002. auto res = cli_.Get("/hi");
  6003. ASSERT_TRUE(res) << "Error: " << to_string(res.error());
  6004. EXPECT_EQ("HTTP/1.1", res->version);
  6005. EXPECT_EQ(StatusCode::OK_200, res->status);
  6006. EXPECT_EQ("OK", res->reason);
  6007. EXPECT_EQ("text/plain", res->get_header_value("Content-Type"));
  6008. EXPECT_EQ(1U, res->get_header_value_count("Content-Type"));
  6009. EXPECT_EQ("Hello World!", res->body);
  6010. }
  6011. TEST_F(ServerTest, GetEmptyFile) {
  6012. auto res = cli_.Get("/empty_file");
  6013. ASSERT_TRUE(res) << "Error: " << to_string(res.error());
  6014. EXPECT_EQ(StatusCode::OK_200, res->status);
  6015. EXPECT_EQ("application/octet-stream", res->get_header_value("Content-Type"));
  6016. EXPECT_EQ(0, std::stoi(res->get_header_value("Content-Length")));
  6017. EXPECT_EQ("", res->body);
  6018. }
  6019. TEST_F(ServerTest, GetFileContent) {
  6020. auto res = cli_.Get("/file_content");
  6021. ASSERT_TRUE(res) << "Error: " << to_string(res.error());
  6022. EXPECT_EQ(StatusCode::OK_200, res->status);
  6023. EXPECT_EQ("text/html", res->get_header_value("Content-Type"));
  6024. EXPECT_EQ(9, std::stoi(res->get_header_value("Content-Length")));
  6025. EXPECT_EQ("test.html", res->body);
  6026. }
  6027. TEST_F(ServerTest, GetFileContentWithRange) {
  6028. auto res = cli_.Get("/file_content", Headers{{make_range_header({{1, 3}})}});
  6029. ASSERT_TRUE(res) << "Error: " << to_string(res.error());
  6030. EXPECT_EQ(StatusCode::PartialContent_206, res->status);
  6031. EXPECT_EQ("text/html", res->get_header_value("Content-Type"));
  6032. EXPECT_EQ("bytes 1-3/9", res->get_header_value("Content-Range"));
  6033. EXPECT_EQ(3, std::stoi(res->get_header_value("Content-Length")));
  6034. EXPECT_EQ("est", res->body);
  6035. }
  6036. TEST_F(ServerTest, GetFileContentWithContentType) {
  6037. auto res = cli_.Get("/file_content_with_content_type");
  6038. ASSERT_TRUE(res) << "Error: " << to_string(res.error());
  6039. EXPECT_EQ(StatusCode::OK_200, res->status);
  6040. EXPECT_EQ("text/plain", res->get_header_value("Content-Type"));
  6041. EXPECT_EQ(5, std::stoi(res->get_header_value("Content-Length")));
  6042. EXPECT_EQ("file\n", res->body);
  6043. }
  6044. TEST_F(ServerTest, GetInvalidFileContent) {
  6045. auto res = cli_.Get("/invalid_file_content");
  6046. ASSERT_TRUE(res) << "Error: " << to_string(res.error());
  6047. EXPECT_EQ(StatusCode::NotFound_404, res->status);
  6048. }
  6049. TEST_F(ServerTest, GetMethod200withPercentEncoding) {
  6050. auto res = cli_.Get("/%68%69"); // auto res = cli_.Get("/hi");
  6051. ASSERT_TRUE(res) << "Error: " << to_string(res.error());
  6052. EXPECT_EQ("HTTP/1.1", res->version);
  6053. EXPECT_EQ(StatusCode::OK_200, res->status);
  6054. EXPECT_EQ("text/plain", res->get_header_value("Content-Type"));
  6055. EXPECT_EQ(1U, res->get_header_value_count("Content-Type"));
  6056. EXPECT_EQ("Hello World!", res->body);
  6057. }
  6058. TEST_F(ServerTest, GetMethod302) {
  6059. auto res = cli_.Get("/");
  6060. ASSERT_TRUE(res) << "Error: " << to_string(res.error());
  6061. EXPECT_EQ(StatusCode::Found_302, res->status);
  6062. EXPECT_EQ("/hi", res->get_header_value("Location"));
  6063. }
  6064. TEST_F(ServerTest, GetMethod302Redirect) {
  6065. cli_.set_follow_location(true);
  6066. auto res = cli_.Get("/");
  6067. ASSERT_TRUE(res) << "Error: " << to_string(res.error());
  6068. EXPECT_EQ(StatusCode::OK_200, res->status);
  6069. EXPECT_EQ("Hello World!", res->body);
  6070. EXPECT_EQ("/hi", res->location);
  6071. }
  6072. TEST_F(ServerTest, GetMethod404) {
  6073. auto res = cli_.Get("/invalid");
  6074. ASSERT_TRUE(res) << "Error: " << to_string(res.error());
  6075. EXPECT_EQ(StatusCode::NotFound_404, res->status);
  6076. }
  6077. TEST_F(ServerTest, HeadMethod200) {
  6078. auto res = cli_.Head("/hi");
  6079. ASSERT_TRUE(res) << "Error: " << to_string(res.error());
  6080. EXPECT_EQ(StatusCode::OK_200, res->status);
  6081. EXPECT_EQ("text/plain", res->get_header_value("Content-Type"));
  6082. EXPECT_TRUE(res->body.empty());
  6083. }
  6084. TEST_F(ServerTest, HeadMethod200Static) {
  6085. auto res = cli_.Head("/mount/dir/index.html");
  6086. ASSERT_TRUE(res) << "Error: " << to_string(res.error());
  6087. EXPECT_EQ(StatusCode::OK_200, res->status);
  6088. EXPECT_EQ("text/html", res->get_header_value("Content-Type"));
  6089. EXPECT_EQ(104, std::stoi(res->get_header_value("Content-Length")));
  6090. EXPECT_TRUE(res->body.empty());
  6091. }
  6092. TEST_F(ServerTest, HeadMethod404) {
  6093. auto res = cli_.Head("/invalid");
  6094. ASSERT_TRUE(res) << "Error: " << to_string(res.error());
  6095. EXPECT_EQ(StatusCode::NotFound_404, res->status);
  6096. EXPECT_TRUE(res->body.empty());
  6097. }
  6098. TEST_F(ServerTest, GetMethodPersonJohn) {
  6099. auto res = cli_.Get("/person/john");
  6100. ASSERT_TRUE(res) << "Error: " << to_string(res.error());
  6101. EXPECT_EQ(StatusCode::OK_200, res->status);
  6102. EXPECT_EQ("text/plain", res->get_header_value("Content-Type"));
  6103. EXPECT_EQ("programmer", res->body);
  6104. }
  6105. TEST_F(ServerTest, PostMethod1) {
  6106. auto res = cli_.Get("/person/john1");
  6107. ASSERT_TRUE(res) << "Error: " << to_string(res.error());
  6108. ASSERT_EQ(StatusCode::NotFound_404, res->status);
  6109. res = cli_.Post("/person", "name=john1&note=coder",
  6110. "application/x-www-form-urlencoded");
  6111. ASSERT_TRUE(res) << "Error: " << to_string(res.error());
  6112. ASSERT_EQ(StatusCode::OK_200, res->status);
  6113. res = cli_.Get("/person/john1");
  6114. ASSERT_TRUE(res) << "Error: " << to_string(res.error());
  6115. ASSERT_EQ(StatusCode::OK_200, res->status);
  6116. ASSERT_EQ("text/plain", res->get_header_value("Content-Type"));
  6117. ASSERT_EQ("coder", res->body);
  6118. }
  6119. TEST_F(ServerTest, PostMethod2) {
  6120. auto res = cli_.Get("/person/john2");
  6121. ASSERT_TRUE(res) << "Error: " << to_string(res.error());
  6122. ASSERT_EQ(StatusCode::NotFound_404, res->status);
  6123. Params params;
  6124. params.emplace("name", "john2");
  6125. params.emplace("note", "coder");
  6126. res = cli_.Post("/person", params);
  6127. ASSERT_TRUE(res) << "Error: " << to_string(res.error());
  6128. ASSERT_EQ(StatusCode::OK_200, res->status);
  6129. res = cli_.Get("/person/john2");
  6130. ASSERT_TRUE(res) << "Error: " << to_string(res.error());
  6131. ASSERT_EQ(StatusCode::OK_200, res->status);
  6132. ASSERT_EQ("text/plain", res->get_header_value("Content-Type"));
  6133. ASSERT_EQ("coder", res->body);
  6134. }
  6135. TEST_F(ServerTest, PutMethod3) {
  6136. auto res = cli_.Get("/person/john3");
  6137. ASSERT_TRUE(res) << "Error: " << to_string(res.error());
  6138. ASSERT_EQ(StatusCode::NotFound_404, res->status);
  6139. Params params;
  6140. params.emplace("name", "john3");
  6141. params.emplace("note", "coder");
  6142. res = cli_.Put("/person", params);
  6143. ASSERT_TRUE(res) << "Error: " << to_string(res.error());
  6144. ASSERT_EQ(StatusCode::OK_200, res->status);
  6145. res = cli_.Get("/person/john3");
  6146. ASSERT_TRUE(res) << "Error: " << to_string(res.error());
  6147. ASSERT_EQ(StatusCode::OK_200, res->status);
  6148. ASSERT_EQ("text/plain", res->get_header_value("Content-Type"));
  6149. ASSERT_EQ("coder", res->body);
  6150. }
  6151. TEST_F(ServerTest, DeleteMethod1) {
  6152. auto res = cli_.Get("/person/john4");
  6153. ASSERT_TRUE(res) << "Error: " << to_string(res.error());
  6154. ASSERT_EQ(StatusCode::NotFound_404, res->status);
  6155. Params params;
  6156. params.emplace("name", "john4");
  6157. params.emplace("note", "coder");
  6158. res = cli_.Post("/person", params);
  6159. ASSERT_TRUE(res) << "Error: " << to_string(res.error());
  6160. ASSERT_EQ(StatusCode::OK_200, res->status);
  6161. res = cli_.Get("/person/john4");
  6162. ASSERT_TRUE(res) << "Error: " << to_string(res.error());
  6163. ASSERT_EQ(StatusCode::OK_200, res->status);
  6164. ASSERT_EQ("text/plain", res->get_header_value("Content-Type"));
  6165. ASSERT_EQ("coder", res->body);
  6166. Params delete_params;
  6167. delete_params.emplace("name", "john4");
  6168. res = cli_.Delete("/person", delete_params);
  6169. ASSERT_TRUE(res) << "Error: " << to_string(res.error());
  6170. ASSERT_EQ(StatusCode::OK_200, res->status);
  6171. ASSERT_EQ("DELETED", res->body);
  6172. res = cli_.Get("/person/john4");
  6173. ASSERT_TRUE(res) << "Error: " << to_string(res.error());
  6174. ASSERT_EQ(StatusCode::NotFound_404, res->status);
  6175. }
  6176. TEST_F(ServerTest, DeleteMethod2) {
  6177. auto res = cli_.Get("/person/john5");
  6178. ASSERT_TRUE(res) << "Error: " << to_string(res.error());
  6179. ASSERT_EQ(StatusCode::NotFound_404, res->status);
  6180. Params params;
  6181. params.emplace("name", "john5");
  6182. params.emplace("note", "developer");
  6183. res = cli_.Post("/person", params);
  6184. ASSERT_TRUE(res) << "Error: " << to_string(res.error());
  6185. ASSERT_EQ(StatusCode::OK_200, res->status);
  6186. res = cli_.Get("/person/john5");
  6187. ASSERT_TRUE(res) << "Error: " << to_string(res.error());
  6188. ASSERT_EQ(StatusCode::OK_200, res->status);
  6189. ASSERT_EQ("text/plain", res->get_header_value("Content-Type"));
  6190. ASSERT_EQ("developer", res->body);
  6191. Params delete_params;
  6192. delete_params.emplace("name", "john5");
  6193. Headers headers;
  6194. headers.emplace("Custom-Header", "test-value");
  6195. res = cli_.Delete("/person", headers, delete_params);
  6196. ASSERT_TRUE(res) << "Error: " << to_string(res.error());
  6197. ASSERT_EQ(StatusCode::OK_200, res->status);
  6198. ASSERT_EQ("DELETED", res->body);
  6199. res = cli_.Get("/person/john5");
  6200. ASSERT_TRUE(res) << "Error: " << to_string(res.error());
  6201. ASSERT_EQ(StatusCode::NotFound_404, res->status);
  6202. }
  6203. TEST_F(ServerTest, DeleteMethod3) {
  6204. auto res = cli_.Get("/person/john6");
  6205. ASSERT_TRUE(res) << "Error: " << to_string(res.error());
  6206. ASSERT_EQ(StatusCode::NotFound_404, res->status);
  6207. Params params;
  6208. params.emplace("name", "john6");
  6209. params.emplace("note", "tester");
  6210. res = cli_.Post("/person", params);
  6211. ASSERT_TRUE(res) << "Error: " << to_string(res.error());
  6212. ASSERT_EQ(StatusCode::OK_200, res->status);
  6213. res = cli_.Get("/person/john6");
  6214. ASSERT_TRUE(res) << "Error: " << to_string(res.error());
  6215. ASSERT_EQ(StatusCode::OK_200, res->status);
  6216. ASSERT_EQ("text/plain", res->get_header_value("Content-Type"));
  6217. ASSERT_EQ("tester", res->body);
  6218. Params delete_params;
  6219. delete_params.emplace("name", "john6");
  6220. Headers headers;
  6221. headers.emplace("Custom-Header", "test-value");
  6222. res = cli_.Delete("/person", headers, delete_params, nullptr);
  6223. ASSERT_TRUE(res) << "Error: " << to_string(res.error());
  6224. ASSERT_EQ(StatusCode::OK_200, res->status);
  6225. ASSERT_EQ("DELETED", res->body);
  6226. res = cli_.Get("/person/john6");
  6227. ASSERT_TRUE(res) << "Error: " << to_string(res.error());
  6228. ASSERT_EQ(StatusCode::NotFound_404, res->status);
  6229. }
  6230. TEST_F(ServerTest, PostWwwFormUrlEncodedJson) {
  6231. Params params;
  6232. params.emplace("json", JSON_DATA);
  6233. auto res = cli_.Post("/x-www-form-urlencoded-json", params);
  6234. ASSERT_TRUE(res) << "Error: " << to_string(res.error());
  6235. ASSERT_EQ(StatusCode::OK_200, res->status);
  6236. ASSERT_EQ(JSON_DATA, res->body);
  6237. }
  6238. TEST_F(ServerTest, PostEmptyContent) {
  6239. auto res = cli_.Post("/empty", "", "text/plain");
  6240. ASSERT_TRUE(res) << "Error: " << to_string(res.error());
  6241. ASSERT_EQ(StatusCode::OK_200, res->status);
  6242. ASSERT_EQ("empty", res->body);
  6243. }
  6244. TEST_F(ServerTest, PostEmptyContentWithNoContentType) {
  6245. auto res = cli_.Post("/empty-no-content-type");
  6246. ASSERT_TRUE(res) << "Error: " << to_string(res.error());
  6247. ASSERT_EQ(StatusCode::OK_200, res->status);
  6248. ASSERT_EQ("empty-no-content-type", res->body);
  6249. }
  6250. TEST_F(ServerTest, PostPathOnly) {
  6251. auto res = cli_.Post("/path-only");
  6252. ASSERT_TRUE(res) << "Error: " << to_string(res.error());
  6253. ASSERT_EQ(StatusCode::OK_200, res->status);
  6254. ASSERT_EQ("path-only", res->body);
  6255. }
  6256. TEST_F(ServerTest, PostPathAndHeadersOnly) {
  6257. auto res = cli_.Post("/path-headers-only",
  6258. Headers({{"hello", "world"}, {"hello2", "world2"}}));
  6259. ASSERT_TRUE(res) << "Error: " << to_string(res.error());
  6260. ASSERT_EQ(StatusCode::OK_200, res->status);
  6261. ASSERT_EQ("path-headers-only", res->body);
  6262. }
  6263. TEST_F(ServerTest, PostLarge) {
  6264. auto res = cli_.Post("/post-large", LARGE_DATA, "text/plain");
  6265. ASSERT_TRUE(res) << "Error: " << to_string(res.error());
  6266. ASSERT_EQ(StatusCode::OK_200, res->status);
  6267. EXPECT_EQ(LARGE_DATA, res->body);
  6268. }
  6269. TEST_F(ServerTest, PutEmptyContentWithNoContentType) {
  6270. auto res = cli_.Put("/empty-no-content-type");
  6271. ASSERT_TRUE(res) << "Error: " << to_string(res.error());
  6272. ASSERT_EQ(StatusCode::OK_200, res->status);
  6273. ASSERT_EQ("empty-no-content-type", res->body);
  6274. }
  6275. TEST_F(ServerTest, GetMethodDir) {
  6276. auto res = cli_.Get("/dir/");
  6277. ASSERT_TRUE(res) << "Error: " << to_string(res.error());
  6278. EXPECT_EQ(StatusCode::OK_200, res->status);
  6279. EXPECT_EQ("text/html", res->get_header_value("Content-Type"));
  6280. auto body = R"(<html>
  6281. <head>
  6282. </head>
  6283. <body>
  6284. <a href="/dir/test.html">Test</a>
  6285. <a href="/hi">hi</a>
  6286. </body>
  6287. </html>
  6288. )";
  6289. EXPECT_EQ(body, res->body);
  6290. }
  6291. TEST_F(ServerTest, GetMethodDirTest) {
  6292. auto res = cli_.Get("/dir/test.html");
  6293. ASSERT_TRUE(res) << "Error: " << to_string(res.error());
  6294. EXPECT_EQ(StatusCode::OK_200, res->status);
  6295. EXPECT_EQ("text/html", res->get_header_value("Content-Type"));
  6296. EXPECT_EQ("test.html", res->body);
  6297. }
  6298. TEST_F(ServerTest, GetMethodDirTestWithDoubleDots) {
  6299. auto res = cli_.Get("/dir/../dir/test.html");
  6300. ASSERT_TRUE(res) << "Error: " << to_string(res.error());
  6301. EXPECT_EQ(StatusCode::OK_200, res->status);
  6302. EXPECT_EQ("text/html", res->get_header_value("Content-Type"));
  6303. EXPECT_EQ("test.html", res->body);
  6304. }
  6305. TEST_F(ServerTest, GetMethodInvalidPath) {
  6306. auto res = cli_.Get("/dir/../test.html");
  6307. ASSERT_TRUE(res) << "Error: " << to_string(res.error());
  6308. EXPECT_EQ(StatusCode::NotFound_404, res->status);
  6309. }
  6310. TEST_F(ServerTest, GetMethodOutOfBaseDir) {
  6311. auto res = cli_.Get("/../www/dir/test.html");
  6312. ASSERT_TRUE(res) << "Error: " << to_string(res.error());
  6313. EXPECT_EQ(StatusCode::NotFound_404, res->status);
  6314. }
  6315. TEST_F(ServerTest, GetMethodOutOfBaseDir2) {
  6316. auto res = cli_.Get("/dir/../../www/dir/test.html");
  6317. ASSERT_TRUE(res) << "Error: " << to_string(res.error());
  6318. EXPECT_EQ(StatusCode::NotFound_404, res->status);
  6319. }
  6320. TEST_F(ServerTest, GetMethodDirMountTest) {
  6321. auto res = cli_.Get("/mount/dir/test.html");
  6322. ASSERT_TRUE(res) << "Error: " << to_string(res.error());
  6323. EXPECT_EQ(StatusCode::OK_200, res->status);
  6324. EXPECT_EQ("text/html", res->get_header_value("Content-Type"));
  6325. EXPECT_EQ("test.html", res->body);
  6326. }
  6327. TEST_F(ServerTest, GetMethodDirMountTestWithDoubleDots) {
  6328. auto res = cli_.Get("/mount/dir/../dir/test.html");
  6329. ASSERT_TRUE(res) << "Error: " << to_string(res.error());
  6330. EXPECT_EQ(StatusCode::OK_200, res->status);
  6331. EXPECT_EQ("text/html", res->get_header_value("Content-Type"));
  6332. EXPECT_EQ("test.html", res->body);
  6333. }
  6334. TEST_F(ServerTest, GetMethodInvalidMountPath) {
  6335. auto res = cli_.Get("/mount/dir/../test.html");
  6336. ASSERT_TRUE(res) << "Error: " << to_string(res.error());
  6337. EXPECT_EQ(StatusCode::NotFound_404, res->status);
  6338. }
  6339. TEST_F(ServerTest, GetMethodEmbeddedNUL) {
  6340. auto res = cli_.Get("/mount/dir/test.html%00.js");
  6341. ASSERT_TRUE(res) << "Error: " << to_string(res.error());
  6342. EXPECT_EQ(StatusCode::NotFound_404, res->status);
  6343. }
  6344. TEST_F(ServerTest, GetMethodOutOfBaseDirMount) {
  6345. auto res = cli_.Get("/mount/../www2/dir/test.html");
  6346. ASSERT_TRUE(res) << "Error: " << to_string(res.error());
  6347. EXPECT_EQ(StatusCode::NotFound_404, res->status);
  6348. }
  6349. TEST_F(ServerTest, GetMethodOutOfBaseDirMount2) {
  6350. auto res = cli_.Get("/mount/dir/../../www2/dir/test.html");
  6351. ASSERT_TRUE(res) << "Error: " << to_string(res.error());
  6352. EXPECT_EQ(StatusCode::NotFound_404, res->status);
  6353. }
  6354. TEST_F(ServerTest, GetMethodOutOfBaseDirMountWithBackslash) {
  6355. auto res = cli_.Get("/mount/%2e%2e%5c/www2/dir/test.html");
  6356. ASSERT_TRUE(res) << "Error: " << to_string(res.error());
  6357. EXPECT_EQ(StatusCode::NotFound_404, res->status);
  6358. }
  6359. TEST_F(ServerTest, GetMethodDirMountWithoutTrailingSlash) {
  6360. auto res = cli_.Get("/mount/dir");
  6361. ASSERT_TRUE(res) << "Error: " << to_string(res.error());
  6362. EXPECT_EQ(StatusCode::MovedPermanently_301, res->status);
  6363. EXPECT_EQ("./dir/", res->get_header_value("Location"));
  6364. }
  6365. TEST_F(ServerTest, GetMethodDirWithLeadingDoubleSlash) {
  6366. auto res = cli_.Get("//dir");
  6367. ASSERT_TRUE(res) << "Error: " << to_string(res.error());
  6368. EXPECT_EQ(StatusCode::MovedPermanently_301, res->status);
  6369. EXPECT_EQ("./dir/", res->get_header_value("Location"));
  6370. }
  6371. TEST_F(ServerTest, PostMethod303) {
  6372. auto res = cli_.Post("/1", "body", "text/plain");
  6373. ASSERT_TRUE(res) << "Error: " << to_string(res.error());
  6374. EXPECT_EQ(StatusCode::SeeOther_303, res->status);
  6375. EXPECT_EQ("/2", res->get_header_value("Location"));
  6376. }
  6377. TEST_F(ServerTest, PostMethod303Redirect) {
  6378. cli_.set_follow_location(true);
  6379. auto res = cli_.Post("/1", "body", "text/plain");
  6380. ASSERT_TRUE(res) << "Error: " << to_string(res.error());
  6381. EXPECT_EQ(StatusCode::OK_200, res->status);
  6382. EXPECT_EQ("redirected.", res->body);
  6383. EXPECT_EQ("/2", res->location);
  6384. }
  6385. TEST_F(ServerTest, UserDefinedMIMETypeMapping) {
  6386. auto res = cli_.Get("/dir/test.abcde");
  6387. ASSERT_TRUE(res) << "Error: " << to_string(res.error());
  6388. EXPECT_EQ(StatusCode::OK_200, res->status);
  6389. EXPECT_EQ("text/abcde", res->get_header_value("Content-Type"));
  6390. EXPECT_EQ("abcde", res->body);
  6391. }
  6392. TEST_F(ServerTest, StaticFileRange) {
  6393. auto res =
  6394. cli_.Get("/dir/test.abcde", Headers{{make_range_header({{2, 3}})}});
  6395. ASSERT_TRUE(res) << "Error: " << to_string(res.error());
  6396. EXPECT_EQ(StatusCode::PartialContent_206, res->status);
  6397. EXPECT_EQ("text/abcde", res->get_header_value("Content-Type"));
  6398. EXPECT_EQ("2", res->get_header_value("Content-Length"));
  6399. EXPECT_EQ(true, res->has_header("Content-Range"));
  6400. EXPECT_EQ("bytes 2-3/5", res->get_header_value("Content-Range"));
  6401. EXPECT_EQ(std::string("cd"), res->body);
  6402. }
  6403. TEST_F(ServerTest, StaticFileRanges) {
  6404. auto res = cli_.Get("/dir/test.abcde",
  6405. Headers{{make_range_header({{1, 2}, {4, -1}})}});
  6406. ASSERT_TRUE(res) << "Error: " << to_string(res.error());
  6407. EXPECT_EQ(StatusCode::PartialContent_206, res->status);
  6408. EXPECT_TRUE(
  6409. res->get_header_value("Content-Type")
  6410. .find(
  6411. "multipart/byteranges; boundary=--cpp-httplib-multipart-data-") ==
  6412. 0);
  6413. EXPECT_EQ("266", res->get_header_value("Content-Length"));
  6414. }
  6415. TEST_F(ServerTest, StaticFileRangeHead) {
  6416. auto res = cli_.Head("/dir/test.abcde", {{make_range_header({{2, 3}})}});
  6417. ASSERT_TRUE(res) << "Error: " << to_string(res.error());
  6418. EXPECT_EQ(StatusCode::PartialContent_206, res->status);
  6419. EXPECT_EQ("text/abcde", res->get_header_value("Content-Type"));
  6420. EXPECT_EQ("2", res->get_header_value("Content-Length"));
  6421. EXPECT_EQ(true, res->has_header("Content-Range"));
  6422. EXPECT_EQ("bytes 2-3/5", res->get_header_value("Content-Range"));
  6423. }
  6424. TEST_F(ServerTest, StaticFileRangeBigFile) {
  6425. auto res = cli_.Get("/dir/1MB.txt", Headers{{make_range_header({{-1, 5}})}});
  6426. ASSERT_TRUE(res) << "Error: " << to_string(res.error());
  6427. EXPECT_EQ(StatusCode::PartialContent_206, res->status);
  6428. EXPECT_EQ("text/plain", res->get_header_value("Content-Type"));
  6429. EXPECT_EQ("5", res->get_header_value("Content-Length"));
  6430. EXPECT_EQ(true, res->has_header("Content-Range"));
  6431. EXPECT_EQ("bytes 1048571-1048575/1048576",
  6432. res->get_header_value("Content-Range"));
  6433. EXPECT_EQ("LAST\n", res->body);
  6434. }
  6435. TEST_F(ServerTest, StaticFileRangeBigFile2) {
  6436. auto res =
  6437. cli_.Get("/dir/1MB.txt", Headers{{make_range_header({{1, 4097}})}});
  6438. ASSERT_TRUE(res) << "Error: " << to_string(res.error());
  6439. EXPECT_EQ(StatusCode::PartialContent_206, res->status);
  6440. EXPECT_EQ("text/plain", res->get_header_value("Content-Type"));
  6441. EXPECT_EQ("4097", res->get_header_value("Content-Length"));
  6442. EXPECT_EQ(true, res->has_header("Content-Range"));
  6443. EXPECT_EQ("bytes 1-4097/1048576", res->get_header_value("Content-Range"));
  6444. }
  6445. TEST_F(ServerTest, StaticFileBigFile) {
  6446. auto res = cli_.Get("/dir/1MB.txt");
  6447. ASSERT_TRUE(res) << "Error: " << to_string(res.error());
  6448. EXPECT_EQ(StatusCode::OK_200, res->status);
  6449. EXPECT_EQ("text/plain", res->get_header_value("Content-Type"));
  6450. EXPECT_EQ("1048576", res->get_header_value("Content-Length"));
  6451. }
  6452. TEST_F(ServerTest, InvalidBaseDirMount) {
  6453. EXPECT_EQ(false, svr_.set_mount_point("invalid_mount_point", "./www3"));
  6454. }
  6455. TEST_F(ServerTest, Binary) {
  6456. std::vector<char> binary{0x00, 0x01, 0x02, 0x03};
  6457. auto res = cli_.Post("/binary", binary.data(), binary.size(),
  6458. "application/octet-stream");
  6459. ASSERT_TRUE(res) << "Error: " << to_string(res.error());
  6460. ASSERT_EQ(StatusCode::OK_200, res->status);
  6461. ASSERT_EQ(4U, res->body.size());
  6462. res = cli_.Put("/binary", binary.data(), binary.size(),
  6463. "application/octet-stream");
  6464. ASSERT_TRUE(res) << "Error: " << to_string(res.error());
  6465. ASSERT_EQ(StatusCode::OK_200, res->status);
  6466. ASSERT_EQ(4U, res->body.size());
  6467. res = cli_.Patch("/binary", binary.data(), binary.size(),
  6468. "application/octet-stream");
  6469. ASSERT_TRUE(res) << "Error: " << to_string(res.error());
  6470. ASSERT_EQ(StatusCode::OK_200, res->status);
  6471. ASSERT_EQ(4U, res->body.size());
  6472. res = cli_.Delete("/binary", binary.data(), binary.size(),
  6473. "application/octet-stream");
  6474. ASSERT_TRUE(res) << "Error: " << to_string(res.error());
  6475. ASSERT_EQ(StatusCode::OK_200, res->status);
  6476. ASSERT_EQ(4U, res->body.size());
  6477. }
  6478. TEST_F(ServerTest, BinaryString) {
  6479. auto binary = std::string("\x00\x01\x02\x03", 4);
  6480. auto res = cli_.Post("/binary", binary, "application/octet-stream");
  6481. ASSERT_TRUE(res) << "Error: " << to_string(res.error());
  6482. ASSERT_EQ(StatusCode::OK_200, res->status);
  6483. ASSERT_EQ(4U, res->body.size());
  6484. res = cli_.Put("/binary", binary, "application/octet-stream");
  6485. ASSERT_TRUE(res) << "Error: " << to_string(res.error());
  6486. ASSERT_EQ(StatusCode::OK_200, res->status);
  6487. ASSERT_EQ(4U, res->body.size());
  6488. res = cli_.Patch("/binary", binary, "application/octet-stream");
  6489. ASSERT_TRUE(res) << "Error: " << to_string(res.error());
  6490. ASSERT_EQ(StatusCode::OK_200, res->status);
  6491. ASSERT_EQ(4U, res->body.size());
  6492. res = cli_.Delete("/binary", binary, "application/octet-stream");
  6493. ASSERT_TRUE(res) << "Error: " << to_string(res.error());
  6494. ASSERT_EQ(StatusCode::OK_200, res->status);
  6495. ASSERT_EQ(4U, res->body.size());
  6496. }
  6497. TEST_F(ServerTest, EmptyRequest) {
  6498. auto res = cli_.Get("");
  6499. ASSERT_TRUE(!res);
  6500. EXPECT_EQ(Error::Connection, res.error());
  6501. }
  6502. TEST_F(ServerTest, LongRequest) {
  6503. std::string request;
  6504. for (size_t i = 0; i < 545; i++) {
  6505. request += "/TooLongRequest";
  6506. }
  6507. request += "OK";
  6508. auto res = cli_.Get(request.c_str());
  6509. ASSERT_TRUE(res) << "Error: " << to_string(res.error());
  6510. EXPECT_EQ(StatusCode::NotFound_404, res->status);
  6511. }
  6512. TEST_F(ServerTest, TooLongRequest) {
  6513. std::string request;
  6514. for (size_t i = 0; i < 546; i++) {
  6515. request += "/TooLongRequest";
  6516. }
  6517. request += "_NG";
  6518. auto start = std::chrono::high_resolution_clock::now();
  6519. cli_.set_keep_alive(true);
  6520. auto res = cli_.Get(request.c_str());
  6521. auto end = std::chrono::high_resolution_clock::now();
  6522. auto elapsed =
  6523. std::chrono::duration_cast<std::chrono::milliseconds>(end - start)
  6524. .count();
  6525. ASSERT_TRUE(res) << "Error: " << to_string(res.error());
  6526. EXPECT_EQ(StatusCode::UriTooLong_414, res->status);
  6527. EXPECT_LE(elapsed, 1000);
  6528. EXPECT_EQ("close", res->get_header_value("Connection"));
  6529. EXPECT_FALSE(cli_.is_socket_open());
  6530. }
  6531. TEST_F(ServerTest, AlmostTooLongRequest) {
  6532. // test for #2046 - URI length check shouldn't include other content on req
  6533. // line URI is max URI length, minus 14 other chars in req line (GET, space,
  6534. // leading /, space, HTTP/1.1)
  6535. std::string request =
  6536. "/" + string(CPPHTTPLIB_REQUEST_URI_MAX_LENGTH - 14, 'A');
  6537. auto res = cli_.Get(request.c_str());
  6538. ASSERT_TRUE(res) << "Error: " << to_string(res.error());
  6539. EXPECT_EQ(StatusCode::NotFound_404, res->status);
  6540. }
  6541. TEST_F(ServerTest, LongHeader) {
  6542. Request req;
  6543. req.method = "GET";
  6544. req.path = "/hi";
  6545. std::string host_and_port;
  6546. host_and_port += HOST;
  6547. host_and_port += ":";
  6548. host_and_port += std::to_string(PORT);
  6549. req.headers.emplace("Host", host_and_port.c_str());
  6550. req.headers.emplace("Accept", "*/*");
  6551. req.headers.emplace("User-Agent", "cpp-httplib/0.1");
  6552. req.headers.emplace(
  6553. "Header-Name",
  6554. "@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@"
  6555. "@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@"
  6556. "@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@"
  6557. "@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@"
  6558. "@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@"
  6559. "@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@"
  6560. "@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@"
  6561. "@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@"
  6562. "@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@"
  6563. "@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@"
  6564. "@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@"
  6565. "@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@"
  6566. "@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@"
  6567. "@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@"
  6568. "@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@"
  6569. "@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@"
  6570. "@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@"
  6571. "@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@"
  6572. "@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@"
  6573. "@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@"
  6574. "@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@"
  6575. "@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@"
  6576. "@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@"
  6577. "@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@"
  6578. "@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@"
  6579. "@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@"
  6580. "@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@"
  6581. "@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@"
  6582. "@@@@@@@@@@@@@@@@");
  6583. auto res = std::make_shared<Response>();
  6584. auto error = Error::Success;
  6585. auto ret = cli_.send(req, *res, error);
  6586. ASSERT_TRUE(ret);
  6587. EXPECT_EQ(StatusCode::OK_200, res->status);
  6588. }
  6589. TEST_F(ServerTest, LongQueryValue) {
  6590. auto start = std::chrono::high_resolution_clock::now();
  6591. cli_.set_keep_alive(true);
  6592. auto res = cli_.Get(LONG_QUERY_URL.c_str());
  6593. auto end = std::chrono::high_resolution_clock::now();
  6594. auto elapsed =
  6595. std::chrono::duration_cast<std::chrono::milliseconds>(end - start)
  6596. .count();
  6597. ASSERT_TRUE(res) << "Error: " << to_string(res.error());
  6598. EXPECT_EQ(StatusCode::UriTooLong_414, res->status);
  6599. EXPECT_LE(elapsed, 1000);
  6600. EXPECT_EQ("close", res->get_header_value("Connection"));
  6601. EXPECT_FALSE(cli_.is_socket_open());
  6602. }
  6603. TEST_F(ServerTest, TooLongQueryValue) {
  6604. auto res = cli_.Get(TOO_LONG_QUERY_URL.c_str());
  6605. ASSERT_FALSE(res);
  6606. EXPECT_EQ(Error::Read, res.error());
  6607. }
  6608. TEST_F(ServerTest, TooLongHeader) {
  6609. Request req;
  6610. req.method = "GET";
  6611. req.path = "/hi";
  6612. std::string host_and_port;
  6613. host_and_port += HOST;
  6614. host_and_port += ":";
  6615. host_and_port += std::to_string(PORT);
  6616. req.headers.emplace("Host", host_and_port.c_str());
  6617. req.headers.emplace("Accept", "*/*");
  6618. req.headers.emplace("User-Agent", "cpp-httplib/0.1");
  6619. req.headers.emplace(
  6620. "Header-Name",
  6621. "@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@"
  6622. "@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@"
  6623. "@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@"
  6624. "@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@"
  6625. "@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@"
  6626. "@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@"
  6627. "@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@"
  6628. "@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@"
  6629. "@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@"
  6630. "@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@"
  6631. "@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@"
  6632. "@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@"
  6633. "@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@"
  6634. "@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@"
  6635. "@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@"
  6636. "@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@"
  6637. "@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@"
  6638. "@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@"
  6639. "@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@"
  6640. "@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@"
  6641. "@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@"
  6642. "@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@"
  6643. "@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@"
  6644. "@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@"
  6645. "@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@"
  6646. "@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@"
  6647. "@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@"
  6648. "@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@"
  6649. "@@@@@@@@@@@@@@@@@");
  6650. auto res = std::make_shared<Response>();
  6651. auto error = Error::Success;
  6652. auto ret = cli_.send(req, *res, error);
  6653. ASSERT_TRUE(ret);
  6654. EXPECT_EQ(StatusCode::OK_200, res->status);
  6655. }
  6656. TEST_F(ServerTest, HeaderCountAtLimit) {
  6657. // Test with headers just under the 100 limit
  6658. httplib::Headers headers;
  6659. // Add 95 custom headers (the client will add Host, User-Agent, Accept, etc.)
  6660. // This should keep us just under the 100 header limit
  6661. for (int i = 0; i < 95; i++) {
  6662. std::string name = "X-Test-Header-" + std::to_string(i);
  6663. std::string value = "value" + std::to_string(i);
  6664. headers.emplace(name, value);
  6665. }
  6666. // This should work fine as we're under the limit
  6667. auto res = cli_.Get("/hi", headers);
  6668. EXPECT_TRUE(res);
  6669. if (res) { EXPECT_EQ(StatusCode::OK_200, res->status); }
  6670. }
  6671. TEST_F(ServerTest, HeaderCountExceedsLimit) {
  6672. // Test with many headers to exceed the 100 limit
  6673. httplib::Headers headers;
  6674. // Add 150 headers to definitely exceed the 100 limit
  6675. for (int i = 0; i < 150; i++) {
  6676. std::string name = "X-Test-Header-" + std::to_string(i);
  6677. std::string value = "value" + std::to_string(i);
  6678. headers.emplace(name, value);
  6679. }
  6680. // This should fail due to exceeding header count limit
  6681. cli_.set_keep_alive(true);
  6682. auto res = cli_.Get("/hi", headers);
  6683. // The server should respond with 400 Bad Request
  6684. ASSERT_TRUE(res) << "Error: " << to_string(res.error());
  6685. EXPECT_EQ(StatusCode::BadRequest_400, res->status);
  6686. EXPECT_EQ("close", res->get_header_value("Connection"));
  6687. EXPECT_FALSE(cli_.is_socket_open());
  6688. }
  6689. TEST_F(ServerTest, PercentEncoding) {
  6690. auto res = cli_.Get("/e%6edwith%");
  6691. ASSERT_TRUE(res) << "Error: " << to_string(res.error());
  6692. EXPECT_EQ(StatusCode::OK_200, res->status);
  6693. }
  6694. TEST_F(ServerTest, PercentEncodingUnicode) {
  6695. auto res = cli_.Get("/e%u006edwith%");
  6696. ASSERT_TRUE(res) << "Error: " << to_string(res.error());
  6697. EXPECT_EQ(StatusCode::OK_200, res->status);
  6698. }
  6699. TEST_F(ServerTest, InvalidPercentEncoding) {
  6700. auto res = cli_.Get("/%endwith%");
  6701. ASSERT_TRUE(res) << "Error: " << to_string(res.error());
  6702. EXPECT_EQ(StatusCode::NotFound_404, res->status);
  6703. }
  6704. TEST_F(ServerTest, InvalidPercentEncodingUnicode) {
  6705. auto res = cli_.Get("/%uendwith%");
  6706. ASSERT_TRUE(res) << "Error: " << to_string(res.error());
  6707. EXPECT_EQ(StatusCode::NotFound_404, res->status);
  6708. }
  6709. TEST_F(ServerTest, EndWithPercentCharacterInQuery) {
  6710. auto res = cli_.Get("/hello?aaa=bbb%");
  6711. ASSERT_TRUE(res) << "Error: " << to_string(res.error());
  6712. EXPECT_EQ(StatusCode::NotFound_404, res->status);
  6713. }
  6714. TEST_F(ServerTest, PlusSignEncoding) {
  6715. auto res = cli_.Get("/a+%2Bb?a %2bb=a %2Bb");
  6716. ASSERT_TRUE(res) << "Error: " << to_string(res.error());
  6717. EXPECT_EQ(StatusCode::OK_200, res->status);
  6718. EXPECT_EQ("a +b", res->body);
  6719. }
  6720. TEST_F(ServerTest, HeaderCountSecurityTest) {
  6721. // This test simulates a potential DoS attack using many headers
  6722. // to verify our security fix prevents memory exhaustion
  6723. httplib::Headers attack_headers;
  6724. // Attempt to add many headers like an attacker would (200 headers to far
  6725. // exceed limit)
  6726. for (int i = 0; i < 200; i++) {
  6727. std::string name = "X-Attack-Header-" + std::to_string(i);
  6728. std::string value = "attack_payload_" + std::to_string(i);
  6729. attack_headers.emplace(name, value);
  6730. }
  6731. // Try to POST with excessive headers
  6732. cli_.set_keep_alive(true);
  6733. auto res = cli_.Post("/", attack_headers, "test_data", "text/plain");
  6734. // Should either fail or return 400 Bad Request due to security limit
  6735. if (res) {
  6736. // If we get a response, it should be 400 Bad Request
  6737. EXPECT_EQ(StatusCode::BadRequest_400, res->status);
  6738. EXPECT_EQ("close", res->get_header_value("Connection"));
  6739. }
  6740. EXPECT_FALSE(cli_.is_socket_open());
  6741. }
  6742. TEST_F(ServerTest, MultipartFormData) {
  6743. UploadFormDataItems items = {
  6744. {"text1", "text default", "", ""},
  6745. {"text2", "aωb", "", ""},
  6746. {"file1", "h\ne\n\nl\nl\no\n", "hello.txt", "text/plain"},
  6747. {"file2", "{\n \"world\", true\n}\n", "world.json", "application/json"},
  6748. {"file3", "", "", "application/octet-stream"},
  6749. {"file4", "", "", " application/json tmp-string "}};
  6750. auto res = cli_.Post("/multipart", items);
  6751. ASSERT_TRUE(res) << "Error: " << to_string(res.error());
  6752. EXPECT_EQ(StatusCode::OK_200, res->status);
  6753. }
  6754. TEST_F(ServerTest, MultipartFormDataMultiFileValues) {
  6755. UploadFormDataItems items = {
  6756. {"text", "default text", "", ""},
  6757. {"multi_text1", "aaaaa", "", ""},
  6758. {"multi_text1", "bbbbb", "", ""},
  6759. {"multi_file1", "h\ne\n\nl\nl\no\n", "hello.txt", "text/plain"},
  6760. {"multi_file1", "{\n \"world\", true\n}\n", "world.json",
  6761. "application/json"},
  6762. };
  6763. auto res = cli_.Post("/multipart/multi_file_values", items);
  6764. ASSERT_TRUE(res) << "Error: " << to_string(res.error());
  6765. EXPECT_EQ(StatusCode::OK_200, res->status);
  6766. }
  6767. TEST_F(ServerTest, CaseInsensitiveHeaderName) {
  6768. auto res = cli_.Get("/hi");
  6769. ASSERT_TRUE(res) << "Error: " << to_string(res.error());
  6770. EXPECT_EQ(StatusCode::OK_200, res->status);
  6771. EXPECT_EQ("text/plain", res->get_header_value("content-type"));
  6772. EXPECT_EQ("Hello World!", res->body);
  6773. }
  6774. TEST_F(ServerTest, CaseInsensitiveTransferEncoding) {
  6775. Request req;
  6776. req.method = "POST";
  6777. req.path = "/chunked";
  6778. std::string host_and_port;
  6779. host_and_port += HOST;
  6780. host_and_port += ":";
  6781. host_and_port += std::to_string(PORT);
  6782. req.headers.emplace("Host", host_and_port.c_str());
  6783. req.headers.emplace("Accept", "*/*");
  6784. req.headers.emplace("User-Agent", "cpp-httplib/0.1");
  6785. req.headers.emplace("Content-Type", "text/plain");
  6786. req.headers.emplace("Content-Length", "0");
  6787. req.headers.emplace(
  6788. "Transfer-Encoding",
  6789. "Chunked"); // Note, "Chunked" rather than typical "chunked".
  6790. // Client does not chunk, so make a chunked body manually.
  6791. req.body = "4\r\ndech\r\nf\r\nunked post body\r\n0\r\n\r\n";
  6792. auto res = std::make_shared<Response>();
  6793. auto error = Error::Success;
  6794. auto ret = cli_.send(req, *res, error);
  6795. ASSERT_TRUE(ret);
  6796. EXPECT_EQ(StatusCode::OK_200, res->status);
  6797. }
  6798. template <typename ClientT>
  6799. static void expect_chunked_body_status(ClientT &cli, const char *body,
  6800. int expected_status) {
  6801. Request req;
  6802. req.method = "POST";
  6803. req.path = "/chunked";
  6804. std::string host_and_port;
  6805. host_and_port += HOST;
  6806. host_and_port += ":";
  6807. host_and_port += std::to_string(PORT);
  6808. req.headers.emplace("Host", host_and_port.c_str());
  6809. req.headers.emplace("Content-Length", "0");
  6810. req.headers.emplace("Transfer-Encoding", "chunked");
  6811. req.body = body;
  6812. auto res = std::make_shared<Response>();
  6813. auto error = Error::Success;
  6814. ASSERT_TRUE(cli.send(req, *res, error));
  6815. EXPECT_EQ(expected_status, res->status);
  6816. }
  6817. // GHSA-h6wq-j5mv-f3q8: the server must reject malformed chunk-size lines
  6818. // rather than treat them as valid lengths.
  6819. template <typename ClientT>
  6820. static void expect_chunked_body_rejected(ClientT &cli, const char *body) {
  6821. expect_chunked_body_status(cli, body, StatusCode::BadRequest_400);
  6822. }
  6823. TEST_F(ServerTest, RejectsNegativeChunkSize) {
  6824. expect_chunked_body_rejected(cli_, "-2\r\nAAAA\r\n0\r\n\r\n");
  6825. }
  6826. TEST_F(ServerTest, RejectsChunkSizeWithLeadingPlus) {
  6827. expect_chunked_body_rejected(
  6828. cli_, "+4\r\ndech\r\nf\r\nunked post body\r\n0\r\n\r\n");
  6829. }
  6830. // RFC 9112 §7.1.1: a chunk-ext is made of tokens and quoted-strings, so the
  6831. // chunk-size line carries no CR, LF or other control character ahead of its
  6832. // terminator. Such a line must be refused rather than read as extension text.
  6833. TEST_F(ServerTest, RejectsBareLFInChunkExtension) {
  6834. expect_chunked_body_rejected(
  6835. cli_, "4;\nxx\r\ndech\r\nf\r\nunked post body\r\n0\r\n\r\n");
  6836. }
  6837. TEST_F(ServerTest, RejectsBareLFAfterChunkSize) {
  6838. expect_chunked_body_rejected(
  6839. cli_, "4\nxx\r\ndech\r\nf\r\nunked post body\r\n0\r\n\r\n");
  6840. }
  6841. TEST_F(ServerTest, RejectsBareCRInChunkExtension) {
  6842. expect_chunked_body_rejected(
  6843. cli_, "4;a\rb\r\ndech\r\nf\r\nunked post body\r\n0\r\n\r\n");
  6844. }
  6845. TEST_F(ServerTest, RejectsControlCharacterInChunkExtension) {
  6846. // The literal stays split: a hex escape consumes every hex digit that
  6847. // follows, so "\x01b" would be the single byte \x1b, not \x01 then 'b'.
  6848. expect_chunked_body_rejected(
  6849. cli_, "4;a\x01"
  6850. "b\r\ndech\r\nf\r\nunked post body\r\n0\r\n\r\n");
  6851. }
  6852. TEST_F(ServerTest, AcceptsChunkExtension) {
  6853. expect_chunked_body_status(cli_,
  6854. "4;name=value\r\ndech\r\n"
  6855. "f ; note=\"a;b c\"\r\nunked post body\r\n"
  6856. "0;last\r\n\r\n",
  6857. StatusCode::OK_200);
  6858. }
  6859. TEST_F(ServerTest, GetStreamed2) {
  6860. auto res = cli_.Get("/streamed", Headers{{make_range_header({{2, 3}})}});
  6861. ASSERT_TRUE(res) << "Error: " << to_string(res.error());
  6862. EXPECT_EQ(StatusCode::PartialContent_206, res->status);
  6863. EXPECT_EQ("2", res->get_header_value("Content-Length"));
  6864. EXPECT_EQ(true, res->has_header("Content-Range"));
  6865. EXPECT_EQ("bytes 2-3/6", res->get_header_value("Content-Range"));
  6866. EXPECT_EQ(std::string("ab"), res->body);
  6867. }
  6868. TEST_F(ServerTest, GetStreamed) {
  6869. auto res = cli_.Get("/streamed");
  6870. ASSERT_TRUE(res) << "Error: " << to_string(res.error());
  6871. EXPECT_EQ(StatusCode::OK_200, res->status);
  6872. EXPECT_EQ("6", res->get_header_value("Content-Length"));
  6873. EXPECT_EQ(std::string("aaabbb"), res->body);
  6874. }
  6875. TEST_F(ServerTest, GetStreamedWithoutLengthWithRange) {
  6876. auto res = cli_.Get("/streamed-without-length",
  6877. Headers{make_range_header({{0, -1}})});
  6878. ASSERT_TRUE(res) << "Error: " << to_string(res.error());
  6879. EXPECT_EQ(StatusCode::OK_200, res->status);
  6880. EXPECT_EQ(false, res->has_header("Content-Length"));
  6881. EXPECT_EQ(false, res->has_header("Content-Range"));
  6882. EXPECT_EQ(std::string("abcdefg"), res->body);
  6883. }
  6884. TEST_F(ServerTest, GetStreamedWithRange1) {
  6885. auto res =
  6886. cli_.Get("/streamed-with-range", Headers{{make_range_header({{3, 5}})}});
  6887. ASSERT_TRUE(res) << "Error: " << to_string(res.error());
  6888. EXPECT_EQ(StatusCode::PartialContent_206, res->status);
  6889. EXPECT_EQ("3", res->get_header_value("Content-Length"));
  6890. EXPECT_EQ(true, res->has_header("Content-Range"));
  6891. EXPECT_EQ("bytes 3-5/7", res->get_header_value("Content-Range"));
  6892. EXPECT_EQ(std::string("def"), res->body);
  6893. }
  6894. TEST_F(ServerTest, GetStreamedWithRange2) {
  6895. auto res =
  6896. cli_.Get("/streamed-with-range", Headers{{make_range_header({{1, -1}})}});
  6897. ASSERT_TRUE(res) << "Error: " << to_string(res.error());
  6898. EXPECT_EQ(StatusCode::PartialContent_206, res->status);
  6899. EXPECT_EQ("6", res->get_header_value("Content-Length"));
  6900. EXPECT_EQ(true, res->has_header("Content-Range"));
  6901. EXPECT_EQ("bytes 1-6/7", res->get_header_value("Content-Range"));
  6902. EXPECT_EQ(std::string("bcdefg"), res->body);
  6903. }
  6904. TEST_F(ServerTest, GetStreamedWithRangeSuffix1) {
  6905. auto res = cli_.Get("/streamed-with-range", Headers{{"Range", "bytes=-3"}});
  6906. ASSERT_TRUE(res) << "Error: " << to_string(res.error());
  6907. EXPECT_EQ(StatusCode::PartialContent_206, res->status);
  6908. EXPECT_EQ("3", res->get_header_value("Content-Length"));
  6909. EXPECT_EQ(true, res->has_header("Content-Range"));
  6910. EXPECT_EQ("bytes 4-6/7", res->get_header_value("Content-Range"));
  6911. EXPECT_EQ(std::string("efg"), res->body);
  6912. }
  6913. TEST_F(ServerTest, GetStreamedWithRangeSuffix2) {
  6914. // RFC 9110 14.1.2: a suffix-length longer than the representation selects
  6915. // the entire representation.
  6916. for (auto range : {"bytes=-8", "bytes=-9999"}) {
  6917. auto res = cli_.Get("/streamed-with-range", Headers{{"Range", range}});
  6918. ASSERT_TRUE(res) << "Error: " << to_string(res.error());
  6919. EXPECT_EQ(StatusCode::PartialContent_206, res->status) << range;
  6920. EXPECT_EQ("7", res->get_header_value("Content-Length")) << range;
  6921. EXPECT_EQ("bytes 0-6/7", res->get_header_value("Content-Range")) << range;
  6922. EXPECT_EQ(std::string("abcdefg"), res->body) << range;
  6923. }
  6924. }
  6925. TEST_F(ServerTest, GetStreamedWithRangeSuffixZero) {
  6926. auto res =
  6927. cli_.Get("/streamed-with-range?error", Headers{{"Range", "bytes=-0"}});
  6928. ASSERT_TRUE(res) << "Error: " << to_string(res.error());
  6929. EXPECT_EQ(StatusCode::RangeNotSatisfiable_416, res->status);
  6930. EXPECT_EQ("0", res->get_header_value("Content-Length"));
  6931. EXPECT_EQ(false, res->has_header("Content-Range"));
  6932. EXPECT_EQ(0U, res->body.size());
  6933. }
  6934. TEST_F(ServerTest, GetStreamedWithRangeAndNonPartialStatus) {
  6935. // Only a 206 is served as a partial representation. Under any other status
  6936. // `apply_ranges()` reported the full content length, so the body must match
  6937. // that header, and the content provider must never be asked for an offset
  6938. // outside the representation.
  6939. auto check = [&](int status, const char *range) {
  6940. auto path =
  6941. std::string("/streamed-with-range?status=") + std::to_string(status);
  6942. auto ctx = path + " Range: " + range;
  6943. auto res = cli_.Get(path, Headers{{"Range", range}});
  6944. ASSERT_TRUE(res) << ctx << " Error: " << to_string(res.error());
  6945. EXPECT_EQ(status, res->status) << ctx;
  6946. EXPECT_EQ("7", res->get_header_value("Content-Length")) << ctx;
  6947. EXPECT_EQ("text/plain", res->get_header_value("Content-Type")) << ctx;
  6948. EXPECT_FALSE(res->has_header("Content-Range")) << ctx;
  6949. EXPECT_EQ(std::string("abcdefg"), res->body) << ctx;
  6950. };
  6951. // Non-2xx: `detail::range_error()` never validated these ranges at all.
  6952. check(403, "bytes=3-5");
  6953. // The offset is far past the representation.
  6954. check(403, "bytes=100000-100200");
  6955. // `first_pos` is still -1 here, and the bounds asserts in
  6956. // `get_range_offset_and_length()` are compiled out under NDEBUG.
  6957. check(403, "bytes=-3");
  6958. // `apply_ranges()` makes no boundary for a non-206 response, so the
  6959. // multipart branch would have written one that is empty.
  6960. check(403, "bytes=1-2, 4-5");
  6961. // 2xx but not 206: the ranges were validated, yet the Content-Length still
  6962. // covers the whole representation.
  6963. check(200, "bytes=3-5");
  6964. check(200, "bytes=1-2, 4-5");
  6965. }
  6966. TEST_F(ServerTest, GetStreamedWithRangeError) {
  6967. auto res =
  6968. cli_.Get("/streamed-with-range",
  6969. Headers{{"Range", "bytes=92233720368547758079223372036854775806-"
  6970. "92233720368547758079223372036854775807"}});
  6971. ASSERT_TRUE(res) << "Error: " << to_string(res.error());
  6972. EXPECT_EQ(StatusCode::RangeNotSatisfiable_416, res->status);
  6973. EXPECT_EQ("0", res->get_header_value("Content-Length"));
  6974. EXPECT_EQ(false, res->has_header("Content-Range"));
  6975. EXPECT_EQ(0U, res->body.size());
  6976. }
  6977. TEST_F(ServerTest, GetRangeWithMaxLongLength) {
  6978. auto res = cli_.Get(
  6979. "/with-range",
  6980. Headers{{"Range",
  6981. "bytes=0-" + std::to_string(std::numeric_limits<long>::max())},
  6982. {"Accept-Encoding", ""}});
  6983. ASSERT_TRUE(res) << "Error: " << to_string(res.error());
  6984. EXPECT_EQ(StatusCode::PartialContent_206, res->status);
  6985. EXPECT_EQ("7", res->get_header_value("Content-Length"));
  6986. EXPECT_EQ(true, res->has_header("Content-Range"));
  6987. EXPECT_EQ("bytes 0-6/7", res->get_header_value("Content-Range"));
  6988. EXPECT_EQ(std::string("abcdefg"), res->body);
  6989. }
  6990. TEST_F(ServerTest, GetRangeWithZeroToInfinite) {
  6991. auto res = cli_.Get("/with-range", Headers{
  6992. {"Range", "bytes=0-"},
  6993. {"Accept-Encoding", ""},
  6994. });
  6995. ASSERT_TRUE(res) << "Error: " << to_string(res.error());
  6996. EXPECT_EQ(StatusCode::PartialContent_206, res->status);
  6997. EXPECT_EQ("7", res->get_header_value("Content-Length"));
  6998. EXPECT_EQ(true, res->has_header("Content-Range"));
  6999. EXPECT_EQ("bytes 0-6/7", res->get_header_value("Content-Range"));
  7000. EXPECT_EQ(std::string("abcdefg"), res->body);
  7001. }
  7002. TEST_F(ServerTest, GetStreamedWithRangeMultipart) {
  7003. auto res = cli_.Get("/streamed-with-range",
  7004. Headers{{make_range_header({{1, 2}, {4, 5}})}});
  7005. ASSERT_TRUE(res) << "Error: " << to_string(res.error());
  7006. EXPECT_EQ(StatusCode::PartialContent_206, res->status);
  7007. EXPECT_EQ("267", res->get_header_value("Content-Length"));
  7008. EXPECT_EQ(false, res->has_header("Content-Range"));
  7009. EXPECT_EQ(267U, res->body.size());
  7010. // Check that both range contents are present
  7011. EXPECT_TRUE(res->body.find("bc\r\n") != std::string::npos);
  7012. EXPECT_TRUE(res->body.find("ef\r\n") != std::string::npos);
  7013. // Check that Content-Range headers are present for both ranges
  7014. EXPECT_TRUE(res->body.find("Content-Range: bytes 1-2/7") !=
  7015. std::string::npos);
  7016. EXPECT_TRUE(res->body.find("Content-Range: bytes 4-5/7") !=
  7017. std::string::npos);
  7018. }
  7019. TEST_F(ServerTest, GetStreamedWithTooManyRanges) {
  7020. Ranges ranges;
  7021. for (size_t i = 0; i < CPPHTTPLIB_RANGE_MAX_COUNT + 1; i++) {
  7022. ranges.emplace_back(0, -1);
  7023. }
  7024. auto res = cli_.Get("/streamed-with-range?error",
  7025. Headers{{make_range_header(ranges)}});
  7026. ASSERT_TRUE(res) << "Error: " << to_string(res.error());
  7027. EXPECT_EQ(StatusCode::RangeNotSatisfiable_416, res->status);
  7028. EXPECT_EQ("0", res->get_header_value("Content-Length"));
  7029. EXPECT_EQ(false, res->has_header("Content-Range"));
  7030. EXPECT_EQ(0U, res->body.size());
  7031. }
  7032. TEST_F(ServerTest, GetStreamedWithOverwrapping) {
  7033. auto res = cli_.Get("/streamed-with-range",
  7034. Headers{{make_range_header({{1, 4}, {2, 5}})}});
  7035. ASSERT_TRUE(res) << "Error: " << to_string(res.error());
  7036. EXPECT_EQ(StatusCode::PartialContent_206, res->status);
  7037. EXPECT_EQ(5U, res->body.size());
  7038. // Check that overlapping ranges are coalesced into a single range
  7039. EXPECT_EQ("bcdef", res->body);
  7040. EXPECT_EQ("bytes 1-5/7", res->get_header_value("Content-Range"));
  7041. // Should be single range, not multipart
  7042. EXPECT_TRUE(res->has_header("Content-Range"));
  7043. EXPECT_EQ("text/plain", res->get_header_value("Content-Type"));
  7044. }
  7045. TEST_F(ServerTest, GetStreamedWithNonAscendingRanges) {
  7046. auto res = cli_.Get("/streamed-with-range",
  7047. Headers{{make_range_header({{4, 5}, {0, 2}})}});
  7048. ASSERT_TRUE(res) << "Error: " << to_string(res.error());
  7049. EXPECT_EQ(StatusCode::PartialContent_206, res->status);
  7050. EXPECT_EQ(268U, res->body.size());
  7051. // Check that both range contents are present
  7052. EXPECT_TRUE(res->body.find("ef\r\n") != std::string::npos);
  7053. EXPECT_TRUE(res->body.find("abc\r\n") != std::string::npos);
  7054. // Check that Content-Range headers are present for both ranges
  7055. EXPECT_TRUE(res->body.find("Content-Range: bytes 4-5/7") !=
  7056. std::string::npos);
  7057. EXPECT_TRUE(res->body.find("Content-Range: bytes 0-2/7") !=
  7058. std::string::npos);
  7059. }
  7060. TEST_F(ServerTest, GetStreamedWithDuplicateRanges) {
  7061. auto res = cli_.Get("/streamed-with-range",
  7062. Headers{{make_range_header({{0, 2}, {0, 2}})}});
  7063. ASSERT_TRUE(res) << "Error: " << to_string(res.error());
  7064. EXPECT_EQ(StatusCode::PartialContent_206, res->status);
  7065. EXPECT_EQ(269U, res->body.size());
  7066. // Check that both duplicate range contents are present
  7067. size_t first_abc = res->body.find("abc\r\n");
  7068. EXPECT_TRUE(first_abc != std::string::npos);
  7069. size_t second_abc = res->body.find("abc\r\n", first_abc + 1);
  7070. EXPECT_TRUE(second_abc != std::string::npos);
  7071. // Check that Content-Range headers are present for both ranges
  7072. size_t first_range = res->body.find("Content-Range: bytes 0-2/7");
  7073. EXPECT_TRUE(first_range != std::string::npos);
  7074. size_t second_range =
  7075. res->body.find("Content-Range: bytes 0-2/7", first_range + 1);
  7076. EXPECT_TRUE(second_range != std::string::npos);
  7077. }
  7078. TEST_F(ServerTest, GetStreamedWithRangesMoreThanTwoOverwrapping) {
  7079. auto res =
  7080. cli_.Get("/streamed-with-range?error",
  7081. Headers{{make_range_header({{0, 1}, {1, 2}, {2, 3}, {3, 4}})}});
  7082. ASSERT_TRUE(res) << "Error: " << to_string(res.error());
  7083. EXPECT_EQ(StatusCode::RangeNotSatisfiable_416, res->status);
  7084. EXPECT_EQ("0", res->get_header_value("Content-Length"));
  7085. EXPECT_EQ(false, res->has_header("Content-Range"));
  7086. EXPECT_EQ(0U, res->body.size());
  7087. }
  7088. TEST_F(ServerTest, GetStreamedEndless) {
  7089. uint64_t offset = 0;
  7090. auto res = cli_.Get("/streamed-cancel",
  7091. [&](const char * /*data*/, uint64_t data_length) {
  7092. if (offset < 100) {
  7093. offset += data_length;
  7094. return true;
  7095. }
  7096. return false;
  7097. });
  7098. ASSERT_TRUE(!res);
  7099. EXPECT_EQ(Error::Canceled, res.error());
  7100. }
  7101. TEST_F(ServerTest, ClientStop) {
  7102. std::atomic_size_t count{4};
  7103. std::vector<std::thread> threads;
  7104. for (auto i = count.load(); i != 0; --i) {
  7105. threads.emplace_back([&]() {
  7106. auto res = cli_.Get("/streamed-cancel",
  7107. [&](const char *, uint64_t) { return true; });
  7108. --count;
  7109. ASSERT_TRUE(!res);
  7110. EXPECT_TRUE(res.error() == Error::Canceled ||
  7111. res.error() == Error::Read || res.error() == Error::Write);
  7112. });
  7113. }
  7114. std::this_thread::sleep_for(std::chrono::seconds(2));
  7115. while (count != 0) {
  7116. cli_.stop();
  7117. std::this_thread::sleep_for(std::chrono::milliseconds(10));
  7118. }
  7119. for (auto &t : threads) {
  7120. t.join();
  7121. }
  7122. }
  7123. TEST_F(ServerTest, GetWithRange1) {
  7124. auto res = cli_.Get("/with-range", Headers{
  7125. make_range_header({{3, 5}}),
  7126. {"Accept-Encoding", ""},
  7127. });
  7128. ASSERT_TRUE(res) << "Error: " << to_string(res.error());
  7129. EXPECT_EQ(StatusCode::PartialContent_206, res->status);
  7130. EXPECT_EQ("3", res->get_header_value("Content-Length"));
  7131. EXPECT_EQ(true, res->has_header("Content-Range"));
  7132. EXPECT_EQ("bytes 3-5/7", res->get_header_value("Content-Range"));
  7133. EXPECT_EQ(std::string("def"), res->body);
  7134. }
  7135. TEST_F(ServerTest, GetWithRange2) {
  7136. auto res = cli_.Get("/with-range", Headers{
  7137. make_range_header({{1, -1}}),
  7138. {"Accept-Encoding", ""},
  7139. });
  7140. ASSERT_TRUE(res) << "Error: " << to_string(res.error());
  7141. EXPECT_EQ(StatusCode::PartialContent_206, res->status);
  7142. EXPECT_EQ("6", res->get_header_value("Content-Length"));
  7143. EXPECT_EQ(true, res->has_header("Content-Range"));
  7144. EXPECT_EQ("bytes 1-6/7", res->get_header_value("Content-Range"));
  7145. EXPECT_EQ(std::string("bcdefg"), res->body);
  7146. }
  7147. TEST_F(ServerTest, GetWithRange3) {
  7148. auto res = cli_.Get("/with-range", Headers{
  7149. make_range_header({{0, 0}}),
  7150. {"Accept-Encoding", ""},
  7151. });
  7152. ASSERT_TRUE(res) << "Error: " << to_string(res.error());
  7153. EXPECT_EQ(StatusCode::PartialContent_206, res->status);
  7154. EXPECT_EQ("1", res->get_header_value("Content-Length"));
  7155. EXPECT_EQ(true, res->has_header("Content-Range"));
  7156. EXPECT_EQ("bytes 0-0/7", res->get_header_value("Content-Range"));
  7157. EXPECT_EQ(std::string("a"), res->body);
  7158. }
  7159. TEST_F(ServerTest, GetWithRange4) {
  7160. auto res = cli_.Get("/with-range", Headers{
  7161. make_range_header({{-1, 2}}),
  7162. {"Accept-Encoding", ""},
  7163. });
  7164. ASSERT_TRUE(res) << "Error: " << to_string(res.error());
  7165. EXPECT_EQ(StatusCode::PartialContent_206, res->status);
  7166. EXPECT_EQ("2", res->get_header_value("Content-Length"));
  7167. EXPECT_EQ(true, res->has_header("Content-Range"));
  7168. EXPECT_EQ("bytes 5-6/7", res->get_header_value("Content-Range"));
  7169. EXPECT_EQ(std::string("fg"), res->body);
  7170. }
  7171. TEST_F(ServerTest, GetWithRange5) {
  7172. auto res = cli_.Get("/with-range", Headers{
  7173. make_range_header({{0, 5}}),
  7174. {"Accept-Encoding", ""},
  7175. });
  7176. ASSERT_TRUE(res) << "Error: " << to_string(res.error());
  7177. EXPECT_EQ(StatusCode::PartialContent_206, res->status);
  7178. EXPECT_EQ("6", res->get_header_value("Content-Length"));
  7179. EXPECT_EQ(true, res->has_header("Content-Range"));
  7180. EXPECT_EQ("bytes 0-5/7", res->get_header_value("Content-Range"));
  7181. EXPECT_EQ(std::string("abcdef"), res->body);
  7182. }
  7183. TEST_F(ServerTest, GetWithRangeOffsetGreaterThanContent) {
  7184. auto res =
  7185. cli_.Get("/with-range", Headers{{make_range_header({{10000, 20000}})}});
  7186. ASSERT_TRUE(res) << "Error: " << to_string(res.error());
  7187. EXPECT_EQ(StatusCode::RangeNotSatisfiable_416, res->status);
  7188. }
  7189. TEST_F(ServerTest, GetWithRangeMultipart) {
  7190. auto res =
  7191. cli_.Get("/with-range", Headers{{make_range_header({{1, 2}, {4, 5}})}});
  7192. ASSERT_TRUE(res) << "Error: " << to_string(res.error());
  7193. EXPECT_EQ(StatusCode::PartialContent_206, res->status);
  7194. EXPECT_EQ("267", res->get_header_value("Content-Length"));
  7195. EXPECT_EQ(false, res->has_header("Content-Range"));
  7196. EXPECT_EQ(267U, res->body.size());
  7197. }
  7198. TEST_F(ServerTest, GetWithRangeMultipartOffsetGreaterThanContent) {
  7199. auto res = cli_.Get("/with-range",
  7200. Headers{{make_range_header({{-1, 2}, {10000, 30000}})}});
  7201. ASSERT_TRUE(res) << "Error: " << to_string(res.error());
  7202. EXPECT_EQ(StatusCode::RangeNotSatisfiable_416, res->status);
  7203. }
  7204. TEST_F(ServerTest, GetWithRangeCustomizedResponse) {
  7205. auto res = cli_.Get("/with-range-customized-response",
  7206. Headers{{make_range_header({{1, 2}})}});
  7207. ASSERT_TRUE(res) << "Error: " << to_string(res.error());
  7208. EXPECT_EQ(StatusCode::BadRequest_400, res->status);
  7209. EXPECT_EQ(true, res->has_header("Content-Length"));
  7210. EXPECT_EQ(false, res->has_header("Content-Range"));
  7211. EXPECT_EQ(JSON_DATA, res->body);
  7212. }
  7213. TEST_F(ServerTest, GetWithRangeMultipartCustomizedResponseMultipleRange) {
  7214. auto res = cli_.Get("/with-range-customized-response",
  7215. Headers{{make_range_header({{1, 2}, {4, 5}})}});
  7216. ASSERT_TRUE(res) << "Error: " << to_string(res.error());
  7217. EXPECT_EQ(StatusCode::BadRequest_400, res->status);
  7218. EXPECT_EQ(true, res->has_header("Content-Length"));
  7219. EXPECT_EQ(false, res->has_header("Content-Range"));
  7220. EXPECT_EQ(JSON_DATA, res->body);
  7221. }
  7222. TEST_F(ServerTest, Issue1772) {
  7223. auto res = cli_.Get("/issue1772", Headers{{make_range_header({{1000, -1}})}});
  7224. ASSERT_TRUE(res) << "Error: " << to_string(res.error());
  7225. EXPECT_EQ(StatusCode::Unauthorized_401, res->status);
  7226. }
  7227. TEST_F(ServerTest, Issue609) {
  7228. auto res = cli_.Delete("/issue609");
  7229. ASSERT_TRUE(res) << "Error: " << to_string(res.error());
  7230. EXPECT_EQ(StatusCode::OK_200, res->status);
  7231. EXPECT_EQ(std::string("ok"), res->body);
  7232. }
  7233. TEST_F(ServerTest, GetStreamedChunked) {
  7234. auto res = cli_.Get("/streamed-chunked");
  7235. ASSERT_TRUE(res) << "Error: " << to_string(res.error());
  7236. EXPECT_EQ(StatusCode::OK_200, res->status);
  7237. EXPECT_EQ(std::string("123456789"), res->body);
  7238. }
  7239. TEST_F(ServerTest, GetStreamedChunked2) {
  7240. auto res = cli_.Get("/streamed-chunked2");
  7241. ASSERT_TRUE(res) << "Error: " << to_string(res.error());
  7242. EXPECT_EQ(StatusCode::OK_200, res->status);
  7243. EXPECT_EQ(std::string("123456789"), res->body);
  7244. }
  7245. TEST_F(ServerTest, GetStreamedChunkedWithTrailer) {
  7246. auto res = cli_.Get("/streamed-chunked-with-trailer");
  7247. ASSERT_TRUE(res) << "Error: " << to_string(res.error());
  7248. EXPECT_EQ(StatusCode::OK_200, res->status);
  7249. EXPECT_EQ(std::string("123456789"), res->body);
  7250. EXPECT_TRUE(res->has_header("Trailer"));
  7251. EXPECT_EQ(1U, res->get_header_value_count("Trailer"));
  7252. EXPECT_EQ(std::string("Dummy1, Dummy2"), res->get_header_value("Trailer"));
  7253. // Trailers are now stored separately from headers (security fix)
  7254. EXPECT_EQ(2U, res->trailers.size());
  7255. EXPECT_TRUE(res->has_trailer("Dummy1"));
  7256. EXPECT_TRUE(res->has_trailer("Dummy2"));
  7257. EXPECT_FALSE(res->has_trailer("Dummy3"));
  7258. EXPECT_EQ(std::string("DummyVal1"), res->get_trailer_value("Dummy1"));
  7259. EXPECT_EQ(std::string("DummyVal2"), res->get_trailer_value("Dummy2"));
  7260. // Verify trailers are NOT in headers (security verification)
  7261. EXPECT_EQ(std::string(""), res->get_header_value("Dummy1"));
  7262. EXPECT_EQ(std::string(""), res->get_header_value("Dummy2"));
  7263. }
  7264. TEST_F(ServerTest, LargeChunkedPost) {
  7265. Request req;
  7266. req.method = "POST";
  7267. req.path = "/large-chunked";
  7268. std::string host_and_port;
  7269. host_and_port += HOST;
  7270. host_and_port += ":";
  7271. host_and_port += std::to_string(PORT);
  7272. req.headers.emplace("Host", host_and_port.c_str());
  7273. req.headers.emplace("Accept", "*/*");
  7274. req.headers.emplace("User-Agent", "cpp-httplib/0.1");
  7275. req.headers.emplace("Content-Type", "text/plain");
  7276. req.headers.emplace("Content-Length", "0");
  7277. req.headers.emplace("Transfer-Encoding", "chunked");
  7278. std::string long_string(30 * 1024u, 'a');
  7279. std::string chunk = "7800\r\n" + long_string + "\r\n";
  7280. // Attempt to make a large enough post to exceed OS buffers, to test that
  7281. // the server handles short reads if the full chunk data isn't available.
  7282. req.body = chunk + chunk + chunk + chunk + chunk + chunk + "0\r\n\r\n";
  7283. auto res = std::make_shared<Response>();
  7284. auto error = Error::Success;
  7285. auto ret = cli_.send(req, *res, error);
  7286. ASSERT_TRUE(ret);
  7287. EXPECT_EQ(StatusCode::OK_200, res->status);
  7288. }
  7289. TEST_F(ServerTest, GetMethodRemoteAddr) {
  7290. auto res = cli_.Get("/remote_addr");
  7291. ASSERT_TRUE(res) << "Error: " << to_string(res.error());
  7292. EXPECT_EQ(StatusCode::OK_200, res->status);
  7293. EXPECT_EQ("text/plain", res->get_header_value("Content-Type"));
  7294. EXPECT_TRUE(res->body == "::1" || res->body == "127.0.0.1");
  7295. }
  7296. TEST_F(ServerTest, GetMethodLocalAddr) {
  7297. auto res = cli_.Get("/local_addr");
  7298. ASSERT_TRUE(res) << "Error: " << to_string(res.error());
  7299. EXPECT_EQ(StatusCode::OK_200, res->status);
  7300. EXPECT_EQ("text/plain", res->get_header_value("Content-Type"));
  7301. EXPECT_TRUE(res->body == std::string("::1:").append(to_string(PORT)) ||
  7302. res->body == std::string("127.0.0.1:").append(to_string(PORT)));
  7303. }
  7304. TEST_F(ServerTest, HTTPResponseSplitting) {
  7305. auto res = cli_.Get("/http_response_splitting");
  7306. ASSERT_TRUE(res) << "Error: " << to_string(res.error());
  7307. EXPECT_EQ(StatusCode::OK_200, res->status);
  7308. }
  7309. TEST_F(ServerTest, SlowRequest) {
  7310. request_threads_.emplace_back([this]() { auto res = cli_.Get("/slow"); });
  7311. request_threads_.emplace_back([this]() { auto res = cli_.Get("/slow"); });
  7312. request_threads_.emplace_back([this]() { auto res = cli_.Get("/slow"); });
  7313. }
  7314. #if 0
  7315. TEST_F(ServerTest, SlowPost) {
  7316. char buffer[64 * 1024];
  7317. memset(buffer, 0x42, sizeof(buffer));
  7318. auto res = cli_.Post(
  7319. "/slowpost", 64 * 1024 * 1024,
  7320. [&](size_t /*offset*/, size_t /*length*/, DataSink &sink) {
  7321. auto ret = sink.write(buffer, sizeof(buffer));
  7322. EXPECT_TRUE(ret);
  7323. return true;
  7324. },
  7325. "text/plain");
  7326. ASSERT_TRUE(res) << "Error: " << to_string(res.error());
  7327. EXPECT_EQ(StatusCode::OK_200, res->status);
  7328. }
  7329. TEST_F(ServerTest, SlowPostFail) {
  7330. char buffer[64 * 1024];
  7331. memset(buffer, 0x42, sizeof(buffer));
  7332. cli_.set_write_timeout(std::chrono::seconds(0));
  7333. auto res = cli_.Post(
  7334. "/slowpost", 64 * 1024 * 1024,
  7335. [&](size_t /*offset*/, size_t /*length*/, DataSink &sink) {
  7336. sink.write(buffer, sizeof(buffer));
  7337. return true;
  7338. },
  7339. "text/plain");
  7340. ASSERT_TRUE(!res);
  7341. EXPECT_EQ(Error::Write, res.error());
  7342. }
  7343. #endif
  7344. TEST_F(ServerTest, Put) {
  7345. auto res = cli_.Put("/put", "PUT", "text/plain");
  7346. ASSERT_TRUE(res) << "Error: " << to_string(res.error());
  7347. EXPECT_EQ(StatusCode::OK_200, res->status);
  7348. EXPECT_EQ("PUT", res->body);
  7349. }
  7350. TEST_F(ServerTest, PutWithContentProvider) {
  7351. auto res = cli_.Put(
  7352. "/put", 3,
  7353. [](size_t /*offset*/, size_t /*length*/, DataSink &sink) {
  7354. sink.os << "PUT";
  7355. return true;
  7356. },
  7357. "text/plain");
  7358. ASSERT_TRUE(res) << "Error: " << to_string(res.error());
  7359. EXPECT_EQ(StatusCode::OK_200, res->status);
  7360. EXPECT_EQ("PUT", res->body);
  7361. }
  7362. TEST_F(ServerTest, PostWithContentProviderAbort) {
  7363. auto res = cli_.Post(
  7364. "/post", 42,
  7365. [](size_t /*offset*/, size_t /*length*/, DataSink & /*sink*/) {
  7366. return false;
  7367. },
  7368. "text/plain");
  7369. ASSERT_TRUE(!res);
  7370. EXPECT_EQ(Error::Canceled, res.error());
  7371. }
  7372. TEST_F(ServerTest, PutWithContentProviderWithoutLength) {
  7373. auto res = cli_.Put(
  7374. "/put",
  7375. [](size_t /*offset*/, DataSink &sink) {
  7376. sink.os << "PUT";
  7377. sink.done();
  7378. return true;
  7379. },
  7380. "text/plain");
  7381. ASSERT_TRUE(res) << "Error: " << to_string(res.error());
  7382. EXPECT_EQ(StatusCode::OK_200, res->status);
  7383. EXPECT_EQ("PUT", res->body);
  7384. }
  7385. TEST_F(ServerTest, PostWithContentProviderWithoutLengthAbort) {
  7386. auto res = cli_.Post(
  7387. "/post", [](size_t /*offset*/, DataSink & /*sink*/) { return false; },
  7388. "text/plain");
  7389. ASSERT_TRUE(!res);
  7390. EXPECT_EQ(Error::Canceled, res.error());
  7391. }
  7392. TEST_F(ServerTest, PostLoopBack) {
  7393. std::string body;
  7394. auto res = cli_.Post(
  7395. "/post-loopback", 9,
  7396. [](size_t /*offset*/, size_t length, DataSink &sink) {
  7397. EXPECT_EQ(9u, length);
  7398. sink.write("123", 3);
  7399. sink.write("456", 3);
  7400. sink.write("789", 3);
  7401. return true;
  7402. },
  7403. "text/plain",
  7404. [&body](const char *data, size_t data_length) {
  7405. body.append(data, data_length);
  7406. return true;
  7407. });
  7408. ASSERT_TRUE(res) << "Error: " << to_string(res.error());
  7409. EXPECT_EQ(StatusCode::OK_200, res->status);
  7410. EXPECT_EQ("123456789", body);
  7411. }
  7412. TEST_F(ServerTest, PutLoopBack) {
  7413. std::string body;
  7414. auto res = cli_.Put(
  7415. "/put-loopback", 9,
  7416. [](size_t /*offset*/, size_t length, DataSink &sink) {
  7417. EXPECT_EQ(9u, length);
  7418. sink.write("123", 3);
  7419. sink.write("456", 3);
  7420. sink.write("789", 3);
  7421. return true;
  7422. },
  7423. "text/plain",
  7424. [&body](const char *data, size_t data_length) {
  7425. body.append(data, data_length);
  7426. return true;
  7427. });
  7428. ASSERT_TRUE(res) << "Error: " << to_string(res.error());
  7429. EXPECT_EQ(StatusCode::OK_200, res->status);
  7430. EXPECT_EQ("123456789", body);
  7431. }
  7432. TEST_F(ServerTest, PatchLoopBack) {
  7433. std::string body;
  7434. auto res = cli_.Patch(
  7435. "/patch-loopback", 9,
  7436. [](size_t /*offset*/, size_t length, DataSink &sink) {
  7437. EXPECT_EQ(9u, length);
  7438. sink.write("123", 3);
  7439. sink.write("456", 3);
  7440. sink.write("789", 3);
  7441. return true;
  7442. },
  7443. "text/plain",
  7444. [&body](const char *data, size_t data_length) {
  7445. body.append(data, data_length);
  7446. return true;
  7447. });
  7448. ASSERT_TRUE(res) << "Error: " << to_string(res.error());
  7449. EXPECT_EQ(StatusCode::OK_200, res->status);
  7450. EXPECT_EQ("123456789", body);
  7451. }
  7452. TEST_F(ServerTest, PostLoopBackWithoutRequestContentLength) {
  7453. std::string body;
  7454. auto res = cli_.Post(
  7455. "/post-loopback",
  7456. [](size_t /*offset*/, DataSink &sink) {
  7457. sink.write("123", 3);
  7458. sink.write("456", 3);
  7459. sink.write("789", 3);
  7460. sink.done();
  7461. return true;
  7462. },
  7463. "text/plain",
  7464. [&body](const char *data, size_t data_length) {
  7465. body.append(data, data_length);
  7466. return true;
  7467. });
  7468. ASSERT_TRUE(res) << "Error: " << to_string(res.error());
  7469. EXPECT_EQ(StatusCode::OK_200, res->status);
  7470. EXPECT_EQ("123456789", body);
  7471. }
  7472. #ifdef CPPHTTPLIB_ZLIB_SUPPORT
  7473. TEST_F(ServerTest, PutWithContentProviderWithGzip) {
  7474. cli_.set_compress(true);
  7475. auto res = cli_.Put(
  7476. "/put", 3,
  7477. [](size_t /*offset*/, size_t /*length*/, DataSink &sink) {
  7478. sink.os << "PUT";
  7479. return true;
  7480. },
  7481. "text/plain");
  7482. ASSERT_TRUE(res) << "Error: " << to_string(res.error());
  7483. EXPECT_EQ(StatusCode::OK_200, res->status);
  7484. EXPECT_EQ("PUT", res->body);
  7485. }
  7486. TEST_F(ServerTest, PostWithContentProviderWithGzipAbort) {
  7487. cli_.set_compress(true);
  7488. auto res = cli_.Post(
  7489. "/post", 42,
  7490. [](size_t /*offset*/, size_t /*length*/, DataSink & /*sink*/) {
  7491. return false;
  7492. },
  7493. "text/plain");
  7494. ASSERT_TRUE(!res);
  7495. EXPECT_EQ(Error::Canceled, res.error());
  7496. }
  7497. TEST_F(ServerTest, PutWithContentProviderWithoutLengthWithGzip) {
  7498. cli_.set_compress(true);
  7499. auto res = cli_.Put(
  7500. "/put",
  7501. [](size_t /*offset*/, DataSink &sink) {
  7502. sink.os << "PUT";
  7503. sink.done();
  7504. return true;
  7505. },
  7506. "text/plain");
  7507. ASSERT_TRUE(res) << "Error: " << to_string(res.error());
  7508. EXPECT_EQ(StatusCode::OK_200, res->status);
  7509. EXPECT_EQ("PUT", res->body);
  7510. }
  7511. TEST_F(ServerTest, PostWithContentProviderWithoutLengthWithGzipAbort) {
  7512. cli_.set_compress(true);
  7513. auto res = cli_.Post(
  7514. "/post", [](size_t /*offset*/, DataSink & /*sink*/) { return false; },
  7515. "text/plain");
  7516. ASSERT_TRUE(!res);
  7517. EXPECT_EQ(Error::Canceled, res.error());
  7518. }
  7519. TEST_F(ServerTest, PutLargeFileWithGzip) {
  7520. cli_.set_compress(true);
  7521. auto res = cli_.Put("/put-large", LARGE_DATA, "text/plain");
  7522. ASSERT_TRUE(res) << "Error: " << to_string(res.error());
  7523. EXPECT_EQ(StatusCode::OK_200, res->status);
  7524. EXPECT_EQ(LARGE_DATA, res->body);
  7525. }
  7526. TEST_F(ServerTest, PutLargeFileWithGzip2) {
  7527. #ifdef CPPHTTPLIB_SSL_ENABLED
  7528. std::string s = std::string("https://") + HOST + ":" + std::to_string(PORT);
  7529. Client cli(s.c_str());
  7530. cli.enable_server_certificate_verification(false);
  7531. #else
  7532. std::string s = std::string("http://") + HOST + ":" + std::to_string(PORT);
  7533. Client cli(s.c_str());
  7534. #endif
  7535. cli.set_compress(true);
  7536. auto res = cli.Put("/put-large", LARGE_DATA, "text/plain");
  7537. ASSERT_TRUE(res) << "Error: " << to_string(res.error());
  7538. EXPECT_EQ(StatusCode::OK_200, res->status);
  7539. EXPECT_EQ(LARGE_DATA, res->body);
  7540. // The compressed size should be less than a 10th of the original. May vary
  7541. // depending on the zlib library.
  7542. EXPECT_LT(res.get_request_header_value_u64("Content-Length"),
  7543. static_cast<uint64_t>(10 * 1024 * 1024));
  7544. #ifdef CPPHTTPLIB_BROTLI_SUPPORT
  7545. EXPECT_EQ("br", res.get_request_header_value("Content-Encoding"));
  7546. #elif defined(CPPHTTPLIB_ZLIB_SUPPORT)
  7547. EXPECT_EQ("gzip", res.get_request_header_value("Content-Encoding"));
  7548. #elif defined(CPPHTTPLIB_ZSTD_SUPPORT)
  7549. EXPECT_EQ("zstd", res.get_request_header_value("Content-Encoding"));
  7550. #endif
  7551. }
  7552. TEST_F(ServerTest, PutContentWithDeflate) {
  7553. cli_.set_compress(false);
  7554. Headers headers;
  7555. headers.emplace("Content-Encoding", "deflate");
  7556. // PUT in deflate format:
  7557. auto res = cli_.Put("/put", headers,
  7558. "\170\234\013\010\015\001\0\001\361\0\372", "text/plain");
  7559. ASSERT_TRUE(res) << "Error: " << to_string(res.error());
  7560. EXPECT_EQ(StatusCode::OK_200, res->status);
  7561. EXPECT_EQ("PUT", res->body);
  7562. }
  7563. TEST_F(ServerTest, GetStreamedChunkedWithGzip) {
  7564. Headers headers;
  7565. headers.emplace("Accept-Encoding", "gzip, deflate");
  7566. auto res = cli_.Get("/streamed-chunked", headers);
  7567. ASSERT_TRUE(res) << "Error: " << to_string(res.error());
  7568. EXPECT_EQ(StatusCode::OK_200, res->status);
  7569. EXPECT_EQ(std::string("123456789"), res->body);
  7570. }
  7571. TEST_F(ServerTest, GetStreamedChunkedWithGzip2) {
  7572. Headers headers;
  7573. headers.emplace("Accept-Encoding", "gzip, deflate");
  7574. auto res = cli_.Get("/streamed-chunked2", headers);
  7575. ASSERT_TRUE(res) << "Error: " << to_string(res.error());
  7576. EXPECT_EQ(StatusCode::OK_200, res->status);
  7577. EXPECT_EQ(std::string("123456789"), res->body);
  7578. }
  7579. TEST_F(ServerTest, SplitDelimiterInPathRegex) {
  7580. auto res = cli_.Get("/regex-with-delimiter?key=^(?.*(value))");
  7581. ASSERT_TRUE(res) << "Error: " << to_string(res.error());
  7582. EXPECT_EQ(StatusCode::OK_200, res->status);
  7583. }
  7584. TEST(GzipDecompressor, ChunkedDecompression) {
  7585. std::string data;
  7586. for (size_t i = 0; i < 32 * 1024; ++i) {
  7587. data.push_back(static_cast<char>('a' + i % 26));
  7588. }
  7589. std::string compressed_data;
  7590. {
  7591. httplib::detail::gzip_compressor compressor;
  7592. bool result = compressor.compress(
  7593. data.data(), data.size(),
  7594. /*last=*/true,
  7595. [&](const char *compressed_data_chunk, size_t compressed_data_size) {
  7596. compressed_data.insert(compressed_data.size(), compressed_data_chunk,
  7597. compressed_data_size);
  7598. return true;
  7599. });
  7600. ASSERT_TRUE(result);
  7601. }
  7602. std::string decompressed_data;
  7603. {
  7604. httplib::detail::gzip_decompressor decompressor;
  7605. // Chunk size is chosen specifically to have a decompressed chunk size equal
  7606. // to 16384 bytes 16384 bytes is the size of decompressor output buffer
  7607. size_t chunk_size = 130;
  7608. for (size_t chunk_begin = 0; chunk_begin < compressed_data.size();
  7609. chunk_begin += chunk_size) {
  7610. size_t current_chunk_size =
  7611. std::min(compressed_data.size() - chunk_begin, chunk_size);
  7612. bool result = decompressor.decompress(
  7613. compressed_data.data() + chunk_begin, current_chunk_size,
  7614. [&](const char *decompressed_data_chunk,
  7615. size_t decompressed_data_chunk_size) {
  7616. decompressed_data.insert(decompressed_data.size(),
  7617. decompressed_data_chunk,
  7618. decompressed_data_chunk_size);
  7619. return true;
  7620. });
  7621. ASSERT_TRUE(result);
  7622. }
  7623. }
  7624. ASSERT_EQ(data, decompressed_data);
  7625. }
  7626. TEST(GzipDecompressor, DeflateDecompression) {
  7627. std::string original_text = "Raw deflate without gzip";
  7628. unsigned char data[32] = {0x78, 0x9C, 0x0B, 0x4A, 0x2C, 0x57, 0x48, 0x49,
  7629. 0x4D, 0xCB, 0x49, 0x2C, 0x49, 0x55, 0x28, 0xCF,
  7630. 0x2C, 0xC9, 0xC8, 0x2F, 0x2D, 0x51, 0x48, 0xAF,
  7631. 0xCA, 0x2C, 0x00, 0x00, 0x6F, 0x98, 0x09, 0x2E};
  7632. std::string compressed_data(data, data + sizeof(data) / sizeof(data[0]));
  7633. std::string decompressed_data;
  7634. {
  7635. httplib::detail::gzip_decompressor decompressor;
  7636. bool result = decompressor.decompress(
  7637. compressed_data.data(), compressed_data.size(),
  7638. [&](const char *decompressed_data_chunk,
  7639. size_t decompressed_data_chunk_size) {
  7640. decompressed_data.insert(decompressed_data.size(),
  7641. decompressed_data_chunk,
  7642. decompressed_data_chunk_size);
  7643. return true;
  7644. });
  7645. ASSERT_TRUE(result);
  7646. }
  7647. ASSERT_EQ(original_text, decompressed_data);
  7648. }
  7649. TEST(GzipDecompressor, DeflateDecompressionTrailingBytes) {
  7650. std::string original_text = "Raw deflate without gzip";
  7651. unsigned char data[40] = {0x78, 0x9C, 0x0B, 0x4A, 0x2C, 0x57, 0x48, 0x49,
  7652. 0x4D, 0xCB, 0x49, 0x2C, 0x49, 0x55, 0x28, 0xCF,
  7653. 0x2C, 0xC9, 0xC8, 0x2F, 0x2D, 0x51, 0x48, 0xAF,
  7654. 0xCA, 0x2C, 0x00, 0x00, 0x6F, 0x98, 0x09, 0x2E,
  7655. 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00};
  7656. std::string compressed_data(data, data + sizeof(data) / sizeof(data[0]));
  7657. std::string decompressed_data;
  7658. {
  7659. httplib::detail::gzip_decompressor decompressor;
  7660. bool result = decompressor.decompress(
  7661. compressed_data.data(), compressed_data.size(),
  7662. [&](const char *decompressed_data_chunk,
  7663. size_t decompressed_data_chunk_size) {
  7664. decompressed_data.insert(decompressed_data.size(),
  7665. decompressed_data_chunk,
  7666. decompressed_data_chunk_size);
  7667. return true;
  7668. });
  7669. ASSERT_TRUE(result);
  7670. }
  7671. ASSERT_EQ(original_text, decompressed_data);
  7672. }
  7673. #endif
  7674. #ifdef CPPHTTPLIB_BROTLI_SUPPORT
  7675. TEST_F(ServerTest, GetStreamedChunkedWithBrotli) {
  7676. Headers headers;
  7677. headers.emplace("Accept-Encoding", "br");
  7678. auto res = cli_.Get("/streamed-chunked", headers);
  7679. ASSERT_TRUE(res) << "Error: " << to_string(res.error());
  7680. EXPECT_EQ(StatusCode::OK_200, res->status);
  7681. EXPECT_EQ(std::string("123456789"), res->body);
  7682. }
  7683. TEST_F(ServerTest, GetStreamedChunkedWithBrotli2) {
  7684. Headers headers;
  7685. headers.emplace("Accept-Encoding", "br");
  7686. auto res = cli_.Get("/streamed-chunked2", headers);
  7687. ASSERT_TRUE(res) << "Error: " << to_string(res.error());
  7688. EXPECT_EQ(StatusCode::OK_200, res->status);
  7689. EXPECT_EQ(std::string("123456789"), res->body);
  7690. }
  7691. TEST_F(ServerTest, PutWithContentProviderWithBrotli) {
  7692. cli_.set_compress(true);
  7693. auto res = cli_.Put(
  7694. "/put", 3,
  7695. [](size_t /*offset*/, size_t /*length*/, DataSink &sink) {
  7696. sink.os << "PUT";
  7697. return true;
  7698. },
  7699. "text/plain");
  7700. ASSERT_TRUE(res) << "Error: " << to_string(res.error());
  7701. EXPECT_EQ(StatusCode::OK_200, res->status);
  7702. EXPECT_EQ("PUT", res->body);
  7703. }
  7704. TEST_F(ServerTest, PutWithContentProviderWithoutLengthWithBrotli) {
  7705. cli_.set_compress(true);
  7706. auto res = cli_.Put(
  7707. "/put",
  7708. [](size_t /*offset*/, DataSink &sink) {
  7709. sink.os << "PUT";
  7710. sink.done();
  7711. return true;
  7712. },
  7713. "text/plain");
  7714. ASSERT_TRUE(res) << "Error: " << to_string(res.error());
  7715. EXPECT_EQ(StatusCode::OK_200, res->status);
  7716. EXPECT_EQ("PUT", res->body);
  7717. }
  7718. TEST_F(ServerTest, PutLargeFileWithBrotli) {
  7719. cli_.set_compress(true);
  7720. auto res = cli_.Put("/put-large", LARGE_DATA, "text/plain");
  7721. ASSERT_TRUE(res) << "Error: " << to_string(res.error());
  7722. EXPECT_EQ(StatusCode::OK_200, res->status);
  7723. EXPECT_EQ(LARGE_DATA, res->body);
  7724. EXPECT_EQ("br", res.get_request_header_value("Content-Encoding"));
  7725. }
  7726. #endif
  7727. TEST_F(ServerTest, Patch) {
  7728. auto res = cli_.Patch("/patch", "PATCH", "text/plain");
  7729. ASSERT_TRUE(res) << "Error: " << to_string(res.error());
  7730. EXPECT_EQ(StatusCode::OK_200, res->status);
  7731. EXPECT_EQ("PATCH", res->body);
  7732. }
  7733. TEST_F(ServerTest, Delete) {
  7734. auto res = cli_.Delete("/delete");
  7735. ASSERT_TRUE(res) << "Error: " << to_string(res.error());
  7736. EXPECT_EQ(StatusCode::OK_200, res->status);
  7737. EXPECT_EQ("DELETE", res->body);
  7738. }
  7739. TEST_F(ServerTest, DeleteContentReceiver) {
  7740. auto res = cli_.Delete("/delete-body", "content", "text/plain");
  7741. ASSERT_TRUE(res) << "Error: " << to_string(res.error());
  7742. EXPECT_EQ(StatusCode::OK_200, res->status);
  7743. EXPECT_EQ("content", res->body);
  7744. }
  7745. TEST_F(ServerTest, Options) {
  7746. auto res = cli_.Options("*");
  7747. ASSERT_TRUE(res) << "Error: " << to_string(res.error());
  7748. EXPECT_EQ(StatusCode::OK_200, res->status);
  7749. EXPECT_EQ("GET, POST, HEAD, OPTIONS", res->get_header_value("Allow"));
  7750. EXPECT_TRUE(res->body.empty());
  7751. }
  7752. TEST_F(ServerTest, URL) {
  7753. auto res = cli_.Get("/request-target?aaa=bbb&ccc=ddd");
  7754. ASSERT_TRUE(res) << "Error: " << to_string(res.error());
  7755. EXPECT_EQ(StatusCode::OK_200, res->status);
  7756. }
  7757. TEST_F(ServerTest, ArrayParam) {
  7758. auto res = cli_.Get("/array-param?array=value1&array=value2&array=value3");
  7759. ASSERT_TRUE(res) << "Error: " << to_string(res.error());
  7760. EXPECT_EQ(StatusCode::OK_200, res->status);
  7761. }
  7762. TEST_F(ServerTest, ArrayParamValues) {
  7763. auto res =
  7764. cli_.Get("/array-param-values?array=value1&array=value2&array=value3");
  7765. ASSERT_TRUE(res) << "Error: " << to_string(res.error());
  7766. EXPECT_EQ(StatusCode::OK_200, res->status);
  7767. }
  7768. TEST_F(ServerTest, NoMultipleHeaders) {
  7769. Headers headers = {{"Content-Length", "5"}};
  7770. auto res = cli_.Post("/validate-no-multiple-headers", headers, "hello",
  7771. "text/plain");
  7772. ASSERT_TRUE(res) << "Error: " << to_string(res.error());
  7773. EXPECT_EQ(StatusCode::OK_200, res->status);
  7774. }
  7775. TEST_F(ServerTest, PostContentReceiver) {
  7776. auto res = cli_.Post("/content_receiver", "content", "text/plain");
  7777. ASSERT_TRUE(res) << "Error: " << to_string(res.error());
  7778. ASSERT_EQ(StatusCode::OK_200, res->status);
  7779. ASSERT_EQ("content", res->body);
  7780. }
  7781. TEST_F(ServerTest, PostMultipartFileContentReceiver) {
  7782. UploadFormDataItems items = {
  7783. {"text1", "text default", "", ""},
  7784. {"text2", "aωb", "", ""},
  7785. {"file1", "h\ne\n\nl\nl\no\n", "hello.txt", "text/plain"},
  7786. {"file2", R"({\n "world": true\n}\n)", "world.json", "application/json"},
  7787. {"file3", "", "", "application/octet-stream"},
  7788. };
  7789. auto res = cli_.Post("/content_receiver", items);
  7790. ASSERT_TRUE(res) << "Error: " << to_string(res.error());
  7791. EXPECT_EQ(StatusCode::OK_200, res->status);
  7792. }
  7793. TEST_F(ServerTest, PostMultipartPlusBoundary) {
  7794. UploadFormDataItems items = {
  7795. {"text1", "text default", "", ""},
  7796. {"text2", "aωb", "", ""},
  7797. {"file1", "h\ne\n\nl\nl\no\n", "hello.txt", "text/plain"},
  7798. {"file2", R"({\n "world": true\n}\n)", "world.json", "application/json"},
  7799. {"file3", "", "", "application/octet-stream"},
  7800. };
  7801. auto boundary = std::string("+++++");
  7802. std::string body;
  7803. for (const auto &item : items) {
  7804. body += "--" + boundary + "\r\n";
  7805. body += "Content-Disposition: form-data; name=\"" + item.name + "\"";
  7806. if (!item.filename.empty()) {
  7807. body += "; filename=\"" + item.filename + "\"";
  7808. }
  7809. body += "\r\n";
  7810. if (!item.content_type.empty()) {
  7811. body += "Content-Type: " + item.content_type + "\r\n";
  7812. }
  7813. body += "\r\n";
  7814. body += item.content + "\r\n";
  7815. }
  7816. body += "--" + boundary + "--\r\n";
  7817. std::string content_type = "multipart/form-data; boundary=" + boundary;
  7818. auto res = cli_.Post("/content_receiver", body, content_type.c_str());
  7819. ASSERT_TRUE(res) << "Error: " << to_string(res.error());
  7820. EXPECT_EQ(StatusCode::OK_200, res->status);
  7821. }
  7822. TEST(MultipartFormDataTest, FieldEscaping) {
  7823. Server svr;
  7824. svr.Post("/post", [&](const Request &req, Response & /*res*/,
  7825. const ContentReader &content_reader) {
  7826. ASSERT_TRUE(req.is_multipart_form_data());
  7827. std::vector<FormData> received;
  7828. content_reader(
  7829. [&](const FormData &file) {
  7830. received.push_back(file);
  7831. return true;
  7832. },
  7833. [&](const char *data, size_t data_length) {
  7834. received.back().content.append(data, data_length);
  7835. return true;
  7836. });
  7837. // '"', CR and LF in names and filenames are escaped following the
  7838. // WHATWG HTML standard, so each part still parses as a single part
  7839. // with no injected headers. Content types get CR/LF escaped too,
  7840. // while '"' (legal there, e.g. quoted charset) is preserved.
  7841. ASSERT_EQ(4U, received.size());
  7842. EXPECT_EQ("na%22me", received[0].name);
  7843. EXPECT_EQ("quoted name", received[0].content);
  7844. EXPECT_EQ("file", received[1].name);
  7845. EXPECT_EQ("evil%0D%0AContent-Type: text/evil%0D%0A%0D%0A.pdf",
  7846. received[1].filename);
  7847. EXPECT_EQ("application/octet-stream", received[1].content_type);
  7848. EXPECT_EQ("injected", received[1].content);
  7849. EXPECT_EQ("my%0Dna%0Ame", received[2].name);
  7850. EXPECT_EQ("my%22file.txt", received[2].filename);
  7851. EXPECT_EQ("cr lf name", received[2].content);
  7852. EXPECT_EQ("typed", received[3].name);
  7853. EXPECT_EQ("text/plain; charset=\"utf-8\"%0D%0AX-Evil: 1",
  7854. received[3].content_type);
  7855. EXPECT_EQ("typed content", received[3].content);
  7856. });
  7857. auto port = svr.bind_to_any_port("localhost");
  7858. auto t = std::thread([&]() { svr.listen_after_bind(); });
  7859. auto se = detail::scope_exit([&] {
  7860. svr.stop();
  7861. t.join();
  7862. ASSERT_FALSE(svr.is_running());
  7863. });
  7864. svr.wait_until_ready();
  7865. Client cli("localhost", port);
  7866. UploadFormDataItems items = {
  7867. {"na\"me", "quoted name", "", ""},
  7868. {"file", "injected", "evil\r\nContent-Type: text/evil\r\n\r\n.pdf",
  7869. "application/octet-stream"},
  7870. {"my\rna\nme", "cr lf name", "my\"file.txt", "text/plain"},
  7871. {"typed", "typed content", "",
  7872. "text/plain; charset=\"utf-8\"\r\nX-Evil: 1"},
  7873. };
  7874. auto res = cli.Post("/post", items);
  7875. ASSERT_TRUE(res) << "Error: " << to_string(res.error());
  7876. EXPECT_EQ(StatusCode::OK_200, res->status);
  7877. }
  7878. TEST(MultipartFormDataTest, PublicWriterAPI) {
  7879. const UploadFormDataItems items = {
  7880. {"name1", "Content 1", "", ""},
  7881. {"name2", "Content 2", "file2.txt", "text/plain"},
  7882. };
  7883. Server svr;
  7884. svr.Post("/post", [&](const Request &req, Response & /*res*/,
  7885. const ContentReader &content_reader) {
  7886. ASSERT_TRUE(req.is_multipart_form_data());
  7887. std::vector<FormData> received;
  7888. content_reader(
  7889. [&](const FormData &file) {
  7890. received.push_back(file);
  7891. return true;
  7892. },
  7893. [&](const char *data, size_t data_length) {
  7894. received.back().content.append(data, data_length);
  7895. return true;
  7896. });
  7897. ASSERT_EQ(2U, received.size());
  7898. EXPECT_EQ("name1", received[0].name);
  7899. EXPECT_EQ("Content 1", received[0].content);
  7900. EXPECT_EQ("name2", received[1].name);
  7901. EXPECT_EQ("Content 2", received[1].content);
  7902. EXPECT_EQ("file2.txt", received[1].filename);
  7903. EXPECT_EQ("text/plain", received[1].content_type);
  7904. });
  7905. auto port = svr.bind_to_any_port("localhost");
  7906. auto t = std::thread([&]() { svr.listen_after_bind(); });
  7907. auto se = detail::scope_exit([&] {
  7908. svr.stop();
  7909. t.join();
  7910. ASSERT_FALSE(svr.is_running());
  7911. });
  7912. svr.wait_until_ready();
  7913. Client cli("localhost", port);
  7914. // Whole-body serialization with a generated boundary
  7915. {
  7916. MultipartFormDataWriter writer;
  7917. EXPECT_TRUE(is_valid_multipart_boundary(writer.boundary()));
  7918. EXPECT_EQ("multipart/form-data; boundary=" + writer.boundary(),
  7919. writer.content_type());
  7920. auto body = writer.serialize(items);
  7921. EXPECT_EQ(body.size(), writer.content_length(items));
  7922. auto res = cli.Post("/post", body, writer.content_type());
  7923. ASSERT_TRUE(res) << "Error: " << to_string(res.error());
  7924. EXPECT_EQ(StatusCode::OK_200, res->status);
  7925. }
  7926. // Per-part framing with a custom boundary via a content provider
  7927. {
  7928. EXPECT_FALSE(is_valid_multipart_boundary("bad boundary"));
  7929. ASSERT_TRUE(is_valid_multipart_boundary("custom-boundary_123"));
  7930. MultipartFormDataWriter writer("custom-boundary_123");
  7931. EXPECT_EQ("custom-boundary_123", writer.boundary());
  7932. std::string body;
  7933. for (const auto &item : items) {
  7934. body += writer.item_begin(item);
  7935. body += item.content;
  7936. body += MultipartFormDataWriter::item_end();
  7937. }
  7938. body += writer.finish();
  7939. EXPECT_EQ(body.size(), writer.content_length(items));
  7940. auto res = cli.Post(
  7941. "/post", body.size(),
  7942. [&](size_t offset, size_t length, DataSink &sink) {
  7943. sink.write(body.data() + offset, length);
  7944. return true;
  7945. },
  7946. writer.content_type());
  7947. ASSERT_TRUE(res) << "Error: " << to_string(res.error());
  7948. EXPECT_EQ(StatusCode::OK_200, res->status);
  7949. }
  7950. }
  7951. TEST_F(ServerTest, PostContentReceiverGzip) {
  7952. cli_.set_compress(true);
  7953. auto res = cli_.Post("/content_receiver", "content", "text/plain");
  7954. ASSERT_TRUE(res) << "Error: " << to_string(res.error());
  7955. ASSERT_EQ(StatusCode::OK_200, res->status);
  7956. ASSERT_EQ("content", res->body);
  7957. }
  7958. TEST_F(ServerTest, PutContentReceiver) {
  7959. auto res = cli_.Put("/content_receiver", "content", "text/plain");
  7960. ASSERT_TRUE(res) << "Error: " << to_string(res.error());
  7961. ASSERT_EQ(StatusCode::OK_200, res->status);
  7962. ASSERT_EQ("content", res->body);
  7963. }
  7964. TEST_F(ServerTest, PatchContentReceiver) {
  7965. auto res = cli_.Patch("/content_receiver", "content", "text/plain");
  7966. ASSERT_TRUE(res) << "Error: " << to_string(res.error());
  7967. ASSERT_EQ(StatusCode::OK_200, res->status);
  7968. ASSERT_EQ("content", res->body);
  7969. }
  7970. template <typename ClientType>
  7971. void TestWithHeadersAndContentReceiver(
  7972. ClientType &cli,
  7973. std::function<Result(ClientType &, const std::string &, const Headers &,
  7974. const std::string &, const std::string &,
  7975. ContentReceiver, DownloadProgress)>
  7976. request_func) {
  7977. Headers headers;
  7978. headers.emplace("X-Custom-Header", "test-value");
  7979. std::string received_body;
  7980. auto res = request_func(
  7981. cli, "/content_receiver", headers, "content", "application/json",
  7982. [&](const char *data, size_t data_length) {
  7983. received_body.append(data, data_length);
  7984. return true;
  7985. },
  7986. nullptr);
  7987. ASSERT_TRUE(res) << "Error: " << to_string(res.error());
  7988. EXPECT_EQ(StatusCode::OK_200, res->status);
  7989. EXPECT_EQ("content", received_body);
  7990. }
  7991. TEST_F(ServerTest, PostWithHeadersAndContentReceiver) {
  7992. #ifdef CPPHTTPLIB_SSL_ENABLED
  7993. using ClientT = SSLClient;
  7994. #else
  7995. using ClientT = Client;
  7996. #endif
  7997. TestWithHeadersAndContentReceiver<ClientT>(
  7998. cli_, [](ClientT &cli, const std::string &path, const Headers &headers,
  7999. const std::string &body, const std::string &content_type,
  8000. ContentReceiver receiver, DownloadProgress progress) {
  8001. return cli.Post(path, headers, body, content_type, receiver, progress);
  8002. });
  8003. }
  8004. TEST_F(ServerTest, PutWithHeadersAndContentReceiver) {
  8005. #ifdef CPPHTTPLIB_SSL_ENABLED
  8006. using ClientT = SSLClient;
  8007. #else
  8008. using ClientT = Client;
  8009. #endif
  8010. TestWithHeadersAndContentReceiver<ClientT>(
  8011. cli_, [](ClientT &cli, const std::string &path, const Headers &headers,
  8012. const std::string &body, const std::string &content_type,
  8013. ContentReceiver receiver, DownloadProgress progress) {
  8014. return cli.Put(path, headers, body, content_type, receiver, progress);
  8015. });
  8016. }
  8017. TEST_F(ServerTest, PatchWithHeadersAndContentReceiver) {
  8018. #ifdef CPPHTTPLIB_SSL_ENABLED
  8019. using ClientT = SSLClient;
  8020. #else
  8021. using ClientT = Client;
  8022. #endif
  8023. TestWithHeadersAndContentReceiver<ClientT>(
  8024. cli_, [](ClientT &cli, const std::string &path, const Headers &headers,
  8025. const std::string &body, const std::string &content_type,
  8026. ContentReceiver receiver, DownloadProgress progress) {
  8027. return cli.Patch(path, headers, body, content_type, receiver, progress);
  8028. });
  8029. }
  8030. template <typename ClientType>
  8031. void TestWithHeadersAndContentReceiverWithProgress(
  8032. ClientType &cli,
  8033. std::function<Result(ClientType &, const std::string &, const Headers &,
  8034. const std::string &, const std::string &,
  8035. ContentReceiver, DownloadProgress)>
  8036. request_func) {
  8037. Headers headers;
  8038. headers.emplace("X-Test-Header", "progress-test");
  8039. std::string received_body;
  8040. auto progress_called = false;
  8041. auto res = request_func(
  8042. cli, "/content_receiver", headers, "content", "text/plain",
  8043. [&](const char *data, size_t data_length) {
  8044. received_body.append(data, data_length);
  8045. return true;
  8046. },
  8047. [&](uint64_t /*current*/, uint64_t /*total*/) {
  8048. progress_called = true;
  8049. return true;
  8050. });
  8051. ASSERT_TRUE(res) << "Error: " << to_string(res.error());
  8052. EXPECT_EQ(StatusCode::OK_200, res->status);
  8053. EXPECT_EQ("content", received_body);
  8054. EXPECT_TRUE(progress_called);
  8055. }
  8056. TEST_F(ServerTest, PostWithHeadersAndContentReceiverWithProgress) {
  8057. #ifdef CPPHTTPLIB_SSL_ENABLED
  8058. using ClientT = SSLClient;
  8059. #else
  8060. using ClientT = Client;
  8061. #endif
  8062. TestWithHeadersAndContentReceiverWithProgress<ClientT>(
  8063. cli_, [](ClientT &cli, const std::string &path, const Headers &headers,
  8064. const std::string &body, const std::string &content_type,
  8065. ContentReceiver receiver, DownloadProgress progress) {
  8066. return cli.Post(path, headers, body, content_type, receiver, progress);
  8067. });
  8068. }
  8069. TEST_F(ServerTest, PutWithHeadersAndContentReceiverWithProgress) {
  8070. #ifdef CPPHTTPLIB_SSL_ENABLED
  8071. using ClientT = SSLClient;
  8072. #else
  8073. using ClientT = Client;
  8074. #endif
  8075. TestWithHeadersAndContentReceiverWithProgress<ClientT>(
  8076. cli_, [](ClientT &cli, const std::string &path, const Headers &headers,
  8077. const std::string &body, const std::string &content_type,
  8078. ContentReceiver receiver, DownloadProgress progress) {
  8079. return cli.Put(path, headers, body, content_type, receiver, progress);
  8080. });
  8081. }
  8082. TEST_F(ServerTest, PatchWithHeadersAndContentReceiverWithProgress) {
  8083. #ifdef CPPHTTPLIB_SSL_ENABLED
  8084. using ClientT = SSLClient;
  8085. #else
  8086. using ClientT = Client;
  8087. #endif
  8088. TestWithHeadersAndContentReceiverWithProgress<ClientT>(
  8089. cli_, [](ClientT &cli, const std::string &path, const Headers &headers,
  8090. const std::string &body, const std::string &content_type,
  8091. ContentReceiver receiver, DownloadProgress progress) {
  8092. return cli.Patch(path, headers, body, content_type, receiver, progress);
  8093. });
  8094. }
  8095. template <typename ClientType>
  8096. void TestWithHeadersAndContentReceiverError(
  8097. ClientType &cli, std::function<Result(ClientType &, const std::string &,
  8098. const Headers &, const std::string &,
  8099. const std::string &, ContentReceiver)>
  8100. request_func) {
  8101. Headers headers;
  8102. headers.emplace("X-Error-Test", "true");
  8103. std::string received_body;
  8104. auto receiver_failed = false;
  8105. auto res =
  8106. request_func(cli, "/content_receiver", headers, "content", "text/plain",
  8107. [&](const char *data, size_t data_length) {
  8108. received_body.append(data, data_length);
  8109. receiver_failed = true;
  8110. return false;
  8111. });
  8112. ASSERT_FALSE(res);
  8113. EXPECT_TRUE(receiver_failed);
  8114. }
  8115. TEST_F(ServerTest, PostWithHeadersAndContentReceiverError) {
  8116. #ifdef CPPHTTPLIB_SSL_ENABLED
  8117. using ClientT = SSLClient;
  8118. #else
  8119. using ClientT = Client;
  8120. #endif
  8121. TestWithHeadersAndContentReceiverError<ClientT>(
  8122. cli_, [](ClientT &cli, const std::string &path, const Headers &headers,
  8123. const std::string &body, const std::string &content_type,
  8124. ContentReceiver receiver) {
  8125. return cli.Post(path, headers, body, content_type, receiver);
  8126. });
  8127. }
  8128. TEST_F(ServerTest, PuttWithHeadersAndContentReceiverError) {
  8129. #ifdef CPPHTTPLIB_SSL_ENABLED
  8130. using ClientT = SSLClient;
  8131. #else
  8132. using ClientT = Client;
  8133. #endif
  8134. TestWithHeadersAndContentReceiverError<ClientT>(
  8135. cli_, [](ClientT &cli, const std::string &path, const Headers &headers,
  8136. const std::string &body, const std::string &content_type,
  8137. ContentReceiver receiver) {
  8138. return cli.Put(path, headers, body, content_type, receiver);
  8139. });
  8140. }
  8141. TEST_F(ServerTest, PatchWithHeadersAndContentReceiverError) {
  8142. #ifdef CPPHTTPLIB_SSL_ENABLED
  8143. using ClientT = SSLClient;
  8144. #else
  8145. using ClientT = Client;
  8146. #endif
  8147. TestWithHeadersAndContentReceiverError<ClientT>(
  8148. cli_, [](ClientT &cli, const std::string &path, const Headers &headers,
  8149. const std::string &body, const std::string &content_type,
  8150. ContentReceiver receiver) {
  8151. return cli.Patch(path, headers, body, content_type, receiver);
  8152. });
  8153. }
  8154. TEST_F(ServerTest, PostQueryStringAndBody) {
  8155. auto res =
  8156. cli_.Post("/query-string-and-body?key=value", "content", "text/plain");
  8157. ASSERT_TRUE(res) << "Error: " << to_string(res.error());
  8158. ASSERT_EQ(StatusCode::OK_200, res->status);
  8159. }
  8160. TEST_F(ServerTest, HTTP2Magic) {
  8161. Request req;
  8162. req.method = "PRI";
  8163. req.path = "*";
  8164. req.body = "SM";
  8165. auto res = std::make_shared<Response>();
  8166. auto error = Error::Success;
  8167. auto ret = cli_.send(req, *res, error);
  8168. ASSERT_TRUE(ret);
  8169. EXPECT_EQ(StatusCode::BadRequest_400, res->status);
  8170. }
  8171. TEST_F(ServerTest, KeepAlive) {
  8172. auto res = cli_.Get("/hi");
  8173. ASSERT_TRUE(res) << "Error: " << to_string(res.error());
  8174. EXPECT_EQ(StatusCode::OK_200, res->status);
  8175. EXPECT_EQ("text/plain", res->get_header_value("Content-Type"));
  8176. EXPECT_EQ("Hello World!", res->body);
  8177. res = cli_.Get("/hi");
  8178. ASSERT_TRUE(res) << "Error: " << to_string(res.error());
  8179. EXPECT_EQ(StatusCode::OK_200, res->status);
  8180. EXPECT_EQ("text/plain", res->get_header_value("Content-Type"));
  8181. EXPECT_EQ("Hello World!", res->body);
  8182. res = cli_.Get("/hi");
  8183. ASSERT_TRUE(res) << "Error: " << to_string(res.error());
  8184. EXPECT_EQ(StatusCode::OK_200, res->status);
  8185. EXPECT_EQ("text/plain", res->get_header_value("Content-Type"));
  8186. EXPECT_EQ("Hello World!", res->body);
  8187. res = cli_.Get("/not-exist");
  8188. ASSERT_TRUE(res) << "Error: " << to_string(res.error());
  8189. EXPECT_EQ(StatusCode::NotFound_404, res->status);
  8190. res = cli_.Post("/empty", "", "text/plain");
  8191. ASSERT_TRUE(res) << "Error: " << to_string(res.error());
  8192. EXPECT_EQ(StatusCode::OK_200, res->status);
  8193. EXPECT_EQ("text/plain", res->get_header_value("Content-Type"));
  8194. EXPECT_EQ("empty", res->body);
  8195. EXPECT_EQ("close", res->get_header_value("Connection"));
  8196. res = cli_.Post(
  8197. "/empty", 0, [&](size_t, size_t, DataSink &) { return true; },
  8198. "text/plain");
  8199. ASSERT_TRUE(res) << "Error: " << to_string(res.error());
  8200. EXPECT_EQ(StatusCode::OK_200, res->status);
  8201. EXPECT_EQ("text/plain", res->get_header_value("Content-Type"));
  8202. EXPECT_EQ("empty", res->body);
  8203. cli_.set_keep_alive(false);
  8204. res = cli_.Get("/last-request");
  8205. ASSERT_TRUE(res) << "Error: " << to_string(res.error());
  8206. EXPECT_EQ(StatusCode::OK_200, res->status);
  8207. EXPECT_EQ("close", res->get_header_value("Connection"));
  8208. }
  8209. TEST_F(ServerTest, TooManyRedirect) {
  8210. cli_.set_follow_location(true);
  8211. auto res = cli_.Get("/redirect/0");
  8212. ASSERT_TRUE(!res);
  8213. EXPECT_EQ(Error::ExceedRedirectCount, res.error());
  8214. }
  8215. TEST_F(ServerTest, BadRequestLineCancelsKeepAlive) {
  8216. Request req;
  8217. req.method = "FOOBAR";
  8218. req.path = "/hi";
  8219. cli_.set_keep_alive(true);
  8220. auto res = cli_.send(req);
  8221. ASSERT_TRUE(res) << "Error: " << to_string(res.error());
  8222. EXPECT_EQ(StatusCode::BadRequest_400, res->status);
  8223. EXPECT_EQ("close", res->get_header_value("Connection"));
  8224. EXPECT_FALSE(cli_.is_socket_open());
  8225. }
  8226. TEST_F(ServerTest, CustomRouteReadsBody) {
  8227. const std::string xml =
  8228. R"(<?xml version="1.0"?><propfind><allprop/></propfind>)";
  8229. Request req;
  8230. req.method = "PROPFIND";
  8231. req.path = "/dav/dir";
  8232. req.set_header("Depth", "1");
  8233. req.body = xml;
  8234. auto res = cli_.send(req);
  8235. ASSERT_TRUE(res) << "Error: " << to_string(res.error());
  8236. EXPECT_EQ(StatusCode::MultiStatus_207, res->status);
  8237. EXPECT_EQ(xml, res->body);
  8238. EXPECT_EQ(std::to_string(xml.size()), res->get_header_value("x-body-size"));
  8239. EXPECT_EQ("application/xml", res->get_header_value("Content-Type"));
  8240. }
  8241. TEST_F(ServerTest, CustomRouteMatchedRouteAndPathParams) {
  8242. Request req;
  8243. req.method = "PROPFIND";
  8244. req.path = "/dav/42";
  8245. auto res = cli_.send(req);
  8246. ASSERT_TRUE(res) << "Error: " << to_string(res.error());
  8247. EXPECT_EQ(StatusCode::MultiStatus_207, res->status);
  8248. EXPECT_EQ("/dav/:id", res->get_header_value("x-matched-route"));
  8249. EXPECT_EQ("42", res->get_header_value("x-dav-id"));
  8250. }
  8251. TEST_F(ServerTest, CustomRouteRegexPattern) {
  8252. Request req;
  8253. req.method = "PROPFIND";
  8254. req.path = "/dav-re/123";
  8255. auto res = cli_.send(req);
  8256. ASSERT_TRUE(res) << "Error: " << to_string(res.error());
  8257. EXPECT_EQ(StatusCode::MultiStatus_207, res->status);
  8258. EXPECT_EQ("123", res->get_header_value("x-dav-match"));
  8259. }
  8260. TEST_F(ServerTest, CustomRouteWithoutBody) {
  8261. Request req;
  8262. req.method = "MKCOL";
  8263. req.path = "/dav-mkcol";
  8264. auto res = cli_.send(req);
  8265. ASSERT_TRUE(res) << "Error: " << to_string(res.error());
  8266. EXPECT_EQ(StatusCode::Created_201, res->status);
  8267. }
  8268. TEST_F(ServerTest, CustomRouteWithContentReader) {
  8269. const std::string xml = R"(<?xml version="1.0"?><sync-collection/>)";
  8270. Request req;
  8271. req.method = "REPORT";
  8272. req.path = "/dav-report";
  8273. req.body = xml;
  8274. auto res = cli_.send(req);
  8275. ASSERT_TRUE(res) << "Error: " << to_string(res.error());
  8276. EXPECT_EQ(StatusCode::MultiStatus_207, res->status);
  8277. EXPECT_EQ(xml, res->body);
  8278. }
  8279. // A content reader route must fire even when the request carries no body,
  8280. // the way the built-in Delete(pattern, HandlerWithContentReader) does.
  8281. // Without that, a body-less PROPFIND-style request would fall through to 404.
  8282. TEST_F(ServerTest, CustomRouteWithContentReaderWithoutBody) {
  8283. Request req;
  8284. req.method = "REPORT";
  8285. req.path = "/dav-report";
  8286. auto res = cli_.send(req);
  8287. ASSERT_TRUE(res) << "Error: " << to_string(res.error());
  8288. EXPECT_EQ(StatusCode::MultiStatus_207, res->status);
  8289. EXPECT_EQ("0", res->get_header_value("x-body-size"));
  8290. }
  8291. TEST_F(ServerTest, CustomRouteUnmatchedPathReturns404) {
  8292. Request req;
  8293. req.method = "PROPFIND";
  8294. req.path = "/not-dav";
  8295. auto res = cli_.send(req);
  8296. ASSERT_TRUE(res) << "Error: " << to_string(res.error());
  8297. EXPECT_EQ(StatusCode::NotFound_404, res->status);
  8298. }
  8299. TEST_F(ServerTest, CustomRouteUnregisteredMethodIsRejected) {
  8300. Request req;
  8301. req.method = "UNLOCK";
  8302. req.path = "/dav/dir";
  8303. cli_.set_keep_alive(true);
  8304. auto res = cli_.send(req);
  8305. ASSERT_TRUE(res) << "Error: " << to_string(res.error());
  8306. EXPECT_EQ(StatusCode::BadRequest_400, res->status);
  8307. EXPECT_EQ("close", res->get_header_value("Connection"));
  8308. EXPECT_FALSE(cli_.is_socket_open());
  8309. }
  8310. TEST_F(ServerTest, CustomRouteDoesNotServeStaticFiles) {
  8311. // The mount point serves this path, but only for GET and HEAD.
  8312. auto get_res = cli_.Get("/dir/index.html");
  8313. ASSERT_TRUE(get_res) << "Error: " << to_string(get_res.error());
  8314. ASSERT_EQ(StatusCode::OK_200, get_res->status);
  8315. Request req;
  8316. req.method = "PROPFIND";
  8317. req.path = "/dir/index.html";
  8318. auto res = cli_.send(req);
  8319. ASSERT_TRUE(res) << "Error: " << to_string(res.error());
  8320. EXPECT_EQ(StatusCode::NotFound_404, res->status);
  8321. }
  8322. TEST_F(ServerTest, CustomRouteKeepAlive) {
  8323. const std::string xml = R"(<?xml version="1.0"?><propfind/>)";
  8324. cli_.set_keep_alive(true);
  8325. for (auto i = 0; i < 2; i++) {
  8326. Request req;
  8327. req.method = "PROPFIND";
  8328. req.path = "/dav/dir";
  8329. req.body = xml;
  8330. auto res = cli_.send(req);
  8331. ASSERT_TRUE(res) << "Error: " << to_string(res.error());
  8332. EXPECT_EQ(StatusCode::MultiStatus_207, res->status);
  8333. EXPECT_EQ(xml, res->body);
  8334. EXPECT_TRUE(cli_.is_socket_open());
  8335. }
  8336. // A built-in method must still be served on the same connection.
  8337. cli_.set_keep_alive(false);
  8338. auto res = cli_.Get("/hi");
  8339. ASSERT_TRUE(res) << "Error: " << to_string(res.error());
  8340. EXPECT_EQ(StatusCode::OK_200, res->status);
  8341. EXPECT_EQ("close", res->get_header_value("Connection"));
  8342. }
  8343. TEST_F(ServerTest, CustomRouteExpect100Continue) {
  8344. const std::string xml = R"(<?xml version="1.0"?><propfind/>)";
  8345. Request req;
  8346. req.method = "PROPFIND";
  8347. req.path = "/dav/dir";
  8348. req.set_header("Expect", "100-continue");
  8349. req.body = xml;
  8350. auto res = cli_.send(req);
  8351. ASSERT_TRUE(res) << "Error: " << to_string(res.error());
  8352. EXPECT_EQ(StatusCode::MultiStatus_207, res->status);
  8353. EXPECT_EQ(xml, res->body);
  8354. }
  8355. TEST_F(ServerTest, StartTime) { auto res = cli_.Get("/test-start-time"); }
  8356. #ifdef CPPHTTPLIB_ZLIB_SUPPORT
  8357. TEST_F(ServerTest, Gzip) {
  8358. Headers headers;
  8359. headers.emplace("Accept-Encoding", "gzip, deflate");
  8360. auto res = cli_.Get("/compress", headers);
  8361. ASSERT_TRUE(res) << "Error: " << to_string(res.error());
  8362. EXPECT_EQ("gzip", res->get_header_value("Content-Encoding"));
  8363. EXPECT_EQ("text/plain", res->get_header_value("Content-Type"));
  8364. EXPECT_EQ("33", res->get_header_value("Content-Length"));
  8365. EXPECT_EQ("123456789012345678901234567890123456789012345678901234567890123456"
  8366. "7890123456789012345678901234567890",
  8367. res->body);
  8368. EXPECT_EQ(StatusCode::OK_200, res->status);
  8369. }
  8370. TEST_F(ServerTest, GzipWithContentTypeParameters) {
  8371. Headers headers;
  8372. headers.emplace("Accept-Encoding", "gzip, deflate");
  8373. auto res = cli_.Get("/compress-with-charset", headers);
  8374. ASSERT_TRUE(res) << "Error: " << to_string(res.error());
  8375. EXPECT_EQ("gzip", res->get_header_value("Content-Encoding"));
  8376. EXPECT_EQ("application/json; charset=utf-8",
  8377. res->get_header_value("Content-Type"));
  8378. EXPECT_EQ("123456789012345678901234567890123456789012345678901234567890123456"
  8379. "7890123456789012345678901234567890",
  8380. res->body);
  8381. EXPECT_EQ(StatusCode::OK_200, res->status);
  8382. }
  8383. TEST_F(ServerTest, GzipWithoutAcceptEncoding) {
  8384. Headers headers;
  8385. headers.emplace("Accept-Encoding", "");
  8386. auto res = cli_.Get("/compress", headers);
  8387. ASSERT_TRUE(res) << "Error: " << to_string(res.error());
  8388. EXPECT_TRUE(res->get_header_value("Content-Encoding").empty());
  8389. EXPECT_EQ("text/plain", res->get_header_value("Content-Type"));
  8390. EXPECT_EQ("100", res->get_header_value("Content-Length"));
  8391. EXPECT_EQ("123456789012345678901234567890123456789012345678901234567890123456"
  8392. "7890123456789012345678901234567890",
  8393. res->body);
  8394. EXPECT_EQ(StatusCode::OK_200, res->status);
  8395. }
  8396. TEST_F(ServerTest, GzipWithContentReceiver) {
  8397. Headers headers;
  8398. headers.emplace("Accept-Encoding", "gzip, deflate");
  8399. std::string body;
  8400. auto res = cli_.Get("/compress", headers,
  8401. [&](const char *data, uint64_t data_length) {
  8402. EXPECT_EQ(100U, data_length);
  8403. body.append(data, data_length);
  8404. return true;
  8405. });
  8406. ASSERT_TRUE(res) << "Error: " << to_string(res.error());
  8407. EXPECT_EQ("gzip", res->get_header_value("Content-Encoding"));
  8408. EXPECT_EQ("text/plain", res->get_header_value("Content-Type"));
  8409. EXPECT_EQ("33", res->get_header_value("Content-Length"));
  8410. EXPECT_EQ("123456789012345678901234567890123456789012345678901234567890123456"
  8411. "7890123456789012345678901234567890",
  8412. body);
  8413. EXPECT_EQ(StatusCode::OK_200, res->status);
  8414. }
  8415. TEST_F(ServerTest, GzipWithoutDecompressing) {
  8416. Headers headers;
  8417. headers.emplace("Accept-Encoding", "gzip, deflate");
  8418. cli_.set_decompress(false);
  8419. auto res = cli_.Get("/compress", headers);
  8420. ASSERT_TRUE(res) << "Error: " << to_string(res.error());
  8421. EXPECT_EQ("gzip", res->get_header_value("Content-Encoding"));
  8422. EXPECT_EQ("text/plain", res->get_header_value("Content-Type"));
  8423. EXPECT_EQ("33", res->get_header_value("Content-Length"));
  8424. EXPECT_EQ(33U, res->body.size());
  8425. EXPECT_EQ(StatusCode::OK_200, res->status);
  8426. }
  8427. TEST_F(ServerTest, GzipWithContentReceiverWithoutAcceptEncoding) {
  8428. Headers headers;
  8429. headers.emplace("Accept-Encoding", "");
  8430. std::string body;
  8431. auto res = cli_.Get("/compress", headers,
  8432. [&](const char *data, uint64_t data_length) {
  8433. EXPECT_EQ(100U, data_length);
  8434. body.append(data, data_length);
  8435. return true;
  8436. });
  8437. ASSERT_TRUE(res) << "Error: " << to_string(res.error());
  8438. EXPECT_TRUE(res->get_header_value("Content-Encoding").empty());
  8439. EXPECT_EQ("text/plain", res->get_header_value("Content-Type"));
  8440. EXPECT_EQ("100", res->get_header_value("Content-Length"));
  8441. EXPECT_EQ("123456789012345678901234567890123456789012345678901234567890123456"
  8442. "7890123456789012345678901234567890",
  8443. body);
  8444. EXPECT_EQ(StatusCode::OK_200, res->status);
  8445. }
  8446. TEST_F(ServerTest, NoGzip) {
  8447. Headers headers;
  8448. headers.emplace("Accept-Encoding", "gzip, deflate");
  8449. auto res = cli_.Get("/nocompress", headers);
  8450. ASSERT_TRUE(res) << "Error: " << to_string(res.error());
  8451. EXPECT_EQ(false, res->has_header("Content-Encoding"));
  8452. EXPECT_EQ("application/octet-stream", res->get_header_value("Content-Type"));
  8453. EXPECT_EQ("100", res->get_header_value("Content-Length"));
  8454. EXPECT_EQ("123456789012345678901234567890123456789012345678901234567890123456"
  8455. "7890123456789012345678901234567890",
  8456. res->body);
  8457. EXPECT_EQ(StatusCode::OK_200, res->status);
  8458. }
  8459. TEST_F(ServerTest, NoGzipWithContentReceiver) {
  8460. Headers headers;
  8461. headers.emplace("Accept-Encoding", "gzip, deflate");
  8462. std::string body;
  8463. auto res = cli_.Get("/nocompress", headers,
  8464. [&](const char *data, uint64_t data_length) {
  8465. EXPECT_EQ(100U, data_length);
  8466. body.append(data, data_length);
  8467. return true;
  8468. });
  8469. ASSERT_TRUE(res) << "Error: " << to_string(res.error());
  8470. EXPECT_EQ(false, res->has_header("Content-Encoding"));
  8471. EXPECT_EQ("application/octet-stream", res->get_header_value("Content-Type"));
  8472. EXPECT_EQ("100", res->get_header_value("Content-Length"));
  8473. EXPECT_EQ("123456789012345678901234567890123456789012345678901234567890123456"
  8474. "7890123456789012345678901234567890",
  8475. body);
  8476. EXPECT_EQ(StatusCode::OK_200, res->status);
  8477. }
  8478. TEST_F(ServerTest, MultipartFormDataGzip) {
  8479. UploadFormDataItems items = {
  8480. {"key1", "test", "", ""},
  8481. {"key2", "--abcdefg123", "", ""},
  8482. };
  8483. cli_.set_compress(true);
  8484. auto res = cli_.Post("/compress-multipart", items);
  8485. ASSERT_TRUE(res) << "Error: " << to_string(res.error());
  8486. EXPECT_EQ(StatusCode::OK_200, res->status);
  8487. }
  8488. #endif
  8489. #ifdef CPPHTTPLIB_ZLIB_SUPPORT
  8490. // Static file compression is opt-in, so these run their own server rather than
  8491. // flipping it on for the shared ServerTest fixture, which would silently
  8492. // rewrite what every other static file test is asserting.
  8493. class StaticFileCompressionTest : public ::testing::Test {
  8494. protected:
  8495. void TearDown() override {
  8496. if (t_.joinable()) {
  8497. svr_.stop();
  8498. t_.join();
  8499. }
  8500. }
  8501. int start(const std::function<void(Server &)> &configure = nullptr) {
  8502. // Serves the same tree as a directory of build-time compressed assets
  8503. // would be served: the mount point names the coding the files are already
  8504. // stored in. Registered before "/" so it is the one that matches.
  8505. svr_.set_mount_point("/pre-encoded", "./www",
  8506. {{"Content-Encoding", "gzip"}});
  8507. svr_.set_mount_point("/", "./www");
  8508. svr_.Get("/file_content", [](const Request & /*req*/, Response &res) {
  8509. res.set_file_content("./www/dir/index.html", "text/html");
  8510. });
  8511. svr_.Get("/pre-encoded-file-content",
  8512. [](const Request & /*req*/, Response &res) {
  8513. res.set_header("Content-Encoding", "gzip");
  8514. res.set_file_content("./www/dir/index.html", "text/html");
  8515. });
  8516. svr_.Get("/streamed", [](const Request & /*req*/, Response &res) {
  8517. res.set_content_provider(
  8518. 6, "text/plain",
  8519. [](size_t offset, size_t /*length*/, DataSink &sink) {
  8520. sink.write(offset < 3 ? "aaa" : "bbb", 3);
  8521. return true;
  8522. });
  8523. });
  8524. svr_.Get("/slow-stream", [](const Request & /*req*/, Response &res) {
  8525. res.set_content_provider(
  8526. 1000, "text/plain",
  8527. [](size_t offset, size_t /*length*/, DataSink &sink) {
  8528. if (offset < 100) {
  8529. std::string data(100, 'A');
  8530. sink.write(data.data(), data.size());
  8531. return true;
  8532. }
  8533. std::this_thread::sleep_for(std::chrono::seconds(2));
  8534. std::string data(900, 'B');
  8535. sink.write(data.data(), data.size());
  8536. return true;
  8537. });
  8538. });
  8539. if (configure) { configure(svr_); }
  8540. auto port = svr_.bind_to_any_port(HOST);
  8541. t_ = std::thread([&]() { svr_.listen_after_bind(); });
  8542. svr_.wait_until_ready();
  8543. return port;
  8544. }
  8545. static void enable(Server &svr) { svr.set_static_file_compression(true); }
  8546. // Every file under ./www except 1MB.txt is smaller than the default
  8547. // 1400-byte floor, so a test that needs a small file compressed has to lower
  8548. // it out of the way.
  8549. static void enable_without_floor(Server &svr) {
  8550. svr.set_static_file_compression(true);
  8551. svr.set_static_file_compression_min_length(0);
  8552. }
  8553. Server svr_;
  8554. std::thread t_;
  8555. };
  8556. TEST_F(StaticFileCompressionTest, DisabledByDefault) {
  8557. auto port = start();
  8558. Client cli(HOST, port);
  8559. auto res = cli.Get("/dir/1MB.txt", Headers{{"Accept-Encoding", "gzip"}});
  8560. ASSERT_TRUE(res) << "Error: " << to_string(res.error());
  8561. EXPECT_EQ(StatusCode::OK_200, res->status);
  8562. EXPECT_FALSE(res->has_header("Content-Encoding"));
  8563. EXPECT_EQ("1048576", res->get_header_value("Content-Length"));
  8564. EXPECT_EQ(1048576U, res->body.size());
  8565. }
  8566. TEST_F(StaticFileCompressionTest, MountPoint) {
  8567. auto port = start(enable);
  8568. Client cli(HOST, port);
  8569. cli.set_decompress(false);
  8570. auto res = cli.Get("/dir/1MB.txt", Headers{{"Accept-Encoding", "gzip"}});
  8571. ASSERT_TRUE(res) << "Error: " << to_string(res.error());
  8572. EXPECT_EQ(StatusCode::OK_200, res->status);
  8573. EXPECT_EQ("text/plain", res->get_header_value("Content-Type"));
  8574. EXPECT_EQ("gzip", res->get_header_value("Content-Encoding"));
  8575. EXPECT_EQ("Accept-Encoding", res->get_header_value("Vary"));
  8576. // The response stays self-delimiting: a length, not a chunked body.
  8577. EXPECT_FALSE(res->has_header("Transfer-Encoding"));
  8578. EXPECT_EQ(std::to_string(res->body.size()),
  8579. res->get_header_value("Content-Length"));
  8580. EXPECT_LT(res->body.size(), 1048576U);
  8581. EXPECT_FALSE(res->body.empty());
  8582. }
  8583. TEST_F(StaticFileCompressionTest, MountPointDecompressed) {
  8584. auto port = start(enable);
  8585. Client cli(HOST, port);
  8586. auto res = cli.Get("/dir/1MB.txt", Headers{{"Accept-Encoding", "gzip"}});
  8587. ASSERT_TRUE(res) << "Error: " << to_string(res.error());
  8588. EXPECT_EQ(StatusCode::OK_200, res->status);
  8589. EXPECT_EQ("gzip", res->get_header_value("Content-Encoding"));
  8590. EXPECT_EQ(1048576U, res->body.size());
  8591. }
  8592. TEST_F(StaticFileCompressionTest, FileContent) {
  8593. auto port = start(enable_without_floor);
  8594. Client cli(HOST, port);
  8595. auto res = cli.Get("/file_content", Headers{{"Accept-Encoding", "gzip"}});
  8596. ASSERT_TRUE(res) << "Error: " << to_string(res.error());
  8597. EXPECT_EQ(StatusCode::OK_200, res->status);
  8598. EXPECT_EQ("text/html", res->get_header_value("Content-Type"));
  8599. EXPECT_EQ("gzip", res->get_header_value("Content-Encoding"));
  8600. EXPECT_EQ(104U, res->body.size());
  8601. }
  8602. // A handler that serves an already-encoded file names the coding itself. The
  8603. // file-backed path decided its coding from Accept-Encoding and the content
  8604. // type alone, so it compressed the stored bytes a second time and appended a
  8605. // second Content-Encoding field line.
  8606. TEST_F(StaticFileCompressionTest, PreEncodedFileContentIsNotCompressedAgain) {
  8607. auto port = start(enable_without_floor);
  8608. Client cli(HOST, port);
  8609. cli.set_decompress(false);
  8610. auto res = cli.Get("/pre-encoded-file-content",
  8611. Headers{{"Accept-Encoding", "gzip"}});
  8612. ASSERT_TRUE(res) << "Error: " << to_string(res.error());
  8613. EXPECT_EQ(StatusCode::OK_200, res->status);
  8614. EXPECT_EQ(1U, res->get_header_value_count("Content-Encoding"));
  8615. EXPECT_EQ("gzip", res->get_header_value("Content-Encoding"));
  8616. // Vary belongs to a coding the server chose, and it chose none here.
  8617. EXPECT_FALSE(res->has_header("Vary"));
  8618. // The file travels exactly as it is stored on disk.
  8619. EXPECT_EQ(104U, res->body.size());
  8620. }
  8621. // The 1MB file clears the default floor, so this one runs the configuration a
  8622. // deployment would actually have.
  8623. TEST_F(StaticFileCompressionTest, PreEncodedMountPointIsNotCompressedAgain) {
  8624. auto port = start(enable);
  8625. Client cli(HOST, port);
  8626. cli.set_decompress(false);
  8627. auto res =
  8628. cli.Get("/pre-encoded/dir/1MB.txt", Headers{{"Accept-Encoding", "gzip"}});
  8629. ASSERT_TRUE(res) << "Error: " << to_string(res.error());
  8630. EXPECT_EQ(StatusCode::OK_200, res->status);
  8631. EXPECT_EQ(1U, res->get_header_value_count("Content-Encoding"));
  8632. EXPECT_EQ("gzip", res->get_header_value("Content-Encoding"));
  8633. EXPECT_FALSE(res->has_header("Vary"));
  8634. EXPECT_EQ(1048576U, res->body.size());
  8635. EXPECT_EQ("1048576", res->get_header_value("Content-Length"));
  8636. }
  8637. TEST_F(StaticFileCompressionTest, Head) {
  8638. auto port = start(enable);
  8639. Client cli(HOST, port);
  8640. cli.set_decompress(false);
  8641. auto get = cli.Get("/dir/1MB.txt", Headers{{"Accept-Encoding", "gzip"}});
  8642. ASSERT_TRUE(get) << "Error: " << to_string(get.error());
  8643. auto res = cli.Head("/dir/1MB.txt", Headers{{"Accept-Encoding", "gzip"}});
  8644. ASSERT_TRUE(res) << "Error: " << to_string(res.error());
  8645. EXPECT_EQ(StatusCode::OK_200, res->status);
  8646. EXPECT_EQ("gzip", res->get_header_value("Content-Encoding"));
  8647. EXPECT_FALSE(res->has_header("Transfer-Encoding"));
  8648. // HEAD still reports the size a GET would return.
  8649. EXPECT_EQ(get->get_header_value("Content-Length"),
  8650. res->get_header_value("Content-Length"));
  8651. EXPECT_TRUE(res->body.empty());
  8652. }
  8653. TEST_F(StaticFileCompressionTest, RangeStaysIdentity) {
  8654. auto port = start(enable);
  8655. Client cli(HOST, port);
  8656. auto res = cli.Get("/dir/test.abcde", Headers{make_range_header({{2, 3}}),
  8657. {"Accept-Encoding", "gzip"}});
  8658. ASSERT_TRUE(res) << "Error: " << to_string(res.error());
  8659. EXPECT_EQ(StatusCode::PartialContent_206, res->status);
  8660. EXPECT_FALSE(res->has_header("Content-Encoding"));
  8661. EXPECT_EQ("2", res->get_header_value("Content-Length"));
  8662. EXPECT_EQ("bytes 2-3/5", res->get_header_value("Content-Range"));
  8663. EXPECT_EQ("cd", res->body);
  8664. }
  8665. TEST_F(StaticFileCompressionTest, NotCompressibleType) {
  8666. auto port = start(enable);
  8667. Client cli(HOST, port);
  8668. auto res = cli.Get("/file", Headers{{"Accept-Encoding", "gzip"}});
  8669. ASSERT_TRUE(res) << "Error: " << to_string(res.error());
  8670. EXPECT_EQ(StatusCode::OK_200, res->status);
  8671. EXPECT_EQ("application/octet-stream", res->get_header_value("Content-Type"));
  8672. EXPECT_FALSE(res->has_header("Content-Encoding"));
  8673. EXPECT_EQ("5", res->get_header_value("Content-Length"));
  8674. }
  8675. TEST_F(StaticFileCompressionTest, EmptyFile) {
  8676. auto port = start(enable);
  8677. Client cli(HOST, port);
  8678. auto res = cli.Get("/empty_file", Headers{{"Accept-Encoding", "gzip"}});
  8679. ASSERT_TRUE(res) << "Error: " << to_string(res.error());
  8680. EXPECT_EQ(StatusCode::OK_200, res->status);
  8681. EXPECT_FALSE(res->has_header("Content-Encoding"));
  8682. EXPECT_EQ("0", res->get_header_value("Content-Length"));
  8683. EXPECT_TRUE(res->body.empty());
  8684. }
  8685. TEST_F(StaticFileCompressionTest, MinLength) {
  8686. auto port = start(enable);
  8687. Client cli(HOST, port);
  8688. // 104 bytes, well under the default floor. Compressing it would add the
  8689. // gzip header and trailer to a body that already fits in one packet.
  8690. auto res = cli.Get("/dir/index.html", Headers{{"Accept-Encoding", "gzip"}});
  8691. ASSERT_TRUE(res) << "Error: " << to_string(res.error());
  8692. EXPECT_EQ(StatusCode::OK_200, res->status);
  8693. EXPECT_FALSE(res->has_header("Content-Encoding"));
  8694. EXPECT_EQ("104", res->get_header_value("Content-Length"));
  8695. }
  8696. TEST_F(StaticFileCompressionTest, MinLengthLowered) {
  8697. auto port = start([](Server &svr) {
  8698. svr.set_static_file_compression(true);
  8699. svr.set_static_file_compression_min_length(1);
  8700. });
  8701. Client cli(HOST, port);
  8702. cli.set_decompress(false);
  8703. auto res = cli.Get("/dir/test.html", Headers{{"Accept-Encoding", "gzip"}});
  8704. ASSERT_TRUE(res) << "Error: " << to_string(res.error());
  8705. EXPECT_EQ("gzip", res->get_header_value("Content-Encoding"));
  8706. // A 9-byte file comes back larger than it went in, because gzip's header and
  8707. // trailer outweigh anything deflate can save. That is the end of the range
  8708. // the floor exists to keep out.
  8709. EXPECT_GT(res->body.size(), 9U);
  8710. }
  8711. TEST_F(StaticFileCompressionTest, MaxLength) {
  8712. auto port = start([](Server &svr) {
  8713. svr.set_static_file_compression(true);
  8714. svr.set_static_file_compression_min_length(0);
  8715. svr.set_static_file_compression_max_length(1024);
  8716. });
  8717. Client cli(HOST, port);
  8718. // Over the limit: served as is. Not named `big`/`small`: <rpcndr.h>
  8719. // defines `small` as a macro on Windows.
  8720. auto over = cli.Get("/dir/1MB.txt", Headers{{"Accept-Encoding", "gzip"}});
  8721. ASSERT_TRUE(over) << "Error: " << to_string(over.error());
  8722. EXPECT_FALSE(over->has_header("Content-Encoding"));
  8723. EXPECT_EQ("1048576", over->get_header_value("Content-Length"));
  8724. // Under it: compressed.
  8725. auto under = cli.Get("/dir/index.html", Headers{{"Accept-Encoding", "gzip"}});
  8726. ASSERT_TRUE(under) << "Error: " << to_string(under.error());
  8727. EXPECT_EQ("gzip", under->get_header_value("Content-Encoding"));
  8728. }
  8729. TEST_F(StaticFileCompressionTest, EtagPerEncoding) {
  8730. auto port = start(enable_without_floor);
  8731. Client cli(HOST, port);
  8732. auto identity = cli.Get("/dir/index.html", Headers{{"Accept-Encoding", ""}});
  8733. ASSERT_TRUE(identity) << "Error: " << to_string(identity.error());
  8734. EXPECT_FALSE(identity->has_header("Content-Encoding"));
  8735. auto identity_etag = identity->get_header_value("ETag");
  8736. ASSERT_FALSE(identity_etag.empty());
  8737. auto gzipped =
  8738. cli.Get("/dir/index.html", Headers{{"Accept-Encoding", "gzip"}});
  8739. ASSERT_TRUE(gzipped) << "Error: " << to_string(gzipped.error());
  8740. EXPECT_EQ("gzip", gzipped->get_header_value("Content-Encoding"));
  8741. auto gzip_etag = gzipped->get_header_value("ETag");
  8742. ASSERT_FALSE(gzip_etag.empty());
  8743. // Two representations, two validators.
  8744. EXPECT_NE(identity_etag, gzip_etag);
  8745. // Each one revalidates against the request that would produce it...
  8746. auto fresh =
  8747. cli.Get("/dir/index.html", Headers{{"Accept-Encoding", "gzip"},
  8748. {"If-None-Match", gzip_etag}});
  8749. ASSERT_TRUE(fresh) << "Error: " << to_string(fresh.error());
  8750. EXPECT_EQ(StatusCode::NotModified_304, fresh->status);
  8751. auto fresh_identity =
  8752. cli.Get("/dir/index.html", Headers{{"Accept-Encoding", ""},
  8753. {"If-None-Match", identity_etag}});
  8754. ASSERT_TRUE(fresh_identity) << "Error: " << to_string(fresh_identity.error());
  8755. EXPECT_EQ(StatusCode::NotModified_304, fresh_identity->status);
  8756. // ...and not against the other representation.
  8757. auto crossed =
  8758. cli.Get("/dir/index.html",
  8759. Headers{{"Accept-Encoding", ""}, {"If-None-Match", gzip_etag}});
  8760. ASSERT_TRUE(crossed) << "Error: " << to_string(crossed.error());
  8761. EXPECT_EQ(StatusCode::OK_200, crossed->status);
  8762. }
  8763. // The opt-in covers responses the server reads off disk itself. A caller's own
  8764. // known-length provider keeps its Content-Length and, more importantly, keeps
  8765. // delivering incrementally: routing it through a compressor would hold every
  8766. // write back until zlib's window filled.
  8767. TEST_F(StaticFileCompressionTest, KnownLengthProviderUnaffected) {
  8768. auto port = start(enable);
  8769. Client cli(HOST, port);
  8770. auto res = cli.Get("/streamed", Headers{{"Accept-Encoding", "gzip"}});
  8771. ASSERT_TRUE(res) << "Error: " << to_string(res.error());
  8772. EXPECT_EQ(StatusCode::OK_200, res->status);
  8773. EXPECT_FALSE(res->has_header("Content-Encoding"));
  8774. EXPECT_EQ("6", res->get_header_value("Content-Length"));
  8775. EXPECT_EQ("aaabbb", res->body);
  8776. }
  8777. TEST_F(StaticFileCompressionTest, IncrementalProviderUnaffected) {
  8778. auto port = start(enable);
  8779. Client cli(HOST, port);
  8780. cli.set_read_timeout(1, 0);
  8781. auto handle = cli.open_stream("GET", "/slow-stream", Params{},
  8782. Headers{{"Accept-Encoding", "gzip"}});
  8783. ASSERT_TRUE(handle.is_valid());
  8784. // The provider writes 100 bytes and then stalls for longer than the read
  8785. // timeout. Those first bytes have to arrive anyway: run the response through
  8786. // a compressor and zlib holds them until its window fills, so the read would
  8787. // come back empty instead.
  8788. char buf[256];
  8789. auto n = handle.read(buf, sizeof(buf));
  8790. ASSERT_GT(n, 0) << "first read should return the bytes already written";
  8791. EXPECT_EQ(std::string(100, 'A'), std::string(buf, static_cast<size_t>(n)));
  8792. }
  8793. #endif
  8794. #ifdef CPPHTTPLIB_BROTLI_SUPPORT
  8795. TEST_F(ServerTest, Brotli) {
  8796. Headers headers;
  8797. headers.emplace("Accept-Encoding", "br");
  8798. auto res = cli_.Get("/compress", headers);
  8799. ASSERT_TRUE(res) << "Error: " << to_string(res.error());
  8800. EXPECT_EQ("br", res->get_header_value("Content-Encoding"));
  8801. EXPECT_EQ("text/plain", res->get_header_value("Content-Type"));
  8802. EXPECT_EQ("19", res->get_header_value("Content-Length"));
  8803. EXPECT_EQ("123456789012345678901234567890123456789012345678901234567890123456"
  8804. "7890123456789012345678901234567890",
  8805. res->body);
  8806. EXPECT_EQ(StatusCode::OK_200, res->status);
  8807. }
  8808. #endif
  8809. #ifdef CPPHTTPLIB_ZSTD_SUPPORT
  8810. TEST_F(ServerTest, Zstd) {
  8811. Headers headers;
  8812. headers.emplace("Accept-Encoding", "zstd");
  8813. auto res = cli_.Get("/compress", headers);
  8814. ASSERT_TRUE(res) << "Error: " << to_string(res.error());
  8815. EXPECT_EQ("zstd", res->get_header_value("Content-Encoding"));
  8816. EXPECT_EQ("text/plain", res->get_header_value("Content-Type"));
  8817. EXPECT_EQ("26", res->get_header_value("Content-Length"));
  8818. EXPECT_EQ("123456789012345678901234567890123456789012345678901234567890123456"
  8819. "7890123456789012345678901234567890",
  8820. res->body);
  8821. EXPECT_EQ(StatusCode::OK_200, res->status);
  8822. }
  8823. TEST_F(ServerTest, ZstdWithoutAcceptEncoding) {
  8824. Headers headers;
  8825. headers.emplace("Accept-Encoding", "");
  8826. auto res = cli_.Get("/compress", headers);
  8827. ASSERT_TRUE(res) << "Error: " << to_string(res.error());
  8828. EXPECT_TRUE(res->get_header_value("Content-Encoding").empty());
  8829. EXPECT_EQ("text/plain", res->get_header_value("Content-Type"));
  8830. EXPECT_EQ("100", res->get_header_value("Content-Length"));
  8831. EXPECT_EQ("123456789012345678901234567890123456789012345678901234567890123456"
  8832. "7890123456789012345678901234567890",
  8833. res->body);
  8834. EXPECT_EQ(StatusCode::OK_200, res->status);
  8835. }
  8836. TEST_F(ServerTest, ZstdWithContentReceiver) {
  8837. Headers headers;
  8838. headers.emplace("Accept-Encoding", "zstd");
  8839. std::string body;
  8840. auto res = cli_.Get("/compress", headers,
  8841. [&](const char *data, uint64_t data_length) {
  8842. EXPECT_EQ(100U, data_length);
  8843. body.append(data, data_length);
  8844. return true;
  8845. });
  8846. ASSERT_TRUE(res) << "Error: " << to_string(res.error());
  8847. EXPECT_EQ("zstd", res->get_header_value("Content-Encoding"));
  8848. EXPECT_EQ("text/plain", res->get_header_value("Content-Type"));
  8849. EXPECT_EQ("26", res->get_header_value("Content-Length"));
  8850. EXPECT_EQ("123456789012345678901234567890123456789012345678901234567890123456"
  8851. "7890123456789012345678901234567890",
  8852. body);
  8853. EXPECT_EQ(StatusCode::OK_200, res->status);
  8854. }
  8855. TEST_F(ServerTest, ZstdWithoutDecompressing) {
  8856. Headers headers;
  8857. headers.emplace("Accept-Encoding", "zstd");
  8858. cli_.set_decompress(false);
  8859. auto res = cli_.Get("/compress", headers);
  8860. unsigned char compressed[26] = {0x28, 0xb5, 0x2f, 0xfd, 0x20, 0x64, 0x8d,
  8861. 0x00, 0x00, 0x50, 0x31, 0x32, 0x33, 0x34,
  8862. 0x35, 0x36, 0x37, 0x38, 0x39, 0x30, 0x01,
  8863. 0x00, 0xd7, 0xa9, 0x20, 0x01};
  8864. ASSERT_TRUE(res) << "Error: " << to_string(res.error());
  8865. EXPECT_EQ("zstd", res->get_header_value("Content-Encoding"));
  8866. EXPECT_EQ("text/plain", res->get_header_value("Content-Type"));
  8867. EXPECT_EQ("26", res->get_header_value("Content-Length"));
  8868. EXPECT_EQ(StatusCode::OK_200, res->status);
  8869. ASSERT_EQ(26U, res->body.size());
  8870. EXPECT_TRUE(std::memcmp(compressed, res->body.data(), sizeof(compressed)) ==
  8871. 0);
  8872. }
  8873. TEST_F(ServerTest, ZstdWithContentReceiverWithoutAcceptEncoding) {
  8874. Headers headers;
  8875. headers.emplace("Accept-Encoding", "");
  8876. std::string body;
  8877. auto res = cli_.Get("/compress", headers,
  8878. [&](const char *data, uint64_t data_length) {
  8879. EXPECT_EQ(100U, data_length);
  8880. body.append(data, data_length);
  8881. return true;
  8882. });
  8883. ASSERT_TRUE(res) << "Error: " << to_string(res.error());
  8884. EXPECT_TRUE(res->get_header_value("Content-Encoding").empty());
  8885. EXPECT_EQ("text/plain", res->get_header_value("Content-Type"));
  8886. EXPECT_EQ("100", res->get_header_value("Content-Length"));
  8887. EXPECT_EQ("123456789012345678901234567890123456789012345678901234567890123456"
  8888. "7890123456789012345678901234567890",
  8889. body);
  8890. EXPECT_EQ(StatusCode::OK_200, res->status);
  8891. }
  8892. TEST_F(ServerTest, NoZstd) {
  8893. Headers headers;
  8894. headers.emplace("Accept-Encoding", "zstd");
  8895. auto res = cli_.Get("/nocompress", headers);
  8896. ASSERT_TRUE(res) << "Error: " << to_string(res.error());
  8897. EXPECT_EQ(false, res->has_header("Content-Encoding"));
  8898. EXPECT_EQ("application/octet-stream", res->get_header_value("Content-Type"));
  8899. EXPECT_EQ("100", res->get_header_value("Content-Length"));
  8900. EXPECT_EQ("123456789012345678901234567890123456789012345678901234567890123456"
  8901. "7890123456789012345678901234567890",
  8902. res->body);
  8903. EXPECT_EQ(StatusCode::OK_200, res->status);
  8904. }
  8905. TEST_F(ServerTest, NoZstdWithContentReceiver) {
  8906. Headers headers;
  8907. headers.emplace("Accept-Encoding", "zstd");
  8908. std::string body;
  8909. auto res = cli_.Get("/nocompress", headers,
  8910. [&](const char *data, uint64_t data_length) {
  8911. EXPECT_EQ(100U, data_length);
  8912. body.append(data, data_length);
  8913. return true;
  8914. });
  8915. ASSERT_TRUE(res) << "Error: " << to_string(res.error());
  8916. EXPECT_EQ(false, res->has_header("Content-Encoding"));
  8917. EXPECT_EQ("application/octet-stream", res->get_header_value("Content-Type"));
  8918. EXPECT_EQ("100", res->get_header_value("Content-Length"));
  8919. EXPECT_EQ("123456789012345678901234567890123456789012345678901234567890123456"
  8920. "7890123456789012345678901234567890",
  8921. body);
  8922. EXPECT_EQ(StatusCode::OK_200, res->status);
  8923. }
  8924. // TODO: How to enable zstd ??
  8925. TEST_F(ServerTest, MultipartFormDataZstd) {
  8926. UploadFormDataItems items = {
  8927. {"key1", "test", "", ""},
  8928. {"key2", "--abcdefg123", "", ""},
  8929. };
  8930. Headers headers;
  8931. headers.emplace("Accept-Encoding", "zstd");
  8932. cli_.set_compress(true);
  8933. auto res = cli_.Post("/compress-multipart", headers, items);
  8934. ASSERT_TRUE(res) << "Error: " << to_string(res.error());
  8935. EXPECT_EQ(StatusCode::OK_200, res->status);
  8936. }
  8937. TEST_F(ServerTest, PutWithContentProviderWithZstd) {
  8938. Headers headers;
  8939. headers.emplace("Accept-Encoding", "zstd");
  8940. cli_.set_compress(true);
  8941. auto res = cli_.Put(
  8942. "/put", headers, 3,
  8943. [](size_t /*offset*/, size_t /*length*/, DataSink &sink) {
  8944. sink.os << "PUT";
  8945. return true;
  8946. },
  8947. "text/plain");
  8948. ASSERT_TRUE(res) << "Error: " << to_string(res.error());
  8949. EXPECT_EQ(StatusCode::OK_200, res->status);
  8950. EXPECT_EQ("PUT", res->body);
  8951. }
  8952. // Pre-compression logging tests
  8953. TEST_F(ServerTest, PreCompressionLogging) {
  8954. // Test data for compression (matches the actual /compress endpoint content)
  8955. const std::string test_content =
  8956. "123456789012345678901234567890123456789012345678901234567890123456789012"
  8957. "3456789012345678901234567890";
  8958. // Variables to capture logging data
  8959. std::string pre_compression_body;
  8960. std::string pre_compression_content_type;
  8961. std::string pre_compression_content_encoding;
  8962. std::string post_compression_body;
  8963. std::string post_compression_content_type;
  8964. std::string post_compression_content_encoding;
  8965. // Set up pre-compression logger
  8966. svr_.set_pre_compression_logger([&](const Request & /*req*/,
  8967. const Response &res) {
  8968. pre_compression_body = res.body;
  8969. pre_compression_content_type = res.get_header_value("Content-Type");
  8970. pre_compression_content_encoding = res.get_header_value("Content-Encoding");
  8971. });
  8972. // Set up post-compression logger
  8973. svr_.set_logger([&](const Request & /*req*/, const Response &res) {
  8974. post_compression_body = res.body;
  8975. post_compression_content_type = res.get_header_value("Content-Type");
  8976. post_compression_content_encoding =
  8977. res.get_header_value("Content-Encoding");
  8978. });
  8979. // Test with gzip compression
  8980. Headers headers;
  8981. headers.emplace("Accept-Encoding", "gzip");
  8982. auto res = cli_.Get("/compress", headers);
  8983. // Verify response was compressed
  8984. ASSERT_TRUE(res) << "Error: " << to_string(res.error());
  8985. EXPECT_EQ(StatusCode::OK_200, res->status);
  8986. EXPECT_EQ("gzip", res->get_header_value("Content-Encoding"));
  8987. // Verify pre-compression logger captured uncompressed content
  8988. EXPECT_EQ(test_content, pre_compression_body);
  8989. EXPECT_EQ("text/plain", pre_compression_content_type);
  8990. EXPECT_TRUE(pre_compression_content_encoding
  8991. .empty()); // No encoding header before compression
  8992. // Verify post-compression logger captured compressed content
  8993. EXPECT_NE(test_content,
  8994. post_compression_body); // Should be different after compression
  8995. EXPECT_EQ("text/plain", post_compression_content_type);
  8996. EXPECT_EQ("gzip", post_compression_content_encoding);
  8997. // Verify compressed content is smaller
  8998. EXPECT_LT(post_compression_body.size(), pre_compression_body.size());
  8999. }
  9000. TEST_F(ServerTest, PreCompressionLoggingWithBrotli) {
  9001. const std::string test_content =
  9002. "123456789012345678901234567890123456789012345678901234567890123456789012"
  9003. "3456789012345678901234567890";
  9004. std::string pre_compression_body;
  9005. std::string post_compression_body;
  9006. svr_.set_pre_compression_logger(
  9007. [&](const Request & /*req*/, const Response &res) {
  9008. pre_compression_body = res.body;
  9009. });
  9010. svr_.set_logger([&](const Request & /*req*/, const Response &res) {
  9011. post_compression_body = res.body;
  9012. });
  9013. Headers headers;
  9014. headers.emplace("Accept-Encoding", "br");
  9015. auto res = cli_.Get("/compress", headers);
  9016. ASSERT_TRUE(res) << "Error: " << to_string(res.error());
  9017. EXPECT_EQ(StatusCode::OK_200, res->status);
  9018. EXPECT_EQ("br", res->get_header_value("Content-Encoding"));
  9019. // Verify pre-compression content is uncompressed
  9020. EXPECT_EQ(test_content, pre_compression_body);
  9021. // Verify post-compression content is compressed
  9022. EXPECT_NE(test_content, post_compression_body);
  9023. EXPECT_LT(post_compression_body.size(), pre_compression_body.size());
  9024. }
  9025. TEST_F(ServerTest, PreCompressionLoggingWithoutCompression) {
  9026. const std::string test_content =
  9027. "123456789012345678901234567890123456789012345678901234567890123456789012"
  9028. "3456789012345678901234567890";
  9029. std::string pre_compression_body;
  9030. std::string post_compression_body;
  9031. svr_.set_pre_compression_logger(
  9032. [&](const Request & /*req*/, const Response &res) {
  9033. pre_compression_body = res.body;
  9034. });
  9035. svr_.set_logger([&](const Request & /*req*/, const Response &res) {
  9036. post_compression_body = res.body;
  9037. });
  9038. // Request without compression (use /nocompress endpoint)
  9039. Headers headers;
  9040. auto res = cli_.Get("/nocompress", headers);
  9041. ASSERT_TRUE(res) << "Error: " << to_string(res.error());
  9042. EXPECT_EQ(StatusCode::OK_200, res->status);
  9043. EXPECT_TRUE(res->get_header_value("Content-Encoding").empty());
  9044. // Pre-compression logger should not be called when no compression is applied
  9045. EXPECT_TRUE(
  9046. pre_compression_body.empty()); // Pre-compression logger not called
  9047. EXPECT_EQ(
  9048. test_content,
  9049. post_compression_body); // Post-compression logger captures final content
  9050. }
  9051. TEST_F(ServerTest, LoggerSeesContentLength) {
  9052. size_t logged_content_length = 0;
  9053. std::string logged_content_length_header;
  9054. svr_.set_logger([&](const Request & /*req*/, const Response &res) {
  9055. logged_content_length = res.content_length_;
  9056. logged_content_length_header = res.get_header_value("Content-Length");
  9057. });
  9058. auto res = cli_.Get("/nocompress");
  9059. ASSERT_TRUE(res) << "Error: " << to_string(res.error());
  9060. EXPECT_EQ(StatusCode::OK_200, res->status);
  9061. EXPECT_EQ(res->body.size(), logged_content_length);
  9062. EXPECT_EQ(std::to_string(logged_content_length),
  9063. logged_content_length_header);
  9064. }
  9065. TEST_F(ServerTest, PreCompressionLoggingOnlyPreLogger) {
  9066. const std::string test_content =
  9067. "123456789012345678901234567890123456789012345678901234567890123456789012"
  9068. "3456789012345678901234567890";
  9069. std::string pre_compression_body;
  9070. bool pre_logger_called = false;
  9071. // Set only pre-compression logger
  9072. svr_.set_pre_compression_logger(
  9073. [&](const Request & /*req*/, const Response &res) {
  9074. pre_compression_body = res.body;
  9075. pre_logger_called = true;
  9076. });
  9077. Headers headers;
  9078. headers.emplace("Accept-Encoding", "gzip");
  9079. auto res = cli_.Get("/compress", headers);
  9080. ASSERT_TRUE(res) << "Error: " << to_string(res.error());
  9081. EXPECT_EQ(StatusCode::OK_200, res->status);
  9082. EXPECT_EQ("gzip", res->get_header_value("Content-Encoding"));
  9083. // Verify pre-compression logger was called
  9084. EXPECT_TRUE(pre_logger_called);
  9085. EXPECT_EQ(test_content, pre_compression_body);
  9086. }
  9087. TEST_F(ServerTest, SendLargeBodyAfterRequestLineError) {
  9088. {
  9089. // Test with Expect: 100-continue header - success case
  9090. // Server returns 100 Continue, client sends body, server returns 200 OK
  9091. Request req;
  9092. req.method = "POST";
  9093. req.path = "/post-large";
  9094. req.set_header("Expect", "100-continue");
  9095. req.body = LARGE_DATA;
  9096. Response res;
  9097. auto error = Error::Success;
  9098. cli_.set_keep_alive(true);
  9099. auto ret = cli_.send(req, res, error);
  9100. EXPECT_TRUE(ret);
  9101. EXPECT_EQ(StatusCode::OK_200, res.status);
  9102. EXPECT_EQ(LARGE_DATA, res.body);
  9103. }
  9104. {
  9105. // Test with Expect: 100-continue header - error case
  9106. // Client should not send the body when server returns an error
  9107. Request req;
  9108. req.method = "POST";
  9109. req.path = "/post-large?q=" + LONG_QUERY_VALUE;
  9110. req.set_header("Expect", "100-continue");
  9111. req.body = LARGE_DATA;
  9112. Response res;
  9113. auto error = Error::Success;
  9114. auto start = std::chrono::high_resolution_clock::now();
  9115. cli_.set_keep_alive(true);
  9116. auto ret = cli_.send(req, res, error);
  9117. auto end = std::chrono::high_resolution_clock::now();
  9118. auto elapsed =
  9119. std::chrono::duration_cast<std::chrono::milliseconds>(end - start)
  9120. .count();
  9121. // With Expect: 100-continue, request completes successfully but with error
  9122. EXPECT_TRUE(ret);
  9123. EXPECT_EQ(StatusCode::UriTooLong_414, res.status);
  9124. EXPECT_EQ("close", res.get_header_value("Connection"));
  9125. EXPECT_FALSE(cli_.is_socket_open());
  9126. EXPECT_LE(elapsed, 2000);
  9127. }
  9128. {
  9129. // Send an extra GET request to ensure error recovery without hanging
  9130. Request req;
  9131. req.method = "GET";
  9132. req.path = "/hi";
  9133. auto start = std::chrono::high_resolution_clock::now();
  9134. auto res = cli_.send(req);
  9135. auto end = std::chrono::high_resolution_clock::now();
  9136. auto elapsed =
  9137. std::chrono::duration_cast<std::chrono::milliseconds>(end - start)
  9138. .count();
  9139. ASSERT_TRUE(res) << "Error: " << to_string(res.error());
  9140. EXPECT_EQ(StatusCode::OK_200, res->status);
  9141. EXPECT_EQ("Hello World!", res->body);
  9142. EXPECT_LE(elapsed, 500);
  9143. }
  9144. }
  9145. TEST(ZstdDecompressor, ChunkedDecompression) {
  9146. std::string data;
  9147. for (size_t i = 0; i < 32 * 1024; ++i) {
  9148. data.push_back(static_cast<char>('a' + i % 26));
  9149. }
  9150. std::string compressed_data;
  9151. {
  9152. httplib::detail::zstd_compressor compressor;
  9153. bool result = compressor.compress(
  9154. data.data(), data.size(),
  9155. /*last=*/true,
  9156. [&](const char *compressed_data_chunk, size_t compressed_data_size) {
  9157. compressed_data.insert(compressed_data.size(), compressed_data_chunk,
  9158. compressed_data_size);
  9159. return true;
  9160. });
  9161. ASSERT_TRUE(result);
  9162. }
  9163. std::string decompressed_data;
  9164. {
  9165. httplib::detail::zstd_decompressor decompressor;
  9166. // Chunk size is chosen specifically to have a decompressed chunk size equal
  9167. // to 16384 bytes 16384 bytes is the size of decompressor output buffer
  9168. size_t chunk_size = 130;
  9169. for (size_t chunk_begin = 0; chunk_begin < compressed_data.size();
  9170. chunk_begin += chunk_size) {
  9171. size_t current_chunk_size =
  9172. std::min(compressed_data.size() - chunk_begin, chunk_size);
  9173. bool result = decompressor.decompress(
  9174. compressed_data.data() + chunk_begin, current_chunk_size,
  9175. [&](const char *decompressed_data_chunk,
  9176. size_t decompressed_data_chunk_size) {
  9177. decompressed_data.insert(decompressed_data.size(),
  9178. decompressed_data_chunk,
  9179. decompressed_data_chunk_size);
  9180. return true;
  9181. });
  9182. ASSERT_TRUE(result);
  9183. }
  9184. }
  9185. ASSERT_EQ(data, decompressed_data);
  9186. }
  9187. TEST(ZstdDecompressor, Decompress) {
  9188. std::string original_text = "Compressed with ZSTD";
  9189. unsigned char data[29] = {0x28, 0xb5, 0x2f, 0xfd, 0x20, 0x14, 0xa1, 0x00,
  9190. 0x00, 0x43, 0x6f, 0x6d, 0x70, 0x72, 0x65, 0x73,
  9191. 0x73, 0x65, 0x64, 0x20, 0x77, 0x69, 0x74, 0x68,
  9192. 0x20, 0x5a, 0x53, 0x54, 0x44};
  9193. std::string compressed_data(data, data + sizeof(data) / sizeof(data[0]));
  9194. std::string decompressed_data;
  9195. {
  9196. httplib::detail::zstd_decompressor decompressor;
  9197. bool result = decompressor.decompress(
  9198. compressed_data.data(), compressed_data.size(),
  9199. [&](const char *decompressed_data_chunk,
  9200. size_t decompressed_data_chunk_size) {
  9201. decompressed_data.insert(decompressed_data.size(),
  9202. decompressed_data_chunk,
  9203. decompressed_data_chunk_size);
  9204. return true;
  9205. });
  9206. ASSERT_TRUE(result);
  9207. }
  9208. ASSERT_EQ(original_text, decompressed_data);
  9209. }
  9210. #endif
  9211. // Sends a raw request to a server listening at HOST:PORT, writing it in
  9212. // separate chunks so that the server sees each part in its own read(). Used to
  9213. // place a read boundary at a specific offset of a request body.
  9214. static bool send_request_in_parts(time_t read_timeout_sec,
  9215. const std::vector<std::string> &parts,
  9216. std::string *resp = nullptr,
  9217. int port = PORT) {
  9218. auto error = Error::Success;
  9219. auto client_sock = detail::create_client_socket(
  9220. HOST, "", port, AF_UNSPEC, false, false, nullptr,
  9221. /*connection_timeout_sec=*/5, 0,
  9222. /*read_timeout_sec=*/5, 0,
  9223. /*write_timeout_sec=*/5, 0, std::string(), error);
  9224. if (client_sock == INVALID_SOCKET) { return false; }
  9225. auto ret = detail::process_client_socket(
  9226. client_sock, read_timeout_sec, 0, 0, 0, 0,
  9227. std::chrono::steady_clock::time_point::min(), [&](Stream &strm) {
  9228. for (size_t i = 0; i < parts.size(); i++) {
  9229. const auto &part = parts[i];
  9230. if (part.size() !=
  9231. static_cast<size_t>(strm.write(part.data(), part.size()))) {
  9232. return false;
  9233. }
  9234. if (i + 1 < parts.size()) {
  9235. std::this_thread::sleep_for(std::chrono::milliseconds(100));
  9236. }
  9237. }
  9238. char buf[512];
  9239. detail::stream_line_reader line_reader(strm, buf, sizeof(buf));
  9240. while (line_reader.getline()) {
  9241. if (resp) { *resp += line_reader.ptr(); }
  9242. }
  9243. return true;
  9244. });
  9245. detail::close_socket(client_sock);
  9246. return ret;
  9247. }
  9248. // Sends a raw request to a server listening at HOST:PORT.
  9249. static bool send_request(time_t read_timeout_sec, const std::string &req,
  9250. std::string *resp = nullptr, int port = PORT) {
  9251. return send_request_in_parts(read_timeout_sec, {req}, resp, port);
  9252. }
  9253. #ifdef CPPHTTPLIB_SSL_ENABLED
  9254. TEST(SSLClientServerTest, ReadTimeoutBoundsTheWholeHandshake) {
  9255. SSLServer svr(SERVER_CERT_FILE, SERVER_PRIVATE_KEY_FILE);
  9256. ASSERT_TRUE(svr.is_valid());
  9257. svr.set_read_timeout(1, 0);
  9258. thread t = thread([&]() { ASSERT_TRUE(svr.listen(HOST, PORT)); });
  9259. auto se = detail::scope_exit([&] {
  9260. svr.stop();
  9261. t.join();
  9262. ASSERT_FALSE(svr.is_running());
  9263. });
  9264. svr.wait_until_ready();
  9265. // The start of a TLS record, then the rest of it a byte every 100 ms, which
  9266. // keeps each wait well within the read timeout. The server gives up a
  9267. // second in, so the bytes sent after that fail.
  9268. std::vector<std::string> parts{std::string("\x16\x03\x01\x00\xff", 5)};
  9269. parts.resize(26, std::string(1, '\0'));
  9270. EXPECT_FALSE(send_request_in_parts(5, parts));
  9271. }
  9272. #endif
  9273. #ifdef CPPHTTPLIB_OPENSSL_SUPPORT
  9274. // send_request_in_parts() over TLS, each part in a TLS record of its own.
  9275. static bool send_ssl_request_in_parts(time_t read_timeout_sec,
  9276. const std::vector<std::string> &parts,
  9277. std::string *resp = nullptr,
  9278. int port = PORT) {
  9279. auto error = Error::Success;
  9280. auto sock = detail::create_client_socket(
  9281. HOST, "", port, AF_UNSPEC, false, false, nullptr,
  9282. /*connection_timeout_sec=*/5, 0, read_timeout_sec, 0,
  9283. /*write_timeout_sec=*/5, 0, std::string(), error);
  9284. if (sock == INVALID_SOCKET) { return false; }
  9285. auto sock_se = detail::scope_exit([&] { detail::close_socket(sock); });
  9286. auto ctx = SSL_CTX_new(TLS_client_method());
  9287. auto ssl = SSL_new(ctx);
  9288. auto ssl_se = detail::scope_exit([&] {
  9289. SSL_free(ssl);
  9290. SSL_CTX_free(ctx);
  9291. });
  9292. SSL_set_fd(ssl, static_cast<int>(sock));
  9293. if (SSL_connect(ssl) != 1) { return false; }
  9294. for (size_t i = 0; i < parts.size(); i++) {
  9295. const auto &part = parts[i];
  9296. if (SSL_write(ssl, part.data(), static_cast<int>(part.size())) !=
  9297. static_cast<int>(part.size())) {
  9298. return false;
  9299. }
  9300. if (i + 1 < parts.size()) {
  9301. std::this_thread::sleep_for(std::chrono::milliseconds(100));
  9302. }
  9303. }
  9304. char buf[512];
  9305. int n;
  9306. while ((n = SSL_read(ssl, buf, sizeof(buf))) > 0) {
  9307. if (resp) { resp->append(buf, static_cast<size_t>(n)); }
  9308. }
  9309. return true;
  9310. }
  9311. #endif
  9312. // The request line, then a header value a byte at a time.
  9313. static std::vector<std::string> slow_request_head_parts() {
  9314. std::vector<std::string> parts{"GET / HTTP/1.1\r\nHost: x\r\nX-Slow: "};
  9315. parts.resize(26, "a");
  9316. parts.emplace_back("\r\n\r\n");
  9317. return parts;
  9318. }
  9319. // `send` takes 2.5 seconds over slow_request_head_parts(), each wait well
  9320. // within the one-second read timeout. The server gives up a second in, before
  9321. // the head is complete.
  9322. static void
  9323. expect_slow_request_head_dropped(Server &svr,
  9324. const std::function<std::string()> &send) {
  9325. std::atomic<bool> handled(false);
  9326. svr.Get("/", [&](const Request &, Response &res) {
  9327. handled = true;
  9328. res.set_content("ok", "text/plain");
  9329. });
  9330. svr.set_read_timeout(1, 0);
  9331. thread t = thread([&]() { ASSERT_TRUE(svr.listen(HOST, PORT)); });
  9332. auto se = detail::scope_exit([&] {
  9333. svr.stop();
  9334. t.join();
  9335. ASSERT_FALSE(svr.is_running());
  9336. });
  9337. svr.wait_until_ready();
  9338. auto resp = send();
  9339. EXPECT_FALSE(handled);
  9340. EXPECT_EQ(std::string::npos, resp.find("200 OK"));
  9341. }
  9342. TEST(ServerRequestParsingTest, ReadTimeoutBoundsTheWholeRequestHead) {
  9343. Server svr;
  9344. expect_slow_request_head_dropped(svr, [] {
  9345. std::string resp;
  9346. send_request_in_parts(5, slow_request_head_parts(), &resp);
  9347. return resp;
  9348. });
  9349. }
  9350. #ifdef CPPHTTPLIB_OPENSSL_SUPPORT
  9351. TEST(SSLClientServerTest, ReadTimeoutBoundsTheWholeRequestHead) {
  9352. SSLServer svr(SERVER_CERT_FILE, SERVER_PRIVATE_KEY_FILE);
  9353. ASSERT_TRUE(svr.is_valid());
  9354. expect_slow_request_head_dropped(svr, [] {
  9355. std::string resp;
  9356. send_ssl_request_in_parts(5, slow_request_head_parts(), &resp);
  9357. return resp;
  9358. });
  9359. }
  9360. #endif
  9361. TEST(ServerRequestParsingTest, TrimWhitespaceFromHeaderValues) {
  9362. Server svr;
  9363. std::string header_value;
  9364. svr.Get("/validate-ws-in-headers", [&](const Request &req, Response &res) {
  9365. header_value = req.get_header_value("foo");
  9366. res.set_content("ok", "text/plain");
  9367. });
  9368. thread t = thread([&] { svr.listen(HOST, PORT); });
  9369. auto se = detail::scope_exit([&] {
  9370. svr.stop();
  9371. t.join();
  9372. ASSERT_FALSE(svr.is_running());
  9373. });
  9374. svr.wait_until_ready();
  9375. // Only space and horizontal tab are whitespace. Make sure other whitespace-
  9376. // like characters are not treated the same - use vertical tab and escape.
  9377. const std::string req = "GET /validate-ws-in-headers HTTP/1.1\r\n"
  9378. "foo: \t \v bar \x1B\t \r\n"
  9379. "Connection: close\r\n"
  9380. "\r\n";
  9381. std::string res;
  9382. ASSERT_TRUE(send_request(5, req, &res));
  9383. EXPECT_EQ(header_value, "");
  9384. EXPECT_EQ("HTTP/1.1 400 Bad Request", res.substr(0, 24));
  9385. }
  9386. TEST(HeadersOrderTest, ReceivedFieldsKeepTheirOrder) {
  9387. Server svr;
  9388. std::string received;
  9389. svr.Get("/order", [&](const Request &req, Response &res) {
  9390. received = entries_to_string(req.headers);
  9391. res.set_content("ok", "text/plain");
  9392. });
  9393. auto port = svr.bind_to_any_port(HOST);
  9394. thread t = thread([&] { svr.listen_after_bind(); });
  9395. auto se = detail::scope_exit([&] {
  9396. svr.stop();
  9397. t.join();
  9398. ASSERT_FALSE(svr.is_running());
  9399. });
  9400. svr.wait_until_ready();
  9401. const std::string req = "GET /order HTTP/1.1\r\n"
  9402. "Host: localhost\r\n"
  9403. "X-First: 1\r\n"
  9404. "X-Dup: a\r\n"
  9405. "X-Second: 2\r\n"
  9406. "X-Dup: b\r\n"
  9407. "Connection: close\r\n"
  9408. "\r\n";
  9409. std::string res;
  9410. ASSERT_TRUE(send_request(5, req, &res, port));
  9411. EXPECT_EQ("HTTP/1.1 200 OK", res.substr(0, 15));
  9412. EXPECT_EQ(
  9413. "Host=localhost X-First=1 X-Dup=a X-Second=2 X-Dup=b Connection=close ",
  9414. received);
  9415. }
  9416. TEST(HeadersOrderTest, SentFieldsKeepTheirOrder) {
  9417. Server svr;
  9418. svr.Get("/cookies", [](const Request & /*req*/, Response &res) {
  9419. res.set_header("Set-Cookie", "first=1");
  9420. res.set_header("X-Between", "y");
  9421. res.set_header("Set-Cookie", "second=2");
  9422. res.set_content("ok", "text/plain");
  9423. });
  9424. auto port = svr.bind_to_any_port(HOST);
  9425. thread t = thread([&] { svr.listen_after_bind(); });
  9426. auto se = detail::scope_exit([&] {
  9427. svr.stop();
  9428. t.join();
  9429. ASSERT_FALSE(svr.is_running());
  9430. });
  9431. svr.wait_until_ready();
  9432. Client cli(HOST, port);
  9433. auto res = cli.Get("/cookies");
  9434. ASSERT_TRUE(res);
  9435. EXPECT_EQ(2U, res->get_header_value_count("Set-Cookie"));
  9436. EXPECT_EQ("first=1", res->get_header_value("Set-Cookie", "", 0));
  9437. EXPECT_EQ("second=2", res->get_header_value("Set-Cookie", "", 1));
  9438. }
  9439. TEST(ServerResponseSplittingTest, ChunkedTrailerCRLFInjection) {
  9440. Server svr;
  9441. svr.Get("/injected-trailer", [&](const Request & /*req*/, Response &res) {
  9442. auto i = new int(0);
  9443. res.set_header("Trailer", "X-Safe, X-Reflected");
  9444. res.set_chunked_content_provider(
  9445. "text/plain",
  9446. [i](size_t /*offset*/, DataSink &sink) {
  9447. if (*i == 0) {
  9448. sink.os << "body";
  9449. } else {
  9450. Headers trailer;
  9451. // A valid trailer that must survive.
  9452. trailer.emplace("X-Safe", "safe");
  9453. // Attacker-controlled value carrying CR/LF (response splitting).
  9454. trailer.emplace("X-Reflected",
  9455. "legit\r\nInjected-Header: pwned\r\nX-Evil: also");
  9456. // Attacker-controlled name carrying CR/LF.
  9457. trailer.emplace("X-Bad\r\nSet-Cookie: a=1", "x");
  9458. sink.done_with_trailer(trailer);
  9459. }
  9460. (*i)++;
  9461. return true;
  9462. },
  9463. [i](bool /*success*/) { delete i; });
  9464. });
  9465. thread t = thread([&] { svr.listen(HOST, PORT); });
  9466. auto se = detail::scope_exit([&] {
  9467. svr.stop();
  9468. t.join();
  9469. ASSERT_FALSE(svr.is_running());
  9470. });
  9471. svr.wait_until_ready();
  9472. const std::string req = std::string("GET /injected-trailer HTTP/1.1\r\n") +
  9473. "Host: " + HOST +
  9474. "\r\n"
  9475. "Connection: close\r\n"
  9476. "\r\n";
  9477. std::string res;
  9478. ASSERT_TRUE(send_request(5, req, &res));
  9479. // The injected fields must not appear anywhere in the raw response.
  9480. EXPECT_EQ(std::string::npos, res.find("Injected-Header"));
  9481. EXPECT_EQ(std::string::npos, res.find("X-Evil"));
  9482. EXPECT_EQ(std::string::npos, res.find("Set-Cookie"));
  9483. // Invalid trailers are dropped entirely, matching set_header().
  9484. EXPECT_EQ(std::string::npos, res.find("X-Reflected:"));
  9485. // The valid trailer still passes through.
  9486. EXPECT_NE(std::string::npos, res.find("X-Safe: safe"));
  9487. }
  9488. TEST(ServerResponseSplittingTest, ResponseHeaderCRLFInjection) {
  9489. Server svr;
  9490. svr.Get("/injected-header", [&](const Request & /*req*/, Response &res) {
  9491. // res.headers is a public field an application can populate directly,
  9492. // bypassing set_header()'s validation (e.g. reflecting a request value).
  9493. // A valid header that must survive.
  9494. res.headers.emplace("X-Safe", "safe");
  9495. // Attacker-controlled value carrying CR/LF (response splitting).
  9496. res.headers.emplace("X-Reflected",
  9497. "legit\r\nInjected-Header: pwned\r\nX-Evil: also");
  9498. // Attacker-controlled name carrying CR/LF.
  9499. res.headers.emplace("X-Bad\r\nSet-Cookie: a=1", "x");
  9500. res.set_content("body", "text/plain");
  9501. });
  9502. thread t = thread([&] { svr.listen(HOST, PORT); });
  9503. auto se = detail::scope_exit([&] {
  9504. svr.stop();
  9505. t.join();
  9506. ASSERT_FALSE(svr.is_running());
  9507. });
  9508. svr.wait_until_ready();
  9509. const std::string req = std::string("GET /injected-header HTTP/1.1\r\n") +
  9510. "Host: " + HOST +
  9511. "\r\n"
  9512. "Connection: close\r\n"
  9513. "\r\n";
  9514. std::string res;
  9515. ASSERT_TRUE(send_request(5, req, &res));
  9516. // The injected fields must not appear anywhere in the raw response.
  9517. EXPECT_EQ(std::string::npos, res.find("Injected-Header"));
  9518. EXPECT_EQ(std::string::npos, res.find("X-Evil"));
  9519. EXPECT_EQ(std::string::npos, res.find("Set-Cookie"));
  9520. // Invalid headers are dropped entirely, matching set_header().
  9521. EXPECT_EQ(std::string::npos, res.find("X-Reflected:"));
  9522. // The valid header still passes through.
  9523. EXPECT_NE(std::string::npos, res.find("X-Safe: safe"));
  9524. }
  9525. // Forward declaration: in split builds split.py strips `inline` and moves the
  9526. // definition into httplib.cc, so detail::write_request_line is not visible from
  9527. // the public httplib.h. Re-declaring it here lets the tests link against the
  9528. // symbol in both header-only and split builds.
  9529. namespace httplib {
  9530. namespace detail {
  9531. ssize_t write_request_line(Stream &strm, const std::string &method,
  9532. const std::string &path);
  9533. } // namespace detail
  9534. } // namespace httplib
  9535. TEST(RequestLineInjectionTest, RejectsInvalidCharsInTarget) {
  9536. // A well-formed target is written verbatim.
  9537. {
  9538. detail::BufferStream strm;
  9539. auto n = detail::write_request_line(strm, "GET", "/path?a=b");
  9540. EXPECT_GT(n, 0);
  9541. EXPECT_EQ("GET /path?a=b HTTP/1.1\r\n", strm.get_buffer());
  9542. }
  9543. // A target carrying CR/LF, SP or other control octets must be rejected
  9544. // before anything reaches the wire, otherwise it splits the request line and
  9545. // injects a header or a whole request.
  9546. const std::string evil_targets[] = {
  9547. "/a\r\nInjected: pwned",
  9548. "/a\rInjected",
  9549. "/a\nInjected",
  9550. "/a\r\n\r\nGET /evil HTTP/1.1\r\nHost: victim\r\n\r\n",
  9551. "/a b",
  9552. "/a\tb",
  9553. "/a\x7f",
  9554. };
  9555. for (const auto &evil : evil_targets) {
  9556. detail::BufferStream strm;
  9557. auto n = detail::write_request_line(strm, "GET", evil);
  9558. EXPECT_LT(n, 0);
  9559. EXPECT_TRUE(strm.get_buffer().empty());
  9560. }
  9561. }
  9562. TEST(RequestLineInjectionTest, ClientRejectsCRLFTargetEndToEnd) {
  9563. // End-to-end counterpart to RejectsInvalidCharsInTarget. With path encoding
  9564. // disabled the client transmits the target verbatim, so a CR/LF-bearing
  9565. // target reaches write_request. The client must fail cleanly with
  9566. // Error::Write instead of putting a request-line-less, header-injecting
  9567. // request on the wire.
  9568. Server svr;
  9569. svr.Get("/a", [](const Request &, Response &res) {
  9570. res.set_content("ok", "text/plain");
  9571. });
  9572. auto thread = std::thread([&]() { svr.listen(HOST, PORT); });
  9573. auto se = detail::scope_exit([&] {
  9574. svr.stop();
  9575. thread.join();
  9576. ASSERT_FALSE(svr.is_running());
  9577. });
  9578. svr.wait_until_ready();
  9579. {
  9580. Client cli(HOST, PORT);
  9581. cli.set_path_encode(false);
  9582. // The request is rejected before anything is written, so the connection
  9583. // stays silent and the subsequent response read would otherwise block for
  9584. // the full default read timeout. Shorten it -- the assertion is on the
  9585. // error, not the timeout.
  9586. cli.set_read_timeout(1, 0);
  9587. auto res = cli.Get("/a\r\nInjected: pwned");
  9588. EXPECT_FALSE(res);
  9589. EXPECT_EQ(Error::Write, res.error());
  9590. }
  9591. }
  9592. TEST(RequestLineInjectionTest, RejectsNonTokenMethod) {
  9593. // Methods that are tokens (RFC 9110 Section 9.1) are written verbatim,
  9594. // including extension methods.
  9595. const std::string good_methods[] = {"GET", "PROPFIND", "M-SEARCH"};
  9596. for (const auto &method : good_methods) {
  9597. detail::BufferStream strm;
  9598. auto n = detail::write_request_line(strm, method, "/");
  9599. EXPECT_GT(n, 0);
  9600. EXPECT_EQ(method + " / HTTP/1.1\r\n", strm.get_buffer());
  9601. }
  9602. // A method carrying CR/LF would split the request line and smuggle a whole
  9603. // request ahead of the real one. A space or an empty method corrupts the
  9604. // request line. All must be rejected before anything reaches the wire.
  9605. const std::string evil_methods[] = {
  9606. "GET /smuggled HTTP/1.1\r\nHost: x\r\n\r\nGET",
  9607. "GET\r\nInjected: pwned",
  9608. "GET\r",
  9609. "GET\n",
  9610. "GE T",
  9611. "",
  9612. };
  9613. for (const auto &evil : evil_methods) {
  9614. detail::BufferStream strm;
  9615. auto n = detail::write_request_line(strm, evil, "/");
  9616. EXPECT_LT(n, 0);
  9617. EXPECT_TRUE(strm.get_buffer().empty());
  9618. }
  9619. }
  9620. TEST(RequestLineInjectionTest, ClientRejectsNonTokenMethodEndToEnd) {
  9621. // End-to-end counterpart to RejectsNonTokenMethod: a smuggling method passed
  9622. // through Client::send must fail with Error::Write and no request, neither
  9623. // the smuggled one nor the real one, may reach the server.
  9624. Server svr;
  9625. std::atomic<int> request_count(0);
  9626. svr.set_pre_routing_handler([&](const Request &, Response &res) {
  9627. request_count++;
  9628. res.status = StatusCode::OK_200;
  9629. return Server::HandlerResponse::Handled;
  9630. });
  9631. auto port = svr.bind_to_any_port(HOST);
  9632. auto thread = std::thread([&]() { svr.listen_after_bind(); });
  9633. auto se = detail::scope_exit([&] {
  9634. svr.stop();
  9635. thread.join();
  9636. ASSERT_FALSE(svr.is_running());
  9637. });
  9638. svr.wait_until_ready();
  9639. {
  9640. Client cli(HOST, port);
  9641. const std::string evil_methods[] = {
  9642. "GET /smuggled HTTP/1.1\r\nHost: x\r\n\r\nGET",
  9643. "GE T",
  9644. "",
  9645. };
  9646. for (const auto &evil : evil_methods) {
  9647. Request req;
  9648. req.method = evil;
  9649. req.path = "/";
  9650. auto res = cli.send(req);
  9651. EXPECT_FALSE(res);
  9652. EXPECT_EQ(Error::Write, res.error());
  9653. }
  9654. auto handle =
  9655. cli.open_stream("GET /smuggled HTTP/1.1\r\nHost: x\r\n\r\nGET", "/");
  9656. EXPECT_FALSE(handle.is_valid());
  9657. EXPECT_EQ(Error::Write, handle.error);
  9658. // A valid request on the same client still goes through.
  9659. auto res = cli.Get("/");
  9660. ASSERT_TRUE(res);
  9661. EXPECT_EQ(StatusCode::OK_200, res->status);
  9662. }
  9663. EXPECT_EQ(1, request_count.load());
  9664. }
  9665. // Sends a raw request and verifies that there isn't a crash or exception.
  9666. static void test_raw_request(const std::string &req,
  9667. std::string *out = nullptr) {
  9668. Server svr;
  9669. svr.Get("/hi", [&](const Request & /*req*/, Response &res) {
  9670. res.set_content("ok", "text/plain");
  9671. });
  9672. svr.Put("/put_hi", [&](const Request & /*req*/, Response &res) {
  9673. res.set_content("ok", "text/plain");
  9674. });
  9675. svr.Get("/header_field_value_check",
  9676. [&](const Request & /*req*/, Response &res) {
  9677. res.set_content("ok", "text/plain");
  9678. });
  9679. svr.CustomRoute("PROPFIND", "/dav",
  9680. [&](const Request & /*req*/, Response &res) {
  9681. res.status = StatusCode::MultiStatus_207;
  9682. });
  9683. // Server read timeout must be longer than the client read timeout for the
  9684. // bug to reproduce, probably to force the server to process a request
  9685. // without a trailing blank line.
  9686. const time_t client_read_timeout_sec = 1;
  9687. svr.set_read_timeout(std::chrono::seconds(client_read_timeout_sec + 1));
  9688. bool listen_thread_ok = false;
  9689. thread t = thread([&] { listen_thread_ok = svr.listen(HOST, PORT); });
  9690. auto se = detail::scope_exit([&] {
  9691. svr.stop();
  9692. t.join();
  9693. ASSERT_FALSE(svr.is_running());
  9694. EXPECT_TRUE(listen_thread_ok);
  9695. });
  9696. svr.wait_until_ready();
  9697. ASSERT_TRUE(send_request(client_read_timeout_sec, req, out));
  9698. }
  9699. TEST(ServerRequestParsingTest, ReadHeadersRegexComplexity) {
  9700. // A certain header line causes an exception if the header property is parsed
  9701. // naively with a single regex. This occurs with libc++ but not libstdc++.
  9702. test_raw_request(
  9703. "GET /hi HTTP/1.1\r\n"
  9704. " : "
  9705. " "
  9706. " ");
  9707. }
  9708. TEST(ServerRequestParsingTest, ReadHeadersRegexComplexity2) {
  9709. // A certain header line causes an exception if the header property *name* is
  9710. // parsed with a regular expression starting with "(.+?):" - this is a non-
  9711. // greedy matcher and requires backtracking when there are a lot of ":"
  9712. // characters.
  9713. // This occurs with libc++ but not libstdc++.
  9714. test_raw_request(
  9715. "GET /hi HTTP/1.1\r\n"
  9716. ":-:::::::::::::::::::::::::::-::::::::::::::::::::::::@-&&&&&&&&&&&"
  9717. "--:::::::-:::::::::::::::::::::::::::::-:::::::::::::::::@-&&&&&&&&"
  9718. "&&&--:::::::-:::::::::::::::::::::::::::::-:::::::::::::::::@-:::::"
  9719. "::-:::::::::::::::::@-&&&&&&&&&&&--:::::::-::::::::::::::::::::::::"
  9720. ":::::-:::::::::::::::::@-&&&&&&&&&&&--:::::::-:::::::::::::::::::::"
  9721. "::::::::-:::::::::::::::::@-&&&&&&&--:::::::-::::::::::::::::::::::"
  9722. ":::::::-:::::::::::::::::@-&&&&&&&&&&&--:::::::-:::::::::::::::::::"
  9723. "::::::::::-:::::::::::::::::@-&&&&&::::::::::::-:::::::::::::::::@-"
  9724. "&&&&&&&&&&&--:::::::-:::::::::::::::::::::::::::::-::::::::::::::::"
  9725. ":@-&&&&&&&&&&&--:::::::-:::::::::::::::::::::::::::::-:::::::::::::"
  9726. "::::@-&&&&&&&&&&&--:::::::-:::::::::::::::::::::::::::::-::::::@-&&"
  9727. "&&&&&&&&&--:::::::-:::::::::::::::::::::::::::::-:::::::::::::::::@"
  9728. "::::::-:::::::::::::::::::::::::::::-:::::::::::::::::@-&&&&&&&&&&&"
  9729. "--:::::::-:::::::::::::::::::::::::::::-:::::::::::::::::@-&&&&&&&&"
  9730. "&&&--:::::::-:::::::::::::::::::::::::::::-:::::::::::::::::@-&&&&&"
  9731. "&&&&&&--:::::::-:::::::::::::::::::::::::::::-:::::::::::::::::@-&&"
  9732. "&&&&&&&&&--:::::::-:::::::::::::::::::::::::::::-:::::::::::::::::@"
  9733. "-&&&&&&&&&&&--:::::::-:::::::::::::::::::::::::::::-:::::::::::::::"
  9734. "::@-&&&&&&&&&&&--:::::::-:::::::::::::::::::::::::::::-::::::::::::"
  9735. ":::::@-&&&&&&&&&&&::-:::::::::::::::::@-&&&&&&&&&&&--:::::::-::::::"
  9736. ":::::::::::::::::::::::-:::::::::::::::::@-&&&&&&&&&&&--:::::::-:::"
  9737. "::::::::::::::::::::::::::-:::::::::::::::::@-&&&&&&&&&&&--:::::::-"
  9738. ":::::::::::::::::::::::::::::-:::::::::::::::::@-&&&&&&&&&&&---&&:&"
  9739. "&&.0------------:-:::::::::::::::::::::::::::::-:::::::::::::::::@-"
  9740. "&&&&&&&&&&&--:::::::-:::::::::::::::::::::::::::::-::::::::::::::::"
  9741. ":@-&&&&&&&&&&&--:::::::-:::::::::::::::::::::::::::::-:::::::::::::"
  9742. "::::@-&&&&&&&&&&&---&&:&&&.0------------O--------\rH PUTHTTP/1.1\r\n"
  9743. "&&&%%%");
  9744. }
  9745. TEST(ServerRequestParsingTest, ExcessiveWhitespaceInUnparsableHeaderLine) {
  9746. // Make sure this doesn't crash the server.
  9747. // In a previous version of the header line regex, the "\r" rendered the line
  9748. // unparsable and the regex engine repeatedly backtracked, trying to look for
  9749. // a new position where the leading white space ended and the field value
  9750. // began.
  9751. // The crash occurs with libc++ but not libstdc++.
  9752. test_raw_request("GET /hi HTTP/1.1\r\n"
  9753. "a:" +
  9754. std::string(2000, ' ') + '\r' + std::string(20, 'z') +
  9755. "\r\n"
  9756. "\r\n");
  9757. }
  9758. TEST(ServerRequestParsingTest, StrictRequestLine) {
  9759. const char *rejected[] = {
  9760. // RFC 9112 §3: one SP between the parts, and nothing else
  9761. "GET /hi HTTP/1.1\r\nHost: localhost\r\n\r\n",
  9762. "GET\t/hi HTTP/1.1\r\nHost: localhost\r\n\r\n",
  9763. "GET /hi\tHTTP/1.1\r\nHost: localhost\r\n\r\n",
  9764. "GET /hi HTTP/1.1 \r\nHost: localhost\r\n\r\n",
  9765. // A request-target has no fragment
  9766. "GET /hi#x HTTP/1.1\r\nHost: localhost\r\n\r\n",
  9767. // An HTTP/1.1 request needs a Host
  9768. "GET /hi HTTP/1.1\r\n\r\n",
  9769. };
  9770. for (auto request : rejected) {
  9771. std::string out;
  9772. test_raw_request(request, &out);
  9773. EXPECT_EQ("HTTP/1.1 400 Bad Request", out.substr(0, 24)) << request;
  9774. }
  9775. std::string out;
  9776. test_raw_request("GET /hi HTTP/1.0\r\n\r\n", &out);
  9777. EXPECT_EQ("HTTP/1.1 200 OK", out.substr(0, 15));
  9778. }
  9779. TEST(ServerRequestParsingTest, AmbiguousTransferEncodingClosesConnection) {
  9780. // RFC 9112 §6.1
  9781. const char *requests[] = {
  9782. "PUT /put_hi HTTP/1.1\r\n"
  9783. "Host: localhost\r\n"
  9784. "Content-Length: 0\r\n"
  9785. "Transfer-Encoding: chunked\r\n"
  9786. "\r\n"
  9787. "0\r\n\r\n",
  9788. "PUT /put_hi HTTP/1.0\r\n"
  9789. "Connection: keep-alive\r\n"
  9790. "Transfer-Encoding: chunked\r\n"
  9791. "\r\n"
  9792. "0\r\n\r\n",
  9793. };
  9794. for (auto request : requests) {
  9795. std::string out;
  9796. test_raw_request(request, &out);
  9797. EXPECT_EQ("HTTP/1.1 200 OK", out.substr(0, 15)) << request;
  9798. EXPECT_NE(std::string::npos, out.find("Connection: close")) << request;
  9799. }
  9800. }
  9801. TEST(ServerRequestParsingTest, InvalidFirstChunkLengthInRequest) {
  9802. std::string out;
  9803. test_raw_request("PUT /put_hi HTTP/1.1\r\n"
  9804. "Content-Type: text/plain\r\n"
  9805. "Transfer-Encoding: chunked\r\n"
  9806. "\r\n"
  9807. "nothex\r\n",
  9808. &out);
  9809. EXPECT_EQ("HTTP/1.1 400 Bad Request", out.substr(0, 24));
  9810. }
  9811. TEST(ServerRequestParsingTest, InvalidSecondChunkLengthInRequest) {
  9812. std::string out;
  9813. test_raw_request("PUT /put_hi HTTP/1.1\r\n"
  9814. "Content-Type: text/plain\r\n"
  9815. "Transfer-Encoding: chunked\r\n"
  9816. "\r\n"
  9817. "3\r\n"
  9818. "xyz\r\n"
  9819. "NaN\r\n",
  9820. &out);
  9821. EXPECT_EQ("HTTP/1.1 400 Bad Request", out.substr(0, 24));
  9822. }
  9823. TEST(ServerRequestParsingTest, ChunkLengthTooHighInRequest) {
  9824. std::string out;
  9825. test_raw_request("PUT /put_hi HTTP/1.1\r\n"
  9826. "Content-Type: text/plain\r\n"
  9827. "Transfer-Encoding: chunked\r\n"
  9828. "\r\n"
  9829. // Length is too large for 64 bits.
  9830. "1ffffffffffffffff\r\n"
  9831. "xyz\r\n",
  9832. &out);
  9833. EXPECT_EQ("HTTP/1.1 400 Bad Request", out.substr(0, 24));
  9834. }
  9835. TEST(ServerRequestParsingTest, InvalidHeaderTextWithExtraCR) {
  9836. test_raw_request("GET /hi HTTP/1.1\r\n"
  9837. "Content-Type: text/plain\r\n\r");
  9838. }
  9839. TEST(ServerRequestParsingTest, InvalidSpaceInURL) {
  9840. std::string out;
  9841. test_raw_request("GET /h i HTTP/1.1\r\n\r\n", &out);
  9842. EXPECT_EQ("HTTP/1.1 400 Bad Request", out.substr(0, 24));
  9843. }
  9844. TEST(ServerRequestParsingTest, InvalidControlCharInURL) {
  9845. for (auto target : {"/h\ri", "/h\x7fi"}) {
  9846. std::string out;
  9847. test_raw_request(std::string("GET ") + target + " HTTP/1.1\r\n\r\n", &out);
  9848. EXPECT_EQ("HTTP/1.1 400 Bad Request", out.substr(0, 24)) << target;
  9849. }
  9850. }
  9851. TEST(ServerRequestParsingTest, NonAsciiInURLAccepted) {
  9852. std::string out;
  9853. test_raw_request("GET /hi?q=\xE3\x81\x82 HTTP/1.1\r\n"
  9854. "Host: localhost\r\n"
  9855. "Connection: close\r\n\r\n",
  9856. &out);
  9857. EXPECT_EQ("HTTP/1.1 200 OK", out.substr(0, 15));
  9858. }
  9859. TEST(ServerRequestParsingTest, RemoteAddrSetOnBadRequest) {
  9860. Server svr;
  9861. svr.set_error_handler([&](const Request &req, Response & /*res*/) {
  9862. EXPECT_TRUE(!req.remote_addr.empty());
  9863. });
  9864. thread t = thread([&] { svr.listen(HOST, PORT); });
  9865. auto se = detail::scope_exit([&] {
  9866. svr.stop();
  9867. t.join();
  9868. ASSERT_FALSE(svr.is_running());
  9869. });
  9870. svr.wait_until_ready();
  9871. // Send an invalid request line to trigger Bad Request
  9872. const std::string bad_req = "BADMETHOD / HTTP/1.1\r\nHost: localhost\r\n\r\n";
  9873. std::string out;
  9874. ASSERT_TRUE(send_request(5, bad_req, &out));
  9875. EXPECT_EQ("HTTP/1.1 400 Bad Request", out.substr(0, 24));
  9876. }
  9877. // A custom method with neither Content-Length nor Transfer-Encoding must be
  9878. // answered right away rather than blocking on a read that waits for EOF.
  9879. TEST(ServerRequestParsingTest, CustomMethodWithoutFraming) {
  9880. std::string out;
  9881. test_raw_request("PROPFIND /dav HTTP/1.1\r\nHost: localhost\r\n\r\n", &out);
  9882. EXPECT_EQ("HTTP/1.1 207 Multi-Status", out.substr(0, 25));
  9883. }
  9884. TEST(CustomRouteRegistrationTest, RejectsBuiltInMethods) {
  9885. const char *methods[] = {"GET", "HEAD", "POST", "PUT", "DELETE",
  9886. "CONNECT", "OPTIONS", "TRACE", "PATCH", "PRI"};
  9887. for (const auto *method : methods) {
  9888. Server svr;
  9889. svr.CustomRoute(method, "/x", [](const Request &, Response &) {});
  9890. EXPECT_FALSE(svr.is_valid()) << method;
  9891. EXPECT_FALSE(svr.listen(HOST, PORT)) << method;
  9892. }
  9893. }
  9894. TEST(CustomRouteRegistrationTest, RejectsNonTokenMethods) {
  9895. const char *methods[] = {"", "PRO PFIND", "PROP\tFIND", "PROP/FIND",
  9896. "PROP,FIND", "PROP:FIND", "PROP(FIND)", "\x01FIND"};
  9897. for (const auto *method : methods) {
  9898. Server svr;
  9899. svr.CustomRoute(method, "/x", [](const Request &, Response &) {});
  9900. EXPECT_FALSE(svr.is_valid()) << method;
  9901. }
  9902. }
  9903. TEST(CustomRouteRegistrationTest, AcceptsWebDavAndUpnpMethods) {
  9904. const char *methods[] = {"PROPFIND", "PROPPATCH", "MKCOL",
  9905. "COPY", "MOVE", "LOCK",
  9906. "UNLOCK", "REPORT", "SUBSCRIBE"};
  9907. Server svr;
  9908. for (const auto *method : methods) {
  9909. svr.CustomRoute(method, "/x", [](const Request &, Response &) {});
  9910. }
  9911. EXPECT_TRUE(svr.is_valid());
  9912. }
  9913. TEST(CustomRouteRegistrationTest, ContentReaderOverloadRejectsBuiltInMethods) {
  9914. Server svr;
  9915. svr.CustomRoute("POST", "/x",
  9916. [](const Request &, Response &, const ContentReader &) {});
  9917. EXPECT_FALSE(svr.is_valid());
  9918. }
  9919. TEST(CustomRouteRegistrationTest, RejectionIsSticky) {
  9920. Server svr;
  9921. svr.CustomRoute("PROPFIND", "/a", [](const Request &, Response &) {});
  9922. svr.CustomRoute("GET", "/b", [](const Request &, Response &) {});
  9923. svr.CustomRoute("MKCOL", "/c", [](const Request &, Response &) {});
  9924. EXPECT_FALSE(svr.is_valid());
  9925. }
  9926. TEST(CustomRouteRegistrationTest, ReportsRejectionToErrorLogger) {
  9927. Server svr;
  9928. auto captured = Error::Success;
  9929. svr.set_error_logger(
  9930. [&](const Error &err, const Request * /*req*/) { captured = err; });
  9931. svr.CustomRoute("POST", "/x", [](const Request &, Response &) {});
  9932. EXPECT_EQ(Error::InvalidHTTPMethod, captured);
  9933. }
  9934. TEST(ServerRequestParsingTest, InvalidFieldValueContains_CR_LF_NUL) {
  9935. std::string out;
  9936. std::string request(
  9937. "GET /header_field_value_check HTTP/1.1\r\nTest: [\r\x00\n]\r\n\r\n", 55);
  9938. test_raw_request(request, &out);
  9939. EXPECT_EQ("HTTP/1.1 400 Bad Request", out.substr(0, 24));
  9940. }
  9941. TEST(ServerRequestParsingTest, InvalidFieldValueContains_LF) {
  9942. std::string out;
  9943. std::string request(
  9944. "GET /header_field_value_check HTTP/1.1\r\nTest: [\n\n\n]\r\n\r\n", 55);
  9945. test_raw_request(request, &out);
  9946. EXPECT_EQ("HTTP/1.1 400 Bad Request", out.substr(0, 24));
  9947. }
  9948. TEST(ServerRequestParsingTest, InvalidFieldNameContains_PreceedingSpaces) {
  9949. std::string out;
  9950. std::string request(
  9951. "GET /header_field_value_check HTTP/1.1\r\n Test: val\r\n\r\n", 55);
  9952. test_raw_request(request, &out);
  9953. EXPECT_EQ("HTTP/1.1 400 Bad Request", out.substr(0, 24));
  9954. }
  9955. TEST(ServerRequestParsingTest, EmptyFieldValue) {
  9956. std::string out;
  9957. test_raw_request("GET /header_field_value_check HTTP/1.1\r\n"
  9958. "Host: localhost\r\n"
  9959. "Test: \r\n\r\n",
  9960. &out);
  9961. EXPECT_EQ("HTTP/1.1 200 OK", out.substr(0, 15));
  9962. }
  9963. TEST(ServerRequestParsingTest, HeaderValueNotPercentDecoded) {
  9964. Server svr;
  9965. std::string x_custom;
  9966. std::string cookie;
  9967. std::string xff;
  9968. std::string x_unicode;
  9969. std::string x_iis;
  9970. svr.Get("/check", [&](const Request &req, Response &res) {
  9971. x_custom = req.get_header_value("X-Custom");
  9972. cookie = req.get_header_value("Cookie");
  9973. xff = req.get_header_value("X-Forwarded-For");
  9974. x_unicode = req.get_header_value("X-Unicode");
  9975. x_iis = req.get_header_value("X-IIS");
  9976. res.set_content("ok", "text/plain");
  9977. });
  9978. thread t = thread([&] { svr.listen(HOST, PORT); });
  9979. auto se = detail::scope_exit([&] {
  9980. svr.stop();
  9981. t.join();
  9982. ASSERT_FALSE(svr.is_running());
  9983. });
  9984. svr.wait_until_ready();
  9985. const std::string req = "GET /check HTTP/1.1\r\n"
  9986. "Host: localhost\r\n"
  9987. "X-Custom: a%0D%0AInjected: b\r\n"
  9988. "Cookie: session%3Dvictim%3B%20admin%3Dyes\r\n"
  9989. "X-Forwarded-For: 1.2.3.4%2C5.6.7.8\r\n"
  9990. "X-Unicode: %E3%81%82\r\n"
  9991. "X-IIS: %u00E9\r\n"
  9992. "Connection: close\r\n"
  9993. "\r\n";
  9994. std::string res;
  9995. ASSERT_TRUE(send_request(5, req, &res));
  9996. EXPECT_EQ("HTTP/1.1 200 OK", res.substr(0, 15));
  9997. // Every value must be returned verbatim (wire form), with no decoding.
  9998. EXPECT_EQ("a%0D%0AInjected: b", x_custom);
  9999. EXPECT_EQ("session%3Dvictim%3B%20admin%3Dyes", cookie);
  10000. EXPECT_EQ("1.2.3.4%2C5.6.7.8", xff);
  10001. EXPECT_EQ("%E3%81%82", x_unicode);
  10002. EXPECT_EQ("%u00E9", x_iis);
  10003. }
  10004. // Applications that previously relied on automatic percent-decoding can
  10005. // reproduce the old behavior by explicitly calling decode_path_component()
  10006. // or, for RFC 3986 conformance, decode_uri_component().
  10007. TEST(ServerRequestParsingTest, HeaderValueExplicitDecodingByApplication) {
  10008. Server svr;
  10009. std::string decoded;
  10010. svr.Get("/check", [&](const Request &req, Response &res) {
  10011. decoded = decode_uri_component(req.get_header_value("X-Custom"));
  10012. res.set_content("ok", "text/plain");
  10013. });
  10014. thread t = thread([&] { svr.listen(HOST, PORT); });
  10015. auto se = detail::scope_exit([&] {
  10016. svr.stop();
  10017. t.join();
  10018. ASSERT_FALSE(svr.is_running());
  10019. });
  10020. svr.wait_until_ready();
  10021. const std::string req = "GET /check HTTP/1.1\r\n"
  10022. "Host: localhost\r\n"
  10023. "X-Custom: hello%20world\r\n"
  10024. "Connection: close\r\n"
  10025. "\r\n";
  10026. std::string res;
  10027. ASSERT_TRUE(send_request(5, req, &res));
  10028. EXPECT_EQ("HTTP/1.1 200 OK", res.substr(0, 15));
  10029. EXPECT_EQ("hello world", decoded);
  10030. }
  10031. // Regression test for #2033. Browsers send Referer values that include
  10032. // percent-encoded characters such as %0A inside the URL. Decoding the
  10033. // header value would either trip the post-decode CR/LF/NUL guard (the
  10034. // original bug, returning 400) or, after that guard was relaxed, silently
  10035. // store a literal LF — both unacceptable. The wire form must round-trip.
  10036. TEST(ServerRequestParsingTest, RefererWithPercentEncodedNewline) {
  10037. Server svr;
  10038. std::string referer;
  10039. svr.Get("/check", [&](const Request &req, Response &res) {
  10040. referer = req.get_header_value("Referer");
  10041. res.set_content("ok", "text/plain");
  10042. });
  10043. thread t = thread([&] { svr.listen(HOST, PORT); });
  10044. auto se = detail::scope_exit([&] {
  10045. svr.stop();
  10046. t.join();
  10047. ASSERT_FALSE(svr.is_running());
  10048. });
  10049. svr.wait_until_ready();
  10050. const std::string req = "GET /check HTTP/1.1\r\n"
  10051. "Host: localhost\r\n"
  10052. "Referer: http://localhost:1111/?q=Hello%0A\r\n"
  10053. "Connection: close\r\n"
  10054. "\r\n";
  10055. std::string res;
  10056. ASSERT_TRUE(send_request(5, req, &res));
  10057. EXPECT_EQ("HTTP/1.1 200 OK", res.substr(0, 15));
  10058. EXPECT_EQ("http://localhost:1111/?q=Hello%0A", referer);
  10059. }
  10060. TEST(ServerStopTest, StopServerWithChunkedTransmission) {
  10061. Server svr;
  10062. svr.Get("/events", [](const Request & /*req*/, Response &res) {
  10063. res.set_header("Cache-Control", "no-cache");
  10064. res.set_chunked_content_provider(
  10065. "text/event-stream", [](size_t offset, DataSink &sink) {
  10066. std::string s = "data:";
  10067. s += std::to_string(offset);
  10068. s += "\n\n";
  10069. auto ret = sink.write(s.data(), s.size());
  10070. EXPECT_TRUE(ret);
  10071. std::this_thread::sleep_for(std::chrono::seconds(1));
  10072. return true;
  10073. });
  10074. });
  10075. auto listen_thread = std::thread([&svr]() { svr.listen("localhost", PORT); });
  10076. svr.wait_until_ready();
  10077. Client client(HOST, PORT);
  10078. const Headers headers = {{"Accept", "text/event-stream"}};
  10079. auto get_thread = std::thread([&client, &headers]() {
  10080. auto res = client.Get(
  10081. "/events", headers,
  10082. [](const char * /*data*/, size_t /*len*/) -> bool { return true; });
  10083. });
  10084. auto se = detail::scope_exit([&] {
  10085. svr.stop();
  10086. get_thread.join();
  10087. listen_thread.join();
  10088. ASSERT_FALSE(svr.is_running());
  10089. });
  10090. // Give GET time to get a few messages.
  10091. std::this_thread::sleep_for(std::chrono::seconds(2));
  10092. }
  10093. TEST(ServerStopTest, ClientAccessAfterServerDown) {
  10094. httplib::Server svr;
  10095. svr.Post("/hi",
  10096. [&](const httplib::Request & /*req*/, httplib::Response &res) {
  10097. res.status = StatusCode::OK_200;
  10098. });
  10099. auto thread = std::thread([&]() { svr.listen(HOST, PORT); });
  10100. svr.wait_until_ready();
  10101. Client cli(HOST, PORT);
  10102. auto res = cli.Post("/hi", "data", "text/plain");
  10103. ASSERT_TRUE(res) << "Error: " << to_string(res.error());
  10104. EXPECT_EQ(StatusCode::OK_200, res->status);
  10105. svr.stop();
  10106. thread.join();
  10107. ASSERT_FALSE(svr.is_running());
  10108. res = cli.Post("/hi", "data", "text/plain");
  10109. ASSERT_FALSE(res);
  10110. }
  10111. TEST(ServerStopTest, ListenFailure) {
  10112. Server svr;
  10113. auto t = thread([&]() {
  10114. auto ret = svr.listen("????", PORT);
  10115. EXPECT_FALSE(ret);
  10116. });
  10117. svr.wait_until_ready();
  10118. svr.stop();
  10119. t.join();
  10120. }
  10121. #ifndef CPPHTTPLIB_NO_EXCEPTIONS
  10122. TEST(ServerStopTest, Decommision) {
  10123. Server svr;
  10124. svr.Get("/hi", [&](const Request &, Response &res) { res.body = "hi..."; });
  10125. for (int i = 0; i < 4; i++) {
  10126. auto is_even = !(i % 2);
  10127. std::thread t{[&] {
  10128. try {
  10129. std::this_thread::sleep_for(std::chrono::milliseconds(100));
  10130. if (is_even) {
  10131. throw std::runtime_error("Some thing that happens to go wrong.");
  10132. }
  10133. svr.listen(HOST, PORT);
  10134. } catch (...) { svr.decommission(); }
  10135. }};
  10136. svr.wait_until_ready();
  10137. // Server is up
  10138. {
  10139. Client cli(HOST, PORT);
  10140. auto res = cli.Get("/hi");
  10141. if (is_even) {
  10142. EXPECT_FALSE(res);
  10143. } else {
  10144. EXPECT_TRUE(res);
  10145. EXPECT_EQ("hi...", res->body);
  10146. }
  10147. }
  10148. svr.stop();
  10149. t.join();
  10150. // Server is down...
  10151. {
  10152. Client cli(HOST, PORT);
  10153. auto res = cli.Get("/hi");
  10154. EXPECT_FALSE(res);
  10155. }
  10156. }
  10157. }
  10158. #endif
  10159. // Helper function for string body upload progress tests
  10160. template <typename SetupHandler, typename ClientCall>
  10161. void TestStringBodyUploadProgress(SetupHandler &&setup_handler,
  10162. ClientCall &&client_call,
  10163. const string &body) {
  10164. Server svr;
  10165. setup_handler(svr);
  10166. thread t = thread([&]() { svr.listen(HOST, PORT); });
  10167. auto se = detail::scope_exit([&] {
  10168. svr.stop();
  10169. t.join();
  10170. });
  10171. svr.wait_until_ready();
  10172. Client cli(HOST, PORT);
  10173. vector<uint64_t> progress_values;
  10174. bool progress_called = false;
  10175. auto res =
  10176. client_call(cli, body, [&](uint64_t current, uint64_t /*total*/) -> bool {
  10177. progress_values.push_back(current);
  10178. progress_called = true;
  10179. return true;
  10180. });
  10181. ASSERT_TRUE(res) << "Error: " << to_string(res.error());
  10182. EXPECT_EQ(200, res->status);
  10183. EXPECT_TRUE(progress_called);
  10184. }
  10185. TEST(UploadProgressTest, PostStringBodyBasic) {
  10186. TestStringBodyUploadProgress(
  10187. [](Server &svr) {
  10188. svr.Post("/test", [](const Request & /*req*/, Response &res) {
  10189. res.set_content("received", "text/plain");
  10190. });
  10191. },
  10192. [](Client &cli, const string &body, UploadProgress progress_callback) {
  10193. return cli.Post("/test", body, "text/plain", progress_callback);
  10194. },
  10195. "test data for upload progress");
  10196. }
  10197. TEST(UploadProgressTest, PutStringBodyBasic) {
  10198. TestStringBodyUploadProgress(
  10199. [](Server &svr) {
  10200. svr.Put("/test", [](const Request & /*req*/, Response &res) {
  10201. res.set_content("put received", "text/plain");
  10202. });
  10203. },
  10204. [](Client &cli, const string &body, UploadProgress progress_callback) {
  10205. return cli.Put("/test", body, "text/plain", progress_callback);
  10206. },
  10207. "put test data for upload progress");
  10208. }
  10209. TEST(UploadProgressTest, PatchStringBodyBasic) {
  10210. TestStringBodyUploadProgress(
  10211. [](Server &svr) {
  10212. svr.Patch("/test", [](const Request & /*req*/, Response &res) {
  10213. res.set_content("patch received", "text/plain");
  10214. });
  10215. },
  10216. [](Client &cli, const string &body, UploadProgress progress_callback) {
  10217. return cli.Patch("/test", body, "text/plain", progress_callback);
  10218. },
  10219. "patch test data for upload progress");
  10220. }
  10221. // Helper function for content provider upload progress tests
  10222. template <typename SetupHandler, typename ClientCall>
  10223. void TestContentProviderUploadProgress(SetupHandler &&setup_handler,
  10224. ClientCall &&client_call) {
  10225. Server svr;
  10226. setup_handler(svr);
  10227. thread t = thread([&]() { svr.listen(HOST, PORT); });
  10228. auto se = detail::scope_exit([&] {
  10229. svr.stop();
  10230. t.join();
  10231. });
  10232. svr.wait_until_ready();
  10233. Client cli(HOST, PORT);
  10234. vector<uint64_t> progress_values;
  10235. auto res =
  10236. client_call(cli, [&](uint64_t current, uint64_t /*total*/) -> bool {
  10237. progress_values.push_back(current);
  10238. return true;
  10239. });
  10240. ASSERT_TRUE(res) << "Error: " << to_string(res.error());
  10241. EXPECT_EQ(200, res->status);
  10242. EXPECT_FALSE(progress_values.empty());
  10243. }
  10244. TEST(UploadProgressTest, PostContentProviderProgress) {
  10245. TestContentProviderUploadProgress(
  10246. [](Server &svr) {
  10247. svr.Post("/test", [](const Request & /*req*/, Response &res) {
  10248. res.set_content("provider received", "text/plain");
  10249. });
  10250. },
  10251. [](Client &cli, UploadProgress progress_callback) {
  10252. return cli.Post(
  10253. "/test", 9,
  10254. [](size_t /*offset*/, size_t /*length*/, DataSink &sink) -> bool {
  10255. sink.os << "test data";
  10256. return true;
  10257. },
  10258. "text/plain", progress_callback);
  10259. });
  10260. }
  10261. // Helper function for multipart upload progress tests
  10262. template <typename SetupHandler, typename ClientCall>
  10263. void TestMultipartUploadProgress(SetupHandler &&setup_handler,
  10264. ClientCall &&client_call,
  10265. const string &endpoint) {
  10266. Server svr;
  10267. setup_handler(svr);
  10268. thread t = thread([&]() { svr.listen(HOST, PORT); });
  10269. auto se = detail::scope_exit([&] {
  10270. svr.stop();
  10271. t.join();
  10272. });
  10273. svr.wait_until_ready();
  10274. Client cli(HOST, PORT);
  10275. vector<uint64_t> progress_values;
  10276. UploadFormDataItems items = {
  10277. {"field1", "value1", "", ""},
  10278. {"field2", "longer value for progress tracking test", "", ""},
  10279. {"file1", "file content data for upload progress", "test.txt",
  10280. "text/plain"}};
  10281. auto res = client_call(cli, endpoint, items,
  10282. [&](uint64_t current, uint64_t /*total*/) -> bool {
  10283. progress_values.push_back(current);
  10284. return true;
  10285. });
  10286. ASSERT_TRUE(res) << "Error: " << to_string(res.error());
  10287. EXPECT_EQ(200, res->status);
  10288. EXPECT_FALSE(progress_values.empty());
  10289. }
  10290. TEST(UploadProgressTest, PostMultipartProgress) {
  10291. TestMultipartUploadProgress(
  10292. [](Server &svr) {
  10293. svr.Post("/multipart", [](const Request &req, Response &res) {
  10294. EXPECT_TRUE(!req.form.files.empty() || !req.form.fields.empty());
  10295. res.set_content("multipart received", "text/plain");
  10296. });
  10297. },
  10298. [](Client &cli, const string &endpoint, const UploadFormDataItems &items,
  10299. UploadProgress progress_callback) {
  10300. return cli.Post(endpoint, items, progress_callback);
  10301. },
  10302. "/multipart");
  10303. }
  10304. // Helper function for basic download progress tests
  10305. template <typename SetupHandler, typename ClientCall>
  10306. void TestBasicDownloadProgress(SetupHandler &&setup_handler,
  10307. ClientCall &&client_call, const string &endpoint,
  10308. size_t expected_content_size) {
  10309. Server svr;
  10310. setup_handler(svr);
  10311. thread t = thread([&]() { svr.listen(HOST, PORT); });
  10312. auto se = detail::scope_exit([&] {
  10313. svr.stop();
  10314. t.join();
  10315. });
  10316. svr.wait_until_ready();
  10317. Client cli(HOST, PORT);
  10318. vector<uint64_t> progress_values;
  10319. auto res = client_call(cli, endpoint,
  10320. [&](uint64_t current, uint64_t /*total*/) -> bool {
  10321. progress_values.push_back(current);
  10322. return true;
  10323. });
  10324. ASSERT_TRUE(res) << "Error: " << to_string(res.error());
  10325. EXPECT_EQ(200, res->status);
  10326. EXPECT_FALSE(progress_values.empty());
  10327. EXPECT_EQ(expected_content_size, res->body.size());
  10328. }
  10329. TEST(DownloadProgressTest, GetBasic) {
  10330. TestBasicDownloadProgress(
  10331. [](Server &svr) {
  10332. svr.Get("/download", [](const Request & /*req*/, Response &res) {
  10333. string content(1000, 'D');
  10334. res.set_content(content, "text/plain");
  10335. });
  10336. },
  10337. [](Client &cli, const string &endpoint,
  10338. DownloadProgress progress_callback) {
  10339. return cli.Get(endpoint, progress_callback);
  10340. },
  10341. "/download", 1000u);
  10342. }
  10343. // Helper function for content receiver download progress tests
  10344. template <typename SetupHandler, typename ClientCall>
  10345. void TestContentReceiverDownloadProgress(SetupHandler &&setup_handler,
  10346. ClientCall &&client_call,
  10347. const string &endpoint,
  10348. size_t expected_content_size) {
  10349. Server svr;
  10350. setup_handler(svr);
  10351. thread t = thread([&]() { svr.listen(HOST, PORT); });
  10352. auto se = detail::scope_exit([&] {
  10353. svr.stop();
  10354. t.join();
  10355. });
  10356. svr.wait_until_ready();
  10357. Client cli(HOST, PORT);
  10358. vector<uint64_t> progress_values;
  10359. string received_body;
  10360. auto res = client_call(
  10361. cli, endpoint,
  10362. [&](const char *data, size_t data_length) -> bool {
  10363. received_body.append(data, data_length);
  10364. return true;
  10365. },
  10366. [&](uint64_t current, uint64_t /*total*/) -> bool {
  10367. progress_values.push_back(current);
  10368. return true;
  10369. });
  10370. ASSERT_TRUE(res) << "Error: " << to_string(res.error());
  10371. EXPECT_EQ(200, res->status);
  10372. EXPECT_FALSE(progress_values.empty());
  10373. EXPECT_EQ(expected_content_size, received_body.size());
  10374. EXPECT_TRUE(res->body.empty());
  10375. }
  10376. TEST(DownloadProgressTest, GetWithContentReceiver) {
  10377. TestContentReceiverDownloadProgress(
  10378. [](Server &svr) {
  10379. svr.Get("/download-receiver",
  10380. [](const Request & /*req*/, Response &res) {
  10381. string content(2000, 'R');
  10382. res.set_content(content, "text/plain");
  10383. });
  10384. },
  10385. [](Client &cli, const string &endpoint, ContentReceiver content_receiver,
  10386. DownloadProgress progress_callback) {
  10387. return cli.Get(endpoint, content_receiver, progress_callback);
  10388. },
  10389. "/download-receiver", 2000u);
  10390. }
  10391. TEST(StreamingTest, ChunkedZeroLengthWriteDoesNotEndTheBody) {
  10392. // A provider reaching a pass with nothing to hand over - an empty buffer
  10393. // popped off a queue, say - must not be taken to mean the body is finished.
  10394. // It used to end the loop with the terminating chunk unwritten while the
  10395. // server still considered the response complete, so the peer waited for an
  10396. // end that never arrived.
  10397. Server svr;
  10398. svr.Get("/stream", [](const Request & /*req*/, Response &res) {
  10399. auto step = std::make_shared<int>(0);
  10400. res.set_chunked_content_provider("text/plain",
  10401. [step](size_t /*offset*/, DataSink &sink) {
  10402. switch ((*step)++) {
  10403. case 0: sink.write("", 0); break;
  10404. case 1: sink.write("hello", 5); break;
  10405. default: sink.done(); break;
  10406. }
  10407. return true;
  10408. });
  10409. });
  10410. auto port = svr.bind_to_any_port(HOST);
  10411. auto listen_thread = std::thread([&svr]() { svr.listen_after_bind(); });
  10412. auto listen_se = detail::scope_exit([&] {
  10413. svr.stop();
  10414. listen_thread.join();
  10415. ASSERT_FALSE(svr.is_running());
  10416. });
  10417. svr.wait_until_ready();
  10418. Client cli(HOST, port);
  10419. // Without the fix the body is never terminated, so bound the wait rather
  10420. // than letting the test hang on the default read timeout.
  10421. cli.set_read_timeout(5, 0);
  10422. auto res = cli.Get("/stream");
  10423. ASSERT_TRUE(res) << "Error: " << to_string(res.error());
  10424. EXPECT_EQ(StatusCode::OK_200, res->status);
  10425. EXPECT_EQ("hello", res->body);
  10426. }
  10427. TEST(StreamingTest, NoContentLengthStreaming) {
  10428. Server svr;
  10429. svr.Get("/stream", [](const Request & /*req*/, Response &res) {
  10430. res.set_content_provider("text/plain", [](size_t offset, DataSink &sink) {
  10431. if (offset < 6) {
  10432. sink.os << (offset < 3 ? "a" : "b");
  10433. } else {
  10434. sink.done();
  10435. }
  10436. return true;
  10437. });
  10438. });
  10439. auto listen_thread = std::thread([&svr]() { svr.listen("localhost", PORT); });
  10440. auto listen_se = detail::scope_exit([&] {
  10441. svr.stop();
  10442. listen_thread.join();
  10443. ASSERT_FALSE(svr.is_running());
  10444. });
  10445. svr.wait_until_ready();
  10446. Client client(HOST, PORT);
  10447. auto get_thread = std::thread([&client]() {
  10448. std::string s;
  10449. auto res =
  10450. client.Get("/stream", [&s](const char *data, size_t len) -> bool {
  10451. s += std::string(data, len);
  10452. return true;
  10453. });
  10454. ASSERT_TRUE(res) << "Error: " << to_string(res.error());
  10455. EXPECT_EQ(StatusCode::OK_200, res->status);
  10456. EXPECT_EQ("aaabbb", s);
  10457. });
  10458. auto get_se = detail::scope_exit([&] { get_thread.join(); });
  10459. // Give GET time to get a few messages.
  10460. std::this_thread::sleep_for(std::chrono::milliseconds(500));
  10461. }
  10462. TEST(MountTest, Unmount) {
  10463. Server svr;
  10464. auto listen_thread = std::thread([&svr]() { svr.listen("localhost", PORT); });
  10465. auto se = detail::scope_exit([&] {
  10466. svr.stop();
  10467. listen_thread.join();
  10468. ASSERT_FALSE(svr.is_running());
  10469. });
  10470. svr.wait_until_ready();
  10471. Client cli("localhost", PORT);
  10472. svr.set_mount_point("/mount2", "./www2");
  10473. auto res = cli.Get("/");
  10474. ASSERT_TRUE(res) << "Error: " << to_string(res.error());
  10475. EXPECT_EQ(StatusCode::NotFound_404, res->status);
  10476. res = cli.Get("/mount2/dir/test.html");
  10477. ASSERT_TRUE(res) << "Error: " << to_string(res.error());
  10478. EXPECT_EQ(StatusCode::OK_200, res->status);
  10479. svr.set_mount_point("/", "./www");
  10480. res = cli.Get("/dir/");
  10481. ASSERT_TRUE(res) << "Error: " << to_string(res.error());
  10482. EXPECT_EQ(StatusCode::OK_200, res->status);
  10483. svr.remove_mount_point("/");
  10484. res = cli.Get("/dir/");
  10485. ASSERT_TRUE(res) << "Error: " << to_string(res.error());
  10486. EXPECT_EQ(StatusCode::NotFound_404, res->status);
  10487. svr.remove_mount_point("/mount2");
  10488. res = cli.Get("/mount2/dir/test.html");
  10489. ASSERT_TRUE(res) << "Error: " << to_string(res.error());
  10490. EXPECT_EQ(StatusCode::NotFound_404, res->status);
  10491. }
  10492. TEST(MountTest, MissingFileFallsThroughToHandlers) {
  10493. Server svr;
  10494. ASSERT_TRUE(svr.set_mount_point("/", "./www"));
  10495. svr.Get("/api/hello", [](const Request &, Response &res) {
  10496. res.set_content("api", "text/plain");
  10497. });
  10498. auto listen_thread = std::thread([&svr]() { svr.listen(HOST, PORT); });
  10499. auto se = detail::scope_exit([&] {
  10500. svr.stop();
  10501. listen_thread.join();
  10502. ASSERT_FALSE(svr.is_running());
  10503. });
  10504. svr.wait_until_ready();
  10505. Client cli(HOST, PORT);
  10506. auto res = cli.Get("/dir/test.html");
  10507. ASSERT_TRUE(res) << "Error: " << to_string(res.error());
  10508. EXPECT_EQ(StatusCode::OK_200, res->status);
  10509. res = cli.Get("/api/hello");
  10510. ASSERT_TRUE(res) << "Error: " << to_string(res.error());
  10511. EXPECT_EQ(StatusCode::OK_200, res->status);
  10512. EXPECT_EQ("api", res->body);
  10513. }
  10514. TEST(MountTest, PathSegmentBoundary) {
  10515. Server svr;
  10516. svr.set_mount_point("/mount2", "./www2");
  10517. svr.set_mount_point("/", "./www");
  10518. auto port = svr.bind_to_any_port(HOST);
  10519. auto listen_thread = std::thread([&svr]() { svr.listen_after_bind(); });
  10520. auto se = detail::scope_exit([&] {
  10521. svr.stop();
  10522. listen_thread.join();
  10523. ASSERT_FALSE(svr.is_running());
  10524. });
  10525. svr.wait_until_ready();
  10526. Client cli(HOST, port);
  10527. auto res = cli.Get("/mount2/dir/test.html");
  10528. ASSERT_TRUE(res) << "Error: " << to_string(res.error());
  10529. EXPECT_EQ(StatusCode::OK_200, res->status);
  10530. // "/mount2" must not match part-way through a path segment.
  10531. res = cli.Get("/mount2dir/test.html");
  10532. ASSERT_TRUE(res) << "Error: " << to_string(res.error());
  10533. EXPECT_EQ(StatusCode::NotFound_404, res->status);
  10534. // A mount point ending in '/' keeps matching every path below it.
  10535. res = cli.Get("/dir/test.html");
  10536. ASSERT_TRUE(res) << "Error: " << to_string(res.error());
  10537. EXPECT_EQ(StatusCode::OK_200, res->status);
  10538. }
  10539. TEST(MountTest, Redicect) {
  10540. Server svr;
  10541. auto listen_thread = std::thread([&svr]() { svr.listen("localhost", PORT); });
  10542. auto se = detail::scope_exit([&] {
  10543. svr.stop();
  10544. listen_thread.join();
  10545. ASSERT_FALSE(svr.is_running());
  10546. });
  10547. svr.set_mount_point("/", "./www");
  10548. svr.wait_until_ready();
  10549. Client cli("localhost", PORT);
  10550. auto res = cli.Get("/dir/");
  10551. ASSERT_TRUE(res) << "Error: " << to_string(res.error());
  10552. EXPECT_EQ(StatusCode::OK_200, res->status);
  10553. res = cli.Get("/dir");
  10554. ASSERT_TRUE(res) << "Error: " << to_string(res.error());
  10555. EXPECT_EQ(StatusCode::MovedPermanently_301, res->status);
  10556. res = cli.Get("/file");
  10557. ASSERT_TRUE(res) << "Error: " << to_string(res.error());
  10558. EXPECT_EQ(StatusCode::OK_200, res->status);
  10559. res = cli.Get("/file/");
  10560. ASSERT_TRUE(res) << "Error: " << to_string(res.error());
  10561. EXPECT_EQ(StatusCode::NotFound_404, res->status);
  10562. cli.set_follow_location(true);
  10563. res = cli.Get("/dir");
  10564. ASSERT_TRUE(res) << "Error: " << to_string(res.error());
  10565. EXPECT_EQ(StatusCode::OK_200, res->status);
  10566. }
  10567. TEST(MountTest, MultibytesPathName) {
  10568. Server svr;
  10569. auto listen_thread = std::thread([&svr]() { svr.listen("localhost", PORT); });
  10570. auto se = detail::scope_exit([&] {
  10571. svr.stop();
  10572. listen_thread.join();
  10573. ASSERT_FALSE(svr.is_running());
  10574. });
  10575. svr.set_mount_point("/", "./www");
  10576. svr.wait_until_ready();
  10577. Client cli("localhost", PORT);
  10578. auto res = cli.Get(U8("/日本語Dir/日本語File.txt"));
  10579. ASSERT_TRUE(res) << "Error: " << to_string(res.error());
  10580. EXPECT_EQ(StatusCode::OK_200, res->status);
  10581. EXPECT_EQ(U8("日本語コンテンツ"), res->body);
  10582. }
  10583. #ifdef _WIN32
  10584. // Issue #2435: mmap::open() must succeed even when another handle holds
  10585. // the file open for writing (e.g. an active log file).
  10586. TEST(MmapTest, OpenWhileFileHeldForWriting) {
  10587. const char *path = "mmap_concurrent_writer_test.txt";
  10588. const char *content = "hello";
  10589. {
  10590. std::ofstream f(path, std::ios::binary);
  10591. f.write(content, static_cast<std::streamsize>(strlen(content)));
  10592. }
  10593. auto file_cleanup = detail::scope_exit([&] { std::remove(path); });
  10594. HANDLE writer = ::CreateFileA(path, GENERIC_WRITE, FILE_SHARE_READ, NULL,
  10595. OPEN_EXISTING, FILE_ATTRIBUTE_NORMAL, NULL);
  10596. ASSERT_NE(INVALID_HANDLE_VALUE, writer);
  10597. auto handle_cleanup = detail::scope_exit([&] { ::CloseHandle(writer); });
  10598. detail::mmap m(path);
  10599. ASSERT_TRUE(m.is_open());
  10600. EXPECT_EQ(strlen(content), m.size());
  10601. char buf[8];
  10602. ASSERT_EQ(strlen(content), m.read(0, buf, sizeof(buf)));
  10603. EXPECT_EQ(0, std::memcmp(content, buf, strlen(content)));
  10604. }
  10605. #endif
  10606. #ifndef _WIN32
  10607. // A directory or a device has no size to serve.
  10608. TEST(MmapTest, OnlyRegularFilesAreOpened) {
  10609. const char *path = "./mmap_not_regular_test_dir";
  10610. ASSERT_EQ(0, ::mkdir(path, 0755));
  10611. auto dir_cleanup = detail::scope_exit([&] { ::rmdir(path); });
  10612. for (auto p : {path, "/dev/null"}) {
  10613. detail::mmap m(p);
  10614. EXPECT_FALSE(m.is_open()) << p;
  10615. EXPECT_EQ(0U, m.size()) << p;
  10616. }
  10617. Server svr;
  10618. svr.Get("/null", [](const Request & /*req*/, Response &res) {
  10619. res.set_file_content("/dev/null");
  10620. });
  10621. auto port = svr.bind_to_any_port(HOST);
  10622. thread t = thread([&] { svr.listen_after_bind(); });
  10623. auto se = detail::scope_exit([&] {
  10624. svr.stop();
  10625. t.join();
  10626. });
  10627. svr.wait_until_ready();
  10628. auto res = Client(HOST, port).Get("/null");
  10629. ASSERT_TRUE(res);
  10630. EXPECT_EQ(StatusCode::NotFound_404, res->status);
  10631. }
  10632. #endif
  10633. #ifdef __linux__
  10634. // Nothing of the file stays mapped, where a truncation would raise SIGBUS.
  10635. TEST(MmapTest, FileIsNotMapped) {
  10636. const char *path = "mmap_not_mapped_test.txt";
  10637. {
  10638. std::ofstream f(path, std::ios::binary);
  10639. f << "hello";
  10640. }
  10641. auto file_cleanup = detail::scope_exit([&] { std::remove(path); });
  10642. detail::mmap m(path);
  10643. ASSERT_TRUE(m.is_open());
  10644. std::ifstream maps("/proc/self/maps");
  10645. std::string mappings((std::istreambuf_iterator<char>(maps)),
  10646. std::istreambuf_iterator<char>());
  10647. EXPECT_EQ(std::string::npos, mappings.find(path));
  10648. }
  10649. #endif
  10650. TEST(KeepAliveTest, ReadTimeout) {
  10651. Server svr;
  10652. svr.Get("/a", [&](const Request & /*req*/, Response &res) {
  10653. std::this_thread::sleep_for(std::chrono::seconds(2));
  10654. res.set_content("a", "text/plain");
  10655. });
  10656. svr.Get("/b", [&](const Request & /*req*/, Response &res) {
  10657. res.set_content("b", "text/plain");
  10658. });
  10659. auto listen_thread = std::thread([&svr]() { svr.listen("localhost", PORT); });
  10660. auto se = detail::scope_exit([&] {
  10661. svr.stop();
  10662. listen_thread.join();
  10663. ASSERT_FALSE(svr.is_running());
  10664. });
  10665. svr.wait_until_ready();
  10666. Client cli("localhost", PORT);
  10667. cli.set_keep_alive(true);
  10668. cli.set_read_timeout(std::chrono::seconds(1));
  10669. auto resa = cli.Get("/a");
  10670. ASSERT_FALSE(resa);
  10671. EXPECT_EQ(Error::Read, resa.error());
  10672. auto resb = cli.Get("/b");
  10673. ASSERT_TRUE(resb);
  10674. EXPECT_EQ(StatusCode::OK_200, resb->status);
  10675. EXPECT_EQ("b", resb->body);
  10676. }
  10677. TEST(KeepAliveTest, MaxCount) {
  10678. size_t keep_alive_max_count = 3;
  10679. Server svr;
  10680. svr.set_keep_alive_max_count(keep_alive_max_count);
  10681. svr.Get("/hi", [](const httplib::Request &, httplib::Response &res) {
  10682. res.set_content("Hello World!", "text/plain");
  10683. });
  10684. auto listen_thread = std::thread([&svr] { svr.listen(HOST, PORT); });
  10685. auto se = detail::scope_exit([&] {
  10686. svr.stop();
  10687. listen_thread.join();
  10688. ASSERT_FALSE(svr.is_running());
  10689. });
  10690. svr.wait_until_ready();
  10691. Client cli(HOST, PORT);
  10692. cli.set_keep_alive(true);
  10693. for (size_t i = 0; i < 5; i++) {
  10694. auto result = cli.Get("/hi");
  10695. ASSERT_TRUE(result);
  10696. EXPECT_EQ(StatusCode::OK_200, result->status);
  10697. if (i == keep_alive_max_count - 1) {
  10698. EXPECT_EQ("close", result->get_header_value("Connection"));
  10699. } else {
  10700. EXPECT_FALSE(result->has_header("Connection"));
  10701. }
  10702. }
  10703. }
  10704. // A client may pipeline its requests (RFC 9112 9.3.2), so reading one request
  10705. // can pull the next one into the server's buffer. The server must serve it
  10706. // without waiting for the socket to become readable again. The keep-alive
  10707. // timeout outlasts the client's read timeout, so a request left waiting for it
  10708. // shows up as a missing response.
  10709. static void serve_pipelining_routes(Server &svr,
  10710. const std::function<void(int)> &client) {
  10711. svr.set_keep_alive_timeout(5);
  10712. svr.Get("/hi/(\\d+)", [](const Request &req, Response &res) {
  10713. res.set_content("hi " + req.matches[1].str(), "text/plain");
  10714. });
  10715. svr.Post("/echo", [](const Request &req, Response &res) {
  10716. res.set_content("echo " + req.body, "text/plain");
  10717. });
  10718. auto port = svr.bind_to_any_port(HOST);
  10719. thread t = thread([&] { svr.listen_after_bind(); });
  10720. auto se = detail::scope_exit([&] {
  10721. svr.stop();
  10722. t.join();
  10723. });
  10724. svr.wait_until_ready();
  10725. client(port);
  10726. }
  10727. static std::string
  10728. send_pipelined_requests(const std::vector<std::string> &parts) {
  10729. Server svr;
  10730. std::string res;
  10731. serve_pipelining_routes(svr, [&](int port) {
  10732. EXPECT_TRUE(send_request_in_parts(2, parts, &res, port));
  10733. });
  10734. return res;
  10735. }
  10736. static void expect_in_order(const std::string &res,
  10737. const std::vector<std::string> &bodies) {
  10738. size_t pos = 0;
  10739. for (const auto &body : bodies) {
  10740. pos = res.find(body, pos);
  10741. ASSERT_NE(std::string::npos, pos) << "missing or out of order: " << body;
  10742. pos += body.size();
  10743. }
  10744. }
  10745. TEST(KeepAliveTest, PipelinedRequests) {
  10746. auto res = send_pipelined_requests(
  10747. {"GET /hi/1 HTTP/1.1\r\nHost: localhost\r\n\r\n"
  10748. "POST /echo HTTP/1.1\r\nHost: localhost\r\n"
  10749. "Content-Length: 4\r\n\r\nbody"
  10750. "GET /hi/3 HTTP/1.1\r\nHost: localhost\r\nConnection: close\r\n\r\n"});
  10751. expect_in_order(res, {"hi 1", "echo body", "hi 3"});
  10752. }
  10753. // The second request starts in the server's buffer and ends on the socket.
  10754. TEST(KeepAliveTest, PipelinedRequestSplitAcrossReads) {
  10755. auto res =
  10756. send_pipelined_requests({"GET /hi/1 HTTP/1.1\r\nHost: localhost\r\n\r\n"
  10757. "GET /hi/2 HTTP/1.1\r\nHo",
  10758. "st: localhost\r\nConnection: close\r\n\r\n"});
  10759. expect_in_order(res, {"hi 1", "hi 2"});
  10760. }
  10761. // RFC 9112 2.2: an empty line before the request-line is ignored, so an extra
  10762. // CRLF after a body does not turn into a 400 for the next request.
  10763. TEST(KeepAliveTest, EmptyLineBeforeRequestLineIsIgnored) {
  10764. auto res = send_pipelined_requests(
  10765. {"POST /echo HTTP/1.1\r\nHost: localhost\r\n"
  10766. "Content-Length: 4\r\n\r\nbody\r\n"
  10767. "GET /hi/2 HTTP/1.1\r\nHost: localhost\r\nConnection: close\r\n\r\n"});
  10768. EXPECT_EQ(std::string::npos, res.find("400 Bad Request"));
  10769. expect_in_order(res, {"echo body", "hi 2"});
  10770. }
  10771. // Where an unparsable request ends is unknown, so what follows it in the buffer
  10772. // must not be served as the next request.
  10773. TEST(KeepAliveTest, PipelinedRequestAfterInvalidRequestIsNotServed) {
  10774. auto res = send_pipelined_requests(
  10775. {"INVALID REQUEST LINE\r\n\r\n"
  10776. "GET /hi/1 HTTP/1.1\r\nHost: localhost\r\n\r\n"});
  10777. EXPECT_EQ("HTTP/1.1 400 Bad Request", res.substr(0, 24));
  10778. EXPECT_EQ(std::string::npos, res.find("hi 1"));
  10779. }
  10780. #ifdef CPPHTTPLIB_OPENSSL_SUPPORT
  10781. // Over TLS, the next request is held by the TLS library as already decrypted
  10782. // data rather than on the socket.
  10783. TEST(KeepAliveTest, SSLPipelinedRequests) {
  10784. SSLServer svr(SERVER_CERT_FILE, SERVER_PRIVATE_KEY_FILE);
  10785. std::string res;
  10786. serve_pipelining_routes(svr, [&](int port) {
  10787. // One part, so all three requests arrive in one TLS record
  10788. EXPECT_TRUE(send_ssl_request_in_parts(
  10789. 2,
  10790. {"GET /hi/1 HTTP/1.1\r\nHost: localhost\r\n\r\n"
  10791. "GET /hi/2 HTTP/1.1\r\nHost: localhost\r\n\r\n"
  10792. "GET /hi/3 HTTP/1.1\r\nHost: localhost\r\nConnection: close\r\n\r\n"},
  10793. &res, port));
  10794. });
  10795. expect_in_order(res, {"hi 1", "hi 2", "hi 3"});
  10796. }
  10797. #endif
  10798. TEST(KeepAliveTest, Issue1041) {
  10799. Server svr;
  10800. svr.set_keep_alive_timeout(3);
  10801. svr.Get("/hi", [](const httplib::Request &, httplib::Response &res) {
  10802. res.set_content("Hello World!", "text/plain");
  10803. });
  10804. auto listen_thread = std::thread([&svr] { svr.listen(HOST, PORT); });
  10805. auto se = detail::scope_exit([&] {
  10806. svr.stop();
  10807. listen_thread.join();
  10808. ASSERT_FALSE(svr.is_running());
  10809. });
  10810. svr.wait_until_ready();
  10811. Client cli(HOST, PORT);
  10812. cli.set_keep_alive(true);
  10813. auto result = cli.Get("/hi");
  10814. ASSERT_TRUE(result);
  10815. EXPECT_EQ(StatusCode::OK_200, result->status);
  10816. std::this_thread::sleep_for(std::chrono::seconds(5));
  10817. result = cli.Get("/hi");
  10818. ASSERT_TRUE(result);
  10819. EXPECT_EQ(StatusCode::OK_200, result->status);
  10820. }
  10821. TEST(KeepAliveTest, MaxCountZeroSetsNoLimit) {
  10822. Server svr;
  10823. svr.set_keep_alive_max_count(0);
  10824. std::set<int> remote_ports;
  10825. svr.Get("/hi", [&](const Request &req, Response &res) {
  10826. remote_ports.insert(req.remote_port);
  10827. res.set_content("hi", "text/plain");
  10828. });
  10829. auto listen_thread = std::thread([&svr] { svr.listen(HOST, PORT); });
  10830. auto se = detail::scope_exit([&] {
  10831. svr.stop();
  10832. listen_thread.join();
  10833. ASSERT_FALSE(svr.is_running());
  10834. });
  10835. svr.wait_until_ready();
  10836. Client cli(HOST, PORT);
  10837. cli.set_keep_alive(true);
  10838. for (int i = 0; i < 3; i++) {
  10839. auto res = cli.Get("/hi");
  10840. ASSERT_TRUE(res);
  10841. EXPECT_EQ("timeout=5", res->get_header_value("Keep-Alive"));
  10842. }
  10843. // All three over one connection
  10844. EXPECT_EQ(1u, remote_ports.size());
  10845. }
  10846. TEST(KeepAliveTest, Issue1959) {
  10847. Server svr;
  10848. svr.set_keep_alive_timeout(5);
  10849. svr.Get("/a", [&](const Request & /*req*/, Response &res) {
  10850. res.set_content("a", "text/plain");
  10851. });
  10852. auto listen_thread = std::thread([&svr]() { svr.listen("localhost", PORT); });
  10853. auto se = detail::scope_exit([&] {
  10854. if (!svr.is_running()) return;
  10855. svr.stop();
  10856. listen_thread.join();
  10857. ASSERT_FALSE(svr.is_running());
  10858. });
  10859. svr.wait_until_ready();
  10860. Client cli("localhost", PORT);
  10861. cli.set_keep_alive(true);
  10862. using namespace std::chrono;
  10863. auto start = steady_clock::now();
  10864. cli.Get("/a");
  10865. svr.stop();
  10866. listen_thread.join();
  10867. auto end = steady_clock::now();
  10868. auto elapsed = duration_cast<milliseconds>(end - start).count();
  10869. EXPECT_LT(elapsed, 5000);
  10870. }
  10871. #ifdef CPPHTTPLIB_SSL_ENABLED
  10872. TEST(KeepAliveTest, SSLClientReconnection) {
  10873. SSLServer svr(SERVER_CERT_FILE, SERVER_PRIVATE_KEY_FILE);
  10874. ASSERT_TRUE(svr.is_valid());
  10875. svr.set_keep_alive_timeout(1);
  10876. svr.Get("/hi", [](const httplib::Request &, httplib::Response &res) {
  10877. res.set_content("Hello World!", "text/plain");
  10878. });
  10879. auto listen_thread = std::thread([&svr] { svr.listen(HOST, PORT); });
  10880. auto se = detail::scope_exit([&] {
  10881. svr.stop();
  10882. listen_thread.join();
  10883. ASSERT_FALSE(svr.is_running());
  10884. });
  10885. svr.wait_until_ready();
  10886. SSLClient cli(HOST, PORT);
  10887. cli.enable_server_certificate_verification(false);
  10888. cli.set_keep_alive(true);
  10889. auto result = cli.Get("/hi");
  10890. ASSERT_TRUE(result);
  10891. EXPECT_EQ(StatusCode::OK_200, result->status);
  10892. result = cli.Get("/hi");
  10893. ASSERT_TRUE(result);
  10894. EXPECT_EQ(StatusCode::OK_200, result->status);
  10895. std::this_thread::sleep_for(std::chrono::seconds(2));
  10896. // Recoonect
  10897. result = cli.Get("/hi");
  10898. ASSERT_TRUE(result);
  10899. EXPECT_EQ(StatusCode::OK_200, result->status);
  10900. result = cli.Get("/hi");
  10901. ASSERT_TRUE(result);
  10902. EXPECT_EQ(StatusCode::OK_200, result->status);
  10903. }
  10904. TEST(KeepAliveTest, SSLClientReconnectionPost) {
  10905. SSLServer svr(SERVER_CERT_FILE, SERVER_PRIVATE_KEY_FILE);
  10906. ASSERT_TRUE(svr.is_valid());
  10907. svr.set_keep_alive_timeout(1);
  10908. std::string content = "reconnect";
  10909. svr.Post("/hi", [](const httplib::Request &, httplib::Response &res) {
  10910. res.set_content("Hello World!", "text/plain");
  10911. });
  10912. auto listen_thread = std::thread([&svr] { svr.listen(HOST, PORT); });
  10913. auto se = detail::scope_exit([&] {
  10914. svr.stop();
  10915. listen_thread.join();
  10916. ASSERT_FALSE(svr.is_running());
  10917. });
  10918. svr.wait_until_ready();
  10919. SSLClient cli(HOST, PORT);
  10920. cli.enable_server_certificate_verification(false);
  10921. cli.set_keep_alive(true);
  10922. auto result = cli.Post(
  10923. "/hi", content.size(),
  10924. [&content](size_t /*offset*/, size_t /*length*/, DataSink &sink) {
  10925. sink.write(content.c_str(), content.size());
  10926. return true;
  10927. },
  10928. "text/plain");
  10929. ASSERT_TRUE(result);
  10930. EXPECT_EQ(200, result->status);
  10931. std::this_thread::sleep_for(std::chrono::seconds(2));
  10932. // Recoonect
  10933. result = cli.Post(
  10934. "/hi", content.size(),
  10935. [&content](size_t /*offset*/, size_t /*length*/, DataSink &sink) {
  10936. sink.write(content.c_str(), content.size());
  10937. return true;
  10938. },
  10939. "text/plain");
  10940. ASSERT_TRUE(result);
  10941. EXPECT_EQ(200, result->status);
  10942. result = cli.Post(
  10943. "/hi", content.size(),
  10944. [&content](size_t /*offset*/, size_t /*length*/, DataSink &sink) {
  10945. sink.write(content.c_str(), content.size());
  10946. return true;
  10947. },
  10948. "text/plain");
  10949. ASSERT_TRUE(result);
  10950. EXPECT_EQ(200, result->status);
  10951. }
  10952. TEST(SNI_AutoDetectionTest, SNI_Logic) {
  10953. using namespace httplib::tls;
  10954. {
  10955. SSLServer svr(SERVER_CERT_FILE, SERVER_PRIVATE_KEY_FILE);
  10956. ASSERT_TRUE(svr.is_valid());
  10957. svr.Get("/sni", [&](const Request &req, Response &res) {
  10958. std::string expected = req.sni();
  10959. EXPECT_EQ(expected, req.get_param_value("expected"));
  10960. res.set_content("ok", "text/plain");
  10961. });
  10962. auto listen_thread = std::thread([&svr] { svr.listen(HOST, PORT); });
  10963. auto se = detail::scope_exit([&] {
  10964. svr.stop();
  10965. listen_thread.join();
  10966. ASSERT_FALSE(svr.is_running());
  10967. });
  10968. svr.wait_until_ready();
  10969. {
  10970. SSLClient cli("localhost", PORT);
  10971. cli.enable_server_certificate_verification(false);
  10972. auto res = cli.Get("/sni?expected=localhost");
  10973. ASSERT_TRUE(res) << "Error: " << to_string(res.error());
  10974. }
  10975. {
  10976. SSLClient cli("::1", PORT);
  10977. cli.enable_server_certificate_verification(false);
  10978. auto res = cli.Get("/sni?expected=");
  10979. // NOTE: This may fail if the server is listening on IPv4 only
  10980. // (e.g., when localhost resolves to 127.0.0.1 only)
  10981. if (res) {
  10982. EXPECT_EQ(StatusCode::OK_200, res->status);
  10983. } else {
  10984. EXPECT_EQ(Error::Connection, res.error());
  10985. }
  10986. }
  10987. }
  10988. }
  10989. #endif
  10990. TEST(ClientProblemDetectionTest, ContentProvider) {
  10991. Server svr;
  10992. size_t content_length = 1024 * 1024;
  10993. svr.Get("/hi", [&](const Request & /*req*/, Response &res) {
  10994. res.set_content_provider(
  10995. content_length, "text/plain",
  10996. [&](size_t offset, size_t length, DataSink &sink) {
  10997. auto out_len = std::min(length, static_cast<size_t>(1024));
  10998. std::string out(out_len, '@');
  10999. sink.write(out.data(), out_len);
  11000. return offset < 4096;
  11001. },
  11002. [](bool success) { ASSERT_FALSE(success); });
  11003. });
  11004. svr.Get("/empty", [&](const Request & /*req*/, Response &res) {
  11005. res.set_content_provider(
  11006. 0, "text/plain",
  11007. [&](size_t /*offset*/, size_t /*length*/, DataSink & /*sink*/) -> bool {
  11008. EXPECT_TRUE(false);
  11009. return true;
  11010. },
  11011. [](bool success) { ASSERT_FALSE(success); });
  11012. });
  11013. auto listen_thread = std::thread([&svr]() { svr.listen("localhost", PORT); });
  11014. auto se = detail::scope_exit([&] {
  11015. svr.stop();
  11016. listen_thread.join();
  11017. ASSERT_FALSE(svr.is_running());
  11018. });
  11019. svr.wait_until_ready();
  11020. Client cli("localhost", PORT);
  11021. {
  11022. auto res = cli.Get("/hi", [&](const char * /*data*/,
  11023. size_t /*data_length*/) { return false; });
  11024. ASSERT_FALSE(res);
  11025. }
  11026. {
  11027. auto res = cli.Get("/empty", [&](const char * /*data*/,
  11028. size_t /*data_length*/) { return false; });
  11029. ASSERT_TRUE(res) << "Error: " << to_string(res.error());
  11030. }
  11031. }
  11032. TEST(ContentProviderTest, ProviderMakingNoProgressFails) {
  11033. // A provider that reports success without writing anything and without
  11034. // calling done() used to be handed the same offset and length again on every
  11035. // pass, so it spun for as long as the peer stayed connected.
  11036. Server svr;
  11037. svr.Post("/", [](const Request & /*req*/, Response &res) {
  11038. res.set_content("ok", "text/plain");
  11039. });
  11040. auto port = svr.bind_to_any_port(HOST);
  11041. auto listen_thread = std::thread([&svr] { svr.listen_after_bind(); });
  11042. auto se = detail::scope_exit([&] {
  11043. svr.stop();
  11044. listen_thread.join();
  11045. ASSERT_FALSE(svr.is_running());
  11046. });
  11047. svr.wait_until_ready();
  11048. std::atomic<int> call_count{0};
  11049. Client cli(HOST, port);
  11050. auto res = cli.Post(
  11051. "/", 1024,
  11052. [&](size_t /*offset*/, size_t /*length*/, DataSink & /*sink*/) {
  11053. // Give up after enough passes to show the spin, so that losing the
  11054. // check below fails this test instead of hanging it.
  11055. return ++call_count < 100;
  11056. },
  11057. "text/plain");
  11058. ASSERT_FALSE(res);
  11059. EXPECT_EQ(Error::Write, res.error());
  11060. EXPECT_EQ(1, call_count.load());
  11061. }
  11062. TEST(DataSinkTest, OptionalCallbacksAreCallableByDefault) {
  11063. // A writer only has to assign `write`. The other three used to be left as
  11064. // empty std::functions, so a provider calling one threw
  11065. // std::bad_function_call out of the thread running it and took the whole
  11066. // process down.
  11067. DataSink sink;
  11068. std::string written;
  11069. sink.write = [&](const char *data, size_t data_len) {
  11070. written.append(data, data_len);
  11071. return true;
  11072. };
  11073. EXPECT_TRUE(sink.is_writable());
  11074. sink.done();
  11075. sink.done_with_trailer(Headers{{"X-Trailer", "value"}});
  11076. EXPECT_TRUE(written.empty());
  11077. }
  11078. TEST(DataSinkTest, DoneWithTrailerFallsBackToDone) {
  11079. // A sink that cannot carry trailers still has to finish.
  11080. DataSink sink;
  11081. auto done_count = 0;
  11082. sink.done = [&]() { done_count++; };
  11083. sink.done_with_trailer(Headers{{"X-Trailer", "value"}});
  11084. EXPECT_EQ(1, done_count);
  11085. }
  11086. TEST(DataSinkTest, LengthFramedProviderMayCallDoneAfterWritingEverything) {
  11087. Server svr;
  11088. const std::string body(4096, 'x');
  11089. svr.Get("/", [&](const Request & /*req*/, Response &res) {
  11090. res.set_content_provider(body.size(), "text/plain",
  11091. [&](size_t offset, size_t length, DataSink &sink) {
  11092. sink.write(body.data() + offset, length);
  11093. sink.done();
  11094. return true;
  11095. });
  11096. });
  11097. auto port = svr.bind_to_any_port(HOST);
  11098. auto listen_thread = std::thread([&svr]() { svr.listen_after_bind(); });
  11099. auto se = detail::scope_exit([&] {
  11100. svr.stop();
  11101. listen_thread.join();
  11102. ASSERT_FALSE(svr.is_running());
  11103. });
  11104. svr.wait_until_ready();
  11105. Client cli(HOST, port);
  11106. auto res = cli.Get("/");
  11107. ASSERT_TRUE(res) << "Error: " << to_string(res.error());
  11108. EXPECT_EQ(StatusCode::OK_200, res->status);
  11109. EXPECT_EQ(body, res->body);
  11110. }
  11111. TEST(DataSinkTest, LengthFramedProviderThatFinishesEarlyFailsTheResponse) {
  11112. Server svr;
  11113. svr.Get("/", [](const Request & /*req*/, Response &res) {
  11114. res.set_content_provider(
  11115. 1024, "text/plain",
  11116. [](size_t /*offset*/, size_t /*length*/, DataSink &sink) {
  11117. sink.write("hello", 5);
  11118. sink.done(); // short of the 1024 bytes the response promised
  11119. return true;
  11120. });
  11121. });
  11122. auto port = svr.bind_to_any_port(HOST);
  11123. auto listen_thread = std::thread([&svr]() { svr.listen_after_bind(); });
  11124. auto se = detail::scope_exit([&] {
  11125. svr.stop();
  11126. listen_thread.join();
  11127. ASSERT_FALSE(svr.is_running());
  11128. });
  11129. svr.wait_until_ready();
  11130. Client cli(HOST, port);
  11131. cli.set_read_timeout(5, 0);
  11132. // The response is short of its Content-Length, so the client cannot read a
  11133. // complete body. What matters is that this returns at all: a no-op done()
  11134. // would leave the writer looping over a provider that never makes progress.
  11135. auto res = cli.Get("/");
  11136. EXPECT_FALSE(res);
  11137. }
  11138. // Read as the next response by a peer that sees it after a framed body.
  11139. static const std::string smuggled_response =
  11140. "HTTP/1.1 200 OK\r\nContent-Length: 8\r\n\r\nSMUGGLED";
  11141. TEST(DataSinkTest, LengthFramedProviderCannotWritePastTheLength) {
  11142. Server svr;
  11143. svr.Get("/", [](const Request & /*req*/, Response &res) {
  11144. res.set_content_provider(
  11145. 5, "text/plain",
  11146. [](size_t /*offset*/, size_t /*length*/, DataSink &sink) {
  11147. auto data = "AAAAA" + smuggled_response;
  11148. sink.write(data.data(), data.size());
  11149. return true;
  11150. });
  11151. });
  11152. thread t = thread([&] { svr.listen(HOST, PORT); });
  11153. auto se = detail::scope_exit([&] {
  11154. svr.stop();
  11155. t.join();
  11156. ASSERT_FALSE(svr.is_running());
  11157. });
  11158. svr.wait_until_ready();
  11159. std::string resp;
  11160. ASSERT_TRUE(send_request(1, "GET / HTTP/1.1\r\nHost: x\r\n\r\n", &resp));
  11161. EXPECT_EQ("AAAAA", resp.substr(resp.find("\r\n\r\n") + 4));
  11162. resp.clear();
  11163. ASSERT_TRUE(send_request(
  11164. 1, "GET / HTTP/1.1\r\nHost: x\r\nRange: bytes=0-1\r\n\r\n", &resp));
  11165. EXPECT_EQ("AA", resp.substr(resp.find("\r\n\r\n") + 4));
  11166. }
  11167. TEST(NoContentTest, BodyIsNotSent) {
  11168. Server svr;
  11169. svr.Get("/204", [](const Request & /*req*/, Response &res) {
  11170. res.status = StatusCode::NoContent_204;
  11171. res.set_content(smuggled_response, "text/plain");
  11172. });
  11173. svr.Get("/304", [](const Request & /*req*/, Response &res) {
  11174. res.status = StatusCode::NotModified_304;
  11175. res.set_chunked_content_provider(
  11176. "text/plain", [](size_t /*offset*/, DataSink &sink) {
  11177. sink.write(smuggled_response.data(), smuggled_response.size());
  11178. sink.done();
  11179. return true;
  11180. });
  11181. });
  11182. thread t = thread([&] { svr.listen(HOST, PORT); });
  11183. auto se = detail::scope_exit([&] {
  11184. svr.stop();
  11185. t.join();
  11186. ASSERT_FALSE(svr.is_running());
  11187. });
  11188. svr.wait_until_ready();
  11189. for (auto path : {"/204", "/304"}) {
  11190. std::string resp;
  11191. ASSERT_TRUE(send_request(
  11192. 1, std::string("GET ") + path + " HTTP/1.1\r\nHost: x\r\n\r\n", &resp));
  11193. EXPECT_EQ(resp.size(), resp.find("\r\n\r\n") + 4) << path;
  11194. EXPECT_EQ(std::string::npos, resp.find("Content-Length")) << path;
  11195. EXPECT_EQ(std::string::npos, resp.find("Transfer-Encoding")) << path;
  11196. }
  11197. }
  11198. TEST(DataSinkTest, RequestProviderCannotWritePastTheLength) {
  11199. Server svr;
  11200. std::atomic<bool> smuggled(false);
  11201. svr.Post("/", [](const Request & /*req*/, Response &res) {
  11202. res.set_content("ok", "text/plain");
  11203. });
  11204. svr.Get("/smuggled", [&](const Request & /*req*/, Response & /*res*/) {
  11205. smuggled = true;
  11206. });
  11207. auto port = svr.bind_to_any_port(HOST);
  11208. auto listen_thread = std::thread([&svr]() { svr.listen_after_bind(); });
  11209. auto se = detail::scope_exit([&] {
  11210. svr.stop();
  11211. listen_thread.join();
  11212. ASSERT_FALSE(svr.is_running());
  11213. });
  11214. svr.wait_until_ready();
  11215. // What follows the body would be read as the next request.
  11216. Client cli(HOST, port);
  11217. auto res = cli.Post(
  11218. "/", 5,
  11219. [](size_t /*offset*/, size_t /*length*/, DataSink &sink) {
  11220. std::string data = "helloGET /smuggled HTTP/1.1\r\nHost: x\r\n\r\n";
  11221. sink.write(data.data(), data.size());
  11222. return true;
  11223. },
  11224. "text/plain");
  11225. ASSERT_FALSE(res);
  11226. EXPECT_EQ(Error::Write, res.error());
  11227. EXPECT_FALSE(smuggled);
  11228. }
  11229. #ifdef CPPHTTPLIB_ZLIB_SUPPORT
  11230. TEST(DataSinkTest, CompressedRequestProviderThatFinishesEarlyFails) {
  11231. // The compressed path builds the whole body before connecting, so this
  11232. // fails client-side and never reaches a server.
  11233. Client cli(HOST, PORT);
  11234. cli.set_compress(true);
  11235. auto res = cli.Post(
  11236. "/", 1024,
  11237. [](size_t /*offset*/, size_t /*length*/, DataSink &sink) {
  11238. sink.write("hello", 5);
  11239. sink.done(); // short of the 1024 bytes the request announced
  11240. return true;
  11241. },
  11242. "text/plain");
  11243. ASSERT_FALSE(res);
  11244. EXPECT_EQ(Error::Write, res.error());
  11245. }
  11246. #endif
  11247. TEST(ErrorHandlerWithContentProviderTest, ErrorHandler) {
  11248. Server svr;
  11249. svr.set_error_handler([](Request const &, Response &res) -> void {
  11250. res.set_chunked_content_provider(
  11251. "text/plain", [](std::size_t const, DataSink &sink) -> bool {
  11252. sink.os << "hello";
  11253. sink.os << "world";
  11254. sink.done();
  11255. return true;
  11256. });
  11257. });
  11258. auto listen_thread = std::thread([&svr]() { svr.listen("localhost", PORT); });
  11259. auto se = detail::scope_exit([&] {
  11260. svr.stop();
  11261. listen_thread.join();
  11262. ASSERT_FALSE(svr.is_running());
  11263. });
  11264. svr.wait_until_ready();
  11265. Client cli("localhost", PORT);
  11266. auto res = cli.Get("/");
  11267. ASSERT_TRUE(res) << "Error: " << to_string(res.error());
  11268. EXPECT_EQ(StatusCode::NotFound_404, res->status);
  11269. EXPECT_EQ("helloworld", res->body);
  11270. }
  11271. // A body set after a content provider must replace it, not be sent through it.
  11272. TEST(ResponseContentSourceTest, FileRequestHandlerCanReplaceFile) {
  11273. Server svr;
  11274. svr.set_mount_point("/", "./www");
  11275. svr.set_file_request_handler([](const Request &req, Response &res) {
  11276. if (req.path == "/dir/test.html") {
  11277. res.status = StatusCode::Forbidden_403;
  11278. res.set_content(std::string(5000, 'D'), "text/plain");
  11279. } else if (req.path == "/file") {
  11280. res.status = StatusCode::Forbidden_403;
  11281. res.body = "Denied";
  11282. }
  11283. });
  11284. auto port = svr.bind_to_any_port(HOST);
  11285. auto t = std::thread([&]() { svr.listen_after_bind(); });
  11286. auto se = detail::scope_exit([&] {
  11287. svr.stop();
  11288. t.join();
  11289. ASSERT_FALSE(svr.is_running());
  11290. });
  11291. svr.wait_until_ready();
  11292. Client cli(HOST, port);
  11293. {
  11294. auto res = cli.Get("/dir/test.html");
  11295. ASSERT_TRUE(res) << "Error: " << to_string(res.error());
  11296. EXPECT_EQ(StatusCode::Forbidden_403, res->status);
  11297. EXPECT_EQ(std::string(5000, 'D'), res->body);
  11298. EXPECT_EQ(1U, res->get_header_value_count("Content-Type"));
  11299. }
  11300. {
  11301. auto res = cli.Get("/file");
  11302. ASSERT_TRUE(res) << "Error: " << to_string(res.error());
  11303. EXPECT_EQ(StatusCode::Forbidden_403, res->status);
  11304. EXPECT_EQ("Denied", res->body);
  11305. }
  11306. {
  11307. auto res = cli.Get("/dir/index.html");
  11308. ASSERT_TRUE(res) << "Error: " << to_string(res.error());
  11309. EXPECT_EQ(StatusCode::OK_200, res->status);
  11310. EXPECT_EQ(0U, res->body.find("<html>"));
  11311. }
  11312. }
  11313. TEST(ResponseContentSourceTest, ErrorAndExceptionHandlersReplaceProvider) {
  11314. Server svr;
  11315. std::vector<bool> released;
  11316. std::mutex released_mutex;
  11317. auto releaser = [&](bool success) {
  11318. std::lock_guard<std::mutex> guard(released_mutex);
  11319. released.push_back(success);
  11320. };
  11321. auto provider = [](size_t offset, size_t length, DataSink &sink) {
  11322. return sink.write(&"hello"[offset], length);
  11323. };
  11324. svr.Get("/sized", [&](const Request &, Response &res) {
  11325. res.status = StatusCode::NotFound_404;
  11326. res.set_content_provider(5, "text/plain", provider, releaser);
  11327. });
  11328. svr.Get("/chunked", [&](const Request &, Response &res) {
  11329. res.status = StatusCode::ServiceUnavailable_503;
  11330. res.set_chunked_content_provider(
  11331. "text/plain",
  11332. [](size_t, DataSink &sink) {
  11333. sink.os << "chunk";
  11334. sink.done();
  11335. return true;
  11336. },
  11337. releaser);
  11338. });
  11339. svr.Get("/throw", [&](const Request &, Response &res) -> void {
  11340. res.set_content_provider(5, "text/plain", provider, releaser);
  11341. throw std::runtime_error("after the provider");
  11342. });
  11343. svr.set_error_handler([](const Request &req, Response &res) {
  11344. // Leave the exception handler's content to it.
  11345. if (req.path == "/throw") { return Server::HandlerResponse::Unhandled; }
  11346. res.set_content(std::string(1000, 'E'), "text/html");
  11347. return Server::HandlerResponse::Handled;
  11348. });
  11349. svr.set_exception_handler(
  11350. [](const Request &, Response &res, std::exception_ptr) {
  11351. res.status = StatusCode::InternalServerError_500;
  11352. res.set_content(std::string(1000, 'X'), "text/html");
  11353. });
  11354. auto port = svr.bind_to_any_port(HOST);
  11355. auto t = std::thread([&]() { svr.listen_after_bind(); });
  11356. auto se = detail::scope_exit([&] {
  11357. svr.stop();
  11358. t.join();
  11359. ASSERT_FALSE(svr.is_running());
  11360. });
  11361. svr.wait_until_ready();
  11362. Client cli(HOST, port);
  11363. {
  11364. auto res = cli.Get("/sized");
  11365. ASSERT_TRUE(res) << "Error: " << to_string(res.error());
  11366. EXPECT_EQ(StatusCode::NotFound_404, res->status);
  11367. EXPECT_EQ(std::string(1000, 'E'), res->body);
  11368. EXPECT_EQ("text/html", res->get_header_value("Content-Type"));
  11369. }
  11370. {
  11371. auto res = cli.Get("/chunked");
  11372. ASSERT_TRUE(res) << "Error: " << to_string(res.error());
  11373. EXPECT_EQ(StatusCode::ServiceUnavailable_503, res->status);
  11374. EXPECT_EQ(std::string(1000, 'E'), res->body);
  11375. EXPECT_FALSE(res->has_header("Transfer-Encoding"));
  11376. }
  11377. {
  11378. auto res = cli.Get("/throw");
  11379. ASSERT_TRUE(res) << "Error: " << to_string(res.error());
  11380. EXPECT_EQ(StatusCode::InternalServerError_500, res->status);
  11381. EXPECT_EQ(std::string(1000, 'X'), res->body);
  11382. }
  11383. std::lock_guard<std::mutex> guard(released_mutex);
  11384. EXPECT_EQ((std::vector<bool>{false, false, false}), released);
  11385. }
  11386. TEST(ResponseContentSourceTest, LastContentSetterWins) {
  11387. Server svr;
  11388. auto abc = [](size_t offset, size_t length, DataSink &sink) {
  11389. return sink.write(&"abc"[offset], length);
  11390. };
  11391. svr.Get("/file-then-body", [](const Request &, Response &res) {
  11392. res.set_file_content("./www/dir/test.html");
  11393. res.set_content("body", "text/plain");
  11394. });
  11395. svr.Get("/body-then-file", [](const Request &, Response &res) {
  11396. res.set_content(std::string(100, 'B'), "text/plain");
  11397. res.set_file_content("./www/dir/test.html");
  11398. });
  11399. svr.Get("/body-then-provider", [&](const Request &, Response &res) {
  11400. res.set_content(std::string(100, 'B'), "text/plain");
  11401. res.set_content_provider(3, "text/x-provider", abc);
  11402. });
  11403. svr.Get("/provider-then-body", [&](const Request &, Response &res) {
  11404. res.set_content_provider(3, "text/x-provider", abc);
  11405. res.set_content(std::string(100, 'B'), "text/plain");
  11406. });
  11407. svr.Get("/provider-then-file", [&](const Request &, Response &res) {
  11408. res.set_content_provider(3, "text/x-provider", abc);
  11409. res.set_file_content("./www/dir/test.html", "text/x-file");
  11410. });
  11411. svr.Get("/file-then-header", [](const Request &, Response &res) {
  11412. res.set_file_content("./www/dir/test.html");
  11413. res.set_header("Content-Type", "text/x-handler");
  11414. });
  11415. svr.Get("/provider-then-direct-body", [&](const Request &, Response &res) {
  11416. res.set_content_provider(3, "text/plain", abc);
  11417. res.body = "direct";
  11418. });
  11419. svr.Get("/file-then-direct-body", [](const Request &, Response &res) {
  11420. res.set_file_content("./www/dir/test.html");
  11421. res.body = "direct";
  11422. });
  11423. auto port = svr.bind_to_any_port(HOST);
  11424. auto t = std::thread([&]() { svr.listen_after_bind(); });
  11425. auto se = detail::scope_exit([&] {
  11426. svr.stop();
  11427. t.join();
  11428. ASSERT_FALSE(svr.is_running());
  11429. });
  11430. svr.wait_until_ready();
  11431. Client cli(HOST, port);
  11432. auto expect_body = [&](const char *path, const std::string &body,
  11433. const std::string &type) {
  11434. // Uncompressed, so Content-Length can be compared with the body.
  11435. auto res = cli.Get(path, Headers{{"Accept-Encoding", ""}});
  11436. ASSERT_TRUE(res) << path << " Error: " << to_string(res.error());
  11437. EXPECT_EQ(StatusCode::OK_200, res->status) << path;
  11438. EXPECT_EQ(body, res->body) << path;
  11439. EXPECT_EQ(std::to_string(body.size()),
  11440. res->get_header_value("Content-Length"))
  11441. << path;
  11442. EXPECT_EQ(1u, res->get_header_value_count("Content-Type")) << path;
  11443. EXPECT_EQ(type, res->get_header_value("Content-Type")) << path;
  11444. };
  11445. expect_body("/file-then-body", "body", "text/plain");
  11446. expect_body("/body-then-file", "test.html", "text/html");
  11447. expect_body("/body-then-provider", "abc", "text/x-provider");
  11448. expect_body("/provider-then-body", std::string(100, 'B'), "text/plain");
  11449. expect_body("/provider-then-file", "test.html", "text/x-file");
  11450. expect_body("/file-then-header", "test.html", "text/x-handler");
  11451. expect_body("/provider-then-direct-body", "direct", "text/plain");
  11452. expect_body("/file-then-direct-body", "direct", "text/plain");
  11453. // Ranges are checked against the body, not the dropped provider.
  11454. {
  11455. auto res = cli.Get("/provider-then-direct-body",
  11456. Headers{{make_range_header({{1, 2}})}});
  11457. ASSERT_TRUE(res) << "Error: " << to_string(res.error());
  11458. EXPECT_EQ(StatusCode::PartialContent_206, res->status);
  11459. EXPECT_EQ("ir", res->body);
  11460. }
  11461. {
  11462. auto res = cli.Get("/file-then-direct-body",
  11463. Headers{{make_range_header({{7, 8}})}});
  11464. ASSERT_TRUE(res) << "Error: " << to_string(res.error());
  11465. EXPECT_EQ(StatusCode::RangeNotSatisfiable_416, res->status);
  11466. }
  11467. }
  11468. #if defined(CPPHTTPLIB_SSL_ENABLED) && !defined(_WIN32)
  11469. TEST(FileContentTest, TruncatedWhileServedEndsTheResponse) {
  11470. const char *path = "./truncated_while_served.txt";
  11471. const size_t size = 32 * 1024 * 1024;
  11472. {
  11473. std::ofstream f(path, std::ios::binary);
  11474. f << std::string(size, 'x');
  11475. }
  11476. auto se_file = detail::scope_exit([&] { std::remove(path); });
  11477. // Over TLS, where the bytes are encrypted in this process rather than
  11478. // copied by send().
  11479. SSLServer svr(SERVER_CERT_FILE, SERVER_PRIVATE_KEY_FILE);
  11480. svr.Get("/file", [&](const Request &, Response &res) {
  11481. res.set_file_content(path, "text/plain");
  11482. });
  11483. auto thread = std::thread([&]() { svr.listen(HOST, PORT); });
  11484. auto se = detail::scope_exit([&] {
  11485. svr.stop();
  11486. thread.join();
  11487. ASSERT_FALSE(svr.is_running());
  11488. });
  11489. svr.wait_until_ready();
  11490. // The file shrinks once the first bytes are in, as a rewrite in place
  11491. // would, and reading the mapping past its new end used to raise SIGBUS.
  11492. SSLClient cli(HOST, PORT);
  11493. cli.enable_server_certificate_verification(false);
  11494. size_t received = 0;
  11495. auto res = cli.Get("/file", [&](const char *, size_t len) {
  11496. if (received == 0) { EXPECT_EQ(0, ::truncate(path, 0)); }
  11497. received += len;
  11498. return true;
  11499. });
  11500. EXPECT_FALSE(res);
  11501. EXPECT_LT(received, size);
  11502. }
  11503. #endif
  11504. // Forward declaration (see the base64_encode note).
  11505. namespace httplib {
  11506. namespace detail {
  11507. void set_file_content_provider(Response &res, const std::shared_ptr<mmap> &m,
  11508. const std::string &content_type,
  11509. EncodingType encoding);
  11510. } // namespace detail
  11511. } // namespace httplib
  11512. TEST(ResponseContentSourceTest, FileContentProviderStaysWithinFile) {
  11513. auto mm = std::make_shared<detail::mmap>("./www/dir/test.html");
  11514. ASSERT_TRUE(mm->is_open());
  11515. Response res;
  11516. detail::set_file_content_provider(res, mm, "text/html",
  11517. detail::EncodingType::None);
  11518. std::string out;
  11519. DataSink sink;
  11520. sink.write = [&](const char *d, size_t l) {
  11521. out.append(d, l);
  11522. return true;
  11523. };
  11524. EXPECT_TRUE(res.content_provider_(0, mm->size() + 4096, sink));
  11525. EXPECT_EQ("test.html", out);
  11526. EXPECT_FALSE(res.content_provider_(mm->size(), 1, sink));
  11527. EXPECT_EQ("test.html", out);
  11528. }
  11529. TEST(LongPollingTest, ClientCloseDetection) {
  11530. Server svr;
  11531. svr.Get("/events", [&](const Request & /*req*/, Response &res) {
  11532. res.set_chunked_content_provider(
  11533. "text/plain", [](std::size_t const, DataSink &sink) -> bool {
  11534. EXPECT_TRUE(sink.is_writable()); // the socket is alive
  11535. sink.os << "hello";
  11536. auto count = 10;
  11537. while (count > 0 && sink.is_writable()) {
  11538. this_thread::sleep_for(chrono::milliseconds(10));
  11539. count--;
  11540. }
  11541. EXPECT_FALSE(sink.is_writable()); // the socket is closed
  11542. return true;
  11543. });
  11544. });
  11545. auto listen_thread = std::thread([&svr]() { svr.listen("localhost", PORT); });
  11546. auto se = detail::scope_exit([&] {
  11547. svr.stop();
  11548. listen_thread.join();
  11549. ASSERT_FALSE(svr.is_running());
  11550. });
  11551. svr.wait_until_ready();
  11552. Client cli("localhost", PORT);
  11553. auto res = cli.Get("/events", [&](const char *data, size_t data_length) {
  11554. EXPECT_EQ("hello", string(data, data_length));
  11555. return false; // close the socket immediately.
  11556. });
  11557. ASSERT_FALSE(res);
  11558. }
  11559. TEST(LongPollingTest, ClientCloseDetectionWithStreamOperator) {
  11560. Server svr;
  11561. svr.Get("/events", [&](const Request & /*req*/, Response &res) {
  11562. res.set_chunked_content_provider(
  11563. "text/plain", [](std::size_t const, DataSink &sink) -> bool {
  11564. EXPECT_TRUE(sink.is_writable()); // the socket is alive
  11565. sink.os << "hello";
  11566. EXPECT_TRUE(sink.os.good());
  11567. // Wait for the client to close the connection
  11568. auto count = 10;
  11569. while (count > 0 && sink.is_writable()) {
  11570. this_thread::sleep_for(chrono::milliseconds(10));
  11571. count--;
  11572. }
  11573. // After client disconnect, write repeatedly until the socket
  11574. // write actually fails (small writes may be absorbed by the
  11575. // kernel buffer)
  11576. std::string chunk(1024, 'x');
  11577. for (int i = 0; i < 1000 && sink.os.good(); i++) {
  11578. sink.os << chunk;
  11579. }
  11580. EXPECT_TRUE(sink.os.fail());
  11581. return true;
  11582. });
  11583. });
  11584. auto port = svr.bind_to_any_port("localhost");
  11585. auto listen_thread = std::thread([&svr]() { svr.listen_after_bind(); });
  11586. auto se = detail::scope_exit([&] {
  11587. svr.stop();
  11588. listen_thread.join();
  11589. ASSERT_FALSE(svr.is_running());
  11590. });
  11591. svr.wait_until_ready();
  11592. Client cli("localhost", port);
  11593. auto res = cli.Get("/events", [&](const char *data, size_t data_length) {
  11594. EXPECT_EQ("hello", string(data, data_length));
  11595. return false; // close the socket immediately.
  11596. });
  11597. ASSERT_FALSE(res);
  11598. }
  11599. TEST(GetWithParametersTest, GetWithParameters) {
  11600. Server svr;
  11601. svr.Get("/", [&](const Request &req, Response &) {
  11602. EXPECT_EQ("world", req.get_param_value("hello"));
  11603. EXPECT_EQ("world2", req.get_param_value("hello2"));
  11604. EXPECT_EQ("world3", req.get_param_value("hello3"));
  11605. });
  11606. svr.Get("/params", [&](const Request &req, Response &) {
  11607. EXPECT_EQ("world", req.get_param_value("hello"));
  11608. EXPECT_EQ("world2", req.get_param_value("hello2"));
  11609. EXPECT_EQ("world3", req.get_param_value("hello3"));
  11610. });
  11611. svr.Get(R"(/resources/([a-z0-9\\-]+))", [&](const Request &req, Response &) {
  11612. EXPECT_EQ("resource-id", req.matches[1]);
  11613. EXPECT_EQ("foo", req.get_param_value("param1"));
  11614. EXPECT_EQ("bar", req.get_param_value("param2"));
  11615. });
  11616. svr.Get("/users/:id", [&](const Request &req, Response &) {
  11617. EXPECT_EQ("user-id", req.path_params.at("id"));
  11618. EXPECT_EQ("foo", req.get_param_value("param1"));
  11619. EXPECT_EQ("bar", req.get_param_value("param2"));
  11620. });
  11621. auto listen_thread = std::thread([&svr]() { svr.listen(HOST, PORT); });
  11622. auto se = detail::scope_exit([&] {
  11623. svr.stop();
  11624. listen_thread.join();
  11625. ASSERT_FALSE(svr.is_running());
  11626. });
  11627. svr.wait_until_ready();
  11628. {
  11629. Client cli(HOST, PORT);
  11630. Params params;
  11631. params.emplace("hello", "world");
  11632. params.emplace("hello2", "world2");
  11633. params.emplace("hello3", "world3");
  11634. auto res = cli.Get("/", params, Headers{});
  11635. ASSERT_TRUE(res) << "Error: " << to_string(res.error());
  11636. EXPECT_EQ(StatusCode::OK_200, res->status);
  11637. }
  11638. {
  11639. Client cli(HOST, PORT);
  11640. auto res = cli.Get("/params?hello=world&hello2=world2&hello3=world3");
  11641. ASSERT_TRUE(res) << "Error: " << to_string(res.error());
  11642. EXPECT_EQ(StatusCode::OK_200, res->status);
  11643. }
  11644. {
  11645. Client cli(HOST, PORT);
  11646. auto res = cli.Get("/resources/resource-id?param1=foo&param2=bar");
  11647. ASSERT_TRUE(res) << "Error: " << to_string(res.error());
  11648. EXPECT_EQ(StatusCode::OK_200, res->status);
  11649. }
  11650. {
  11651. Client cli(HOST, PORT);
  11652. auto res = cli.Get("/users/user-id?param1=foo&param2=bar");
  11653. ASSERT_TRUE(res) << "Error: " << to_string(res.error());
  11654. EXPECT_EQ(StatusCode::OK_200, res->status);
  11655. }
  11656. }
  11657. TEST(GetWithParametersTest, GetWithParameters2) {
  11658. Server svr;
  11659. svr.Get("/", [&](const Request &req, Response &res) {
  11660. auto text = req.get_param_value("hello");
  11661. res.set_content(text, "text/plain");
  11662. });
  11663. auto listen_thread = std::thread([&svr]() { svr.listen("localhost", PORT); });
  11664. auto se = detail::scope_exit([&] {
  11665. svr.stop();
  11666. listen_thread.join();
  11667. ASSERT_FALSE(svr.is_running());
  11668. });
  11669. svr.wait_until_ready();
  11670. Client cli("localhost", PORT);
  11671. Params params;
  11672. params.emplace("hello", "world");
  11673. std::string body;
  11674. auto res = cli.Get("/", params, Headers{},
  11675. [&](const char *data, size_t data_length) {
  11676. body.append(data, data_length);
  11677. return true;
  11678. });
  11679. ASSERT_TRUE(res) << "Error: " << to_string(res.error());
  11680. EXPECT_EQ(StatusCode::OK_200, res->status);
  11681. EXPECT_EQ("world", body);
  11682. }
  11683. TEST(GetWithParametersTest, GetWithParamsOnlyNoHeaders) {
  11684. Server svr;
  11685. svr.Get("/search", [&](const Request &req, Response &res) {
  11686. auto q = req.get_param_value("q");
  11687. res.set_content(q, "text/plain");
  11688. });
  11689. auto listen_thread = std::thread([&svr]() { svr.listen("localhost", PORT); });
  11690. auto se = detail::scope_exit([&] {
  11691. svr.stop();
  11692. listen_thread.join();
  11693. ASSERT_FALSE(svr.is_running());
  11694. });
  11695. svr.wait_until_ready();
  11696. Client cli("localhost", PORT);
  11697. // Verify that Get(path, params) works without requiring Headers argument
  11698. auto res = cli.Get("/search", httplib::Params{{"q", "cpp-httplib"}});
  11699. ASSERT_TRUE(res) << "Error: " << to_string(res.error());
  11700. EXPECT_EQ(StatusCode::OK_200, res->status);
  11701. EXPECT_EQ("cpp-httplib", res->body);
  11702. }
  11703. TEST(ClientDefaultHeadersTest, DefaultHeaders_Online) {
  11704. auto host = "httpbingo.org";
  11705. auto path = std::string{"/range/32"};
  11706. #ifdef CPPHTTPLIB_SSL_ENABLED
  11707. SSLClient cli(host);
  11708. #else
  11709. Client cli(host);
  11710. #endif
  11711. cli.set_default_headers({make_range_header({{1, 10}})});
  11712. cli.set_connection_timeout(5);
  11713. {
  11714. auto res = cli.Get(path);
  11715. ASSERT_TRUE(res) << "Error: " << to_string(res.error());
  11716. EXPECT_EQ("bcdefghijk", res->body);
  11717. EXPECT_EQ(StatusCode::PartialContent_206, res->status);
  11718. }
  11719. {
  11720. auto res = cli.Get(path);
  11721. ASSERT_TRUE(res) << "Error: " << to_string(res.error());
  11722. EXPECT_EQ("bcdefghijk", res->body);
  11723. EXPECT_EQ(StatusCode::PartialContent_206, res->status);
  11724. }
  11725. }
  11726. TEST(ServerDefaultHeadersTest, DefaultHeaders) {
  11727. Server svr;
  11728. svr.set_default_headers({{"Hello", "World"}});
  11729. svr.Get("/", [&](const Request & /*req*/, Response &res) {
  11730. res.set_content("ok", "text/plain");
  11731. });
  11732. auto listen_thread = std::thread([&svr]() { svr.listen("localhost", PORT); });
  11733. auto se = detail::scope_exit([&] {
  11734. svr.stop();
  11735. listen_thread.join();
  11736. ASSERT_FALSE(svr.is_running());
  11737. });
  11738. svr.wait_until_ready();
  11739. Client cli("localhost", PORT);
  11740. auto res = cli.Get("/");
  11741. ASSERT_TRUE(res) << "Error: " << to_string(res.error());
  11742. EXPECT_EQ(StatusCode::OK_200, res->status);
  11743. EXPECT_EQ("ok", res->body);
  11744. EXPECT_EQ("World", res->get_header_value("Hello"));
  11745. }
  11746. #ifdef CPPHTTPLIB_SSL_ENABLED
  11747. TEST(KeepAliveTest, ReadTimeoutSSL) {
  11748. SSLServer svr(SERVER_CERT_FILE, SERVER_PRIVATE_KEY_FILE);
  11749. ASSERT_TRUE(svr.is_valid());
  11750. svr.Get("/a", [&](const Request & /*req*/, Response &res) {
  11751. std::this_thread::sleep_for(std::chrono::seconds(2));
  11752. res.set_content("a", "text/plain");
  11753. });
  11754. svr.Get("/b", [&](const Request & /*req*/, Response &res) {
  11755. res.set_content("b", "text/plain");
  11756. });
  11757. auto listen_thread = std::thread([&svr]() { svr.listen("localhost", PORT); });
  11758. auto se = detail::scope_exit([&] {
  11759. svr.stop();
  11760. listen_thread.join();
  11761. ASSERT_FALSE(svr.is_running());
  11762. });
  11763. svr.wait_until_ready();
  11764. SSLClient cli("localhost", PORT);
  11765. cli.enable_server_certificate_verification(false);
  11766. cli.set_keep_alive(true);
  11767. cli.set_read_timeout(std::chrono::seconds(1));
  11768. auto resa = cli.Get("/a");
  11769. ASSERT_TRUE(!resa);
  11770. EXPECT_EQ(Error::Read, resa.error());
  11771. auto resb = cli.Get("/b");
  11772. ASSERT_TRUE(resb);
  11773. EXPECT_EQ(StatusCode::OK_200, resb->status);
  11774. EXPECT_EQ("b", resb->body);
  11775. }
  11776. // Closing an idle keep-alive connection sends close_notify and returns. The
  11777. // server must not wait for the client's close_notify: an idle client never
  11778. // sends one, so the worker would be held until the read timeout expires, and
  11779. // stop() would wait for it.
  11780. TEST(KeepAliveTest, SSLIdleCloseDoesNotWaitForPeer) {
  11781. SSLServer svr(SERVER_CERT_FILE, SERVER_PRIVATE_KEY_FILE);
  11782. ASSERT_TRUE(svr.is_valid());
  11783. svr.set_keep_alive_timeout(1);
  11784. svr.set_read_timeout(10, 0);
  11785. svr.Get("/", [](const Request &, Response &res) {
  11786. res.set_content("ok", "text/plain");
  11787. });
  11788. auto port = svr.bind_to_any_port(HOST);
  11789. auto listen_thread = std::thread([&svr]() { svr.listen_after_bind(); });
  11790. auto se = detail::scope_exit([&] {
  11791. if (listen_thread.joinable()) {
  11792. svr.stop();
  11793. listen_thread.join();
  11794. }
  11795. });
  11796. svr.wait_until_ready();
  11797. SSLClient cli(HOST, port);
  11798. cli.enable_server_certificate_verification(false);
  11799. cli.set_keep_alive(true);
  11800. auto res = cli.Get("/");
  11801. ASSERT_TRUE(res) << "Error: " << to_string(res.error());
  11802. EXPECT_EQ(StatusCode::OK_200, res->status);
  11803. // Stay idle past the keep-alive timeout so the server closes the connection.
  11804. std::this_thread::sleep_for(std::chrono::milliseconds(1500));
  11805. auto start = std::chrono::steady_clock::now();
  11806. svr.stop();
  11807. listen_thread.join();
  11808. auto elapsed = std::chrono::duration_cast<std::chrono::milliseconds>(
  11809. std::chrono::steady_clock::now() - start)
  11810. .count();
  11811. EXPECT_LT(elapsed, 3000);
  11812. }
  11813. #endif
  11814. class ServerTestWithAI_PASSIVE : public ::testing::Test {
  11815. protected:
  11816. ServerTestWithAI_PASSIVE()
  11817. : cli_(HOST, PORT)
  11818. #ifdef CPPHTTPLIB_SSL_ENABLED
  11819. ,
  11820. svr_(SERVER_CERT_FILE, SERVER_PRIVATE_KEY_FILE)
  11821. #endif
  11822. {
  11823. #ifdef CPPHTTPLIB_SSL_ENABLED
  11824. cli_.enable_server_certificate_verification(false);
  11825. #endif
  11826. }
  11827. virtual void SetUp() {
  11828. svr_.Get("/hi", [&](const Request & /*req*/, Response &res) {
  11829. res.set_content("Hello World!", "text/plain");
  11830. });
  11831. t_ = thread(
  11832. [&]() { ASSERT_TRUE(svr_.listen(std::string(), PORT, AI_PASSIVE)); });
  11833. svr_.wait_until_ready();
  11834. }
  11835. virtual void TearDown() {
  11836. svr_.stop();
  11837. t_.join();
  11838. }
  11839. #ifdef CPPHTTPLIB_SSL_ENABLED
  11840. SSLClient cli_;
  11841. SSLServer svr_;
  11842. #else
  11843. Client cli_;
  11844. Server svr_;
  11845. #endif
  11846. thread t_;
  11847. };
  11848. TEST_F(ServerTestWithAI_PASSIVE, GetMethod200) {
  11849. auto res = cli_.Get("/hi");
  11850. ASSERT_TRUE(res) << "Error: " << to_string(res.error());
  11851. EXPECT_EQ(StatusCode::OK_200, res->status);
  11852. EXPECT_EQ("text/plain", res->get_header_value("Content-Type"));
  11853. EXPECT_EQ("Hello World!", res->body);
  11854. }
  11855. class ServerUpDownTest : public ::testing::Test {
  11856. protected:
  11857. ServerUpDownTest() : cli_(HOST, PORT) {}
  11858. virtual void SetUp() {
  11859. t_ = thread([&]() {
  11860. svr_.bind_to_any_port(HOST);
  11861. std::this_thread::sleep_for(std::chrono::milliseconds(500));
  11862. ASSERT_TRUE(svr_.listen_after_bind());
  11863. });
  11864. svr_.wait_until_ready();
  11865. }
  11866. virtual void TearDown() {
  11867. svr_.stop();
  11868. t_.join();
  11869. }
  11870. Client cli_;
  11871. Server svr_;
  11872. thread t_;
  11873. };
  11874. TEST_F(ServerUpDownTest, QuickStartStop) {
  11875. // Should not crash, especially when run with
  11876. // --gtest_filter=ServerUpDownTest.QuickStartStop --gtest_repeat=1000
  11877. }
  11878. class PayloadMaxLengthTest : public ::testing::Test {
  11879. protected:
  11880. PayloadMaxLengthTest()
  11881. : cli_(HOST, PORT)
  11882. #ifdef CPPHTTPLIB_SSL_ENABLED
  11883. ,
  11884. svr_(SERVER_CERT_FILE, SERVER_PRIVATE_KEY_FILE)
  11885. #endif
  11886. {
  11887. #ifdef CPPHTTPLIB_SSL_ENABLED
  11888. cli_.enable_server_certificate_verification(false);
  11889. #endif
  11890. }
  11891. virtual void SetUp() {
  11892. svr_.set_payload_max_length(8);
  11893. svr_.Post("/test", [&](const Request & /*req*/, Response &res) {
  11894. res.set_content("test", "text/plain");
  11895. });
  11896. t_ = thread([&]() { ASSERT_TRUE(svr_.listen(HOST, PORT)); });
  11897. svr_.wait_until_ready();
  11898. }
  11899. virtual void TearDown() {
  11900. svr_.stop();
  11901. t_.join();
  11902. }
  11903. #ifdef CPPHTTPLIB_SSL_ENABLED
  11904. SSLClient cli_;
  11905. SSLServer svr_;
  11906. #else
  11907. Client cli_;
  11908. Server svr_;
  11909. #endif
  11910. thread t_;
  11911. };
  11912. TEST_F(PayloadMaxLengthTest, ExceedLimit) {
  11913. auto res = cli_.Post("/test", "123456789", "text/plain");
  11914. ASSERT_TRUE(res) << "Error: " << to_string(res.error());
  11915. EXPECT_EQ(StatusCode::PayloadTooLarge_413, res->status);
  11916. res = cli_.Post("/test", "12345678", "text/plain");
  11917. ASSERT_TRUE(res) << "Error: " << to_string(res.error());
  11918. EXPECT_EQ(StatusCode::OK_200, res->status);
  11919. }
  11920. TEST_F(PayloadMaxLengthTest, ChunkedEncodingSecurityTest) {
  11921. // Test chunked encoding with payload exceeding the 8-byte limit
  11922. std::string large_chunked_data(16, 'A'); // 16 bytes, exceeds 8-byte limit
  11923. auto res = cli_.Post("/test", large_chunked_data, "text/plain");
  11924. ASSERT_TRUE(res) << "Error: " << to_string(res.error());
  11925. EXPECT_EQ(StatusCode::PayloadTooLarge_413, res->status);
  11926. }
  11927. TEST_F(PayloadMaxLengthTest, ChunkedEncodingWithinLimit) {
  11928. // Test chunked encoding with payload within the 8-byte limit
  11929. std::string small_chunked_data(4, 'B'); // 4 bytes, within 8-byte limit
  11930. auto res = cli_.Post("/test", small_chunked_data, "text/plain");
  11931. ASSERT_TRUE(res) << "Error: " << to_string(res.error());
  11932. EXPECT_EQ(StatusCode::OK_200, res->status);
  11933. }
  11934. TEST_F(PayloadMaxLengthTest, RawSocketChunkedTest) {
  11935. // Test using send_request to send chunked data exceeding payload limit
  11936. std::string chunked_request = "POST /test HTTP/1.1\r\n"
  11937. "Host: " +
  11938. std::string(HOST) + ":" + std::to_string(PORT) +
  11939. "\r\n"
  11940. "Transfer-Encoding: chunked\r\n"
  11941. "Connection: close\r\n"
  11942. "\r\n"
  11943. "a\r\n" // 10 bytes chunk (exceeds 8-byte limit)
  11944. "0123456789\r\n"
  11945. "0\r\n" // End chunk
  11946. "\r\n";
  11947. std::string response;
  11948. bool result = send_request(1, chunked_request, &response);
  11949. if (!result) {
  11950. // If send_request fails, it might be because the server closed the
  11951. // connection due to payload limit enforcement, which is acceptable
  11952. SUCCEED()
  11953. << "Server rejected oversized chunked request (connection closed)";
  11954. } else {
  11955. // If we got a response, check if it's an error response or connection was
  11956. // closed early Short response length indicates connection was closed due to
  11957. // payload limit
  11958. if (response.length() <= 10) {
  11959. SUCCEED() << "Server closed connection for oversized chunked request";
  11960. } else {
  11961. // Check for error status codes
  11962. EXPECT_TRUE(response.find("413") != std::string::npos ||
  11963. response.find("Payload Too Large") != std::string::npos ||
  11964. response.find("400") != std::string::npos);
  11965. }
  11966. }
  11967. }
  11968. TEST_F(PayloadMaxLengthTest, NoContentLengthPayloadLimit) {
  11969. // Test request without Content-Length header exceeding payload limit
  11970. std::string request_without_content_length = "POST /test HTTP/1.1\r\n"
  11971. "Host: " +
  11972. std::string(HOST) + ":" +
  11973. std::to_string(PORT) +
  11974. "\r\n"
  11975. "Connection: close\r\n"
  11976. "\r\n";
  11977. // Add payload exceeding the 8-byte limit
  11978. std::string large_payload(16, 'X'); // 16 bytes, exceeds 8-byte limit
  11979. request_without_content_length += large_payload;
  11980. std::string response;
  11981. bool result = send_request(1, request_without_content_length, &response);
  11982. if (!result) {
  11983. // If send_request fails, server likely closed connection due to payload
  11984. // limit
  11985. SUCCEED() << "Server rejected oversized request without Content-Length "
  11986. "(connection closed)";
  11987. } else {
  11988. // Check if server responded with error or closed connection early
  11989. if (response.length() <= 10) {
  11990. SUCCEED() << "Server closed connection for oversized request without "
  11991. "Content-Length";
  11992. } else {
  11993. // Check for error status codes
  11994. EXPECT_TRUE(response.find("413") != std::string::npos ||
  11995. response.find("Payload Too Large") != std::string::npos ||
  11996. response.find("400") != std::string::npos);
  11997. }
  11998. }
  11999. }
  12000. TEST_F(PayloadMaxLengthTest, NoContentLengthWithinLimit) {
  12001. // Test request without Content-Length header within payload limit
  12002. std::string request_without_content_length = "POST /test HTTP/1.1\r\n"
  12003. "Host: " +
  12004. std::string(HOST) + ":" +
  12005. std::to_string(PORT) +
  12006. "\r\n"
  12007. "Connection: close\r\n"
  12008. "\r\n";
  12009. // Add payload within the 8-byte limit
  12010. std::string small_payload(4, 'Y'); // 4 bytes, within 8-byte limit
  12011. request_without_content_length += small_payload;
  12012. std::string response;
  12013. bool result = send_request(1, request_without_content_length, &response);
  12014. // For requests without Content-Length, the server may have different behavior
  12015. // The key is that it should not reject due to payload limit for small
  12016. // payloads
  12017. if (result) {
  12018. // Check for any HTTP response (success or error, but not connection closed)
  12019. if (response.length() > 10) {
  12020. SUCCEED()
  12021. << "Server processed request without Content-Length within limit";
  12022. } else {
  12023. // Short response might indicate connection closed, which is acceptable
  12024. SUCCEED() << "Server closed connection for request without "
  12025. "Content-Length (acceptable behavior)";
  12026. }
  12027. } else {
  12028. // Connection failure might be due to protocol requirements
  12029. SUCCEED() << "Connection issue with request without Content-Length "
  12030. "(environment-specific)";
  12031. }
  12032. }
  12033. class LargePayloadMaxLengthTest : public ::testing::Test {
  12034. protected:
  12035. LargePayloadMaxLengthTest()
  12036. : cli_(HOST, PORT)
  12037. #ifdef CPPHTTPLIB_SSL_ENABLED
  12038. ,
  12039. svr_(SERVER_CERT_FILE, SERVER_PRIVATE_KEY_FILE)
  12040. #endif
  12041. {
  12042. #ifdef CPPHTTPLIB_SSL_ENABLED
  12043. cli_.enable_server_certificate_verification(false);
  12044. #endif
  12045. }
  12046. virtual void SetUp() {
  12047. // Set 10MB payload limit
  12048. const size_t LARGE_PAYLOAD_LIMIT = 10 * 1024 * 1024; // 10MB
  12049. svr_.set_payload_max_length(LARGE_PAYLOAD_LIMIT);
  12050. svr_.Post("/test", [&](const Request & /*req*/, Response &res) {
  12051. res.set_content("Large payload test", "text/plain");
  12052. });
  12053. t_ = thread([&]() { ASSERT_TRUE(svr_.listen(HOST, PORT)); });
  12054. svr_.wait_until_ready();
  12055. }
  12056. virtual void TearDown() {
  12057. svr_.stop();
  12058. t_.join();
  12059. }
  12060. #ifdef CPPHTTPLIB_SSL_ENABLED
  12061. SSLClient cli_;
  12062. SSLServer svr_;
  12063. #else
  12064. Client cli_;
  12065. Server svr_;
  12066. #endif
  12067. thread t_;
  12068. };
  12069. TEST_F(LargePayloadMaxLengthTest, ChunkedEncodingWithin10MB) {
  12070. // Test chunked encoding with payload within 10MB limit
  12071. std::string medium_payload(5 * 1024 * 1024,
  12072. 'A'); // 5MB payload, within 10MB limit
  12073. auto res = cli_.Post("/test", medium_payload, "application/octet-stream");
  12074. ASSERT_TRUE(res) << "Error: " << to_string(res.error());
  12075. EXPECT_EQ(StatusCode::OK_200, res->status);
  12076. }
  12077. TEST_F(LargePayloadMaxLengthTest, ChunkedEncodingExceeds10MB) {
  12078. // Test chunked encoding with payload exceeding 10MB limit
  12079. std::string large_payload(12 * 1024 * 1024,
  12080. 'B'); // 12MB payload, exceeds 10MB limit
  12081. auto res = cli_.Post("/test", large_payload, "application/octet-stream");
  12082. // Server may either return 413 or close the connection
  12083. if (res) {
  12084. EXPECT_EQ(StatusCode::PayloadTooLarge_413, res->status);
  12085. } else {
  12086. SUCCEED() << "Server closed connection for payload exceeding 10MB limit";
  12087. }
  12088. }
  12089. TEST_F(LargePayloadMaxLengthTest, NoContentLengthWithin10MB) {
  12090. // Test request without Content-Length header within 10MB limit
  12091. std::string request_without_content_length = "POST /test HTTP/1.1\r\n"
  12092. "Host: " +
  12093. std::string(HOST) + ":" +
  12094. std::to_string(PORT) +
  12095. "\r\n"
  12096. "Connection: close\r\n"
  12097. "\r\n";
  12098. // Add 1MB payload (within 10MB limit)
  12099. std::string medium_payload(1024 * 1024, 'C'); // 1MB payload
  12100. request_without_content_length += medium_payload;
  12101. std::string response;
  12102. bool result = send_request(5, request_without_content_length, &response);
  12103. if (result) {
  12104. // Should get a proper HTTP response for payloads within limit
  12105. if (response.length() > 10) {
  12106. SUCCEED() << "Server processed 1MB request without Content-Length within "
  12107. "10MB limit";
  12108. } else {
  12109. SUCCEED() << "Server closed connection (acceptable behavior for no "
  12110. "Content-Length)";
  12111. }
  12112. } else {
  12113. SUCCEED() << "Connection issue with 1MB payload (environment-specific)";
  12114. }
  12115. }
  12116. TEST_F(LargePayloadMaxLengthTest, NoContentLengthExceeds10MB) {
  12117. // Test request without Content-Length header exceeding 10MB limit
  12118. std::string request_without_content_length = "POST /test HTTP/1.1\r\n"
  12119. "Host: " +
  12120. std::string(HOST) + ":" +
  12121. std::to_string(PORT) +
  12122. "\r\n"
  12123. "Connection: close\r\n"
  12124. "\r\n";
  12125. // Add 12MB payload (exceeds 10MB limit)
  12126. std::string large_payload(12 * 1024 * 1024, 'D'); // 12MB payload
  12127. request_without_content_length += large_payload;
  12128. std::string response;
  12129. bool result = send_request(10, request_without_content_length, &response);
  12130. if (!result) {
  12131. // Server should close connection due to payload limit
  12132. SUCCEED() << "Server rejected 12MB request without Content-Length "
  12133. "(connection closed)";
  12134. } else {
  12135. // Check for error response
  12136. if (response.length() <= 10) {
  12137. SUCCEED()
  12138. << "Server closed connection for 12MB request exceeding 10MB limit";
  12139. } else {
  12140. EXPECT_TRUE(response.find("413") != std::string::npos ||
  12141. response.find("Payload Too Large") != std::string::npos ||
  12142. response.find("400") != std::string::npos);
  12143. }
  12144. }
  12145. }
  12146. TEST(ClientPayloadTest, DoesNotReserveTheClaimedLength) {
  12147. Server svr;
  12148. svr.Get("/", [](const Request &, Response &res) {
  12149. // Claims far more than it sends, then drops the connection.
  12150. res.set_content_provider(size_t(1) << 41, "text/plain",
  12151. [](size_t, size_t, DataSink &sink) {
  12152. sink.write("abc", 3);
  12153. return false;
  12154. });
  12155. });
  12156. auto thread = std::thread([&]() { svr.listen(HOST, PORT); });
  12157. auto se = detail::scope_exit([&] {
  12158. svr.stop();
  12159. thread.join();
  12160. ASSERT_FALSE(svr.is_running());
  12161. });
  12162. svr.wait_until_ready();
  12163. Client cli(HOST, PORT);
  12164. cli.set_payload_max_length(0);
  12165. EXPECT_FALSE(cli.Get("/"));
  12166. }
  12167. #ifdef CPPHTTPLIB_ZLIB_SUPPORT
  12168. // `payload_max_length` is not enforced on decompressed body in ContentReader
  12169. // path.
  12170. TEST(PayloadLimitBypassTest, StreamingGzipDecompression) {
  12171. Server svr;
  12172. const size_t LIMIT = 64 * 1024; // 64KB
  12173. svr.set_payload_max_length(LIMIT);
  12174. size_t total = 0;
  12175. svr.Post("/stream", [&](const Request & /*req*/, Response &res,
  12176. const ContentReader &content_reader) {
  12177. content_reader([&](const char * /*data*/, size_t len) {
  12178. total += len;
  12179. return true;
  12180. });
  12181. res.status = 200;
  12182. res.set_content("stream_ok", "text/plain");
  12183. });
  12184. auto thread = std::thread([&]() { svr.listen(HOST, PORT); });
  12185. auto se = detail::scope_exit([&] {
  12186. svr.stop();
  12187. thread.join();
  12188. ASSERT_FALSE(svr.is_running());
  12189. });
  12190. svr.wait_until_ready();
  12191. // Prepare 256KB raw data and gzip-compress it
  12192. std::string raw(256 * 1024, 'A');
  12193. std::string gz;
  12194. {
  12195. z_stream zs{};
  12196. deflateInit2(&zs, Z_BEST_COMPRESSION, Z_DEFLATED, 15 + 16, 8,
  12197. Z_DEFAULT_STRATEGY);
  12198. zs.next_in = reinterpret_cast<Bytef *>(const_cast<char *>(raw.data()));
  12199. zs.avail_in = static_cast<uInt>(raw.size());
  12200. char outbuf[4096];
  12201. int ret;
  12202. do {
  12203. zs.next_out = reinterpret_cast<Bytef *>(outbuf);
  12204. zs.avail_out = sizeof(outbuf);
  12205. ret = deflate(&zs, Z_FINISH);
  12206. gz.append(outbuf, sizeof(outbuf) - zs.avail_out);
  12207. } while (ret != Z_STREAM_END);
  12208. deflateEnd(&zs);
  12209. }
  12210. Client cli(HOST, PORT);
  12211. cli.set_connection_timeout(std::chrono::seconds(5));
  12212. Headers headers = {{"Content-Encoding", "gzip"}};
  12213. auto res = cli.Post("/stream", headers, gz.data(), gz.size(),
  12214. "application/octet-stream");
  12215. ASSERT_TRUE(res) << "Error: " << to_string(res.error());
  12216. // Server must reject oversized decompressed payloads with 413.
  12217. EXPECT_EQ(StatusCode::PayloadTooLarge_413, res->status);
  12218. // Decompressed bytes delivered to the handler must not exceed LIMIT.
  12219. EXPECT_LE(total, LIMIT);
  12220. }
  12221. #ifndef CPPHTTPLIB_SSL_ENABLED
  12222. // For a request with neither Content-Length nor Transfer-Encoding, the
  12223. // non-SSL raw-socket fallback in read_content_core() used to hand the
  12224. // compressed wire bytes straight to the ContentReader without ever routing
  12225. // them through the decompressor, so payload_max_length_ only bounded the
  12226. // compressed size on the wire, not the decompressed size.
  12227. TEST(PayloadLimitBypassTest, UnframedGzipDecompression) {
  12228. Server svr;
  12229. const size_t LIMIT = 64 * 1024; // 64KB
  12230. svr.set_payload_max_length(LIMIT);
  12231. size_t total = 0;
  12232. svr.Post("/stream", [&](const Request & /*req*/, Response &res,
  12233. const ContentReader &content_reader) {
  12234. content_reader([&](const char * /*data*/, size_t len) {
  12235. total += len;
  12236. return true;
  12237. });
  12238. res.status = 200;
  12239. res.set_content("stream_ok", "text/plain");
  12240. });
  12241. auto port = svr.bind_to_any_port(HOST);
  12242. auto thread = std::thread([&]() { svr.listen_after_bind(); });
  12243. auto se = detail::scope_exit([&] {
  12244. svr.stop();
  12245. thread.join();
  12246. ASSERT_FALSE(svr.is_running());
  12247. });
  12248. svr.wait_until_ready();
  12249. // Prepare 256KB raw data and gzip-compress it, same payload as the
  12250. // StreamingGzipDecompression test above.
  12251. std::string raw(256 * 1024, 'A');
  12252. std::string gz;
  12253. {
  12254. httplib::detail::gzip_compressor compressor;
  12255. bool result = compressor.compress(raw.data(), raw.size(), /*last=*/true,
  12256. [&](const char *chunk, size_t len) {
  12257. gz.append(chunk, len);
  12258. return true;
  12259. });
  12260. ASSERT_TRUE(result);
  12261. }
  12262. // Send the gzip body over raw TCP with neither Content-Length nor
  12263. // Transfer-Encoding, and Connection: close so the server's stray-body scan
  12264. // kicks in.
  12265. std::string req = "POST /stream HTTP/1.1\r\n"
  12266. "Host: " +
  12267. std::string(HOST) + ":" + std::to_string(port) +
  12268. "\r\n"
  12269. "Content-Encoding: gzip\r\n"
  12270. "Connection: close\r\n"
  12271. "\r\n" +
  12272. gz;
  12273. std::string response;
  12274. ASSERT_TRUE(send_request(5, req, &response, port));
  12275. // Decompressed bytes delivered to the handler must not exceed LIMIT.
  12276. EXPECT_LE(total, LIMIT);
  12277. }
  12278. #endif
  12279. #endif
  12280. // Some servers misuse Content-Encoding to advertise a character set, e.g.
  12281. // `Content-Encoding: UTF-8` on a JPEG. Such a value is not a content coding, so
  12282. // the payload must be passed through untouched instead of being rejected.
  12283. TEST(ContentEncodingTest, UnknownEncodingIsPassedThrough) {
  12284. const std::string body = "\xff\xd8\xff\xe0 not really a jpeg";
  12285. Server svr;
  12286. svr.Get("/image", [&](const Request & /*req*/, Response &res) {
  12287. res.set_content(body, "image/jpeg");
  12288. res.set_header("Content-Encoding", "UTF-8");
  12289. });
  12290. svr.Get("/identity", [&](const Request & /*req*/, Response &res) {
  12291. res.set_content(body, "image/jpeg");
  12292. res.set_header("Content-Encoding", "identity");
  12293. });
  12294. svr.Post("/echo", [](const Request &req, Response &res) {
  12295. res.set_content(req.body, "image/jpeg");
  12296. });
  12297. thread t = thread([&]() { svr.listen(HOST, PORT); });
  12298. auto se = detail::scope_exit([&] {
  12299. svr.stop();
  12300. t.join();
  12301. ASSERT_FALSE(svr.is_running());
  12302. });
  12303. svr.wait_until_ready();
  12304. Client cli(HOST, PORT);
  12305. {
  12306. auto res = cli.Get("/image");
  12307. ASSERT_TRUE(res) << "Error: " << to_string(res.error());
  12308. EXPECT_EQ(StatusCode::OK_200, res->status);
  12309. EXPECT_EQ(body, res->body);
  12310. }
  12311. {
  12312. auto res = cli.Get("/identity");
  12313. ASSERT_TRUE(res) << "Error: " << to_string(res.error());
  12314. EXPECT_EQ(StatusCode::OK_200, res->status);
  12315. EXPECT_EQ(body, res->body);
  12316. }
  12317. {
  12318. // The same applies to a request body reaching the server.
  12319. Headers headers = {{"Content-Encoding", "UTF-8"}};
  12320. auto res = cli.Post("/echo", headers, body, "image/jpeg");
  12321. ASSERT_TRUE(res) << "Error: " << to_string(res.error());
  12322. EXPECT_EQ(StatusCode::OK_200, res->status);
  12323. EXPECT_EQ(body, res->body);
  12324. }
  12325. }
  12326. // "Hello World!" as gzip. Hard-coded so that the test below can serve a
  12327. // gzip-encoded response even when the build has no zlib support.
  12328. static const char GZIPPED_HELLO_WORLD[] = {
  12329. '\x1f', '\x8b', '\x08', '\x00', '\x00', '\x00', '\x00', '\x00',
  12330. '\x02', '\x03', '\xf3', '\x48', '\xcd', '\xc9', '\xc9', '\x57',
  12331. '\x08', '\xcf', '\x2f', '\xca', '\x49', '\x51', '\x04', '\x00',
  12332. '\xa3', '\x1c', '\x29', '\x1c', '\x0c', '\x00', '\x00', '\x00'};
  12333. // A content coding is a whole token, not something the field value merely
  12334. // contains. Matching "br" and "zstd" as substrings made unrelated values such
  12335. // as "fibre" look like Brotli, and turned a multi-coding value like
  12336. // "gzip, br" into a Brotli-labeled body, so a decompressor was run over data
  12337. // it was never meant to see.
  12338. TEST(ContentEncodingTest, SubstringOfACodingIsNotTheCoding) {
  12339. const std::string body = "\xff\xd8\xff\xe0 not really a jpeg";
  12340. Server svr;
  12341. svr.Get("/fibre", [&](const Request & /*req*/, Response &res) {
  12342. res.set_content(body, "image/jpeg");
  12343. res.set_header("Content-Encoding", "fibre");
  12344. });
  12345. svr.Get("/multi", [&](const Request & /*req*/, Response &res) {
  12346. res.set_content(body, "image/jpeg");
  12347. res.set_header("Content-Encoding", "gzip, br");
  12348. });
  12349. svr.Get("/zstdish", [&](const Request & /*req*/, Response &res) {
  12350. res.set_content(body, "image/jpeg");
  12351. res.set_header("Content-Encoding", "x-zstd-ish");
  12352. });
  12353. auto port = svr.bind_to_any_port(HOST);
  12354. thread t = thread([&]() { svr.listen_after_bind(); });
  12355. auto se = detail::scope_exit([&] {
  12356. svr.stop();
  12357. t.join();
  12358. ASSERT_FALSE(svr.is_running());
  12359. });
  12360. svr.wait_until_ready();
  12361. Client cli(HOST, port);
  12362. for (const char *path : {"/fibre", "/multi", "/zstdish"}) {
  12363. auto res = cli.Get(path);
  12364. ASSERT_TRUE(res) << path << " -> " << to_string(res.error());
  12365. EXPECT_EQ(StatusCode::OK_200, res->status) << path;
  12366. // Not a coding we recognize, so the payload comes back untouched
  12367. EXPECT_EQ(body, res->body) << path;
  12368. }
  12369. }
  12370. // A content coding cpp-httplib recognizes but was not built with must be
  12371. // reported as such. Handing the still-compressed payload back to the caller
  12372. // would silently corrupt it.
  12373. TEST(ContentEncodingTest, KnownEncodingWithoutSupportIsReported) {
  12374. const std::string gzipped(GZIPPED_HELLO_WORLD, sizeof(GZIPPED_HELLO_WORLD));
  12375. Server svr;
  12376. // "image/jpeg" keeps the server from applying a content coding of its own,
  12377. // so the hand-crafted Content-Encoding below survives.
  12378. svr.Get("/gzipped", [&](const Request & /*req*/, Response &res) {
  12379. res.set_content(gzipped, "image/jpeg");
  12380. res.set_header("Content-Encoding", "gzip");
  12381. });
  12382. // Content codings are case-insensitive (RFC 9110 8.4.1).
  12383. svr.Get("/gzipped-uppercase", [&](const Request & /*req*/, Response &res) {
  12384. res.set_content(gzipped, "image/jpeg");
  12385. res.set_header("Content-Encoding", "GZIP");
  12386. });
  12387. thread t = thread([&]() { svr.listen(HOST, PORT); });
  12388. auto se = detail::scope_exit([&] {
  12389. svr.stop();
  12390. t.join();
  12391. ASSERT_FALSE(svr.is_running());
  12392. });
  12393. svr.wait_until_ready();
  12394. Client cli(HOST, PORT);
  12395. {
  12396. auto res = cli.Get("/gzipped");
  12397. #ifdef CPPHTTPLIB_ZLIB_SUPPORT
  12398. ASSERT_TRUE(res) << "Error: " << to_string(res.error());
  12399. EXPECT_EQ("Hello World!", res->body);
  12400. #else
  12401. ASSERT_FALSE(res);
  12402. EXPECT_EQ(Error::UnsupportedContentEncoding, res.error());
  12403. #endif
  12404. }
  12405. {
  12406. // open_stream() must behave the same way.
  12407. auto handle = cli.open_stream("GET", "/gzipped");
  12408. #ifdef CPPHTTPLIB_ZLIB_SUPPORT
  12409. ASSERT_TRUE(handle.is_valid());
  12410. std::string received;
  12411. char buf[256];
  12412. ssize_t n;
  12413. while ((n = handle.read(buf, sizeof(buf))) > 0) {
  12414. received.append(buf, static_cast<size_t>(n));
  12415. }
  12416. EXPECT_EQ("Hello World!", received);
  12417. #else
  12418. EXPECT_FALSE(handle.is_valid());
  12419. EXPECT_EQ(Error::UnsupportedContentEncoding, handle.error);
  12420. #endif
  12421. }
  12422. {
  12423. // A differently-cased coding must not be mistaken for an unknown one, or
  12424. // the body would be handed back still compressed.
  12425. auto res = cli.Get("/gzipped-uppercase");
  12426. #ifdef CPPHTTPLIB_ZLIB_SUPPORT
  12427. ASSERT_TRUE(res) << "Error: " << to_string(res.error());
  12428. EXPECT_EQ("Hello World!", res->body);
  12429. #else
  12430. ASSERT_FALSE(res);
  12431. EXPECT_EQ(Error::UnsupportedContentEncoding, res.error());
  12432. #endif
  12433. }
  12434. }
  12435. #ifdef CPPHTTPLIB_ZLIB_SUPPORT
  12436. // A handler serving pre-compressed content (e.g. build-time gzipped static
  12437. // assets) sets Content-Encoding itself. The server used to pick a coding from
  12438. // Accept-Encoding and the content type alone, gzipping the already-gzipped
  12439. // body a second time and appending a second Content-Encoding field line, so
  12440. // clients that decode one coding per listed value handed back raw gzip bytes.
  12441. TEST(ContentEncodingTest, PreEncodedResponseIsNotCompressedAgain) {
  12442. const std::string gzipped(GZIPPED_HELLO_WORLD, sizeof(GZIPPED_HELLO_WORLD));
  12443. Server svr;
  12444. // text/plain is a compressible type, so only the pre-set Content-Encoding
  12445. // keeps the server from applying a coding of its own.
  12446. svr.Get("/pre-gzipped", [&](const Request & /*req*/, Response &res) {
  12447. res.set_content(gzipped, "text/plain");
  12448. res.set_header("Content-Encoding", "gzip");
  12449. });
  12450. auto port = svr.bind_to_any_port(HOST);
  12451. thread t = thread([&]() { svr.listen_after_bind(); });
  12452. auto se = detail::scope_exit([&] {
  12453. svr.stop();
  12454. t.join();
  12455. ASSERT_FALSE(svr.is_running());
  12456. });
  12457. svr.wait_until_ready();
  12458. Client cli(HOST, port);
  12459. Headers headers = {{"Accept-Encoding", "gzip"}};
  12460. auto res = cli.Get("/pre-gzipped", headers);
  12461. ASSERT_TRUE(res) << "Error: " << to_string(res.error());
  12462. EXPECT_EQ(StatusCode::OK_200, res->status);
  12463. EXPECT_EQ(1U, res->get_header_value_count("Content-Encoding"));
  12464. EXPECT_EQ("Hello World!", res->body);
  12465. }
  12466. // A chunked provider settles its coding where the headers are written and
  12467. // reuses it at write time. Both ends of that have to hold: a handler's own
  12468. // Content-Encoding suppresses the coding, and a response without one is still
  12469. // compressed as it always was.
  12470. TEST(ContentEncodingTest, PreEncodedChunkedResponseIsNotCompressedAgain) {
  12471. const std::string gzipped(GZIPPED_HELLO_WORLD, sizeof(GZIPPED_HELLO_WORLD));
  12472. const std::string plain = "Hello World! Hello World! Hello World!";
  12473. Server svr;
  12474. svr.Get("/pre-gzipped", [&](const Request & /*req*/, Response &res) {
  12475. res.set_header("Content-Encoding", "gzip");
  12476. res.set_chunked_content_provider(
  12477. "text/plain", [gzipped](size_t /*offset*/, DataSink &sink) {
  12478. sink.write(gzipped.data(), gzipped.size());
  12479. sink.done();
  12480. return true;
  12481. });
  12482. });
  12483. svr.Get("/negotiated", [&](const Request & /*req*/, Response &res) {
  12484. res.set_chunked_content_provider(
  12485. "text/plain", [plain](size_t /*offset*/, DataSink &sink) {
  12486. sink.write(plain.data(), plain.size());
  12487. sink.done();
  12488. return true;
  12489. });
  12490. });
  12491. auto port = svr.bind_to_any_port(HOST);
  12492. thread t = thread([&]() { svr.listen_after_bind(); });
  12493. auto se = detail::scope_exit([&] {
  12494. svr.stop();
  12495. t.join();
  12496. ASSERT_FALSE(svr.is_running());
  12497. });
  12498. svr.wait_until_ready();
  12499. Client cli(HOST, port);
  12500. Headers headers = {{"Accept-Encoding", "gzip"}};
  12501. {
  12502. auto res = cli.Get("/pre-gzipped", headers);
  12503. ASSERT_TRUE(res) << "Error: " << to_string(res.error());
  12504. EXPECT_EQ(StatusCode::OK_200, res->status);
  12505. EXPECT_EQ(1U, res->get_header_value_count("Content-Encoding"));
  12506. EXPECT_EQ("Hello World!", res->body);
  12507. }
  12508. {
  12509. auto res = cli.Get("/negotiated", headers);
  12510. ASSERT_TRUE(res) << "Error: " << to_string(res.error());
  12511. EXPECT_EQ(StatusCode::OK_200, res->status);
  12512. EXPECT_EQ("gzip", res->get_header_value("Content-Encoding"));
  12513. EXPECT_EQ(plain, res->body);
  12514. }
  12515. }
  12516. #endif
  12517. // RFC 9110 Section 5.3: a Content-Encoding split over several field lines is
  12518. // the same message as the comma-joined one, so both have to be read the same
  12519. // way. Reading only the first line made "gzip" followed by "gzip" look like a
  12520. // single gzip coding, and a body the sender says was encoded twice was handed
  12521. // back after one pass, still compressed but presented as decoded.
  12522. TEST(ContentEncodingTest, DuplicateFieldLinesAreTheSameAsTheJoinedValue) {
  12523. const std::string body = "\xff\xd8\xff\xe0 not really a jpeg";
  12524. Server svr;
  12525. svr.Get("/split", [&](const Request & /*req*/, Response &res) {
  12526. res.set_content(body, "image/jpeg");
  12527. res.headers.emplace("Content-Encoding", "gzip");
  12528. res.headers.emplace("Content-Encoding", "gzip");
  12529. });
  12530. svr.Get("/joined", [&](const Request & /*req*/, Response &res) {
  12531. res.set_content(body, "image/jpeg");
  12532. res.set_header("Content-Encoding", "gzip, gzip");
  12533. });
  12534. auto port = svr.bind_to_any_port(HOST);
  12535. thread t = thread([&]() { svr.listen_after_bind(); });
  12536. auto se = detail::scope_exit([&] {
  12537. svr.stop();
  12538. t.join();
  12539. ASSERT_FALSE(svr.is_running());
  12540. });
  12541. svr.wait_until_ready();
  12542. Client cli(HOST, port);
  12543. // Two codings is not something cpp-httplib decodes, so both representations
  12544. // take the pass-through path rather than one of them being gunzipped once.
  12545. for (const char *path : {"/split", "/joined"}) {
  12546. auto res = cli.Get(path);
  12547. ASSERT_TRUE(res) << path << " -> " << to_string(res.error());
  12548. EXPECT_EQ(StatusCode::OK_200, res->status) << path;
  12549. EXPECT_EQ(body, res->body) << path;
  12550. }
  12551. }
  12552. // Regression test for DoS vulnerability: a malicious server sending a response
  12553. // without Content-Length header must not cause unbounded memory consumption on
  12554. // the client side. The client should stop reading after a reasonable limit,
  12555. // similar to the server-side set_payload_max_length protection.
  12556. TEST(ClientVulnerabilityTest, UnboundedReadWithoutContentLength) {
  12557. constexpr size_t CLIENT_READ_LIMIT = 2 * 1024 * 1024; // 2MB safety limit
  12558. #ifndef _WIN32
  12559. signal(SIGPIPE, SIG_IGN);
  12560. #endif
  12561. auto server_thread = std::thread([] {
  12562. constexpr size_t MALICIOUS_DATA_SIZE = 10 * 1024 * 1024; // 10MB from server
  12563. auto srv = ::socket(AF_INET, SOCK_STREAM, 0);
  12564. default_socket_options(srv);
  12565. detail::set_socket_opt_time(srv, SOL_SOCKET, SO_RCVTIMEO, 5, 0);
  12566. detail::set_socket_opt_time(srv, SOL_SOCKET, SO_SNDTIMEO, 5, 0);
  12567. sockaddr_in addr{};
  12568. addr.sin_family = AF_INET;
  12569. addr.sin_port = htons(static_cast<uint16_t>(PORT + 2));
  12570. ::inet_pton(AF_INET, "127.0.0.1", &addr.sin_addr);
  12571. int opt = 1;
  12572. ::setsockopt(srv, SOL_SOCKET, SO_REUSEADDR,
  12573. #ifdef _WIN32
  12574. reinterpret_cast<const char *>(&opt),
  12575. #else
  12576. &opt,
  12577. #endif
  12578. sizeof(opt));
  12579. ::bind(srv, reinterpret_cast<sockaddr *>(&addr), sizeof(addr));
  12580. ::listen(srv, 1);
  12581. sockaddr_in cli_addr{};
  12582. socklen_t cli_len = sizeof(cli_addr);
  12583. auto cli = ::accept(srv, reinterpret_cast<sockaddr *>(&cli_addr), &cli_len);
  12584. if (cli != INVALID_SOCKET) {
  12585. char buf[4096];
  12586. ::recv(cli, buf, sizeof(buf), 0);
  12587. // Malicious response: no Content-Length, no chunked encoding
  12588. std::string response_header = "HTTP/1.1 200 OK\r\n"
  12589. "Connection: close\r\n"
  12590. "\r\n";
  12591. ::send(cli,
  12592. #ifdef _WIN32
  12593. static_cast<const char *>(response_header.c_str()),
  12594. static_cast<int>(response_header.size()),
  12595. #else
  12596. response_header.c_str(), response_header.size(),
  12597. #endif
  12598. 0);
  12599. // Send 10MB of data
  12600. std::string chunk(64 * 1024, 'A');
  12601. size_t total_sent = 0;
  12602. while (total_sent < MALICIOUS_DATA_SIZE) {
  12603. auto to_send = std::min(chunk.size(), MALICIOUS_DATA_SIZE - total_sent);
  12604. auto sent = ::send(cli,
  12605. #ifdef _WIN32
  12606. static_cast<const char *>(chunk.c_str()),
  12607. static_cast<int>(to_send),
  12608. #else
  12609. chunk.c_str(), to_send,
  12610. #endif
  12611. 0);
  12612. if (sent <= 0) break;
  12613. total_sent += static_cast<size_t>(sent);
  12614. }
  12615. detail::close_socket(cli);
  12616. }
  12617. detail::close_socket(srv);
  12618. });
  12619. std::this_thread::sleep_for(std::chrono::milliseconds(200));
  12620. size_t total_read = 0;
  12621. {
  12622. Client cli("127.0.0.1", PORT + 2);
  12623. cli.set_read_timeout(5, 0);
  12624. cli.set_payload_max_length(CLIENT_READ_LIMIT);
  12625. auto stream = cli.open_stream("GET", "/malicious");
  12626. ASSERT_TRUE(stream.is_valid());
  12627. char buffer[64 * 1024];
  12628. ssize_t n;
  12629. while ((n = stream.read(buffer, sizeof(buffer))) > 0) {
  12630. total_read += static_cast<size_t>(n);
  12631. }
  12632. } // StreamHandle and Client destroyed here, closing the socket
  12633. server_thread.join();
  12634. // With set_payload_max_length, the client must stop reading before consuming
  12635. // all 10MB. The read loop should be cut off at or near the configured limit.
  12636. EXPECT_LE(total_read, CLIENT_READ_LIMIT)
  12637. << "Client read " << total_read << " bytes, exceeding the configured "
  12638. << "payload_max_length of " << CLIENT_READ_LIMIT << " bytes.";
  12639. }
  12640. // Verify that set_payload_max_length(0) means "no limit" and allows reading
  12641. // the entire response body without truncation.
  12642. TEST(ClientVulnerabilityTest, PayloadMaxLengthZeroMeansNoLimit) {
  12643. static constexpr size_t DATA_SIZE = 4 * 1024 * 1024; // 4MB from server
  12644. #ifndef _WIN32
  12645. signal(SIGPIPE, SIG_IGN);
  12646. #endif
  12647. auto server_thread = std::thread([] {
  12648. auto srv = ::socket(AF_INET, SOCK_STREAM, 0);
  12649. default_socket_options(srv);
  12650. detail::set_socket_opt_time(srv, SOL_SOCKET, SO_RCVTIMEO, 5, 0);
  12651. detail::set_socket_opt_time(srv, SOL_SOCKET, SO_SNDTIMEO, 5, 0);
  12652. sockaddr_in addr{};
  12653. addr.sin_family = AF_INET;
  12654. addr.sin_port = htons(static_cast<uint16_t>(PORT + 2));
  12655. ::inet_pton(AF_INET, "127.0.0.1", &addr.sin_addr);
  12656. int opt = 1;
  12657. ::setsockopt(srv, SOL_SOCKET, SO_REUSEADDR,
  12658. #ifdef _WIN32
  12659. reinterpret_cast<const char *>(&opt),
  12660. #else
  12661. &opt,
  12662. #endif
  12663. sizeof(opt));
  12664. ::bind(srv, reinterpret_cast<sockaddr *>(&addr), sizeof(addr));
  12665. ::listen(srv, 1);
  12666. sockaddr_in cli_addr{};
  12667. socklen_t cli_len = sizeof(cli_addr);
  12668. auto cli = ::accept(srv, reinterpret_cast<sockaddr *>(&cli_addr), &cli_len);
  12669. if (cli != INVALID_SOCKET) {
  12670. char buf[4096];
  12671. ::recv(cli, buf, sizeof(buf), 0);
  12672. std::string response_header = "HTTP/1.1 200 OK\r\n"
  12673. "Connection: close\r\n"
  12674. "\r\n";
  12675. ::send(cli,
  12676. #ifdef _WIN32
  12677. static_cast<const char *>(response_header.c_str()),
  12678. static_cast<int>(response_header.size()),
  12679. #else
  12680. response_header.c_str(), response_header.size(),
  12681. #endif
  12682. 0);
  12683. std::string chunk(64 * 1024, 'A');
  12684. size_t total_sent = 0;
  12685. while (total_sent < DATA_SIZE) {
  12686. auto to_send = std::min(chunk.size(), DATA_SIZE - total_sent);
  12687. auto sent = ::send(cli,
  12688. #ifdef _WIN32
  12689. static_cast<const char *>(chunk.c_str()),
  12690. static_cast<int>(to_send),
  12691. #else
  12692. chunk.c_str(), to_send,
  12693. #endif
  12694. 0);
  12695. if (sent <= 0) break;
  12696. total_sent += static_cast<size_t>(sent);
  12697. }
  12698. #ifdef _WIN32
  12699. ::shutdown(cli, SD_SEND);
  12700. #else
  12701. ::shutdown(cli, SHUT_WR);
  12702. #endif
  12703. // Drain until the client closes its end, ensuring all data is delivered
  12704. char drain[1024];
  12705. while (::recv(cli, drain, sizeof(drain), 0) > 0) {}
  12706. detail::close_socket(cli);
  12707. }
  12708. detail::close_socket(srv);
  12709. });
  12710. std::this_thread::sleep_for(std::chrono::milliseconds(200));
  12711. size_t total_read = 0;
  12712. {
  12713. Client cli("127.0.0.1", PORT + 2);
  12714. cli.set_read_timeout(5, 0);
  12715. cli.set_payload_max_length(0); // 0 means no limit
  12716. auto stream = cli.open_stream("GET", "/data");
  12717. ASSERT_TRUE(stream.is_valid());
  12718. char buffer[64 * 1024];
  12719. ssize_t n;
  12720. while ((n = stream.read(buffer, sizeof(buffer))) > 0) {
  12721. total_read += static_cast<size_t>(n);
  12722. }
  12723. }
  12724. server_thread.join();
  12725. EXPECT_EQ(total_read, DATA_SIZE)
  12726. << "With payload_max_length(0), the client should read all " << DATA_SIZE
  12727. << " bytes without truncation, but only read " << total_read << " bytes.";
  12728. }
  12729. // Regression test for OSS-Fuzz issue 508342856: a malicious server sending an
  12730. // enormous Content-Length must not cause the client to pre-allocate a huge
  12731. // response body buffer. The reservation is capped at payload_max_length_, and
  12732. // the read itself fails when the body exceeds the limit.
  12733. TEST(ClientVulnerabilityTest, HugeContentLengthDoesNotPreallocate) {
  12734. #ifndef _WIN32
  12735. signal(SIGPIPE, SIG_IGN);
  12736. #endif
  12737. auto server_thread = std::thread([] {
  12738. auto srv = ::socket(AF_INET, SOCK_STREAM, 0);
  12739. default_socket_options(srv);
  12740. detail::set_socket_opt_time(srv, SOL_SOCKET, SO_RCVTIMEO, 5, 0);
  12741. detail::set_socket_opt_time(srv, SOL_SOCKET, SO_SNDTIMEO, 5, 0);
  12742. sockaddr_in addr{};
  12743. addr.sin_family = AF_INET;
  12744. addr.sin_port = htons(static_cast<uint16_t>(PORT + 2));
  12745. ::inet_pton(AF_INET, "127.0.0.1", &addr.sin_addr);
  12746. int opt = 1;
  12747. ::setsockopt(srv, SOL_SOCKET, SO_REUSEADDR,
  12748. #ifdef _WIN32
  12749. reinterpret_cast<const char *>(&opt),
  12750. #else
  12751. &opt,
  12752. #endif
  12753. sizeof(opt));
  12754. ::bind(srv, reinterpret_cast<sockaddr *>(&addr), sizeof(addr));
  12755. ::listen(srv, 1);
  12756. sockaddr_in cli_addr{};
  12757. socklen_t cli_len = sizeof(cli_addr);
  12758. auto cli = ::accept(srv, reinterpret_cast<sockaddr *>(&cli_addr), &cli_len);
  12759. if (cli != INVALID_SOCKET) {
  12760. char buf[4096];
  12761. ::recv(cli, buf, sizeof(buf), 0);
  12762. // Malicious response: claim a 20GB body but send only a tiny payload.
  12763. std::string response = "HTTP/1.1 200 OK\r\n"
  12764. "Content-Length: 20000000000\r\n"
  12765. "\r\n"
  12766. "abc";
  12767. ::send(cli,
  12768. #ifdef _WIN32
  12769. static_cast<const char *>(response.c_str()),
  12770. static_cast<int>(response.size()),
  12771. #else
  12772. response.c_str(), response.size(),
  12773. #endif
  12774. 0);
  12775. detail::close_socket(cli);
  12776. }
  12777. detail::close_socket(srv);
  12778. });
  12779. std::this_thread::sleep_for(std::chrono::milliseconds(200));
  12780. {
  12781. Client cli("127.0.0.1", PORT + 2);
  12782. cli.set_read_timeout(5, 0);
  12783. // Default payload_max_length_ is 100MB; a 20GB Content-Length must not
  12784. // result in a 20GB pre-allocation. The Get() call is expected to fail
  12785. // (server claims more bytes than payload_max_length permits), but it must
  12786. // not exhaust memory before getting there.
  12787. auto res = cli.Get("/malicious");
  12788. EXPECT_FALSE(res); // Read fails because body exceeds payload_max_length_
  12789. }
  12790. server_thread.join();
  12791. }
  12792. // Verify that content_receiver bypasses the default payload_max_length,
  12793. // allowing streaming downloads larger than 100MB without requiring an explicit
  12794. // set_payload_max_length call.
  12795. TEST(ClientVulnerabilityTest, ContentReceiverBypassesDefaultPayloadMaxLength) {
  12796. static constexpr size_t DATA_SIZE = 200 * 1024 * 1024; // 200MB from server
  12797. #ifndef _WIN32
  12798. signal(SIGPIPE, SIG_IGN);
  12799. #endif
  12800. auto server_thread = std::thread([] {
  12801. auto srv = ::socket(AF_INET, SOCK_STREAM, 0);
  12802. default_socket_options(srv);
  12803. detail::set_socket_opt_time(srv, SOL_SOCKET, SO_RCVTIMEO, 5, 0);
  12804. detail::set_socket_opt_time(srv, SOL_SOCKET, SO_SNDTIMEO, 5, 0);
  12805. sockaddr_in addr{};
  12806. addr.sin_family = AF_INET;
  12807. addr.sin_port = htons(static_cast<uint16_t>(PORT + 2));
  12808. ::inet_pton(AF_INET, "127.0.0.1", &addr.sin_addr);
  12809. int opt = 1;
  12810. ::setsockopt(srv, SOL_SOCKET, SO_REUSEADDR,
  12811. #ifdef _WIN32
  12812. reinterpret_cast<const char *>(&opt),
  12813. #else
  12814. &opt,
  12815. #endif
  12816. sizeof(opt));
  12817. ::bind(srv, reinterpret_cast<sockaddr *>(&addr), sizeof(addr));
  12818. ::listen(srv, 1);
  12819. sockaddr_in cli_addr{};
  12820. socklen_t cli_len = sizeof(cli_addr);
  12821. auto cli = ::accept(srv, reinterpret_cast<sockaddr *>(&cli_addr), &cli_len);
  12822. if (cli != INVALID_SOCKET) {
  12823. char buf[4096];
  12824. ::recv(cli, buf, sizeof(buf), 0);
  12825. // Response with Content-Length larger than default 100MB limit
  12826. auto content_length = std::to_string(DATA_SIZE);
  12827. std::string response_header = "HTTP/1.1 200 OK\r\n"
  12828. "Content-Length: " +
  12829. content_length +
  12830. "\r\n"
  12831. "Connection: close\r\n"
  12832. "\r\n";
  12833. ::send(cli,
  12834. #ifdef _WIN32
  12835. static_cast<const char *>(response_header.c_str()),
  12836. static_cast<int>(response_header.size()),
  12837. #else
  12838. response_header.c_str(), response_header.size(),
  12839. #endif
  12840. 0);
  12841. std::string chunk(64 * 1024, 'A');
  12842. size_t total_sent = 0;
  12843. while (total_sent < DATA_SIZE) {
  12844. auto to_send = std::min(chunk.size(), DATA_SIZE - total_sent);
  12845. auto sent = ::send(cli,
  12846. #ifdef _WIN32
  12847. static_cast<const char *>(chunk.c_str()),
  12848. static_cast<int>(to_send),
  12849. #else
  12850. chunk.c_str(), to_send,
  12851. #endif
  12852. 0);
  12853. if (sent <= 0) break;
  12854. total_sent += static_cast<size_t>(sent);
  12855. }
  12856. detail::close_socket(cli);
  12857. }
  12858. detail::close_socket(srv);
  12859. });
  12860. std::this_thread::sleep_for(std::chrono::milliseconds(200));
  12861. size_t total_received = 0;
  12862. {
  12863. Client cli("127.0.0.1", PORT + 2);
  12864. cli.set_read_timeout(10, 0);
  12865. // Do NOT call set_payload_max_length — use the default 100MB limit
  12866. auto res =
  12867. cli.Get("/large", [&](const char * /*data*/, size_t data_length) {
  12868. total_received += data_length;
  12869. return true;
  12870. });
  12871. ASSERT_TRUE(res) << "Error: " << to_string(res.error());
  12872. EXPECT_EQ(StatusCode::OK_200, res->status);
  12873. }
  12874. server_thread.join();
  12875. EXPECT_EQ(total_received, DATA_SIZE)
  12876. << "With content_receiver, the client should read all " << DATA_SIZE
  12877. << " bytes despite the default 100MB payload_max_length, but only read "
  12878. << total_received << " bytes.";
  12879. }
  12880. // Verify that an explicit set_payload_max_length smaller than the response is
  12881. // enforced even when a content_receiver is used.
  12882. TEST(ClientVulnerabilityTest,
  12883. ContentReceiverRespectsExplicitPayloadMaxLength150MB) {
  12884. static constexpr size_t DATA_SIZE = 200 * 1024 * 1024; // 200MB from server
  12885. static constexpr size_t EXPLICIT_LIMIT = 150 * 1024 * 1024; // 150MB limit
  12886. #ifndef _WIN32
  12887. signal(SIGPIPE, SIG_IGN);
  12888. #endif
  12889. auto server_thread = std::thread([] {
  12890. auto srv = ::socket(AF_INET, SOCK_STREAM, 0);
  12891. default_socket_options(srv);
  12892. detail::set_socket_opt_time(srv, SOL_SOCKET, SO_RCVTIMEO, 5, 0);
  12893. detail::set_socket_opt_time(srv, SOL_SOCKET, SO_SNDTIMEO, 5, 0);
  12894. sockaddr_in addr{};
  12895. addr.sin_family = AF_INET;
  12896. addr.sin_port = htons(static_cast<uint16_t>(PORT + 2));
  12897. ::inet_pton(AF_INET, "127.0.0.1", &addr.sin_addr);
  12898. int opt = 1;
  12899. ::setsockopt(srv, SOL_SOCKET, SO_REUSEADDR,
  12900. #ifdef _WIN32
  12901. reinterpret_cast<const char *>(&opt),
  12902. #else
  12903. &opt,
  12904. #endif
  12905. sizeof(opt));
  12906. ::bind(srv, reinterpret_cast<sockaddr *>(&addr), sizeof(addr));
  12907. ::listen(srv, 1);
  12908. sockaddr_in cli_addr{};
  12909. socklen_t cli_len = sizeof(cli_addr);
  12910. auto cli = ::accept(srv, reinterpret_cast<sockaddr *>(&cli_addr), &cli_len);
  12911. if (cli != INVALID_SOCKET) {
  12912. char buf[4096];
  12913. ::recv(cli, buf, sizeof(buf), 0);
  12914. auto content_length = std::to_string(DATA_SIZE);
  12915. std::string response_header = "HTTP/1.1 200 OK\r\n"
  12916. "Content-Length: " +
  12917. content_length +
  12918. "\r\n"
  12919. "Connection: close\r\n"
  12920. "\r\n";
  12921. ::send(cli,
  12922. #ifdef _WIN32
  12923. static_cast<const char *>(response_header.c_str()),
  12924. static_cast<int>(response_header.size()),
  12925. #else
  12926. response_header.c_str(), response_header.size(),
  12927. #endif
  12928. 0);
  12929. std::string chunk(64 * 1024, 'A');
  12930. size_t total_sent = 0;
  12931. while (total_sent < DATA_SIZE) {
  12932. auto to_send = std::min(chunk.size(), DATA_SIZE - total_sent);
  12933. auto sent = ::send(cli,
  12934. #ifdef _WIN32
  12935. static_cast<const char *>(chunk.c_str()),
  12936. static_cast<int>(to_send),
  12937. #else
  12938. chunk.c_str(), to_send,
  12939. #endif
  12940. 0);
  12941. if (sent <= 0) break;
  12942. total_sent += static_cast<size_t>(sent);
  12943. }
  12944. detail::close_socket(cli);
  12945. }
  12946. detail::close_socket(srv);
  12947. });
  12948. std::this_thread::sleep_for(std::chrono::milliseconds(200));
  12949. size_t total_received = 0;
  12950. {
  12951. Client cli("127.0.0.1", PORT + 2);
  12952. cli.set_read_timeout(10, 0);
  12953. cli.set_payload_max_length(EXPLICIT_LIMIT); // Explicit 150MB limit
  12954. auto res =
  12955. cli.Get("/large", [&](const char * /*data*/, size_t data_length) {
  12956. total_received += data_length;
  12957. return true;
  12958. });
  12959. // Should fail because 200MB exceeds the explicit 150MB limit
  12960. EXPECT_FALSE(res);
  12961. }
  12962. server_thread.join();
  12963. EXPECT_LE(total_received, EXPLICIT_LIMIT)
  12964. << "Client with content_receiver should respect the explicit "
  12965. << "payload_max_length of " << EXPLICIT_LIMIT << " bytes, but read "
  12966. << total_received << " bytes.";
  12967. }
  12968. // Verify that an explicit set_payload_max_length larger than the response
  12969. // allows the content_receiver to read all data successfully.
  12970. TEST(ClientVulnerabilityTest,
  12971. ContentReceiverRespectsExplicitPayloadMaxLength250MB) {
  12972. static constexpr size_t DATA_SIZE = 200 * 1024 * 1024; // 200MB from server
  12973. static constexpr size_t EXPLICIT_LIMIT = 250 * 1024 * 1024; // 250MB limit
  12974. #ifndef _WIN32
  12975. signal(SIGPIPE, SIG_IGN);
  12976. #endif
  12977. auto server_thread = std::thread([] {
  12978. auto srv = ::socket(AF_INET, SOCK_STREAM, 0);
  12979. default_socket_options(srv);
  12980. detail::set_socket_opt_time(srv, SOL_SOCKET, SO_RCVTIMEO, 5, 0);
  12981. detail::set_socket_opt_time(srv, SOL_SOCKET, SO_SNDTIMEO, 5, 0);
  12982. sockaddr_in addr{};
  12983. addr.sin_family = AF_INET;
  12984. addr.sin_port = htons(static_cast<uint16_t>(PORT + 2));
  12985. ::inet_pton(AF_INET, "127.0.0.1", &addr.sin_addr);
  12986. int opt = 1;
  12987. ::setsockopt(srv, SOL_SOCKET, SO_REUSEADDR,
  12988. #ifdef _WIN32
  12989. reinterpret_cast<const char *>(&opt),
  12990. #else
  12991. &opt,
  12992. #endif
  12993. sizeof(opt));
  12994. ::bind(srv, reinterpret_cast<sockaddr *>(&addr), sizeof(addr));
  12995. ::listen(srv, 1);
  12996. sockaddr_in cli_addr{};
  12997. socklen_t cli_len = sizeof(cli_addr);
  12998. auto cli = ::accept(srv, reinterpret_cast<sockaddr *>(&cli_addr), &cli_len);
  12999. if (cli != INVALID_SOCKET) {
  13000. char buf[4096];
  13001. ::recv(cli, buf, sizeof(buf), 0);
  13002. auto content_length = std::to_string(DATA_SIZE);
  13003. std::string response_header = "HTTP/1.1 200 OK\r\n"
  13004. "Content-Length: " +
  13005. content_length +
  13006. "\r\n"
  13007. "Connection: close\r\n"
  13008. "\r\n";
  13009. ::send(cli,
  13010. #ifdef _WIN32
  13011. static_cast<const char *>(response_header.c_str()),
  13012. static_cast<int>(response_header.size()),
  13013. #else
  13014. response_header.c_str(), response_header.size(),
  13015. #endif
  13016. 0);
  13017. std::string chunk(64 * 1024, 'A');
  13018. size_t total_sent = 0;
  13019. while (total_sent < DATA_SIZE) {
  13020. auto to_send = std::min(chunk.size(), DATA_SIZE - total_sent);
  13021. auto sent = ::send(cli,
  13022. #ifdef _WIN32
  13023. static_cast<const char *>(chunk.c_str()),
  13024. static_cast<int>(to_send),
  13025. #else
  13026. chunk.c_str(), to_send,
  13027. #endif
  13028. 0);
  13029. if (sent <= 0) break;
  13030. total_sent += static_cast<size_t>(sent);
  13031. }
  13032. #ifdef _WIN32
  13033. ::shutdown(cli, SD_SEND);
  13034. #else
  13035. ::shutdown(cli, SHUT_WR);
  13036. #endif
  13037. char drain[1024];
  13038. while (::recv(cli, drain, sizeof(drain), 0) > 0) {}
  13039. detail::close_socket(cli);
  13040. }
  13041. detail::close_socket(srv);
  13042. });
  13043. std::this_thread::sleep_for(std::chrono::milliseconds(200));
  13044. size_t total_received = 0;
  13045. {
  13046. Client cli("127.0.0.1", PORT + 2);
  13047. cli.set_read_timeout(10, 0);
  13048. cli.set_payload_max_length(EXPLICIT_LIMIT); // Explicit 250MB limit
  13049. auto res =
  13050. cli.Get("/large", [&](const char * /*data*/, size_t data_length) {
  13051. total_received += data_length;
  13052. return true;
  13053. });
  13054. ASSERT_TRUE(res) << "Error: " << to_string(res.error());
  13055. EXPECT_EQ(StatusCode::OK_200, res->status);
  13056. }
  13057. server_thread.join();
  13058. EXPECT_EQ(total_received, DATA_SIZE)
  13059. << "With explicit payload_max_length of " << EXPLICIT_LIMIT
  13060. << " bytes (larger than " << DATA_SIZE
  13061. << " bytes response), content_receiver should read all data, but only "
  13062. "read "
  13063. << total_received << " bytes.";
  13064. }
  13065. #if defined(CPPHTTPLIB_ZLIB_SUPPORT) && !defined(_WIN32)
  13066. // Regression test for "zip bomb" attack on the client side: a malicious server
  13067. // sends a small gzip-compressed response that decompresses to a huge payload.
  13068. // The client must enforce payload_max_length on the decompressed size.
  13069. TEST(ClientVulnerabilityTest, ZipBombWithoutContentLength) {
  13070. constexpr size_t DECOMPRESSED_SIZE =
  13071. 10 * 1024 * 1024; // 10MB after decompression
  13072. constexpr size_t CLIENT_READ_LIMIT = 2 * 1024 * 1024; // 2MB safety limit
  13073. // Prepare gzip-compressed data: 10MB of zeros compresses to a few KB
  13074. std::string uncompressed(DECOMPRESSED_SIZE, '\0');
  13075. std::string compressed;
  13076. {
  13077. httplib::detail::gzip_compressor compressor;
  13078. bool ok =
  13079. compressor.compress(uncompressed.data(), uncompressed.size(),
  13080. /*last=*/true, [&](const char *buf, size_t len) {
  13081. compressed.append(buf, len);
  13082. return true;
  13083. });
  13084. ASSERT_TRUE(ok);
  13085. }
  13086. // Sanity: compressed data should be much smaller than the decompressed size
  13087. ASSERT_LT(compressed.size(), DECOMPRESSED_SIZE / 10);
  13088. #ifndef _WIN32
  13089. signal(SIGPIPE, SIG_IGN);
  13090. #endif
  13091. // Set up the listening socket in the main thread so the server is guaranteed
  13092. // to be ready before the client connects (eliminates race condition).
  13093. auto srv = ::socket(AF_INET, SOCK_STREAM, 0);
  13094. default_socket_options(srv);
  13095. detail::set_socket_opt_time(srv, SOL_SOCKET, SO_RCVTIMEO, 5, 0);
  13096. detail::set_socket_opt_time(srv, SOL_SOCKET, SO_SNDTIMEO, 5, 0);
  13097. sockaddr_in addr{};
  13098. addr.sin_family = AF_INET;
  13099. addr.sin_port = htons(static_cast<uint16_t>(PORT + 3));
  13100. ::inet_pton(AF_INET, "127.0.0.1", &addr.sin_addr);
  13101. int opt = 1;
  13102. ::setsockopt(srv, SOL_SOCKET, SO_REUSEADDR,
  13103. #ifdef _WIN32
  13104. reinterpret_cast<const char *>(&opt),
  13105. #else
  13106. &opt,
  13107. #endif
  13108. sizeof(opt));
  13109. ASSERT_EQ(0, ::bind(srv, reinterpret_cast<sockaddr *>(&addr), sizeof(addr)));
  13110. ASSERT_EQ(0, ::listen(srv, 1));
  13111. auto server_thread = std::thread([&compressed, srv] {
  13112. sockaddr_in cli_addr{};
  13113. socklen_t cli_len = sizeof(cli_addr);
  13114. auto cli = ::accept(srv, reinterpret_cast<sockaddr *>(&cli_addr), &cli_len);
  13115. if (cli != INVALID_SOCKET) {
  13116. // Read the full HTTP request (until \r\n\r\n)
  13117. char buf[4096];
  13118. size_t total = 0;
  13119. while (total < sizeof(buf)) {
  13120. auto n = ::recv(cli, buf + total, sizeof(buf) - total, 0);
  13121. if (n <= 0) break;
  13122. total += static_cast<size_t>(n);
  13123. // Check for end of headers
  13124. if (total >= 4) {
  13125. std::string req(buf, total);
  13126. if (req.find("\r\n\r\n") != std::string::npos) break;
  13127. }
  13128. }
  13129. // Malicious response: gzip-compressed body, no Content-Length
  13130. std::string response_header = "HTTP/1.1 200 OK\r\n"
  13131. "Content-Encoding: gzip\r\n"
  13132. "Connection: close\r\n"
  13133. "\r\n";
  13134. ::send(cli,
  13135. #ifdef _WIN32
  13136. static_cast<const char *>(response_header.c_str()),
  13137. static_cast<int>(response_header.size()),
  13138. #else
  13139. response_header.c_str(), response_header.size(),
  13140. #endif
  13141. 0);
  13142. // Send the compressed payload (small on the wire, huge when decompressed)
  13143. size_t total_sent = 0;
  13144. while (total_sent < compressed.size()) {
  13145. auto to_send = std::min(compressed.size() - total_sent,
  13146. static_cast<size_t>(64 * 1024));
  13147. auto sent =
  13148. ::send(cli,
  13149. #ifdef _WIN32
  13150. static_cast<const char *>(compressed.c_str() + total_sent),
  13151. static_cast<int>(to_send),
  13152. #else
  13153. compressed.c_str() + total_sent, to_send,
  13154. #endif
  13155. 0);
  13156. if (sent <= 0) break;
  13157. total_sent += static_cast<size_t>(sent);
  13158. }
  13159. detail::close_socket(cli);
  13160. }
  13161. });
  13162. auto se = detail::scope_exit([&] {
  13163. detail::close_socket(srv);
  13164. server_thread.join();
  13165. });
  13166. size_t total_decompressed = 0;
  13167. {
  13168. Client cli("127.0.0.1", PORT + 3);
  13169. cli.set_read_timeout(5, 0);
  13170. cli.set_decompress(true);
  13171. cli.set_payload_max_length(CLIENT_READ_LIMIT);
  13172. auto stream = cli.open_stream("GET", "/zipbomb");
  13173. ASSERT_TRUE(stream.is_valid());
  13174. char buffer[64 * 1024];
  13175. ssize_t n;
  13176. while ((n = stream.read(buffer, sizeof(buffer))) > 0) {
  13177. total_decompressed += static_cast<size_t>(n);
  13178. }
  13179. }
  13180. // The decompressed size must be capped by payload_max_length. Without
  13181. // protection, the client would decompress the full 10MB from a tiny
  13182. // compressed payload, enabling a zip bomb DoS attack.
  13183. EXPECT_LE(total_decompressed, CLIENT_READ_LIMIT)
  13184. << "Client decompressed " << total_decompressed
  13185. << " bytes from a gzip response. The decompressed size should be "
  13186. << "limited by set_payload_max_length to prevent zip bomb attacks.";
  13187. }
  13188. #endif
  13189. TEST(HostAndPortPropertiesTest, NoSSL) {
  13190. httplib::Client cli("www.google.com", 1234);
  13191. ASSERT_EQ("www.google.com", cli.host());
  13192. ASSERT_EQ(1234, cli.port());
  13193. }
  13194. TEST(HostAndPortPropertiesTest, NoSSLWithSimpleAPI) {
  13195. httplib::Client cli("www.google.com:1234");
  13196. ASSERT_EQ("www.google.com", cli.host());
  13197. ASSERT_EQ(1234, cli.port());
  13198. }
  13199. TEST(HostAndPortPropertiesTest, OverflowPortNumber) {
  13200. // Port number that overflows int — should not crash, client becomes invalid
  13201. httplib::Client cli("http://www.google.com:99999999999999999999");
  13202. ASSERT_FALSE(cli.is_valid());
  13203. }
  13204. TEST(HostAndPortPropertiesTest, PortOutOfRange) {
  13205. // Port 99999 exceeds valid range (1-65535) — should not crash
  13206. httplib::Client cli("http://www.google.com:99999");
  13207. ASSERT_FALSE(cli.is_valid());
  13208. auto res = cli.Get("/");
  13209. EXPECT_FALSE(res);
  13210. EXPECT_EQ(Error::Connection, res.error());
  13211. }
  13212. TEST(HostAndPortPropertiesTest, UserinfoIsNotSupported) {
  13213. httplib::Client cli("http://user:pass@localhost:1234");
  13214. ASSERT_FALSE(cli.is_valid());
  13215. EXPECT_FALSE(cli.Get("/"));
  13216. EXPECT_FALSE(httplib::Client("//user@localhost:1234").is_valid());
  13217. }
  13218. TEST(HostAndPortPropertiesTest, TrailingCharactersInPort) {
  13219. httplib::Client cli("http://www.google.com:80abc");
  13220. ASSERT_FALSE(cli.is_valid());
  13221. }
  13222. #ifdef CPPHTTPLIB_SSL_ENABLED
  13223. TEST(HostAndPortPropertiesTest, SSL) {
  13224. httplib::SSLClient cli("www.google.com");
  13225. ASSERT_EQ("www.google.com", cli.host());
  13226. ASSERT_EQ(443, cli.port());
  13227. }
  13228. TEST(SSLClientTest, UpdateCAStoreWithPem_Online) {
  13229. // Test updating CA store multiple times using PEM-based load_ca_cert_store
  13230. std::string cert;
  13231. read_file(CA_CERT_FILE, cert);
  13232. httplib::SSLClient httplib_client("www.google.com");
  13233. // Load CA store first time
  13234. httplib_client.load_ca_cert_store(cert.data(), cert.size());
  13235. // Load CA store second time (update)
  13236. httplib_client.load_ca_cert_store(cert.data(), cert.size());
  13237. // Verify client is still valid and can make connections
  13238. httplib_client.enable_server_certificate_verification(true);
  13239. auto res = httplib_client.Get("/");
  13240. ASSERT_TRUE(res) << "Error: " << to_string(res.error());
  13241. // Google may return 200 or 301 depending on various factors
  13242. EXPECT_TRUE(res->status == StatusCode::OK_200 ||
  13243. res->status == StatusCode::MovedPermanently_301);
  13244. }
  13245. TEST(SSLClientTest, ServerNameIndication_Online) {
  13246. auto host = "httpbingo.org";
  13247. auto path = std::string{"/get"};
  13248. SSLClient cli(host, 443);
  13249. auto res = cli.Get(path);
  13250. ASSERT_TRUE(res) << "Error: " << to_string(res.error());
  13251. ASSERT_EQ(StatusCode::OK_200, res->status);
  13252. }
  13253. TEST(SSLClientTest, ServerCertificateVerificationError_Online) {
  13254. // Use a site that will cause SSL verification failure due to self-signed cert
  13255. SSLClient cli("self-signed.badssl.com", 443);
  13256. cli.enable_server_certificate_verification(true);
  13257. auto res = cli.Get("/");
  13258. ASSERT_TRUE(!res);
  13259. EXPECT_EQ(Error::SSLServerVerification, res.error());
  13260. // Verify backend error is captured for SSLServerVerification
  13261. // This occurs when certificate verification fails
  13262. // OpenSSL: X509_V_ERR_DEPTH_ZERO_SELF_SIGNED_CERT (18)
  13263. // Mbed TLS: MBEDTLS_X509_BADCERT_NOT_TRUSTED or similar flags
  13264. EXPECT_NE(0UL, res.ssl_backend_error());
  13265. #ifdef CPPHTTPLIB_OPENSSL_SUPPORT
  13266. // For OpenSSL, ssl_error is 0 for verification errors
  13267. EXPECT_EQ(0, res.ssl_error());
  13268. #if !defined(_WIN32) || \
  13269. defined(CPPHTTPLIB_DISABLE_WINDOWS_AUTOMATIC_ROOT_CERTIFICATES_UPDATE)
  13270. // On non-Windows or when Windows Schannel is disabled, the error comes
  13271. // from OpenSSL's verification
  13272. EXPECT_EQ(static_cast<unsigned long>(X509_V_ERR_DEPTH_ZERO_SELF_SIGNED_CERT),
  13273. res.ssl_backend_error());
  13274. #endif
  13275. #endif
  13276. }
  13277. TEST(SSLClientTest, ServerHostnameVerificationError_Online) {
  13278. // Use a site where hostname doesn't match the certificate
  13279. // badssl.com provides wrong.host.badssl.com which has cert for *.badssl.com
  13280. SSLClient cli("wrong.host.badssl.com", 443);
  13281. cli.enable_server_certificate_verification(true);
  13282. cli.enable_server_hostname_verification(true);
  13283. auto res = cli.Get("/");
  13284. ASSERT_TRUE(!res);
  13285. EXPECT_EQ(Error::SSLServerHostnameVerification, res.error());
  13286. // Verify backend error is captured for hostname verification failure
  13287. EXPECT_NE(0UL, res.ssl_backend_error());
  13288. #ifdef CPPHTTPLIB_OPENSSL_SUPPORT
  13289. // For OpenSSL, ssl_error is 0 for verification errors
  13290. EXPECT_EQ(0, res.ssl_error());
  13291. #if !defined(_WIN32) || \
  13292. defined(CPPHTTPLIB_DISABLE_WINDOWS_AUTOMATIC_ROOT_CERTIFICATES_UPDATE)
  13293. // On non-Windows or when Windows Schannel is disabled, the error comes
  13294. // from OpenSSL's hostname verification
  13295. EXPECT_EQ(static_cast<unsigned long>(X509_V_ERR_HOSTNAME_MISMATCH),
  13296. res.ssl_backend_error());
  13297. #endif
  13298. #endif
  13299. }
  13300. #if defined(_WIN32) && defined(CPPHTTPLIB_SSL_ENABLED) && \
  13301. !defined(CPPHTTPLIB_DISABLE_WINDOWS_AUTOMATIC_ROOT_CERTIFICATES_UPDATE)
  13302. TEST(SSLClientTest, WindowsCertificateVerification_DefaultEnabled) {
  13303. SSLClient cli("www.google.com", 443);
  13304. cli.enable_server_certificate_verification(true);
  13305. auto res = cli.Get("/");
  13306. if (res) { EXPECT_NE(StatusCode::InternalServerError_500, res->status); }
  13307. }
  13308. TEST(SSLClientTest, WindowsCertificateVerification_Disabled) {
  13309. SSLClient cli("www.google.com", 443);
  13310. cli.enable_server_certificate_verification(true);
  13311. cli.enable_windows_certificate_verification(false);
  13312. auto res = cli.Get("/");
  13313. if (res) { EXPECT_NE(StatusCode::InternalServerError_500, res->status); }
  13314. }
  13315. // The server sends an intermediate cross-signed by a root Windows trusts,
  13316. // while the leaf's AIA URL leads to one under a root Windows does not trust.
  13317. TEST(SSLClientTest, WindowsCertificateVerification_ServerIntermediates_Online) {
  13318. SSLClient cli("accounts.spotify.com", 443);
  13319. auto res = cli.Get("/");
  13320. ASSERT_TRUE(res) << "Error: " << to_string(res.error())
  13321. << " ssl_backend_error=" << res.ssl_backend_error();
  13322. }
  13323. // Windows, not the backend, decides on the chain: the error is a CryptoAPI
  13324. // policy status, which no backend reports for a self-signed certificate.
  13325. TEST(SSLClientTest, WindowsCertificateVerification_RejectsUntrustedRoot) {
  13326. SSLServer svr(SERVER_CERT2_FILE, SERVER_PRIVATE_KEY_FILE);
  13327. ASSERT_TRUE(svr.is_valid());
  13328. thread t = thread([&]() { ASSERT_TRUE(svr.listen("127.0.0.1", PORT)); });
  13329. auto se = detail::scope_exit([&] {
  13330. svr.stop();
  13331. t.join();
  13332. ASSERT_FALSE(svr.is_running());
  13333. });
  13334. svr.wait_until_ready();
  13335. SSLClient cli("127.0.0.1", PORT);
  13336. cli.set_connection_timeout(30);
  13337. auto res = cli.Get("/");
  13338. ASSERT_FALSE(res);
  13339. EXPECT_EQ(Error::SSLServerVerification, res.error());
  13340. EXPECT_EQ(static_cast<DWORD>(CERT_E_UNTRUSTEDROOT), res.ssl_backend_error());
  13341. }
  13342. #endif
  13343. TEST(SSLClientTest, ServerCertificateVerification1_Online) {
  13344. Client cli("https://google.com");
  13345. auto res = cli.Get("/");
  13346. ASSERT_TRUE(res) << "Error: " << to_string(res.error());
  13347. ASSERT_EQ(StatusCode::MovedPermanently_301, res->status);
  13348. }
  13349. TEST(SSLClientTest, ServerCertificateVerification2_Online) {
  13350. SSLClient cli("google.com");
  13351. cli.set_ca_cert_path(CA_CERT_FILE);
  13352. auto res = cli.Get("/");
  13353. ASSERT_TRUE(res) << "Error: " << to_string(res.error());
  13354. ASSERT_EQ(StatusCode::MovedPermanently_301, res->status);
  13355. }
  13356. TEST(SSLClientTest, ServerCertificateVerification3_Online) {
  13357. SSLClient cli("google.com");
  13358. cli.enable_server_certificate_verification(true);
  13359. cli.set_ca_cert_path("hello");
  13360. auto res = cli.Get("/");
  13361. ASSERT_TRUE(!res);
  13362. EXPECT_EQ(Error::SSLLoadingCerts, res.error());
  13363. // For SSL_CTX operations, ssl_error should be 0, only ssl_backend_error
  13364. // should be set
  13365. EXPECT_EQ(0, res.ssl_error());
  13366. // Verify backend error is captured for SSLLoadingCerts
  13367. // This error occurs when loading CA certificates fails
  13368. EXPECT_NE(0UL, res.ssl_backend_error());
  13369. #ifdef CPPHTTPLIB_OPENSSL_SUPPORT
  13370. // OpenSSL specific error codes:
  13371. // > openssl errstr 0x80000002
  13372. // error:80000002:system library::No such file or directory
  13373. // > openssl errstr 0xA000126
  13374. // error:0A000126:SSL routines::unexpected eof while reading
  13375. EXPECT_TRUE(res.ssl_backend_error() == 0x80000002 ||
  13376. res.ssl_backend_error() == 0xA000126);
  13377. #endif
  13378. }
  13379. TEST(SSLClientTest, ServerCertificateVerification4) {
  13380. SSLServer svr(SERVER_CERT2_FILE, SERVER_PRIVATE_KEY_FILE);
  13381. ASSERT_TRUE(svr.is_valid());
  13382. svr.Get("/test", [&](const Request &, Response &res) {
  13383. res.set_content("test", "text/plain");
  13384. svr.stop();
  13385. ASSERT_TRUE(true);
  13386. });
  13387. thread t = thread([&]() { ASSERT_TRUE(svr.listen("127.0.0.1", PORT)); });
  13388. auto se = detail::scope_exit([&] {
  13389. t.join();
  13390. ASSERT_FALSE(svr.is_running());
  13391. });
  13392. svr.wait_until_ready();
  13393. SSLClient cli("127.0.0.1", PORT);
  13394. cli.set_ca_cert_path(SERVER_CERT2_FILE);
  13395. cli.enable_server_certificate_verification(true);
  13396. cli.set_connection_timeout(30);
  13397. auto res = cli.Get("/test");
  13398. ASSERT_TRUE(res) << "Error: " << to_string(res.error());
  13399. ASSERT_EQ(StatusCode::OK_200, res->status);
  13400. }
  13401. TEST(SSLClientTest, ServerCertificateVerification5_Online) {
  13402. std::string cert;
  13403. read_file(CA_CERT_FILE, cert);
  13404. SSLClient cli("google.com");
  13405. cli.load_ca_cert_store(cert.data(), cert.size());
  13406. const auto res = cli.Get("/");
  13407. ASSERT_TRUE(res) << "Error: " << to_string(res.error());
  13408. ASSERT_EQ(StatusCode::MovedPermanently_301, res->status);
  13409. }
  13410. TEST(SSLClientTest, ServerCertificateVerification6_Online) {
  13411. // clang-format off
  13412. static constexpr char cert[] =
  13413. "GlobalSign Root CA\n"
  13414. "==================\n"
  13415. "-----BEGIN CERTIFICATE-----\n"
  13416. "MIIDdTCCAl2gAwIBAgILBAAAAAABFUtaw5QwDQYJKoZIhvcNAQEFBQAwVzELMAkGA1UEBhMCQkUx\n"
  13417. "GTAXBgNVBAoTEEdsb2JhbFNpZ24gbnYtc2ExEDAOBgNVBAsTB1Jvb3QgQ0ExGzAZBgNVBAMTEkds\n"
  13418. "b2JhbFNpZ24gUm9vdCBDQTAeFw05ODA5MDExMjAwMDBaFw0yODAxMjgxMjAwMDBaMFcxCzAJBgNV\n"
  13419. "BAYTAkJFMRkwFwYDVQQKExBHbG9iYWxTaWduIG52LXNhMRAwDgYDVQQLEwdSb290IENBMRswGQYD\n"
  13420. "VQQDExJHbG9iYWxTaWduIFJvb3QgQ0EwggEiMA0GCSqGSIb3DQEBAQUAA4IBDwAwggEKAoIBAQDa\n"
  13421. "DuaZjc6j40+Kfvvxi4Mla+pIH/EqsLmVEQS98GPR4mdmzxzdzxtIK+6NiY6arymAZavpxy0Sy6sc\n"
  13422. "THAHoT0KMM0VjU/43dSMUBUc71DuxC73/OlS8pF94G3VNTCOXkNz8kHp1Wrjsok6Vjk4bwY8iGlb\n"
  13423. "Kk3Fp1S4bInMm/k8yuX9ifUSPJJ4ltbcdG6TRGHRjcdGsnUOhugZitVtbNV4FpWi6cgKOOvyJBNP\n"
  13424. "c1STE4U6G7weNLWLBYy5d4ux2x8gkasJU26Qzns3dLlwR5EiUWMWea6xrkEmCMgZK9FGqkjWZCrX\n"
  13425. "gzT/LCrBbBlDSgeF59N89iFo7+ryUp9/k5DPAgMBAAGjQjBAMA4GA1UdDwEB/wQEAwIBBjAPBgNV\n"
  13426. "HRMBAf8EBTADAQH/MB0GA1UdDgQWBBRge2YaRQ2XyolQL30EzTSo//z9SzANBgkqhkiG9w0BAQUF\n"
  13427. "AAOCAQEA1nPnfE920I2/7LqivjTFKDK1fPxsnCwrvQmeU79rXqoRSLblCKOzyj1hTdNGCbM+w6Dj\n"
  13428. "Y1Ub8rrvrTnhQ7k4o+YviiY776BQVvnGCv04zcQLcFGUl5gE38NflNUVyRRBnMRddWQVDf9VMOyG\n"
  13429. "j/8N7yy5Y0b2qvzfvGn9LhJIZJrglfCm7ymPAbEVtQwdpf5pLGkkeB6zpxxxYu7KyJesF12KwvhH\n"
  13430. "hm4qxFYxldBniYUr+WymXUadDKqC5JlR3XC321Y9YeRq4VzW9v493kHMB65jUr9TU/Qr6cf9tveC\n"
  13431. "X4XSQRjbgbMEHMUfpIBvFSDJ3gyICh3WZlXi/EjJKSZp4A==\n"
  13432. "-----END CERTIFICATE-----\n";
  13433. // clang-format on
  13434. SSLClient cli("google.com");
  13435. cli.load_ca_cert_store(cert, sizeof(cert));
  13436. const auto res = cli.Get("/");
  13437. ASSERT_TRUE(res) << "Error: " << to_string(res.error());
  13438. ASSERT_EQ(StatusCode::MovedPermanently_301, res->status);
  13439. }
  13440. TEST(SSLClientTest, WildcardHostNameMatch_Online) {
  13441. SSLClient cli("www.youtube.com");
  13442. cli.set_ca_cert_path(CA_CERT_FILE);
  13443. cli.enable_server_certificate_verification(true);
  13444. cli.set_follow_location(true);
  13445. auto res = cli.Get("/");
  13446. ASSERT_TRUE(res) << "Error: " << to_string(res.error());
  13447. ASSERT_EQ(StatusCode::OK_200, res->status);
  13448. }
  13449. TEST(SSLClientTest, WildcardHostNameMatchCase_Online) {
  13450. SSLClient cli("wWw.YouTube.Com");
  13451. cli.set_ca_cert_path(CA_CERT_FILE);
  13452. cli.enable_server_certificate_verification(true);
  13453. cli.enable_server_hostname_verification(true);
  13454. cli.set_follow_location(true);
  13455. auto res = cli.Get("/");
  13456. ASSERT_TRUE(res) << "Error: " << to_string(res.error());
  13457. ASSERT_EQ(StatusCode::OK_200, res->status);
  13458. }
  13459. TEST(SSLClientTest, HostNameMatchCase_Online) {
  13460. SSLClient cli("gOoGlE.COm");
  13461. cli.enable_server_certificate_verification(true);
  13462. cli.enable_server_hostname_verification(true);
  13463. cli.set_follow_location(true);
  13464. auto res = cli.Get("/");
  13465. ASSERT_TRUE(res) << "Error: " << to_string(res.error());
  13466. ASSERT_EQ(StatusCode::OK_200, res->status);
  13467. }
  13468. TEST(SSLClientTest, Issue2004_Online) {
  13469. Client client("https://google.com");
  13470. client.set_follow_location(true);
  13471. auto res = client.Get("/");
  13472. ASSERT_TRUE(res) << "Error: " << to_string(res.error());
  13473. ASSERT_EQ(StatusCode::OK_200, res->status);
  13474. auto body = res->body;
  13475. EXPECT_EQ(body.substr(0, 15), "<!doctype html>");
  13476. }
  13477. TEST(SSLClientTest, ErrorReportingWhenInvalid) {
  13478. // Create SSLClient with invalid cert/key to make is_valid() return false
  13479. SSLClient cli("localhost", 8080, "nonexistent_cert.pem",
  13480. "nonexistent_key.pem");
  13481. // is_valid() should be false due to cert loading failure
  13482. ASSERT_FALSE(cli.is_valid());
  13483. auto res = cli.Get("/");
  13484. ASSERT_FALSE(res);
  13485. EXPECT_EQ(Error::SSLConnection, res.error());
  13486. }
  13487. TEST(SSLClientTest, Issue2251_SwappedClientCertAndKey) {
  13488. // Test for Issue #2251: SSL error not properly reported when client cert
  13489. // and key paths are swapped or mismatched
  13490. // This simulates the scenario where user accidentally swaps the cert and key
  13491. // files
  13492. // Using client cert file as private key and vice versa (completely wrong)
  13493. SSLClient cli("localhost", 8080, "client.key.pem", "client.cert.pem");
  13494. // Should fail validation due to cert/key mismatch
  13495. ASSERT_FALSE(cli.is_valid());
  13496. // Attempt to make a request should fail with proper error
  13497. auto res = cli.Get("/");
  13498. ASSERT_FALSE(res);
  13499. EXPECT_EQ(Error::SSLConnection, res.error());
  13500. // SSL error should be recorded in the Result object (this is the key fix for
  13501. // Issue #2251)
  13502. auto backend_error = res.ssl_backend_error();
  13503. EXPECT_NE(0u, backend_error);
  13504. }
  13505. // Tests cert/key mismatch detection at the TLS context level
  13506. TEST(TlsApiTest, ClientCertKeyMismatch) {
  13507. // Test that using mismatched cert/key causes connection failure.
  13508. // We verify this at the SSLClient level rather than through internal
  13509. // TLS API functions.
  13510. SSLClient cli(HOST, PORT, "client.cert.pem", "key.pem");
  13511. cli.enable_server_certificate_verification(false);
  13512. cli.set_connection_timeout(2);
  13513. // The mismatch should cause a connection or handshake error
  13514. auto res = cli.Get("/test");
  13515. // OpenSSL detects mismatch at context setup, MbedTLS at handshake
  13516. // Either way, the request should fail
  13517. EXPECT_FALSE(res);
  13518. }
  13519. #endif
  13520. #if 0
  13521. TEST(SSLClientTest, SetInterfaceWithINET6) {
  13522. auto cli = std::make_shared<httplib::Client>("https://httpcan.org");
  13523. ASSERT_TRUE(cli != nullptr);
  13524. cli->set_address_family(AF_INET6);
  13525. cli->set_interface("en0");
  13526. auto res = cli->Get("/get");
  13527. ASSERT_TRUE(res) << "Error: " << to_string(res.error());
  13528. ASSERT_EQ(StatusCode::OK_200, res->status);
  13529. }
  13530. #endif
  13531. // Client certificate tests - work with all TLS backends
  13532. #ifdef CPPHTTPLIB_SSL_ENABLED
  13533. using ClientCertServerSetup = std::function<void(SSLServer &)>;
  13534. void ClientCertPresent(
  13535. const std::string &client_cert_file,
  13536. const std::string &client_private_key_file,
  13537. const std::string &client_encrypted_private_key_pass = std::string(),
  13538. const ClientCertServerSetup &setup = nullptr) {
  13539. SSLServer svr(SERVER_CERT_FILE, SERVER_PRIVATE_KEY_FILE, CLIENT_CA_CERT_FILE,
  13540. CLIENT_CA_CERT_DIR);
  13541. ASSERT_TRUE(svr.is_valid());
  13542. if (setup) { setup(svr); }
  13543. svr.Get("/test", [&](const Request &req, Response &res) {
  13544. res.set_content("test", "text/plain");
  13545. auto cert = req.peer_cert();
  13546. ASSERT_TRUE(static_cast<bool>(cert));
  13547. std::string common_name = cert.subject_cn();
  13548. EXPECT_EQ("Common Name", common_name);
  13549. });
  13550. auto port = svr.bind_to_any_port(HOST);
  13551. ASSERT_LT(0, port);
  13552. thread t = thread([&]() { svr.listen_after_bind(); });
  13553. auto se = detail::scope_exit([&] {
  13554. svr.stop();
  13555. t.join();
  13556. ASSERT_FALSE(svr.is_running());
  13557. });
  13558. svr.wait_until_ready();
  13559. SSLClient cli(HOST, port, client_cert_file, client_private_key_file,
  13560. client_encrypted_private_key_pass);
  13561. cli.enable_server_certificate_verification(false);
  13562. cli.set_connection_timeout(30);
  13563. auto res = cli.Get("/test");
  13564. ASSERT_TRUE(res) << "Error: " << to_string(res.error());
  13565. ASSERT_EQ(StatusCode::OK_200, res->status);
  13566. }
  13567. TEST(SSLClientServerTest, ClientCertPresent) {
  13568. ClientCertPresent(CLIENT_CERT_FILE, CLIENT_PRIVATE_KEY_FILE);
  13569. }
  13570. TEST(SSLClientServerTest, ClientEncryptedCertPresent) {
  13571. ClientCertPresent(CLIENT_ENCRYPTED_CERT_FILE,
  13572. CLIENT_ENCRYPTED_PRIVATE_KEY_FILE,
  13573. CLIENT_ENCRYPTED_PRIVATE_KEY_PASS);
  13574. }
  13575. void ClientCertMissing(const ClientCertServerSetup &setup = nullptr) {
  13576. SSLServer svr(SERVER_CERT_FILE, SERVER_PRIVATE_KEY_FILE, CLIENT_CA_CERT_FILE,
  13577. CLIENT_CA_CERT_DIR);
  13578. ASSERT_TRUE(svr.is_valid());
  13579. if (setup) { setup(svr); }
  13580. svr.Get("/test", [](const Request &, Response &) { FAIL(); });
  13581. auto port = svr.bind_to_any_port(HOST);
  13582. ASSERT_LT(0, port);
  13583. thread t = thread([&]() { svr.listen_after_bind(); });
  13584. auto se = detail::scope_exit([&] {
  13585. svr.stop();
  13586. t.join();
  13587. ASSERT_FALSE(svr.is_running());
  13588. });
  13589. svr.wait_until_ready();
  13590. SSLClient cli(HOST, port);
  13591. cli.set_connection_timeout(30);
  13592. // Skip the server certificate check, so that the request fails because the
  13593. // client certificate is missing rather than because cert.pem is not trusted
  13594. cli.enable_server_certificate_verification(false);
  13595. auto res = cli.Get("/test");
  13596. ASSERT_FALSE(res);
  13597. // The server rejects the client during the handshake, or on TLS 1.3 right
  13598. // after it, which the client notices on its first write or read
  13599. EXPECT_TRUE(res.error() == Error::SSLConnection ||
  13600. res.error() == Error::Write || res.error() == Error::Read)
  13601. << to_string(res.error());
  13602. if (res.error() == Error::SSLConnection) {
  13603. EXPECT_NE(0UL, res.ssl_backend_error());
  13604. }
  13605. // A rejection noticed on the write keeps the TLS error the write hit
  13606. if (res.error() == Error::Write) { EXPECT_NE(0, res.ssl_error()); }
  13607. }
  13608. TEST(SSLClientServerTest, ClientCertMissing) { ClientCertMissing(); }
  13609. // A server that requires client certificates must keep requiring them after a
  13610. // verify callback is set on its context, or set and then cleared again.
  13611. void ClientCertStillRequired(bool clear_callback) {
  13612. auto setup = [clear_callback](SSLServer &svr) {
  13613. ASSERT_TRUE(tls::set_verify_callback(
  13614. svr.tls_context(), [](const tls::VerifyContext &) { return true; }));
  13615. if (clear_callback) {
  13616. ASSERT_TRUE(tls::set_verify_callback(svr.tls_context(), nullptr));
  13617. }
  13618. };
  13619. ClientCertMissing(setup);
  13620. ClientCertPresent(CLIENT_CERT_FILE, CLIENT_PRIVATE_KEY_FILE, std::string(),
  13621. setup);
  13622. }
  13623. TEST(SSLClientServerTest, ClientCertStillRequiredAfterVerifyCallbackSet) {
  13624. ClientCertStillRequired(false);
  13625. }
  13626. TEST(SSLClientServerTest, ClientCertStillRequiredAfterVerifyCallbackCleared) {
  13627. ClientCertStillRequired(true);
  13628. }
  13629. // A TLS error from one request must not show up in a later request's Result
  13630. TEST(SSLClientServerTest, SSLErrorNotCarriedToLaterRequest) {
  13631. SSLServer svr(SERVER_CERT_FILE, SERVER_PRIVATE_KEY_FILE);
  13632. ASSERT_TRUE(svr.is_valid());
  13633. svr.Get("/test", [](const Request &, Response &res) {
  13634. res.set_content("test", "text/plain");
  13635. });
  13636. auto port = svr.bind_to_any_port(HOST);
  13637. ASSERT_LT(0, port);
  13638. thread t = thread([&]() { svr.listen_after_bind(); });
  13639. auto se = detail::scope_exit([&] {
  13640. svr.stop();
  13641. t.join();
  13642. ASSERT_FALSE(svr.is_running());
  13643. });
  13644. svr.wait_until_ready();
  13645. SSLClient cli(HOST, port);
  13646. cli.set_connection_timeout(30);
  13647. cli.enable_server_hostname_verification(false);
  13648. // cert.pem is not trusted, so the handshake fails
  13649. ASSERT_FALSE(cli.Get("/test"));
  13650. cli.enable_server_certificate_verification(false);
  13651. auto res = cli.Get("/test");
  13652. ASSERT_TRUE(res) << "Error: " << to_string(res.error());
  13653. EXPECT_EQ(0, res.ssl_error());
  13654. EXPECT_EQ(0UL, res.ssl_backend_error());
  13655. }
  13656. // PEM memory-based constructor tests (works with all TLS backends)
  13657. void PemMemoryClientCertPresent(
  13658. const std::string &client_cert_file,
  13659. const std::string &client_private_key_file,
  13660. const std::string &client_encrypted_private_key_pass = std::string()) {
  13661. // Read PEM files into memory
  13662. std::string server_cert_pem, server_key_pem;
  13663. std::string client_ca_pem;
  13664. std::string client_cert_pem, client_key_pem;
  13665. read_file(SERVER_CERT_FILE, server_cert_pem);
  13666. read_file(SERVER_PRIVATE_KEY_FILE, server_key_pem);
  13667. read_file(CLIENT_CA_CERT_FILE, client_ca_pem);
  13668. read_file(client_cert_file, client_cert_pem);
  13669. read_file(client_private_key_file, client_key_pem);
  13670. // Create server with PEM memory
  13671. SSLServer::PemMemory server_pem = {
  13672. server_cert_pem.c_str(),
  13673. server_cert_pem.size(),
  13674. server_key_pem.c_str(),
  13675. server_key_pem.size(),
  13676. client_ca_pem.c_str(),
  13677. client_ca_pem.size(),
  13678. nullptr // no password for server key
  13679. };
  13680. SSLServer svr(server_pem);
  13681. ASSERT_TRUE(svr.is_valid());
  13682. svr.Get("/test", [&](const Request &, Response &res) {
  13683. res.set_content("test", "text/plain");
  13684. });
  13685. thread t = thread([&]() { ASSERT_TRUE(svr.listen(HOST, PORT)); });
  13686. auto se = detail::scope_exit([&] {
  13687. svr.stop();
  13688. t.join();
  13689. ASSERT_FALSE(svr.is_running());
  13690. });
  13691. svr.wait_until_ready();
  13692. // Create client with PEM memory
  13693. const char *password = client_encrypted_private_key_pass.empty()
  13694. ? nullptr
  13695. : client_encrypted_private_key_pass.c_str();
  13696. SSLClient::PemMemory client_pem = {
  13697. client_cert_pem.c_str(), client_cert_pem.size(), client_key_pem.c_str(),
  13698. client_key_pem.size(), password};
  13699. SSLClient cli(HOST, PORT, client_pem);
  13700. cli.enable_server_certificate_verification(false);
  13701. cli.set_connection_timeout(30);
  13702. auto res = cli.Get("/test");
  13703. ASSERT_TRUE(res) << "Error: " << to_string(res.error());
  13704. ASSERT_EQ(StatusCode::OK_200, res->status);
  13705. }
  13706. TEST(SSLClientServerTest, PemMemoryClientCertPresent) {
  13707. PemMemoryClientCertPresent(CLIENT_CERT_FILE, CLIENT_PRIVATE_KEY_FILE);
  13708. }
  13709. TEST(SSLClientServerTest, PemMemoryClientEncryptedCertPresent) {
  13710. PemMemoryClientCertPresent(CLIENT_ENCRYPTED_CERT_FILE,
  13711. CLIENT_ENCRYPTED_PRIVATE_KEY_FILE,
  13712. CLIENT_ENCRYPTED_PRIVATE_KEY_PASS);
  13713. }
  13714. TEST(SSLClientServerTest, TrustDirOptional) {
  13715. SSLServer svr(SERVER_CERT_FILE, SERVER_PRIVATE_KEY_FILE, CLIENT_CA_CERT_FILE);
  13716. ASSERT_TRUE(svr.is_valid());
  13717. svr.Get("/test", [&](const Request &, Response &res) {
  13718. res.set_content("test", "text/plain");
  13719. });
  13720. thread t = thread([&]() { ASSERT_TRUE(svr.listen(HOST, PORT)); });
  13721. auto se = detail::scope_exit([&] {
  13722. svr.stop();
  13723. t.join();
  13724. ASSERT_FALSE(svr.is_running());
  13725. });
  13726. svr.wait_until_ready();
  13727. SSLClient cli(HOST, PORT, CLIENT_CERT_FILE, CLIENT_PRIVATE_KEY_FILE);
  13728. cli.enable_server_certificate_verification(false);
  13729. cli.set_connection_timeout(30);
  13730. auto res = cli.Get("/test");
  13731. ASSERT_TRUE(res) << "Error: " << to_string(res.error());
  13732. ASSERT_EQ(StatusCode::OK_200, res->status);
  13733. }
  13734. TEST(SSLClientServerTest, SSLConnectTimeout) {
  13735. class NoListenSSLServer : public SSLServer {
  13736. public:
  13737. NoListenSSLServer(const char *cert_path, const char *private_key_path,
  13738. const char *client_ca_cert_file_path,
  13739. const char *client_ca_cert_dir_path = nullptr)
  13740. : SSLServer(cert_path, private_key_path, client_ca_cert_file_path,
  13741. client_ca_cert_dir_path),
  13742. stop_(false) {}
  13743. std::atomic_bool stop_;
  13744. private:
  13745. bool process_and_close_socket(socket_t /*sock*/) override {
  13746. // Don't create SSL context
  13747. while (!stop_.load()) {
  13748. std::this_thread::sleep_for(std::chrono::milliseconds(100));
  13749. }
  13750. return true;
  13751. }
  13752. };
  13753. NoListenSSLServer svr(SERVER_CERT_FILE, SERVER_PRIVATE_KEY_FILE,
  13754. CLIENT_CA_CERT_FILE);
  13755. ASSERT_TRUE(svr.is_valid());
  13756. svr.Get("/test", [&](const Request &, Response &res) {
  13757. res.set_content("test", "text/plain");
  13758. });
  13759. thread t = thread([&]() { ASSERT_TRUE(svr.listen(HOST, PORT)); });
  13760. auto se = detail::scope_exit([&] {
  13761. svr.stop_ = true;
  13762. svr.stop();
  13763. t.join();
  13764. ASSERT_FALSE(svr.is_running());
  13765. });
  13766. svr.wait_until_ready();
  13767. SSLClient cli(HOST, PORT, CLIENT_CERT_FILE, CLIENT_PRIVATE_KEY_FILE);
  13768. cli.enable_server_certificate_verification(false);
  13769. cli.set_connection_timeout(1);
  13770. auto res = cli.Get("/test");
  13771. ASSERT_TRUE(!res);
  13772. EXPECT_EQ(Error::SSLConnection, res.error());
  13773. // Timeout results in WantRead error code (maps to backend-specific value)
  13774. EXPECT_NE(0, res.ssl_error());
  13775. }
  13776. TEST(SSLClientServerTest, CustomizeServerSSLCtxGeneric) {
  13777. // Test SSLServer with client certificate verification using the standard
  13778. // constructor (ContextSetupCallback is tested by backend-specific tests)
  13779. SSLServer svr(SERVER_CERT_FILE, SERVER_PRIVATE_KEY_FILE, CLIENT_CA_CERT_FILE,
  13780. CLIENT_CA_CERT_DIR);
  13781. ASSERT_TRUE(svr.is_valid());
  13782. svr.Get("/test", [&](const Request &req, Response &res) {
  13783. res.set_content("test", "text/plain");
  13784. auto cert = req.peer_cert();
  13785. ASSERT_TRUE(static_cast<bool>(cert));
  13786. auto common_name = cert.subject_cn();
  13787. EXPECT_EQ("Common Name", common_name);
  13788. });
  13789. thread t = thread([&]() { ASSERT_TRUE(svr.listen(HOST, PORT)); });
  13790. auto se = detail::scope_exit([&] {
  13791. svr.stop();
  13792. t.join();
  13793. ASSERT_FALSE(svr.is_running());
  13794. });
  13795. svr.wait_until_ready();
  13796. SSLClient cli(HOST, PORT, CLIENT_CERT_FILE, CLIENT_PRIVATE_KEY_FILE);
  13797. cli.enable_server_certificate_verification(false);
  13798. cli.set_connection_timeout(30);
  13799. auto res = cli.Get("/test");
  13800. ASSERT_TRUE(res) << "Error: " << to_string(res.error());
  13801. ASSERT_EQ(StatusCode::OK_200, res->status);
  13802. }
  13803. // Test verify_hostname for both OpenSSL and MbedTLS backends
  13804. // Verifies that wildcard matching and exact matching work consistently
  13805. TEST(SSLClientServerTest, TlsVerifyHostname) {
  13806. using namespace httplib::tls;
  13807. // We need a running server to test against
  13808. SSLServer svr(SERVER_CERT_FILE, SERVER_PRIVATE_KEY_FILE);
  13809. ASSERT_TRUE(svr.is_valid());
  13810. svr.Get("/test", [](const Request &, Response &res) {
  13811. res.set_content("ok", "text/plain");
  13812. });
  13813. thread t([&]() { svr.listen(HOST, PORT); });
  13814. auto se = detail::scope_exit([&] {
  13815. svr.stop();
  13816. t.join();
  13817. });
  13818. svr.wait_until_ready();
  13819. bool verify_callback_called = false;
  13820. bool verify_result_wrong = false;
  13821. SSLClient cli(HOST, PORT);
  13822. cli.enable_server_certificate_verification(true);
  13823. cli.set_ca_cert_path(CA_CERT_FILE);
  13824. cli.set_connection_timeout(5);
  13825. // Note: Test certificate has CN="Common Name", not "localhost"
  13826. bool verify_result_cn = false;
  13827. cli.set_server_certificate_verifier([&](const VerifyContext &ctx) -> bool {
  13828. verify_callback_called = true;
  13829. if (!ctx.cert) return false;
  13830. // Test 1: "Common Name" should match (our test server cert CN)
  13831. verify_result_cn = ctx.check_hostname("Common Name");
  13832. // Test 2: wrong hostname should not match
  13833. verify_result_wrong = ctx.check_hostname("wronghost.example.com");
  13834. return true; // Accept for the purpose of this test
  13835. });
  13836. auto res = cli.Get("/test");
  13837. // The request may succeed or fail depending on cert configuration
  13838. // but the callback should have been called
  13839. ASSERT_TRUE(verify_callback_called)
  13840. << "Verify callback should have been called";
  13841. // CN="Common Name" should match our test certificate
  13842. //
  13843. // BoringSSL intentionally drops CN-based hostname matching per RFC 6125
  13844. // §6.4.4 — only SubjectAltName is consulted. Other backends (OpenSSL,
  13845. // MbedTLS, wolfSSL) still honor the CN fallback, so flip the expectation
  13846. // for BoringSSL builds. OPENSSL_IS_BORINGSSL is defined by BoringSSL's
  13847. // <openssl/base.h>, which is included transitively when
  13848. // CPPHTTPLIB_OPENSSL_SUPPORT is set against a BoringSSL install.
  13849. #if defined(OPENSSL_IS_BORINGSSL)
  13850. EXPECT_FALSE(verify_result_cn)
  13851. << "BoringSSL should reject CN-based hostname matching (SAN-only)";
  13852. #else
  13853. EXPECT_TRUE(verify_result_cn)
  13854. << "verify_hostname should match 'Common Name' (certificate CN)";
  13855. #endif
  13856. // Wrong hostname should not match
  13857. EXPECT_FALSE(verify_result_wrong)
  13858. << "verify_hostname should not match 'wronghost.example.com'";
  13859. }
  13860. // An IP-literal host must only be authenticated via an iPAddress SAN, never via
  13861. // the certificate's Common Name (RFC 9110). This mirrors the OpenSSL backend's
  13862. // X509_check_ip behavior and must hold for every backend.
  13863. TEST(SSLClientServerTest, TlsVerifyHostnameIpNotMatchedByCommonName) {
  13864. using namespace httplib::tls;
  13865. // Certificate CN is the IPv4 literal "127.0.0.1" and it carries no SAN.
  13866. SSLServer svr(SERVER_CERT_IP_CN_FILE, SERVER_PRIVATE_KEY_FILE);
  13867. ASSERT_TRUE(svr.is_valid());
  13868. svr.Get("/test", [](const Request &, Response &res) {
  13869. res.set_content("ok", "text/plain");
  13870. });
  13871. thread t([&]() { svr.listen(HOST, PORT); });
  13872. auto se = detail::scope_exit([&] {
  13873. svr.stop();
  13874. t.join();
  13875. });
  13876. svr.wait_until_ready();
  13877. bool verify_callback_called = false;
  13878. bool ip_matched_via_cn = true;
  13879. SSLClient cli(HOST, PORT);
  13880. cli.enable_server_certificate_verification(true);
  13881. cli.set_ca_cert_path(CA_CERT_FILE);
  13882. cli.set_connection_timeout(5);
  13883. cli.set_server_certificate_verifier([&](const VerifyContext &ctx) -> bool {
  13884. verify_callback_called = true;
  13885. if (!ctx.cert) return false;
  13886. // The IP appears only in the CN, so it must NOT be accepted.
  13887. ip_matched_via_cn = ctx.check_hostname("127.0.0.1");
  13888. return true; // Accept for the purpose of this test
  13889. });
  13890. cli.Get("/test");
  13891. ASSERT_TRUE(verify_callback_called)
  13892. << "Verify callback should have been called";
  13893. EXPECT_FALSE(ip_matched_via_cn)
  13894. << "An IP host must not be authenticated via the certificate CN";
  13895. }
  13896. // IPv6 hosts must be matched against IPv6 iPAddress SANs (and only those).
  13897. TEST(SSLClientServerTest, TlsVerifyHostnameIpv6San) {
  13898. using namespace httplib::tls;
  13899. // Certificate CN is "::1" and it carries an IPv6 SAN for "2001:db8::1".
  13900. SSLServer svr(SERVER_CERT_IPV6_FILE, SERVER_PRIVATE_KEY_FILE);
  13901. ASSERT_TRUE(svr.is_valid());
  13902. svr.Get("/test", [](const Request &, Response &res) {
  13903. res.set_content("ok", "text/plain");
  13904. });
  13905. thread t([&]() { svr.listen(HOST, PORT); });
  13906. auto se = detail::scope_exit([&] {
  13907. svr.stop();
  13908. t.join();
  13909. });
  13910. svr.wait_until_ready();
  13911. bool verify_callback_called = false;
  13912. bool san_matched = false;
  13913. bool wrong_ipv6_matched = true;
  13914. bool cn_ipv6_matched = true;
  13915. SSLClient cli(HOST, PORT);
  13916. cli.enable_server_certificate_verification(true);
  13917. cli.set_ca_cert_path(CA_CERT_FILE);
  13918. cli.set_connection_timeout(5);
  13919. cli.set_server_certificate_verifier([&](const VerifyContext &ctx) -> bool {
  13920. verify_callback_called = true;
  13921. if (!ctx.cert) return false;
  13922. // Matches the IPv6 iPAddress SAN.
  13923. san_matched = ctx.check_hostname("2001:db8::1");
  13924. // A different IPv6 address must not match.
  13925. wrong_ipv6_matched = ctx.check_hostname("2001:db8::2");
  13926. // "::1" lives only in the CN, so it must not be accepted.
  13927. cn_ipv6_matched = ctx.check_hostname("::1");
  13928. return true; // Accept for the purpose of this test
  13929. });
  13930. cli.Get("/test");
  13931. ASSERT_TRUE(verify_callback_called)
  13932. << "Verify callback should have been called";
  13933. EXPECT_TRUE(san_matched)
  13934. << "verify_hostname should match an IPv6 iPAddress SAN";
  13935. EXPECT_FALSE(wrong_ipv6_matched)
  13936. << "verify_hostname should not match a non-matching IPv6 address";
  13937. EXPECT_FALSE(cn_ipv6_matched)
  13938. << "An IPv6 host must not be authenticated via the certificate CN";
  13939. }
  13940. // A SAN entry must only match a host of its own type: the bytes of the dNSName
  13941. // "a.zz" are also 97.46.122.122, and 42.46.122.122 reads as "*.zz".
  13942. TEST(SSLClientServerTest, TlsVerifyHostnameSanType) {
  13943. using namespace httplib::tls;
  13944. // SANs: DNS:a.zz, IP:42.46.122.122
  13945. SSLServer svr(SERVER_CERT_SAN_TYPES_FILE, SERVER_PRIVATE_KEY_FILE);
  13946. ASSERT_TRUE(svr.is_valid());
  13947. svr.Get("/test", [](const Request &, Response &res) {
  13948. res.set_content("ok", "text/plain");
  13949. });
  13950. auto port = svr.bind_to_any_port(HOST);
  13951. thread t([&]() { svr.listen_after_bind(); });
  13952. auto se = detail::scope_exit([&] {
  13953. svr.stop();
  13954. t.join();
  13955. });
  13956. svr.wait_until_ready();
  13957. bool verify_callback_called = false;
  13958. bool dns_san_matched = false;
  13959. bool ip_san_matched = false;
  13960. bool ip_matched_via_dns_san = true;
  13961. bool dns_matched_via_ip_san = true;
  13962. bool cn_matched_next_to_dns_san = true;
  13963. SSLClient cli(HOST, port);
  13964. cli.enable_server_certificate_verification(true);
  13965. cli.set_ca_cert_path(CA_CERT_FILE);
  13966. cli.set_connection_timeout(5);
  13967. cli.set_server_certificate_verifier([&](const VerifyContext &ctx) -> bool {
  13968. verify_callback_called = true;
  13969. if (!ctx.cert) return false;
  13970. dns_san_matched = ctx.check_hostname("a.zz");
  13971. ip_san_matched = ctx.check_hostname("42.46.122.122");
  13972. ip_matched_via_dns_san = ctx.check_hostname("97.46.122.122");
  13973. dns_matched_via_ip_san = ctx.check_hostname("b.zz");
  13974. cn_matched_next_to_dns_san = ctx.check_hostname("san-types");
  13975. return true; // Accept for the purpose of this test
  13976. });
  13977. cli.Get("/test");
  13978. ASSERT_TRUE(verify_callback_called)
  13979. << "Verify callback should have been called";
  13980. EXPECT_TRUE(dns_san_matched) << "verify_hostname should match a dNSName SAN";
  13981. EXPECT_TRUE(ip_san_matched)
  13982. << "verify_hostname should match an iPAddress SAN";
  13983. EXPECT_FALSE(ip_matched_via_dns_san)
  13984. << "An IP host must not be authenticated via a dNSName SAN";
  13985. EXPECT_FALSE(dns_matched_via_ip_san)
  13986. << "A DNS host must not be authenticated via an iPAddress SAN";
  13987. EXPECT_FALSE(cn_matched_next_to_dns_san)
  13988. << "The CN must not be consulted next to a dNSName SAN (RFC 6125)";
  13989. }
  13990. // RFC 6125 6.4.3: only the leftmost label of a dNSName may be a wildcard, so
  13991. // "www.*.example.test" names one host and not every host under example.test.
  13992. TEST(SSLClientServerTest, TlsVerifyHostnameWildcardLabel) {
  13993. using namespace httplib::tls;
  13994. // SANs: DNS:*.leftmost.example.test, DNS:www.*.example.test
  13995. SSLServer svr(SERVER_CERT_WILDCARD_SAN_FILE, SERVER_PRIVATE_KEY_FILE);
  13996. ASSERT_TRUE(svr.is_valid());
  13997. svr.Get("/test", [](const Request &, Response &res) {
  13998. res.set_content("ok", "text/plain");
  13999. });
  14000. auto port = svr.bind_to_any_port(HOST);
  14001. thread t([&]() { svr.listen_after_bind(); });
  14002. auto se = detail::scope_exit([&] {
  14003. svr.stop();
  14004. t.join();
  14005. });
  14006. svr.wait_until_ready();
  14007. bool verify_callback_called = false;
  14008. bool leftmost_wildcard_matched = false;
  14009. bool wildcard_spanned_labels = true;
  14010. bool inner_wildcard_matched = true;
  14011. SSLClient cli(HOST, port);
  14012. cli.enable_server_certificate_verification(true);
  14013. cli.set_ca_cert_path(CA_CERT_FILE);
  14014. cli.set_connection_timeout(5);
  14015. cli.set_server_certificate_verifier([&](const VerifyContext &ctx) -> bool {
  14016. verify_callback_called = true;
  14017. if (!ctx.cert) return false;
  14018. leftmost_wildcard_matched = ctx.check_hostname("a.leftmost.example.test");
  14019. wildcard_spanned_labels = ctx.check_hostname("a.b.leftmost.example.test");
  14020. inner_wildcard_matched = ctx.check_hostname("www.evil.example.test");
  14021. return true; // Accept for the purpose of this test
  14022. });
  14023. cli.Get("/test");
  14024. ASSERT_TRUE(verify_callback_called)
  14025. << "Verify callback should have been called";
  14026. EXPECT_TRUE(leftmost_wildcard_matched)
  14027. << "A leftmost wildcard should match a single label";
  14028. EXPECT_FALSE(wildcard_spanned_labels)
  14029. << "A wildcard label must not match more than one label";
  14030. EXPECT_FALSE(inner_wildcard_matched)
  14031. << "A wildcard outside the leftmost label must not be honoured";
  14032. }
  14033. // sans() must report each SAN entry under its own type.
  14034. TEST(SSLClientServerTest, TlsCertSansEntryTypes) {
  14035. using namespace httplib::tls;
  14036. // SANs: DNS:a.zz, IP:42.46.122.122
  14037. SSLServer svr(SERVER_CERT_SAN_TYPES_FILE, SERVER_PRIVATE_KEY_FILE);
  14038. ASSERT_TRUE(svr.is_valid());
  14039. svr.Get("/test", [](const Request &, Response &res) {
  14040. res.set_content("ok", "text/plain");
  14041. });
  14042. auto port = svr.bind_to_any_port(HOST);
  14043. thread t([&]() { svr.listen_after_bind(); });
  14044. auto se = detail::scope_exit([&] {
  14045. svr.stop();
  14046. t.join();
  14047. });
  14048. svr.wait_until_ready();
  14049. bool verify_callback_called = false;
  14050. std::vector<SanEntry> sans;
  14051. SSLClient cli(HOST, port);
  14052. cli.enable_server_certificate_verification(true);
  14053. cli.set_ca_cert_path(CA_CERT_FILE);
  14054. cli.set_connection_timeout(5);
  14055. cli.set_server_certificate_verifier([&](const VerifyContext &ctx) -> bool {
  14056. verify_callback_called = true;
  14057. if (!ctx.cert) return false;
  14058. sans = ctx.sans();
  14059. return true; // Accept for the purpose of this test
  14060. });
  14061. cli.Get("/test");
  14062. ASSERT_TRUE(verify_callback_called)
  14063. << "Verify callback should have been called";
  14064. auto has_san = [&](SanType type, const std::string &value) {
  14065. return std::any_of(sans.begin(), sans.end(), [&](const SanEntry &san) {
  14066. return san.type == type && san.value == value;
  14067. });
  14068. };
  14069. EXPECT_TRUE(has_san(SanType::DNS, "a.zz"))
  14070. << "sans() should report the dNSName SAN";
  14071. EXPECT_TRUE(has_san(SanType::IP, "42.46.122.122"))
  14072. << "sans() should report the iPAddress SAN";
  14073. EXPECT_FALSE(has_san(SanType::IP, "97.46.122.122"))
  14074. << "sans() must not report the dNSName SAN as an address";
  14075. EXPECT_FALSE(has_san(SanType::DNS, "*.zz"))
  14076. << "sans() must not report the iPAddress SAN as a DNS name";
  14077. }
  14078. #endif
  14079. // mbedTLS-specific callback constructor test
  14080. // Tests that the void* callback can customize TLS settings via MbedTlsContext
  14081. #ifdef CPPHTTPLIB_SSL_ENABLED
  14082. TEST(SSLClientServerTest, ClientCAListSentToClient) {
  14083. SSLServer svr(SERVER_CERT_FILE, SERVER_PRIVATE_KEY_FILE, CLIENT_CA_CERT_FILE);
  14084. ASSERT_TRUE(svr.is_valid());
  14085. // Set up a handler to verify client certificate is present
  14086. bool client_cert_verified = false;
  14087. svr.Get("/test", [&](const Request & /*req*/, Response &res) {
  14088. // Verify that client certificate was provided
  14089. client_cert_verified = true;
  14090. res.set_content("success", "text/plain");
  14091. });
  14092. thread t = thread([&]() { ASSERT_TRUE(svr.listen(HOST, PORT)); });
  14093. auto se = detail::scope_exit([&] {
  14094. svr.stop();
  14095. t.join();
  14096. ASSERT_FALSE(svr.is_running());
  14097. });
  14098. svr.wait_until_ready();
  14099. // Client with certificate
  14100. SSLClient cli(HOST, PORT, CLIENT_CERT_FILE, CLIENT_PRIVATE_KEY_FILE);
  14101. cli.enable_server_certificate_verification(false);
  14102. cli.set_connection_timeout(30);
  14103. auto res = cli.Get("/test");
  14104. ASSERT_TRUE(res) << "Error: " << to_string(res.error());
  14105. ASSERT_EQ(StatusCode::OK_200, res->status);
  14106. ASSERT_TRUE(client_cert_verified);
  14107. EXPECT_EQ("success", res->body);
  14108. }
  14109. #endif
  14110. // ClientCAListSetInContext uses get_peer_cert() - works with all TLS
  14111. // backends
  14112. #ifdef CPPHTTPLIB_SSL_ENABLED
  14113. TEST(SSLClientServerTest, ClientCAListSetInContext) {
  14114. using namespace httplib::tls;
  14115. // Test that when client CA cert file is provided,
  14116. // the server properly requests and validates client certificates
  14117. // Create a server with client authentication
  14118. SSLServer svr(SERVER_CERT_FILE, SERVER_PRIVATE_KEY_FILE, CLIENT_CA_CERT_FILE);
  14119. ASSERT_TRUE(svr.is_valid());
  14120. bool handler_called = false;
  14121. svr.Get("/test", [&](const Request &req, Response &res) {
  14122. handler_called = true;
  14123. // Verify that a client certificate was provided
  14124. auto cert = req.peer_cert();
  14125. ASSERT_TRUE(static_cast<bool>(cert));
  14126. // Get the issuer name
  14127. std::string issuer_str = cert.issuer_name();
  14128. ASSERT_FALSE(issuer_str.empty());
  14129. // The client certificate should be issued by our test CA
  14130. EXPECT_TRUE(issuer_str.find("Root CA Name") != std::string::npos);
  14131. res.set_content("authenticated", "text/plain");
  14132. });
  14133. thread t = thread([&]() { ASSERT_TRUE(svr.listen(HOST, PORT)); });
  14134. auto se = detail::scope_exit([&] {
  14135. svr.stop();
  14136. t.join();
  14137. ASSERT_FALSE(svr.is_running());
  14138. });
  14139. svr.wait_until_ready();
  14140. // Connect with a client certificate issued by the CA
  14141. SSLClient cli(HOST, PORT, CLIENT_CERT_FILE, CLIENT_PRIVATE_KEY_FILE);
  14142. cli.enable_server_certificate_verification(false);
  14143. cli.set_connection_timeout(30);
  14144. auto res = cli.Get("/test");
  14145. ASSERT_TRUE(res) << "Error: " << to_string(res.error());
  14146. ASSERT_EQ(StatusCode::OK_200, res->status);
  14147. ASSERT_TRUE(handler_called);
  14148. EXPECT_EQ("authenticated", res->body);
  14149. }
  14150. TEST(TlsCertIntrospectionTest, GetCertSANs) {
  14151. using namespace httplib::tls;
  14152. SSLServer svr(SERVER_CERT_FILE, SERVER_PRIVATE_KEY_FILE);
  14153. ASSERT_TRUE(svr.is_valid());
  14154. svr.Get("/test", [](const Request &, Response &res) {
  14155. res.set_content("ok", "text/plain");
  14156. });
  14157. thread t = thread([&]() { ASSERT_TRUE(svr.listen(HOST, PORT)); });
  14158. auto se = detail::scope_exit([&] {
  14159. svr.stop();
  14160. t.join();
  14161. });
  14162. svr.wait_until_ready();
  14163. SSLClient cli(HOST, PORT);
  14164. cli.enable_server_certificate_verification(false);
  14165. cli.set_connection_timeout(30);
  14166. bool cert_checked = false;
  14167. cli.set_server_certificate_verifier([&](const VerifyContext &ctx) -> bool {
  14168. if (ctx.cert) {
  14169. auto sans = ctx.sans();
  14170. // Test certificate may or may not have SANs - just verify the API
  14171. // works If SANs exist, verify the types are valid
  14172. for (const auto &san : sans) {
  14173. EXPECT_TRUE(san.type == SanType::DNS || san.type == SanType::IP ||
  14174. san.type == SanType::EMAIL || san.type == SanType::URI ||
  14175. san.type == SanType::OTHER);
  14176. EXPECT_FALSE(san.value.empty());
  14177. }
  14178. cert_checked = true;
  14179. }
  14180. return true;
  14181. });
  14182. auto res = cli.Get("/test");
  14183. ASSERT_TRUE(res) << "Error: " << to_string(res.error());
  14184. EXPECT_TRUE(cert_checked);
  14185. }
  14186. TEST(TlsCertIntrospectionTest, GetCertValidity) {
  14187. using namespace httplib::tls;
  14188. SSLServer svr(SERVER_CERT_FILE, SERVER_PRIVATE_KEY_FILE);
  14189. ASSERT_TRUE(svr.is_valid());
  14190. svr.Get("/test", [](const Request &, Response &res) {
  14191. res.set_content("ok", "text/plain");
  14192. });
  14193. thread t = thread([&]() { ASSERT_TRUE(svr.listen(HOST, PORT)); });
  14194. auto se = detail::scope_exit([&] {
  14195. svr.stop();
  14196. t.join();
  14197. });
  14198. svr.wait_until_ready();
  14199. SSLClient cli(HOST, PORT);
  14200. cli.enable_server_certificate_verification(false);
  14201. cli.set_connection_timeout(30);
  14202. bool validity_checked = false;
  14203. cli.set_server_certificate_verifier([&](const VerifyContext &ctx) -> bool {
  14204. if (ctx.cert) {
  14205. time_t not_before = 0, not_after = 0;
  14206. bool result = ctx.validity(not_before, not_after);
  14207. EXPECT_TRUE(result);
  14208. // Verify that not_before < now < not_after for a valid cert
  14209. time_t now = time(nullptr);
  14210. EXPECT_LT(not_before, now);
  14211. EXPECT_GT(not_after, now);
  14212. validity_checked = true;
  14213. }
  14214. return true;
  14215. });
  14216. auto res = cli.Get("/test");
  14217. ASSERT_TRUE(res) << "Error: " << to_string(res.error());
  14218. EXPECT_TRUE(validity_checked);
  14219. }
  14220. TEST(TlsCertIntrospectionTest, GetCertSerial) {
  14221. using namespace httplib::tls;
  14222. SSLServer svr(SERVER_CERT_FILE, SERVER_PRIVATE_KEY_FILE);
  14223. ASSERT_TRUE(svr.is_valid());
  14224. svr.Get("/test", [](const Request &, Response &res) {
  14225. res.set_content("ok", "text/plain");
  14226. });
  14227. thread t = thread([&]() { ASSERT_TRUE(svr.listen(HOST, PORT)); });
  14228. auto se = detail::scope_exit([&] {
  14229. svr.stop();
  14230. t.join();
  14231. });
  14232. svr.wait_until_ready();
  14233. SSLClient cli(HOST, PORT);
  14234. cli.enable_server_certificate_verification(false);
  14235. cli.set_connection_timeout(30);
  14236. bool serial_checked = false;
  14237. cli.set_server_certificate_verifier([&](const VerifyContext &ctx) -> bool {
  14238. if (ctx.cert) {
  14239. std::string serial = ctx.serial();
  14240. EXPECT_FALSE(serial.empty());
  14241. // Serial should be a hex string
  14242. for (char c : serial) {
  14243. EXPECT_TRUE((c >= '0' && c <= '9') || (c >= 'A' && c <= 'F') ||
  14244. (c >= 'a' && c <= 'f'));
  14245. }
  14246. serial_checked = true;
  14247. }
  14248. return true;
  14249. });
  14250. auto res = cli.Get("/test");
  14251. ASSERT_TRUE(res) << "Error: " << to_string(res.error());
  14252. EXPECT_TRUE(serial_checked);
  14253. }
  14254. TEST(SSLClientServerTest, ClientCAListLoadErrorRecorded) {
  14255. // Test 1: Valid CA file - no error should be recorded
  14256. {
  14257. SSLServer svr(SERVER_CERT_FILE, SERVER_PRIVATE_KEY_FILE,
  14258. CLIENT_CA_CERT_FILE);
  14259. ASSERT_TRUE(svr.is_valid());
  14260. // With valid setup, last_ssl_error should be 0
  14261. EXPECT_EQ(0, svr.ssl_last_error());
  14262. }
  14263. // Test 2: Invalid CA file content
  14264. // When SSL_load_client_CA_file fails, last_ssl_error_ should be set
  14265. {
  14266. // Create a temporary file with completely invalid content
  14267. const char *temp_invalid_ca = "./temp_invalid_ca_for_test.txt";
  14268. {
  14269. std::ofstream ofs(temp_invalid_ca);
  14270. ofs << "This is not a certificate file at all\n";
  14271. ofs << "Just plain text content\n";
  14272. }
  14273. // Create server with invalid CA file
  14274. SSLServer svr(SERVER_CERT_FILE, SERVER_PRIVATE_KEY_FILE, temp_invalid_ca);
  14275. // Clean up temporary file
  14276. std::remove(temp_invalid_ca);
  14277. // When there's an SSL error (from either SSL_CTX_load_verify_locations
  14278. // or SSL_load_client_CA_file), last_ssl_error_ should be non-zero
  14279. // Note: SSL_CTX_load_verify_locations typically fails first,
  14280. // but our error handling code path is still exercised
  14281. if (!svr.is_valid()) { EXPECT_NE(0, svr.ssl_last_error()); }
  14282. }
  14283. }
  14284. TEST(VerifyCallbackTest, VerifyContextFields) {
  14285. using namespace httplib::tls;
  14286. SSLServer svr(SERVER_CERT_FILE, SERVER_PRIVATE_KEY_FILE);
  14287. ASSERT_TRUE(svr.is_valid());
  14288. svr.Get("/test", [](const Request &, Response &res) {
  14289. res.set_content("ok", "text/plain");
  14290. });
  14291. thread t = thread([&]() { ASSERT_TRUE(svr.listen(HOST, PORT)); });
  14292. auto se = detail::scope_exit([&] {
  14293. svr.stop();
  14294. t.join();
  14295. });
  14296. svr.wait_until_ready();
  14297. SSLClient cli(HOST, PORT);
  14298. cli.enable_server_certificate_verification(false);
  14299. cli.set_connection_timeout(30);
  14300. int callback_count = 0;
  14301. bool saw_leaf_cert = false;
  14302. cli.set_server_certificate_verifier([&](const VerifyContext &ctx) -> bool {
  14303. if (ctx.cert) {
  14304. callback_count++;
  14305. // We should see at least one certificate (the leaf)
  14306. std::string cn = ctx.subject_cn();
  14307. if (!cn.empty()) { saw_leaf_cert = true; }
  14308. // Verify context fields are populated
  14309. EXPECT_NE(ctx.session, nullptr);
  14310. EXPECT_GE(ctx.depth, 0);
  14311. }
  14312. return true;
  14313. });
  14314. auto res = cli.Get("/test");
  14315. ASSERT_TRUE(res) << "Error: " << to_string(res.error());
  14316. EXPECT_GT(callback_count, 0);
  14317. EXPECT_TRUE(saw_leaf_cert);
  14318. }
  14319. // A verifier belongs to the client that set it, not to the thread that set it.
  14320. TEST(VerifyCallbackTest, VerifierStaysWithItsClient) {
  14321. using namespace httplib::tls;
  14322. SSLServer svr(SERVER_CERT_FILE, SERVER_PRIVATE_KEY_FILE);
  14323. ASSERT_TRUE(svr.is_valid());
  14324. svr.Get("/test", [](const Request &, Response &res) {
  14325. res.set_content("ok", "text/plain");
  14326. });
  14327. auto port = svr.bind_to_any_port(HOST);
  14328. thread t([&]() { svr.listen_after_bind(); });
  14329. auto se = detail::scope_exit([&] {
  14330. svr.stop();
  14331. t.join();
  14332. });
  14333. svr.wait_until_ready();
  14334. auto rejecting_calls = 0;
  14335. SSLClient rejecting(HOST, port);
  14336. rejecting.enable_server_certificate_verification(false);
  14337. rejecting.set_server_certificate_verifier([&](const VerifyContext &) {
  14338. rejecting_calls++;
  14339. return false;
  14340. });
  14341. auto accepting_calls = 0;
  14342. SSLClient accepting(HOST, port);
  14343. accepting.enable_server_certificate_verification(false);
  14344. // Set on another thread than the requests below.
  14345. thread([&]() {
  14346. accepting.set_server_certificate_verifier([&](const VerifyContext &) {
  14347. accepting_calls++;
  14348. return true;
  14349. });
  14350. }).join();
  14351. // Requested on another thread than the verifier was set on.
  14352. thread([&]() { EXPECT_FALSE(rejecting.Get("/test")); }).join();
  14353. EXPECT_GT(rejecting_calls, 0);
  14354. auto res = accepting.Get("/test");
  14355. ASSERT_TRUE(res) << "Error: " << to_string(res.error());
  14356. EXPECT_GT(accepting_calls, 0);
  14357. }
  14358. // A verifier replaced while a handshake runs it lives until it returns.
  14359. TEST(VerifyCallbackTest, VerifierReplacedDuringHandshake) {
  14360. using namespace httplib::tls;
  14361. SSLServer svr(SERVER_CERT_FILE, SERVER_PRIVATE_KEY_FILE);
  14362. ASSERT_TRUE(svr.is_valid());
  14363. svr.Get("/test", [](const Request &, Response &res) {
  14364. res.set_content("ok", "text/plain");
  14365. });
  14366. auto port = svr.bind_to_any_port(HOST);
  14367. thread t([&]() { svr.listen_after_bind(); });
  14368. auto se = detail::scope_exit([&] {
  14369. svr.stop();
  14370. t.join();
  14371. });
  14372. svr.wait_until_ready();
  14373. SSLClient cli(HOST, port);
  14374. cli.enable_server_certificate_verification(false);
  14375. std::promise<void> entered;
  14376. std::promise<void> replaced;
  14377. auto replaced_future = replaced.get_future();
  14378. auto first_call = true;
  14379. // Long enough to live on the heap
  14380. std::string expected(64, 'v');
  14381. cli.set_server_certificate_verifier([&, expected](const VerifyContext &) {
  14382. if (first_call) {
  14383. first_call = false;
  14384. entered.set_value();
  14385. replaced_future.wait();
  14386. }
  14387. return expected == std::string(64, 'v');
  14388. });
  14389. thread request([&]() {
  14390. auto res = cli.Get("/test");
  14391. EXPECT_TRUE(res) << "Error: " << to_string(res.error());
  14392. });
  14393. entered.get_future().wait();
  14394. cli.set_server_certificate_verifier(
  14395. [](const VerifyContext &) { return true; });
  14396. replaced.set_value();
  14397. request.join();
  14398. }
  14399. // VerifyContext::session is the same handle the other tls:: functions take.
  14400. TEST(VerifyCallbackTest, SessionMatchesSessionVerifier) {
  14401. using namespace httplib::tls;
  14402. SSLServer svr(SERVER_CERT_FILE, SERVER_PRIVATE_KEY_FILE);
  14403. ASSERT_TRUE(svr.is_valid());
  14404. svr.Get("/test", [](const Request &, Response &res) {
  14405. res.set_content("ok", "text/plain");
  14406. });
  14407. auto port = svr.bind_to_any_port(HOST);
  14408. thread t([&]() { svr.listen_after_bind(); });
  14409. auto se = detail::scope_exit([&] {
  14410. svr.stop();
  14411. t.join();
  14412. });
  14413. svr.wait_until_ready();
  14414. SSLClient cli(HOST, port);
  14415. cli.enable_server_certificate_verification(false);
  14416. session_t verifier_session = nullptr;
  14417. cli.set_server_certificate_verifier([&](const VerifyContext &ctx) {
  14418. verifier_session = ctx.session;
  14419. return true;
  14420. });
  14421. session_t session_verifier_session = nullptr;
  14422. cli.set_session_verifier([&](session_t session) {
  14423. session_verifier_session = session;
  14424. return SSLVerifierResponse::NoDecisionMade;
  14425. });
  14426. auto res = cli.Get("/test");
  14427. ASSERT_TRUE(res) << "Error: " << to_string(res.error());
  14428. EXPECT_NE(nullptr, verifier_session);
  14429. EXPECT_EQ(session_verifier_session, verifier_session);
  14430. }
  14431. TEST(TlsVerifyErrorTest, GetVerifyErrorString) {
  14432. using httplib::tls::TlsError;
  14433. // Test that verify_error_to_string returns empty for success
  14434. std::string success_str = TlsError::verify_error_to_string(0);
  14435. EXPECT_TRUE(success_str.empty());
  14436. // Test that verify_error_to_string returns non-empty for error codes
  14437. // Using a common error code (certificate expired)
  14438. std::string error_str =
  14439. TlsError::verify_error_to_string(10); // X509_V_ERR_CERT_HAS_EXPIRED
  14440. EXPECT_FALSE(error_str.empty());
  14441. }
  14442. TEST(SessionVerifierTest, CertificateAccepted) {
  14443. SSLServer svr(SERVER_CERT_FILE, SERVER_PRIVATE_KEY_FILE);
  14444. ASSERT_TRUE(svr.is_valid());
  14445. svr.Get("/test", [](const Request &, Response &res) {
  14446. res.set_content("ok", "text/plain");
  14447. });
  14448. thread t = thread([&]() { ASSERT_TRUE(svr.listen(HOST, PORT)); });
  14449. auto se = detail::scope_exit([&] {
  14450. svr.stop();
  14451. t.join();
  14452. });
  14453. svr.wait_until_ready();
  14454. SSLClient cli(HOST, PORT);
  14455. cli.enable_server_certificate_verification(false);
  14456. cli.set_connection_timeout(30);
  14457. bool callback_called = false;
  14458. cli.set_session_verifier([&](tls::session_t session) -> SSLVerifierResponse {
  14459. EXPECT_NE(session, nullptr);
  14460. callback_called = true;
  14461. return SSLVerifierResponse::CertificateAccepted;
  14462. });
  14463. auto res = cli.Get("/test");
  14464. ASSERT_TRUE(res) << "Error: " << to_string(res.error());
  14465. EXPECT_EQ(200, res->status);
  14466. EXPECT_TRUE(callback_called);
  14467. }
  14468. TEST(SessionVerifierTest, CertificateRejected) {
  14469. SSLServer svr(SERVER_CERT_FILE, SERVER_PRIVATE_KEY_FILE);
  14470. ASSERT_TRUE(svr.is_valid());
  14471. svr.Get("/test", [](const Request &, Response &res) {
  14472. res.set_content("ok", "text/plain");
  14473. });
  14474. thread t = thread([&]() { ASSERT_TRUE(svr.listen(HOST, PORT)); });
  14475. auto se = detail::scope_exit([&] {
  14476. svr.stop();
  14477. t.join();
  14478. });
  14479. svr.wait_until_ready();
  14480. SSLClient cli(HOST, PORT);
  14481. cli.enable_server_certificate_verification(false);
  14482. cli.set_connection_timeout(30);
  14483. bool callback_called = false;
  14484. cli.set_session_verifier([&](tls::session_t session) -> SSLVerifierResponse {
  14485. EXPECT_NE(session, nullptr);
  14486. callback_called = true;
  14487. return SSLVerifierResponse::CertificateRejected;
  14488. });
  14489. auto res = cli.Get("/test");
  14490. EXPECT_FALSE(res);
  14491. EXPECT_TRUE(callback_called);
  14492. }
  14493. TEST(SessionVerifierTest, NoDecisionFallsThrough) {
  14494. SSLServer svr(SERVER_CERT_FILE, SERVER_PRIVATE_KEY_FILE);
  14495. ASSERT_TRUE(svr.is_valid());
  14496. svr.Get("/test", [](const Request &, Response &res) {
  14497. res.set_content("ok", "text/plain");
  14498. });
  14499. thread t = thread([&]() { ASSERT_TRUE(svr.listen(HOST, PORT)); });
  14500. auto se = detail::scope_exit([&] {
  14501. svr.stop();
  14502. t.join();
  14503. });
  14504. svr.wait_until_ready();
  14505. // NoDecisionMade with verification disabled should succeed (no default check)
  14506. SSLClient cli(HOST, PORT);
  14507. cli.enable_server_certificate_verification(false);
  14508. cli.set_connection_timeout(30);
  14509. bool callback_called = false;
  14510. cli.set_session_verifier([&](tls::session_t session) -> SSLVerifierResponse {
  14511. EXPECT_NE(session, nullptr);
  14512. callback_called = true;
  14513. return SSLVerifierResponse::NoDecisionMade;
  14514. });
  14515. auto res = cli.Get("/test");
  14516. ASSERT_TRUE(res) << "Error: " << to_string(res.error());
  14517. EXPECT_EQ(200, res->status);
  14518. EXPECT_TRUE(callback_called);
  14519. }
  14520. TEST(SessionVerifierTest, NoDecisionWithVerificationEnabled) {
  14521. SSLServer svr(SERVER_CERT_FILE, SERVER_PRIVATE_KEY_FILE);
  14522. ASSERT_TRUE(svr.is_valid());
  14523. svr.Get("/test", [](const Request &, Response &res) {
  14524. res.set_content("ok", "text/plain");
  14525. });
  14526. thread t = thread([&]() { ASSERT_TRUE(svr.listen(HOST, PORT)); });
  14527. auto se = detail::scope_exit([&] {
  14528. svr.stop();
  14529. t.join();
  14530. });
  14531. svr.wait_until_ready();
  14532. // NoDecisionMade with verification enabled should fail (self-signed cert).
  14533. // Note: On MbedTLS, the handshake itself fails before reaching the verifier,
  14534. // so we only check that the request fails, not whether the callback was
  14535. // called.
  14536. SSLClient cli(HOST, PORT);
  14537. cli.enable_server_certificate_verification(true);
  14538. cli.set_connection_timeout(30);
  14539. cli.set_session_verifier([&](tls::session_t session) -> SSLVerifierResponse {
  14540. EXPECT_NE(session, nullptr);
  14541. return SSLVerifierResponse::NoDecisionMade;
  14542. });
  14543. auto res = cli.Get("/test");
  14544. EXPECT_FALSE(res);
  14545. }
  14546. TEST(SSLClientServerTest, ClientCAListFromPem) {
  14547. // Test SSL server using PemMemory constructor with client CA certificates
  14548. // Read PEM files
  14549. std::string server_cert_pem, server_key_pem, client_ca_pem;
  14550. read_file(SERVER_CERT_FILE, server_cert_pem);
  14551. read_file(SERVER_PRIVATE_KEY_FILE, server_key_pem);
  14552. read_file(CLIENT_CA_CERT_FILE, client_ca_pem);
  14553. // Create SSLServer with PemMemory constructor including client CA
  14554. SSLServer::PemMemory server_pem = {
  14555. server_cert_pem.c_str(),
  14556. server_cert_pem.size(),
  14557. server_key_pem.c_str(),
  14558. server_key_pem.size(),
  14559. client_ca_pem.c_str(),
  14560. client_ca_pem.size(),
  14561. nullptr // no password for server key
  14562. };
  14563. SSLServer svr(server_pem);
  14564. ASSERT_TRUE(svr.is_valid());
  14565. // No SSL error should be recorded for valid setup
  14566. EXPECT_EQ(0, svr.ssl_last_error());
  14567. // Set up server endpoints
  14568. svr.Get("/test-pem-ca", [&](const Request & /*req*/, Response &res) {
  14569. res.set_content("ok", "text/plain");
  14570. });
  14571. // Start server in a thread
  14572. auto server_thread = thread([&]() { svr.listen(HOST, PORT); });
  14573. svr.wait_until_ready();
  14574. // Connect with client certificate (using constructor with paths)
  14575. SSLClient cli(HOST, PORT, CLIENT_CERT_FILE, CLIENT_PRIVATE_KEY_FILE);
  14576. cli.enable_server_certificate_verification(false);
  14577. auto res = cli.Get("/test-pem-ca");
  14578. ASSERT_TRUE(res) << "Error: " << to_string(res.error());
  14579. EXPECT_EQ(200, res->status);
  14580. EXPECT_EQ("ok", res->body);
  14581. svr.stop();
  14582. server_thread.join();
  14583. }
  14584. #endif
  14585. #ifdef _WIN32
  14586. TEST(CleanupTest, WSACleanup) {
  14587. int ret = WSACleanup();
  14588. ASSERT_EQ(0, ret);
  14589. }
  14590. #endif
  14591. #ifndef CPPHTTPLIB_SSL_ENABLED
  14592. TEST(NoSSLSupport, SimpleInterface) {
  14593. ASSERT_ANY_THROW(Client cli("https://yahoo.com"));
  14594. }
  14595. #endif
  14596. #ifndef CPPHTTPLIB_NO_EXCEPTIONS
  14597. TEST(InvalidScheme, SimpleInterface) {
  14598. ASSERT_ANY_THROW(Client cli("scheme://yahoo.com"));
  14599. }
  14600. #endif
  14601. TEST(NoScheme, SimpleInterface) {
  14602. Client cli("yahoo.com:80");
  14603. ASSERT_TRUE(cli.is_valid());
  14604. }
  14605. TEST(SendAPI, SimpleInterface_Online) {
  14606. Client cli("http://yahoo.com");
  14607. Request req;
  14608. req.method = "GET";
  14609. req.path = "/";
  14610. auto res = cli.send(req);
  14611. ASSERT_TRUE(res) << "Error: " << to_string(res.error());
  14612. EXPECT_EQ(StatusCode::MovedPermanently_301, res->status);
  14613. }
  14614. TEST(SendAPI, WithParamsInRequest) {
  14615. Server svr;
  14616. svr.Get("/", [&](const Request &req, Response & /*res*/) {
  14617. EXPECT_TRUE(req.has_param("test"));
  14618. EXPECT_EQ("test_value", req.get_param_value("test"));
  14619. });
  14620. auto t = std::thread([&]() { svr.listen(HOST, PORT); });
  14621. auto se = detail::scope_exit([&] {
  14622. svr.stop();
  14623. t.join();
  14624. ASSERT_FALSE(svr.is_running());
  14625. });
  14626. svr.wait_until_ready();
  14627. Client cli(HOST, PORT);
  14628. {
  14629. Request req;
  14630. req.method = "GET";
  14631. req.path = "/";
  14632. req.params.emplace("test", "test_value");
  14633. auto res = cli.send(req);
  14634. ASSERT_TRUE(res) << "Error: " << to_string(res.error());
  14635. }
  14636. {
  14637. auto res = cli.Get("/", {{"test", "test_value"}}, Headers{});
  14638. ASSERT_TRUE(res) << "Error: " << to_string(res.error());
  14639. }
  14640. }
  14641. TEST(ClientImplMethods, GetSocketTest) {
  14642. httplib::Server svr;
  14643. svr.Get("/", [&](const httplib::Request & /*req*/, httplib::Response &res) {
  14644. res.status = StatusCode::OK_200;
  14645. });
  14646. auto port = svr.bind_to_any_port("127.0.0.1");
  14647. auto thread = std::thread([&]() { svr.listen_after_bind(); });
  14648. auto se = detail::scope_exit([&] {
  14649. svr.stop();
  14650. thread.join();
  14651. ASSERT_FALSE(svr.is_running());
  14652. });
  14653. svr.wait_until_ready();
  14654. {
  14655. httplib::Client cli("127.0.0.1", port);
  14656. cli.set_keep_alive(true);
  14657. // Use the behavior of cpp-httplib of opening the connection
  14658. // only when the first request happens. If that changes,
  14659. // this test would be obsolete.
  14660. EXPECT_EQ(cli.socket(), INVALID_SOCKET);
  14661. // This also implicitly tests the server. But other tests would fail much
  14662. // earlier than this one to be considered.
  14663. auto res = cli.Get("/");
  14664. ASSERT_TRUE(res) << "Error: " << to_string(res.error());
  14665. EXPECT_EQ(StatusCode::OK_200, res->status);
  14666. ASSERT_TRUE(cli.socket() != INVALID_SOCKET);
  14667. }
  14668. }
  14669. #ifdef CPPHTTPLIB_SSL_ENABLED
  14670. TEST(YahooRedirectTest2, SimpleInterface_Online) {
  14671. Client cli("http://yahoo.com");
  14672. auto res = cli.Get("/");
  14673. ASSERT_TRUE(res) << "Error: " << to_string(res.error());
  14674. EXPECT_EQ(StatusCode::MovedPermanently_301, res->status);
  14675. cli.set_follow_location(true);
  14676. res = cli.Get("/");
  14677. ASSERT_TRUE(res) << "Error: " << to_string(res.error());
  14678. EXPECT_EQ(StatusCode::OK_200, res->status);
  14679. EXPECT_EQ("https://www.yahoo.com/", res->location);
  14680. }
  14681. TEST(YahooRedirectTest3, SimpleInterface_Online) {
  14682. Client cli("https://yahoo.com");
  14683. auto res = cli.Get("/");
  14684. ASSERT_TRUE(res) << "Error: " << to_string(res.error());
  14685. EXPECT_EQ(StatusCode::MovedPermanently_301, res->status);
  14686. cli.set_follow_location(true);
  14687. res = cli.Get("/");
  14688. ASSERT_TRUE(res) << "Error: " << to_string(res.error());
  14689. EXPECT_EQ(StatusCode::OK_200, res->status);
  14690. EXPECT_EQ("https://www.yahoo.com/", res->location);
  14691. }
  14692. TEST(YahooRedirectTest3, NewResultInterface_Online) {
  14693. Client cli("https://yahoo.com");
  14694. auto res = cli.Get("/");
  14695. ASSERT_TRUE(res) << "Error: " << to_string(res.error());
  14696. ASSERT_FALSE(!res);
  14697. ASSERT_TRUE(res) << "Error: " << to_string(res.error());
  14698. ASSERT_FALSE(res == nullptr);
  14699. ASSERT_TRUE(res != nullptr);
  14700. EXPECT_EQ(Error::Success, res.error());
  14701. EXPECT_EQ(StatusCode::MovedPermanently_301, res.value().status);
  14702. EXPECT_EQ(StatusCode::MovedPermanently_301, (*res).status);
  14703. EXPECT_EQ(StatusCode::MovedPermanently_301, res->status);
  14704. cli.set_follow_location(true);
  14705. res = cli.Get("/");
  14706. ASSERT_TRUE(res) << "Error: " << to_string(res.error());
  14707. EXPECT_EQ(Error::Success, res.error());
  14708. EXPECT_EQ(StatusCode::OK_200, res.value().status);
  14709. EXPECT_EQ(StatusCode::OK_200, (*res).status);
  14710. EXPECT_EQ(StatusCode::OK_200, res->status);
  14711. EXPECT_EQ("https://www.yahoo.com/", res->location);
  14712. }
  14713. #ifdef CPPHTTPLIB_BROTLI_SUPPORT
  14714. TEST(DecodeWithChunkedEncoding, BrotliEncoding_Online) {
  14715. Client cli("https://cdnjs.cloudflare.com");
  14716. auto res = cli.Get("/ajax/libs/jquery/3.5.1/jquery.js",
  14717. Headers{{"Accept-Encoding", "br"}});
  14718. ASSERT_TRUE(res) << "Error: " << to_string(res.error());
  14719. EXPECT_EQ(StatusCode::OK_200, res->status);
  14720. EXPECT_EQ(287630U, res->body.size());
  14721. EXPECT_EQ("application/javascript; charset=utf-8",
  14722. res->get_header_value("Content-Type"));
  14723. }
  14724. #endif
  14725. // Previously "https://nghttp2.org" "/httpbin/redirect-to"
  14726. #undef REDIR_HOST // Silence compiler warning
  14727. #define REDIR_HOST "https://httpbingo.org"
  14728. TEST(HttpsToHttpRedirectTest, SimpleInterface_Online) {
  14729. Client cli(REDIR_HOST);
  14730. cli.set_follow_location(true);
  14731. auto res =
  14732. cli.Get(REDIR_PATH "?url=http%3A%2F%2Fexample.com&status_code=302");
  14733. ASSERT_TRUE(res) << "Error: " << to_string(res.error());
  14734. EXPECT_EQ(StatusCode::OK_200, res->status);
  14735. }
  14736. TEST(HttpsToHttpRedirectTest2, SimpleInterface_Online) {
  14737. Client cli(REDIR_HOST);
  14738. cli.set_follow_location(true);
  14739. Params params;
  14740. params.emplace("url", "http://example.com");
  14741. params.emplace("status_code", "302");
  14742. auto res = cli.Get(REDIR_PATH, params, Headers{});
  14743. ASSERT_TRUE(res) << "Error: " << to_string(res.error());
  14744. EXPECT_EQ(StatusCode::OK_200, res->status);
  14745. }
  14746. TEST(HttpsToHttpRedirectTest3, SimpleInterface_Online) {
  14747. Client cli(REDIR_HOST);
  14748. cli.set_follow_location(true);
  14749. Params params;
  14750. params.emplace("url", "http://example.com");
  14751. auto res = cli.Get(REDIR_PATH "?status_code=302", params, Headers{});
  14752. ASSERT_TRUE(res) << "Error: " << to_string(res.error());
  14753. EXPECT_EQ(StatusCode::OK_200, res->status);
  14754. }
  14755. TEST(HttpToHttpsRedirectTest, CertFile) {
  14756. auto ssl_port = PORT + 1;
  14757. Server svr;
  14758. ASSERT_TRUE(svr.is_valid());
  14759. svr.Get("/index", [&](const Request &, Response &res) {
  14760. res.set_redirect("https://127.0.0.1:" + std::to_string(ssl_port) +
  14761. "/index");
  14762. svr.stop();
  14763. });
  14764. SSLServer ssl_svr(SERVER_CERT2_FILE, SERVER_PRIVATE_KEY_FILE);
  14765. ASSERT_TRUE(ssl_svr.is_valid());
  14766. ssl_svr.Get("/index", [&](const Request &, Response &res) {
  14767. res.set_content("test", "text/plain");
  14768. ssl_svr.stop();
  14769. });
  14770. thread t = thread([&]() { ASSERT_TRUE(svr.listen("127.0.0.1", PORT)); });
  14771. thread t2 =
  14772. thread([&]() { ASSERT_TRUE(ssl_svr.listen("127.0.0.1", ssl_port)); });
  14773. auto se = detail::scope_exit([&] {
  14774. t2.join();
  14775. t.join();
  14776. ASSERT_FALSE(svr.is_running());
  14777. });
  14778. svr.wait_until_ready();
  14779. ssl_svr.wait_until_ready();
  14780. Client cli("127.0.0.1", PORT);
  14781. cli.set_ca_cert_path(SERVER_CERT2_FILE);
  14782. cli.enable_server_certificate_verification(true);
  14783. cli.set_follow_location(true);
  14784. cli.set_connection_timeout(30);
  14785. auto res = cli.Get("/index");
  14786. ASSERT_TRUE(res) << "Error: " << to_string(res.error());
  14787. ASSERT_EQ(StatusCode::OK_200, res->status);
  14788. }
  14789. TEST(SSLClientRedirectTest, CertFile) {
  14790. auto ssl_port = PORT + 1;
  14791. SSLServer ssl_svr1(SERVER_CERT2_FILE, SERVER_PRIVATE_KEY_FILE);
  14792. ASSERT_TRUE(ssl_svr1.is_valid());
  14793. ssl_svr1.Get("/index", [&](const Request &, Response &res) {
  14794. res.set_redirect("https://127.0.0.1:" + std::to_string(ssl_port) +
  14795. "/index");
  14796. ssl_svr1.stop();
  14797. });
  14798. SSLServer ssl_svr2(SERVER_CERT2_FILE, SERVER_PRIVATE_KEY_FILE);
  14799. ASSERT_TRUE(ssl_svr2.is_valid());
  14800. ssl_svr2.Get("/index", [&](const Request &, Response &res) {
  14801. res.set_content("test", "text/plain");
  14802. ssl_svr2.stop();
  14803. });
  14804. thread t = thread([&]() { ASSERT_TRUE(ssl_svr1.listen("127.0.0.1", PORT)); });
  14805. thread t2 =
  14806. thread([&]() { ASSERT_TRUE(ssl_svr2.listen("127.0.0.1", ssl_port)); });
  14807. auto se = detail::scope_exit([&] {
  14808. t2.join();
  14809. t.join();
  14810. ASSERT_FALSE(ssl_svr1.is_running());
  14811. });
  14812. ssl_svr1.wait_until_ready();
  14813. ssl_svr2.wait_until_ready();
  14814. SSLClient cli("127.0.0.1", PORT);
  14815. std::string cert;
  14816. read_file(SERVER_CERT2_FILE, cert);
  14817. cli.load_ca_cert_store(cert.c_str(), cert.size());
  14818. cli.enable_server_certificate_verification(true);
  14819. cli.set_follow_location(true);
  14820. cli.set_connection_timeout(30);
  14821. auto res = cli.Get("/index");
  14822. ASSERT_TRUE(res) << "Error: " << to_string(res.error());
  14823. ASSERT_EQ(StatusCode::OK_200, res->status);
  14824. }
  14825. // Redirects from a server with SERVER_CERT2_FILE to one with target_cert on
  14826. // another port, so the client follows it with a new client.
  14827. static Result GetThroughTlsRedirectToDifferentPort(
  14828. const std::function<void(SSLClient &)> &setup,
  14829. const char *target_cert = SERVER_CERT2_FILE,
  14830. const char *target_key = SERVER_PRIVATE_KEY_FILE) {
  14831. auto ssl_port = PORT + 1;
  14832. SSLServer ssl_svr1(SERVER_CERT2_FILE, SERVER_PRIVATE_KEY_FILE);
  14833. ssl_svr1.Get("/index", [&](const Request &, Response &res) {
  14834. res.set_redirect("https://127.0.0.1:" + std::to_string(ssl_port) +
  14835. "/index");
  14836. });
  14837. SSLServer ssl_svr2(target_cert, target_key);
  14838. ssl_svr2.Get("/index", [&](const Request &, Response &res) {
  14839. res.set_content("test", "text/plain");
  14840. });
  14841. thread t = thread([&]() { ssl_svr1.listen("127.0.0.1", PORT); });
  14842. thread t2 = thread([&]() { ssl_svr2.listen("127.0.0.1", ssl_port); });
  14843. auto se = detail::scope_exit([&] {
  14844. ssl_svr2.stop();
  14845. ssl_svr1.stop();
  14846. t2.join();
  14847. t.join();
  14848. });
  14849. ssl_svr1.wait_until_ready();
  14850. ssl_svr2.wait_until_ready();
  14851. SSLClient cli("127.0.0.1", PORT);
  14852. cli.set_follow_location(true);
  14853. cli.set_connection_timeout(30);
  14854. setup(cli);
  14855. return cli.Get("/index");
  14856. }
  14857. TEST(SSLClientRedirectTest, KeepSessionVerifier) {
  14858. auto calls = 0;
  14859. auto res = GetThroughTlsRedirectToDifferentPort([&](SSLClient &cli) {
  14860. cli.enable_server_certificate_verification(false);
  14861. // Accept the first server only.
  14862. cli.set_session_verifier([&](tls::session_t) {
  14863. return ++calls == 1 ? SSLVerifierResponse::NoDecisionMade
  14864. : SSLVerifierResponse::CertificateRejected;
  14865. });
  14866. });
  14867. ASSERT_FALSE(res);
  14868. EXPECT_EQ(Error::SSLServerVerification, res.error());
  14869. EXPECT_EQ(2, calls);
  14870. }
  14871. TEST(SSLClientRedirectTest, KeepServerCertificateVerifier) {
  14872. std::string pinned;
  14873. auto res = GetThroughTlsRedirectToDifferentPort(
  14874. [&](SSLClient &cli) {
  14875. cli.enable_server_certificate_verification(false);
  14876. // Pin the first certificate seen.
  14877. cli.set_server_certificate_verifier([&](const tls::VerifyContext &ctx) {
  14878. if (pinned.empty()) { pinned = ctx.serial(); }
  14879. return ctx.serial() == pinned;
  14880. });
  14881. },
  14882. // A certificate other than the first server's.
  14883. SERVER_CERT_FILE);
  14884. EXPECT_FALSE(res);
  14885. EXPECT_FALSE(pinned.empty());
  14886. }
  14887. TEST(SSLClientRedirectTest, KeepCaCertStore) {
  14888. auto res = GetThroughTlsRedirectToDifferentPort([](SSLClient &cli) {
  14889. std::string cert;
  14890. read_file(SERVER_CERT2_FILE, cert);
  14891. cli.set_ca_cert_store(tls::create_ca_store(cert.c_str(), cert.size()));
  14892. });
  14893. ASSERT_TRUE(res) << "Error: " << to_string(res.error());
  14894. EXPECT_EQ(StatusCode::OK_200, res->status);
  14895. }
  14896. // The target's certificate is signed by the root CA, which the first server's
  14897. // is not. Its name is not checked, as it carries none of 127.0.0.1.
  14898. TEST(SSLClientRedirectTest, KeepEveryCaCertPem) {
  14899. auto res = GetThroughTlsRedirectToDifferentPort(
  14900. [](SSLClient &cli) {
  14901. std::string root_ca, cert;
  14902. read_file(CLIENT_CA_CERT_FILE, root_ca);
  14903. read_file(SERVER_CERT2_FILE, cert);
  14904. cli.load_ca_cert_store(root_ca.data(), root_ca.size());
  14905. cli.load_ca_cert_store(cert.data(), cert.size());
  14906. cli.enable_server_hostname_verification(false);
  14907. },
  14908. CLIENT_CERT_FILE, CLIENT_PRIVATE_KEY_FILE);
  14909. ASSERT_TRUE(res) << "Error: " << to_string(res.error());
  14910. EXPECT_EQ(StatusCode::OK_200, res->status);
  14911. }
  14912. #ifndef CPPHTTPLIB_WOLFSSL_SUPPORT
  14913. // set_ca_cert_store() replaces the root CA loaded before it, so the target is
  14914. // not trusted after the redirect either. (wolfSSL adds the store instead.)
  14915. TEST(SSLClientRedirectTest, CaCertStoreReplacesEarlierPem) {
  14916. auto res = GetThroughTlsRedirectToDifferentPort(
  14917. [](SSLClient &cli) {
  14918. std::string root_ca, cert;
  14919. read_file(CLIENT_CA_CERT_FILE, root_ca);
  14920. read_file(SERVER_CERT2_FILE, cert);
  14921. cli.load_ca_cert_store(root_ca.data(), root_ca.size());
  14922. cli.set_ca_cert_store(tls::create_ca_store(cert.c_str(), cert.size()));
  14923. cli.enable_server_hostname_verification(false);
  14924. },
  14925. CLIENT_CERT_FILE, CLIENT_PRIVATE_KEY_FILE);
  14926. ASSERT_FALSE(res);
  14927. EXPECT_EQ(Error::SSLServerVerification, res.error());
  14928. }
  14929. #endif
  14930. #endif
  14931. #ifdef CPPHTTPLIB_SSL_ENABLED
  14932. // Test that set_ca_cert_store() skips system certs (consistent with
  14933. // set_ca_cert_path behavior). When a custom cert store is set, only those certs
  14934. // should be trusted - system certs should NOT be loaded.
  14935. TEST(SSLClientTest, SetCaCertStoreSkipsSystemCerts_Online) {
  14936. // Load a specific cert that is NOT a system CA cert
  14937. std::string cert;
  14938. read_file(SERVER_CERT2_FILE, cert);
  14939. SSLClient cli("google.com");
  14940. cli.load_ca_cert_store(cert.c_str(), cert.size());
  14941. cli.enable_server_certificate_verification(true);
  14942. // This should FAIL because:
  14943. // 1. We loaded only SERVER_CERT2 (a test cert, not a CA for google.com)
  14944. // 2. System certs should NOT be loaded when custom store is set
  14945. // If system certs WERE loaded, this would succeed
  14946. auto res = cli.Get("/");
  14947. ASSERT_FALSE(res);
  14948. EXPECT_EQ(Error::SSLServerVerification, res.error());
  14949. }
  14950. // Same as above, but through the native store handle path. Regression test:
  14951. // set_ca_cert_store() used to leave no trace on the client, so load_certs()
  14952. // merged system certs into the user-provided store.
  14953. TEST(SSLClientTest, SetCaCertStoreNativeSkipsSystemCerts_Online) {
  14954. std::string cert;
  14955. read_file(SERVER_CERT2_FILE, cert);
  14956. SSLClient cli("google.com");
  14957. cli.set_ca_cert_store(tls::create_ca_store(cert.c_str(), cert.size()));
  14958. cli.enable_server_certificate_verification(true);
  14959. auto res = cli.Get("/");
  14960. ASSERT_FALSE(res);
  14961. EXPECT_EQ(Error::SSLServerVerification, res.error());
  14962. }
  14963. // A custom store set via the native handle must still verify a server whose
  14964. // cert it does contain.
  14965. TEST(SSLClientTest, SetCaCertStoreNativeVerifiesLocalServer) {
  14966. SSLServer svr(SERVER_CERT2_FILE, SERVER_PRIVATE_KEY_FILE);
  14967. ASSERT_TRUE(svr.is_valid());
  14968. svr.Get("/test", [&](const Request &, Response &res) {
  14969. res.set_content("test", "text/plain");
  14970. });
  14971. thread t = thread([&]() { ASSERT_TRUE(svr.listen("127.0.0.1", PORT)); });
  14972. auto se = detail::scope_exit([&] {
  14973. svr.stop();
  14974. t.join();
  14975. ASSERT_FALSE(svr.is_running());
  14976. });
  14977. svr.wait_until_ready();
  14978. SSLClient cli("127.0.0.1", PORT);
  14979. std::string cert;
  14980. read_file(SERVER_CERT2_FILE, cert);
  14981. cli.set_ca_cert_store(tls::create_ca_store(cert.c_str(), cert.size()));
  14982. cli.enable_server_certificate_verification(true);
  14983. cli.set_connection_timeout(30);
  14984. auto res = cli.Get("/test");
  14985. ASSERT_TRUE(res) << "Error: " << to_string(res.error());
  14986. ASSERT_EQ(StatusCode::OK_200, res->status);
  14987. }
  14988. // CA certs loaded through the universal Client must be transferred to the
  14989. // client created internally for following an HTTPS redirect. Regression test:
  14990. // Client::load_ca_cert_store() used to bypass the PEM-based path that stores
  14991. // the CA data for redirect transfer.
  14992. TEST(UniversalClientRedirectTest, LoadCaCertStore) {
  14993. auto ssl_port = PORT + 1;
  14994. SSLServer ssl_svr1(SERVER_CERT2_FILE, SERVER_PRIVATE_KEY_FILE);
  14995. ASSERT_TRUE(ssl_svr1.is_valid());
  14996. ssl_svr1.Get("/index", [&](const Request &, Response &res) {
  14997. res.set_redirect("https://127.0.0.1:" + std::to_string(ssl_port) +
  14998. "/index");
  14999. });
  15000. SSLServer ssl_svr2(SERVER_CERT2_FILE, SERVER_PRIVATE_KEY_FILE);
  15001. ASSERT_TRUE(ssl_svr2.is_valid());
  15002. ssl_svr2.Get("/index", [&](const Request &, Response &res) {
  15003. res.set_content("test", "text/plain");
  15004. });
  15005. thread t = thread([&]() { ASSERT_TRUE(ssl_svr1.listen("127.0.0.1", PORT)); });
  15006. thread t2 =
  15007. thread([&]() { ASSERT_TRUE(ssl_svr2.listen("127.0.0.1", ssl_port)); });
  15008. auto se = detail::scope_exit([&] {
  15009. ssl_svr2.stop();
  15010. ssl_svr1.stop();
  15011. t2.join();
  15012. t.join();
  15013. ASSERT_FALSE(ssl_svr1.is_running());
  15014. });
  15015. ssl_svr1.wait_until_ready();
  15016. ssl_svr2.wait_until_ready();
  15017. Client cli("https://127.0.0.1:" + std::to_string(PORT));
  15018. std::string cert;
  15019. read_file(SERVER_CERT2_FILE, cert);
  15020. cli.load_ca_cert_store(cert.c_str(), cert.size());
  15021. cli.enable_server_certificate_verification(true);
  15022. cli.set_follow_location(true);
  15023. cli.set_connection_timeout(30);
  15024. auto res = cli.Get("/index");
  15025. ASSERT_TRUE(res) << "Error: " << to_string(res.error());
  15026. ASSERT_EQ(StatusCode::OK_200, res->status);
  15027. }
  15028. // enable_system_ca(true) loads system CA certs in addition to a custom CA,
  15029. // so a host signed by a system CA verifies even though a custom CA is set
  15030. TEST(SSLClientTest, EnableSystemCaWithCustomCa_Online) {
  15031. std::string cert;
  15032. read_file(SERVER_CERT2_FILE, cert);
  15033. SSLClient cli("google.com");
  15034. cli.load_ca_cert_store(cert.c_str(), cert.size());
  15035. cli.enable_system_ca(true);
  15036. cli.enable_server_certificate_verification(true);
  15037. auto res = cli.Get("/");
  15038. ASSERT_TRUE(res) << "Error: " << to_string(res.error());
  15039. ASSERT_EQ(StatusCode::MovedPermanently_301, res->status);
  15040. }
  15041. // The custom CA remains effective when combined with the system CA
  15042. TEST(SSLClientTest, EnableSystemCaCustomCaVerifiesLocalServer) {
  15043. SSLServer svr(SERVER_CERT2_FILE, SERVER_PRIVATE_KEY_FILE);
  15044. ASSERT_TRUE(svr.is_valid());
  15045. svr.Get("/test", [&](const Request &, Response &res) {
  15046. res.set_content("test", "text/plain");
  15047. });
  15048. thread t = thread([&]() { ASSERT_TRUE(svr.listen("127.0.0.1", PORT)); });
  15049. auto se = detail::scope_exit([&] {
  15050. svr.stop();
  15051. t.join();
  15052. ASSERT_FALSE(svr.is_running());
  15053. });
  15054. svr.wait_until_ready();
  15055. SSLClient cli("127.0.0.1", PORT);
  15056. std::string cert;
  15057. read_file(SERVER_CERT2_FILE, cert);
  15058. cli.load_ca_cert_store(cert.c_str(), cert.size());
  15059. cli.enable_system_ca(true);
  15060. cli.enable_server_certificate_verification(true);
  15061. cli.set_connection_timeout(30);
  15062. auto res = cli.Get("/test");
  15063. ASSERT_TRUE(res) << "Error: " << to_string(res.error());
  15064. ASSERT_EQ(StatusCode::OK_200, res->status);
  15065. }
  15066. // Regression test: for IP hosts the Mbed TLS and wolfSSL backends used to
  15067. // skip chain verification entirely (only the certificate identity was
  15068. // checked), so a server presenting an untrusted certificate with a matching
  15069. // IP SAN was accepted. The chain must be validated for IP hosts too.
  15070. TEST(SSLClientTest, IpHostUntrustedChainFails) {
  15071. SSLServer svr(SERVER_CERT2_FILE, SERVER_PRIVATE_KEY_FILE);
  15072. ASSERT_TRUE(svr.is_valid());
  15073. svr.Get("/test", [&](const Request &, Response &res) {
  15074. res.set_content("test", "text/plain");
  15075. });
  15076. thread t = thread([&]() { ASSERT_TRUE(svr.listen("127.0.0.1", PORT)); });
  15077. auto se = detail::scope_exit([&] {
  15078. svr.stop();
  15079. t.join();
  15080. ASSERT_FALSE(svr.is_running());
  15081. });
  15082. svr.wait_until_ready();
  15083. SSLClient cli("127.0.0.1", PORT);
  15084. std::string cert;
  15085. // A trusted CA that did not sign the server certificate. The server cert
  15086. // (cert2) carries the matching IP SAN, so only chain validation can reject
  15087. // this connection.
  15088. read_file(CLIENT_CA_CERT_FILE, cert);
  15089. cli.load_ca_cert_store(cert.c_str(), cert.size());
  15090. cli.enable_server_certificate_verification(true);
  15091. cli.set_connection_timeout(30);
  15092. auto res = cli.Get("/test");
  15093. ASSERT_FALSE(res);
  15094. }
  15095. // enable_system_ca(false) prevents system CA loading entirely
  15096. TEST(SSLClientTest, DisableSystemCa_Online) {
  15097. SSLClient cli("google.com");
  15098. cli.enable_system_ca(false);
  15099. cli.enable_server_certificate_verification(true);
  15100. auto res = cli.Get("/");
  15101. ASSERT_FALSE(res);
  15102. // OpenSSL reports a verification failure; Mbed TLS fails the handshake
  15103. // itself when the CA chain is empty
  15104. EXPECT_TRUE(res.error() == Error::SSLServerVerification ||
  15105. res.error() == Error::SSLConnection);
  15106. }
  15107. // The universal Client forwards enable_system_ca()
  15108. TEST(UniversalClientTest, EnableSystemCaWithCustomCa_Online) {
  15109. std::string cert;
  15110. read_file(SERVER_CERT2_FILE, cert);
  15111. Client cli("https://google.com");
  15112. cli.load_ca_cert_store(cert.c_str(), cert.size());
  15113. cli.enable_system_ca(true);
  15114. cli.enable_server_certificate_verification(true);
  15115. auto res = cli.Get("/");
  15116. ASSERT_TRUE(res) << "Error: " << to_string(res.error());
  15117. ASSERT_EQ(StatusCode::MovedPermanently_301, res->status);
  15118. }
  15119. // The system CA policy must carry over to the client created internally for
  15120. // following a cross-host HTTPS redirect
  15121. TEST(UniversalClientRedirectTest, EnableSystemCaCarriesOver_Online) {
  15122. SSLServer svr(SERVER_CERT2_FILE, SERVER_PRIVATE_KEY_FILE);
  15123. ASSERT_TRUE(svr.is_valid());
  15124. svr.Get("/index", [&](const Request &, Response &res) {
  15125. res.set_redirect("https://www.google.com/");
  15126. });
  15127. thread t = thread([&]() { ASSERT_TRUE(svr.listen("127.0.0.1", PORT)); });
  15128. auto se = detail::scope_exit([&] {
  15129. svr.stop();
  15130. t.join();
  15131. ASSERT_FALSE(svr.is_running());
  15132. });
  15133. svr.wait_until_ready();
  15134. Client cli("https://127.0.0.1:" + std::to_string(PORT));
  15135. std::string cert;
  15136. read_file(SERVER_CERT2_FILE, cert);
  15137. cli.load_ca_cert_store(cert.c_str(), cert.size());
  15138. cli.enable_system_ca(true);
  15139. cli.enable_server_certificate_verification(true);
  15140. cli.set_follow_location(true);
  15141. cli.set_connection_timeout(30);
  15142. // Receiving any response proves the redirect client completed the TLS
  15143. // handshake with a system-CA-signed host
  15144. auto res = cli.Get("/index");
  15145. ASSERT_TRUE(res) << "Error: " << to_string(res.error());
  15146. }
  15147. TEST(MultipartFormDataTest, LargeData) {
  15148. SSLServer svr(SERVER_CERT_FILE, SERVER_PRIVATE_KEY_FILE);
  15149. svr.Post("/post", [&](const Request &req, Response & /*res*/,
  15150. const ContentReader &content_reader) {
  15151. if (req.is_multipart_form_data()) {
  15152. std::vector<FormData> items;
  15153. content_reader(
  15154. [&](const FormData &file) {
  15155. items.push_back(file);
  15156. return true;
  15157. },
  15158. [&](const char *data, size_t data_length) {
  15159. items.back().content.append(data, data_length);
  15160. return true;
  15161. });
  15162. EXPECT_TRUE(std::string(items[0].name) == "document");
  15163. EXPECT_EQ(size_t(1024 * 1024 * 2), items[0].content.size());
  15164. EXPECT_TRUE(items[0].filename == "2MB_data");
  15165. EXPECT_TRUE(items[0].content_type == "application/octet-stream");
  15166. EXPECT_TRUE(items[1].name == "hello");
  15167. EXPECT_TRUE(items[1].content == "world");
  15168. EXPECT_TRUE(items[1].filename == "");
  15169. EXPECT_TRUE(items[1].content_type == "");
  15170. } else {
  15171. std::string body;
  15172. content_reader([&](const char *data, size_t data_length) {
  15173. body.append(data, data_length);
  15174. return true;
  15175. });
  15176. }
  15177. });
  15178. auto port = svr.bind_to_any_port(HOST);
  15179. auto t = std::thread([&]() { svr.listen_after_bind(); });
  15180. auto se = detail::scope_exit([&] {
  15181. svr.stop();
  15182. t.join();
  15183. ASSERT_FALSE(svr.is_running());
  15184. });
  15185. svr.wait_until_ready();
  15186. {
  15187. std::string data(1024 * 1024 * 2, '.');
  15188. std::stringstream buffer;
  15189. buffer << data;
  15190. SSLClient cli(HOST, port);
  15191. cli.enable_server_certificate_verification(false);
  15192. UploadFormDataItems items{
  15193. {"document", buffer.str(), "2MB_data", "application/octet-stream"},
  15194. {"hello", "world", "", ""},
  15195. };
  15196. auto res = cli.Post("/post", items);
  15197. ASSERT_TRUE(res) << "Error: " << to_string(res.error());
  15198. ASSERT_EQ(StatusCode::OK_200, res->status);
  15199. }
  15200. }
  15201. TEST(MultipartFormDataTest, DataProviderItems) {
  15202. std::random_device seed_gen;
  15203. std::mt19937 random(seed_gen());
  15204. std::string rand1;
  15205. rand1.resize(1000);
  15206. std::generate(rand1.begin(), rand1.end(), [&]() { return random(); });
  15207. std::string rand2;
  15208. rand2.resize(3000);
  15209. std::generate(rand2.begin(), rand2.end(), [&]() { return random(); });
  15210. SSLServer svr(SERVER_CERT_FILE, SERVER_PRIVATE_KEY_FILE);
  15211. svr.Post("/post-none", [&](const Request &req, Response & /*res*/,
  15212. const ContentReader &content_reader) {
  15213. ASSERT_FALSE(req.is_multipart_form_data());
  15214. std::string body;
  15215. content_reader([&](const char *data, size_t data_length) {
  15216. body.append(data, data_length);
  15217. return true;
  15218. });
  15219. EXPECT_EQ(body, "");
  15220. });
  15221. svr.Post("/post-items", [&](const Request &req, Response & /*res*/,
  15222. const ContentReader &content_reader) {
  15223. ASSERT_TRUE(req.is_multipart_form_data());
  15224. std::vector<FormData> items;
  15225. content_reader(
  15226. [&](const FormData &file) {
  15227. items.push_back(file);
  15228. return true;
  15229. },
  15230. [&](const char *data, size_t data_length) {
  15231. items.back().content.append(data, data_length);
  15232. return true;
  15233. });
  15234. ASSERT_TRUE(items.size() == 2);
  15235. EXPECT_EQ(std::string(items[0].name), "name1");
  15236. EXPECT_EQ(items[0].content, "Testing123");
  15237. EXPECT_EQ(items[0].filename, "filename1");
  15238. EXPECT_EQ(items[0].content_type, "application/octet-stream");
  15239. EXPECT_EQ(items[1].name, "name2");
  15240. EXPECT_EQ(items[1].content, "Testing456");
  15241. EXPECT_EQ(items[1].filename, "");
  15242. EXPECT_EQ(items[1].content_type, "");
  15243. });
  15244. svr.Post("/post-providers", [&](const Request &req, Response & /*res*/,
  15245. const ContentReader &content_reader) {
  15246. ASSERT_TRUE(req.is_multipart_form_data());
  15247. std::vector<FormData> items;
  15248. content_reader(
  15249. [&](const FormData &file) {
  15250. items.push_back(file);
  15251. return true;
  15252. },
  15253. [&](const char *data, size_t data_length) {
  15254. items.back().content.append(data, data_length);
  15255. return true;
  15256. });
  15257. ASSERT_TRUE(items.size() == 2);
  15258. EXPECT_EQ(items[0].name, "name3");
  15259. EXPECT_EQ(items[0].content, rand1);
  15260. EXPECT_EQ(items[0].filename, "filename3");
  15261. EXPECT_EQ(items[0].content_type, "");
  15262. EXPECT_EQ(items[1].name, "name4");
  15263. EXPECT_EQ(items[1].content, rand2);
  15264. EXPECT_EQ(items[1].filename, "filename4");
  15265. EXPECT_EQ(items[1].content_type, "");
  15266. });
  15267. svr.Post("/post-both", [&](const Request &req, Response & /*res*/,
  15268. const ContentReader &content_reader) {
  15269. ASSERT_TRUE(req.is_multipart_form_data());
  15270. std::vector<FormData> items;
  15271. content_reader(
  15272. [&](const FormData &file) {
  15273. items.push_back(file);
  15274. return true;
  15275. },
  15276. [&](const char *data, size_t data_length) {
  15277. items.back().content.append(data, data_length);
  15278. return true;
  15279. });
  15280. ASSERT_TRUE(items.size() == 4);
  15281. EXPECT_EQ(std::string(items[0].name), "name1");
  15282. EXPECT_EQ(items[0].content, "Testing123");
  15283. EXPECT_EQ(items[0].filename, "filename1");
  15284. EXPECT_EQ(items[0].content_type, "application/octet-stream");
  15285. EXPECT_EQ(items[1].name, "name2");
  15286. EXPECT_EQ(items[1].content, "Testing456");
  15287. EXPECT_EQ(items[1].filename, "");
  15288. EXPECT_EQ(items[1].content_type, "");
  15289. EXPECT_EQ(items[2].name, "name3");
  15290. EXPECT_EQ(items[2].content, rand1);
  15291. EXPECT_EQ(items[2].filename, "filename3");
  15292. EXPECT_EQ(items[2].content_type, "");
  15293. EXPECT_EQ(items[3].name, "name4");
  15294. EXPECT_EQ(items[3].content, rand2);
  15295. EXPECT_EQ(items[3].filename, "filename4");
  15296. EXPECT_EQ(items[3].content_type, "");
  15297. });
  15298. auto port = svr.bind_to_any_port("localhost");
  15299. auto t = std::thread([&]() { svr.listen_after_bind(); });
  15300. auto se = detail::scope_exit([&] {
  15301. svr.stop();
  15302. t.join();
  15303. ASSERT_FALSE(svr.is_running());
  15304. });
  15305. svr.wait_until_ready();
  15306. {
  15307. SSLClient cli("localhost", port);
  15308. cli.enable_server_certificate_verification(false);
  15309. UploadFormDataItems items{
  15310. {"name1", "Testing123", "filename1", "application/octet-stream"},
  15311. {"name2", "Testing456", "", ""}, // not a file
  15312. };
  15313. {
  15314. auto res = cli.Post("/post-none", {}, {}, {});
  15315. ASSERT_TRUE(res) << "Error: " << to_string(res.error());
  15316. ASSERT_EQ(StatusCode::OK_200, res->status);
  15317. }
  15318. FormDataProviderItems providers;
  15319. {
  15320. auto res =
  15321. cli.Post("/post-items", {}, items, providers); // empty providers
  15322. ASSERT_TRUE(res) << "Error: " << to_string(res.error());
  15323. ASSERT_EQ(StatusCode::OK_200, res->status);
  15324. }
  15325. providers.push_back({"name3",
  15326. [&](size_t offset, httplib::DataSink &sink) -> bool {
  15327. // test the offset is given correctly at each step
  15328. if (!offset)
  15329. sink.os.write(rand1.data(), 30);
  15330. else if (offset == 30)
  15331. sink.os.write(rand1.data() + 30, 300);
  15332. else if (offset == 330)
  15333. sink.os.write(rand1.data() + 330, 670);
  15334. else if (offset == rand1.size())
  15335. sink.done();
  15336. return true;
  15337. },
  15338. "filename3",
  15339. {}});
  15340. providers.push_back({"name4",
  15341. [&](size_t offset, httplib::DataSink &sink) -> bool {
  15342. // test the offset is given correctly at each step
  15343. if (!offset)
  15344. sink.os.write(rand2.data(), 2000);
  15345. else if (offset == 2000)
  15346. sink.os.write(rand2.data() + 2000, 1);
  15347. else if (offset == 2001)
  15348. sink.os.write(rand2.data() + 2001, 999);
  15349. else if (offset == rand2.size())
  15350. sink.done();
  15351. return true;
  15352. },
  15353. "filename4",
  15354. {}});
  15355. {
  15356. auto res = cli.Post("/post-providers", {}, {}, providers);
  15357. ASSERT_TRUE(res) << "Error: " << to_string(res.error());
  15358. ASSERT_EQ(StatusCode::OK_200, res->status);
  15359. }
  15360. {
  15361. auto res = cli.Post("/post-both", {}, items, providers);
  15362. ASSERT_TRUE(res) << "Error: " << to_string(res.error());
  15363. ASSERT_EQ(StatusCode::OK_200, res->status);
  15364. }
  15365. }
  15366. }
  15367. TEST(MultipartFormDataTest, BadHeader) {
  15368. Server svr;
  15369. svr.Post("/post", [&](const Request & /*req*/, Response &res) {
  15370. res.set_content("ok", "text/plain");
  15371. });
  15372. thread t = thread([&] { svr.listen(HOST, PORT); });
  15373. auto se = detail::scope_exit([&] {
  15374. svr.stop();
  15375. t.join();
  15376. ASSERT_FALSE(svr.is_running());
  15377. });
  15378. svr.wait_until_ready();
  15379. const std::string body =
  15380. "This is the preamble. It is to be ignored, though it\r\n"
  15381. "is a handy place for composition agents to include an\r\n"
  15382. "explanatory note to non-MIME conformant readers.\r\n"
  15383. "\r\n"
  15384. "\r\n"
  15385. "--simple boundary\r\n"
  15386. "Content-Disposition: form-data; name=\"field1\"\r\n"
  15387. ": BAD...\r\n"
  15388. "\r\n"
  15389. "value1\r\n"
  15390. "--simple boundary\r\n"
  15391. "Content-Disposition: form-data; name=\"field2\"; "
  15392. "filename=\"example.txt\"\r\n"
  15393. "\r\n"
  15394. "value2\r\n"
  15395. "--simple boundary--\r\n"
  15396. "This is the epilogue. It is also to be ignored.\r\n";
  15397. std::string content_type =
  15398. R"(multipart/form-data; boundary="simple boundary")";
  15399. Client cli(HOST, PORT);
  15400. auto res = cli.Post("/post", body, content_type.c_str());
  15401. ASSERT_TRUE(res) << "Error: " << to_string(res.error());
  15402. EXPECT_EQ(StatusCode::BadRequest_400, res->status);
  15403. }
  15404. TEST(MultipartFormDataTest, WithPreamble) {
  15405. Server svr;
  15406. svr.Post("/post", [&](const Request & /*req*/, Response &res) {
  15407. res.set_content("ok", "text/plain");
  15408. });
  15409. thread t = thread([&] { svr.listen(HOST, PORT); });
  15410. auto se = detail::scope_exit([&] {
  15411. svr.stop();
  15412. t.join();
  15413. ASSERT_FALSE(svr.is_running());
  15414. });
  15415. svr.wait_until_ready();
  15416. const std::string body =
  15417. "This is the preamble. It is to be ignored, though it\r\n"
  15418. "is a handy place for composition agents to include an\r\n"
  15419. "explanatory note to non-MIME conformant readers.\r\n"
  15420. "\r\n"
  15421. "\r\n"
  15422. "--simple boundary\r\n"
  15423. "Content-Disposition: form-data; name=\"field1\"\r\n"
  15424. "\r\n"
  15425. "value1\r\n"
  15426. "--simple boundary\r\n"
  15427. "Content-Disposition: form-data; name=\"field2\"; "
  15428. "filename=\"example.txt\"\r\n"
  15429. "\r\n"
  15430. "value2\r\n"
  15431. "--simple boundary--\r\n"
  15432. "This is the epilogue. It is also to be ignored.\r\n";
  15433. std::string content_type =
  15434. R"(multipart/form-data; boundary="simple boundary")";
  15435. Client cli(HOST, PORT);
  15436. auto res = cli.Post("/post", body, content_type.c_str());
  15437. ASSERT_TRUE(res) << "Error: " << to_string(res.error());
  15438. EXPECT_EQ(StatusCode::OK_200, res->status);
  15439. }
  15440. TEST(MultipartFormDataTest, PostCustomBoundary) {
  15441. SSLServer svr(SERVER_CERT_FILE, SERVER_PRIVATE_KEY_FILE);
  15442. svr.Post("/post_customboundary", [&](const Request &req, Response & /*res*/,
  15443. const ContentReader &content_reader) {
  15444. if (req.is_multipart_form_data()) {
  15445. std::vector<FormData> items;
  15446. content_reader(
  15447. [&](const FormData &file) {
  15448. items.push_back(file);
  15449. return true;
  15450. },
  15451. [&](const char *data, size_t data_length) {
  15452. items.back().content.append(data, data_length);
  15453. return true;
  15454. });
  15455. EXPECT_TRUE(std::string(items[0].name) == "document");
  15456. EXPECT_EQ(size_t(1024 * 1024 * 2), items[0].content.size());
  15457. EXPECT_TRUE(items[0].filename == "2MB_data");
  15458. EXPECT_TRUE(items[0].content_type == "application/octet-stream");
  15459. EXPECT_TRUE(items[1].name == "hello");
  15460. EXPECT_TRUE(items[1].content == "world");
  15461. EXPECT_TRUE(items[1].filename == "");
  15462. EXPECT_TRUE(items[1].content_type == "");
  15463. } else {
  15464. std::string body;
  15465. content_reader([&](const char *data, size_t data_length) {
  15466. body.append(data, data_length);
  15467. return true;
  15468. });
  15469. }
  15470. });
  15471. auto port = svr.bind_to_any_port("localhost");
  15472. auto t = std::thread([&]() { 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. {
  15480. std::string data(1024 * 1024 * 2, '.');
  15481. std::stringstream buffer;
  15482. buffer << data;
  15483. SSLClient cli("localhost", port);
  15484. cli.enable_server_certificate_verification(false);
  15485. UploadFormDataItems items{
  15486. {"document", buffer.str(), "2MB_data", "application/octet-stream"},
  15487. {"hello", "world", "", ""},
  15488. };
  15489. auto res = cli.Post("/post_customboundary", {}, items, "abc-abc");
  15490. ASSERT_TRUE(res) << "Error: " << to_string(res.error());
  15491. ASSERT_EQ(StatusCode::OK_200, res->status);
  15492. }
  15493. }
  15494. TEST(MultipartFormDataTest, PostInvalidBoundaryChars) {
  15495. std::string data(1024 * 1024 * 2, '&');
  15496. std::stringstream buffer;
  15497. buffer << data;
  15498. Client cli("https://localhost:8080");
  15499. UploadFormDataItems items{
  15500. {"document", buffer.str(), "2MB_data", "application/octet-stream"},
  15501. {"hello", "world", "", ""},
  15502. };
  15503. for (const char &c : " \t\r\n") {
  15504. auto res =
  15505. cli.Post("/invalid_boundary", {}, items, string("abc123").append(1, c));
  15506. ASSERT_EQ(Error::UnsupportedMultipartBoundaryChars, res.error());
  15507. ASSERT_FALSE(res);
  15508. }
  15509. }
  15510. TEST(MultipartFormDataTest, PutFormData) {
  15511. SSLServer svr(SERVER_CERT_FILE, SERVER_PRIVATE_KEY_FILE);
  15512. svr.Put("/put", [&](const Request &req, const Response & /*res*/,
  15513. const ContentReader &content_reader) {
  15514. if (req.is_multipart_form_data()) {
  15515. std::vector<FormData> items;
  15516. content_reader(
  15517. [&](const FormData &file) {
  15518. items.push_back(file);
  15519. return true;
  15520. },
  15521. [&](const char *data, size_t data_length) {
  15522. items.back().content.append(data, data_length);
  15523. return true;
  15524. });
  15525. EXPECT_TRUE(std::string(items[0].name) == "document");
  15526. EXPECT_EQ(size_t(1024 * 1024 * 2), items[0].content.size());
  15527. EXPECT_TRUE(items[0].filename == "2MB_data");
  15528. EXPECT_TRUE(items[0].content_type == "application/octet-stream");
  15529. EXPECT_TRUE(items[1].name == "hello");
  15530. EXPECT_TRUE(items[1].content == "world");
  15531. EXPECT_TRUE(items[1].filename == "");
  15532. EXPECT_TRUE(items[1].content_type == "");
  15533. } else {
  15534. std::string body;
  15535. content_reader([&](const char *data, size_t data_length) {
  15536. body.append(data, data_length);
  15537. return true;
  15538. });
  15539. }
  15540. });
  15541. auto port = svr.bind_to_any_port("localhost");
  15542. auto t = std::thread([&]() { svr.listen_after_bind(); });
  15543. auto se = detail::scope_exit([&] {
  15544. svr.stop();
  15545. t.join();
  15546. ASSERT_FALSE(svr.is_running());
  15547. });
  15548. svr.wait_until_ready();
  15549. {
  15550. std::string data(1024 * 1024 * 2, '&');
  15551. std::stringstream buffer;
  15552. buffer << data;
  15553. SSLClient cli("localhost", port);
  15554. cli.enable_server_certificate_verification(false);
  15555. UploadFormDataItems items{
  15556. {"document", buffer.str(), "2MB_data", "application/octet-stream"},
  15557. {"hello", "world", "", ""},
  15558. };
  15559. auto res = cli.Put("/put", items);
  15560. ASSERT_TRUE(res) << "Error: " << to_string(res.error());
  15561. ASSERT_EQ(StatusCode::OK_200, res->status);
  15562. }
  15563. }
  15564. TEST(MultipartFormDataTest, PutFormDataCustomBoundary) {
  15565. SSLServer svr(SERVER_CERT_FILE, SERVER_PRIVATE_KEY_FILE);
  15566. svr.Put("/put_customboundary",
  15567. [&](const Request &req, const Response & /*res*/,
  15568. const ContentReader &content_reader) {
  15569. if (req.is_multipart_form_data()) {
  15570. std::vector<FormData> items;
  15571. content_reader(
  15572. [&](const FormData &file) {
  15573. items.push_back(file);
  15574. return true;
  15575. },
  15576. [&](const char *data, size_t data_length) {
  15577. items.back().content.append(data, data_length);
  15578. return true;
  15579. });
  15580. EXPECT_TRUE(std::string(items[0].name) == "document");
  15581. EXPECT_EQ(size_t(1024 * 1024 * 2), items[0].content.size());
  15582. EXPECT_TRUE(items[0].filename == "2MB_data");
  15583. EXPECT_TRUE(items[0].content_type == "application/octet-stream");
  15584. EXPECT_TRUE(items[1].name == "hello");
  15585. EXPECT_TRUE(items[1].content == "world");
  15586. EXPECT_TRUE(items[1].filename == "");
  15587. EXPECT_TRUE(items[1].content_type == "");
  15588. } else {
  15589. std::string body;
  15590. content_reader([&](const char *data, size_t data_length) {
  15591. body.append(data, data_length);
  15592. return true;
  15593. });
  15594. }
  15595. });
  15596. auto port = svr.bind_to_any_port("localhost");
  15597. auto t = std::thread([&]() { svr.listen_after_bind(); });
  15598. auto se = detail::scope_exit([&] {
  15599. svr.stop();
  15600. t.join();
  15601. ASSERT_FALSE(svr.is_running());
  15602. });
  15603. svr.wait_until_ready();
  15604. {
  15605. std::string data(1024 * 1024 * 2, '&');
  15606. std::stringstream buffer;
  15607. buffer << data;
  15608. SSLClient cli("localhost", port);
  15609. cli.enable_server_certificate_verification(false);
  15610. UploadFormDataItems items{
  15611. {"document", buffer.str(), "2MB_data", "application/octet-stream"},
  15612. {"hello", "world", "", ""},
  15613. };
  15614. auto res = cli.Put("/put_customboundary", {}, items, "abc-abc_");
  15615. ASSERT_TRUE(res) << "Error: " << to_string(res.error());
  15616. ASSERT_EQ(StatusCode::OK_200, res->status);
  15617. }
  15618. }
  15619. TEST(MultipartFormDataTest, PutInvalidBoundaryChars) {
  15620. std::string data(1024 * 1024 * 2, '&');
  15621. std::stringstream buffer;
  15622. buffer << data;
  15623. Client cli("https://localhost:8080");
  15624. cli.enable_server_certificate_verification(false);
  15625. UploadFormDataItems items{
  15626. {"document", buffer.str(), "2MB_data", "application/octet-stream"},
  15627. {"hello", "world", "", ""},
  15628. };
  15629. for (const char &c : " \t\r\n") {
  15630. auto res = cli.Put("/put", {}, items, string("abc123").append(1, c));
  15631. ASSERT_EQ(Error::UnsupportedMultipartBoundaryChars, res.error());
  15632. ASSERT_FALSE(res);
  15633. }
  15634. }
  15635. TEST(MultipartFormDataTest, AlternateFilename) {
  15636. auto handled = false;
  15637. Server svr;
  15638. svr.Post("/test", [&](const Request &req, Response &res) {
  15639. ASSERT_EQ(2u, req.form.files.size());
  15640. ASSERT_EQ(1u, req.form.fields.size());
  15641. // Test files
  15642. const auto &file1 = req.form.get_file("file1");
  15643. ASSERT_EQ("file1", file1.name);
  15644. ASSERT_EQ("A.txt", file1.filename);
  15645. ASSERT_EQ("text/plain", file1.content_type);
  15646. ASSERT_EQ("Content of a.txt.\r\n", file1.content);
  15647. const auto &file2 = req.form.get_file("file2");
  15648. ASSERT_EQ("file2", file2.name);
  15649. ASSERT_EQ("a.html", file2.filename);
  15650. ASSERT_EQ("text/html", file2.content_type);
  15651. ASSERT_EQ("<!DOCTYPE html><title>Content of a.html.</title>\r\n",
  15652. file2.content);
  15653. // Test text field
  15654. const auto &text = req.form.get_field("text");
  15655. ASSERT_EQ("text default", text);
  15656. res.set_content("ok", "text/plain");
  15657. handled = true;
  15658. });
  15659. thread t = thread([&] { svr.listen(HOST, PORT); });
  15660. auto se = detail::scope_exit([&] {
  15661. svr.stop();
  15662. t.join();
  15663. ASSERT_FALSE(svr.is_running());
  15664. ASSERT_TRUE(handled);
  15665. });
  15666. svr.wait_until_ready();
  15667. auto req = "POST /test HTTP/1.1\r\n"
  15668. "Host: localhost\r\n"
  15669. "Content-Type: multipart/form-data;boundary=--------\r\n"
  15670. "Content-Length: 399\r\n"
  15671. "\r\n"
  15672. "----------\r\n"
  15673. "Content-Disposition: form-data; name=\"text\"\r\n"
  15674. "\r\n"
  15675. "text default\r\n"
  15676. "----------\r\n"
  15677. "Content-Disposition: form-data; filename*=\"UTF-8''%41.txt\"; "
  15678. "filename=\"a.txt\"; name=\"file1\"\r\n"
  15679. "Content-Type: text/plain\r\n"
  15680. "\r\n"
  15681. "Content of a.txt.\r\n"
  15682. "\r\n"
  15683. "----------\r\n"
  15684. "Content-Disposition: form-data; name=\"file2\" ;filename = "
  15685. "\"a.html\"\r\n"
  15686. "Content-Type: text/html\r\n"
  15687. "\r\n"
  15688. "<!DOCTYPE html><title>Content of a.html.</title>\r\n"
  15689. "\r\n"
  15690. "------------\r\n";
  15691. ASSERT_TRUE(send_request(1, req));
  15692. }
  15693. TEST(MultipartFormDataTest, AlternateFilenameLongValueAndCaseInsensitive) {
  15694. auto handled = false;
  15695. Server svr;
  15696. svr.Post("/test", [&](const Request &req, Response &res) {
  15697. // Case-insensitive "utf-8''" prefix with a long value
  15698. const auto &file = req.form.get_file("file1");
  15699. ASSERT_EQ("file1", file.name);
  15700. // 8000 chars exercises both the Content-Disposition parser and the
  15701. // filename* parser near the CPPHTTPLIB_HEADER_MAX_LENGTH limit (8192).
  15702. // Prior to the fix, std::regex_match on this header would cause O(N)
  15703. // stack recursion in libstdc++, leading to SIGSEGV.
  15704. std::string expected_filename(8000, 'A');
  15705. ASSERT_EQ(expected_filename, file.filename);
  15706. res.set_content("ok", "text/plain");
  15707. handled = true;
  15708. });
  15709. thread t = thread([&] { svr.listen(HOST, PORT); });
  15710. auto se = detail::scope_exit([&] {
  15711. svr.stop();
  15712. t.join();
  15713. ASSERT_FALSE(svr.is_running());
  15714. ASSERT_TRUE(handled);
  15715. });
  15716. svr.wait_until_ready();
  15717. // Build body with a long filename* value using mixed-case prefix "Utf-8''"
  15718. // Regression test for GHSA-qq6v-r583-3h69
  15719. std::string long_filename(8000, 'A');
  15720. std::string body = "----------\r\n"
  15721. "Content-Disposition: form-data; name=\"file1\"; "
  15722. "filename*=\"Utf-8''" +
  15723. long_filename +
  15724. "\"\r\n"
  15725. "\r\n"
  15726. "hello\r\n"
  15727. "------------\r\n";
  15728. auto req = "POST /test HTTP/1.1\r\n"
  15729. "Host: localhost\r\n"
  15730. "Content-Type: multipart/form-data;boundary=--------\r\n"
  15731. "Content-Length: " +
  15732. std::to_string(body.size()) + "\r\n\r\n" + body;
  15733. ASSERT_TRUE(send_request(1, req));
  15734. }
  15735. TEST(MultipartFormDataTest, CloseDelimiterWithoutCRLF) {
  15736. auto handled = false;
  15737. Server svr;
  15738. svr.Post("/test", [&](const Request &req, Response &) {
  15739. ASSERT_EQ(2u, req.form.fields.size());
  15740. const auto &text1 = req.form.get_field("text1");
  15741. ASSERT_EQ("text1", text1);
  15742. const auto &text2 = req.form.get_field("text2");
  15743. ASSERT_EQ("text2", text2);
  15744. handled = true;
  15745. });
  15746. thread t = thread([&] { svr.listen(HOST, PORT); });
  15747. auto se = detail::scope_exit([&] {
  15748. svr.stop();
  15749. t.join();
  15750. ASSERT_FALSE(svr.is_running());
  15751. ASSERT_TRUE(handled);
  15752. });
  15753. svr.wait_until_ready();
  15754. auto req = "POST /test HTTP/1.1\r\n"
  15755. "Host: localhost\r\n"
  15756. "Content-Type: multipart/form-data;boundary=--------\r\n"
  15757. "Content-Length: 146\r\n"
  15758. "\r\n----------\r\n"
  15759. "Content-Disposition: form-data; name=\"text1\"\r\n"
  15760. "\r\n"
  15761. "text1"
  15762. "\r\n----------\r\n"
  15763. "Content-Disposition: form-data; name=\"text2\"\r\n"
  15764. "\r\n"
  15765. "text2"
  15766. "\r\n------------";
  15767. std::string response;
  15768. ASSERT_TRUE(send_request(1, req, &response));
  15769. ASSERT_EQ("200", response.substr(9, 3));
  15770. }
  15771. TEST(MultipartFormDataTest, ContentLength) {
  15772. auto handled = false;
  15773. Server svr;
  15774. svr.Post("/test", [&](const Request &req, Response &) {
  15775. ASSERT_EQ(2u, req.form.fields.size());
  15776. const auto &text1 = req.form.get_field("text1");
  15777. ASSERT_EQ("text1", text1);
  15778. const auto &text2 = req.form.get_field("text2");
  15779. ASSERT_EQ("text2", text2);
  15780. handled = true;
  15781. });
  15782. thread t = thread([&] { svr.listen(HOST, PORT); });
  15783. auto se = detail::scope_exit([&] {
  15784. svr.stop();
  15785. t.join();
  15786. ASSERT_FALSE(svr.is_running());
  15787. ASSERT_TRUE(handled);
  15788. });
  15789. svr.wait_until_ready();
  15790. auto req = "POST /test HTTP/1.1\r\n"
  15791. "Host: localhost\r\n"
  15792. "Content-Type: multipart/form-data;boundary=--------\r\n"
  15793. "Content-Length: 167\r\n"
  15794. "\r\n----------\r\n"
  15795. "Content-Disposition: form-data; name=\"text1\"\r\n"
  15796. "Content-Length: 5\r\n"
  15797. "\r\n"
  15798. "text1"
  15799. "\r\n----------\r\n"
  15800. "Content-Disposition: form-data; name=\"text2\"\r\n"
  15801. "\r\n"
  15802. "text2"
  15803. "\r\n------------\r\n";
  15804. std::string response;
  15805. ASSERT_TRUE(send_request(1, req, &response));
  15806. ASSERT_EQ("200", response.substr(9, 3));
  15807. }
  15808. TEST(MultipartFormDataTest, AccessPartHeaders) {
  15809. auto handled = false;
  15810. Server svr;
  15811. svr.Post("/test", [&](const Request &req, Response &) {
  15812. ASSERT_EQ(2u, req.form.fields.size());
  15813. const auto &text1 = req.form.get_field("text1");
  15814. ASSERT_EQ("text1", text1);
  15815. // TODO: Add header access for text fields if needed
  15816. const auto &text2 = req.form.get_field("text2");
  15817. ASSERT_EQ("text2", text2);
  15818. // TODO: Header access for text fields needs to be implemented
  15819. // auto &headers = it->second.headers;
  15820. // ASSERT_EQ(3U, headers.size());
  15821. // auto custom_header = headers.find("x-whatever");
  15822. // ASSERT_TRUE(custom_header != headers.end());
  15823. // ASSERT_NE("customvalue", custom_header->second);
  15824. // ASSERT_EQ("CustomValue", custom_header->second);
  15825. // ASSERT_TRUE(headers.find("X-Test") == headers.end()); // text1 header
  15826. handled = true;
  15827. });
  15828. thread t = thread([&] { svr.listen(HOST, PORT); });
  15829. auto se = detail::scope_exit([&] {
  15830. svr.stop();
  15831. t.join();
  15832. ASSERT_FALSE(svr.is_running());
  15833. ASSERT_TRUE(handled);
  15834. });
  15835. svr.wait_until_ready();
  15836. auto req = "POST /test HTTP/1.1\r\n"
  15837. "Host: localhost\r\n"
  15838. "Content-Type: multipart/form-data;boundary=--------\r\n"
  15839. "Content-Length: 232\r\n"
  15840. "\r\n----------\r\n"
  15841. "Content-Disposition: form-data; name=\"text1\"\r\n"
  15842. "Content-Length: 5\r\n"
  15843. "X-Test: 1\r\n"
  15844. "\r\n"
  15845. "text1"
  15846. "\r\n----------\r\n"
  15847. "Content-Disposition: form-data; name=\"text2\"\r\n"
  15848. "Content-Type: text/plain\r\n"
  15849. "X-Whatever: CustomValue\r\n"
  15850. "\r\n"
  15851. "text2"
  15852. "\r\n------------\r\n"
  15853. "That should be disregarded. Not even read";
  15854. std::string response;
  15855. ASSERT_TRUE(send_request(1, req, &response));
  15856. ASSERT_EQ("200", response.substr(9, 3));
  15857. }
  15858. TEST(MultipartFormDataTest, LargeHeader) {
  15859. auto handled = false;
  15860. Server svr;
  15861. svr.Post("/test", [&](const Request &req, Response &) {
  15862. ASSERT_EQ(1u, req.form.fields.size());
  15863. const auto &text = req.form.get_field("name1");
  15864. ASSERT_EQ("text1", text);
  15865. handled = true;
  15866. });
  15867. thread t = thread([&] { svr.listen(HOST, PORT); });
  15868. auto se = detail::scope_exit([&] {
  15869. svr.stop();
  15870. t.join();
  15871. ASSERT_FALSE(svr.is_running());
  15872. ASSERT_TRUE(handled);
  15873. });
  15874. svr.wait_until_ready();
  15875. auto boundary = std::string("cpp-httplib-multipart-data");
  15876. std::string content = "--" + boundary +
  15877. "\r\n"
  15878. "Content-Disposition: form-data; name=\"name1\"\r\n"
  15879. "\r\n"
  15880. "text1\r\n"
  15881. "--" +
  15882. boundary + "--\r\n";
  15883. std::string header_prefix = "POST /test HTTP/1.1\r\n"
  15884. "Host: localhost\r\n"
  15885. "Content-Type: multipart/form-data;boundary=" +
  15886. boundary +
  15887. "\r\n"
  15888. "Content-Length: " +
  15889. std::to_string(content.size()) +
  15890. "\r\n"
  15891. "Dummy-Header: ";
  15892. std::string header_suffix = "\r\n"
  15893. "\r\n";
  15894. size_t read_buff_size = 1024u * 4; // SocketStream::read_buff_size_
  15895. size_t header_dummy_size =
  15896. read_buff_size -
  15897. (header_prefix.size() + header_suffix.size() + boundary.size() / 2);
  15898. auto header_dummy = std::string(header_dummy_size, '@');
  15899. auto req = header_prefix + header_dummy + header_suffix + content;
  15900. std::string response;
  15901. ASSERT_TRUE(send_request(1, req, &response));
  15902. ASSERT_EQ("200", response.substr(9, 3));
  15903. }
  15904. TEST(MultipartFormDataTest, UploadItemsHasContentLength) {
  15905. // Verify that Post(path, headers, UploadFormDataItems) sends Content-Length
  15906. // (not chunked Transfer-Encoding) after the streaming refactor.
  15907. auto handled = false;
  15908. Server svr;
  15909. svr.Post("/upload", [&](const Request &req, Response &res) {
  15910. auto cl_it = req.headers.find("Content-Length");
  15911. EXPECT_TRUE(cl_it != req.headers.end());
  15912. auto te_it = req.headers.find("Transfer-Encoding");
  15913. EXPECT_TRUE(te_it == req.headers.end());
  15914. EXPECT_EQ(2u, req.form.fields.size() + req.form.files.size());
  15915. res.set_content("ok", "text/plain");
  15916. handled = true;
  15917. });
  15918. auto port = svr.bind_to_any_port(HOST);
  15919. auto t = thread([&] { svr.listen_after_bind(); });
  15920. auto se = detail::scope_exit([&] {
  15921. svr.stop();
  15922. t.join();
  15923. ASSERT_FALSE(svr.is_running());
  15924. ASSERT_TRUE(handled);
  15925. });
  15926. svr.wait_until_ready();
  15927. UploadFormDataItems items = {
  15928. {"field1", "hello", "", "text/plain"},
  15929. {"file1", "world", "test.txt", "application/octet-stream"},
  15930. };
  15931. Client cli(HOST, port);
  15932. auto res = cli.Post("/upload", {}, items);
  15933. ASSERT_TRUE(res) << "Error: " << to_string(res.error());
  15934. EXPECT_EQ(StatusCode::OK_200, res->status);
  15935. }
  15936. TEST(MultipartFormDataTest, ContentProviderCoalescesWrites) {
  15937. // Verify that make_multipart_content_provider coalesces many small segments
  15938. // into fewer sink.write() calls to avoid TCP packet fragmentation (#2410).
  15939. constexpr size_t kItemCount = 1000;
  15940. UploadFormDataItems items;
  15941. items.reserve(kItemCount);
  15942. for (size_t i = 0; i < kItemCount; i++) {
  15943. items.push_back(
  15944. {"field" + std::to_string(i), "value" + std::to_string(i), "", ""});
  15945. }
  15946. const std::string boundary = "----test-boundary";
  15947. auto content_length = detail::get_multipart_content_length(items, boundary);
  15948. auto provider = detail::make_multipart_content_provider(items, boundary);
  15949. // Drive the provider the same way write_content_with_progress does
  15950. size_t write_count = 0;
  15951. size_t total_bytes = 0;
  15952. DataSink sink;
  15953. size_t offset = 0;
  15954. sink.write = [&](const char *d, size_t l) -> bool {
  15955. (void)d;
  15956. write_count++;
  15957. total_bytes += l;
  15958. offset += l;
  15959. return true;
  15960. };
  15961. sink.is_writable = []() -> bool { return true; };
  15962. while (offset < content_length) {
  15963. ASSERT_TRUE(provider(offset, content_length - offset, sink));
  15964. }
  15965. EXPECT_EQ(content_length, total_bytes);
  15966. // The total number of segments is 3 * kItemCount + 1 = 3001.
  15967. // With buffering into 64KB blocks, write_count should be much smaller.
  15968. auto segment_count = 3 * kItemCount + 1;
  15969. EXPECT_LT(write_count, segment_count / 10);
  15970. }
  15971. TEST(MultipartFormDataTest, ManyItemsEndToEnd) {
  15972. // Integration test: send many UploadFormDataItems and verify the server
  15973. // receives all of them correctly (#2410).
  15974. constexpr size_t kItemCount = 500;
  15975. auto handled = false;
  15976. Server svr;
  15977. svr.Post("/upload", [&](const Request &req, Response &res) {
  15978. EXPECT_EQ(kItemCount, req.form.fields.size());
  15979. for (size_t i = 0; i < kItemCount; i++) {
  15980. auto key = "field" + std::to_string(i);
  15981. auto val = "value" + std::to_string(i);
  15982. auto it = req.form.fields.find(key);
  15983. if (it != req.form.fields.end()) {
  15984. EXPECT_EQ(val, it->second.content);
  15985. } else {
  15986. ADD_FAILURE() << "Missing field: " << key;
  15987. }
  15988. }
  15989. res.set_content("ok", "text/plain");
  15990. handled = true;
  15991. });
  15992. auto port = svr.bind_to_any_port(HOST);
  15993. auto t = thread([&] { svr.listen_after_bind(); });
  15994. auto se = detail::scope_exit([&] {
  15995. svr.stop();
  15996. t.join();
  15997. ASSERT_FALSE(svr.is_running());
  15998. ASSERT_TRUE(handled);
  15999. });
  16000. svr.wait_until_ready();
  16001. UploadFormDataItems items;
  16002. items.reserve(kItemCount);
  16003. for (size_t i = 0; i < kItemCount; i++) {
  16004. items.push_back(
  16005. {"field" + std::to_string(i), "value" + std::to_string(i), "", ""});
  16006. }
  16007. Client cli(HOST, port);
  16008. auto res = cli.Post("/upload", items);
  16009. ASSERT_TRUE(res) << "Error: " << to_string(res.error());
  16010. EXPECT_EQ(StatusCode::OK_200, res->status);
  16011. }
  16012. TEST(MultipartFormDataTest, MakeFileProvider) {
  16013. // Verify make_file_provider sends a file's contents correctly.
  16014. const std::string file_content(4096, 'Z');
  16015. const std::string tmp_path = "./httplib_test_make_file_provider.bin";
  16016. {
  16017. std::ofstream ofs(tmp_path, std::ios::binary);
  16018. ofs.write(file_content.data(),
  16019. static_cast<std::streamsize>(file_content.size()));
  16020. }
  16021. auto handled = false;
  16022. Server svr;
  16023. svr.Post("/upload", [&](const Request &req, Response & /*res*/,
  16024. const ContentReader &content_reader) {
  16025. ASSERT_TRUE(req.is_multipart_form_data());
  16026. std::vector<FormData> items;
  16027. content_reader(
  16028. [&](const FormData &file) {
  16029. items.push_back(file);
  16030. return true;
  16031. },
  16032. [&](const char *data, size_t data_length) {
  16033. items.back().content.append(data, data_length);
  16034. return true;
  16035. });
  16036. ASSERT_EQ(1u, items.size());
  16037. EXPECT_EQ("myfile", items[0].name);
  16038. EXPECT_EQ("data.bin", items[0].filename);
  16039. EXPECT_EQ("application/octet-stream", items[0].content_type);
  16040. EXPECT_EQ(file_content, items[0].content);
  16041. handled = true;
  16042. });
  16043. auto port = svr.bind_to_any_port(HOST);
  16044. auto t = thread([&] { svr.listen_after_bind(); });
  16045. auto se = detail::scope_exit([&] {
  16046. svr.stop();
  16047. t.join();
  16048. ASSERT_FALSE(svr.is_running());
  16049. ASSERT_TRUE(handled);
  16050. std::remove(tmp_path.c_str());
  16051. });
  16052. svr.wait_until_ready();
  16053. FormDataProviderItems providers;
  16054. providers.push_back(make_file_provider("myfile", tmp_path, "data.bin",
  16055. "application/octet-stream"));
  16056. Client cli(HOST, port);
  16057. auto res = cli.Post("/upload", {}, {}, providers);
  16058. ASSERT_TRUE(res) << "Error: " << to_string(res.error());
  16059. EXPECT_EQ(StatusCode::OK_200, res->status);
  16060. }
  16061. TEST(MultipartFormDataTest, ExcessivePartHeaders) {
  16062. // Verify that a multipart part with more than CPPHTTPLIB_HEADER_MAX_COUNT
  16063. // (100) headers is rejected with a 400 Bad Request response.
  16064. Server svr;
  16065. svr.Post("/post", [&](const Request & /*req*/, Response &res) {
  16066. res.set_content("ok", "text/plain");
  16067. });
  16068. thread t = thread([&] { svr.listen(HOST, PORT); });
  16069. auto se = detail::scope_exit([&] {
  16070. svr.stop();
  16071. t.join();
  16072. ASSERT_FALSE(svr.is_running());
  16073. });
  16074. svr.wait_until_ready();
  16075. // Build a multipart part with 101 custom headers (exceeding
  16076. // CPPHTTPLIB_HEADER_MAX_COUNT=100)
  16077. std::stringstream body;
  16078. body << "--simpleboundary\r\n"
  16079. << "Content-Disposition: form-data; name=\"field1\"\r\n";
  16080. for (int i = 0; i < 101; i++) {
  16081. body << "X-Custom-Header-" << i << ": value\r\n";
  16082. }
  16083. body << "\r\n"
  16084. << "value1\r\n"
  16085. << "--simpleboundary--\r\n";
  16086. std::string content_type = "multipart/form-data; boundary=simpleboundary";
  16087. Client cli(HOST, PORT);
  16088. auto res = cli.Post("/post", body.str(), content_type.c_str());
  16089. ASSERT_TRUE(res) << "Error: " << to_string(res.error());
  16090. EXPECT_EQ(StatusCode::BadRequest_400, res->status);
  16091. }
  16092. TEST(MultipartFormDataTest, NoInitialBoundaryParsingIsNotQuadratic) {
  16093. // A body that never contains the declared boundary must not be accumulated
  16094. // while the parser waits for it. Buffering it would also make every read
  16095. // rescan everything seen so far, which is quadratic in the body size.
  16096. Server svr;
  16097. svr.Post("/post", [](const Request & /*req*/, Response &res) {
  16098. res.set_content("ok", "text/plain");
  16099. });
  16100. auto port = svr.bind_to_any_port(HOST);
  16101. thread t = thread([&] { svr.listen_after_bind(); });
  16102. auto se = detail::scope_exit([&] {
  16103. svr.stop();
  16104. t.join();
  16105. ASSERT_FALSE(svr.is_running());
  16106. });
  16107. svr.wait_until_ready();
  16108. Client cli(HOST, port);
  16109. cli.set_read_timeout(60, 0);
  16110. cli.set_write_timeout(60, 0);
  16111. // '-' is the worst case: it matches the first character of the boundary, so
  16112. // every position has to be checked against it.
  16113. auto post_dashes = [&](size_t size) {
  16114. const std::string body(size, '-');
  16115. auto start = std::chrono::steady_clock::now();
  16116. auto res =
  16117. cli.Post("/post", body, "multipart/form-data; boundary=simpleboundary");
  16118. auto ms = std::chrono::duration_cast<std::chrono::milliseconds>(
  16119. std::chrono::steady_clock::now() - start)
  16120. .count();
  16121. EXPECT_TRUE(res) << "Error: " << to_string(res.error());
  16122. if (res) { EXPECT_EQ(StatusCode::BadRequest_400, res->status); }
  16123. return ms;
  16124. };
  16125. // Not named `small`/`large`: <rpcndr.h> defines `small` as a macro on
  16126. // Windows.
  16127. auto ms_4mb = post_dashes(4u * 1024 * 1024);
  16128. auto ms_16mb = post_dashes(16u * 1024 * 1024);
  16129. // Comparing the two sizes rather than checking an absolute duration keeps
  16130. // this meaningful across build types and CI load, both of which move the
  16131. // absolute numbers by more than an order of magnitude. Four times the bytes
  16132. // costs about four times the time when parsing is linear, and about sixteen
  16133. // times when the body is buffered and rescanned.
  16134. ASSERT_GT(ms_4mb, 0) << "timer resolution too coarse to compare";
  16135. EXPECT_LT(ms_16mb, ms_4mb * 10)
  16136. << "4MB took " << ms_4mb << "ms but 16MB took " << ms_16mb
  16137. << "ms, which suggests the body is being buffered and rescanned";
  16138. }
  16139. TEST(MultipartFormDataTest, BoundaryNotFollowedByDelimiterFailsFast) {
  16140. // A boundary can only be followed by CRLF or by "--", so anything else is
  16141. // malformed no matter what comes next. The parser must say so right away
  16142. // instead of buffering the rest of the declared body.
  16143. Server svr;
  16144. svr.Post("/post", [](const Request & /*req*/, Response &res) {
  16145. res.set_content("ok", "text/plain");
  16146. });
  16147. auto port = svr.bind_to_any_port(HOST);
  16148. thread t = thread([&] { svr.listen_after_bind(); });
  16149. auto se = detail::scope_exit([&] {
  16150. svr.stop();
  16151. t.join();
  16152. ASSERT_FALSE(svr.is_running());
  16153. });
  16154. svr.wait_until_ready();
  16155. // Announce a 1 MB body but send only the malformed prefix. A parser that
  16156. // buffers instead of failing would still be waiting for the remaining bytes.
  16157. const std::string body = "--zzzz\r\n"
  16158. "Content-Disposition: form-data; name=\"text1\"\r\n"
  16159. "\r\n"
  16160. "text1"
  16161. "\r\n--zzzzXX";
  16162. const std::string req = "POST /post HTTP/1.1\r\n"
  16163. "Content-Type: multipart/form-data; boundary=zzzz\r\n"
  16164. "Content-Length: 1048576\r\n"
  16165. "\r\n" +
  16166. body;
  16167. std::string response;
  16168. ASSERT_TRUE(send_request(3, req, &response, port));
  16169. ASSERT_GE(response.size(), 12u) << "no response before the read timeout";
  16170. EXPECT_EQ("400", response.substr(9, 3));
  16171. }
  16172. // Posts a multipart body split into two writes, so that the server sees the
  16173. // split at whatever offset the caller chose, and expects the single "text1"
  16174. // field to come through.
  16175. static void expect_split_multipart_ok(const std::string &body1,
  16176. const std::string &body2) {
  16177. auto handled = false;
  16178. Server svr;
  16179. svr.Post("/post", [&](const Request &req, Response &) {
  16180. EXPECT_EQ(1u, req.form.fields.size());
  16181. EXPECT_EQ("text1", req.form.get_field("text1"));
  16182. handled = true;
  16183. });
  16184. auto port = svr.bind_to_any_port(HOST);
  16185. thread t = thread([&] { svr.listen_after_bind(); });
  16186. auto se = detail::scope_exit([&] {
  16187. svr.stop();
  16188. t.join();
  16189. ASSERT_FALSE(svr.is_running());
  16190. ASSERT_TRUE(handled);
  16191. });
  16192. svr.wait_until_ready();
  16193. // "Connection: close" makes the server close once it has answered, so the
  16194. // response drain ends immediately instead of idling until the read timeout.
  16195. const std::string head =
  16196. "POST /post HTTP/1.1\r\n"
  16197. "Host: localhost\r\n"
  16198. "Content-Type: multipart/form-data; boundary=zzzz\r\n"
  16199. "Connection: close\r\n"
  16200. "Content-Length: " +
  16201. std::to_string(body1.size() + body2.size()) + "\r\n\r\n";
  16202. std::string response;
  16203. ASSERT_TRUE(send_request_in_parts(3, {head + body1, body2}, &response, port));
  16204. ASSERT_GE(response.size(), 12u) << "no response";
  16205. EXPECT_EQ("200", response.substr(9, 3));
  16206. }
  16207. TEST(MultipartFormDataTest, EpilogueSplitAcrossReadsIsIgnored) {
  16208. // RFC 2046: everything after the close-delimiter is an epilogue and is to be
  16209. // ignored, including when it does not arrive in the same read as the
  16210. // close-delimiter itself.
  16211. expect_split_multipart_ok("--zzzz\r\n"
  16212. "Content-Disposition: form-data; name=\"text1\"\r\n"
  16213. "\r\n"
  16214. "text1"
  16215. "\r\n--zzzz--",
  16216. "\r\nthis epilogue must be ignored\r\n");
  16217. }
  16218. TEST(MultipartFormDataTest, InitialBoundarySplitAfterLongPreamble) {
  16219. // The initial boundary may be preceded by a preamble of any length and may
  16220. // straddle a read boundary. Discarding data while waiting for it must not
  16221. // throw away a partial boundary sitting at the end of the buffer.
  16222. expect_split_multipart_ok(std::string(64u * 1024, 'p') + "--zz",
  16223. "zz\r\n"
  16224. "Content-Disposition: form-data; name=\"text1\"\r\n"
  16225. "\r\n"
  16226. "text1"
  16227. "\r\n--zzzz--\r\n");
  16228. }
  16229. TEST(MultipartFormDataTest, BoundaryLengthLimitIsEnforced) {
  16230. // The received boundary was only checked for being non-empty, so it could be
  16231. // as long as a header is allowed to be. The parser scans the body for
  16232. // "--" + boundary, so a body crafted to repeat that delimiter's leading bytes
  16233. // costs a nearly full comparison at nearly every position, making the
  16234. // boundary's length a multiplier on the worst-case parsing cost. RFC 2046
  16235. // 5.1.1 caps a boundary at 70 characters; honoring that caps the multiplier.
  16236. Server svr;
  16237. svr.Post("/post", [](const Request &req, Response &res) {
  16238. EXPECT_EQ(1u, req.form.fields.size());
  16239. EXPECT_EQ("text1", req.form.get_field("text1"));
  16240. res.set_content("ok", "text/plain");
  16241. });
  16242. auto port = svr.bind_to_any_port(HOST);
  16243. thread t = thread([&] { svr.listen_after_bind(); });
  16244. auto se = detail::scope_exit([&] {
  16245. svr.stop();
  16246. t.join();
  16247. ASSERT_FALSE(svr.is_running());
  16248. });
  16249. svr.wait_until_ready();
  16250. Client cli(HOST, port);
  16251. auto post_with_boundary_of_length = [&](size_t len) {
  16252. const std::string boundary(len, 'a');
  16253. const std::string body =
  16254. "--" + boundary +
  16255. "\r\n"
  16256. "Content-Disposition: form-data; name=\"text1\"\r\n"
  16257. "\r\n"
  16258. "text1"
  16259. "\r\n--" +
  16260. boundary + "--\r\n";
  16261. return cli.Post("/post", body, "multipart/form-data; boundary=" + boundary);
  16262. };
  16263. auto res = post_with_boundary_of_length(70);
  16264. ASSERT_TRUE(res) << "Error: " << to_string(res.error());
  16265. EXPECT_EQ(StatusCode::OK_200, res->status);
  16266. res = post_with_boundary_of_length(71);
  16267. ASSERT_TRUE(res) << "Error: " << to_string(res.error());
  16268. EXPECT_EQ(StatusCode::BadRequest_400, res->status);
  16269. }
  16270. TEST(MakeFileBodyTest, Basic) {
  16271. const std::string file_content(4096, 'Z');
  16272. const std::string tmp_path = "./httplib_test_make_file_body.bin";
  16273. {
  16274. std::ofstream ofs(tmp_path, std::ios::binary);
  16275. ofs.write(file_content.data(),
  16276. static_cast<std::streamsize>(file_content.size()));
  16277. }
  16278. auto handled = false;
  16279. Server svr;
  16280. svr.Post("/upload", [&](const Request &req, Response &res) {
  16281. EXPECT_EQ(file_content, req.body);
  16282. handled = true;
  16283. res.status = StatusCode::OK_200;
  16284. });
  16285. auto port = svr.bind_to_any_port(HOST);
  16286. auto t = thread([&] { svr.listen_after_bind(); });
  16287. auto se = detail::scope_exit([&] {
  16288. svr.stop();
  16289. t.join();
  16290. ASSERT_FALSE(svr.is_running());
  16291. ASSERT_TRUE(handled);
  16292. std::remove(tmp_path.c_str());
  16293. });
  16294. svr.wait_until_ready();
  16295. auto fb = make_file_body(tmp_path);
  16296. ASSERT_GT(fb.first, 0u);
  16297. Client cli(HOST, port);
  16298. auto res =
  16299. cli.Post("/upload", fb.first, fb.second, "application/octet-stream");
  16300. ASSERT_TRUE(res) << "Error: " << to_string(res.error());
  16301. EXPECT_EQ(StatusCode::OK_200, res->status);
  16302. }
  16303. TEST(MakeFileBodyTest, TruncatedFileMakesTheProviderFail) {
  16304. const std::string path = "./httplib_test_make_file_body_truncated.bin";
  16305. {
  16306. std::ofstream ofs(path, std::ios::binary);
  16307. const std::string content(100, 'A');
  16308. ofs.write(content.data(), static_cast<std::streamsize>(content.size()));
  16309. }
  16310. auto cleanup = detail::scope_exit([&] { std::remove(path.c_str()); });
  16311. auto body = make_file_body(path);
  16312. ASSERT_EQ(100u, body.first);
  16313. ASSERT_TRUE(static_cast<bool>(body.second));
  16314. // Rewritten shorter after its length was measured - and, on a server, after
  16315. // that length has already gone out as Content-Length.
  16316. {
  16317. std::ofstream ofs(path, std::ios::binary | std::ios::trunc);
  16318. const std::string content(10, 'A');
  16319. ofs.write(content.data(), static_cast<std::streamsize>(content.size()));
  16320. }
  16321. std::string written;
  16322. DataSink sink;
  16323. sink.write = [&](const char *d, size_t l) {
  16324. written.append(d, l);
  16325. return true;
  16326. };
  16327. // The provider has to report failure. write_content_with_progress() advances
  16328. // its offset only by what was written, so a provider that returns true
  16329. // without completing the length it promised is called again straight away,
  16330. // and again.
  16331. EXPECT_FALSE(body.second(0, body.first, sink));
  16332. EXPECT_EQ(std::string(10, 'A'), written);
  16333. }
  16334. TEST(MakeFileBodyTest, WholeFileIsSent) {
  16335. const std::string path = "./httplib_test_make_file_body_whole.bin";
  16336. const std::string content(9000, 'Z'); // spans more than one 8 KiB read
  16337. {
  16338. std::ofstream ofs(path, std::ios::binary);
  16339. ofs.write(content.data(), static_cast<std::streamsize>(content.size()));
  16340. }
  16341. auto cleanup = detail::scope_exit([&] { std::remove(path.c_str()); });
  16342. auto body = make_file_body(path);
  16343. ASSERT_EQ(content.size(), body.first);
  16344. ASSERT_TRUE(static_cast<bool>(body.second));
  16345. std::string written;
  16346. DataSink sink;
  16347. sink.write = [&](const char *d, size_t l) {
  16348. written.append(d, l);
  16349. return true;
  16350. };
  16351. EXPECT_TRUE(body.second(0, body.first, sink));
  16352. EXPECT_EQ(content, written);
  16353. }
  16354. TEST(TaskQueueTest, IncreaseAtomicInteger) {
  16355. static constexpr unsigned int number_of_tasks{1000000};
  16356. std::atomic_uint count{0};
  16357. std::unique_ptr<TaskQueue> task_queue{
  16358. new ThreadPool{CPPHTTPLIB_THREAD_POOL_COUNT}};
  16359. for (unsigned int i = 0; i < number_of_tasks; ++i) {
  16360. auto queued = task_queue->enqueue(
  16361. [&count] { count.fetch_add(1, std::memory_order_relaxed); });
  16362. EXPECT_TRUE(queued);
  16363. }
  16364. #ifdef CPPHTTPLIB_NO_EXCEPTIONS
  16365. task_queue->shutdown();
  16366. #else
  16367. EXPECT_NO_THROW(task_queue->shutdown());
  16368. #endif
  16369. EXPECT_EQ(number_of_tasks, count.load());
  16370. }
  16371. TEST(TaskQueueTest, IncreaseAtomicIntegerWithQueueLimit) {
  16372. static constexpr unsigned int number_of_tasks{1000000};
  16373. static constexpr unsigned int qlimit{2};
  16374. unsigned int queued_count{0};
  16375. std::atomic_uint count{0};
  16376. std::unique_ptr<TaskQueue> task_queue{
  16377. new ThreadPool{/*num_threads=*/1, /*max_threads=*/1, qlimit}};
  16378. for (unsigned int i = 0; i < number_of_tasks; ++i) {
  16379. if (task_queue->enqueue(
  16380. [&count] { count.fetch_add(1, std::memory_order_relaxed); })) {
  16381. queued_count++;
  16382. }
  16383. }
  16384. #ifdef CPPHTTPLIB_NO_EXCEPTIONS
  16385. task_queue->shutdown();
  16386. #else
  16387. EXPECT_NO_THROW(task_queue->shutdown());
  16388. #endif
  16389. EXPECT_EQ(queued_count, count.load());
  16390. EXPECT_TRUE(queued_count <= number_of_tasks);
  16391. EXPECT_TRUE(queued_count >= qlimit);
  16392. }
  16393. TEST(TaskQueueTest, IdleTimeoutAtRuntime) {
  16394. // Use a short idle timeout so a dynamic thread spawns, times out and
  16395. // exits during the test, and the pool keeps working afterwards.
  16396. std::unique_ptr<TaskQueue> task_queue{new ThreadPool{
  16397. /*num_threads=*/1, /*max_threads=*/2, /*max_queued_requests=*/0,
  16398. /*idle_timeout_sec=*/1}};
  16399. std::atomic_uint count{0};
  16400. std::condition_variable cv;
  16401. std::mutex mtx;
  16402. bool release = false;
  16403. // Block the base thread so the second task spawns a dynamic thread.
  16404. EXPECT_TRUE(task_queue->enqueue([&] {
  16405. std::unique_lock<std::mutex> lock(mtx);
  16406. while (!release) {
  16407. cv.wait(lock);
  16408. }
  16409. count++;
  16410. }));
  16411. EXPECT_TRUE(task_queue->enqueue([&] { count++; }));
  16412. // Let the dynamic thread finish its task and exceed the idle timeout.
  16413. std::this_thread::sleep_for(std::chrono::milliseconds(1500));
  16414. {
  16415. std::unique_lock<std::mutex> lock(mtx);
  16416. release = true;
  16417. }
  16418. cv.notify_all();
  16419. // The pool must still accept and run tasks after the dynamic thread exited.
  16420. EXPECT_TRUE(task_queue->enqueue([&] { count++; }));
  16421. task_queue->shutdown();
  16422. EXPECT_EQ(3u, count.load());
  16423. }
  16424. TEST(TaskQueueTest, MaxQueuedRequests) {
  16425. static constexpr unsigned int qlimit{3};
  16426. std::unique_ptr<TaskQueue> task_queue{new ThreadPool{1, 1, qlimit}};
  16427. std::condition_variable sem_cv;
  16428. std::mutex sem_mtx;
  16429. int credits = 0;
  16430. bool queued;
  16431. /* Fill up the queue with tasks that will block until we give them credits to
  16432. * complete. */
  16433. for (unsigned int n = 0; n <= qlimit;) {
  16434. queued = task_queue->enqueue([&sem_mtx, &sem_cv, &credits] {
  16435. std::unique_lock<std::mutex> lock(sem_mtx);
  16436. while (credits <= 0) {
  16437. sem_cv.wait(lock);
  16438. }
  16439. /* Consume the credit and signal the test code if they are all gone. */
  16440. if (--credits == 0) { sem_cv.notify_one(); }
  16441. });
  16442. if (n < qlimit) {
  16443. /* The first qlimit enqueues must succeed. */
  16444. EXPECT_TRUE(queued);
  16445. } else {
  16446. /* The last one will succeed only when the worker thread
  16447. * starts and dequeues the first blocking task. Although
  16448. * not necessary for the correctness of this test, we sleep for
  16449. * a short while to avoid busy waiting. */
  16450. std::this_thread::sleep_for(std::chrono::milliseconds(10));
  16451. }
  16452. if (queued) { n++; }
  16453. }
  16454. /* Further enqueues must fail since the queue is full. */
  16455. for (auto i = 0; i < 4; i++) {
  16456. queued = task_queue->enqueue([] {});
  16457. EXPECT_FALSE(queued);
  16458. }
  16459. /* Give the credits to allow the previous tasks to complete. */
  16460. {
  16461. std::unique_lock<std::mutex> lock(sem_mtx);
  16462. credits += qlimit + 1;
  16463. }
  16464. sem_cv.notify_all();
  16465. /* Wait for all the credits to be consumed. */
  16466. {
  16467. std::unique_lock<std::mutex> lock(sem_mtx);
  16468. while (credits > 0) {
  16469. sem_cv.wait(lock);
  16470. }
  16471. }
  16472. /* Check that we are able again to enqueue at least qlimit tasks. */
  16473. for (unsigned int i = 0; i < qlimit; i++) {
  16474. queued = task_queue->enqueue([] {});
  16475. EXPECT_TRUE(queued);
  16476. }
  16477. #ifdef CPPHTTPLIB_NO_EXCEPTIONS
  16478. task_queue->shutdown();
  16479. #else
  16480. EXPECT_NO_THROW(task_queue->shutdown());
  16481. #endif
  16482. }
  16483. TEST(RedirectTest, SeeOtherDoesNotResendContentProviderBody) {
  16484. Server svr;
  16485. std::string method;
  16486. std::string body;
  16487. auto has_content_length = false;
  16488. auto has_transfer_encoding = false;
  16489. std::atomic<int> bad_requests{0};
  16490. // Leftover body bytes get parsed as a malformed request and answered with
  16491. // 400
  16492. svr.set_logger([&](const Request & /*req*/, const Response &res) {
  16493. if (res.status == StatusCode::BadRequest_400) { bad_requests++; }
  16494. });
  16495. svr.Post("/up", [](const Request & /*req*/, Response &res) {
  16496. res.set_redirect("/down", StatusCode::SeeOther_303);
  16497. });
  16498. svr.Get("/down", [&](const Request &req, Response &res) {
  16499. method = req.method;
  16500. body = req.body;
  16501. has_content_length = req.has_header("Content-Length");
  16502. has_transfer_encoding = req.has_header("Transfer-Encoding");
  16503. res.set_content("ok", "text/plain");
  16504. });
  16505. auto port = svr.bind_to_any_port(HOST);
  16506. auto thread = std::thread([&]() { svr.listen_after_bind(); });
  16507. auto se = detail::scope_exit([&] {
  16508. svr.stop();
  16509. thread.join();
  16510. ASSERT_FALSE(svr.is_running());
  16511. });
  16512. svr.wait_until_ready();
  16513. const std::string payload = "SECRET-BODY";
  16514. auto check = [&](Client &cli, const Result &res) {
  16515. ASSERT_TRUE(res) << "Error: " << to_string(res.error());
  16516. EXPECT_EQ(StatusCode::OK_200, res->status);
  16517. EXPECT_EQ("ok", res->body);
  16518. EXPECT_EQ("GET", method);
  16519. EXPECT_TRUE(body.empty());
  16520. EXPECT_FALSE(has_content_length);
  16521. EXPECT_FALSE(has_transfer_encoding);
  16522. // Nothing of the original body may be left on the connection
  16523. auto res2 = cli.Get("/down");
  16524. ASSERT_TRUE(res2) << "Error: " << to_string(res2.error());
  16525. EXPECT_EQ(StatusCode::OK_200, res2->status);
  16526. EXPECT_EQ("ok", res2->body);
  16527. EXPECT_EQ(0, bad_requests);
  16528. };
  16529. // With content length
  16530. {
  16531. Client cli(HOST, port);
  16532. cli.set_keep_alive(true);
  16533. cli.set_follow_location(true);
  16534. auto res = cli.Post(
  16535. "/up", payload.size(),
  16536. [&](size_t offset, size_t length, DataSink &sink) {
  16537. return sink.write(payload.data() + offset, length);
  16538. },
  16539. "text/plain");
  16540. check(cli, res);
  16541. }
  16542. // Without content length (chunked)
  16543. {
  16544. Client cli(HOST, port);
  16545. cli.set_keep_alive(true);
  16546. cli.set_follow_location(true);
  16547. auto res = cli.Post(
  16548. "/up",
  16549. [&](size_t /*offset*/, DataSink &sink) {
  16550. sink.write(payload.data(), payload.size());
  16551. sink.done();
  16552. return true;
  16553. },
  16554. "text/plain");
  16555. check(cli, res);
  16556. }
  16557. }
  16558. TEST(RedirectTest, LocationPathIsNotDecoded) {
  16559. Server svr;
  16560. std::string target;
  16561. svr.Get(R"(/start/.*)", [](const Request &req, Response &res) {
  16562. // Echo the still-encoded name back in the Location
  16563. const std::string prefix = "/start/";
  16564. res.status = StatusCode::Found_302;
  16565. res.set_header("Location", "/dest/" + req.target.substr(prefix.size()));
  16566. });
  16567. svr.Get(R"(/dest.*)", [&](const Request &req, Response &res) {
  16568. target = req.target;
  16569. res.set_content("ok", "text/plain");
  16570. });
  16571. auto port = svr.bind_to_any_port(HOST);
  16572. auto thread = std::thread([&]() { svr.listen_after_bind(); });
  16573. auto se = detail::scope_exit([&] {
  16574. svr.stop();
  16575. thread.join();
  16576. ASSERT_FALSE(svr.is_running());
  16577. });
  16578. svr.wait_until_ready();
  16579. // Decoding the Location path would turn the first four into a path
  16580. // separator, a query delimiter, a fragment delimiter and a different
  16581. // percent-encoded octet. The rest must keep reaching the server as they are.
  16582. const std::vector<std::string> names = {
  16583. "a%2Fb", "x%3Fy", "x%23y", "a%2520b", "a%20b", "%C3%BC", "a-b_c.d~e",
  16584. };
  16585. for (auto path_encode : {true, false}) {
  16586. Client cli(HOST, port);
  16587. cli.set_follow_location(true);
  16588. cli.set_path_encode(path_encode);
  16589. for (const auto &name : names) {
  16590. target.clear();
  16591. auto res = cli.Get("/start/" + name);
  16592. ASSERT_TRUE(res) << "Error: " << to_string(res.error());
  16593. EXPECT_EQ(StatusCode::OK_200, res->status);
  16594. EXPECT_EQ("/dest/" + name, target);
  16595. }
  16596. }
  16597. }
  16598. TEST(RedirectTest, RedirectToUrlWithQueryParameters) {
  16599. Server svr;
  16600. svr.Get("/", [](const Request & /*req*/, Response &res) {
  16601. res.set_redirect(R"(/hello?key=val%26key2%3Dval2)");
  16602. });
  16603. svr.Get("/hello", [](const Request &req, Response &res) {
  16604. res.set_content(req.get_param_value("key"), "text/plain");
  16605. });
  16606. auto thread = std::thread([&]() { svr.listen(HOST, PORT); });
  16607. auto se = detail::scope_exit([&] {
  16608. svr.stop();
  16609. thread.join();
  16610. ASSERT_FALSE(svr.is_running());
  16611. });
  16612. svr.wait_until_ready();
  16613. {
  16614. Client cli(HOST, PORT);
  16615. cli.set_follow_location(true);
  16616. auto res = cli.Get("/");
  16617. ASSERT_TRUE(res) << "Error: " << to_string(res.error());
  16618. EXPECT_EQ(StatusCode::OK_200, res->status);
  16619. EXPECT_EQ("val&key2=val2", res->body);
  16620. }
  16621. }
  16622. #endif
  16623. TEST(RedirectTest, RedirectToUrlWithPlusInQueryParameters) {
  16624. Server svr;
  16625. svr.Get("/", [](const Request & /*req*/, Response &res) {
  16626. res.set_redirect(R"(/hello?key=AByz09+~-._%20%26%3F%C3%BC%2B)");
  16627. });
  16628. svr.Get("/hello", [](const Request &req, Response &res) {
  16629. res.set_content(req.get_param_value("key"), "text/plain");
  16630. });
  16631. auto thread = std::thread([&]() { svr.listen(HOST, PORT); });
  16632. auto se = detail::scope_exit([&] {
  16633. svr.stop();
  16634. thread.join();
  16635. ASSERT_FALSE(svr.is_running());
  16636. });
  16637. svr.wait_until_ready();
  16638. {
  16639. Client cli(HOST, PORT);
  16640. cli.set_follow_location(true);
  16641. auto res = cli.Get("/");
  16642. ASSERT_TRUE(res) << "Error: " << to_string(res.error());
  16643. EXPECT_EQ(StatusCode::OK_200, res->status);
  16644. EXPECT_EQ("AByz09 ~-._ &?ü+", res->body);
  16645. }
  16646. }
  16647. TEST(RedirectTest, RedirectWithPlusInPath) {
  16648. Server svr;
  16649. svr.Get("/", [](const Request & /*req*/, Response &res) {
  16650. res.set_redirect("/a+b");
  16651. });
  16652. // Route pattern uses regex; escape + as \\+
  16653. svr.Get(R"(/a\+b)", [](const Request &req, Response &res) {
  16654. res.set_content(req.path, "text/plain");
  16655. });
  16656. auto thread = std::thread([&]() { svr.listen(HOST, PORT); });
  16657. auto se = detail::scope_exit([&] {
  16658. svr.stop();
  16659. thread.join();
  16660. ASSERT_FALSE(svr.is_running());
  16661. });
  16662. svr.wait_until_ready();
  16663. {
  16664. Client cli(HOST, PORT);
  16665. cli.set_follow_location(true);
  16666. auto res = cli.Get("/");
  16667. ASSERT_TRUE(res) << "Error: " << to_string(res.error());
  16668. EXPECT_EQ(StatusCode::OK_200, res->status);
  16669. EXPECT_EQ("/a+b", res->body);
  16670. }
  16671. }
  16672. TEST(RedirectTest, ResolveRelativeLocation) {
  16673. // Examples from RFC 3986 section 5.4, base "http://a/b/c/d;p?q".
  16674. const std::vector<std::pair<std::string, std::string>> cases = {
  16675. {"g", "/b/c/g"},
  16676. {"./g", "/b/c/g"},
  16677. {"g/", "/b/c/g/"},
  16678. {"?y", "/b/c/d;p?y"},
  16679. {"g?y", "/b/c/g?y"},
  16680. {"#s", "/b/c/d;p?q#s"},
  16681. {"g#s", "/b/c/g#s"},
  16682. {"g?y#s", "/b/c/g?y#s"},
  16683. {";x", "/b/c/;x"},
  16684. {"g;x", "/b/c/g;x"},
  16685. {".", "/b/c/"},
  16686. {"./", "/b/c/"},
  16687. {"..", "/b/"},
  16688. {"../", "/b/"},
  16689. {"../g", "/b/g"},
  16690. {"../..", "/"},
  16691. {"../../", "/"},
  16692. {"../../g", "/g"},
  16693. {"../../../g", "/g"},
  16694. {"g.", "/b/c/g."},
  16695. {".g", "/b/c/.g"},
  16696. {"g..", "/b/c/g.."},
  16697. {"..g", "/b/c/..g"},
  16698. {"./../g", "/b/g"},
  16699. {"./g/.", "/b/c/g/"},
  16700. {"g/./h", "/b/c/g/h"},
  16701. {"g/../h", "/b/c/h"},
  16702. {"g;x=1/./y", "/b/c/g;x=1/y"},
  16703. {"g;x=1/../y", "/b/c/y"},
  16704. {"g?y/./x", "/b/c/g?y/./x"},
  16705. {"g#s/../x", "/b/c/g#s/../x"},
  16706. // Not relative-path references, so left for parse_url.
  16707. {"/g", "/g"},
  16708. {"//g", "//g"},
  16709. {"http://g/x", "http://g/x"},
  16710. {"g:h", "g:h"},
  16711. };
  16712. for (const auto &c : cases) {
  16713. EXPECT_EQ(c.second,
  16714. detail::resolve_relative_location(c.first, "/b/c/d;p?q"))
  16715. << c.first;
  16716. }
  16717. }
  16718. TEST(RedirectTest, RelativeLocationWithoutLeadingSlash) {
  16719. Server svr;
  16720. svr.Get("/dir/page", [](const Request &req, Response &res) {
  16721. res.set_redirect(req.get_param_value("to"));
  16722. });
  16723. svr.Get("/dir/next", [](const Request &req, Response &res) {
  16724. res.set_content(req.target, "text/plain");
  16725. });
  16726. svr.Get("/other", [](const Request &req, Response &res) {
  16727. res.set_content(req.target, "text/plain");
  16728. });
  16729. auto thread = std::thread([&]() { svr.listen(HOST, PORT); });
  16730. auto se = detail::scope_exit([&] {
  16731. svr.stop();
  16732. thread.join();
  16733. ASSERT_FALSE(svr.is_running());
  16734. });
  16735. svr.wait_until_ready();
  16736. const std::vector<std::pair<std::string, std::string>> cases = {
  16737. {"next", "/dir/next"},
  16738. {"./next?x=1", "/dir/next?x=1"},
  16739. {"../other", "/other"},
  16740. };
  16741. for (const auto &c : cases) {
  16742. Client cli(HOST, PORT);
  16743. cli.set_follow_location(true);
  16744. auto res = cli.Get("/dir/page?to=" + encode_query_component(c.first));
  16745. ASSERT_TRUE(res) << c.first << ": " << to_string(res.error());
  16746. EXPECT_EQ(StatusCode::OK_200, res->status) << c.first;
  16747. EXPECT_EQ(c.second, res->body) << c.first;
  16748. }
  16749. }
  16750. #ifdef CPPHTTPLIB_SSL_ENABLED
  16751. TEST(RedirectTest, Issue2185_Online) {
  16752. SSLClient client("github.com");
  16753. client.set_follow_location(true);
  16754. auto res = client.Get("/Coollab-Art/Coollab/releases/download/1.1.1_UI-Scale/"
  16755. "Coollab-Windows.zip");
  16756. ASSERT_TRUE(res) << "Error: " << to_string(res.error());
  16757. EXPECT_EQ(StatusCode::OK_200, res->status);
  16758. EXPECT_EQ(9920427U, res->body.size());
  16759. }
  16760. #endif
  16761. TEST(VulnerabilityTest, CRLFInjection) {
  16762. Server svr;
  16763. svr.Post("/test1", [](const Request & /*req*/, Response &res) {
  16764. res.set_content("Hello 1", "text/plain");
  16765. });
  16766. svr.Delete("/test2", [](const Request & /*req*/, Response &res) {
  16767. res.set_content("Hello 2", "text/plain");
  16768. });
  16769. svr.Put("/test3", [](const Request & /*req*/, Response &res) {
  16770. res.set_content("Hello 3", "text/plain");
  16771. });
  16772. svr.Patch("/test4", [](const Request & /*req*/, Response &res) {
  16773. res.set_content("Hello 4", "text/plain");
  16774. });
  16775. svr.set_logger([](const Request &req, const Response & /*res*/) {
  16776. for (const auto &x : req.headers) {
  16777. auto key = x.first;
  16778. EXPECT_STRNE("evil", key.c_str());
  16779. }
  16780. });
  16781. auto thread = std::thread([&]() { svr.listen(HOST, PORT); });
  16782. auto se = detail::scope_exit([&] {
  16783. svr.stop();
  16784. thread.join();
  16785. ASSERT_FALSE(svr.is_running());
  16786. });
  16787. svr.wait_until_ready();
  16788. {
  16789. Client cli(HOST, PORT);
  16790. cli.Post("/test1", "A=B",
  16791. "application/x-www-form-urlencoded\r\nevil: hello1");
  16792. cli.Delete("/test2", "A=B", "text/plain\r\nevil: hello2");
  16793. cli.Put("/test3", "text", "text/plain\r\nevil: hello3");
  16794. cli.Patch("/test4", "content", "text/plain\r\nevil: hello4");
  16795. }
  16796. }
  16797. TEST(VulnerabilityTest, CRLFInjectionInHeaders) {
  16798. auto server_thread = std::thread([] {
  16799. auto srv = ::socket(AF_INET, SOCK_STREAM, 0);
  16800. default_socket_options(srv);
  16801. sockaddr_in addr{};
  16802. addr.sin_family = AF_INET;
  16803. addr.sin_port = htons(static_cast<uint16_t>(PORT + 1));
  16804. ::inet_pton(AF_INET, "127.0.0.1", &addr.sin_addr);
  16805. ::bind(srv, reinterpret_cast<sockaddr *>(&addr), sizeof(addr));
  16806. ::listen(srv, 1);
  16807. sockaddr_in cli_addr{};
  16808. socklen_t cli_len = sizeof(cli_addr);
  16809. auto cli = ::accept(srv, reinterpret_cast<sockaddr *>(&cli_addr), &cli_len);
  16810. detail::set_socket_opt_time(cli, SOL_SOCKET, SO_RCVTIMEO, 1, 0);
  16811. std::string buf_all;
  16812. char buf[2048];
  16813. ssize_t n;
  16814. while ((n = ::recv(cli, buf, sizeof(buf), 0)) > 0) {
  16815. buf_all.append(buf, static_cast<size_t>(n));
  16816. size_t pos;
  16817. while ((pos = buf_all.find("\r\n\r\n")) != std::string::npos) {
  16818. auto request_block = buf_all.substr(0, pos + 4); // include separator
  16819. auto e = request_block.find("\r\n");
  16820. if (e != std::string::npos) {
  16821. auto request_line = request_block.substr(0, e);
  16822. std::string msg =
  16823. "CRLF injection detected in request line: '" + request_line + "'";
  16824. EXPECT_FALSE(true) << msg;
  16825. }
  16826. std::string resp = "HTTP/1.1 200 OK\r\nContent-Length: 5\r\n\r\nHello";
  16827. ::send(cli,
  16828. #ifdef _WIN32
  16829. static_cast<const char *>(resp.c_str()),
  16830. static_cast<int>(resp.size()),
  16831. #else
  16832. resp.c_str(), resp.size(),
  16833. #endif
  16834. 0);
  16835. buf_all.erase(0, pos + 4);
  16836. }
  16837. }
  16838. detail::close_socket(cli);
  16839. detail::close_socket(srv);
  16840. });
  16841. std::this_thread::sleep_for(std::chrono::milliseconds(200));
  16842. auto cli = Client("127.0.0.1", PORT + 1);
  16843. auto headers = Headers{
  16844. {"A", "B\r\n\r\nGET /pwned HTTP/1.1\r\nHost: 127.0.0.1:1234\r\n\r\n"},
  16845. {"Connection", "keep-alive"}};
  16846. auto res = cli.Get("/hi", headers);
  16847. EXPECT_FALSE(res);
  16848. EXPECT_EQ(Error::InvalidHeaders, res.error());
  16849. server_thread.join();
  16850. }
  16851. // A request rejected before any byte reaches the socket must fail right away
  16852. // instead of waiting for a response the server will never send.
  16853. TEST(ClientRejectedRequestTest, DoesNotWaitForResponse) {
  16854. // The kernel completes the TCP handshake from the listen backlog, so the
  16855. // client connects, but nothing ever reads, responds or closes.
  16856. auto srv = ::socket(AF_INET, SOCK_STREAM, 0);
  16857. default_socket_options(srv);
  16858. sockaddr_in addr{};
  16859. addr.sin_family = AF_INET;
  16860. addr.sin_port = htons(static_cast<uint16_t>(PORT + 1));
  16861. ::inet_pton(AF_INET, "127.0.0.1", &addr.sin_addr);
  16862. ASSERT_EQ(0, ::bind(srv, reinterpret_cast<sockaddr *>(&addr), sizeof(addr)));
  16863. ASSERT_EQ(0, ::listen(srv, 8));
  16864. auto cli = Client("127.0.0.1", PORT + 1);
  16865. cli.set_read_timeout(10, 0);
  16866. auto elapsed_ms = [](std::chrono::steady_clock::time_point start) {
  16867. return std::chrono::duration_cast<std::chrono::milliseconds>(
  16868. std::chrono::steady_clock::now() - start)
  16869. .count();
  16870. };
  16871. {
  16872. Request req;
  16873. req.method = "GE T";
  16874. req.path = "/";
  16875. auto start = std::chrono::steady_clock::now();
  16876. auto res = cli.send(req);
  16877. EXPECT_FALSE(res);
  16878. EXPECT_EQ(Error::Write, res.error());
  16879. EXPECT_LT(elapsed_ms(start), 1000);
  16880. }
  16881. {
  16882. auto start = std::chrono::steady_clock::now();
  16883. auto res = cli.Get("/", Headers{{"A", "B\r\nEvil: 1"}});
  16884. EXPECT_FALSE(res);
  16885. EXPECT_EQ(Error::InvalidHeaders, res.error());
  16886. EXPECT_LT(elapsed_ms(start), 1000);
  16887. }
  16888. EXPECT_FALSE(cli.is_socket_open());
  16889. detail::close_socket(srv);
  16890. }
  16891. TEST(ClientRejectedRequestTest, OpenStreamSendsNothingOnInvalidHeader) {
  16892. auto srv = ::socket(AF_INET, SOCK_STREAM, 0);
  16893. default_socket_options(srv);
  16894. sockaddr_in addr{};
  16895. addr.sin_family = AF_INET;
  16896. addr.sin_port = htons(static_cast<uint16_t>(PORT + 1));
  16897. ::inet_pton(AF_INET, "127.0.0.1", &addr.sin_addr);
  16898. ASSERT_EQ(0, ::bind(srv, reinterpret_cast<sockaddr *>(&addr), sizeof(addr)));
  16899. ASSERT_EQ(0, ::listen(srv, 1));
  16900. std::string received;
  16901. auto server_thread = std::thread([&] {
  16902. auto sock = ::accept(srv, nullptr, nullptr);
  16903. if (sock == INVALID_SOCKET) { return; }
  16904. detail::set_socket_opt_time(sock, SOL_SOCKET, SO_RCVTIMEO, 2, 0);
  16905. char buf[2048];
  16906. ssize_t n;
  16907. while ((n = ::recv(sock, buf, sizeof(buf), 0)) > 0) {
  16908. received.append(buf, static_cast<size_t>(n));
  16909. }
  16910. detail::close_socket(sock);
  16911. });
  16912. {
  16913. auto cli = Client("127.0.0.1", PORT + 1);
  16914. // "Z" sorts after the default headers, so writing straight to the socket
  16915. // would have sent the request line and those headers before the rejection.
  16916. auto handle =
  16917. cli.open_stream("GET", "/", Params{}, Headers{{"Z", "B\r\nEvil: 1"}});
  16918. EXPECT_FALSE(handle.is_valid());
  16919. EXPECT_EQ(Error::InvalidHeaders, handle.error);
  16920. }
  16921. server_thread.join();
  16922. detail::close_socket(srv);
  16923. EXPECT_TRUE(received.empty()) << received;
  16924. }
  16925. TEST(PathParamsTest, StaticMatch) {
  16926. const auto pattern = "/users/all";
  16927. detail::PathParamsMatcher matcher(pattern);
  16928. Request request;
  16929. request.path = "/users/all";
  16930. ASSERT_TRUE(matcher.match(request));
  16931. std::unordered_map<std::string, std::string> expected_params = {};
  16932. EXPECT_EQ(request.path_params, expected_params);
  16933. }
  16934. TEST(PathParamsTest, StaticMismatch) {
  16935. const auto pattern = "/users/all";
  16936. detail::PathParamsMatcher matcher(pattern);
  16937. Request request;
  16938. request.path = "/users/1";
  16939. ASSERT_FALSE(matcher.match(request));
  16940. }
  16941. TEST(PathParamsTest, SingleParamInTheMiddle) {
  16942. const auto pattern = "/users/:id/subscriptions";
  16943. detail::PathParamsMatcher matcher(pattern);
  16944. Request request;
  16945. request.path = "/users/42/subscriptions";
  16946. ASSERT_TRUE(matcher.match(request));
  16947. std::unordered_map<std::string, std::string> expected_params = {{"id", "42"}};
  16948. EXPECT_EQ(request.path_params, expected_params);
  16949. }
  16950. TEST(PathParamsTest, SingleParamInTheEnd) {
  16951. const auto pattern = "/users/:id";
  16952. detail::PathParamsMatcher matcher(pattern);
  16953. Request request;
  16954. request.path = "/users/24";
  16955. ASSERT_TRUE(matcher.match(request));
  16956. std::unordered_map<std::string, std::string> expected_params = {{"id", "24"}};
  16957. EXPECT_EQ(request.path_params, expected_params);
  16958. }
  16959. TEST(PathParamsTest, SingleParamInTheEndTrailingSlash) {
  16960. const auto pattern = "/users/:id/";
  16961. detail::PathParamsMatcher matcher(pattern);
  16962. Request request;
  16963. request.path = "/users/42/";
  16964. ASSERT_TRUE(matcher.match(request));
  16965. std::unordered_map<std::string, std::string> expected_params = {{"id", "42"}};
  16966. EXPECT_EQ(request.path_params, expected_params);
  16967. }
  16968. TEST(PathParamsTest, EmptyParam) {
  16969. const auto pattern = "/users/:id/";
  16970. detail::PathParamsMatcher matcher(pattern);
  16971. Request request;
  16972. request.path = "/users//";
  16973. ASSERT_TRUE(matcher.match(request));
  16974. std::unordered_map<std::string, std::string> expected_params = {{"id", ""}};
  16975. EXPECT_EQ(request.path_params, expected_params);
  16976. }
  16977. TEST(PathParamsTest, FragmentMismatch) {
  16978. const auto pattern = "/users/:id/";
  16979. detail::PathParamsMatcher matcher(pattern);
  16980. Request request;
  16981. request.path = "/admins/24/";
  16982. ASSERT_FALSE(matcher.match(request));
  16983. }
  16984. TEST(PathParamsTest, ExtraFragments) {
  16985. const auto pattern = "/users/:id";
  16986. detail::PathParamsMatcher matcher(pattern);
  16987. Request request;
  16988. request.path = "/users/42/subscriptions";
  16989. ASSERT_FALSE(matcher.match(request));
  16990. }
  16991. TEST(PathParamsTest, MissingTrailingParam) {
  16992. const auto pattern = "/users/:id";
  16993. detail::PathParamsMatcher matcher(pattern);
  16994. Request request;
  16995. request.path = "/users";
  16996. ASSERT_FALSE(matcher.match(request));
  16997. }
  16998. TEST(PathParamsTest, MissingParamInTheMiddle) {
  16999. const auto pattern = "/users/:id/subscriptions";
  17000. detail::PathParamsMatcher matcher(pattern);
  17001. Request request;
  17002. request.path = "/users/subscriptions";
  17003. ASSERT_FALSE(matcher.match(request));
  17004. }
  17005. TEST(PathParamsTest, MultipleParams) {
  17006. const auto pattern = "/users/:userid/subscriptions/:subid";
  17007. detail::PathParamsMatcher matcher(pattern);
  17008. Request request;
  17009. request.path = "/users/42/subscriptions/2";
  17010. ASSERT_TRUE(matcher.match(request));
  17011. std::unordered_map<std::string, std::string> expected_params = {
  17012. {"userid", "42"}, {"subid", "2"}};
  17013. EXPECT_EQ(request.path_params, expected_params);
  17014. }
  17015. TEST(PathParamsTest, SequenceOfParams) {
  17016. const auto pattern = "/values/:x/:y/:z";
  17017. detail::PathParamsMatcher matcher(pattern);
  17018. Request request;
  17019. request.path = "/values/1/2/3";
  17020. ASSERT_TRUE(matcher.match(request));
  17021. std::unordered_map<std::string, std::string> expected_params = {
  17022. {"x", "1"}, {"y", "2"}, {"z", "3"}};
  17023. EXPECT_EQ(request.path_params, expected_params);
  17024. }
  17025. TEST(PathParamsTest, SemicolonInTheMiddleIsNotAParam) {
  17026. const auto pattern = "/prefix:suffix";
  17027. detail::PathParamsMatcher matcher(pattern);
  17028. Request request;
  17029. request.path = "/prefix:suffix";
  17030. ASSERT_TRUE(matcher.match(request));
  17031. const std::unordered_map<std::string, std::string> expected_params = {};
  17032. EXPECT_EQ(request.path_params, expected_params);
  17033. }
  17034. TEST(RegexMatcherTest, OverlongPathIsRejectedBeforeRegexMatch) {
  17035. // std::regex_match's backtracking (most acute on libstdc++) can exhaust the
  17036. // calling thread's stack on a long enough path for a quantified pattern;
  17037. // RegexMatcher must refuse to run regex matching on paths beyond
  17038. // CPPHTTPLIB_REGEX_ROUTE_PATH_MAX_LENGTH instead of invoking it.
  17039. detail::RegexMatcher matcher("/files/(.*)");
  17040. Request within_limit;
  17041. within_limit.path = "/files/" + std::string(10, 'A');
  17042. EXPECT_TRUE(matcher.match(within_limit));
  17043. Request over_limit;
  17044. over_limit.path =
  17045. "/files/" + std::string(CPPHTTPLIB_REGEX_ROUTE_PATH_MAX_LENGTH, 'A');
  17046. EXPECT_FALSE(matcher.match(over_limit));
  17047. }
  17048. TEST(RegexMatcherTest, ServerSurvivesOverlongPathOnRegexRoute) {
  17049. Server svr;
  17050. svr.Get(R"(/files/(.*))", [](const Request & /*req*/, Response &res) {
  17051. res.set_content("ok", "text/plain");
  17052. });
  17053. auto port = svr.bind_to_any_port(HOST);
  17054. auto thread = std::thread([&]() { svr.listen_after_bind(); });
  17055. auto se = detail::scope_exit([&] {
  17056. svr.stop();
  17057. thread.join();
  17058. ASSERT_FALSE(svr.is_running());
  17059. });
  17060. svr.wait_until_ready();
  17061. // Comfortably past CPPHTTPLIB_REGEX_ROUTE_PATH_MAX_LENGTH, well within the
  17062. // request URI limit; this used to be able to crash the process.
  17063. std::string path =
  17064. "/files/" + std::string(CPPHTTPLIB_REGEX_ROUTE_PATH_MAX_LENGTH * 4, 'A');
  17065. std::string req = "GET " + path +
  17066. " HTTP/1.1\r\n"
  17067. "Host: " +
  17068. std::string(HOST) + ":" + std::to_string(port) +
  17069. "\r\n"
  17070. "Connection: close\r\n"
  17071. "\r\n";
  17072. std::string response;
  17073. ASSERT_TRUE(send_request(5, req, &response, port));
  17074. EXPECT_NE(std::string::npos, response.find("404"));
  17075. }
  17076. TEST(RouteMatcherTest, LiteralPatternsAndRegexPatterns) {
  17077. Server svr;
  17078. auto handler = [](const Request & /*req*/, Response &res) {
  17079. res.set_content("hit", "text/plain");
  17080. };
  17081. // No regex metacharacter, so this one is compared literally
  17082. svr.Get("/literal/route", handler);
  17083. // '.' is a regex metacharacter, so this one must keep regex semantics
  17084. svr.Get("/a.c", handler);
  17085. auto port = svr.bind_to_any_port(HOST);
  17086. std::thread t([&]() { svr.listen_after_bind(); });
  17087. auto se = detail::scope_exit([&] {
  17088. svr.stop();
  17089. t.join();
  17090. ASSERT_FALSE(svr.is_running());
  17091. });
  17092. svr.wait_until_ready();
  17093. Client cli(HOST, port);
  17094. struct {
  17095. const char *path;
  17096. int status;
  17097. } cases[] = {
  17098. {"/literal/route", StatusCode::OK_200},
  17099. {"/literal/routes", StatusCode::NotFound_404},
  17100. {"/literal/rout", StatusCode::NotFound_404},
  17101. {"/abc", StatusCode::OK_200},
  17102. {"/a.c", StatusCode::OK_200},
  17103. };
  17104. for (const auto &x : cases) {
  17105. auto res = cli.Get(x.path);
  17106. ASSERT_TRUE(res) << x.path;
  17107. EXPECT_EQ(x.status, res->status) << x.path;
  17108. }
  17109. }
  17110. TEST(RouteMatcherTest, LongLiteralPatternIsNotSubjectToTheRegexPathLimit) {
  17111. // CPPHTTPLIB_REGEX_ROUTE_PATH_MAX_LENGTH exists to keep std::regex_match
  17112. // from exhausting the stack, so it must only constrain routes that actually
  17113. // run a regular expression. A literal route is matched by comparison and
  17114. // stays usable at any length.
  17115. Server svr;
  17116. const std::string pattern =
  17117. "/files/" + std::string(CPPHTTPLIB_REGEX_ROUTE_PATH_MAX_LENGTH * 2, 'a');
  17118. svr.Get(pattern, [](const Request & /*req*/, Response &res) {
  17119. res.set_content("hit", "text/plain");
  17120. });
  17121. auto port = svr.bind_to_any_port(HOST);
  17122. std::thread t([&]() { svr.listen_after_bind(); });
  17123. auto se = detail::scope_exit([&] {
  17124. svr.stop();
  17125. t.join();
  17126. ASSERT_FALSE(svr.is_running());
  17127. });
  17128. svr.wait_until_ready();
  17129. Client cli(HOST, port);
  17130. auto res = cli.Get(pattern);
  17131. ASSERT_TRUE(res);
  17132. EXPECT_EQ(StatusCode::OK_200, res->status);
  17133. }
  17134. TEST(ParseUrlTest, VariousPatterns) {
  17135. {
  17136. detail::UrlComponents uc;
  17137. ASSERT_TRUE(detail::parse_url("http://example.com:8080/path?q=1#frag", uc));
  17138. EXPECT_EQ("http", uc.scheme);
  17139. EXPECT_EQ("example.com", uc.host);
  17140. EXPECT_EQ("8080", uc.port);
  17141. EXPECT_EQ("/path", uc.path);
  17142. EXPECT_EQ("?q=1", uc.query);
  17143. }
  17144. {
  17145. detail::UrlComponents uc;
  17146. ASSERT_TRUE(detail::parse_url("https://example.com/path", uc));
  17147. EXPECT_EQ("https", uc.scheme);
  17148. EXPECT_EQ("example.com", uc.host);
  17149. EXPECT_TRUE(uc.port.empty());
  17150. EXPECT_EQ("/path", uc.path);
  17151. }
  17152. {
  17153. detail::UrlComponents uc;
  17154. ASSERT_TRUE(detail::parse_url("http://[::1]:8080/path", uc));
  17155. EXPECT_EQ("::1", uc.host);
  17156. EXPECT_EQ("8080", uc.port);
  17157. EXPECT_EQ("/path", uc.path);
  17158. }
  17159. {
  17160. detail::UrlComponents uc;
  17161. ASSERT_FALSE(detail::parse_url("http://[::1/path", uc));
  17162. }
  17163. {
  17164. // Bytes after the IPv6 literal must be a delimiter, not folded into
  17165. // the path while the connection still targets the bracketed host.
  17166. detail::UrlComponents uc;
  17167. ASSERT_FALSE(detail::parse_url("http://[::1]evil.com/", uc));
  17168. }
  17169. {
  17170. detail::UrlComponents uc;
  17171. ASSERT_FALSE(detail::parse_url("http://[::1]evil", uc));
  17172. }
  17173. {
  17174. detail::UrlComponents uc;
  17175. ASSERT_TRUE(detail::parse_url("http://[::1]/path", uc));
  17176. EXPECT_EQ("::1", uc.host);
  17177. EXPECT_TRUE(uc.port.empty());
  17178. EXPECT_EQ("/path", uc.path);
  17179. }
  17180. {
  17181. detail::UrlComponents uc;
  17182. ASSERT_TRUE(detail::parse_url("//example.com/path?q=1", uc));
  17183. EXPECT_TRUE(uc.scheme.empty());
  17184. EXPECT_EQ("example.com", uc.host);
  17185. EXPECT_EQ("/path", uc.path);
  17186. EXPECT_EQ("?q=1", uc.query);
  17187. }
  17188. {
  17189. detail::UrlComponents uc;
  17190. ASSERT_TRUE(detail::parse_url("/path?q=1", uc));
  17191. EXPECT_TRUE(uc.host.empty());
  17192. EXPECT_EQ("/path", uc.path);
  17193. EXPECT_EQ("?q=1", uc.query);
  17194. }
  17195. {
  17196. detail::UrlComponents uc;
  17197. ASSERT_TRUE(detail::parse_url("example.com:8080", uc));
  17198. EXPECT_EQ("example.com", uc.host);
  17199. EXPECT_EQ("8080", uc.port);
  17200. }
  17201. {
  17202. // Unix socket path — must not be parsed as host
  17203. detail::UrlComponents uc;
  17204. ASSERT_TRUE(detail::parse_url("./httplib-server.sock", uc));
  17205. EXPECT_TRUE(uc.host.empty());
  17206. }
  17207. {
  17208. detail::UrlComponents uc;
  17209. ASSERT_TRUE(detail::parse_url("", uc));
  17210. EXPECT_TRUE(uc.host.empty());
  17211. EXPECT_TRUE(uc.path.empty());
  17212. }
  17213. {
  17214. detail::UrlComponents uc;
  17215. ASSERT_FALSE(detail::parse_url("HTTP://example.com/path", uc));
  17216. }
  17217. {
  17218. detail::UrlComponents uc;
  17219. ASSERT_FALSE(detail::parse_url("h2://example.com/path", uc));
  17220. }
  17221. {
  17222. // Accepted by parse_url; callers restrict to http/https
  17223. detail::UrlComponents uc;
  17224. ASSERT_TRUE(detail::parse_url("ftp://example.com/", uc));
  17225. EXPECT_EQ("ftp", uc.scheme);
  17226. }
  17227. {
  17228. detail::UrlComponents uc;
  17229. ASSERT_FALSE(detail::parse_url("http://[::1<script>]/path", uc));
  17230. }
  17231. {
  17232. detail::UrlComponents uc;
  17233. ASSERT_FALSE(detail::parse_url("http://[]/path", uc));
  17234. }
  17235. }
  17236. TEST(ParseUrlTest, FragmentHandling) {
  17237. {
  17238. detail::UrlComponents uc;
  17239. ASSERT_TRUE(detail::parse_url("http://example.com/path#frag", uc));
  17240. EXPECT_EQ("/path", uc.path);
  17241. EXPECT_TRUE(uc.query.empty());
  17242. }
  17243. {
  17244. detail::UrlComponents uc;
  17245. ASSERT_TRUE(detail::parse_url("#frag", uc));
  17246. EXPECT_TRUE(uc.path.empty());
  17247. EXPECT_TRUE(uc.query.empty());
  17248. }
  17249. }
  17250. TEST(ParseUrlTest, UserinfoHandling) {
  17251. // userinfo, and a backslash some parsers take for '/', are rejected: such
  17252. // parsers would see evil.com as the host.
  17253. const char *urls[] = {"http://user@evil.com/", "http://user:pass@evil.com/",
  17254. "http://evil.com\\@good.com/", "//user@evil.com/x"};
  17255. for (auto url : urls) {
  17256. detail::UrlComponents uc;
  17257. EXPECT_FALSE(detail::parse_url(url, uc)) << url;
  17258. }
  17259. }
  17260. TEST(ParseUrlTest, IPv6EdgeCases) {
  17261. {
  17262. detail::UrlComponents uc;
  17263. ASSERT_TRUE(detail::parse_url("[::1]:8080", uc));
  17264. EXPECT_TRUE(uc.scheme.empty());
  17265. EXPECT_EQ("::1", uc.host);
  17266. EXPECT_EQ("8080", uc.port);
  17267. }
  17268. {
  17269. // Zone ID '%25' is not in [a-fA-F0-9:]
  17270. detail::UrlComponents uc;
  17271. ASSERT_FALSE(detail::parse_url("http://[fe80::1%25eth0]:443/path", uc));
  17272. }
  17273. }
  17274. TEST(ParseUrlTest, SchemeEdgeCases) {
  17275. {
  17276. detail::UrlComponents uc;
  17277. ASSERT_FALSE(detail::parse_url("://evil.com/path", uc));
  17278. }
  17279. {
  17280. detail::UrlComponents uc;
  17281. ASSERT_FALSE(detail::parse_url("ht-tp://evil.com/path", uc));
  17282. }
  17283. {
  17284. detail::UrlComponents uc;
  17285. ASSERT_FALSE(detail::parse_url("h.t://evil.com/path", uc));
  17286. }
  17287. }
  17288. TEST(ParseUrlTest, PortEdgeCases) {
  17289. {
  17290. detail::UrlComponents uc;
  17291. ASSERT_TRUE(detail::parse_url("http://example.com:/path", uc));
  17292. EXPECT_TRUE(uc.port.empty());
  17293. EXPECT_EQ("/path", uc.path);
  17294. }
  17295. {
  17296. // parse_url accepts any port string; validation is done by parse_port
  17297. detail::UrlComponents uc;
  17298. ASSERT_TRUE(detail::parse_url("http://example.com:abc/path", uc));
  17299. EXPECT_EQ("abc", uc.port);
  17300. }
  17301. }
  17302. TEST(ParseUrlTest, WebSocketPatterns) {
  17303. {
  17304. detail::UrlComponents uc;
  17305. ASSERT_TRUE(detail::parse_url("ws://echo.example.com:8080/ws", uc));
  17306. EXPECT_EQ("ws", uc.scheme);
  17307. EXPECT_EQ("echo.example.com", uc.host);
  17308. EXPECT_EQ("8080", uc.port);
  17309. EXPECT_EQ("/ws", uc.path);
  17310. }
  17311. {
  17312. detail::UrlComponents uc;
  17313. ASSERT_TRUE(detail::parse_url("wss://echo.example.com/ws", uc));
  17314. EXPECT_EQ("wss", uc.scheme);
  17315. EXPECT_EQ("echo.example.com", uc.host);
  17316. EXPECT_TRUE(uc.port.empty());
  17317. EXPECT_EQ("/ws", uc.path);
  17318. }
  17319. }
  17320. TEST(ParseUrlTest, QueryOnly) {
  17321. detail::UrlComponents uc;
  17322. ASSERT_TRUE(detail::parse_url("?q=1&r=2", uc));
  17323. EXPECT_TRUE(uc.host.empty());
  17324. EXPECT_TRUE(uc.path.empty());
  17325. EXPECT_EQ("?q=1&r=2", uc.query);
  17326. }
  17327. TEST(ParseUrlTest, SchemeRelativeWithPort) {
  17328. detail::UrlComponents uc;
  17329. ASSERT_TRUE(detail::parse_url("//example.com:443/path", uc));
  17330. EXPECT_TRUE(uc.scheme.empty());
  17331. EXPECT_EQ("example.com", uc.host);
  17332. EXPECT_EQ("443", uc.port);
  17333. EXPECT_EQ("/path", uc.path);
  17334. }
  17335. TEST(UniversalClientImplTest, Ipv6LiteralAddress) {
  17336. // If ipv6 regex working, regex match codepath is taken.
  17337. // else port will default to 80 in Client impl
  17338. int clientImplMagicPort = 80;
  17339. int port = 4321;
  17340. // above ports must be different to avoid false negative
  17341. EXPECT_NE(clientImplMagicPort, port);
  17342. std::string ipV6TestURL = "http://[ff06::c3]";
  17343. Client cli(ipV6TestURL + ":" + std::to_string(port), CLIENT_CERT_FILE,
  17344. CLIENT_PRIVATE_KEY_FILE);
  17345. EXPECT_EQ(cli.port(), port);
  17346. }
  17347. TEST(FileSystemTest, FileAndDirExistenceCheck) {
  17348. auto file_path = "./www/dir/index.html";
  17349. auto dir_path = "./www/dir";
  17350. detail::FileStat stat_file(file_path);
  17351. EXPECT_TRUE(stat_file.is_file());
  17352. EXPECT_FALSE(stat_file.is_dir());
  17353. detail::FileStat stat_dir(dir_path);
  17354. EXPECT_FALSE(stat_dir.is_file());
  17355. EXPECT_TRUE(stat_dir.is_dir());
  17356. }
  17357. TEST(MakeHostAndPortStringTest, VariousPatterns) {
  17358. // IPv4 with default HTTP port (80)
  17359. EXPECT_EQ("example.com",
  17360. detail::make_host_and_port_string("example.com", 80, false));
  17361. // IPv4 with default HTTPS port (443)
  17362. EXPECT_EQ("example.com",
  17363. detail::make_host_and_port_string("example.com", 443, true));
  17364. // IPv4 with non-default HTTP port
  17365. EXPECT_EQ("example.com:8080",
  17366. detail::make_host_and_port_string("example.com", 8080, false));
  17367. // IPv4 with non-default HTTPS port
  17368. EXPECT_EQ("example.com:8443",
  17369. detail::make_host_and_port_string("example.com", 8443, true));
  17370. // IPv6 with default HTTP port (80)
  17371. EXPECT_EQ("[::1]", detail::make_host_and_port_string("::1", 80, false));
  17372. // IPv6 with default HTTPS port (443)
  17373. EXPECT_EQ("[::1]", detail::make_host_and_port_string("::1", 443, true));
  17374. // IPv6 with non-default HTTP port
  17375. EXPECT_EQ("[::1]:8080",
  17376. detail::make_host_and_port_string("::1", 8080, false));
  17377. // IPv6 with non-default HTTPS port
  17378. EXPECT_EQ("[::1]:8443", detail::make_host_and_port_string("::1", 8443, true));
  17379. // IPv6 full address with default port
  17380. EXPECT_EQ("[2001:0db8:85a3:0000:0000:8a2e:0370:7334]",
  17381. detail::make_host_and_port_string(
  17382. "2001:0db8:85a3:0000:0000:8a2e:0370:7334", 443, true));
  17383. // IPv6 full address with non-default port
  17384. EXPECT_EQ("[2001:0db8:85a3:0000:0000:8a2e:0370:7334]:9000",
  17385. detail::make_host_and_port_string(
  17386. "2001:0db8:85a3:0000:0000:8a2e:0370:7334", 9000, false));
  17387. // IPv6 localhost with non-default port
  17388. EXPECT_EQ("[::1]:3000",
  17389. detail::make_host_and_port_string("::1", 3000, false));
  17390. // IPv6 with zone ID (link-local address) with default port
  17391. EXPECT_EQ("[fe80::1%eth0]",
  17392. detail::make_host_and_port_string("fe80::1%eth0", 80, false));
  17393. // IPv6 with zone ID (link-local address) with non-default port
  17394. EXPECT_EQ("[fe80::1%eth0]:8080",
  17395. detail::make_host_and_port_string("fe80::1%eth0", 8080, false));
  17396. // Edge case: Port 443 with is_ssl=false (should add port)
  17397. EXPECT_EQ("example.com:443",
  17398. detail::make_host_and_port_string("example.com", 443, false));
  17399. // Edge case: Port 80 with is_ssl=true (should add port)
  17400. EXPECT_EQ("example.com:80",
  17401. detail::make_host_and_port_string("example.com", 80, true));
  17402. // IPv6 edge case: Port 443 with is_ssl=false (should add port)
  17403. EXPECT_EQ("[::1]:443", detail::make_host_and_port_string("::1", 443, false));
  17404. // IPv6 edge case: Port 80 with is_ssl=true (should add port)
  17405. EXPECT_EQ("[::1]:80", detail::make_host_and_port_string("::1", 80, true));
  17406. // Security fix: Already bracketed IPv6 should not get double brackets
  17407. EXPECT_EQ("[::1]", detail::make_host_and_port_string("[::1]", 80, false));
  17408. EXPECT_EQ("[::1]", detail::make_host_and_port_string("[::1]", 443, true));
  17409. EXPECT_EQ("[::1]:8080",
  17410. detail::make_host_and_port_string("[::1]", 8080, false));
  17411. EXPECT_EQ("[2001:db8::1]:8080",
  17412. detail::make_host_and_port_string("[2001:db8::1]", 8080, false));
  17413. EXPECT_EQ("[fe80::1%eth0]",
  17414. detail::make_host_and_port_string("[fe80::1%eth0]", 80, false));
  17415. EXPECT_EQ("[fe80::1%eth0]:8080",
  17416. detail::make_host_and_port_string("[fe80::1%eth0]", 8080, false));
  17417. // Edge case: Empty host (should return as-is)
  17418. EXPECT_EQ("", detail::make_host_and_port_string("", 80, false));
  17419. // Edge case: Colon in hostname (non-IPv6) - will be treated as IPv6
  17420. // This is a known limitation but shouldn't crash
  17421. EXPECT_EQ("[host:name]",
  17422. detail::make_host_and_port_string("host:name", 80, false));
  17423. // Port number edge cases (no validation, but should not crash)
  17424. EXPECT_EQ("example.com:0",
  17425. detail::make_host_and_port_string("example.com", 0, false));
  17426. EXPECT_EQ("example.com:-1",
  17427. detail::make_host_and_port_string("example.com", -1, false));
  17428. EXPECT_EQ("example.com:65535",
  17429. detail::make_host_and_port_string("example.com", 65535, false));
  17430. EXPECT_EQ("example.com:65536",
  17431. detail::make_host_and_port_string("example.com", 65536, false));
  17432. }
  17433. #ifdef CPPHTTPLIB_SSL_ENABLED
  17434. TEST(SSLClientHostHeaderTest, Issue2301_Online) {
  17435. httplib::SSLClient cli("roblox.com", 443);
  17436. cli.set_follow_location(true);
  17437. auto res = cli.Get("/");
  17438. ASSERT_TRUE(res) << "Error: " << to_string(res.error());
  17439. EXPECT_EQ(StatusCode::OK_200, res->status);
  17440. }
  17441. #endif
  17442. TEST(DirtyDataRequestTest, HeadFieldValueContains_CR_LF_NUL) {
  17443. Server svr;
  17444. svr.Get("/test", [&](const Request & /*req*/, Response &res) {
  17445. EXPECT_EQ(res.status, 400);
  17446. });
  17447. auto thread = std::thread([&]() { svr.listen(HOST, PORT); });
  17448. auto se = detail::scope_exit([&] {
  17449. svr.stop();
  17450. thread.join();
  17451. ASSERT_FALSE(svr.is_running());
  17452. });
  17453. svr.wait_until_ready();
  17454. Client cli(HOST, PORT);
  17455. cli.Get("/test", Headers{{"Test", "_\n\r_\n\r_"}});
  17456. }
  17457. TEST(InvalidHeaderCharsTest, is_field_name) {
  17458. EXPECT_TRUE(detail::fields::is_field_name("exampleToken"));
  17459. EXPECT_TRUE(detail::fields::is_field_name("token123"));
  17460. EXPECT_TRUE(detail::fields::is_field_name("!#$%&'*+-.^_`|~"));
  17461. EXPECT_FALSE(detail::fields::is_field_name("example token"));
  17462. EXPECT_FALSE(detail::fields::is_field_name(" example_token"));
  17463. EXPECT_FALSE(detail::fields::is_field_name("example_token "));
  17464. EXPECT_FALSE(detail::fields::is_field_name("token@123"));
  17465. EXPECT_FALSE(detail::fields::is_field_name(""));
  17466. EXPECT_FALSE(detail::fields::is_field_name("example\rtoken"));
  17467. EXPECT_FALSE(detail::fields::is_field_name("example\ntoken"));
  17468. EXPECT_FALSE(detail::fields::is_field_name(std::string("\0", 1)));
  17469. EXPECT_FALSE(detail::fields::is_field_name("example\ttoken"));
  17470. }
  17471. TEST(InvalidHeaderCharsTest, is_field_value) {
  17472. EXPECT_TRUE(detail::fields::is_field_value("exampleToken"));
  17473. EXPECT_TRUE(detail::fields::is_field_value("token123"));
  17474. EXPECT_TRUE(detail::fields::is_field_value("!#$%&'*+-.^_`|~"));
  17475. EXPECT_TRUE(detail::fields::is_field_value("example token"));
  17476. EXPECT_FALSE(detail::fields::is_field_value(" example_token"));
  17477. EXPECT_FALSE(detail::fields::is_field_value("example_token "));
  17478. EXPECT_TRUE(detail::fields::is_field_value("token@123"));
  17479. EXPECT_TRUE(detail::fields::is_field_value(""));
  17480. EXPECT_FALSE(detail::fields::is_field_value("example\rtoken"));
  17481. EXPECT_FALSE(detail::fields::is_field_value("example\ntoken"));
  17482. EXPECT_FALSE(detail::fields::is_field_value(std::string("\0", 1)));
  17483. EXPECT_TRUE(detail::fields::is_field_value("example\ttoken"));
  17484. EXPECT_TRUE(detail::fields::is_field_value("0"));
  17485. }
  17486. TEST(InvalidHeaderCharsTest, OnServer) {
  17487. Server svr;
  17488. svr.Get("/test_name", [&](const Request &req, Response &res) {
  17489. std::string header = "Not Set";
  17490. if (req.has_param("header")) { header = req.get_param_value("header"); }
  17491. res.set_header(header, "value");
  17492. res.set_content("Page Content Page Content", "text/plain");
  17493. });
  17494. svr.Get("/test_value", [&](const Request &req, Response &res) {
  17495. std::string header = "Not Set";
  17496. if (req.has_param("header")) { header = req.get_param_value("header"); }
  17497. res.set_header("X-Test", header);
  17498. res.set_content("Page Content Page Content", "text/plain");
  17499. });
  17500. auto thread = std::thread([&]() { svr.listen(HOST, PORT); });
  17501. auto se = detail::scope_exit([&] {
  17502. svr.stop();
  17503. thread.join();
  17504. ASSERT_FALSE(svr.is_running());
  17505. });
  17506. svr.wait_until_ready();
  17507. Client cli(HOST, PORT);
  17508. {
  17509. auto res = cli.Get(
  17510. R"(/test_name?header=Value%00%0d%0aHEADER_KEY%3aHEADER_VALUE%0d%0a%0d%0aBODY_BODY_BODY)");
  17511. ASSERT_TRUE(res) << "Error: " << to_string(res.error());
  17512. EXPECT_EQ("Page Content Page Content", res->body);
  17513. EXPECT_FALSE(res->has_header("HEADER_KEY"));
  17514. }
  17515. {
  17516. auto res = cli.Get(
  17517. R"(/test_value?header=Value%00%0d%0aHEADER_KEY%3aHEADER_VALUE%0d%0a%0d%0aBODY_BODY_BODY)");
  17518. ASSERT_TRUE(res) << "Error: " << to_string(res.error());
  17519. EXPECT_EQ("Page Content Page Content", res->body);
  17520. EXPECT_FALSE(res->has_header("HEADER_KEY"));
  17521. }
  17522. }
  17523. TEST(InvalidHeaderValueTest, InvalidContentLength) {
  17524. auto handled = false;
  17525. Server svr;
  17526. svr.Post("/test", [&](const Request &, Response &) { handled = true; });
  17527. thread t = thread([&] { svr.listen(HOST, PORT); });
  17528. auto se = detail::scope_exit([&] {
  17529. svr.stop();
  17530. t.join();
  17531. ASSERT_FALSE(svr.is_running());
  17532. ASSERT_FALSE(handled);
  17533. });
  17534. svr.wait_until_ready();
  17535. auto req = "POST /test HTTP/1.1\r\n"
  17536. "Content-Length: x\r\n"
  17537. "\r\n";
  17538. std::string response;
  17539. ASSERT_TRUE(send_request(1, req, &response));
  17540. ASSERT_EQ("HTTP/1.1 400 Bad Request",
  17541. response.substr(0, response.find("\r\n")));
  17542. }
  17543. // RFC 9110 Section 10.1.1: Expect is a comma-separated list, its value is
  17544. // case-insensitive, and a server that receives a 100-continue expectation in
  17545. // an HTTP/1.0 request MUST ignore it.
  17546. static void probe_expect(int port, const std::string &req, bool *got_100) {
  17547. std::string response;
  17548. ASSERT_TRUE(send_request(1, req, &response, port));
  17549. *got_100 = response.find("100 Continue") != std::string::npos;
  17550. }
  17551. class ExpectTokenTest : public ::testing::Test {
  17552. protected:
  17553. void SetUp() override {
  17554. svr_.Post("/p", [](const Request &, Response &res) {
  17555. res.set_content("ok", "text/plain");
  17556. });
  17557. port_ = svr_.bind_to_any_port(HOST);
  17558. thread_ = thread([&]() { svr_.listen_after_bind(); });
  17559. svr_.wait_until_ready();
  17560. }
  17561. void TearDown() override {
  17562. svr_.stop();
  17563. if (thread_.joinable()) { thread_.join(); }
  17564. }
  17565. std::string request(const char *version, const char *expect_value) const {
  17566. return std::string("POST /p ") + version +
  17567. "\r\n"
  17568. "Host: localhost\r\n"
  17569. "Content-Length: 2\r\n"
  17570. "Connection: close\r\n"
  17571. "Expect: " +
  17572. expect_value +
  17573. "\r\n"
  17574. "\r\n"
  17575. "hi";
  17576. }
  17577. Server svr_;
  17578. int port_ = 0;
  17579. thread thread_;
  17580. };
  17581. TEST_F(ExpectTokenTest, Http11GetsTheInterimResponse) {
  17582. bool got_100 = false;
  17583. probe_expect(port_, request("HTTP/1.1", "100-continue"), &got_100);
  17584. EXPECT_TRUE(got_100);
  17585. }
  17586. TEST_F(ExpectTokenTest, Http10ExpectationIsIgnored) {
  17587. bool got_100 = true;
  17588. probe_expect(port_, request("HTTP/1.0", "100-continue"), &got_100);
  17589. EXPECT_FALSE(got_100);
  17590. }
  17591. TEST_F(ExpectTokenTest, ExpectationIsCaseInsensitive) {
  17592. bool got_100 = false;
  17593. probe_expect(port_, request("HTTP/1.1", "100-Continue"), &got_100);
  17594. EXPECT_TRUE(got_100);
  17595. }
  17596. TEST_F(ExpectTokenTest, ExpectationAmongOthersIsRecognized) {
  17597. bool got_100 = false;
  17598. probe_expect(port_, request("HTTP/1.1", "100-continue, foo"), &got_100);
  17599. EXPECT_TRUE(got_100);
  17600. }
  17601. // `100 Continue` is sent only when the server starts reading the body, so a
  17602. // request rejected before that never invites the client to send it. The
  17603. // requests below carry the expectation but withhold the body, as a client
  17604. // waiting for `100 Continue` would.
  17605. // A POST that expects `100 Continue` and withholds its two-byte body.
  17606. static std::string expect_headers_only(const std::string &path) {
  17607. return "POST " + path +
  17608. " HTTP/1.1\r\n"
  17609. "Host: localhost\r\n"
  17610. "Content-Length: 2\r\n"
  17611. "Expect: 100-continue\r\n"
  17612. "\r\n";
  17613. }
  17614. class ExpectLazyContinueTest : public ::testing::Test {
  17615. protected:
  17616. void SetUp() override {
  17617. svr_.set_pre_routing_handler([](const Request &req, Response &res) {
  17618. if (req.path == "/pre-routing") {
  17619. res.status = StatusCode::Unauthorized_401;
  17620. return Server::HandlerResponse::Handled;
  17621. }
  17622. return Server::HandlerResponse::Unhandled;
  17623. });
  17624. svr_.set_pre_request_handler([](const Request &req, Response &res) {
  17625. if (req.matched_route == "/pre-request") {
  17626. res.status = StatusCode::Forbidden_403;
  17627. return Server::HandlerResponse::Handled;
  17628. }
  17629. return Server::HandlerResponse::Unhandled;
  17630. });
  17631. svr_.Post("/pre-routing", [](const Request &, Response &res) {
  17632. res.set_content("ok", "text/plain");
  17633. });
  17634. svr_.Post("/pre-request", [](const Request &, Response &res) {
  17635. res.set_content("ok", "text/plain");
  17636. });
  17637. svr_.Post("/reader-used", [](const Request &, Response &res,
  17638. const ContentReader &content_reader) {
  17639. std::string body;
  17640. content_reader([&](const char *data, size_t len) {
  17641. body.append(data, len);
  17642. return true;
  17643. });
  17644. res.set_content(body, "text/plain");
  17645. });
  17646. svr_.Post("/reader-unused",
  17647. [](const Request &, Response &res, const ContentReader &) {
  17648. res.set_content("ignored", "text/plain");
  17649. });
  17650. port_ = svr_.bind_to_any_port(HOST);
  17651. thread_ = thread([&]() { svr_.listen_after_bind(); });
  17652. svr_.wait_until_ready();
  17653. }
  17654. void TearDown() override {
  17655. svr_.stop();
  17656. if (thread_.joinable()) { thread_.join(); }
  17657. }
  17658. // Sends `req` and reads until the server closes the connection. Returns
  17659. // false if the read had to wait for the client-side timeout instead.
  17660. bool send_until_closed(const std::string &req, std::string *resp) const {
  17661. auto start = std::chrono::steady_clock::now();
  17662. if (!send_request(3, req, resp, port_)) { return false; }
  17663. auto elapsed = std::chrono::steady_clock::now() - start;
  17664. return elapsed < std::chrono::seconds(2);
  17665. }
  17666. // The final response comes without `100 Continue`, and the server closes
  17667. // the connection since the body may or may not follow.
  17668. void expect_final_without_interim(const std::string &path,
  17669. const char *status_line) const {
  17670. std::string resp;
  17671. ASSERT_TRUE(send_until_closed(expect_headers_only(path), &resp));
  17672. EXPECT_EQ(std::string::npos, resp.find("100 Continue"));
  17673. EXPECT_EQ(0u, resp.find(status_line));
  17674. EXPECT_NE(std::string::npos, resp.find("Connection: close"));
  17675. }
  17676. Server svr_;
  17677. int port_ = 0;
  17678. thread thread_;
  17679. };
  17680. TEST_F(ExpectLazyContinueTest, PreRoutingRejectsWithoutInterimResponse) {
  17681. expect_final_without_interim("/pre-routing", "HTTP/1.1 401");
  17682. }
  17683. TEST_F(ExpectLazyContinueTest, PreRequestRejectsWithoutInterimResponse) {
  17684. expect_final_without_interim("/pre-request", "HTTP/1.1 403");
  17685. }
  17686. TEST_F(ExpectLazyContinueTest, UnknownRouteRejectsWithoutInterimResponse) {
  17687. expect_final_without_interim("/nowhere", "HTTP/1.1 404");
  17688. }
  17689. TEST_F(ExpectLazyContinueTest, UnreadContentReaderClosesWithoutInterim) {
  17690. expect_final_without_interim("/reader-unused", "HTTP/1.1 200");
  17691. }
  17692. TEST_F(ExpectLazyContinueTest, ContentReaderGetsInterimResponse) {
  17693. // The body follows once `100 Continue` has had time to arrive.
  17694. auto req = expect_headers_only("/reader-used");
  17695. req.insert(req.size() - 2, "Connection: close\r\n");
  17696. std::string resp;
  17697. ASSERT_TRUE(send_request_in_parts(3, {req, "hi"}, &resp, port_));
  17698. EXPECT_EQ(0u, resp.find("HTTP/1.1 100 Continue"));
  17699. EXPECT_NE(std::string::npos, resp.find("HTTP/1.1 200"));
  17700. EXPECT_NE(std::string::npos, resp.find("hi"));
  17701. }
  17702. TEST_F(ExpectLazyContinueTest, ClientWithholdsBodyWhenRejected) {
  17703. // Large enough for the client to add `Expect: 100-continue` itself.
  17704. const size_t length = CPPHTTPLIB_EXPECT_100_THRESHOLD * 4;
  17705. std::atomic<bool> body_sent{false};
  17706. Client cli(HOST, port_);
  17707. auto res = cli.Post(
  17708. "/pre-request", length,
  17709. [&](size_t /*offset*/, size_t len, DataSink &sink) {
  17710. body_sent = true;
  17711. std::string chunk(len, 'x');
  17712. sink.write(chunk.data(), chunk.size());
  17713. return true;
  17714. },
  17715. "application/octet-stream");
  17716. ASSERT_TRUE(res);
  17717. EXPECT_EQ(StatusCode::Forbidden_403, res->status);
  17718. EXPECT_FALSE(body_sent);
  17719. }
  17720. TEST(Expect100ContinueHandlerTest, ExpectationFailedIsFinalResponse) {
  17721. Server svr;
  17722. svr.set_expect_100_continue_handler([](const Request &, Response &) {
  17723. return StatusCode::ExpectationFailed_417;
  17724. });
  17725. svr.Post("/p", [](const Request &, Response &res) {
  17726. res.set_content("ok", "text/plain");
  17727. });
  17728. auto port = svr.bind_to_any_port(HOST);
  17729. thread t = thread([&] { svr.listen_after_bind(); });
  17730. auto se = detail::scope_exit([&] {
  17731. svr.stop();
  17732. t.join();
  17733. });
  17734. svr.wait_until_ready();
  17735. std::string resp;
  17736. ASSERT_TRUE(send_request(3, expect_headers_only("/p"), &resp, port));
  17737. EXPECT_EQ(0u, resp.find("HTTP/1.1 417"));
  17738. EXPECT_NE(std::string::npos, resp.find("Connection: close"));
  17739. // Exactly one response: the route handler must not run after the 417.
  17740. EXPECT_EQ(std::string::npos, resp.find("HTTP/1.1", 1));
  17741. }
  17742. #ifndef _WIN32
  17743. TEST(Expect100ContinueTest, ServerClosesConnection) {
  17744. static constexpr char reject[] = "Unauthorized";
  17745. static constexpr char accept[] = "Upload accepted";
  17746. constexpr size_t total_size = 10 * 1024 * 1024 * 1024ULL;
  17747. Server svr;
  17748. svr.set_expect_100_continue_handler(
  17749. [](const Request & /*req*/, Response &res) {
  17750. res.status = StatusCode::Unauthorized_401;
  17751. res.set_content(reject, "text/plain");
  17752. return res.status;
  17753. });
  17754. svr.Post("/", [&](const Request & /*req*/, Response &res) {
  17755. res.set_content(accept, "text/plain");
  17756. });
  17757. auto thread = std::thread([&]() { svr.listen(HOST, PORT); });
  17758. auto se = detail::scope_exit([&] {
  17759. svr.stop();
  17760. thread.join();
  17761. ASSERT_FALSE(svr.is_running());
  17762. });
  17763. svr.wait_until_ready();
  17764. {
  17765. const auto curl = std::unique_ptr<CURL, decltype(&curl_easy_cleanup)>{
  17766. curl_easy_init(), &curl_easy_cleanup};
  17767. ASSERT_NE(curl, nullptr);
  17768. curl_easy_setopt(curl.get(), CURLOPT_URL, HOST);
  17769. curl_easy_setopt(curl.get(), CURLOPT_PORT, PORT);
  17770. curl_easy_setopt(curl.get(), CURLOPT_POST, 1L);
  17771. auto list = std::unique_ptr<curl_slist, decltype(&curl_slist_free_all)>{
  17772. curl_slist_append(nullptr, "Content-Type: application/octet-stream"),
  17773. &curl_slist_free_all};
  17774. ASSERT_NE(list, nullptr);
  17775. curl_easy_setopt(curl.get(), CURLOPT_HTTPHEADER, list.get());
  17776. struct read_data {
  17777. size_t read_size;
  17778. size_t total_size;
  17779. } data = {0, total_size};
  17780. using read_callback_t =
  17781. size_t (*)(char *ptr, size_t size, size_t nmemb, void *userdata);
  17782. read_callback_t read_callback = [](char *ptr, size_t size, size_t nmemb,
  17783. void *userdata) -> size_t {
  17784. read_data *d = (read_data *)userdata;
  17785. if (!userdata || d->read_size >= d->total_size) { return 0; }
  17786. std::fill_n(ptr, size * nmemb, 'A');
  17787. d->read_size += size * nmemb;
  17788. return size * nmemb;
  17789. };
  17790. curl_easy_setopt(curl.get(), CURLOPT_READDATA, data);
  17791. curl_easy_setopt(curl.get(), CURLOPT_READFUNCTION, read_callback);
  17792. std::vector<char> buffer;
  17793. curl_easy_setopt(curl.get(), CURLOPT_WRITEDATA, &buffer);
  17794. using write_callback_t =
  17795. size_t (*)(char *ptr, size_t size, size_t nmemb, void *userdata);
  17796. write_callback_t write_callback = [](char *ptr, size_t size, size_t nmemb,
  17797. void *userdata) -> size_t {
  17798. std::vector<char> *buf = (std::vector<char> *)userdata;
  17799. buf->reserve(buf->size() + size * nmemb + 1);
  17800. buf->insert(buf->end(), (char *)ptr, (char *)ptr + size * nmemb);
  17801. return size * nmemb;
  17802. };
  17803. curl_easy_setopt(curl.get(), CURLOPT_WRITEFUNCTION, write_callback);
  17804. {
  17805. const auto res = curl_easy_perform(curl.get());
  17806. ASSERT_EQ(res, CURLE_OK);
  17807. }
  17808. {
  17809. auto response_code = long{};
  17810. const auto res =
  17811. curl_easy_getinfo(curl.get(), CURLINFO_RESPONSE_CODE, &response_code);
  17812. ASSERT_EQ(res, CURLE_OK);
  17813. ASSERT_EQ(response_code, StatusCode::Unauthorized_401);
  17814. }
  17815. {
  17816. auto dl = curl_off_t{};
  17817. const auto res =
  17818. curl_easy_getinfo(curl.get(), CURLINFO_SIZE_DOWNLOAD_T, &dl);
  17819. ASSERT_EQ(res, CURLE_OK);
  17820. ASSERT_EQ(dl, (curl_off_t)sizeof reject - 1);
  17821. }
  17822. {
  17823. buffer.push_back('\0');
  17824. ASSERT_STRCASEEQ(buffer.data(), reject);
  17825. }
  17826. }
  17827. }
  17828. #endif
  17829. #if defined(CPPHTTPLIB_OPENSSL_SUPPORT) && !defined(_WIN32)
  17830. // Regression test for #2458.
  17831. //
  17832. // A large request body (>= CPPHTTPLIB_EXPECT_100_THRESHOLD) makes the client
  17833. // auto-add `Expect: 100-continue`. Over TLS, the server's TLS 1.3 session
  17834. // ticket can make the client socket spuriously readable during the
  17835. // 100-continue wait. If the readiness is mistaken for an incoming response,
  17836. // the client withholds the body and then blocks reading a response that never
  17837. // comes, failing with `Failed to read connection`.
  17838. //
  17839. // A correct client (like curl) sends the body once no `100 Continue` arrives
  17840. // within the timeout. This raw OpenSSL server deliberately never sends
  17841. // `100 Continue`; the client must still deliver the body and receive 200.
  17842. TEST(Expect100ContinueTest, TLSServerOmits100Continue) {
  17843. signal(SIGPIPE, SIG_IGN);
  17844. const auto port = PORT + 4;
  17845. auto srv = ::socket(AF_INET, SOCK_STREAM, 0);
  17846. ASSERT_NE(srv, INVALID_SOCKET);
  17847. int opt = 1;
  17848. ::setsockopt(srv, SOL_SOCKET, SO_REUSEADDR, &opt, sizeof(opt));
  17849. sockaddr_in addr{};
  17850. addr.sin_family = AF_INET;
  17851. addr.sin_port = htons(static_cast<uint16_t>(port));
  17852. ::inet_pton(AF_INET, "127.0.0.1", &addr.sin_addr);
  17853. ASSERT_EQ(0, ::bind(srv, reinterpret_cast<sockaddr *>(&addr), sizeof(addr)));
  17854. ASSERT_EQ(0, ::listen(srv, 1));
  17855. std::atomic<size_t> server_body_bytes{0};
  17856. auto server_thread = std::thread([&] {
  17857. sockaddr_in cli_addr{};
  17858. socklen_t cli_len = sizeof(cli_addr);
  17859. auto cli = ::accept(srv, reinterpret_cast<sockaddr *>(&cli_addr), &cli_len);
  17860. if (cli == INVALID_SOCKET) { return; }
  17861. // Bound the lifetime of the server side so a buggy client (which never
  17862. // sends the body) cannot make this thread block forever on join.
  17863. detail::set_socket_opt_time(cli, SOL_SOCKET, SO_RCVTIMEO, 4, 0);
  17864. SSL_CTX *ctx = SSL_CTX_new(TLS_server_method());
  17865. SSL_CTX_set_min_proto_version(ctx, TLS1_3_VERSION);
  17866. SSL_CTX_use_certificate_file(ctx, SERVER_CERT_FILE, SSL_FILETYPE_PEM);
  17867. SSL_CTX_use_PrivateKey_file(ctx, SERVER_PRIVATE_KEY_FILE, SSL_FILETYPE_PEM);
  17868. SSL *ssl = SSL_new(ctx);
  17869. SSL_set_fd(ssl, static_cast<int>(cli));
  17870. if (SSL_accept(ssl) > 0) {
  17871. // Read the request headers. Reading here also flushes the TLS 1.3
  17872. // session tickets to the client. Deliberately do NOT send
  17873. // `100 Continue`.
  17874. std::string buf;
  17875. char tmp[1024];
  17876. while (buf.find("\r\n\r\n") == std::string::npos) {
  17877. auto n = SSL_read(ssl, tmp, sizeof(tmp));
  17878. if (n <= 0) { break; }
  17879. buf.append(tmp, static_cast<size_t>(n));
  17880. }
  17881. // A correct client sends the body now; count what arrives.
  17882. auto pos = buf.find("\r\n\r\n");
  17883. size_t body = (pos == std::string::npos) ? 0 : buf.size() - (pos + 4);
  17884. while (body < 4096) {
  17885. auto n = SSL_read(ssl, tmp, sizeof(tmp));
  17886. if (n <= 0) { break; }
  17887. body += static_cast<size_t>(n);
  17888. }
  17889. server_body_bytes = body;
  17890. std::string resp = "HTTP/1.1 200 OK\r\nContent-Length: 2\r\n\r\nok";
  17891. SSL_write(ssl, resp.data(), static_cast<int>(resp.size()));
  17892. SSL_shutdown(ssl);
  17893. }
  17894. SSL_free(ssl);
  17895. detail::close_socket(cli);
  17896. SSL_CTX_free(ctx);
  17897. });
  17898. auto se = detail::scope_exit([&] {
  17899. server_thread.join();
  17900. detail::close_socket(srv);
  17901. });
  17902. SSLClient cli("127.0.0.1", port);
  17903. cli.enable_server_certificate_verification(false);
  17904. cli.set_connection_timeout(5, 0);
  17905. cli.set_read_timeout(3, 0); // short, so a hang surfaces quickly
  17906. // Body larger than CPPHTTPLIB_EXPECT_100_THRESHOLD (1024) -> auto Expect.
  17907. std::string body(4096, 'A');
  17908. auto res = cli.Put("/api/test", body, "application/json");
  17909. ASSERT_TRUE(res) << "request failed: " << to_string(res.error());
  17910. EXPECT_EQ(StatusCode::OK_200, res->status);
  17911. EXPECT_EQ(body.size(), server_body_bytes.load());
  17912. }
  17913. #endif
  17914. template <typename S, typename C>
  17915. inline void max_timeout_test(S &svr, C &cli, time_t timeout, time_t threshold) {
  17916. svr.Get("/stream", [&](const Request &, Response &res) {
  17917. auto data = new std::string("01234567890123456789");
  17918. res.set_content_provider(
  17919. data->size(), "text/plain",
  17920. [&, data](size_t offset, size_t length, DataSink &sink) {
  17921. const size_t DATA_CHUNK_SIZE = 4;
  17922. const auto &d = *data;
  17923. std::this_thread::sleep_for(std::chrono::seconds(1));
  17924. sink.write(&d[offset], std::min(length, DATA_CHUNK_SIZE));
  17925. return true;
  17926. },
  17927. [data](bool success) {
  17928. EXPECT_FALSE(success);
  17929. delete data;
  17930. });
  17931. });
  17932. svr.Get("/stream_without_length", [&](const Request &, Response &res) {
  17933. auto i = new size_t(0);
  17934. res.set_content_provider(
  17935. "text/plain",
  17936. [i](size_t, DataSink &sink) {
  17937. if (*i < 5) {
  17938. std::this_thread::sleep_for(std::chrono::seconds(1));
  17939. sink.write("abcd", 4);
  17940. (*i)++;
  17941. } else {
  17942. sink.done();
  17943. }
  17944. return true;
  17945. },
  17946. [i](bool success) {
  17947. EXPECT_FALSE(success);
  17948. delete i;
  17949. });
  17950. });
  17951. svr.Get("/chunked", [&](const Request &, Response &res) {
  17952. auto i = new size_t(0);
  17953. res.set_chunked_content_provider(
  17954. "text/plain",
  17955. [i](size_t, DataSink &sink) {
  17956. if (*i < 5) {
  17957. std::this_thread::sleep_for(std::chrono::seconds(1));
  17958. sink.os << "abcd";
  17959. (*i)++;
  17960. } else {
  17961. sink.done();
  17962. }
  17963. return true;
  17964. },
  17965. [i](bool success) {
  17966. EXPECT_FALSE(success);
  17967. delete i;
  17968. });
  17969. });
  17970. auto listen_thread = std::thread([&svr]() { svr.listen("localhost", PORT); });
  17971. auto se = detail::scope_exit([&] {
  17972. svr.stop();
  17973. listen_thread.join();
  17974. ASSERT_FALSE(svr.is_running());
  17975. });
  17976. svr.wait_until_ready();
  17977. cli.set_max_timeout(std::chrono::milliseconds(timeout));
  17978. {
  17979. auto start = std::chrono::steady_clock::now();
  17980. auto res = cli.Get("/stream");
  17981. auto elapsed = std::chrono::duration_cast<std::chrono::milliseconds>(
  17982. std::chrono::steady_clock::now() - start)
  17983. .count();
  17984. ASSERT_FALSE(res);
  17985. EXPECT_EQ(Error::Read, res.error());
  17986. EXPECT_TRUE(timeout <= elapsed && elapsed < timeout + threshold)
  17987. << "Timeout exceeded by " << (elapsed - timeout) << "ms";
  17988. }
  17989. {
  17990. auto start = std::chrono::steady_clock::now();
  17991. auto res = cli.Get("/stream_without_length");
  17992. auto elapsed = std::chrono::duration_cast<std::chrono::milliseconds>(
  17993. std::chrono::steady_clock::now() - start)
  17994. .count();
  17995. ASSERT_FALSE(res);
  17996. EXPECT_EQ(Error::Read, res.error());
  17997. EXPECT_TRUE(timeout <= elapsed && elapsed < timeout + threshold)
  17998. << "Timeout exceeded by " << (elapsed - timeout) << "ms";
  17999. }
  18000. {
  18001. auto start = std::chrono::steady_clock::now();
  18002. auto res = cli.Get("/chunked", [&](const char *data, size_t data_length) {
  18003. EXPECT_EQ("abcd", string(data, data_length));
  18004. return true;
  18005. });
  18006. auto elapsed = std::chrono::duration_cast<std::chrono::milliseconds>(
  18007. std::chrono::steady_clock::now() - start)
  18008. .count();
  18009. ASSERT_FALSE(res);
  18010. EXPECT_EQ(Error::Read, res.error());
  18011. EXPECT_TRUE(timeout <= elapsed && elapsed < timeout + threshold)
  18012. << "Timeout exceeded by " << (elapsed - timeout) << "ms";
  18013. }
  18014. }
  18015. TEST(MaxTimeoutTest, ContentStream) {
  18016. time_t timeout = 2000;
  18017. time_t threshold = 200;
  18018. Server svr;
  18019. Client cli("localhost", PORT);
  18020. max_timeout_test(svr, cli, timeout, threshold);
  18021. }
  18022. #ifdef CPPHTTPLIB_SSL_ENABLED
  18023. TEST(MaxTimeoutTest, ContentStreamSSL) {
  18024. time_t timeout = 2000;
  18025. time_t threshold = 1200; // SSL_shutdown is slow on some operating systems.
  18026. SSLServer svr(SERVER_CERT_FILE, SERVER_PRIVATE_KEY_FILE);
  18027. SSLClient cli("localhost", PORT);
  18028. cli.enable_server_certificate_verification(false);
  18029. max_timeout_test(svr, cli, timeout, threshold);
  18030. }
  18031. #endif
  18032. class EventDispatcher {
  18033. public:
  18034. EventDispatcher() {}
  18035. bool wait_event(DataSink *sink) {
  18036. unique_lock<mutex> lk(m_);
  18037. int id = id_;
  18038. // Wait with timeout to prevent hanging if client disconnects
  18039. if (!cv_.wait_for(lk, std::chrono::seconds(5),
  18040. [&] { return cid_ == id; })) {
  18041. return false; // Timeout occurred
  18042. }
  18043. sink->write(message_.data(), message_.size());
  18044. return true;
  18045. }
  18046. void send_event(const string &message) {
  18047. lock_guard<mutex> lk(m_);
  18048. cid_ = id_++;
  18049. message_ = message;
  18050. cv_.notify_all();
  18051. }
  18052. private:
  18053. mutex m_;
  18054. condition_variable cv_;
  18055. atomic_int id_{0};
  18056. atomic_int cid_{-1};
  18057. string message_;
  18058. };
  18059. TEST(ClientInThreadTest, Issue2068) {
  18060. EventDispatcher ed;
  18061. Server svr;
  18062. svr.Get("/event1", [&](const Request & /*req*/, Response &res) {
  18063. res.set_chunked_content_provider("text/event-stream",
  18064. [&](size_t /*offset*/, DataSink &sink) {
  18065. return ed.wait_event(&sink);
  18066. });
  18067. });
  18068. auto listen_thread = std::thread([&svr]() { svr.listen(HOST, PORT); });
  18069. svr.wait_until_ready();
  18070. thread event_thread([&] {
  18071. int id = 0;
  18072. while (svr.is_running()) {
  18073. this_thread::sleep_for(chrono::milliseconds(500));
  18074. std::stringstream ss;
  18075. ss << "data: " << id << "\n\n";
  18076. ed.send_event(ss.str());
  18077. id++;
  18078. }
  18079. });
  18080. auto se = detail::scope_exit([&] {
  18081. svr.stop();
  18082. listen_thread.join();
  18083. event_thread.join();
  18084. ASSERT_FALSE(svr.is_running());
  18085. });
  18086. {
  18087. auto client = detail::make_unique<Client>(HOST, PORT);
  18088. client->set_read_timeout(std::chrono::minutes(10));
  18089. std::atomic<bool> stop{false};
  18090. std::thread t([&] {
  18091. client->Get("/event1",
  18092. [&](const char *, size_t) -> bool { return !stop; });
  18093. });
  18094. std::this_thread::sleep_for(std::chrono::seconds(2));
  18095. stop = true;
  18096. client->stop();
  18097. t.join();
  18098. // Reset client after thread has finished
  18099. client.reset();
  18100. }
  18101. }
  18102. TEST(RequestSmugglingTest, DuplicateContentLengthDifferentValues) {
  18103. auto handled = false;
  18104. Server svr;
  18105. svr.Post("/test", [&](const Request &, Response &) { handled = true; });
  18106. thread t = thread([&]() { svr.listen(HOST, PORT); });
  18107. auto se = detail::scope_exit([&] {
  18108. svr.stop();
  18109. t.join();
  18110. ASSERT_FALSE(svr.is_running());
  18111. ASSERT_FALSE(handled);
  18112. });
  18113. svr.wait_until_ready();
  18114. // Two Content-Length headers with different values — must be rejected
  18115. auto req = "POST /test HTTP/1.1\r\n"
  18116. "Content-Length: 5\r\n"
  18117. "Content-Length: 10\r\n"
  18118. "\r\n"
  18119. "hello";
  18120. std::string response;
  18121. ASSERT_TRUE(send_request(1, req, &response));
  18122. ASSERT_EQ("HTTP/1.1 400 Bad Request",
  18123. response.substr(0, response.find("\r\n")));
  18124. }
  18125. TEST(RequestSmugglingTest, DuplicateContentLengthSameValues) {
  18126. auto handled = false;
  18127. Server svr;
  18128. svr.Post("/test", [&](const Request &, Response &res) {
  18129. handled = true;
  18130. res.set_content("ok", "text/plain");
  18131. });
  18132. thread t = thread([&]() { svr.listen(HOST, PORT); });
  18133. auto se = detail::scope_exit([&] {
  18134. svr.stop();
  18135. t.join();
  18136. ASSERT_FALSE(svr.is_running());
  18137. ASSERT_TRUE(handled);
  18138. });
  18139. svr.wait_until_ready();
  18140. // Two Content-Length headers with same value — should be accepted (RFC 9110)
  18141. auto req = "POST /test HTTP/1.1\r\n"
  18142. "Host: localhost\r\n"
  18143. "Content-Length: 5\r\n"
  18144. "Content-Length: 5\r\n"
  18145. "\r\n"
  18146. "hello";
  18147. std::string response;
  18148. ASSERT_TRUE(send_request(1, req, &response));
  18149. ASSERT_EQ("HTTP/1.1 200 OK", response.substr(0, response.find("\r\n")));
  18150. }
  18151. TEST(HostHeaderValidationTest, AmbiguousOrInvalidHostRejected) {
  18152. Server svr;
  18153. svr.Get("/test", [](const Request &, Response &res) {
  18154. res.set_content("ok", "text/plain");
  18155. });
  18156. auto port = svr.bind_to_any_port(HOST);
  18157. thread t = thread([&] { svr.listen_after_bind(); });
  18158. auto se = detail::scope_exit([&] {
  18159. svr.stop();
  18160. t.join();
  18161. ASSERT_FALSE(svr.is_running());
  18162. });
  18163. svr.wait_until_ready();
  18164. auto status_line = [&](const std::string &host_lines) {
  18165. std::string res;
  18166. send_request(
  18167. 5, "GET /test HTTP/1.1\r\n" + host_lines + "Connection: close\r\n\r\n",
  18168. &res, port);
  18169. return res.substr(0, res.find("\r\n"));
  18170. };
  18171. const char *accepted[] = {
  18172. "Host: localhost\r\n",
  18173. "Host: a.example:8080\r\n",
  18174. "Host: my_service\r\n",
  18175. "Host: [::1]:8080\r\n",
  18176. "Host: [fe80::1%25eth0]\r\n",
  18177. "Host: \r\n", // RFC 9112 §3.2: the target URI has no authority
  18178. };
  18179. for (auto host_lines : accepted) {
  18180. EXPECT_EQ("HTTP/1.1 200 OK", status_line(host_lines)) << host_lines;
  18181. }
  18182. const char *rejected[] = {
  18183. "Host: a.example\r\nHost: b.example\r\n",
  18184. "Host: a.example\r\nHost: a.example\r\n",
  18185. "Host: a@b.example\r\n",
  18186. "Host: a.example/b\r\n",
  18187. "Host: a.example\\b\r\n",
  18188. "Host: a.example?b\r\n",
  18189. "Host: a.example#b\r\n",
  18190. "Host: a.example b.example\r\n",
  18191. };
  18192. for (auto host_lines : rejected) {
  18193. EXPECT_EQ("HTTP/1.1 400 Bad Request", status_line(host_lines))
  18194. << host_lines;
  18195. }
  18196. }
  18197. TEST(HeaderSmugglingTest, ChunkedTrailerHeadersMerged) {
  18198. Server svr;
  18199. svr.Get("/", [](const Request &req, Response &res) {
  18200. EXPECT_EQ(2U, req.trailers.size());
  18201. EXPECT_FALSE(req.has_trailer("[invalid key...]"));
  18202. // Denied
  18203. EXPECT_FALSE(req.has_trailer("Content-Length"));
  18204. EXPECT_FALSE(req.has_trailer("X-Forwarded-For"));
  18205. // Accepted
  18206. EXPECT_TRUE(req.has_trailer("X-Hello"));
  18207. EXPECT_EQ(req.get_trailer_value("X-Hello"), "hello");
  18208. EXPECT_TRUE(req.has_trailer("X-World"));
  18209. EXPECT_EQ(req.get_trailer_value("X-World"), "world");
  18210. res.set_content("ok", "text/plain");
  18211. });
  18212. thread t = thread([&]() { svr.listen(HOST, PORT); });
  18213. auto se = detail::scope_exit([&] {
  18214. svr.stop();
  18215. t.join();
  18216. ASSERT_FALSE(svr.is_running());
  18217. });
  18218. svr.wait_until_ready();
  18219. const std::string req = "GET / HTTP/1.1\r\n"
  18220. "Transfer-Encoding: chunked\r\n"
  18221. "Trailer: X-Hello, X-World, X-AAA, X-BBB\r\n"
  18222. "\r\n"
  18223. "0\r\n"
  18224. "Content-Length: 10\r\n"
  18225. "Host: internal.local\r\n"
  18226. "Content-Type: malicious/content\r\n"
  18227. "Cookie: any\r\n"
  18228. "Set-Cookie: any\r\n"
  18229. "X-Forwarded-For: attacker.com\r\n"
  18230. "X-Real-Ip: 1.1.1.1\r\n"
  18231. "X-Hello: hello\r\n"
  18232. "X-World: world\r\n"
  18233. "\r\n";
  18234. std::string res;
  18235. ASSERT_TRUE(send_request(1, req, &res));
  18236. }
  18237. // RFC 9110 Section 5.2 and 5.3: a comma-separated list field may be sent as
  18238. // several field lines, and the combined value is what has to be parsed. A
  18239. // Trailer field split across lines therefore declares every name it lists;
  18240. // reading only the first line silently drops the trailers the later lines
  18241. // declare. The prohibited-trailer filter still applies to every line.
  18242. TEST(HeaderSmugglingTest, DuplicateTrailerFieldLinesDeclareAllTrailers) {
  18243. Server svr;
  18244. size_t observed_trailer_count = 0;
  18245. std::string observed_hello;
  18246. std::string observed_world;
  18247. bool observed_content_length = true;
  18248. svr.Get("/", [&](const Request &req, Response &res) {
  18249. observed_trailer_count = req.trailers.size();
  18250. observed_hello = req.get_trailer_value("X-Hello");
  18251. observed_world = req.get_trailer_value("X-World");
  18252. observed_content_length = req.has_trailer("Content-Length");
  18253. res.set_content("ok", "text/plain");
  18254. });
  18255. auto port = svr.bind_to_any_port(HOST);
  18256. thread t = thread([&]() { svr.listen_after_bind(); });
  18257. auto se = detail::scope_exit([&] {
  18258. svr.stop();
  18259. t.join();
  18260. ASSERT_FALSE(svr.is_running());
  18261. });
  18262. svr.wait_until_ready();
  18263. const std::string req = "GET / HTTP/1.1\r\n"
  18264. "Host: localhost\r\n"
  18265. "Transfer-Encoding: chunked\r\n"
  18266. "Trailer: X-Hello\r\n"
  18267. "Trailer: X-World, Content-Length\r\n"
  18268. "\r\n"
  18269. "0\r\n"
  18270. "X-Hello: hello\r\n"
  18271. "X-World: world\r\n"
  18272. "Content-Length: 10\r\n"
  18273. "\r\n";
  18274. std::string res;
  18275. ASSERT_TRUE(send_request(1, req, &res, port));
  18276. EXPECT_EQ("HTTP/1.1 200 OK", res.substr(0, 15));
  18277. // Accepted: both field lines contribute to the declared set
  18278. EXPECT_EQ(2U, observed_trailer_count);
  18279. EXPECT_EQ(observed_hello, "hello");
  18280. EXPECT_EQ(observed_world, "world");
  18281. // Denied: a prohibited name stays prohibited on a later field line
  18282. EXPECT_FALSE(observed_content_length);
  18283. }
  18284. // Undeclared trailer fields must count toward the trailer limit too. Otherwise
  18285. // a peer can keep the trailer-parsing loop running indefinitely by sending an
  18286. // unbounded run of fields that are never declared, because the counter would
  18287. // only advance for declared fields.
  18288. TEST(HeaderSmugglingTest, UndeclaredTrailerFieldsCountTowardLimit) {
  18289. Server svr;
  18290. bool handler_called = false;
  18291. svr.Get("/", [&](const Request & /*req*/, Response &res) {
  18292. handler_called = true;
  18293. res.set_content("ok", "text/plain");
  18294. });
  18295. auto port = svr.bind_to_any_port(HOST);
  18296. thread t = thread([&]() { svr.listen_after_bind(); });
  18297. auto se = detail::scope_exit([&] {
  18298. svr.stop();
  18299. t.join();
  18300. ASSERT_FALSE(svr.is_running());
  18301. });
  18302. svr.wait_until_ready();
  18303. // Declare nothing, then send far more undeclared trailer fields than the
  18304. // header-count limit. Parsing must stop and reject the request rather than
  18305. // read every line.
  18306. std::string req = "GET / HTTP/1.1\r\n"
  18307. "Transfer-Encoding: chunked\r\n"
  18308. "\r\n"
  18309. "0\r\n";
  18310. for (int i = 0; i < CPPHTTPLIB_HEADER_MAX_COUNT + 10; i++) {
  18311. req += "X-Undeclared-" + std::to_string(i) + ": v\r\n";
  18312. }
  18313. req += "\r\n";
  18314. std::string res;
  18315. ASSERT_TRUE(send_request(1, req, &res, port));
  18316. // The request is rejected before the handler runs.
  18317. EXPECT_FALSE(handler_called);
  18318. EXPECT_EQ("HTTP/1.1 400 Bad Request", res.substr(0, res.find("\r\n")));
  18319. }
  18320. // The set of declared trailer names is capped so a peer cannot grow it without
  18321. // bound (an unkeyed hash set would otherwise be a hash-flooding target). A name
  18322. // declared past the cap is not honored, even if the field is actually sent.
  18323. TEST(HeaderSmugglingTest, DeclaredTrailerNamesAreCappedAtHeaderMaxCount) {
  18324. Server svr;
  18325. // One name inside the cap and one past it, so the test tracks the cap rather
  18326. // than a fixed count.
  18327. constexpr int declared_count = CPPHTTPLIB_HEADER_MAX_COUNT + 50;
  18328. const std::string within_cap_name = "X-T-0";
  18329. const std::string past_cap_name = "X-T-" + std::to_string(declared_count - 1);
  18330. bool observed_within_cap = false;
  18331. bool observed_past_cap = false;
  18332. svr.Get("/", [&](const Request &req, Response &res) {
  18333. observed_within_cap = req.has_trailer(within_cap_name);
  18334. observed_past_cap = req.has_trailer(past_cap_name);
  18335. res.set_content("ok", "text/plain");
  18336. });
  18337. auto port = svr.bind_to_any_port(HOST);
  18338. thread t = thread([&]() { svr.listen_after_bind(); });
  18339. auto se = detail::scope_exit([&] {
  18340. svr.stop();
  18341. t.join();
  18342. ASSERT_FALSE(svr.is_running());
  18343. });
  18344. svr.wait_until_ready();
  18345. // Declare more trailer names than the cap in a single Trailer field, then
  18346. // actually send the first (within the cap) and the last (past it).
  18347. std::string trailer_decl = "Trailer: ";
  18348. for (int i = 0; i < declared_count; i++) {
  18349. if (i != 0) { trailer_decl += ", "; }
  18350. trailer_decl += "X-T-" + std::to_string(i);
  18351. }
  18352. trailer_decl += "\r\n";
  18353. const std::string req = "GET / HTTP/1.1\r\n"
  18354. "Host: localhost\r\n"
  18355. "Transfer-Encoding: chunked\r\n" +
  18356. trailer_decl +
  18357. "\r\n"
  18358. "0\r\n" +
  18359. within_cap_name + ": a\r\n" + past_cap_name +
  18360. ": b\r\n"
  18361. "\r\n";
  18362. std::string res;
  18363. ASSERT_TRUE(send_request(1, req, &res, port));
  18364. EXPECT_EQ("HTTP/1.1 200 OK", res.substr(0, res.find("\r\n")));
  18365. // A name within the cap is honored; one declared past the cap is dropped.
  18366. EXPECT_TRUE(observed_within_cap);
  18367. EXPECT_FALSE(observed_past_cap);
  18368. }
  18369. // A direct client that is not listed in trusted_proxies must not be able to
  18370. // spoof req.remote_addr by sending an arbitrary X-Forwarded-For header. Only
  18371. // the peer address on the actual TCP connection determines whether the
  18372. // header is honored.
  18373. TEST(ForwardedHeadersTest, UntrustedDirectClientCannotSpoofXFF) {
  18374. Server svr;
  18375. // Deliberately does NOT include the loopback address the test client
  18376. // actually connects from, so the direct connection is not a trusted proxy.
  18377. svr.set_trusted_proxies({"203.0.113.66"});
  18378. std::string observed_remote_addr;
  18379. svr.Get("/ip", [&](const Request &req, Response &res) {
  18380. observed_remote_addr = req.remote_addr;
  18381. res.set_content("ok", "text/plain");
  18382. });
  18383. thread t = thread([&]() { svr.listen(HOST, PORT); });
  18384. auto se = detail::scope_exit([&] {
  18385. svr.stop();
  18386. t.join();
  18387. ASSERT_FALSE(svr.is_running());
  18388. });
  18389. svr.wait_until_ready();
  18390. Client cli(HOST, PORT);
  18391. auto res = cli.Get("/ip", Headers{{"X-Forwarded-For", "9.9.9.9"}});
  18392. ASSERT_TRUE(res) << "Error: " << to_string(res.error());
  18393. EXPECT_EQ(StatusCode::OK_200, res->status);
  18394. // The connecting peer is not a trusted proxy, so the spoofed header must be
  18395. // ignored entirely and the real connection-level address retained.
  18396. EXPECT_TRUE(observed_remote_addr == "::1" ||
  18397. observed_remote_addr == "127.0.0.1");
  18398. }
  18399. TEST(ForwardedHeadersTest, NoProxiesSetting) {
  18400. Server svr;
  18401. std::string observed_remote_addr;
  18402. std::string observed_xff;
  18403. svr.Get("/ip", [&](const Request &req, Response &res) {
  18404. observed_remote_addr = req.remote_addr;
  18405. observed_xff = req.get_header_value("X-Forwarded-For");
  18406. res.set_content("ok", "text/plain");
  18407. });
  18408. thread t = thread([&]() { svr.listen(HOST, PORT); });
  18409. auto se = detail::scope_exit([&] {
  18410. svr.stop();
  18411. t.join();
  18412. ASSERT_FALSE(svr.is_running());
  18413. });
  18414. svr.wait_until_ready();
  18415. Client cli(HOST, PORT);
  18416. auto res = cli.Get("/ip", Headers{{"X-Forwarded-For", "203.0.113.66"}});
  18417. ASSERT_TRUE(res) << "Error: " << to_string(res.error());
  18418. EXPECT_EQ(StatusCode::OK_200, res->status);
  18419. EXPECT_EQ(observed_xff, "203.0.113.66");
  18420. EXPECT_TRUE(observed_remote_addr == "::1" ||
  18421. observed_remote_addr == "127.0.0.1");
  18422. }
  18423. TEST(ForwardedHeadersTest, NoForwardedHeaders) {
  18424. Server svr;
  18425. svr.set_trusted_proxies({"203.0.113.66"});
  18426. std::string observed_remote_addr;
  18427. std::string observed_xff;
  18428. svr.Get("/ip", [&](const Request &req, Response &res) {
  18429. observed_remote_addr = req.remote_addr;
  18430. observed_xff = req.get_header_value("X-Forwarded-For");
  18431. res.set_content("ok", "text/plain");
  18432. });
  18433. thread t = thread([&]() { svr.listen(HOST, PORT); });
  18434. auto se = detail::scope_exit([&] {
  18435. svr.stop();
  18436. t.join();
  18437. ASSERT_FALSE(svr.is_running());
  18438. });
  18439. svr.wait_until_ready();
  18440. Client cli(HOST, PORT);
  18441. auto res = cli.Get("/ip");
  18442. ASSERT_TRUE(res) << "Error: " << to_string(res.error());
  18443. EXPECT_EQ(StatusCode::OK_200, res->status);
  18444. EXPECT_EQ(observed_xff, "");
  18445. EXPECT_TRUE(observed_remote_addr == "::1" ||
  18446. observed_remote_addr == "127.0.0.1");
  18447. }
  18448. TEST(ForwardedHeadersTest, SingleTrustedProxy_UsesIPBeforeTrusted) {
  18449. Server svr;
  18450. // Include the loopback address the test client actually connects from, so
  18451. // the direct connection itself is recognized as the trusted proxy hop.
  18452. svr.set_trusted_proxies({"203.0.113.66", "::1", "127.0.0.1"});
  18453. std::string observed_remote_addr;
  18454. std::string observed_xff;
  18455. svr.Get("/ip", [&](const Request &req, Response &res) {
  18456. observed_remote_addr = req.remote_addr;
  18457. observed_xff = req.get_header_value("X-Forwarded-For");
  18458. res.set_content("ok", "text/plain");
  18459. });
  18460. thread t = thread([&]() { svr.listen(HOST, PORT); });
  18461. auto se = detail::scope_exit([&] {
  18462. svr.stop();
  18463. t.join();
  18464. ASSERT_FALSE(svr.is_running());
  18465. });
  18466. svr.wait_until_ready();
  18467. Client cli(HOST, PORT);
  18468. auto res = cli.Get(
  18469. "/ip", Headers{{"X-Forwarded-For", "198.51.100.23, 203.0.113.66"}});
  18470. ASSERT_TRUE(res) << "Error: " << to_string(res.error());
  18471. EXPECT_EQ(StatusCode::OK_200, res->status);
  18472. EXPECT_EQ(observed_xff, "198.51.100.23, 203.0.113.66");
  18473. EXPECT_EQ(observed_remote_addr, "198.51.100.23");
  18474. }
  18475. TEST(ForwardedHeadersTest, MultipleTrustedProxies_UsesClientIP) {
  18476. Server svr;
  18477. svr.set_trusted_proxies({"203.0.113.66", "192.0.2.45", "::1", "127.0.0.1"});
  18478. std::string observed_remote_addr;
  18479. std::string observed_xff;
  18480. svr.Get("/ip", [&](const Request &req, Response &res) {
  18481. observed_remote_addr = req.remote_addr;
  18482. observed_xff = req.get_header_value("X-Forwarded-For");
  18483. res.set_content("ok", "text/plain");
  18484. });
  18485. thread t = thread([&]() { svr.listen(HOST, PORT); });
  18486. auto se = detail::scope_exit([&] {
  18487. svr.stop();
  18488. t.join();
  18489. ASSERT_FALSE(svr.is_running());
  18490. });
  18491. svr.wait_until_ready();
  18492. Client cli(HOST, PORT);
  18493. auto res = cli.Get(
  18494. "/ip",
  18495. Headers{{"X-Forwarded-For", "198.51.100.23, 203.0.113.66, 192.0.2.45"}});
  18496. ASSERT_TRUE(res) << "Error: " << to_string(res.error());
  18497. EXPECT_EQ(StatusCode::OK_200, res->status);
  18498. EXPECT_EQ(observed_xff, "198.51.100.23, 203.0.113.66, 192.0.2.45");
  18499. EXPECT_EQ(observed_remote_addr, "198.51.100.23");
  18500. }
  18501. TEST(ForwardedHeadersTest, TrustedProxyNotInHeader_UsesRightmostIP) {
  18502. Server svr;
  18503. svr.set_trusted_proxies({"192.0.2.45", "::1", "127.0.0.1"});
  18504. std::string observed_remote_addr;
  18505. std::string observed_xff;
  18506. svr.Get("/ip", [&](const Request &req, Response &res) {
  18507. observed_remote_addr = req.remote_addr;
  18508. observed_xff = req.get_header_value("X-Forwarded-For");
  18509. res.set_content("ok", "text/plain");
  18510. });
  18511. thread t = thread([&]() { svr.listen(HOST, PORT); });
  18512. auto se = detail::scope_exit([&] {
  18513. svr.stop();
  18514. t.join();
  18515. ASSERT_FALSE(svr.is_running());
  18516. });
  18517. svr.wait_until_ready();
  18518. Client cli(HOST, PORT);
  18519. auto res = cli.Get(
  18520. "/ip", Headers{{"X-Forwarded-For", "198.51.100.23, 198.51.100.24"}});
  18521. ASSERT_TRUE(res) << "Error: " << to_string(res.error());
  18522. EXPECT_EQ(StatusCode::OK_200, res->status);
  18523. // No listed hop is a trusted proxy, so the rightmost entry (the one written
  18524. // by the closest hop) is used. The leftmost entry is fully client-controlled
  18525. // and must not be selected.
  18526. EXPECT_EQ(observed_xff, "198.51.100.23, 198.51.100.24");
  18527. EXPECT_EQ(observed_remote_addr, "198.51.100.24");
  18528. }
  18529. TEST(ForwardedHeadersTest, SpoofedIPBeforeTrustedProxyIsIgnored) {
  18530. Server svr;
  18531. svr.set_trusted_proxies({"10.0.0.1", "::1", "127.0.0.1"});
  18532. std::string observed_remote_addr;
  18533. svr.Get("/ip", [&](const Request &req, Response &res) {
  18534. observed_remote_addr = req.remote_addr;
  18535. res.set_content("ok", "text/plain");
  18536. });
  18537. thread t = thread([&]() { svr.listen(HOST, PORT); });
  18538. auto se = detail::scope_exit([&] {
  18539. svr.stop();
  18540. t.join();
  18541. ASSERT_FALSE(svr.is_running());
  18542. });
  18543. svr.wait_until_ready();
  18544. // The trusted proxy appends the address it saw (5.6.7.8). The client prepends
  18545. // a forged address and the trusted proxy's own address; the forged value must
  18546. // not win over the address the trusted proxy actually recorded.
  18547. Client cli(HOST, PORT);
  18548. auto res = cli.Get(
  18549. "/ip", Headers{{"X-Forwarded-For", "1.2.3.4, 10.0.0.1, 5.6.7.8"}});
  18550. ASSERT_TRUE(res) << "Error: " << to_string(res.error());
  18551. EXPECT_EQ(StatusCode::OK_200, res->status);
  18552. EXPECT_EQ(observed_remote_addr, "5.6.7.8");
  18553. }
  18554. TEST(ForwardedHeadersTest, LastHopTrusted_SelectsImmediateLeftIP) {
  18555. Server svr;
  18556. svr.set_trusted_proxies({"192.0.2.45", "::1", "127.0.0.1"});
  18557. std::string observed_remote_addr;
  18558. std::string observed_xff;
  18559. svr.Get("/ip", [&](const Request &req, Response &res) {
  18560. observed_remote_addr = req.remote_addr;
  18561. observed_xff = req.get_header_value("X-Forwarded-For");
  18562. res.set_content("ok", "text/plain");
  18563. });
  18564. thread t = thread([&]() { svr.listen(HOST, PORT); });
  18565. auto se = detail::scope_exit([&] {
  18566. svr.stop();
  18567. t.join();
  18568. ASSERT_FALSE(svr.is_running());
  18569. });
  18570. svr.wait_until_ready();
  18571. Client cli(HOST, PORT);
  18572. auto res = cli.Get(
  18573. "/ip",
  18574. Headers{{"X-Forwarded-For", "198.51.100.23, 203.0.113.66, 192.0.2.45"}});
  18575. ASSERT_TRUE(res) << "Error: " << to_string(res.error());
  18576. EXPECT_EQ(StatusCode::OK_200, res->status);
  18577. EXPECT_EQ(observed_xff, "198.51.100.23, 203.0.113.66, 192.0.2.45");
  18578. EXPECT_EQ(observed_remote_addr, "203.0.113.66");
  18579. }
  18580. TEST(ForwardedHeadersTest, HandlesWhitespaceAroundIPs) {
  18581. Server svr;
  18582. svr.set_trusted_proxies({"192.0.2.45", "::1", "127.0.0.1"});
  18583. std::string observed_remote_addr;
  18584. std::string observed_xff;
  18585. svr.Get("/ip", [&](const Request &req, Response &res) {
  18586. observed_remote_addr = req.remote_addr;
  18587. observed_xff = req.get_header_value("X-Forwarded-For");
  18588. res.set_content("ok", "text/plain");
  18589. });
  18590. thread t = thread([&]() { svr.listen(HOST, PORT); });
  18591. auto se = detail::scope_exit([&] {
  18592. svr.stop();
  18593. t.join();
  18594. ASSERT_FALSE(svr.is_running());
  18595. });
  18596. svr.wait_until_ready();
  18597. std::string raw_req =
  18598. "GET /ip HTTP/1.1\r\n"
  18599. "Host: localhost\r\n"
  18600. "X-Forwarded-For: 198.51.100.23 , 203.0.113.66 , 192.0.2.45 \r\n"
  18601. "Connection: close\r\n"
  18602. "\r\n";
  18603. std::string out;
  18604. ASSERT_TRUE(send_request(5, raw_req, &out));
  18605. EXPECT_EQ("HTTP/1.1 200 OK", out.substr(0, 15));
  18606. // Header parser trims surrounding whitespace of the header value
  18607. EXPECT_EQ(observed_xff, "198.51.100.23 , 203.0.113.66 , 192.0.2.45");
  18608. EXPECT_EQ(observed_remote_addr, "203.0.113.66");
  18609. }
  18610. // RFC 9110 Section 5.2 and 5.3: repeated field lines carry the same meaning as
  18611. // one comma-joined value, in the order received. Proxies such as HAProxy append
  18612. // their own X-Forwarded-For as a separate field line rather than extending the
  18613. // one the client sent, so every occurrence has to be taken into account.
  18614. // Reading only the first one hands back the address the client chose.
  18615. TEST(ForwardedHeadersTest, DuplicateFieldLines_JoinsAllOccurrences) {
  18616. Server svr;
  18617. svr.set_trusted_proxies({"192.0.2.45", "::1", "127.0.0.1"});
  18618. std::string observed_remote_addr;
  18619. size_t observed_xff_count = 0;
  18620. svr.Get("/ip", [&](const Request &req, Response &res) {
  18621. observed_remote_addr = req.remote_addr;
  18622. observed_xff_count = req.get_header_value_count("X-Forwarded-For");
  18623. res.set_content("ok", "text/plain");
  18624. });
  18625. auto port = svr.bind_to_any_port(HOST);
  18626. thread t = thread([&]() { svr.listen_after_bind(); });
  18627. auto se = detail::scope_exit([&] {
  18628. svr.stop();
  18629. t.join();
  18630. ASSERT_FALSE(svr.is_running());
  18631. });
  18632. svr.wait_until_ready();
  18633. // The client supplies the first field line; the trusted proxy appends the
  18634. // address it observed as a second one.
  18635. std::string raw_req = "GET /ip HTTP/1.1\r\n"
  18636. "Host: localhost\r\n"
  18637. "X-Forwarded-For: 1.2.3.4\r\n"
  18638. "X-Forwarded-For: 198.51.100.23, 192.0.2.45\r\n"
  18639. "Connection: close\r\n"
  18640. "\r\n";
  18641. std::string out;
  18642. ASSERT_TRUE(send_request(5, raw_req, &out, port));
  18643. EXPECT_EQ("HTTP/1.1 200 OK", out.substr(0, 15));
  18644. EXPECT_EQ(observed_xff_count, 2U);
  18645. EXPECT_EQ(observed_remote_addr, "198.51.100.23");
  18646. // The same chain spread over one field line per hop derives the same client
  18647. // address, i.e. the split and the comma-joined representations agree.
  18648. std::string per_hop_req = "GET /ip HTTP/1.1\r\n"
  18649. "Host: localhost\r\n"
  18650. "X-Forwarded-For: 1.2.3.4\r\n"
  18651. "X-Forwarded-For: 198.51.100.23\r\n"
  18652. "X-Forwarded-For: 192.0.2.45\r\n"
  18653. "Connection: close\r\n"
  18654. "\r\n";
  18655. out.clear();
  18656. ASSERT_TRUE(send_request(5, per_hop_req, &out, port));
  18657. EXPECT_EQ("HTTP/1.1 200 OK", out.substr(0, 15));
  18658. EXPECT_EQ(observed_xff_count, 3U);
  18659. EXPECT_EQ(observed_remote_addr, "198.51.100.23");
  18660. }
  18661. // An X-Forwarded-For header whose value parses to zero IP segments must not
  18662. // crash the server (it used to call front() on an empty vector inside
  18663. // get_client_ip). The connection-level remote address must be retained instead.
  18664. static void run_malformed_xff_test(const std::string &xff_value) {
  18665. Server svr;
  18666. svr.set_trusted_proxies({"192.0.2.45"});
  18667. std::string observed_remote_addr;
  18668. svr.Get("/ip", [&](const Request &req, Response &res) {
  18669. observed_remote_addr = req.remote_addr;
  18670. res.set_content("ok", "text/plain");
  18671. });
  18672. int port = 0;
  18673. thread t = thread([&]() {
  18674. port = svr.bind_to_any_port(HOST);
  18675. svr.listen_after_bind();
  18676. });
  18677. auto se = detail::scope_exit([&] {
  18678. svr.stop();
  18679. t.join();
  18680. ASSERT_FALSE(svr.is_running());
  18681. });
  18682. svr.wait_until_ready();
  18683. Client cli(HOST, port);
  18684. auto res = cli.Get("/ip", Headers{{"X-Forwarded-For", xff_value}});
  18685. ASSERT_TRUE(res) << "Error: " << to_string(res.error());
  18686. EXPECT_EQ(StatusCode::OK_200, res->status);
  18687. EXPECT_TRUE(observed_remote_addr == "::1" ||
  18688. observed_remote_addr == "127.0.0.1");
  18689. }
  18690. TEST(ForwardedHeadersTest, EmptyXForwardedFor_DoesNotCrash) {
  18691. run_malformed_xff_test("");
  18692. }
  18693. TEST(ForwardedHeadersTest, CommaOnlyXForwardedFor_DoesNotCrash) {
  18694. run_malformed_xff_test(",");
  18695. }
  18696. TEST(ForwardedHeadersTest, MultipleCommasXForwardedFor_DoesNotCrash) {
  18697. run_malformed_xff_test(", , ,");
  18698. }
  18699. // The same rule applies to Accept: a request whose acceptable types are spread
  18700. // over several field lines must be negotiated against all of them.
  18701. // RFC 9110 Section 7.6.1: Connection carries a comma-separated list of
  18702. // case-insensitive connection options. Comparing the whole field value against
  18703. // one option misses a client that sends several of them, and misses every
  18704. // casing but the one written in the comparison.
  18705. //
  18706. // Sends req, reads the response, then reuses the same socket for a second
  18707. // request to find out whether the server kept the connection.
  18708. static void probe_connection_reuse(int port, const std::string &req,
  18709. bool *announced_close, bool *reusable) {
  18710. auto error = Error::Success;
  18711. auto sock = detail::create_client_socket(
  18712. HOST, "", port, AF_UNSPEC, false, false, nullptr,
  18713. /*connection_timeout_sec=*/5, 0,
  18714. /*read_timeout_sec=*/1, 0,
  18715. /*write_timeout_sec=*/5, 0, std::string(), error);
  18716. ASSERT_NE(sock, INVALID_SOCKET);
  18717. auto se = detail::scope_exit([&] { detail::close_socket(sock); });
  18718. const std::string second = "GET /keepalive HTTP/1.1\r\n"
  18719. "Host: localhost\r\n"
  18720. "Connection: close\r\n"
  18721. "\r\n";
  18722. std::string first_response;
  18723. std::string second_response;
  18724. detail::process_client_socket(
  18725. sock, 1, 0, 5, 0, 0, std::chrono::steady_clock::time_point::min(),
  18726. [&](Stream &strm) {
  18727. if (strm.write(req.data(), req.size()) !=
  18728. static_cast<ssize_t>(req.size())) {
  18729. return false;
  18730. }
  18731. char buf[512];
  18732. detail::stream_line_reader reader(strm, buf, sizeof(buf));
  18733. // Headers plus the two-byte body of the handler below
  18734. while (reader.getline()) {
  18735. first_response += reader.ptr();
  18736. if (first_response.find("ok") != std::string::npos) { break; }
  18737. }
  18738. if (strm.write(second.data(), second.size()) !=
  18739. static_cast<ssize_t>(second.size())) {
  18740. return true;
  18741. }
  18742. detail::stream_line_reader reader2(strm, buf, sizeof(buf));
  18743. while (reader2.getline()) {
  18744. second_response += reader2.ptr();
  18745. if (second_response.find("ok") != std::string::npos) { break; }
  18746. }
  18747. return true;
  18748. });
  18749. *announced_close =
  18750. first_response.find("Connection: close") != std::string::npos;
  18751. *reusable = second_response.find("HTTP/1.1 200") != std::string::npos;
  18752. }
  18753. class ConnectionTokenTest : public ::testing::Test {
  18754. protected:
  18755. void SetUp() override {
  18756. svr_.Get("/keepalive", [](const Request &, Response &res) {
  18757. res.set_content("ok", "text/plain");
  18758. });
  18759. port_ = svr_.bind_to_any_port(HOST);
  18760. thread_ = thread([&]() { svr_.listen_after_bind(); });
  18761. svr_.wait_until_ready();
  18762. }
  18763. void TearDown() override {
  18764. svr_.stop();
  18765. if (thread_.joinable()) { thread_.join(); }
  18766. }
  18767. Server svr_;
  18768. int port_ = 0;
  18769. thread thread_;
  18770. };
  18771. // "close" alongside another option still closes the connection, and the
  18772. // response says so rather than leaving the peer to discover it.
  18773. TEST_F(ConnectionTokenTest, CloseAmongSeveralOptionsIsHonored) {
  18774. bool announced_close = false;
  18775. bool reusable = true;
  18776. probe_connection_reuse(port_,
  18777. "GET /keepalive HTTP/1.1\r\n"
  18778. "Host: localhost\r\n"
  18779. "Connection: keep-alive, close\r\n"
  18780. "\r\n",
  18781. &announced_close, &reusable);
  18782. EXPECT_TRUE(announced_close);
  18783. EXPECT_FALSE(reusable);
  18784. }
  18785. // "close" split over two field lines is the same list, so it is honored too.
  18786. TEST_F(ConnectionTokenTest, CloseOnALaterFieldLineIsHonored) {
  18787. bool announced_close = false;
  18788. bool reusable = true;
  18789. probe_connection_reuse(port_,
  18790. "GET /keepalive HTTP/1.1\r\n"
  18791. "Host: localhost\r\n"
  18792. "Connection: keep-alive\r\n"
  18793. "Connection: close\r\n"
  18794. "\r\n",
  18795. &announced_close, &reusable);
  18796. EXPECT_TRUE(announced_close);
  18797. EXPECT_FALSE(reusable);
  18798. }
  18799. // Connection options are case-insensitive, so an HTTP/1.0 client asking for
  18800. // keep-alive in the spelling everyone actually sends keeps its connection.
  18801. TEST_F(ConnectionTokenTest, Http10KeepAliveIsCaseInsensitive) {
  18802. bool announced_close = false;
  18803. bool reusable = false;
  18804. probe_connection_reuse(port_,
  18805. "GET /keepalive HTTP/1.0\r\n"
  18806. "Host: localhost\r\n"
  18807. "Connection: keep-alive\r\n"
  18808. "\r\n",
  18809. &announced_close, &reusable);
  18810. EXPECT_FALSE(announced_close);
  18811. EXPECT_TRUE(reusable);
  18812. }
  18813. // A token the value merely contains is not the token itself.
  18814. TEST_F(ConnectionTokenTest, SubstringOfAnOptionIsNotTheOption) {
  18815. bool announced_close = false;
  18816. bool reusable = false;
  18817. probe_connection_reuse(port_,
  18818. "GET /keepalive HTTP/1.1\r\n"
  18819. "Host: localhost\r\n"
  18820. "Connection: notclose\r\n"
  18821. "\r\n",
  18822. &announced_close, &reusable);
  18823. EXPECT_FALSE(announced_close);
  18824. EXPECT_TRUE(reusable);
  18825. }
  18826. TEST(RepeatedFieldLinesTest, AcceptCombinesEveryFieldLine) {
  18827. Server svr;
  18828. std::vector<std::string> observed_types;
  18829. svr.Get("/", [&](const Request &req, Response &res) {
  18830. observed_types = req.accept_content_types;
  18831. res.set_content("ok", "text/plain");
  18832. });
  18833. auto port = svr.bind_to_any_port(HOST);
  18834. thread t = thread([&]() { svr.listen_after_bind(); });
  18835. auto se = detail::scope_exit([&] {
  18836. svr.stop();
  18837. t.join();
  18838. ASSERT_FALSE(svr.is_running());
  18839. });
  18840. svr.wait_until_ready();
  18841. Client cli(HOST, port);
  18842. Headers headers;
  18843. headers.emplace("Accept", "text/plain;q=0.5");
  18844. headers.emplace("Accept", "application/json");
  18845. auto res = cli.Get("/", headers);
  18846. ASSERT_TRUE(res) << "Error: " << to_string(res.error());
  18847. EXPECT_EQ(StatusCode::OK_200, res->status);
  18848. // Sorted by q-value, so the second field line's type comes first
  18849. ASSERT_EQ(2U, observed_types.size());
  18850. EXPECT_EQ("application/json", observed_types[0]);
  18851. EXPECT_EQ("text/plain", observed_types[1]);
  18852. }
  18853. // RFC 9110 Section 5.6.1.2: empty list elements are parsed and ignored, so an
  18854. // empty field line must not contribute a bare comma to the combined value.
  18855. TEST(RepeatedFieldLinesTest, EmptyFieldLineDoesNotInjectComma) {
  18856. Server svr;
  18857. std::vector<std::string> observed_types;
  18858. svr.Get("/", [&](const Request &req, Response &res) {
  18859. observed_types = req.accept_content_types;
  18860. res.set_content("ok", "text/plain");
  18861. });
  18862. auto port = svr.bind_to_any_port(HOST);
  18863. thread t = thread([&]() { svr.listen_after_bind(); });
  18864. auto se = detail::scope_exit([&] {
  18865. svr.stop();
  18866. t.join();
  18867. ASSERT_FALSE(svr.is_running());
  18868. });
  18869. svr.wait_until_ready();
  18870. // Empty first field line, then a real one
  18871. std::string raw_req = "GET / HTTP/1.1\r\n"
  18872. "Host: localhost\r\n"
  18873. "Accept:\r\n"
  18874. "Accept: application/json\r\n"
  18875. "Connection: close\r\n"
  18876. "\r\n";
  18877. std::string out;
  18878. ASSERT_TRUE(send_request(5, raw_req, &out, port));
  18879. EXPECT_EQ("HTTP/1.1 200 OK", out.substr(0, 15));
  18880. ASSERT_EQ(1U, observed_types.size());
  18881. EXPECT_EQ("application/json", observed_types[0]);
  18882. }
  18883. // The skip in get_combined_header_value() is what keeps an empty field line
  18884. // from contributing a bare comma. Only a trailing empty field line exercises
  18885. // it: a leading one is already covered by the "combined is still empty" check,
  18886. // and parse_accept_header() now ignores the empty element either way, so the
  18887. // request-level test above can no longer tell the two apart.
  18888. TEST(RepeatedFieldLinesTest, EmptyFieldLineIsNotCombined) {
  18889. Headers headers;
  18890. headers.emplace("Accept", "text/html");
  18891. headers.emplace("Accept", "");
  18892. EXPECT_EQ("text/html", detail::get_combined_header_value(headers, "Accept"));
  18893. headers.clear();
  18894. headers.emplace("Accept", "");
  18895. headers.emplace("Accept", "application/json");
  18896. EXPECT_EQ("application/json",
  18897. detail::get_combined_header_value(headers, "Accept"));
  18898. }
  18899. #ifdef CPPHTTPLIB_ZLIB_SUPPORT
  18900. // An encoding offered on a later Accept-Encoding field line is still offered.
  18901. TEST(RepeatedFieldLinesTest, AcceptEncodingCombinesEveryFieldLine) {
  18902. Server svr;
  18903. svr.Get("/", [](const Request & /*req*/, Response &res) {
  18904. res.set_content(std::string(1024, 'x'), "text/plain");
  18905. });
  18906. auto port = svr.bind_to_any_port(HOST);
  18907. thread t = thread([&]() { svr.listen_after_bind(); });
  18908. auto se = detail::scope_exit([&] {
  18909. svr.stop();
  18910. t.join();
  18911. ASSERT_FALSE(svr.is_running());
  18912. });
  18913. svr.wait_until_ready();
  18914. Client cli(HOST, port);
  18915. cli.set_decompress(false);
  18916. Headers headers;
  18917. headers.emplace("Accept-Encoding", "identity");
  18918. headers.emplace("Accept-Encoding", "gzip");
  18919. auto res = cli.Get("/", headers);
  18920. ASSERT_TRUE(res) << "Error: " << to_string(res.error());
  18921. EXPECT_EQ(StatusCode::OK_200, res->status);
  18922. EXPECT_EQ("gzip", res->get_header_value("Content-Encoding"));
  18923. }
  18924. #endif
  18925. #ifndef _WIN32
  18926. TEST(ServerRequestParsingTest, RequestWithoutContentLengthOrTransferEncoding) {
  18927. Server svr;
  18928. svr.Post("/post", [&](const Request &req, Response &res) {
  18929. res.set_content(req.body, "text/plain");
  18930. });
  18931. svr.Put("/put", [&](const Request &req, Response &res) {
  18932. res.set_content(req.body, "text/plain");
  18933. });
  18934. svr.Patch("/patch", [&](const Request &req, Response &res) {
  18935. res.set_content(req.body, "text/plain");
  18936. });
  18937. svr.Delete("/delete", [&](const Request &req, Response &res) {
  18938. res.set_content(req.body, "text/plain");
  18939. });
  18940. thread t = thread([&]() { svr.listen(HOST, PORT); });
  18941. auto se = detail::scope_exit([&] {
  18942. svr.stop();
  18943. t.join();
  18944. ASSERT_FALSE(svr.is_running());
  18945. });
  18946. svr.wait_until_ready();
  18947. std::string resp;
  18948. // POST without Content-Length
  18949. ASSERT_TRUE(send_request(5,
  18950. "POST /post HTTP/1.1\r\n"
  18951. "Host: localhost\r\n"
  18952. "Connection: close\r\n"
  18953. "\r\n",
  18954. &resp));
  18955. EXPECT_TRUE(resp.find("HTTP/1.1 200 OK") == 0);
  18956. // PUT without Content-Length
  18957. resp.clear();
  18958. ASSERT_TRUE(send_request(5,
  18959. "PUT /put HTTP/1.1\r\n"
  18960. "Host: localhost\r\n"
  18961. "Connection: close\r\n"
  18962. "\r\n",
  18963. &resp));
  18964. EXPECT_TRUE(resp.find("HTTP/1.1 200 OK") == 0);
  18965. // PATCH without Content-Length
  18966. resp.clear();
  18967. ASSERT_TRUE(send_request(5,
  18968. "PATCH /patch HTTP/1.1\r\n"
  18969. "Host: localhost\r\n"
  18970. "Connection: close\r\n"
  18971. "\r\n",
  18972. &resp));
  18973. EXPECT_TRUE(resp.find("HTTP/1.1 200 OK") == 0);
  18974. // DELETE without Content-Length
  18975. resp.clear();
  18976. ASSERT_TRUE(send_request(5,
  18977. "DELETE /delete HTTP/1.1\r\n"
  18978. "Host: localhost\r\n"
  18979. "Connection: close\r\n"
  18980. "\r\n",
  18981. &resp));
  18982. EXPECT_TRUE(resp.find("HTTP/1.1 200 OK") == 0);
  18983. }
  18984. #endif
  18985. //==============================================================================
  18986. // open_stream() Tests
  18987. //==============================================================================
  18988. inline std::string read_all(ClientImpl::StreamHandle &handle) {
  18989. std::string result;
  18990. char buf[8192];
  18991. ssize_t n;
  18992. while ((n = handle.read(buf, sizeof(buf))) > 0) {
  18993. result.append(buf, static_cast<size_t>(n));
  18994. }
  18995. return result;
  18996. }
  18997. // Mock stream for unit tests
  18998. class MockStream : public Stream {
  18999. public:
  19000. std::string data;
  19001. size_t pos = 0;
  19002. ssize_t error_after = -1; // -1 = no error
  19003. explicit MockStream(const std::string &d, ssize_t err = -1)
  19004. : data(d), error_after(err) {}
  19005. bool is_readable() const override { return true; }
  19006. bool wait_readable() const override { return true; }
  19007. bool wait_writable() const override { return true; }
  19008. ssize_t read(char *ptr, size_t size) override {
  19009. if (error_after >= 0 && pos >= static_cast<size_t>(error_after)) return -1;
  19010. if (pos >= data.size()) return 0;
  19011. size_t limit =
  19012. error_after >= 0 ? static_cast<size_t>(error_after) : data.size();
  19013. size_t to_read = std::min(size, std::min(data.size() - pos, limit - pos));
  19014. std::memcpy(ptr, data.data() + pos, to_read);
  19015. pos += to_read;
  19016. return static_cast<ssize_t>(to_read);
  19017. }
  19018. ssize_t write(const char *, size_t) override { return -1; }
  19019. void get_remote_ip_and_port(std::string &ip, int &port) const override {
  19020. ip = "127.0.0.1";
  19021. port = 0;
  19022. }
  19023. void get_local_ip_and_port(std::string &ip, int &port) const override {
  19024. ip = "127.0.0.1";
  19025. port = 0;
  19026. }
  19027. socket_t socket() const override { return INVALID_SOCKET; }
  19028. time_t duration() const override { return 0; }
  19029. };
  19030. TEST(StreamHandleTest, Basic) {
  19031. ClientImpl::StreamHandle handle;
  19032. EXPECT_FALSE(handle.is_valid());
  19033. handle.response = detail::make_unique<Response>();
  19034. handle.error = Error::Connection;
  19035. EXPECT_FALSE(handle.is_valid());
  19036. handle.error = Error::Success;
  19037. EXPECT_TRUE(handle.is_valid());
  19038. }
  19039. TEST(BodyReaderTest, Basic) {
  19040. MockStream stream("Hello, World!");
  19041. detail::BodyReader reader;
  19042. reader.stream = &stream;
  19043. reader.content_length = 13;
  19044. char buf[32];
  19045. EXPECT_EQ(13, reader.read(buf, sizeof(buf)));
  19046. EXPECT_EQ(0, reader.read(buf, sizeof(buf)));
  19047. EXPECT_TRUE(reader.eof);
  19048. }
  19049. TEST(BodyReaderTest, NoStream) {
  19050. detail::BodyReader reader;
  19051. char buf[32];
  19052. EXPECT_EQ(-1, reader.read(buf, sizeof(buf)));
  19053. EXPECT_EQ(Error::Connection, reader.last_error);
  19054. }
  19055. TEST(BodyReaderTest, Error) {
  19056. MockStream stream("Hello, World!", 5);
  19057. detail::BodyReader reader;
  19058. reader.stream = &stream;
  19059. reader.content_length = 13;
  19060. char buf[32];
  19061. EXPECT_EQ(5, reader.read(buf, sizeof(buf)));
  19062. EXPECT_EQ(-1, reader.read(buf, sizeof(buf)));
  19063. EXPECT_EQ(Error::Read, reader.last_error);
  19064. }
  19065. // Memory buffer mode removed: StreamHandle reads only from socket streams.
  19066. // Mock-based StreamHandle tests relying on private internals are removed.
  19067. class OpenStreamTest : public ::testing::Test {
  19068. protected:
  19069. void SetUp() override {
  19070. svr_.Get("/hello", [](const Request &, Response &res) {
  19071. res.set_content("Hello World!", "text/plain");
  19072. });
  19073. svr_.Get("/large", [](const Request &, Response &res) {
  19074. res.set_content(std::string(10000, 'X'), "text/plain");
  19075. });
  19076. svr_.Get("/unknown-encoding", [](const Request &, Response &res) {
  19077. res.set_content("Hello World!", "image/jpeg");
  19078. res.set_header("Content-Encoding", "UTF-8");
  19079. });
  19080. svr_.Get("/chunked", [](const Request &, Response &res) {
  19081. res.set_chunked_content_provider("text/plain",
  19082. [](size_t offset, DataSink &sink) {
  19083. if (offset < 15) {
  19084. sink.write("chunk", 5);
  19085. return true;
  19086. }
  19087. sink.done();
  19088. return true;
  19089. });
  19090. });
  19091. svr_.Get("/compressible", [](const Request &, Response &res) {
  19092. res.set_chunked_content_provider("text/plain", [](size_t offset,
  19093. DataSink &sink) {
  19094. if (offset < 100 * 1024) {
  19095. std::string chunk(std::min(size_t(8192), 100 * 1024 - offset), 'A');
  19096. sink.write(chunk.data(), chunk.size());
  19097. return true;
  19098. }
  19099. sink.done();
  19100. return true;
  19101. });
  19102. });
  19103. svr_.Get("/streamed-chunked-with-prohibited-trailer",
  19104. [](const Request & /*req*/, Response &res) {
  19105. auto i = new int(0);
  19106. res.set_header("Trailer", "Content-Length, X-Allowed");
  19107. res.set_chunked_content_provider(
  19108. "text/plain",
  19109. [i](size_t /*offset*/, DataSink &sink) {
  19110. switch (*i) {
  19111. case 0: sink.os << "123"; break;
  19112. case 1: sink.os << "456"; break;
  19113. case 2: sink.os << "789"; break;
  19114. case 3: {
  19115. sink.done_with_trailer(
  19116. {{"Content-Length", "5"}, {"X-Allowed", "yes"}});
  19117. } break;
  19118. }
  19119. (*i)++;
  19120. return true;
  19121. },
  19122. [i](bool success) {
  19123. EXPECT_TRUE(success);
  19124. delete i;
  19125. });
  19126. });
  19127. // Echo headers endpoint for header-related tests
  19128. svr_.Get("/echo-headers", [](const Request &req, Response &res) {
  19129. std::string body;
  19130. for (const auto &h : req.headers) {
  19131. body.append(h.first);
  19132. body.push_back(':');
  19133. body.append(h.second);
  19134. body.push_back('\n');
  19135. }
  19136. res.set_content(body, "text/plain");
  19137. });
  19138. svr_.Post("/echo-headers", [](const Request &req, Response &res) {
  19139. std::string body;
  19140. for (const auto &h : req.headers) {
  19141. body.append(h.first);
  19142. body.push_back(':');
  19143. body.append(h.second);
  19144. body.push_back('\n');
  19145. }
  19146. res.set_content(body, "text/plain");
  19147. });
  19148. port_ = svr_.bind_to_any_port("127.0.0.1");
  19149. thread_ = std::thread([this]() { svr_.listen_after_bind(); });
  19150. svr_.wait_until_ready();
  19151. }
  19152. void TearDown() override {
  19153. svr_.stop();
  19154. if (thread_.joinable()) thread_.join();
  19155. }
  19156. Server svr_;
  19157. std::thread thread_;
  19158. int port_ = 0;
  19159. };
  19160. TEST_F(OpenStreamTest, Basic) {
  19161. Client cli("127.0.0.1", port_);
  19162. auto handle = cli.open_stream("GET", "/hello");
  19163. EXPECT_TRUE(handle.is_valid());
  19164. EXPECT_EQ("Hello World!", read_all(handle));
  19165. }
  19166. TEST_F(OpenStreamTest, UnknownContentEncodingIsPassedThrough) {
  19167. Client cli("127.0.0.1", port_);
  19168. auto handle = cli.open_stream("GET", "/unknown-encoding");
  19169. ASSERT_TRUE(handle.is_valid());
  19170. EXPECT_EQ("Hello World!", read_all(handle));
  19171. }
  19172. TEST_F(OpenStreamTest, SmallBuffer) {
  19173. Client cli("127.0.0.1", port_);
  19174. auto handle = cli.open_stream("GET", "/hello");
  19175. std::string result;
  19176. char buf[4];
  19177. ssize_t n;
  19178. while ((n = handle.read(buf, sizeof(buf))) > 0)
  19179. result.append(buf, static_cast<size_t>(n));
  19180. EXPECT_EQ("Hello World!", result);
  19181. }
  19182. TEST_F(OpenStreamTest, DefaultHeaders) {
  19183. Client cli("127.0.0.1", port_);
  19184. // open_stream GET should include Host, User-Agent and Accept-Encoding
  19185. {
  19186. auto handle = cli.open_stream("GET", "/echo-headers");
  19187. ASSERT_TRUE(handle.is_valid());
  19188. auto body = read_all(handle);
  19189. EXPECT_NE(body.find("Host:127.0.0.1:" + std::to_string(port_)),
  19190. std::string::npos);
  19191. EXPECT_NE(body.find("User-Agent:cpp-httplib/" CPPHTTPLIB_VERSION),
  19192. std::string::npos);
  19193. EXPECT_NE(body.find("Accept-Encoding:"), std::string::npos);
  19194. }
  19195. // open_stream POST with body and no explicit content_type should NOT add
  19196. // text/plain Content-Type (behavior differs from non-streaming path), but
  19197. // should include Content-Length
  19198. {
  19199. auto handle = cli.open_stream("POST", "/echo-headers", {}, {}, "hello", "");
  19200. ASSERT_TRUE(handle.is_valid());
  19201. auto body = read_all(handle);
  19202. EXPECT_EQ(body.find("Content-Type: text/plain"), std::string::npos);
  19203. EXPECT_NE(body.find("Content-Length:5"), std::string::npos);
  19204. }
  19205. // open_stream POST with explicit Content-Type should preserve it
  19206. {
  19207. auto handle = cli.open_stream("POST", "/echo-headers", {},
  19208. {{"Content-Type", "application/custom"}},
  19209. "{}", "application/custom");
  19210. ASSERT_TRUE(handle.is_valid());
  19211. auto body = read_all(handle);
  19212. EXPECT_NE(body.find("Content-Type:application/custom"), std::string::npos);
  19213. }
  19214. // User-specified User-Agent must not be overwritten for stream API
  19215. {
  19216. auto handle = cli.open_stream("GET", "/echo-headers", {},
  19217. {{"User-Agent", "MyAgent/1.2"}});
  19218. ASSERT_TRUE(handle.is_valid());
  19219. auto body = read_all(handle);
  19220. EXPECT_NE(body.find("User-Agent:MyAgent/1.2"), std::string::npos);
  19221. }
  19222. }
  19223. TEST_F(OpenStreamTest, Large) {
  19224. Client cli("127.0.0.1", port_);
  19225. auto handle = cli.open_stream("GET", "/large");
  19226. EXPECT_EQ(10000u, read_all(handle).size());
  19227. }
  19228. TEST_F(OpenStreamTest, ConnectionError) {
  19229. Client cli("127.0.0.1", 9999);
  19230. auto handle = cli.open_stream("GET", "/hello");
  19231. EXPECT_FALSE(handle.is_valid());
  19232. }
  19233. TEST_F(OpenStreamTest, Chunked) {
  19234. Client cli("127.0.0.1", port_);
  19235. auto handle = cli.open_stream("GET", "/chunked");
  19236. EXPECT_TRUE(handle.response && handle.response->get_header_value(
  19237. "Transfer-Encoding") == "chunked");
  19238. EXPECT_EQ("chunkchunkchunk", read_all(handle));
  19239. }
  19240. TEST_F(OpenStreamTest, ProhibitedTrailersAreIgnored_Stream) {
  19241. Client cli("127.0.0.1", port_);
  19242. auto handle =
  19243. cli.open_stream("GET", "/streamed-chunked-with-prohibited-trailer");
  19244. ASSERT_TRUE(handle.is_valid());
  19245. // Consume body to allow trailers to be received/parsed
  19246. auto body = read_all(handle);
  19247. // Explicitly parse trailers (ensure trailers are available for assertion)
  19248. handle.parse_trailers_if_needed();
  19249. EXPECT_EQ(std::string("123456789"), body);
  19250. // The response should include a Trailer header declaring both names
  19251. ASSERT_TRUE(handle.response);
  19252. EXPECT_TRUE(handle.response->has_header("Trailer"));
  19253. EXPECT_EQ(std::string("Content-Length, X-Allowed"),
  19254. handle.response->get_header_value("Trailer"));
  19255. // Prohibited trailer must not be present
  19256. EXPECT_FALSE(handle.response->has_trailer("Content-Length"));
  19257. // Allowed trailer should be present
  19258. EXPECT_TRUE(handle.response->has_trailer("X-Allowed"));
  19259. EXPECT_EQ(std::string("yes"),
  19260. handle.response->get_trailer_value("X-Allowed"));
  19261. // Verify trailers are NOT present as regular headers
  19262. EXPECT_EQ(std::string(""),
  19263. handle.response->get_header_value("Content-Length"));
  19264. EXPECT_EQ(std::string(""), handle.response->get_header_value("X-Allowed"));
  19265. }
  19266. // Accepts one connection on an OS-assigned port, which it hands over through
  19267. // port_promise, reads the request head and sends back response. after_send,
  19268. // if given, runs on the connection before it is closed.
  19269. static std::thread
  19270. serve_single_response(std::promise<int> &port_promise,
  19271. const std::string &response,
  19272. std::function<void(socket_t)> after_send = nullptr) {
  19273. return std::thread([&port_promise, response, after_send] {
  19274. auto srv = ::socket(AF_INET, SOCK_STREAM, 0);
  19275. default_socket_options(srv);
  19276. detail::set_socket_opt_time(srv, SOL_SOCKET, SO_RCVTIMEO, 5, 0);
  19277. detail::set_socket_opt_time(srv, SOL_SOCKET, SO_SNDTIMEO, 5, 0);
  19278. sockaddr_in addr{};
  19279. addr.sin_family = AF_INET;
  19280. addr.sin_port = htons(0); // Let OS assign a free port
  19281. ::inet_pton(AF_INET, "127.0.0.1", &addr.sin_addr);
  19282. int opt = 1;
  19283. ::setsockopt(srv, SOL_SOCKET, SO_REUSEADDR,
  19284. #ifdef _WIN32
  19285. reinterpret_cast<const char *>(&opt),
  19286. #else
  19287. &opt,
  19288. #endif
  19289. sizeof(opt));
  19290. if (::bind(srv, reinterpret_cast<sockaddr *>(&addr), sizeof(addr)) != 0 ||
  19291. ::listen(srv, 1) != 0) {
  19292. port_promise.set_value(-1);
  19293. detail::close_socket(srv);
  19294. return;
  19295. }
  19296. socklen_t addr_len = sizeof(addr);
  19297. ::getsockname(srv, reinterpret_cast<sockaddr *>(&addr), &addr_len);
  19298. port_promise.set_value(static_cast<int>(ntohs(addr.sin_port)));
  19299. sockaddr_in cli_addr{};
  19300. socklen_t cli_len = sizeof(cli_addr);
  19301. auto cli = ::accept(srv, reinterpret_cast<sockaddr *>(&cli_addr), &cli_len);
  19302. if (cli != INVALID_SOCKET) {
  19303. // Read the complete HTTP request (until the blank line that terminates
  19304. // headers) before sending the response. If the server closes the socket
  19305. // while the client's request data is still unread in the kernel receive
  19306. // buffer, the TCP stack sends RST instead of FIN. That RST resets the
  19307. // connection on both sides: it discards the client's receive buffer
  19308. // (which already holds our response) and causes any in-progress write on
  19309. // the client to fail with ECONNRESET. Reading all request data first
  19310. // ensures close() emits a graceful FIN.
  19311. {
  19312. char rbuf[256];
  19313. std::string req;
  19314. while (req.find("\r\n\r\n") == std::string::npos) {
  19315. auto n = ::recv(cli, rbuf, sizeof(rbuf), 0);
  19316. if (n <= 0) { break; }
  19317. req.append(rbuf, static_cast<size_t>(n));
  19318. }
  19319. }
  19320. ::send(cli,
  19321. #ifdef _WIN32
  19322. static_cast<const char *>(response.c_str()),
  19323. static_cast<int>(response.size()),
  19324. #else
  19325. response.c_str(), response.size(),
  19326. #endif
  19327. 0);
  19328. if (after_send) { after_send(cli); }
  19329. detail::close_socket(cli);
  19330. }
  19331. detail::close_socket(srv);
  19332. });
  19333. }
  19334. TEST(OpenStreamMalformedContentLength, InvalidArgument) {
  19335. #ifndef _WIN32
  19336. signal(SIGPIPE, SIG_IGN);
  19337. #endif
  19338. std::promise<int> port_promise;
  19339. auto port_future = port_promise.get_future();
  19340. auto server_thread =
  19341. serve_single_response(port_promise, "HTTP/1.1 200 OK\r\n"
  19342. "Content-Type: text/plain\r\n"
  19343. "Content-Length: not-a-number\r\n"
  19344. "Connection: close\r\n"
  19345. "\r\n"
  19346. "hello");
  19347. auto port = port_future.get();
  19348. ASSERT_GT(port, 0);
  19349. Client cli("127.0.0.1", port);
  19350. auto handle = cli.open_stream("GET", "/");
  19351. EXPECT_FALSE(handle.is_valid());
  19352. server_thread.join();
  19353. }
  19354. TEST(OpenStreamMalformedContentLength, OutOfRange) {
  19355. #ifndef _WIN32
  19356. signal(SIGPIPE, SIG_IGN);
  19357. #endif
  19358. std::promise<int> port_promise;
  19359. auto port_future = port_promise.get_future();
  19360. auto server_thread = serve_single_response(
  19361. port_promise, "HTTP/1.1 200 OK\r\n"
  19362. "Content-Type: text/plain\r\n"
  19363. "Content-Length: 99999999999999999999999999\r\n"
  19364. "Connection: close\r\n"
  19365. "\r\n"
  19366. "hello");
  19367. auto port = port_future.get();
  19368. ASSERT_GT(port, 0);
  19369. // Historically std::stoull would throw std::out_of_range here and crash
  19370. // the process, then parsing silently clamped to a bogus framing length and
  19371. // the stream opened anyway. Now the out-of-range value is flagged invalid,
  19372. // so the stream fails to open, matching the not-a-number case above. The
  19373. // process still must NOT terminate.
  19374. Client cli("127.0.0.1", port);
  19375. auto handle = cli.open_stream("GET", "/");
  19376. EXPECT_FALSE(handle.is_valid());
  19377. server_thread.join();
  19378. }
  19379. // Serves `response` to the single request `fn` makes with a fresh client.
  19380. template <typename Fn>
  19381. static void with_single_response(const std::string &response, Fn fn) {
  19382. #ifndef _WIN32
  19383. signal(SIGPIPE, SIG_IGN);
  19384. #endif
  19385. std::promise<int> port_promise;
  19386. auto port_future = port_promise.get_future();
  19387. auto server_thread = serve_single_response(port_promise, response);
  19388. auto se = detail::scope_exit([&] { server_thread.join(); });
  19389. auto port = port_future.get();
  19390. ASSERT_GT(port, 0);
  19391. Client cli("127.0.0.1", port);
  19392. fn(cli);
  19393. }
  19394. TEST(InterimResponseTest, SkippedWithTheirHeaderFields) {
  19395. const char *responses[] = {
  19396. "HTTP/1.1 103 Early Hints\r\n"
  19397. "Link: </style.css>; rel=preload\r\n"
  19398. "\r\n"
  19399. "HTTP/1.1 200 OK\r\nContent-Length: 2\r\n\r\nok",
  19400. "HTTP/1.1 100 Continue\r\n"
  19401. "X-Note: interim\r\n"
  19402. "\r\n"
  19403. "HTTP/1.1 200 OK\r\nContent-Length: 2\r\n\r\nok",
  19404. };
  19405. for (auto response : responses) {
  19406. with_single_response(response, [](Client &cli) {
  19407. auto res = cli.Get("/");
  19408. ASSERT_TRUE(res) << "Error: " << to_string(res.error());
  19409. EXPECT_EQ(StatusCode::OK_200, res->status);
  19410. EXPECT_EQ("ok", res->body);
  19411. });
  19412. }
  19413. }
  19414. TEST(InterimResponseTest, OnlySoManyAreSkipped) {
  19415. const std::string interim = "HTTP/1.1 102 Processing\r\n\r\n";
  19416. const std::string final_response =
  19417. "HTTP/1.1 200 OK\r\nContent-Length: 2\r\n\r\nok";
  19418. std::string interims;
  19419. for (auto i = 0; i < CPPHTTPLIB_INTERIM_RESPONSE_MAX_COUNT; i++) {
  19420. interims += interim;
  19421. }
  19422. with_single_response(interims + final_response, [](Client &cli) {
  19423. auto res = cli.Get("/");
  19424. ASSERT_TRUE(res) << "Error: " << to_string(res.error());
  19425. EXPECT_EQ("ok", res->body);
  19426. });
  19427. with_single_response(interims + interim + final_response, [](Client &cli) {
  19428. auto res = cli.Get("/");
  19429. ASSERT_FALSE(res);
  19430. EXPECT_EQ(Error::Read, res.error());
  19431. });
  19432. }
  19433. TEST(ExpectContinueTest, EarlyFinalResponseClosesConnection) {
  19434. #ifndef _WIN32
  19435. signal(SIGPIPE, SIG_IGN);
  19436. #endif
  19437. // The server answers the head without asking for the body. Bytes it then
  19438. // reads on the connection would be taken for the body the request declared.
  19439. auto closed_by_client = false;
  19440. std::promise<int> port_promise;
  19441. auto server_thread = serve_single_response(
  19442. port_promise, "HTTP/1.1 401 Unauthorized\r\nContent-Length: 0\r\n\r\n",
  19443. [&](socket_t sock) {
  19444. detail::set_socket_opt_time(sock, SOL_SOCKET, SO_RCVTIMEO, 3, 0);
  19445. char buf[256];
  19446. closed_by_client = ::recv(sock, buf, sizeof(buf), 0) == 0;
  19447. });
  19448. Client cli("127.0.0.1", port_promise.get_future().get());
  19449. cli.set_keep_alive(true);
  19450. cli.set_read_timeout(1, 0);
  19451. // Long enough for the client to send Expect: 100-continue.
  19452. auto res = cli.Post("/upload", std::string(2048, 'B'), "text/plain");
  19453. ASSERT_TRUE(res) << "Error: " << to_string(res.error());
  19454. EXPECT_EQ(StatusCode::Unauthorized_401, res->status);
  19455. cli.Get("/second");
  19456. server_thread.join();
  19457. EXPECT_TRUE(closed_by_client);
  19458. }
  19459. TEST(InterimResponseTest, SkippedWhileWaitingForContinue) {
  19460. // Long enough for the client to send Expect: 100-continue
  19461. with_single_response(
  19462. "HTTP/1.1 103 Early Hints\r\n"
  19463. "Link: </style.css>; rel=preload\r\n"
  19464. "\r\n"
  19465. "HTTP/1.1 401 Unauthorized\r\n"
  19466. "Content-Length: 0\r\n\r\n",
  19467. [](Client &cli) {
  19468. cli.set_read_timeout(2, 0);
  19469. auto res = cli.Post("/upload", std::string(2048, 'B'), "text/plain");
  19470. ASSERT_TRUE(res) << "Error: " << to_string(res.error());
  19471. EXPECT_EQ(StatusCode::Unauthorized_401, res->status);
  19472. });
  19473. }
  19474. #ifdef CPPHTTPLIB_SSL_ENABLED
  19475. TEST(ExpectContinueTest, AuthRetryAfterEarlyResponseUsesANewConnection) {
  19476. #ifndef _WIN32
  19477. signal(SIGPIPE, SIG_IGN);
  19478. #endif
  19479. auto reused = false;
  19480. std::promise<int> port_promise;
  19481. auto server_thread = serve_single_response(
  19482. port_promise,
  19483. "HTTP/1.1 401 Unauthorized\r\n"
  19484. "WWW-Authenticate: Digest realm=\"r\", nonce=\"n\", qop=\"auth\"\r\n"
  19485. "Content-Length: 0\r\n\r\n",
  19486. [&](socket_t sock) {
  19487. detail::set_socket_opt_time(sock, SOL_SOCKET, SO_RCVTIMEO, 3, 0);
  19488. char buf[256];
  19489. reused = ::recv(sock, buf, sizeof(buf), 0) > 0;
  19490. });
  19491. Client cli("127.0.0.1", port_promise.get_future().get());
  19492. cli.set_keep_alive(true);
  19493. cli.set_digest_auth("user", "pass");
  19494. cli.set_read_timeout(1, 0);
  19495. cli.Post("/upload", std::string(2048, 'B'), "text/plain");
  19496. server_thread.join();
  19497. EXPECT_FALSE(reused);
  19498. }
  19499. TEST(ProxyConnectTest, OnlyAProxyAuthChallengeIsPassedOn) {
  19500. // Any other answer to CONNECT would read as the origin's response.
  19501. struct {
  19502. const char *response;
  19503. bool passed_on;
  19504. } cases[] = {
  19505. {"HTTP/1.1 201 Created\r\n"
  19506. "Set-Cookie: session=from-proxy\r\n"
  19507. "Content-Length: 0\r\n\r\n",
  19508. false},
  19509. {"HTTP/1.1 403 Forbidden\r\nContent-Length: 0\r\n\r\n", false},
  19510. {"HTTP/1.1 407 Proxy Authentication Required\r\n"
  19511. "Content-Length: 0\r\n\r\n",
  19512. true},
  19513. };
  19514. for (const auto &c : cases) {
  19515. std::promise<int> port_promise;
  19516. auto server_thread = serve_single_response(port_promise, c.response);
  19517. SSLClient cli("example.com", 443);
  19518. cli.set_proxy("127.0.0.1", port_promise.get_future().get());
  19519. auto res = cli.Get("/");
  19520. server_thread.join();
  19521. EXPECT_EQ(Error::ProxyConnection, res.error()) << c.response;
  19522. ASSERT_EQ(c.passed_on, static_cast<bool>(res)) << c.response;
  19523. if (res) {
  19524. EXPECT_EQ(StatusCode::ProxyAuthenticationRequired_407, res->status);
  19525. }
  19526. }
  19527. }
  19528. #endif
  19529. // RFC 9112 §6.3: a response that pairs a non-zero Content-Length with
  19530. // Transfer-Encoding is framed ambiguously. Both read paths delimit its body by
  19531. // the chunked coding and drop Content-Length, so a front-end that trusts
  19532. // Content-Length would disagree about where the body ends (response
  19533. // smuggling). The client must reject such a response.
  19534. TEST(ClientResponseSmugglingTest, ContentLengthAndTransferEncodingRejected) {
  19535. for (const char *te : {"chunked", "gzip, chunked"}) {
  19536. auto response = std::string("HTTP/1.1 200 OK\r\n") +
  19537. "Content-Length: 5\r\n" + "Transfer-Encoding: " + te +
  19538. "\r\n" + "Connection: close\r\n" + "\r\n" +
  19539. "5\r\nhello\r\n0\r\n\r\n";
  19540. with_single_response(response, [&](Client &cli) {
  19541. auto res = cli.Get("/");
  19542. EXPECT_FALSE(static_cast<bool>(res)) << te;
  19543. EXPECT_EQ(Error::Read, res.error()) << te;
  19544. });
  19545. with_single_response(response, [&](Client &cli) {
  19546. auto handle = cli.open_stream("GET", "/");
  19547. EXPECT_FALSE(handle.is_valid()) << te;
  19548. EXPECT_EQ(Error::Read, handle.error) << te;
  19549. });
  19550. }
  19551. }
  19552. // Unambiguous framing stays readable on both paths: chunked alone, and a final
  19553. // coding other than chunked, whose body RFC 9112 §6.3 delimits by the server
  19554. // closing the connection (unlike a request, which must be rejected).
  19555. TEST(ClientResponseSmugglingTest, UnambiguousFramingAccepted) {
  19556. for (const char *response : {"HTTP/1.1 200 OK\r\n"
  19557. "Transfer-Encoding: chunked\r\n"
  19558. "Connection: close\r\n"
  19559. "\r\n"
  19560. "5\r\nhello\r\n0\r\n\r\n",
  19561. "HTTP/1.1 200 OK\r\n"
  19562. "Transfer-Encoding: gzip\r\n"
  19563. "Connection: close\r\n"
  19564. "\r\n"
  19565. "hello"}) {
  19566. with_single_response(response, [&](Client &cli) {
  19567. auto res = cli.Get("/");
  19568. ASSERT_TRUE(static_cast<bool>(res)) << response;
  19569. EXPECT_EQ("hello", res->body);
  19570. });
  19571. with_single_response(response, [&](Client &cli) {
  19572. auto handle = cli.open_stream("GET", "/");
  19573. ASSERT_TRUE(handle.is_valid()) << response;
  19574. EXPECT_EQ("hello", read_all(handle));
  19575. });
  19576. }
  19577. }
  19578. // A response to HEAD, and a 204 or 304 response, carries no body, so its
  19579. // framing headers describe nothing to read and must not be rejected.
  19580. TEST(ClientResponseSmugglingTest, BodylessResponseNotRejected) {
  19581. const std::string framing = "Content-Length: 5\r\n"
  19582. "Transfer-Encoding: chunked\r\n"
  19583. "Connection: close\r\n"
  19584. "\r\n";
  19585. with_single_response("HTTP/1.1 200 OK\r\n" + framing, [](Client &cli) {
  19586. EXPECT_TRUE(static_cast<bool>(cli.Head("/")));
  19587. });
  19588. with_single_response("HTTP/1.1 200 OK\r\n" + framing, [](Client &cli) {
  19589. EXPECT_TRUE(cli.open_stream("HEAD", "/").is_valid());
  19590. });
  19591. for (const char *status : {"204 No Content", "304 Not Modified"}) {
  19592. auto response = std::string("HTTP/1.1 ") + status + "\r\n" + framing;
  19593. with_single_response(response, [&](Client &cli) {
  19594. EXPECT_TRUE(static_cast<bool>(cli.Get("/"))) << status;
  19595. });
  19596. with_single_response(response, [&](Client &cli) {
  19597. EXPECT_TRUE(cli.open_stream("GET", "/").is_valid()) << status;
  19598. });
  19599. }
  19600. }
  19601. // RFC 9112 6.1: Transfer-Encoding next to a Content-Length, or in an HTTP/1.0
  19602. // response, is faulty framing, so the connection is not reused after it.
  19603. TEST(ClientResponseSmugglingTest, FaultyTransferEncodingClosesConnection) {
  19604. for (const char *response : {"HTTP/1.1 200 OK\r\n"
  19605. "Content-Length: 0\r\n"
  19606. "Transfer-Encoding: chunked\r\n"
  19607. "\r\n"
  19608. "5\r\nhello\r\n0\r\n\r\n",
  19609. "HTTP/1.0 200 Connection established\r\n"
  19610. "Connection: keep-alive\r\n"
  19611. "Transfer-Encoding: chunked\r\n"
  19612. "\r\n"
  19613. "5\r\nhello\r\n0\r\n\r\n"}) {
  19614. with_single_response(response, [&](Client &cli) {
  19615. cli.set_keep_alive(true);
  19616. auto res = cli.Get("/");
  19617. ASSERT_TRUE(res) << response;
  19618. EXPECT_EQ("hello", res->body);
  19619. EXPECT_FALSE(cli.is_socket_open()) << response;
  19620. });
  19621. }
  19622. }
  19623. // A payload max length of 0 means no limit, however the body is framed.
  19624. TEST(PayloadMaxLengthZeroTest, ClientReadsChunkedAndUnframedResponse) {
  19625. for (const char *response : {"HTTP/1.1 200 OK\r\n"
  19626. "Transfer-Encoding: chunked\r\n"
  19627. "\r\n"
  19628. "5\r\nhello\r\n0\r\n\r\n",
  19629. "HTTP/1.1 200 OK\r\n"
  19630. "Connection: close\r\n"
  19631. "\r\n"
  19632. "hello"}) {
  19633. with_single_response(response, [&](Client &cli) {
  19634. cli.set_payload_max_length(0);
  19635. auto res = cli.Get("/");
  19636. ASSERT_TRUE(res) << response;
  19637. EXPECT_EQ("hello", res->body) << response;
  19638. });
  19639. }
  19640. }
  19641. TEST(PayloadMaxLengthZeroTest, ServerReadsChunkedRequest) {
  19642. Server svr;
  19643. svr.set_payload_max_length(0);
  19644. svr.Post("/echo", [](const Request &req, Response &res) {
  19645. res.set_content(req.body, "text/plain");
  19646. });
  19647. auto port = svr.bind_to_any_port(HOST);
  19648. thread t = thread([&] { svr.listen_after_bind(); });
  19649. auto se = detail::scope_exit([&] {
  19650. svr.stop();
  19651. t.join();
  19652. ASSERT_FALSE(svr.is_running());
  19653. });
  19654. svr.wait_until_ready();
  19655. Client cli(HOST, port);
  19656. auto res = cli.Post(
  19657. "/echo",
  19658. [](size_t /*offset*/, DataSink &sink) {
  19659. sink.write("hello", 5);
  19660. sink.done();
  19661. return true;
  19662. },
  19663. "text/plain");
  19664. ASSERT_TRUE(res);
  19665. EXPECT_EQ(StatusCode::OK_200, res->status);
  19666. EXPECT_EQ("hello", res->body);
  19667. }
  19668. #ifdef CPPHTTPLIB_ZLIB_SUPPORT
  19669. TEST_F(OpenStreamTest, Gzip) {
  19670. Client cli("127.0.0.1", port_);
  19671. auto handle = cli.open_stream("GET", "/compressible", {},
  19672. {{"Accept-Encoding", "gzip"}});
  19673. EXPECT_EQ("gzip", handle.response->get_header_value("Content-Encoding"));
  19674. EXPECT_EQ(100u * 1024u, read_all(handle).size());
  19675. }
  19676. #endif
  19677. #ifdef CPPHTTPLIB_BROTLI_SUPPORT
  19678. TEST_F(OpenStreamTest, Brotli) {
  19679. Client cli("127.0.0.1", port_);
  19680. auto handle =
  19681. cli.open_stream("GET", "/compressible", {}, {{"Accept-Encoding", "br"}});
  19682. EXPECT_EQ("br", handle.response->get_header_value("Content-Encoding"));
  19683. EXPECT_EQ(100u * 1024u, read_all(handle).size());
  19684. }
  19685. #endif
  19686. #ifdef CPPHTTPLIB_ZSTD_SUPPORT
  19687. TEST_F(OpenStreamTest, Zstd) {
  19688. Client cli("127.0.0.1", port_);
  19689. auto handle = cli.open_stream("GET", "/compressible", {},
  19690. {{"Accept-Encoding", "zstd"}});
  19691. EXPECT_EQ("zstd", handle.response->get_header_value("Content-Encoding"));
  19692. EXPECT_EQ(100u * 1024u, read_all(handle).size());
  19693. }
  19694. #endif
  19695. #ifdef CPPHTTPLIB_SSL_ENABLED
  19696. class SSLOpenStreamTest : public ::testing::Test {
  19697. protected:
  19698. SSLOpenStreamTest() : svr_("cert.pem", "key.pem") {}
  19699. void SetUp() override {
  19700. svr_.Get("/hello", [](const Request &, Response &res) {
  19701. res.set_content("Hello SSL World!", "text/plain");
  19702. });
  19703. svr_.Get("/chunked", [](const Request &, Response &res) {
  19704. res.set_chunked_content_provider("text/plain",
  19705. [](size_t offset, DataSink &sink) {
  19706. if (offset < 15) {
  19707. sink.write("chunk", 5);
  19708. return true;
  19709. }
  19710. sink.done();
  19711. return true;
  19712. });
  19713. });
  19714. svr_.Post("/echo", [](const Request &req, Response &res) {
  19715. res.set_content(req.body, req.get_header_value("Content-Type"));
  19716. });
  19717. svr_.Post("/chunked-response", [](const Request &req, Response &res) {
  19718. std::string body = req.body;
  19719. res.set_chunked_content_provider(
  19720. "text/plain", [body](size_t offset, DataSink &sink) {
  19721. if (offset < body.size()) {
  19722. sink.write(body.data() + offset, body.size() - offset);
  19723. }
  19724. sink.done();
  19725. return true;
  19726. });
  19727. });
  19728. port_ = svr_.bind_to_any_port("127.0.0.1");
  19729. thread_ = std::thread([this]() { svr_.listen_after_bind(); });
  19730. svr_.wait_until_ready();
  19731. }
  19732. void TearDown() override {
  19733. svr_.stop();
  19734. if (thread_.joinable()) thread_.join();
  19735. }
  19736. SSLServer svr_;
  19737. std::thread thread_;
  19738. int port_ = 0;
  19739. };
  19740. TEST_F(SSLOpenStreamTest, Basic) {
  19741. SSLClient cli("127.0.0.1", port_);
  19742. cli.enable_server_certificate_verification(false);
  19743. auto handle = cli.open_stream("GET", "/hello");
  19744. ASSERT_TRUE(handle.is_valid());
  19745. EXPECT_EQ("Hello SSL World!", read_all(handle));
  19746. }
  19747. TEST_F(SSLOpenStreamTest, Chunked) {
  19748. SSLClient cli("127.0.0.1", port_);
  19749. cli.enable_server_certificate_verification(false);
  19750. auto handle = cli.open_stream("GET", "/chunked");
  19751. ASSERT_TRUE(handle.is_valid()) << "Error: " << static_cast<int>(handle.error);
  19752. EXPECT_TRUE(handle.response && handle.response->get_header_value(
  19753. "Transfer-Encoding") == "chunked");
  19754. auto body = read_all(handle);
  19755. EXPECT_EQ("chunkchunkchunk", body);
  19756. }
  19757. TEST_F(SSLOpenStreamTest, Post) {
  19758. SSLClient cli("127.0.0.1", port_);
  19759. cli.enable_server_certificate_verification(false);
  19760. auto handle =
  19761. cli.open_stream("POST", "/echo", {}, {}, "Hello SSL POST", "text/plain");
  19762. ASSERT_TRUE(handle.is_valid()) << "Error: " << static_cast<int>(handle.error);
  19763. EXPECT_EQ(200, handle.response->status);
  19764. auto body = read_all(handle);
  19765. EXPECT_EQ("Hello SSL POST", body);
  19766. }
  19767. TEST_F(SSLOpenStreamTest, PostChunked) {
  19768. SSLClient cli("127.0.0.1", port_);
  19769. cli.enable_server_certificate_verification(false);
  19770. auto handle = cli.open_stream("POST", "/chunked-response", {}, {},
  19771. "Chunked SSL Data", "text/plain");
  19772. ASSERT_TRUE(handle.is_valid());
  19773. EXPECT_EQ(200, handle.response->status);
  19774. auto body = read_all(handle);
  19775. EXPECT_EQ("Chunked SSL Data", body);
  19776. }
  19777. // RFC 7230 §3.3: a response body with neither chunked Transfer-Encoding nor
  19778. // Content-Length is terminated by the server closing the connection. When the
  19779. // SSL peer sends a close_notify after the body, the client must treat it as a
  19780. // clean EOF and return a successful response rather than an error.
  19781. TEST(SSLTest, ResponseBodyTerminatedByConnectionClose) {
  19782. SSLServer svr(SERVER_CERT_FILE, SERVER_PRIVATE_KEY_FILE);
  19783. ASSERT_TRUE(svr.is_valid());
  19784. svr.set_keep_alive_max_count(1);
  19785. const std::string expected_body = "Hello from connection-close response!";
  19786. svr.Get("/no-content-length", [&](const Request & /*req*/, Response &res) {
  19787. res.set_content_provider("text/plain",
  19788. [&](size_t offset, DataSink &sink) -> bool {
  19789. if (offset < expected_body.size()) {
  19790. sink.write(expected_body.data() + offset,
  19791. expected_body.size() - offset);
  19792. }
  19793. sink.done();
  19794. return true;
  19795. });
  19796. });
  19797. auto listen_thread = std::thread([&svr] { svr.listen(HOST, PORT); });
  19798. auto se = detail::scope_exit([&] {
  19799. svr.stop();
  19800. listen_thread.join();
  19801. ASSERT_FALSE(svr.is_running());
  19802. });
  19803. svr.wait_until_ready();
  19804. SSLClient cli(HOST, PORT);
  19805. cli.enable_server_certificate_verification(false);
  19806. auto res = cli.Get("/no-content-length");
  19807. ASSERT_TRUE(res) << "Request failed: " << to_string(res.error());
  19808. EXPECT_EQ(StatusCode::OK_200, res->status);
  19809. EXPECT_EQ(expected_body, res->body);
  19810. }
  19811. #endif // CPPHTTPLIB_SSL_ENABLED
  19812. //==============================================================================
  19813. // Parity Tests: ensure streaming and non-streaming APIs produce identical
  19814. // results for various scenarios.
  19815. //==============================================================================
  19816. TEST(ParityTest, GetVsOpenStream) {
  19817. Server svr;
  19818. const std::string path = "/parity";
  19819. const std::string content = "Parity test content: hello world";
  19820. svr.Get(path, [&](const Request & /*req*/, Response &res) {
  19821. res.set_content(content, "text/plain");
  19822. });
  19823. auto t = std::thread([&]() { svr.listen(HOST, PORT); });
  19824. auto se = detail::scope_exit([&] {
  19825. svr.stop();
  19826. t.join();
  19827. ASSERT_FALSE(svr.is_running());
  19828. });
  19829. svr.wait_until_ready();
  19830. Client cli(HOST, PORT);
  19831. // Non-stream path
  19832. auto r1 = cli.Get(path);
  19833. ASSERT_TRUE(r1);
  19834. EXPECT_EQ(StatusCode::OK_200, r1->status);
  19835. // Stream path
  19836. auto h = cli.open_stream("GET", path);
  19837. ASSERT_TRUE(h.is_valid());
  19838. EXPECT_EQ(r1->body, read_all(h));
  19839. }
  19840. // Helper to compress data with provided compressor type T
  19841. template <typename Compressor>
  19842. static std::string compress_payload_for_parity(const std::string &in) {
  19843. std::string out;
  19844. Compressor compressor;
  19845. bool ok = compressor.compress(in.data(), in.size(), /*last=*/true,
  19846. [&](const char *data, size_t n) {
  19847. out.append(data, n);
  19848. return true;
  19849. });
  19850. EXPECT_TRUE(ok);
  19851. return out;
  19852. }
  19853. // Helper function for compression parity tests
  19854. template <typename Compressor>
  19855. static void test_compression_parity(const std::string &original,
  19856. const std::string &path,
  19857. const std::string &encoding) {
  19858. const std::string compressed =
  19859. compress_payload_for_parity<Compressor>(original);
  19860. Server svr;
  19861. svr.Get(path, [&](const Request & /*req*/, Response &res) {
  19862. res.set_content(compressed, "application/octet-stream");
  19863. res.set_header("Content-Encoding", encoding);
  19864. });
  19865. auto t = std::thread([&] { svr.listen(HOST, PORT); });
  19866. auto se = detail::scope_exit([&] {
  19867. svr.stop();
  19868. t.join();
  19869. ASSERT_FALSE(svr.is_running());
  19870. });
  19871. svr.wait_until_ready();
  19872. Client cli(HOST, PORT);
  19873. // Non-streaming
  19874. {
  19875. auto res = cli.Get(path);
  19876. ASSERT_TRUE(res) << "Error: " << to_string(res.error());
  19877. EXPECT_EQ(StatusCode::OK_200, res->status);
  19878. EXPECT_EQ(original, res->body);
  19879. }
  19880. // Streaming
  19881. {
  19882. auto h = cli.open_stream("GET", path);
  19883. ASSERT_TRUE(h.is_valid());
  19884. EXPECT_EQ(original, read_all(h));
  19885. }
  19886. }
  19887. #ifdef CPPHTTPLIB_ZLIB_SUPPORT
  19888. TEST(ParityTest, Gzip) {
  19889. test_compression_parity<detail::gzip_compressor>(
  19890. "The quick brown fox jumps over the lazy dog", "/parity-gzip", "gzip");
  19891. }
  19892. #endif
  19893. #ifdef CPPHTTPLIB_BROTLI_SUPPORT
  19894. TEST(ParityTest, Brotli) {
  19895. test_compression_parity<detail::brotli_compressor>(
  19896. "Hello, brotli parity test payload", "/parity-br", "br");
  19897. }
  19898. #endif
  19899. #ifdef CPPHTTPLIB_ZSTD_SUPPORT
  19900. TEST(ParityTest, Zstd) {
  19901. test_compression_parity<detail::zstd_compressor>(
  19902. "Zstandard parity test payload", "/parity-zstd", "zstd");
  19903. }
  19904. #endif
  19905. //==============================================================================
  19906. // New Stream API Tests
  19907. //==============================================================================
  19908. inline std::string read_body(httplib::stream::Result &result) {
  19909. std::string body;
  19910. while (result.next()) {
  19911. body.append(result.data(), result.size());
  19912. }
  19913. return body;
  19914. }
  19915. TEST(ClientConnectionTest, Basic) {
  19916. httplib::ClientConnection conn;
  19917. EXPECT_FALSE(conn.is_open());
  19918. conn.sock = 1;
  19919. EXPECT_TRUE(conn.is_open());
  19920. httplib::ClientConnection conn2(std::move(conn));
  19921. EXPECT_EQ(INVALID_SOCKET, conn.sock);
  19922. conn2.sock = INVALID_SOCKET;
  19923. }
  19924. // Unified test server for all stream::* tests
  19925. class StreamApiTest : public ::testing::Test {
  19926. protected:
  19927. void SetUp() override {
  19928. svr_.Get("/hello", [](const httplib::Request &, httplib::Response &res) {
  19929. res.set_content("Hello World!", "text/plain");
  19930. });
  19931. svr_.Get("/echo-params",
  19932. [](const httplib::Request &req, httplib::Response &res) {
  19933. std::string r;
  19934. for (const auto &p : req.params) {
  19935. if (!r.empty()) r += "&";
  19936. r += p.first + "=" + p.second;
  19937. }
  19938. res.set_content(r, "text/plain");
  19939. });
  19940. svr_.Post("/echo", [](const httplib::Request &req, httplib::Response &res) {
  19941. res.set_content(req.body, req.get_header_value("Content-Type"));
  19942. });
  19943. svr_.Post("/echo-headers",
  19944. [](const httplib::Request &req, httplib::Response &res) {
  19945. std::string r;
  19946. for (const auto &h : req.headers)
  19947. r += h.first + ": " + h.second + "\n";
  19948. res.set_content(r, "text/plain");
  19949. });
  19950. svr_.Post("/echo-params",
  19951. [](const httplib::Request &req, httplib::Response &res) {
  19952. std::string r = "params:";
  19953. for (const auto &p : req.params)
  19954. r += p.first + "=" + p.second + ";";
  19955. res.set_content(r + " body:" + req.body, "text/plain");
  19956. });
  19957. svr_.Post("/large", [](const httplib::Request &, httplib::Response &res) {
  19958. res.set_content(std::string(100 * 1024, 'X'), "application/octet-stream");
  19959. });
  19960. svr_.Put("/echo", [](const httplib::Request &req, httplib::Response &res) {
  19961. res.set_content("PUT:" + req.body, "text/plain");
  19962. });
  19963. svr_.Patch("/echo",
  19964. [](const httplib::Request &req, httplib::Response &res) {
  19965. res.set_content("PATCH:" + req.body, "text/plain");
  19966. });
  19967. svr_.Delete(
  19968. "/resource", [](const httplib::Request &req, httplib::Response &res) {
  19969. res.set_content(req.body.empty() ? "Deleted" : "Deleted:" + req.body,
  19970. "text/plain");
  19971. });
  19972. svr_.Get("/head-test",
  19973. [](const httplib::Request &, httplib::Response &res) {
  19974. res.set_content("body for HEAD", "text/plain");
  19975. });
  19976. svr_.Options("/options",
  19977. [](const httplib::Request &, httplib::Response &res) {
  19978. res.set_header("Allow", "GET, POST, PUT, DELETE, OPTIONS");
  19979. });
  19980. thread_ = std::thread([this]() { svr_.listen(HOST, PORT); });
  19981. svr_.wait_until_ready();
  19982. }
  19983. void TearDown() override {
  19984. svr_.stop();
  19985. if (thread_.joinable()) thread_.join();
  19986. }
  19987. httplib::Server svr_;
  19988. std::thread thread_;
  19989. };
  19990. // stream::Get tests
  19991. TEST_F(StreamApiTest, GetBasic) {
  19992. httplib::Client cli(HOST, PORT);
  19993. auto result = httplib::stream::Get(cli, "/hello");
  19994. ASSERT_TRUE(result.is_valid());
  19995. EXPECT_EQ(200, result.status());
  19996. EXPECT_EQ("Hello World!", read_body(result));
  19997. }
  19998. TEST_F(StreamApiTest, GetWithParams) {
  19999. httplib::Client cli(HOST, PORT);
  20000. httplib::Params params{{"foo", "bar"}};
  20001. auto result = httplib::stream::Get(cli, "/echo-params", params);
  20002. ASSERT_TRUE(result.is_valid());
  20003. EXPECT_TRUE(read_body(result).find("foo=bar") != std::string::npos);
  20004. }
  20005. #ifdef CPPHTTPLIB_ZLIB_SUPPORT
  20006. TEST_F(StreamApiTest, GetCompressedWithNoPayloadLimit) {
  20007. httplib::Client cli(HOST, PORT);
  20008. cli.set_payload_max_length(0);
  20009. auto result = httplib::stream::Get(cli, "/hello");
  20010. ASSERT_TRUE(result.is_valid());
  20011. EXPECT_FALSE(result.get_header_value("Content-Encoding").empty());
  20012. EXPECT_EQ("Hello World!", read_body(result));
  20013. }
  20014. #endif
  20015. TEST_F(StreamApiTest, GetConnectionError) {
  20016. httplib::Client cli(HOST, 9999);
  20017. EXPECT_FALSE(httplib::stream::Get(cli, "/hello").is_valid());
  20018. }
  20019. TEST_F(StreamApiTest, Get404) {
  20020. httplib::Client cli(HOST, PORT);
  20021. auto result = httplib::stream::Get(cli, "/nonexistent");
  20022. EXPECT_TRUE(result.is_valid());
  20023. EXPECT_EQ(404, result.status());
  20024. }
  20025. // stream::Post tests
  20026. TEST_F(StreamApiTest, PostBasic) {
  20027. httplib::Client cli(HOST, PORT);
  20028. auto result = httplib::stream::Post(cli, "/echo", R"({"key":"value"})",
  20029. "application/json");
  20030. ASSERT_TRUE(result.is_valid());
  20031. EXPECT_EQ("application/json", result.get_header_value("Content-Type"));
  20032. EXPECT_EQ(R"({"key":"value"})", read_body(result));
  20033. }
  20034. TEST_F(StreamApiTest, PostWithHeaders) {
  20035. httplib::Client cli(HOST, PORT);
  20036. httplib::Headers headers{{"X-Custom", "value"}};
  20037. auto result = httplib::stream::Post(cli, "/echo-headers", headers, "body",
  20038. "text/plain");
  20039. EXPECT_TRUE(read_body(result).find("X-Custom: value") != std::string::npos);
  20040. }
  20041. TEST_F(StreamApiTest, PostWithParams) {
  20042. httplib::Client cli(HOST, PORT);
  20043. httplib::Params params{{"k", "v"}};
  20044. auto result =
  20045. httplib::stream::Post(cli, "/echo-params", params, "data", "text/plain");
  20046. auto body = read_body(result);
  20047. EXPECT_TRUE(body.find("k=v") != std::string::npos);
  20048. EXPECT_TRUE(body.find("body:data") != std::string::npos);
  20049. }
  20050. TEST_F(StreamApiTest, PostLarge) {
  20051. httplib::Client cli(HOST, PORT);
  20052. auto result = httplib::stream::Post(cli, "/large", "", "text/plain");
  20053. size_t total = 0;
  20054. while (result.next()) {
  20055. total += result.size();
  20056. }
  20057. EXPECT_EQ(100u * 1024u, total);
  20058. }
  20059. // stream::Put/Patch tests
  20060. TEST_F(StreamApiTest, PutAndPatch) {
  20061. httplib::Client cli(HOST, PORT);
  20062. auto put = httplib::stream::Put(cli, "/echo", "test", "text/plain");
  20063. EXPECT_EQ("PUT:test", read_body(put));
  20064. auto patch = httplib::stream::Patch(cli, "/echo", "test", "text/plain");
  20065. EXPECT_EQ("PATCH:test", read_body(patch));
  20066. }
  20067. // stream::Delete tests
  20068. TEST_F(StreamApiTest, Delete) {
  20069. httplib::Client cli(HOST, PORT);
  20070. auto del1 = httplib::stream::Delete(cli, "/resource");
  20071. EXPECT_EQ("Deleted", read_body(del1));
  20072. auto del2 = httplib::stream::Delete(cli, "/resource", "data", "text/plain");
  20073. EXPECT_EQ("Deleted:data", read_body(del2));
  20074. }
  20075. // stream::Head/Options tests
  20076. TEST_F(StreamApiTest, HeadAndOptions) {
  20077. httplib::Client cli(HOST, PORT);
  20078. auto head = httplib::stream::Head(cli, "/head-test");
  20079. EXPECT_TRUE(head.is_valid());
  20080. EXPECT_FALSE(head.get_header_value("Content-Length").empty());
  20081. auto opts = httplib::stream::Options(cli, "/options");
  20082. EXPECT_EQ("GET, POST, PUT, DELETE, OPTIONS", opts.get_header_value("Allow"));
  20083. }
  20084. // SSL stream::* tests
  20085. #ifdef CPPHTTPLIB_SSL_ENABLED
  20086. class SSLStreamApiTest : public ::testing::Test {
  20087. protected:
  20088. void SetUp() override {
  20089. svr_.Get("/hello", [](const httplib::Request &, httplib::Response &res) {
  20090. res.set_content("Hello SSL!", "text/plain");
  20091. });
  20092. svr_.Post("/echo", [](const httplib::Request &req, httplib::Response &res) {
  20093. res.set_content(req.body, "text/plain");
  20094. });
  20095. port_ = svr_.bind_to_any_port("127.0.0.1");
  20096. thread_ = std::thread([this]() { svr_.listen_after_bind(); });
  20097. svr_.wait_until_ready();
  20098. }
  20099. void TearDown() override {
  20100. svr_.stop();
  20101. if (thread_.joinable()) thread_.join();
  20102. }
  20103. httplib::SSLServer svr_{"cert.pem", "key.pem"};
  20104. std::thread thread_;
  20105. int port_ = 0;
  20106. };
  20107. TEST_F(SSLStreamApiTest, GetAndPost) {
  20108. httplib::SSLClient cli("127.0.0.1", port_);
  20109. cli.enable_server_certificate_verification(false);
  20110. auto get = httplib::stream::Get(cli, "/hello");
  20111. EXPECT_EQ("Hello SSL!", read_body(get));
  20112. auto post = httplib::stream::Post(cli, "/echo", "test", "text/plain");
  20113. EXPECT_EQ("test", read_body(post));
  20114. }
  20115. #endif
  20116. // Tests for Error::Timeout and Error::ConnectionClosed error types
  20117. // These errors are set in SocketStream/SSLSocketStream and propagated through
  20118. // BodyReader
  20119. TEST(ErrorHandlingTest, StreamReadTimeout) {
  20120. // Test that read timeout during streaming is detected
  20121. // Use a large content-length response where server delays mid-stream
  20122. Server svr;
  20123. svr.Get("/slow-stream", [](const Request &, Response &res) {
  20124. // Send a large response with delay in the middle
  20125. res.set_content_provider(
  20126. 1000, // content_length
  20127. "text/plain", [](size_t offset, size_t /*length*/, DataSink &sink) {
  20128. if (offset < 100) {
  20129. // Send first 100 bytes immediately
  20130. std::string data(100, 'A');
  20131. sink.write(data.c_str(), data.size());
  20132. return true;
  20133. }
  20134. // Then delay longer than client timeout
  20135. std::this_thread::sleep_for(std::chrono::seconds(3));
  20136. std::string data(900, 'B');
  20137. sink.write(data.c_str(), data.size());
  20138. return true;
  20139. });
  20140. });
  20141. auto port = 8091;
  20142. std::thread t([&]() { svr.listen("localhost", port); });
  20143. svr.wait_until_ready();
  20144. Client cli("localhost", port);
  20145. cli.set_read_timeout(1, 0); // 1 second timeout
  20146. auto handle = cli.open_stream("GET", "/slow-stream");
  20147. ASSERT_TRUE(handle.is_valid());
  20148. char buf[256];
  20149. ssize_t total = 0;
  20150. ssize_t n;
  20151. bool got_error = false;
  20152. while ((n = handle.read(buf, sizeof(buf))) > 0) {
  20153. total += n;
  20154. }
  20155. if (n < 0) {
  20156. got_error = true;
  20157. // Should be timeout or read error
  20158. EXPECT_TRUE(handle.get_read_error() == Error::Timeout ||
  20159. handle.get_read_error() == Error::Read)
  20160. << "Actual error: " << to_string(handle.get_read_error());
  20161. }
  20162. // Either we got an error, or we got less data than expected
  20163. EXPECT_TRUE(got_error || total < 1000)
  20164. << "Expected timeout but got all " << total << " bytes";
  20165. svr.stop();
  20166. t.join();
  20167. }
  20168. TEST(ErrorHandlingTest, StreamConnectionClosed) {
  20169. // Test connection closed detection via BodyReader
  20170. Server svr;
  20171. std::atomic<bool> close_now{false};
  20172. svr.Get("/will-close", [&](const Request &, Response &res) {
  20173. res.set_content_provider(
  20174. 10000, // Large content_length that we won't fully send
  20175. "text/plain", [&](size_t offset, size_t /*length*/, DataSink &sink) {
  20176. if (offset < 100) {
  20177. std::string data(100, 'X');
  20178. sink.write(data.c_str(), data.size());
  20179. return true;
  20180. }
  20181. // Wait for signal then abort
  20182. while (!close_now) {
  20183. std::this_thread::sleep_for(std::chrono::milliseconds(10));
  20184. }
  20185. return false; // Abort - server will close connection
  20186. });
  20187. });
  20188. auto port = 8092;
  20189. std::thread t([&]() { svr.listen("localhost", port); });
  20190. svr.wait_until_ready();
  20191. Client cli("localhost", port);
  20192. auto handle = cli.open_stream("GET", "/will-close");
  20193. ASSERT_TRUE(handle.is_valid());
  20194. char buf[256];
  20195. ssize_t n = handle.read(buf, sizeof(buf)); // First read
  20196. EXPECT_GT(n, 0) << "First read should succeed";
  20197. // Signal server to close
  20198. close_now = true;
  20199. // Keep reading until error or EOF
  20200. while ((n = handle.read(buf, sizeof(buf))) > 0) {
  20201. // Keep reading
  20202. }
  20203. // Should get an error since content_length wasn't satisfied
  20204. if (n < 0) {
  20205. EXPECT_TRUE(handle.get_read_error() == Error::ConnectionClosed ||
  20206. handle.get_read_error() == Error::Read)
  20207. << "Actual error: " << to_string(handle.get_read_error());
  20208. }
  20209. svr.stop();
  20210. t.join();
  20211. }
  20212. #ifdef CPPHTTPLIB_SSL_ENABLED
  20213. TEST(ErrorHandlingTest, SSLStreamReadTimeout) {
  20214. // Test that read timeout during SSL streaming is detected
  20215. SSLServer svr(SERVER_CERT_FILE, SERVER_PRIVATE_KEY_FILE);
  20216. svr.Get("/slow-stream", [](const Request &, Response &res) {
  20217. res.set_content_provider(
  20218. 1000, "text/plain",
  20219. [](size_t offset, size_t /*length*/, DataSink &sink) {
  20220. if (offset < 100) {
  20221. std::string data(100, 'A');
  20222. sink.write(data.c_str(), data.size());
  20223. return true;
  20224. }
  20225. std::this_thread::sleep_for(std::chrono::seconds(3));
  20226. std::string data(900, 'B');
  20227. sink.write(data.c_str(), data.size());
  20228. return true;
  20229. });
  20230. });
  20231. auto port = 8093;
  20232. std::thread t([&]() { svr.listen("localhost", port); });
  20233. svr.wait_until_ready();
  20234. SSLClient cli("localhost", port);
  20235. cli.enable_server_certificate_verification(false);
  20236. cli.set_read_timeout(1, 0); // 1 second timeout
  20237. auto handle = cli.open_stream("GET", "/slow-stream");
  20238. ASSERT_TRUE(handle.is_valid());
  20239. char buf[256];
  20240. ssize_t total = 0;
  20241. ssize_t n;
  20242. bool got_error = false;
  20243. while ((n = handle.read(buf, sizeof(buf))) > 0) {
  20244. total += n;
  20245. }
  20246. if (n < 0) {
  20247. got_error = true;
  20248. EXPECT_TRUE(handle.get_read_error() == Error::Timeout ||
  20249. handle.get_read_error() == Error::Read)
  20250. << "Actual error: " << to_string(handle.get_read_error());
  20251. }
  20252. EXPECT_TRUE(got_error || total < 1000)
  20253. << "Expected timeout but got all " << total << " bytes";
  20254. svr.stop();
  20255. t.join();
  20256. }
  20257. TEST(ErrorHandlingTest, SSLStreamConnectionClosed) {
  20258. // Test SSL connection closed detection
  20259. SSLServer svr(SERVER_CERT_FILE, SERVER_PRIVATE_KEY_FILE);
  20260. std::atomic<bool> close_now{false};
  20261. svr.Get("/will-close", [&](const Request &, Response &res) {
  20262. res.set_content_provider(
  20263. 10000, "text/plain",
  20264. [&](size_t offset, size_t /*length*/, DataSink &sink) {
  20265. if (offset < 100) {
  20266. std::string data(100, 'X');
  20267. sink.write(data.c_str(), data.size());
  20268. return true;
  20269. }
  20270. while (!close_now) {
  20271. std::this_thread::sleep_for(std::chrono::milliseconds(10));
  20272. }
  20273. return false;
  20274. });
  20275. });
  20276. auto port = 8094;
  20277. std::thread t([&]() { svr.listen("localhost", port); });
  20278. svr.wait_until_ready();
  20279. SSLClient cli("localhost", port);
  20280. cli.enable_server_certificate_verification(false);
  20281. auto handle = cli.open_stream("GET", "/will-close");
  20282. ASSERT_TRUE(handle.is_valid());
  20283. char buf[256];
  20284. ssize_t n = handle.read(buf, sizeof(buf)); // First read
  20285. EXPECT_GT(n, 0);
  20286. // Signal server to close
  20287. close_now = true;
  20288. while ((n = handle.read(buf, sizeof(buf))) > 0) {
  20289. // Keep reading
  20290. }
  20291. if (n < 0) {
  20292. EXPECT_TRUE(handle.get_read_error() == Error::ConnectionClosed ||
  20293. handle.get_read_error() == Error::Read)
  20294. << "Actual error: " << to_string(handle.get_read_error());
  20295. }
  20296. svr.stop();
  20297. t.join();
  20298. }
  20299. #endif
  20300. TEST(ETagTest, StaticFileETagAndIfNoneMatch) {
  20301. using namespace httplib;
  20302. // Create a test file
  20303. const char *fname = "etag_testfile.txt";
  20304. const char *content = "etag-content";
  20305. {
  20306. std::ofstream ofs(fname);
  20307. ofs << content;
  20308. ASSERT_TRUE(ofs.good());
  20309. }
  20310. Server svr;
  20311. svr.set_mount_point("/static", ".");
  20312. auto t = std::thread([&]() { svr.listen("localhost", PORT); });
  20313. svr.wait_until_ready();
  20314. Client cli(HOST, PORT);
  20315. // First request: should get 200 with ETag header
  20316. auto res1 = cli.Get("/static/etag_testfile.txt");
  20317. ASSERT_TRUE(res1);
  20318. ASSERT_EQ(200, res1->status);
  20319. ASSERT_TRUE(res1->has_header("ETag"));
  20320. std::string etag = res1->get_header_value("ETag");
  20321. EXPECT_FALSE(etag.empty());
  20322. // Verify ETag format: W/"hex-hex"
  20323. ASSERT_GE(etag.length(), 5u); // Minimum: W/""
  20324. EXPECT_EQ('W', etag[0]);
  20325. EXPECT_EQ('/', etag[1]);
  20326. EXPECT_EQ('"', etag[2]);
  20327. EXPECT_EQ('"', etag.back());
  20328. // Exact match: expect 304 Not Modified
  20329. Headers h2 = {{"If-None-Match", etag}};
  20330. auto res2 = cli.Get("/static/etag_testfile.txt", h2);
  20331. ASSERT_TRUE(res2);
  20332. EXPECT_EQ(304, res2->status);
  20333. // Wildcard match: expect 304 Not Modified
  20334. Headers h3 = {{"If-None-Match", "*"}};
  20335. auto res3 = cli.Get("/static/etag_testfile.txt", h3);
  20336. ASSERT_TRUE(res3);
  20337. EXPECT_EQ(304, res3->status);
  20338. // Non-matching ETag: expect 200
  20339. Headers h4 = {{"If-None-Match", "W/\"deadbeef\""}};
  20340. auto res4 = cli.Get("/static/etag_testfile.txt", h4);
  20341. ASSERT_TRUE(res4);
  20342. EXPECT_EQ(200, res4->status);
  20343. // Multiple ETags with one matching: expect 304
  20344. Headers h5 = {{"If-None-Match", "W/\"other\", " + etag + ", W/\"another\""}};
  20345. auto res5 = cli.Get("/static/etag_testfile.txt", h5);
  20346. ASSERT_TRUE(res5);
  20347. EXPECT_EQ(304, res5->status);
  20348. // The ETag list split over several field lines: RFC 9110 Section 5.3 makes
  20349. // that equivalent to the single comma-separated list above, so the match on
  20350. // the second line must still be found.
  20351. Headers h6;
  20352. h6.emplace("If-None-Match", "W/\"other\"");
  20353. h6.emplace("If-None-Match", etag);
  20354. auto res6 = cli.Get("/static/etag_testfile.txt", h6);
  20355. ASSERT_TRUE(res6);
  20356. EXPECT_EQ(304, res6->status);
  20357. svr.stop();
  20358. t.join();
  20359. std::remove(fname);
  20360. }
  20361. TEST(ETagTest, StaticFileETagIfNoneMatchStarNotFound) {
  20362. using namespace httplib;
  20363. Server svr;
  20364. svr.set_mount_point("/static", ".");
  20365. auto t = std::thread([&]() { svr.listen(HOST, PORT); });
  20366. svr.wait_until_ready();
  20367. Client cli(HOST, PORT);
  20368. // Send If-None-Match: * to a non-existent file
  20369. Headers h = {{"If-None-Match", "*"}};
  20370. auto res = cli.Get("/static/etag_testfile_notfound.txt", h);
  20371. ASSERT_TRUE(res) << "Error: " << to_string(res.error());
  20372. EXPECT_EQ(404, res->status);
  20373. svr.stop();
  20374. t.join();
  20375. }
  20376. TEST(ETagTest, IfNoneMatchBoundaryCheck) {
  20377. using namespace httplib;
  20378. // Create a test file
  20379. const char *fname = "etag_boundary_testfile.txt";
  20380. const char *content = "boundary-test";
  20381. {
  20382. std::ofstream ofs(fname);
  20383. ofs << content;
  20384. ASSERT_TRUE(ofs.good());
  20385. }
  20386. Server svr;
  20387. svr.set_mount_point("/static", ".");
  20388. auto t = std::thread([&]() { svr.listen("localhost", PORT); });
  20389. svr.wait_until_ready();
  20390. Client cli(HOST, PORT);
  20391. // Get the actual ETag
  20392. auto res1 = cli.Get("/static/etag_boundary_testfile.txt");
  20393. ASSERT_TRUE(res1);
  20394. ASSERT_EQ(200, res1->status);
  20395. ASSERT_TRUE(res1->has_header("ETag"));
  20396. std::string etag = res1->get_header_value("ETag");
  20397. // Test 1: Very long ETag value (longer than actual ETag)
  20398. // Should NOT match and return 200 (not trigger out-of-bounds read)
  20399. Headers h1 = {{"If-None-Match", "W/"
  20400. "\"very-long-etag-value-that-is-much-longer-"
  20401. "than-the-actual-etag-value\""}};
  20402. auto res2 = cli.Get("/static/etag_boundary_testfile.txt", h1);
  20403. ASSERT_TRUE(res2);
  20404. EXPECT_EQ(200, res2->status); // Should not match
  20405. // Test 2: Long string followed by wildcard
  20406. // Should match on "*" and return 304 (without out-of-bounds read on the long
  20407. // string)
  20408. Headers h2 = {{"If-None-Match", "W/\"another-very-long-value\", *"}};
  20409. auto res3 = cli.Get("/static/etag_boundary_testfile.txt", h2);
  20410. ASSERT_TRUE(res3);
  20411. EXPECT_EQ(304, res3->status); // Should match on "*"
  20412. // Test 3: Wildcard followed by long string
  20413. // Should match on "*" immediately and return 304
  20414. Headers h3 = {{"If-None-Match", "*, W/\"long-value-after-wildcard\""}};
  20415. auto res4 = cli.Get("/static/etag_boundary_testfile.txt", h3);
  20416. ASSERT_TRUE(res4);
  20417. EXPECT_EQ(304, res4->status); // Should match on "*"
  20418. // Test 4: Multiple long non-matching values
  20419. // Should NOT match and return 200 (test that all comparisons are safe)
  20420. Headers h4 = {{"If-None-Match", "W/\"first-long-non-matching-value\", "
  20421. "W/\"second-long-non-matching-value\", "
  20422. "W/\"third-long-non-matching-value\""}};
  20423. auto res5 = cli.Get("/static/etag_boundary_testfile.txt", h4);
  20424. ASSERT_TRUE(res5);
  20425. EXPECT_EQ(200, res5->status); // Should not match
  20426. // Test 5: Single character that is not "*" (edge case)
  20427. Headers h5 = {{"If-None-Match", "X"}};
  20428. auto res6 = cli.Get("/static/etag_boundary_testfile.txt", h5);
  20429. ASSERT_TRUE(res6);
  20430. EXPECT_EQ(200, res6->status); // Should not match
  20431. svr.stop();
  20432. t.join();
  20433. std::remove(fname);
  20434. }
  20435. TEST(ETagTest, LastModifiedAndIfModifiedSince) {
  20436. using namespace httplib;
  20437. // Create a test file
  20438. const char *fname = "ims_testfile.txt";
  20439. const char *content = "if-modified-since-test";
  20440. {
  20441. std::ofstream ofs(fname);
  20442. ofs << content;
  20443. ASSERT_TRUE(ofs.good());
  20444. }
  20445. Server svr;
  20446. svr.set_mount_point("/static", ".");
  20447. auto t = std::thread([&]() { svr.listen(HOST, PORT); });
  20448. svr.wait_until_ready();
  20449. Client cli(HOST, PORT);
  20450. // First request: should get 200 with Last-Modified header
  20451. auto res1 = cli.Get("/static/ims_testfile.txt");
  20452. ASSERT_TRUE(res1);
  20453. ASSERT_EQ(200, res1->status);
  20454. ASSERT_TRUE(res1->has_header("Last-Modified"));
  20455. std::string last_modified = res1->get_header_value("Last-Modified");
  20456. EXPECT_FALSE(last_modified.empty());
  20457. // If-Modified-Since with same time: expect 304
  20458. Headers h2 = {{"If-Modified-Since", last_modified}};
  20459. auto res2 = cli.Get("/static/ims_testfile.txt", h2);
  20460. ASSERT_TRUE(res2);
  20461. EXPECT_EQ(304, res2->status);
  20462. // If-Modified-Since with future time: expect 304
  20463. Headers h3 = {{"If-Modified-Since", "Sun, 01 Jan 2099 00:00:00 GMT"}};
  20464. auto res3 = cli.Get("/static/ims_testfile.txt", h3);
  20465. ASSERT_TRUE(res3);
  20466. EXPECT_EQ(304, res3->status);
  20467. // If-Modified-Since with past time: expect 200
  20468. Headers h4 = {{"If-Modified-Since", "Sun, 01 Jan 2000 00:00:00 GMT"}};
  20469. auto res4 = cli.Get("/static/ims_testfile.txt", h4);
  20470. ASSERT_TRUE(res4);
  20471. EXPECT_EQ(200, res4->status);
  20472. // If-None-Match takes precedence over If-Modified-Since
  20473. // (send matching ETag with old If-Modified-Since -> should still be 304)
  20474. ASSERT_TRUE(res1->has_header("ETag"));
  20475. std::string etag = res1->get_header_value("ETag");
  20476. Headers h5 = {{"If-None-Match", etag},
  20477. {"If-Modified-Since", "Sun, 01 Jan 2000 00:00:00 GMT"}};
  20478. auto res5 = cli.Get("/static/ims_testfile.txt", h5);
  20479. ASSERT_TRUE(res5);
  20480. EXPECT_EQ(304, res5->status);
  20481. svr.stop();
  20482. t.join();
  20483. std::remove(fname);
  20484. }
  20485. TEST(ETagTest, VaryAcceptEncodingWithCompression) {
  20486. using namespace httplib;
  20487. Server svr;
  20488. // Endpoint that returns compressible content
  20489. svr.Get("/compressible", [](const Request &, Response &res) {
  20490. // Return a large enough body to trigger compression
  20491. std::string body(1000, 'a');
  20492. res.set_content(body, "text/plain");
  20493. });
  20494. auto t = std::thread([&]() { svr.listen(HOST, PORT); });
  20495. svr.wait_until_ready();
  20496. Client cli(HOST, PORT);
  20497. // Request with gzip support: should get Vary header when compressed
  20498. cli.set_compress(true);
  20499. auto res1 = cli.Get("/compressible");
  20500. ASSERT_TRUE(res1);
  20501. EXPECT_EQ(200, res1->status);
  20502. // If Content-Encoding is set, Vary should also be set
  20503. if (res1->has_header("Content-Encoding")) {
  20504. EXPECT_TRUE(res1->has_header("Vary"));
  20505. EXPECT_EQ("Accept-Encoding", res1->get_header_value("Vary"));
  20506. }
  20507. // Request without Accept-Encoding header: should not have compression
  20508. Headers h_no_compress;
  20509. auto res2 = cli.Get("/compressible", h_no_compress);
  20510. ASSERT_TRUE(res2);
  20511. EXPECT_EQ(200, res2->status);
  20512. // Verify Vary header is present when compression is applied
  20513. // (the exact behavior depends on server configuration)
  20514. svr.stop();
  20515. t.join();
  20516. }
  20517. TEST(ETagTest, IfRangeWithETag) {
  20518. using namespace httplib;
  20519. // Create a test file with known content
  20520. const char *fname = "if_range_testfile.txt";
  20521. const std::string content = "0123456789ABCDEFGHIJ"; // 20 bytes
  20522. {
  20523. std::ofstream ofs(fname);
  20524. ofs << content;
  20525. ASSERT_TRUE(ofs.good());
  20526. }
  20527. Server svr;
  20528. svr.set_mount_point("/static", ".");
  20529. auto t = std::thread([&]() { svr.listen(HOST, PORT); });
  20530. svr.wait_until_ready();
  20531. Client cli(HOST, PORT);
  20532. // First request: get ETag
  20533. auto res1 = cli.Get("/static/if_range_testfile.txt");
  20534. ASSERT_TRUE(res1);
  20535. ASSERT_EQ(200, res1->status);
  20536. ASSERT_TRUE(res1->has_header("ETag"));
  20537. std::string etag = res1->get_header_value("ETag");
  20538. // RFC 9110 Section 13.1.5: If-Range requires strong ETag comparison.
  20539. // Since our server generates weak ETags (W/"..."), If-Range with our
  20540. // ETag should NOT result in partial content - it should return full content.
  20541. Headers h2 = {{"Range", "bytes=0-4"}, {"If-Range", etag}};
  20542. auto res2 = cli.Get("/static/if_range_testfile.txt", h2);
  20543. ASSERT_TRUE(res2);
  20544. // Weak ETag in If-Range -> full content (200), not partial (206)
  20545. EXPECT_EQ(200, res2->status);
  20546. EXPECT_EQ(content, res2->body);
  20547. EXPECT_FALSE(res2->has_header("Content-Range"));
  20548. // Range request with non-matching If-Range (ETag): should get 200 (full
  20549. // content)
  20550. Headers h3 = {{"Range", "bytes=0-4"}, {"If-Range", "W/\"wrong-etag\""}};
  20551. auto res3 = cli.Get("/static/if_range_testfile.txt", h3);
  20552. ASSERT_TRUE(res3);
  20553. EXPECT_EQ(200, res3->status);
  20554. EXPECT_EQ(content, res3->body);
  20555. EXPECT_FALSE(res3->has_header("Content-Range"));
  20556. // Range request with strong ETag (hypothetical - our server doesn't generate
  20557. // strong ETags, but if client sends a strong ETag that doesn't match, it
  20558. // should return full content)
  20559. Headers h4 = {{"Range", "bytes=0-4"}, {"If-Range", "\"strong-etag\""}};
  20560. auto res4 = cli.Get("/static/if_range_testfile.txt", h4);
  20561. ASSERT_TRUE(res4);
  20562. EXPECT_EQ(200, res4->status);
  20563. EXPECT_EQ(content, res4->body);
  20564. EXPECT_FALSE(res4->has_header("Content-Range"));
  20565. svr.stop();
  20566. t.join();
  20567. std::remove(fname);
  20568. }
  20569. TEST(ETagTest, IfRangeWithDate) {
  20570. using namespace httplib;
  20571. // Create a test file
  20572. const char *fname = "if_range_date_testfile.txt";
  20573. const std::string content = "ABCDEFGHIJ0123456789"; // 20 bytes
  20574. {
  20575. std::ofstream ofs(fname);
  20576. ofs << content;
  20577. ASSERT_TRUE(ofs.good());
  20578. }
  20579. Server svr;
  20580. svr.set_mount_point("/static", ".");
  20581. auto t = std::thread([&]() { svr.listen(HOST, PORT); });
  20582. svr.wait_until_ready();
  20583. Client cli(HOST, PORT);
  20584. // First request: get Last-Modified
  20585. auto res1 = cli.Get("/static/if_range_date_testfile.txt");
  20586. ASSERT_TRUE(res1);
  20587. ASSERT_EQ(200, res1->status);
  20588. ASSERT_TRUE(res1->has_header("Last-Modified"));
  20589. std::string last_modified = res1->get_header_value("Last-Modified");
  20590. // Range request with matching If-Range (date): should get 206
  20591. Headers h2 = {{"Range", "bytes=5-9"}, {"If-Range", last_modified}};
  20592. auto res2 = cli.Get("/static/if_range_date_testfile.txt", h2);
  20593. ASSERT_TRUE(res2);
  20594. EXPECT_EQ(206, res2->status);
  20595. EXPECT_EQ("FGHIJ", res2->body);
  20596. // Range request with old If-Range date: should get 200 (full content)
  20597. Headers h3 = {{"Range", "bytes=5-9"},
  20598. {"If-Range", "Sun, 01 Jan 2000 00:00:00 GMT"}};
  20599. auto res3 = cli.Get("/static/if_range_date_testfile.txt", h3);
  20600. ASSERT_TRUE(res3);
  20601. EXPECT_EQ(200, res3->status);
  20602. EXPECT_EQ(content, res3->body);
  20603. // Range request with future If-Range date: should get 206
  20604. Headers h4 = {{"Range", "bytes=0-4"},
  20605. {"If-Range", "Sun, 01 Jan 2099 00:00:00 GMT"}};
  20606. auto res4 = cli.Get("/static/if_range_date_testfile.txt", h4);
  20607. ASSERT_TRUE(res4);
  20608. EXPECT_EQ(206, res4->status);
  20609. EXPECT_EQ("ABCDE", res4->body);
  20610. svr.stop();
  20611. t.join();
  20612. std::remove(fname);
  20613. }
  20614. TEST(ETagTest, MalformedIfNoneMatchAndWhitespace) {
  20615. using namespace httplib;
  20616. const char *fname = "etag_malformed.txt";
  20617. const char *content = "malformed-etag";
  20618. {
  20619. std::ofstream ofs(fname);
  20620. ofs << content;
  20621. ASSERT_TRUE(ofs.good());
  20622. }
  20623. Server svr;
  20624. svr.set_mount_point("/static", ".");
  20625. auto t = std::thread([&]() { svr.listen(HOST, PORT); });
  20626. svr.wait_until_ready();
  20627. Client cli(HOST, PORT);
  20628. // baseline: should get 200 and an ETag
  20629. auto res1 = cli.Get("/static/etag_malformed.txt");
  20630. ASSERT_TRUE(res1);
  20631. ASSERT_EQ(200, res1->status);
  20632. ASSERT_TRUE(res1->has_header("ETag"));
  20633. // Malformed ETag value (missing quotes) should be treated as non-matching
  20634. Headers h_bad = {{"If-None-Match", "W/noquotes"}};
  20635. auto res_bad = cli.Get("/static/etag_malformed.txt", h_bad);
  20636. ASSERT_TRUE(res_bad);
  20637. EXPECT_EQ(200, res_bad->status);
  20638. // Whitespace-only header value should be considered invalid / non-matching
  20639. std::string raw_req = "GET /static/etag_malformed.txt HTTP/1.1\r\n"
  20640. "Host: localhost\r\n"
  20641. "If-None-Match: \r\n"
  20642. "Connection: close\r\n"
  20643. "\r\n";
  20644. std::string out;
  20645. ASSERT_TRUE(send_request(5, raw_req, &out));
  20646. EXPECT_EQ("HTTP/1.1 200 OK", out.substr(0, 15));
  20647. svr.stop();
  20648. t.join();
  20649. std::remove(fname);
  20650. }
  20651. TEST(ETagTest, InvalidIfModifiedSinceAndIfRangeDate) {
  20652. using namespace httplib;
  20653. const char *fname = "ims_invalid_format.txt";
  20654. const char *content = "ims-bad-format";
  20655. {
  20656. std::ofstream ofs(fname);
  20657. ofs << content;
  20658. ASSERT_TRUE(ofs.good());
  20659. }
  20660. Server svr;
  20661. svr.set_mount_point("/static", ".");
  20662. auto t = std::thread([&]() { svr.listen(HOST, PORT); });
  20663. svr.wait_until_ready();
  20664. Client cli(HOST, PORT);
  20665. auto res1 = cli.Get("/static/ims_invalid_format.txt");
  20666. ASSERT_TRUE(res1);
  20667. ASSERT_EQ(200, res1->status);
  20668. ASSERT_TRUE(res1->has_header("Last-Modified"));
  20669. // If-Modified-Since with invalid format should not result in 304
  20670. Headers h_bad_date = {{"If-Modified-Since", "not-a-valid-date"}};
  20671. auto res_bad = cli.Get("/static/ims_invalid_format.txt", h_bad_date);
  20672. ASSERT_TRUE(res_bad);
  20673. EXPECT_EQ(200, res_bad->status);
  20674. // If-Range with invalid date format should be treated as mismatch -> full
  20675. // content (200)
  20676. Headers h_ifrange_bad = {{"Range", "bytes=0-3"},
  20677. {"If-Range", "invalid-date"}};
  20678. auto res_ifrange = cli.Get("/static/ims_invalid_format.txt", h_ifrange_bad);
  20679. ASSERT_TRUE(res_ifrange);
  20680. EXPECT_EQ(200, res_ifrange->status);
  20681. svr.stop();
  20682. t.join();
  20683. std::remove(fname);
  20684. }
  20685. TEST(ETagTest, IfRangeWithMalformedETag) {
  20686. using namespace httplib;
  20687. const char *fname = "ifrange_malformed.txt";
  20688. const std::string content = "0123456789";
  20689. {
  20690. std::ofstream ofs(fname);
  20691. ofs << content;
  20692. ASSERT_TRUE(ofs.good());
  20693. }
  20694. Server svr;
  20695. svr.set_mount_point("/static", ".");
  20696. auto t = std::thread([&]() { svr.listen(HOST, PORT); });
  20697. svr.wait_until_ready();
  20698. Client cli(HOST, PORT);
  20699. // First request: get ETag
  20700. auto res1 = cli.Get("/static/ifrange_malformed.txt");
  20701. ASSERT_TRUE(res1);
  20702. ASSERT_EQ(200, res1->status);
  20703. ASSERT_TRUE(res1->has_header("ETag"));
  20704. // If-Range with malformed ETag (no quotes) should be treated as mismatch ->
  20705. // full content (200)
  20706. Headers h_malformed = {{"Range", "bytes=0-4"}, {"If-Range", "W/noquotes"}};
  20707. auto res2 = cli.Get("/static/ifrange_malformed.txt", h_malformed);
  20708. ASSERT_TRUE(res2);
  20709. EXPECT_EQ(200, res2->status);
  20710. EXPECT_EQ(content, res2->body);
  20711. svr.stop();
  20712. t.join();
  20713. std::remove(fname);
  20714. }
  20715. TEST(ETagTest, ExtremeLargeDateValues) {
  20716. using namespace httplib;
  20717. const char *fname = "ims_extreme_date.txt";
  20718. const char *content = "ims-extreme-date";
  20719. {
  20720. std::ofstream ofs(fname);
  20721. ofs << content;
  20722. ASSERT_TRUE(ofs.good());
  20723. }
  20724. Server svr;
  20725. svr.set_mount_point("/static", ".");
  20726. auto t = std::thread([&]() { svr.listen(HOST, PORT); });
  20727. svr.wait_until_ready();
  20728. Client cli(HOST, PORT);
  20729. auto res1 = cli.Get(std::string("/static/") + fname);
  20730. ASSERT_TRUE(res1);
  20731. ASSERT_EQ(200, res1->status);
  20732. ASSERT_TRUE(res1->has_header("Last-Modified"));
  20733. // Extremely large year that may overflow date parsing routines.
  20734. Headers h_large_date = {
  20735. {"If-Modified-Since", "Sun, 01 Jan 99999 00:00:00 GMT"}};
  20736. auto res_bad = cli.Get(std::string("/static/") + fname, h_large_date);
  20737. ASSERT_TRUE(res_bad);
  20738. // Expect server to treat this as invalid/mismatch and return full content
  20739. EXPECT_EQ(200, res_bad->status);
  20740. // If-Range with extremely large date should be treated as mismatch -> full
  20741. // content (200)
  20742. Headers h_ifrange_large = {{"Range", "bytes=0-3"},
  20743. {"If-Range", "Sun, 01 Jan 99999 00:00:00 GMT"}};
  20744. auto res_ifrange = cli.Get(std::string("/static/") + fname, h_ifrange_large);
  20745. ASSERT_TRUE(res_ifrange);
  20746. EXPECT_EQ(200, res_ifrange->status);
  20747. svr.stop();
  20748. t.join();
  20749. std::remove(fname);
  20750. }
  20751. TEST(ETagTest, NegativeFileModificationTime) {
  20752. using namespace httplib;
  20753. const char *fname = "ims_negative_mtime.txt";
  20754. const std::string content = "negative-mtime";
  20755. {
  20756. std::ofstream ofs(fname);
  20757. ofs << content;
  20758. ASSERT_TRUE(ofs.good());
  20759. }
  20760. // Try to set file mtime to a negative value. This may fail on some
  20761. // platforms/filesystems; if it fails, the test will still verify server
  20762. // behaves safely by performing a regular conditional request.
  20763. #if defined(__APPLE__) || defined(__linux__)
  20764. bool set_negative = false;
  20765. do {
  20766. struct timeval times[2];
  20767. // access time: now
  20768. times[0].tv_sec = time(nullptr);
  20769. times[0].tv_usec = 0;
  20770. // modification time: negative (e.g., -1)
  20771. times[1].tv_sec = -1;
  20772. times[1].tv_usec = 0;
  20773. if (utimes(fname, times) == 0) { set_negative = true; }
  20774. } while (0);
  20775. #else
  20776. bool set_negative = false;
  20777. #endif
  20778. Server svr;
  20779. svr.set_mount_point("/static", ".");
  20780. auto t = std::thread([&]() { svr.listen(HOST, PORT); });
  20781. svr.wait_until_ready();
  20782. Client cli(HOST, PORT);
  20783. auto res1 = cli.Get(std::string("/static/") + fname);
  20784. ASSERT_TRUE(res1);
  20785. ASSERT_EQ(200, res1->status);
  20786. bool has_last_modified = res1->has_header("Last-Modified");
  20787. std::string last_modified;
  20788. if (has_last_modified) {
  20789. last_modified = res1->get_header_value("Last-Modified");
  20790. }
  20791. if (set_negative) {
  20792. // If we successfully set a negative mtime, ensure server returns a
  20793. // Last-Modified string (may be empty or normalized). Send If-Modified-Since
  20794. // with an old date and ensure server handles it without crash.
  20795. Headers h_old = {{"If-Modified-Since", "Sun, 01 Jan 1970 00:00:00 GMT"}};
  20796. auto res2 = cli.Get(std::string("/static/") + fname, h_old);
  20797. ASSERT_TRUE(res2);
  20798. // Behavior may vary; at minimum ensure server responds (200 or 304).
  20799. EXPECT_TRUE(res2->status == 200 || res2->status == 304);
  20800. } else {
  20801. // Could not set negative mtime on this platform; fall back to verifying
  20802. // that normal invalid/malformed dates are treated safely (non-304).
  20803. Headers h_bad_date = {
  20804. {"If-Modified-Since", "Sun, 01 Jan 99999 00:00:00 GMT"}};
  20805. auto res_bad = cli.Get(std::string("/static/") + fname, h_bad_date);
  20806. ASSERT_TRUE(res_bad);
  20807. EXPECT_EQ(200, res_bad->status);
  20808. }
  20809. svr.stop();
  20810. t.join();
  20811. std::remove(fname);
  20812. }
  20813. //==============================================================================
  20814. // Integration Tests with Server
  20815. //==============================================================================
  20816. class SSEIntegrationTest : public ::testing::Test {
  20817. protected:
  20818. void SetUp() override {
  20819. stop_server_.store(false);
  20820. events_.clear();
  20821. server_ = httplib::detail::make_unique<Server>();
  20822. setup_server();
  20823. start_server();
  20824. }
  20825. void TearDown() override {
  20826. stop_server_.store(true);
  20827. event_cv_.notify_all();
  20828. server_->stop();
  20829. if (server_thread_.joinable()) { server_thread_.join(); }
  20830. }
  20831. void setup_server() {
  20832. // Simple SSE endpoint
  20833. server_->Get("/events", [this](const Request &req, Response &res) {
  20834. auto last_id = req.get_header_value("Last-Event-ID");
  20835. if (!last_id.empty()) { last_received_event_id_ = last_id; }
  20836. res.set_chunked_content_provider(
  20837. "text/event-stream", [this](size_t /*offset*/, DataSink &sink) {
  20838. std::unique_lock<std::mutex> lock(event_mutex_);
  20839. if (event_cv_.wait_for(
  20840. lock, std::chrono::milliseconds(200), [this] {
  20841. return !events_.empty() || stop_server_.load();
  20842. })) {
  20843. if (stop_server_.load()) { return false; }
  20844. if (!events_.empty()) {
  20845. std::string event = events_.front();
  20846. events_.erase(events_.begin());
  20847. sink.write(event.data(), event.size());
  20848. return true;
  20849. }
  20850. }
  20851. return !stop_server_.load();
  20852. });
  20853. });
  20854. // Endpoint that returns error
  20855. server_->Get("/error-endpoint", [](const Request &, Response &res) {
  20856. res.status = 500;
  20857. res.set_content("Internal Server Error", "text/plain");
  20858. });
  20859. // Endpoint for custom event types
  20860. server_->Get("/custom-events", [](const Request &, Response &res) {
  20861. res.set_chunked_content_provider(
  20862. "text/event-stream", [](size_t offset, DataSink &sink) {
  20863. if (offset == 0) {
  20864. std::string event = "event: update\ndata: updated\n\n"
  20865. "event: delete\ndata: deleted\n\n";
  20866. sink.write(event.data(), event.size());
  20867. }
  20868. return false; // End stream after sending
  20869. });
  20870. });
  20871. }
  20872. void start_server() {
  20873. port_ = server_->bind_to_any_port(HOST);
  20874. server_thread_ = std::thread([this]() { server_->listen_after_bind(); });
  20875. // Wait for server to start
  20876. while (!server_->is_running()) {
  20877. std::this_thread::sleep_for(std::chrono::milliseconds(10));
  20878. }
  20879. }
  20880. int get_port() const { return port_; }
  20881. void send_event(const std::string &event) {
  20882. std::lock_guard<std::mutex> lock(event_mutex_);
  20883. events_.push_back(event);
  20884. event_cv_.notify_all();
  20885. }
  20886. std::unique_ptr<Server> server_;
  20887. std::thread server_thread_;
  20888. std::mutex event_mutex_;
  20889. std::condition_variable event_cv_;
  20890. std::vector<std::string> events_;
  20891. std::atomic<bool> stop_server_{false};
  20892. std::string last_received_event_id_;
  20893. int port_ = 0;
  20894. };
  20895. //==============================================================================
  20896. // SSE Parsing Tests
  20897. //==============================================================================
  20898. class SSEParsingTest : public SSEIntegrationTest {
  20899. protected:
  20900. // Feeds a raw event stream to SSEClient and returns the dispatched messages.
  20901. // A trailing sentinel event tells when the whole stream has been parsed.
  20902. std::vector<sse::SSEMessage> parse(const std::string &stream) {
  20903. auto body = stream + "event: end\ndata: end\n\n";
  20904. server_->Get("/parse", [body](const Request &, Response &res) {
  20905. res.set_content(body, "text/event-stream");
  20906. });
  20907. return collect("/parse");
  20908. }
  20909. // Runs SSEClient against path until an "end" event arrives and returns the
  20910. // messages dispatched before it
  20911. std::vector<sse::SSEMessage> collect(const std::string &path) {
  20912. Client client(HOST, get_port());
  20913. sse::SSEClient sse(client, path);
  20914. std::mutex mutex;
  20915. std::condition_variable cv;
  20916. std::vector<sse::SSEMessage> messages;
  20917. auto done = false;
  20918. sse.on_message([&](const sse::SSEMessage &msg) {
  20919. std::lock_guard<std::mutex> lock(mutex);
  20920. // Ignore a replay from a reconnect that races with stop()
  20921. if (!done) { messages.push_back(msg); }
  20922. });
  20923. sse.on_event("end", [&](const sse::SSEMessage &) {
  20924. std::lock_guard<std::mutex> lock(mutex);
  20925. done = true;
  20926. cv.notify_all();
  20927. });
  20928. sse.set_reconnect_interval(100);
  20929. sse.start_async();
  20930. {
  20931. std::unique_lock<std::mutex> lock(mutex);
  20932. cv.wait_for(lock, std::chrono::seconds(5), [&] { return done; });
  20933. }
  20934. sse.stop();
  20935. EXPECT_TRUE(done);
  20936. return messages;
  20937. }
  20938. };
  20939. TEST_F(SSEParsingTest, SingleLineData) {
  20940. auto msgs = parse("data: hello\n\n");
  20941. ASSERT_EQ(msgs.size(), 1u);
  20942. EXPECT_EQ(msgs[0].data, "hello");
  20943. EXPECT_EQ(msgs[0].event, "message");
  20944. }
  20945. TEST_F(SSEParsingTest, MultiLineData) {
  20946. auto msgs = parse("data: line1\ndata: line2\ndata: line3\n\n");
  20947. ASSERT_EQ(msgs.size(), 1u);
  20948. EXPECT_EQ(msgs[0].data, "line1\nline2\nline3");
  20949. }
  20950. TEST_F(SSEParsingTest, CustomEventType) {
  20951. auto msgs = parse("event: update\ndata: payload\n\n");
  20952. ASSERT_EQ(msgs.size(), 1u);
  20953. EXPECT_EQ(msgs[0].event, "update");
  20954. EXPECT_EQ(msgs[0].data, "payload");
  20955. }
  20956. TEST_F(SSEParsingTest, EventIdHandling) {
  20957. auto msgs = parse("id: 12345\ndata: test\n\n");
  20958. ASSERT_EQ(msgs.size(), 1u);
  20959. EXPECT_EQ(msgs[0].id, "12345");
  20960. }
  20961. TEST_F(SSEParsingTest, EmptyEventId) {
  20962. auto msgs = parse("id:\ndata: test\n\n");
  20963. ASSERT_EQ(msgs.size(), 1u);
  20964. EXPECT_EQ(msgs[0].id, "");
  20965. }
  20966. TEST_F(SSEParsingTest, CommentsIgnored) {
  20967. auto msgs = parse(": this is a comment\ndata: hello\n\n");
  20968. ASSERT_EQ(msgs.size(), 1u);
  20969. EXPECT_EQ(msgs[0].data, "hello");
  20970. EXPECT_EQ(msgs[0].event, "message");
  20971. }
  20972. TEST_F(SSEParsingTest, ColonInValue) {
  20973. auto msgs = parse("data: hello:world:test\n\n");
  20974. ASSERT_EQ(msgs.size(), 1u);
  20975. EXPECT_EQ(msgs[0].data, "hello:world:test");
  20976. }
  20977. TEST_F(SSEParsingTest, FieldNameOnly) {
  20978. // A line without a colon is a field name with an empty value
  20979. auto msgs = parse("data\n\n");
  20980. ASSERT_EQ(msgs.size(), 1u);
  20981. EXPECT_EQ(msgs[0].data, "");
  20982. }
  20983. TEST_F(SSEParsingTest, TrailingCarriageReturn) {
  20984. auto msgs = parse("event: update\r\ndata: hello\r\n\r\n");
  20985. ASSERT_EQ(msgs.size(), 1u);
  20986. EXPECT_EQ(msgs[0].event, "update");
  20987. EXPECT_EQ(msgs[0].data, "hello");
  20988. }
  20989. TEST_F(SSEParsingTest, FieldNameOnlyWithCarriageReturn) {
  20990. auto msgs = parse("data\r\n\r\n");
  20991. ASSERT_EQ(msgs.size(), 1u);
  20992. EXPECT_EQ(msgs[0].data, "");
  20993. }
  20994. TEST_F(SSEParsingTest, CarriageReturnLineEnding) {
  20995. auto msgs = parse("event: update\rdata: hello\r\r");
  20996. ASSERT_EQ(msgs.size(), 1u);
  20997. EXPECT_EQ(msgs[0].event, "update");
  20998. EXPECT_EQ(msgs[0].data, "hello");
  20999. }
  21000. TEST_F(SSEParsingTest, LineEndingSplitAcrossChunks) {
  21001. // Chunk boundaries fall inside every \r\n and right before the first one
  21002. std::vector<std::string> chunks = {"event: update", "\r", "\ndata: hello\r",
  21003. "\n\r", "\nevent: end\ndata: end\n\n"};
  21004. server_->Get("/split", [chunks](const Request &, Response &res) {
  21005. auto i = std::make_shared<size_t>(0);
  21006. res.set_chunked_content_provider(
  21007. "text/event-stream", [chunks, i](size_t /*offset*/, DataSink &sink) {
  21008. if (*i == chunks.size()) {
  21009. sink.done();
  21010. } else {
  21011. sink.write(chunks[*i].data(), chunks[*i].size());
  21012. (*i)++;
  21013. }
  21014. return true;
  21015. });
  21016. });
  21017. auto msgs = collect("/split");
  21018. ASSERT_EQ(msgs.size(), 1u);
  21019. EXPECT_EQ(msgs[0].event, "update");
  21020. EXPECT_EQ(msgs[0].data, "hello");
  21021. }
  21022. TEST_F(SSEParsingTest, LeadingByteOrderMarkIgnored) {
  21023. // Only a BOM at the start of the stream is ignored
  21024. auto msgs = parse("\xEF\xBB\xBF"
  21025. "data: first\n\n"
  21026. "\xEF\xBB\xBF"
  21027. "data: second\n\n");
  21028. ASSERT_EQ(msgs.size(), 1u);
  21029. EXPECT_EQ(msgs[0].data, "first");
  21030. }
  21031. TEST_F(SSEParsingTest, UnknownFieldsIgnored) {
  21032. auto msgs = parse("unknown: value\ndata: hello\n\n");
  21033. ASSERT_EQ(msgs.size(), 1u);
  21034. EXPECT_EQ(msgs[0].data, "hello");
  21035. EXPECT_EQ(msgs[0].event, "message");
  21036. }
  21037. TEST_F(SSEParsingTest, SpaceAfterColonOptional) {
  21038. auto msgs = parse("data: hello\n\ndata:hello\n\n");
  21039. ASSERT_EQ(msgs.size(), 2u);
  21040. EXPECT_EQ(msgs[0].data, "hello");
  21041. EXPECT_EQ(msgs[1].data, "hello");
  21042. }
  21043. TEST_F(SSEParsingTest, EventWithoutDataResetsEventType) {
  21044. // An event without data is not dispatched, and its type must not leak
  21045. // into the next event
  21046. auto msgs = parse("event: update\n\ndata: hello\n\n");
  21047. ASSERT_EQ(msgs.size(), 1u);
  21048. EXPECT_EQ(msgs[0].event, "message");
  21049. EXPECT_EQ(msgs[0].data, "hello");
  21050. }
  21051. TEST_F(SSEParsingTest, EventWithoutDataUpdatesLastEventId) {
  21052. // The first connection sends only an id; the second echoes back the
  21053. // Last-Event-ID it was reconnected with
  21054. std::atomic<int> connection_count{0};
  21055. server_->Get("/id-only", [&](const Request &req, Response &res) {
  21056. if (connection_count++ == 0) {
  21057. res.set_content("id: 42\n\n", "text/event-stream");
  21058. } else {
  21059. res.set_content("data: " + req.get_header_value("Last-Event-ID") +
  21060. "\n\nevent: end\ndata: end\n\n",
  21061. "text/event-stream");
  21062. }
  21063. });
  21064. auto msgs = collect("/id-only");
  21065. ASSERT_EQ(msgs.size(), 1u);
  21066. EXPECT_EQ(msgs[0].data, "42");
  21067. }
  21068. TEST_F(SSEParsingTest, EmptyEventIdClearsLastEventId) {
  21069. // The first connection sets an id and then clears it with an empty one; the
  21070. // second reports whether it was reconnected with a Last-Event-ID
  21071. std::atomic<int> connection_count{0};
  21072. server_->Get("/id-clear", [&](const Request &req, Response &res) {
  21073. if (connection_count++ == 0) {
  21074. res.set_content("id: 1\ndata: first\n\nid:\ndata: second\n\n",
  21075. "text/event-stream");
  21076. } else {
  21077. res.set_content(
  21078. std::string("data: ") +
  21079. (req.has_header("Last-Event-ID") ? "sent" : "not sent") +
  21080. "\n\nevent: end\ndata: end\n\n",
  21081. "text/event-stream");
  21082. }
  21083. });
  21084. auto msgs = collect("/id-clear");
  21085. ASSERT_EQ(msgs.size(), 3u);
  21086. EXPECT_EQ(msgs[0].id, "1");
  21087. EXPECT_EQ(msgs[1].id, "");
  21088. EXPECT_EQ(msgs[2].data, "not sent");
  21089. }
  21090. TEST_F(SSEParsingTest, UnsendableEventIdKeepsLastEventId) {
  21091. // The first connection sets an id and then sends ids that cannot be carried
  21092. // in a header; the second echoes back the Last-Event-ID it was reconnected
  21093. // with
  21094. std::atomic<int> connection_count{0};
  21095. server_->Get("/id-unsendable", [&](const Request &req, Response &res) {
  21096. if (connection_count++ == 0) {
  21097. res.set_content(std::string("id: 42\n\nid: a") + '\0' +
  21098. "b\n\nid: \x01\n\nid: 7\n\nid: 7 \n\n",
  21099. "text/event-stream");
  21100. } else {
  21101. res.set_content("data: " + req.get_header_value("Last-Event-ID") +
  21102. "\n\nevent: end\ndata: end\n\n",
  21103. "text/event-stream");
  21104. }
  21105. });
  21106. auto msgs = collect("/id-unsendable");
  21107. ASSERT_EQ(msgs.size(), 1u);
  21108. EXPECT_EQ(msgs[0].data, "42");
  21109. }
  21110. TEST_F(SSEParsingTest, CompleteEventParsing) {
  21111. auto msgs = parse("event: notification\nid: evt-42\n"
  21112. "data: {\"type\":\"alert\"}\nretry: 1000\n\n");
  21113. ASSERT_EQ(msgs.size(), 1u);
  21114. EXPECT_EQ(msgs[0].event, "notification");
  21115. EXPECT_EQ(msgs[0].id, "evt-42");
  21116. EXPECT_EQ(msgs[0].data, "{\"type\":\"alert\"}");
  21117. }
  21118. TEST(SSEMessageTest, Clear) {
  21119. sse::SSEMessage msg;
  21120. msg.event = "custom";
  21121. msg.data = "some data";
  21122. msg.id = "123";
  21123. msg.clear();
  21124. EXPECT_EQ(msg.event, "message");
  21125. EXPECT_EQ(msg.data, "");
  21126. EXPECT_EQ(msg.id, "");
  21127. }
  21128. //==============================================================================
  21129. // SSE Integration Tests
  21130. //==============================================================================
  21131. // Test: Successful connection and on_open callback
  21132. TEST_F(SSEIntegrationTest, SuccessfulConnection) {
  21133. // Add a simple endpoint that sends one event and closes
  21134. server_->Get("/simple-event", [](const Request &, Response &res) {
  21135. res.set_chunked_content_provider(
  21136. "text/event-stream", [](size_t offset, DataSink &sink) {
  21137. if (offset == 0) {
  21138. std::string event = "data: hello\n\n";
  21139. sink.write(event.data(), event.size());
  21140. }
  21141. return false; // Close stream after sending
  21142. });
  21143. });
  21144. Client client("localhost", get_port());
  21145. sse::SSEClient sse(client, "/simple-event");
  21146. std::atomic<bool> open_called{false};
  21147. std::atomic<bool> message_received{false};
  21148. sse.on_open([&open_called]() { open_called.store(true); });
  21149. sse.on_message([&message_received](const sse::SSEMessage &msg) {
  21150. if (msg.data == "hello") { message_received.store(true); }
  21151. });
  21152. sse.set_reconnect_interval(100);
  21153. sse.set_max_reconnect_attempts(1);
  21154. // Start async
  21155. sse.start_async();
  21156. // Wait for message to be processed
  21157. std::this_thread::sleep_for(std::chrono::milliseconds(500));
  21158. sse.stop();
  21159. EXPECT_TRUE(open_called.load());
  21160. EXPECT_TRUE(message_received.load());
  21161. }
  21162. TEST_F(SSEIntegrationTest, TooLongEventEndsTheConnection) {
  21163. // A data line that never ends.
  21164. server_->Get("/endless-line", [](const Request &, Response &res) {
  21165. res.set_chunked_content_provider(
  21166. "text/event-stream", [](size_t offset, DataSink &sink) {
  21167. if (offset == 0) { sink.write("data: ", 6); }
  21168. std::string chunk(64 * 1024, 'A');
  21169. return sink.write(chunk.data(), chunk.size());
  21170. });
  21171. });
  21172. Client client("localhost", get_port());
  21173. sse::SSEClient sse(client, "/endless-line");
  21174. std::atomic<bool> too_long{false};
  21175. sse.on_error([&](Error err) {
  21176. if (err == Error::ExceedMaxPayloadSize) { too_long = true; }
  21177. });
  21178. sse.set_max_reconnect_attempts(1);
  21179. sse.start_async();
  21180. for (int i = 0; i < 500 && !too_long; i++) {
  21181. std::this_thread::sleep_for(std::chrono::milliseconds(10));
  21182. }
  21183. sse.stop();
  21184. EXPECT_TRUE(too_long);
  21185. }
  21186. TEST_F(SSEIntegrationTest, PayloadLimitDoesNotEndTheStream) {
  21187. // Far more in all than the client's payload limit below.
  21188. server_->Get("/many-events", [](const Request &, Response &res) {
  21189. res.set_chunked_content_provider(
  21190. "text/event-stream", [](size_t offset, DataSink &sink) {
  21191. if (offset == 0) {
  21192. std::string events;
  21193. for (int i = 0; i < 1000; i++) {
  21194. events += "data: message\n\n";
  21195. }
  21196. sink.write(events.data(), events.size());
  21197. }
  21198. return false;
  21199. });
  21200. });
  21201. Client client("localhost", get_port());
  21202. client.set_payload_max_length(1024);
  21203. sse::SSEClient sse(client, "/many-events");
  21204. std::atomic<int> messages{0};
  21205. std::atomic<bool> too_large{false};
  21206. sse.on_message([&](const sse::SSEMessage &) { messages++; });
  21207. sse.on_error([&](Error err) {
  21208. if (err == Error::ExceedMaxPayloadSize) { too_large = true; }
  21209. });
  21210. sse.set_max_reconnect_attempts(1);
  21211. sse.start_async();
  21212. for (int i = 0; i < 500 && messages < 1000; i++) {
  21213. std::this_thread::sleep_for(std::chrono::milliseconds(10));
  21214. }
  21215. sse.stop();
  21216. EXPECT_GE(messages.load(), 1000);
  21217. EXPECT_FALSE(too_large);
  21218. }
  21219. // Test: on_message callback
  21220. TEST_F(SSEIntegrationTest, OnMessageCallback) {
  21221. // Endpoint that sends multiple events then closes
  21222. server_->Get("/multi-event", [](const Request &, Response &res) {
  21223. res.set_chunked_content_provider(
  21224. "text/event-stream", [](size_t offset, DataSink &sink) {
  21225. if (offset == 0) {
  21226. std::string events = "data: message1\n\ndata: message2\n\n";
  21227. sink.write(events.data(), events.size());
  21228. }
  21229. return false;
  21230. });
  21231. });
  21232. Client client("localhost", get_port());
  21233. sse::SSEClient sse(client, "/multi-event");
  21234. std::vector<std::string> received_messages;
  21235. std::mutex messages_mutex;
  21236. sse.on_message([&](const sse::SSEMessage &msg) {
  21237. std::lock_guard<std::mutex> lock(messages_mutex);
  21238. received_messages.push_back(msg.data);
  21239. });
  21240. sse.set_reconnect_interval(100);
  21241. sse.set_max_reconnect_attempts(1);
  21242. sse.start_async();
  21243. std::this_thread::sleep_for(std::chrono::milliseconds(500));
  21244. sse.stop();
  21245. std::lock_guard<std::mutex> lock(messages_mutex);
  21246. EXPECT_GE(received_messages.size(), 2u);
  21247. if (received_messages.size() >= 2) {
  21248. EXPECT_EQ(received_messages[0], "message1");
  21249. EXPECT_EQ(received_messages[1], "message2");
  21250. }
  21251. }
  21252. // Test: on_event for specific types
  21253. TEST_F(SSEIntegrationTest, OnEventForSpecificTypes) {
  21254. Client client("localhost", get_port());
  21255. sse::SSEClient sse(client, "/custom-events");
  21256. std::atomic<bool> update_received{false};
  21257. std::atomic<bool> delete_received{false};
  21258. sse.on_event("update", [&update_received](const sse::SSEMessage &msg) {
  21259. if (msg.data == "updated") { update_received.store(true); }
  21260. });
  21261. sse.on_event("delete", [&delete_received](const sse::SSEMessage &msg) {
  21262. if (msg.data == "deleted") { delete_received.store(true); }
  21263. });
  21264. sse.set_max_reconnect_attempts(1);
  21265. sse.start_async();
  21266. std::this_thread::sleep_for(std::chrono::milliseconds(300));
  21267. sse.stop();
  21268. EXPECT_TRUE(update_received.load());
  21269. EXPECT_TRUE(delete_received.load());
  21270. }
  21271. // Test: on_error callback on connection failure
  21272. TEST_F(SSEIntegrationTest, OnErrorCallback) {
  21273. // Connect to a non-existent port
  21274. Client client("localhost", 59999);
  21275. sse::SSEClient sse(client, "/events");
  21276. std::atomic<bool> error_called{false};
  21277. Error received_error = Error::Success;
  21278. sse.on_error([&](Error err) {
  21279. error_called.store(true);
  21280. received_error = err;
  21281. });
  21282. sse.set_reconnect_interval(50);
  21283. sse.set_max_reconnect_attempts(1);
  21284. sse.start_async();
  21285. std::this_thread::sleep_for(std::chrono::milliseconds(200));
  21286. sse.stop();
  21287. EXPECT_TRUE(error_called.load());
  21288. EXPECT_NE(received_error, Error::Success);
  21289. }
  21290. // Test: Last-Event-ID header sent on reconnect
  21291. TEST_F(SSEIntegrationTest, LastEventIdHeader) {
  21292. // Endpoint that sends event with ID
  21293. server_->Get("/event-with-id", [](const Request &, Response &res) {
  21294. res.set_chunked_content_provider(
  21295. "text/event-stream", [](size_t offset, DataSink &sink) {
  21296. if (offset == 0) {
  21297. std::string event = "id: evt-123\ndata: test\n\n";
  21298. sink.write(event.data(), event.size());
  21299. }
  21300. return false;
  21301. });
  21302. });
  21303. Client client("localhost", get_port());
  21304. sse::SSEClient sse(client, "/event-with-id");
  21305. std::atomic<bool> id_received{false};
  21306. sse.on_message([&](const sse::SSEMessage &msg) {
  21307. if (!msg.id.empty()) { id_received.store(true); }
  21308. });
  21309. sse.set_reconnect_interval(100);
  21310. sse.set_max_reconnect_attempts(1);
  21311. sse.start_async();
  21312. std::this_thread::sleep_for(std::chrono::milliseconds(500));
  21313. sse.stop();
  21314. EXPECT_TRUE(id_received.load());
  21315. EXPECT_EQ(sse.last_event_id(), "evt-123");
  21316. }
  21317. // Test: Manual stop
  21318. TEST_F(SSEIntegrationTest, ManualStop) {
  21319. // Endpoint that sends one event and stays open briefly
  21320. std::atomic<bool> handler_running{true};
  21321. server_->Get("/stay-open", [&handler_running](const Request &,
  21322. Response &res) {
  21323. res.set_chunked_content_provider(
  21324. "text/event-stream", [&handler_running](size_t offset, DataSink &sink) {
  21325. if (offset == 0) {
  21326. std::string event = "data: connected\n\n";
  21327. sink.write(event.data(), event.size());
  21328. }
  21329. // Keep connection open while handler_running is true
  21330. for (int i = 0; i < 10 && handler_running.load(); ++i) {
  21331. std::this_thread::sleep_for(std::chrono::milliseconds(50));
  21332. }
  21333. return false;
  21334. });
  21335. });
  21336. Client client("localhost", get_port());
  21337. sse::SSEClient sse(client, "/stay-open");
  21338. std::atomic<bool> connected{false};
  21339. sse.on_open([&connected]() { connected.store(true); });
  21340. sse.set_reconnect_interval(100);
  21341. sse.set_max_reconnect_attempts(1);
  21342. sse.start_async();
  21343. // Wait for connection to establish
  21344. for (int i = 0; i < 20 && !connected.load(); ++i) {
  21345. std::this_thread::sleep_for(std::chrono::milliseconds(50));
  21346. }
  21347. EXPECT_TRUE(connected.load());
  21348. EXPECT_TRUE(sse.is_connected());
  21349. // Signal handler to stop
  21350. handler_running.store(false);
  21351. // Stop SSE client
  21352. sse.stop();
  21353. EXPECT_FALSE(sse.is_connected());
  21354. }
  21355. // Test: SSEClient with custom headers
  21356. TEST_F(SSEIntegrationTest, CustomHeaders) {
  21357. // Setup a server endpoint that checks for custom header
  21358. std::atomic<bool> header_received{false};
  21359. server_->Get("/header-check", [&](const Request &req, Response &res) {
  21360. if (req.get_header_value("X-Custom-Header") == "custom-value") {
  21361. header_received.store(true);
  21362. }
  21363. res.set_chunked_content_provider("text/event-stream",
  21364. [](size_t, DataSink &) { return false; });
  21365. });
  21366. Client client("localhost", get_port());
  21367. Headers headers = {{"X-Custom-Header", "custom-value"}};
  21368. sse::SSEClient sse(client, "/header-check", headers);
  21369. sse.set_max_reconnect_attempts(1);
  21370. sse.start_async();
  21371. std::this_thread::sleep_for(std::chrono::milliseconds(200));
  21372. sse.stop();
  21373. EXPECT_TRUE(header_received.load());
  21374. }
  21375. // Test: Reconnect interval configuration
  21376. TEST_F(SSEIntegrationTest, ReconnectIntervalConfiguration) {
  21377. Client client("localhost", get_port());
  21378. sse::SSEClient sse(client, "/events");
  21379. auto &result = sse.set_reconnect_interval(500);
  21380. // Builder pattern should return reference to self
  21381. EXPECT_EQ(&result, &sse);
  21382. }
  21383. // Test: Max reconnect attempts
  21384. TEST_F(SSEIntegrationTest, MaxReconnectAttempts) {
  21385. // Connect to non-existent port to force reconnects
  21386. Client client("localhost", 59998);
  21387. sse::SSEClient sse(client, "/events");
  21388. std::atomic<int> error_count{0};
  21389. sse.on_error([&](Error) { error_count.fetch_add(1); });
  21390. sse.set_reconnect_interval(50);
  21391. sse.set_max_reconnect_attempts(2);
  21392. auto start = std::chrono::steady_clock::now();
  21393. sse.start(); // Blocking call
  21394. auto end = std::chrono::steady_clock::now();
  21395. // Should have stopped after 2 failed attempts
  21396. EXPECT_GE(error_count.load(), 2);
  21397. // Should not have taken too long (max 2 attempts * 50ms + overhead)
  21398. auto duration =
  21399. std::chrono::duration_cast<std::chrono::milliseconds>(end - start);
  21400. #ifdef _WIN32
  21401. // Windows is much slower for socket connection failures
  21402. EXPECT_LT(duration.count(), 7000);
  21403. #else
  21404. EXPECT_LT(duration.count(), 1000);
  21405. #endif
  21406. }
  21407. // Test: Multi-line data in integration
  21408. TEST_F(SSEIntegrationTest, MultiLineDataIntegration) {
  21409. // Endpoint with multi-line data
  21410. server_->Get("/multiline-data", [](const Request &, Response &res) {
  21411. res.set_chunked_content_provider(
  21412. "text/event-stream", [](size_t offset, DataSink &sink) {
  21413. if (offset == 0) {
  21414. std::string event = "data: line1\ndata: line2\ndata: line3\n\n";
  21415. sink.write(event.data(), event.size());
  21416. }
  21417. return false;
  21418. });
  21419. });
  21420. Client client("localhost", get_port());
  21421. sse::SSEClient sse(client, "/multiline-data");
  21422. std::string received_data;
  21423. std::mutex data_mutex;
  21424. sse.on_message([&](const sse::SSEMessage &msg) {
  21425. std::lock_guard<std::mutex> lock(data_mutex);
  21426. received_data = msg.data;
  21427. });
  21428. sse.set_reconnect_interval(100);
  21429. sse.set_max_reconnect_attempts(1);
  21430. sse.start_async();
  21431. std::this_thread::sleep_for(std::chrono::milliseconds(500));
  21432. sse.stop();
  21433. std::lock_guard<std::mutex> lock(data_mutex);
  21434. EXPECT_EQ(received_data, "line1\nline2\nline3");
  21435. }
  21436. TEST_F(SSEIntegrationTest, EmptyDataLines) {
  21437. server_->Get("/empty-data-lines", [](const Request &, Response &res) {
  21438. res.set_chunked_content_provider("text/event-stream", [](size_t offset,
  21439. DataSink &sink) {
  21440. if (offset == 0) {
  21441. const std::string events = "data:\n\ndata:\ndata: hello\n\ndata\n\n";
  21442. sink.write(events.data(), events.size());
  21443. }
  21444. return false;
  21445. });
  21446. });
  21447. Client client("localhost", get_port());
  21448. sse::SSEClient sse(client, "/empty-data-lines");
  21449. std::mutex mutex;
  21450. std::condition_variable cv;
  21451. std::vector<std::string> received;
  21452. sse.on_message([&](const sse::SSEMessage &msg) {
  21453. std::lock_guard<std::mutex> lock(mutex);
  21454. received.push_back(msg.data);
  21455. cv.notify_all();
  21456. });
  21457. sse.set_max_reconnect_attempts(1);
  21458. sse.start_async();
  21459. {
  21460. std::unique_lock<std::mutex> lock(mutex);
  21461. cv.wait_for(lock, std::chrono::seconds(2),
  21462. [&] { return received.size() >= 3; });
  21463. }
  21464. sse.stop();
  21465. ASSERT_GE(received.size(), 3u);
  21466. EXPECT_EQ(received[0], "");
  21467. EXPECT_EQ(received[1], "\nhello");
  21468. EXPECT_EQ(received[2], "");
  21469. }
  21470. // Test: Auto-reconnect after server disconnection
  21471. TEST_F(SSEIntegrationTest, AutoReconnectAfterDisconnect) {
  21472. std::atomic<int> connection_count{0};
  21473. std::atomic<int> message_count{0};
  21474. // Endpoint that sends one event and closes, forcing reconnect
  21475. server_->Get("/reconnect-test",
  21476. [&connection_count](const Request &, Response &res) {
  21477. connection_count.fetch_add(1);
  21478. res.set_chunked_content_provider(
  21479. "text/event-stream", [](size_t offset, DataSink &sink) {
  21480. if (offset == 0) {
  21481. std::string event = "data: hello\n\n";
  21482. sink.write(event.data(), event.size());
  21483. }
  21484. return false; // Close connection after sending
  21485. });
  21486. });
  21487. Client client("localhost", get_port());
  21488. sse::SSEClient sse(client, "/reconnect-test");
  21489. sse.on_message([&message_count](const sse::SSEMessage &) {
  21490. message_count.fetch_add(1);
  21491. });
  21492. sse.set_reconnect_interval(100);
  21493. sse.set_max_reconnect_attempts(3);
  21494. sse.start_async();
  21495. // Wait long enough for multiple reconnects
  21496. std::this_thread::sleep_for(std::chrono::milliseconds(800));
  21497. sse.stop();
  21498. // Should have connected multiple times (initial + reconnects)
  21499. EXPECT_GE(connection_count.load(), 2);
  21500. // Should have received messages from multiple connections
  21501. EXPECT_GE(message_count.load(), 2);
  21502. }
  21503. // Test: A retry field that is not all ASCII digits is ignored
  21504. TEST_F(SSEIntegrationTest, NonDigitRetryFieldIgnored) {
  21505. std::atomic<int> connection_count{0};
  21506. server_->Get("/bad-retry",
  21507. [&connection_count](const Request &, Response &res) {
  21508. connection_count.fetch_add(1);
  21509. res.set_chunked_content_provider(
  21510. "text/event-stream", [](size_t offset, DataSink &sink) {
  21511. if (offset == 0) {
  21512. std::string event = "retry: -1\ndata: hello\n\n";
  21513. sink.write(event.data(), event.size());
  21514. }
  21515. return false;
  21516. });
  21517. });
  21518. Client client("localhost", get_port());
  21519. sse::SSEClient sse(client, "/bad-retry");
  21520. sse.set_reconnect_interval(10000);
  21521. sse.start_async();
  21522. std::this_thread::sleep_for(std::chrono::milliseconds(500));
  21523. sse.stop();
  21524. EXPECT_EQ(connection_count.load(), 1);
  21525. }
  21526. // Test: A retry field of all ASCII digits sets the reconnection time
  21527. TEST_F(SSEIntegrationTest, DigitRetryFieldApplied) {
  21528. std::mutex mutex;
  21529. std::condition_variable cv;
  21530. std::vector<std::chrono::steady_clock::time_point> connected_at;
  21531. server_->Get("/zero-retry", [&](const Request &, Response &res) {
  21532. {
  21533. std::lock_guard<std::mutex> lock(mutex);
  21534. connected_at.push_back(std::chrono::steady_clock::now());
  21535. cv.notify_all();
  21536. }
  21537. res.set_chunked_content_provider(
  21538. "text/event-stream", [](size_t offset, DataSink &sink) {
  21539. if (offset == 0) {
  21540. std::string event = "retry: 0\ndata: hello\n\n";
  21541. sink.write(event.data(), event.size());
  21542. }
  21543. return false;
  21544. });
  21545. });
  21546. Client client("localhost", get_port());
  21547. sse::SSEClient sse(client, "/zero-retry");
  21548. sse.set_reconnect_interval(10000);
  21549. sse.start_async();
  21550. {
  21551. std::unique_lock<std::mutex> lock(mutex);
  21552. cv.wait_for(lock, std::chrono::seconds(5),
  21553. [&] { return connected_at.size() >= 2; });
  21554. }
  21555. sse.stop();
  21556. // The server-supplied interval is applied, but never below 100ms, so
  21557. // "retry: 0" does not cause a busy reconnect loop
  21558. std::lock_guard<std::mutex> lock(mutex);
  21559. ASSERT_GE(connected_at.size(), 2u);
  21560. auto interval_ms = std::chrono::duration_cast<std::chrono::milliseconds>(
  21561. connected_at[1] - connected_at[0])
  21562. .count();
  21563. EXPECT_GE(interval_ms, 100);
  21564. }
  21565. // Test: Last-Event-ID sent on reconnect
  21566. TEST_F(SSEIntegrationTest, LastEventIdSentOnReconnect) {
  21567. std::atomic<int> connection_count{0};
  21568. std::vector<std::string> received_last_event_ids;
  21569. std::mutex id_mutex;
  21570. // Endpoint that checks Last-Event-ID header and sends event with ID
  21571. server_->Get("/reconnect-with-id", [&](const Request &req, Response &res) {
  21572. int conn = connection_count.fetch_add(1);
  21573. // Capture the Last-Event-ID header from each connection
  21574. {
  21575. std::lock_guard<std::mutex> lock(id_mutex);
  21576. received_last_event_ids.push_back(req.get_header_value("Last-Event-ID"));
  21577. }
  21578. res.set_chunked_content_provider(
  21579. "text/event-stream", [conn](size_t offset, DataSink &sink) {
  21580. if (offset == 0) {
  21581. std::string event =
  21582. "id: event-" + std::to_string(conn) + "\ndata: msg\n\n";
  21583. sink.write(event.data(), event.size());
  21584. }
  21585. return false;
  21586. });
  21587. });
  21588. Client client("localhost", get_port());
  21589. sse::SSEClient sse(client, "/reconnect-with-id");
  21590. sse.set_reconnect_interval(100);
  21591. sse.set_max_reconnect_attempts(3);
  21592. sse.start_async();
  21593. // Wait for at least 2 connections
  21594. std::this_thread::sleep_for(std::chrono::milliseconds(500));
  21595. sse.stop();
  21596. // Verify behavior
  21597. std::lock_guard<std::mutex> lock(id_mutex);
  21598. EXPECT_GE(received_last_event_ids.size(), 2u);
  21599. // First connection should have no Last-Event-ID
  21600. if (!received_last_event_ids.empty()) {
  21601. EXPECT_EQ(received_last_event_ids[0], "");
  21602. }
  21603. // Second connection should have Last-Event-ID from first connection
  21604. if (received_last_event_ids.size() >= 2) {
  21605. EXPECT_EQ(received_last_event_ids[1], "event-0");
  21606. }
  21607. }
  21608. // Test: set_headers updates headers used on reconnect
  21609. TEST_F(SSEIntegrationTest, SetHeadersUpdatesOnReconnect) {
  21610. std::vector<std::string> received_tokens;
  21611. std::mutex token_mutex;
  21612. // Endpoint that captures Authorization header
  21613. server_->Get("/auth-check", [&](const Request &req, Response &res) {
  21614. {
  21615. std::lock_guard<std::mutex> lock(token_mutex);
  21616. received_tokens.push_back(req.get_header_value("Authorization"));
  21617. }
  21618. res.set_chunked_content_provider(
  21619. "text/event-stream", [](size_t offset, DataSink &sink) {
  21620. if (offset == 0) {
  21621. std::string event = "data: hello\n\n";
  21622. sink.write(event.data(), event.size());
  21623. }
  21624. return false; // Close connection to trigger reconnect
  21625. });
  21626. });
  21627. Client client("localhost", get_port());
  21628. Headers headers = {{"Authorization", "Bearer old-token"}};
  21629. sse::SSEClient sse(client, "/auth-check", headers);
  21630. // Update headers on each successful connection
  21631. sse.on_open(
  21632. [&sse]() { sse.set_headers({{"Authorization", "Bearer new-token"}}); });
  21633. sse.set_reconnect_interval(100);
  21634. sse.set_max_reconnect_attempts(3);
  21635. sse.start_async();
  21636. std::this_thread::sleep_for(std::chrono::milliseconds(800));
  21637. sse.stop();
  21638. std::lock_guard<std::mutex> lock(token_mutex);
  21639. ASSERT_GE(received_tokens.size(), 2u);
  21640. // First connection uses original header
  21641. EXPECT_EQ(received_tokens[0], "Bearer old-token");
  21642. // Second connection uses updated header from set_headers
  21643. EXPECT_EQ(received_tokens[1], "Bearer new-token");
  21644. }
  21645. // Test: 401 allows reconnection (so on_error can refresh headers)
  21646. TEST_F(SSEIntegrationTest, ReconnectOn401WithHeaderRefresh) {
  21647. std::atomic<int> connection_count{0};
  21648. // Endpoint: returns 401 on first attempt, 200 on second
  21649. server_->Get("/auth-retry", [&](const Request &req, Response &res) {
  21650. int conn = connection_count.fetch_add(1);
  21651. if (conn == 0 || req.get_header_value("Authorization") != "Bearer valid") {
  21652. res.status = StatusCode::Unauthorized_401;
  21653. res.set_content("Unauthorized", "text/plain");
  21654. return;
  21655. }
  21656. res.set_chunked_content_provider(
  21657. "text/event-stream", [](size_t offset, DataSink &sink) {
  21658. if (offset == 0) {
  21659. std::string event = "data: authenticated\n\n";
  21660. sink.write(event.data(), event.size());
  21661. }
  21662. return false;
  21663. });
  21664. });
  21665. Client client("localhost", get_port());
  21666. Headers headers = {{"Authorization", "Bearer expired"}};
  21667. sse::SSEClient sse(client, "/auth-retry", headers);
  21668. std::atomic<bool> message_received{false};
  21669. // Refresh token on error
  21670. sse.on_error(
  21671. [&sse](Error) { sse.set_headers({{"Authorization", "Bearer valid"}}); });
  21672. sse.on_message([&](const sse::SSEMessage &msg) {
  21673. if (msg.data == "authenticated") { message_received.store(true); }
  21674. });
  21675. sse.set_reconnect_interval(100);
  21676. sse.set_max_reconnect_attempts(3);
  21677. sse.start_async();
  21678. std::this_thread::sleep_for(std::chrono::milliseconds(800));
  21679. sse.stop();
  21680. // Should have reconnected after 401 and succeeded with new token
  21681. EXPECT_GE(connection_count.load(), 2);
  21682. EXPECT_TRUE(message_received.load());
  21683. }
  21684. TEST(Issue2318Test, EmptyHostString) {
  21685. {
  21686. httplib::Client cli_empty("", PORT);
  21687. auto res = cli_empty.Get("/");
  21688. ASSERT_FALSE(res);
  21689. EXPECT_EQ(httplib::Error::Connection, res.error());
  21690. }
  21691. {
  21692. httplib::Client cli(" ", PORT);
  21693. auto res = cli.Get("/");
  21694. ASSERT_FALSE(res);
  21695. EXPECT_EQ(httplib::Error::Connection, res.error());
  21696. }
  21697. }
  21698. #ifdef CPPHTTPLIB_ZLIB_SUPPORT
  21699. TEST(ZipBombProtectionTest, DecompressedSizeExceedsLimit) {
  21700. Server svr;
  21701. // Set a small payload limit (1KB)
  21702. svr.set_payload_max_length(1024);
  21703. svr.Post("/test", [&](const Request &req, Response &res) {
  21704. res.set_content("Body size: " + std::to_string(req.body.size()),
  21705. "text/plain");
  21706. });
  21707. auto listen_thread = std::thread([&]() { svr.listen(HOST, PORT); });
  21708. auto se = detail::scope_exit([&] {
  21709. svr.stop();
  21710. listen_thread.join();
  21711. });
  21712. svr.wait_until_ready();
  21713. // Create data that compresses well but exceeds limit when decompressed
  21714. // 8KB of repeated null bytes compresses to a very small size
  21715. std::string original_data(8 * 1024, '\0');
  21716. // Compress the data using gzip
  21717. std::string compressed_data;
  21718. detail::gzip_compressor compressor;
  21719. compressor.compress(original_data.data(), original_data.size(), true,
  21720. [&](const char *data, size_t size) {
  21721. compressed_data.append(data, size);
  21722. return true;
  21723. });
  21724. // Verify compression worked (compressed should be much smaller)
  21725. ASSERT_LT(compressed_data.size(), original_data.size());
  21726. ASSERT_LT(compressed_data.size(), 1024u); // Compressed fits in limit
  21727. // Send compressed data with Content-Encoding: gzip
  21728. Client cli(HOST, PORT);
  21729. Headers headers = {{"Content-Encoding", "gzip"}};
  21730. auto res =
  21731. cli.Post("/test", headers, compressed_data, "application/octet-stream");
  21732. // Server should reject because decompressed size (8KB) exceeds limit (1KB)
  21733. ASSERT_TRUE(res) << "Error: " << to_string(res.error());
  21734. EXPECT_EQ(StatusCode::PayloadTooLarge_413, res->status);
  21735. }
  21736. #endif
  21737. // ============================================================================
  21738. // OpenSSL-Specific Tests
  21739. // ============================================================================
  21740. #ifdef CPPHTTPLIB_OPENSSL_SUPPORT
  21741. X509 *readCertificate(const std::string &strFileName) {
  21742. std::ifstream inStream(strFileName);
  21743. std::string strCertPEM((std::istreambuf_iterator<char>(inStream)),
  21744. std::istreambuf_iterator<char>());
  21745. if (strCertPEM.empty()) return (nullptr);
  21746. BIO *pbCert = BIO_new(BIO_s_mem());
  21747. BIO_write(pbCert, strCertPEM.c_str(), (int)strCertPEM.size());
  21748. X509 *pCert = PEM_read_bio_X509(pbCert, NULL, 0, NULL);
  21749. BIO_free(pbCert);
  21750. return (pCert);
  21751. }
  21752. EVP_PKEY *readPrivateKey(const std::string &strFileName) {
  21753. std::ifstream inStream(strFileName);
  21754. std::string strPrivateKeyPEM((std::istreambuf_iterator<char>(inStream)),
  21755. std::istreambuf_iterator<char>());
  21756. if (strPrivateKeyPEM.empty()) return (nullptr);
  21757. BIO *pbPrivKey = BIO_new(BIO_s_mem());
  21758. BIO_write(pbPrivKey, strPrivateKeyPEM.c_str(), (int)strPrivateKeyPEM.size());
  21759. EVP_PKEY *pPrivateKey = PEM_read_bio_PrivateKey(pbPrivKey, NULL, NULL, NULL);
  21760. BIO_free(pbPrivKey);
  21761. return (pPrivateKey);
  21762. }
  21763. TEST(BindServerTest, UpdateCerts) {
  21764. SSLServer svr(SERVER_CERT_FILE, SERVER_PRIVATE_KEY_FILE, CLIENT_CA_CERT_FILE);
  21765. int port = svr.bind_to_any_port("0.0.0.0");
  21766. ASSERT_TRUE(svr.is_valid());
  21767. ASSERT_TRUE(port > 0);
  21768. X509 *cert = readCertificate(SERVER_CERT_FILE);
  21769. X509 *ca_cert = readCertificate(CLIENT_CA_CERT_FILE);
  21770. EVP_PKEY *key = readPrivateKey(SERVER_PRIVATE_KEY_FILE);
  21771. ASSERT_TRUE(cert != nullptr);
  21772. ASSERT_TRUE(ca_cert != nullptr);
  21773. ASSERT_TRUE(key != nullptr);
  21774. X509_STORE *cert_store = X509_STORE_new();
  21775. X509_STORE_add_cert(cert_store, ca_cert);
  21776. // svr.update_certs(cert, key, cert_store); // deprecated
  21777. svr.update_certs_pem(SERVER_CERT_FILE, SERVER_PRIVATE_KEY_FILE,
  21778. CLIENT_CA_CERT_FILE);
  21779. ASSERT_TRUE(svr.is_valid());
  21780. svr.stop();
  21781. X509_STORE_free(cert_store);
  21782. X509_free(cert);
  21783. X509_free(ca_cert);
  21784. EVP_PKEY_free(key);
  21785. }
  21786. // Test that update_certs() updates client CA list correctly
  21787. TEST(SSLClientServerTest, UpdateCertsSetsClientCAList) {
  21788. // Start with file-based constructor
  21789. SSLServer svr(SERVER_CERT_FILE, SERVER_PRIVATE_KEY_FILE);
  21790. ASSERT_TRUE(svr.is_valid());
  21791. // Initially no client CA list should be set
  21792. auto ssl_ctx = static_cast<SSL_CTX *>(svr.tls_context());
  21793. ASSERT_TRUE(ssl_ctx != nullptr);
  21794. STACK_OF(X509_NAME) *ca_list_before = SSL_CTX_get_client_CA_list(ssl_ctx);
  21795. int count_before = ca_list_before ? sk_X509_NAME_num(ca_list_before) : 0;
  21796. EXPECT_EQ(0, count_before);
  21797. // Now update with client CA (PEM string)
  21798. std::string cert_pem, key_pem, ca_pem;
  21799. read_file(SERVER_CERT_FILE, cert_pem);
  21800. read_file(SERVER_PRIVATE_KEY_FILE, key_pem);
  21801. read_file(CLIENT_CA_CERT_FILE, ca_pem);
  21802. svr.update_certs_pem(cert_pem.c_str(), key_pem.c_str(), ca_pem.c_str());
  21803. ASSERT_TRUE(svr.is_valid());
  21804. // Now client CA list should be set
  21805. STACK_OF(X509_NAME) *ca_list_after = SSL_CTX_get_client_CA_list(ssl_ctx);
  21806. ASSERT_TRUE(ca_list_after != nullptr);
  21807. EXPECT_GT(sk_X509_NAME_num(ca_list_after), 0);
  21808. }
  21809. TEST(SSLClientServerTest, FilePathConstructorSetsClientCAList) {
  21810. // Test that the file-path SSLServer constructor properly sets the client CA
  21811. // list that is sent to clients during the TLS handshake (CertificateRequest)
  21812. SSLServer svr(SERVER_CERT_FILE, SERVER_PRIVATE_KEY_FILE, CLIENT_CA_CERT_FILE);
  21813. ASSERT_TRUE(svr.is_valid());
  21814. auto ssl_ctx = static_cast<SSL_CTX *>(svr.tls_context());
  21815. ASSERT_TRUE(ssl_ctx != nullptr);
  21816. STACK_OF(X509_NAME) *ca_list = SSL_CTX_get_client_CA_list(ssl_ctx);
  21817. ASSERT_TRUE(ca_list != nullptr);
  21818. EXPECT_GT(sk_X509_NAME_num(ca_list), 0);
  21819. }
  21820. #endif
  21821. // ============================================================================
  21822. // MbedTLS-Specific Tests
  21823. // ============================================================================
  21824. #ifdef CPPHTTPLIB_MBEDTLS_SUPPORT
  21825. TEST(SSLClientServerTest, CustomizeServerSSLCtxMbedTLS) {
  21826. using namespace httplib::tls;
  21827. // Track if callback was invoked
  21828. bool callback_invoked = false;
  21829. // The callback receives void* ctx which is actually MbedTlsContext*
  21830. // We can access the mbedtls_ssl_config via the context
  21831. auto setup_callback = [&callback_invoked](void *ctx) {
  21832. callback_invoked = true;
  21833. // Cast to MbedTlsContext* to access the ssl config
  21834. auto *mbedtls_ctx = static_cast<httplib::tls::impl::MbedTlsContext *>(ctx);
  21835. mbedtls_ssl_config *conf = &mbedtls_ctx->conf;
  21836. // Use static variables to hold certificate data (simplified for test)
  21837. static mbedtls_x509_crt own_cert;
  21838. static mbedtls_pk_context own_key;
  21839. static mbedtls_x509_crt ca_chain;
  21840. static bool initialized = false;
  21841. if (!initialized) {
  21842. mbedtls_x509_crt_init(&own_cert);
  21843. mbedtls_pk_init(&own_key);
  21844. mbedtls_x509_crt_init(&ca_chain);
  21845. // Load server certificate
  21846. if (mbedtls_x509_crt_parse_file(&own_cert, SERVER_CERT_FILE) != 0) {
  21847. return false;
  21848. }
  21849. // Load server private key.
  21850. // Mbed TLS 3.x takes an RNG callback here; 2.x and 4.x do not.
  21851. if (mbedtls_pk_parse_keyfile(&own_key, SERVER_PRIVATE_KEY_FILE, nullptr
  21852. #if MBEDTLS_VERSION_MAJOR == 3
  21853. ,
  21854. mbedtls_ctr_drbg_random, nullptr
  21855. #endif
  21856. ) != 0) {
  21857. return false;
  21858. }
  21859. // Load CA chain for client verification
  21860. if (mbedtls_x509_crt_parse_file(&ca_chain, CLIENT_CA_CERT_FILE) != 0) {
  21861. return false;
  21862. }
  21863. initialized = true;
  21864. }
  21865. // Configure the SSL config
  21866. mbedtls_ssl_conf_own_cert(conf, &own_cert, &own_key);
  21867. mbedtls_ssl_conf_ca_chain(conf, &ca_chain, nullptr);
  21868. mbedtls_ssl_conf_authmode(conf, MBEDTLS_SSL_VERIFY_REQUIRED);
  21869. // Set minimum TLS version using mbedTLS native API
  21870. #if MBEDTLS_VERSION_MAJOR >= 3
  21871. mbedtls_ssl_conf_min_tls_version(conf, MBEDTLS_SSL_VERSION_TLS1_2);
  21872. #else
  21873. mbedtls_ssl_conf_min_version(conf, MBEDTLS_SSL_MAJOR_VERSION_3,
  21874. MBEDTLS_SSL_MINOR_VERSION_3);
  21875. #endif
  21876. return true;
  21877. };
  21878. SSLServer svr(setup_callback);
  21879. ASSERT_TRUE(svr.is_valid());
  21880. ASSERT_TRUE(callback_invoked);
  21881. svr.Get("/test", [&](const Request &req, Response &res) {
  21882. res.set_content("test", "text/plain");
  21883. auto cert = req.peer_cert();
  21884. ASSERT_TRUE(static_cast<bool>(cert));
  21885. auto common_name = cert.subject_cn();
  21886. EXPECT_EQ("Common Name", common_name);
  21887. });
  21888. thread t = thread([&]() { ASSERT_TRUE(svr.listen(HOST, PORT)); });
  21889. auto se = detail::scope_exit([&] {
  21890. svr.stop();
  21891. t.join();
  21892. ASSERT_FALSE(svr.is_running());
  21893. });
  21894. svr.wait_until_ready();
  21895. SSLClient cli(HOST, PORT, CLIENT_CERT_FILE, CLIENT_PRIVATE_KEY_FILE);
  21896. cli.enable_server_certificate_verification(false);
  21897. cli.set_connection_timeout(30);
  21898. auto res = cli.Get("/test");
  21899. ASSERT_TRUE(res) << "Error: " << to_string(res.error());
  21900. ASSERT_EQ(StatusCode::OK_200, res->status);
  21901. }
  21902. // Regression test for a use-after-free where ~SSLClient freed the mbedTLS
  21903. // context (owning mbedtls_ssl_config) before shutting down a still-open
  21904. // keep-alive SSL session, which reads through that config in
  21905. // mbedtls_ssl_close_notify.
  21906. TEST(SSLClientServerTest, DestructWithLiveKeepAliveSessionMbedTLS) {
  21907. SSLServer svr(SERVER_CERT_FILE, SERVER_PRIVATE_KEY_FILE);
  21908. ASSERT_TRUE(svr.is_valid());
  21909. svr.Get("/test", [&](const Request & /*req*/, Response &res) {
  21910. res.set_content("test", "text/plain");
  21911. });
  21912. thread t = thread([&]() { ASSERT_TRUE(svr.listen(HOST, PORT)); });
  21913. auto se = detail::scope_exit([&] {
  21914. svr.stop();
  21915. t.join();
  21916. ASSERT_FALSE(svr.is_running());
  21917. });
  21918. svr.wait_until_ready();
  21919. {
  21920. SSLClient cli(HOST, PORT);
  21921. cli.enable_server_certificate_verification(false);
  21922. cli.set_keep_alive(true);
  21923. auto res = cli.Get("/test");
  21924. ASSERT_TRUE(res) << "Error: " << to_string(res.error());
  21925. ASSERT_EQ(StatusCode::OK_200, res->status);
  21926. // cli is destructed here with the keep-alive SSL session still open.
  21927. }
  21928. }
  21929. #endif
  21930. // WebSocket Tests
  21931. TEST(WebSocketTest, RSVBitsMustBeZero) {
  21932. // RFC 6455 Section 5.2: RSV1, RSV2, RSV3 MUST be 0 unless an extension
  21933. // defining the meaning of these bits has been negotiated.
  21934. auto make_frame = [](uint8_t first_byte) {
  21935. std::string frame;
  21936. frame += static_cast<char>(first_byte); // FIN + RSV + opcode
  21937. frame += static_cast<char>(0x05); // mask=0, payload_len=5
  21938. frame += "Hello";
  21939. return frame;
  21940. };
  21941. // RSV1 set (0x40)
  21942. {
  21943. detail::BufferStream strm;
  21944. strm.write(make_frame(0x81 | 0x40).data(), 8); // FIN + RSV1 + Text
  21945. ws::Opcode opcode;
  21946. std::string payload;
  21947. bool fin;
  21948. EXPECT_EQ(
  21949. ws::impl::read_websocket_frame(strm, opcode, payload, fin, false, 1024),
  21950. ws::impl::FrameRead::Fail);
  21951. }
  21952. // RSV2 set (0x20)
  21953. {
  21954. detail::BufferStream strm;
  21955. strm.write(make_frame(0x81 | 0x20).data(), 8); // FIN + RSV2 + Text
  21956. ws::Opcode opcode;
  21957. std::string payload;
  21958. bool fin;
  21959. EXPECT_EQ(
  21960. ws::impl::read_websocket_frame(strm, opcode, payload, fin, false, 1024),
  21961. ws::impl::FrameRead::Fail);
  21962. }
  21963. // RSV3 set (0x10)
  21964. {
  21965. detail::BufferStream strm;
  21966. strm.write(make_frame(0x81 | 0x10).data(), 8); // FIN + RSV3 + Text
  21967. ws::Opcode opcode;
  21968. std::string payload;
  21969. bool fin;
  21970. EXPECT_EQ(
  21971. ws::impl::read_websocket_frame(strm, opcode, payload, fin, false, 1024),
  21972. ws::impl::FrameRead::Fail);
  21973. }
  21974. // No RSV bits set - should succeed
  21975. {
  21976. detail::BufferStream strm;
  21977. strm.write(make_frame(0x81).data(), 8); // FIN + Text, no RSV
  21978. ws::Opcode opcode;
  21979. std::string payload;
  21980. bool fin;
  21981. EXPECT_EQ(
  21982. ws::impl::read_websocket_frame(strm, opcode, payload, fin, false, 1024),
  21983. ws::impl::FrameRead::Ok);
  21984. EXPECT_EQ(ws::Opcode::Text, opcode);
  21985. EXPECT_EQ("Hello", payload);
  21986. EXPECT_TRUE(fin);
  21987. }
  21988. }
  21989. TEST(WebSocketTest, ControlFrameValidation) {
  21990. // RFC 6455 Section 5.5: control frames MUST have FIN=1 and
  21991. // payload length <= 125.
  21992. // Ping with FIN=0 - must be rejected
  21993. {
  21994. detail::BufferStream strm;
  21995. std::string frame;
  21996. frame += static_cast<char>(0x09); // FIN=0, opcode=Ping
  21997. frame += static_cast<char>(0x00); // mask=0, payload_len=0
  21998. strm.write(frame.data(), frame.size());
  21999. ws::Opcode opcode;
  22000. std::string payload;
  22001. bool fin;
  22002. EXPECT_EQ(
  22003. ws::impl::read_websocket_frame(strm, opcode, payload, fin, false, 1024),
  22004. ws::impl::FrameRead::Fail);
  22005. }
  22006. // Close with FIN=0 - must be rejected
  22007. {
  22008. detail::BufferStream strm;
  22009. std::string frame;
  22010. frame += static_cast<char>(0x08); // FIN=0, opcode=Close
  22011. frame += static_cast<char>(0x00); // mask=0, payload_len=0
  22012. strm.write(frame.data(), frame.size());
  22013. ws::Opcode opcode;
  22014. std::string payload;
  22015. bool fin;
  22016. EXPECT_EQ(
  22017. ws::impl::read_websocket_frame(strm, opcode, payload, fin, false, 1024),
  22018. ws::impl::FrameRead::Fail);
  22019. }
  22020. // Ping with payload_len=126 (extended length) - must be rejected
  22021. {
  22022. detail::BufferStream strm;
  22023. std::string frame;
  22024. frame += static_cast<char>(0x89); // FIN=1, opcode=Ping
  22025. frame += static_cast<char>(126); // payload_len=126 (>125)
  22026. frame += static_cast<char>(0x00); // extended length high byte
  22027. frame += static_cast<char>(126); // extended length low byte
  22028. frame += std::string(126, 'x');
  22029. strm.write(frame.data(), frame.size());
  22030. ws::Opcode opcode;
  22031. std::string payload;
  22032. bool fin;
  22033. EXPECT_EQ(
  22034. ws::impl::read_websocket_frame(strm, opcode, payload, fin, false, 1024),
  22035. ws::impl::FrameRead::Fail);
  22036. }
  22037. // Ping with FIN=1 and payload_len=125 - should succeed
  22038. {
  22039. detail::BufferStream strm;
  22040. std::string frame;
  22041. frame += static_cast<char>(0x89); // FIN=1, opcode=Ping
  22042. frame += static_cast<char>(125); // payload_len=125
  22043. frame += std::string(125, 'x');
  22044. strm.write(frame.data(), frame.size());
  22045. ws::Opcode opcode;
  22046. std::string payload;
  22047. bool fin;
  22048. EXPECT_EQ(
  22049. ws::impl::read_websocket_frame(strm, opcode, payload, fin, false, 1024),
  22050. ws::impl::FrameRead::Ok);
  22051. EXPECT_EQ(ws::Opcode::Ping, opcode);
  22052. EXPECT_EQ(125u, payload.size());
  22053. EXPECT_TRUE(fin);
  22054. }
  22055. }
  22056. TEST(WebSocketTest, PayloadLength64BitMSBMustBeZero) {
  22057. // RFC 6455 Section 5.2: the most significant bit of a 64-bit payload
  22058. // length MUST be 0.
  22059. // MSB set - must be rejected
  22060. {
  22061. detail::BufferStream strm;
  22062. std::string frame;
  22063. frame += static_cast<char>(0x81); // FIN=1, opcode=Text
  22064. frame += static_cast<char>(127); // 64-bit extended length
  22065. frame += static_cast<char>(0x80); // MSB set (invalid)
  22066. frame += std::string(7, '\0'); // remaining 7 bytes of length
  22067. strm.write(frame.data(), frame.size());
  22068. ws::Opcode opcode;
  22069. std::string payload;
  22070. bool fin;
  22071. EXPECT_EQ(
  22072. ws::impl::read_websocket_frame(strm, opcode, payload, fin, false, 1024),
  22073. ws::impl::FrameRead::Fail);
  22074. }
  22075. // MSB clear - should pass length parsing (will be rejected by max_len,
  22076. // but that's a different check; use a small length to verify)
  22077. {
  22078. detail::BufferStream strm;
  22079. std::string frame;
  22080. frame += static_cast<char>(0x81); // FIN=1, opcode=Text
  22081. frame += static_cast<char>(127); // 64-bit extended length
  22082. frame += std::string(7, '\0'); // high bytes = 0
  22083. frame += static_cast<char>(0x03); // length = 3
  22084. frame += "abc";
  22085. strm.write(frame.data(), frame.size());
  22086. ws::Opcode opcode;
  22087. std::string payload;
  22088. bool fin;
  22089. EXPECT_EQ(
  22090. ws::impl::read_websocket_frame(strm, opcode, payload, fin, false, 1024),
  22091. ws::impl::FrameRead::Ok);
  22092. EXPECT_EQ(ws::Opcode::Text, opcode);
  22093. EXPECT_EQ("abc", payload);
  22094. }
  22095. }
  22096. TEST(WebSocketTest, InvalidUTF8TextFrame) {
  22097. // RFC 6455 Section 5.6: text frames must contain valid UTF-8.
  22098. // Valid UTF-8
  22099. EXPECT_TRUE(ws::impl::is_valid_utf8("Hello"));
  22100. EXPECT_TRUE(ws::impl::is_valid_utf8("\xC3\xA9")); // é (U+00E9)
  22101. EXPECT_TRUE(ws::impl::is_valid_utf8("\xE3\x81\x82")); // あ (U+3042)
  22102. EXPECT_TRUE(ws::impl::is_valid_utf8("\xF0\x9F\x98\x80")); // 😀 (U+1F600)
  22103. EXPECT_TRUE(ws::impl::is_valid_utf8(""));
  22104. // Invalid UTF-8
  22105. EXPECT_FALSE(ws::impl::is_valid_utf8("\x80")); // Invalid start byte
  22106. EXPECT_FALSE(ws::impl::is_valid_utf8("\xC3\x28")); // Bad continuation
  22107. EXPECT_FALSE(ws::impl::is_valid_utf8("\xC0\xAF")); // Overlong encoding
  22108. EXPECT_FALSE(
  22109. ws::impl::is_valid_utf8("\xED\xA0\x80")); // Surrogate half U+D800
  22110. EXPECT_FALSE(ws::impl::is_valid_utf8("\xF4\x90\x80\x80")); // Beyond U+10FFFF
  22111. }
  22112. TEST(WebSocketTest, ConnectAndDisconnect) {
  22113. Server svr;
  22114. svr.WebSocket("/ws", [](const Request &, ws::WebSocket &ws) {
  22115. std::string msg;
  22116. while (ws.read(msg)) {}
  22117. });
  22118. auto port = svr.bind_to_any_port(HOST);
  22119. std::thread t([&]() { svr.listen_after_bind(); });
  22120. svr.wait_until_ready();
  22121. ws::WebSocketClient client("ws://localhost:" + std::to_string(port) + "/ws");
  22122. auto res = client.connect();
  22123. ASSERT_TRUE(res);
  22124. EXPECT_EQ(Error::Success, res.error());
  22125. EXPECT_EQ(StatusCode::SwitchingProtocol_101, res.status());
  22126. EXPECT_TRUE(res.has_header("Sec-WebSocket-Accept"));
  22127. EXPECT_TRUE(client.is_open());
  22128. client.close();
  22129. EXPECT_FALSE(client.is_open());
  22130. svr.stop();
  22131. t.join();
  22132. }
  22133. TEST(WebSocketTest, ValidURL) {
  22134. ws::WebSocketClient ws1("ws://localhost:8080/path");
  22135. EXPECT_TRUE(ws1.is_valid());
  22136. ws::WebSocketClient ws2("ws://example.com/path");
  22137. EXPECT_TRUE(ws2.is_valid());
  22138. ws::WebSocketClient ws3("ws://example.com:9090/path/to/endpoint");
  22139. EXPECT_TRUE(ws3.is_valid());
  22140. #ifdef CPPHTTPLIB_SSL_ENABLED
  22141. ws::WebSocketClient wss1("wss://example.com/path");
  22142. EXPECT_TRUE(wss1.is_valid());
  22143. ws::WebSocketClient wss2("wss://example.com:443/path");
  22144. EXPECT_TRUE(wss2.is_valid());
  22145. #endif
  22146. }
  22147. TEST(WebSocketTest, InvalidURL) {
  22148. // No scheme
  22149. ws::WebSocketClient ws1("localhost:8080/path");
  22150. EXPECT_FALSE(ws1.is_valid());
  22151. // No path
  22152. ws::WebSocketClient ws2("ws://localhost:8080");
  22153. EXPECT_FALSE(ws2.is_valid());
  22154. // Empty string
  22155. ws::WebSocketClient ws3("");
  22156. EXPECT_FALSE(ws3.is_valid());
  22157. // Missing host
  22158. ws::WebSocketClient ws4("ws://:8080/path");
  22159. EXPECT_FALSE(ws4.is_valid());
  22160. // Port number overflow — should not crash
  22161. ws::WebSocketClient ws5("ws://localhost:99999999999999999999/path");
  22162. EXPECT_FALSE(ws5.is_valid());
  22163. // Port out of range
  22164. ws::WebSocketClient ws6("ws://localhost:99999/path");
  22165. EXPECT_FALSE(ws6.is_valid());
  22166. }
  22167. TEST(WebSocketTest, UnsupportedScheme) {
  22168. #ifdef CPPHTTPLIB_NO_EXCEPTIONS
  22169. ws::WebSocketClient ws1("http://localhost:8080/path");
  22170. EXPECT_FALSE(ws1.is_valid());
  22171. ws::WebSocketClient ws2("https://localhost:8080/path");
  22172. EXPECT_FALSE(ws2.is_valid());
  22173. ws::WebSocketClient ws3("ftp://localhost:8080/path");
  22174. EXPECT_FALSE(ws3.is_valid());
  22175. #else
  22176. EXPECT_THROW(ws::WebSocketClient("http://localhost:8080/path"),
  22177. std::invalid_argument);
  22178. EXPECT_THROW(ws::WebSocketClient("ftp://localhost:8080/path"),
  22179. std::invalid_argument);
  22180. #endif
  22181. }
  22182. TEST(WebSocketTest, ConnectWhenInvalid) {
  22183. ws::WebSocketClient ws("not a valid url");
  22184. EXPECT_FALSE(ws.is_valid());
  22185. auto res = ws.connect();
  22186. EXPECT_FALSE(res);
  22187. EXPECT_EQ(Error::Connection, res.error());
  22188. EXPECT_EQ(-1, res.status());
  22189. }
  22190. TEST(WebSocketTest, ConnectRefusedReportsError) {
  22191. // Grab a port that is free, then close it again so nothing listens there
  22192. Server svr;
  22193. auto port = svr.bind_to_any_port(HOST);
  22194. svr.stop();
  22195. ws::WebSocketClient client("ws://localhost:" + std::to_string(port) + "/ws");
  22196. auto res = client.connect();
  22197. ASSERT_FALSE(res);
  22198. EXPECT_EQ(Error::Connection, res.error());
  22199. EXPECT_EQ(-1, res.status());
  22200. }
  22201. TEST(WebSocketTest, DefaultPort) {
  22202. ws::WebSocketClient ws1("ws://example.com/path");
  22203. EXPECT_TRUE(ws1.is_valid());
  22204. // ws:// defaults to port 80 (verified by successful parse)
  22205. #ifdef CPPHTTPLIB_SSL_ENABLED
  22206. ws::WebSocketClient ws2("wss://example.com/path");
  22207. EXPECT_TRUE(ws2.is_valid());
  22208. // wss:// defaults to port 443 (verified by successful parse)
  22209. #endif
  22210. }
  22211. TEST(WebSocketTest, IPv6LiteralAddress) {
  22212. ws::WebSocketClient ws1("ws://[::1]:8080/path");
  22213. EXPECT_TRUE(ws1.is_valid());
  22214. ws::WebSocketClient ws2("ws://[fe80::1]:3000/ws");
  22215. EXPECT_TRUE(ws2.is_valid());
  22216. }
  22217. TEST(WebSocketTest, ComplexPath) {
  22218. ws::WebSocketClient ws1("ws://localhost:8080/path/to/endpoint");
  22219. EXPECT_TRUE(ws1.is_valid());
  22220. ws::WebSocketClient ws2("ws://localhost:8080/");
  22221. EXPECT_TRUE(ws2.is_valid());
  22222. }
  22223. TEST(WebSocketTest, SpecifyServerIPAddress_AnotherHostname) {
  22224. Server svr;
  22225. svr.WebSocket("/ws", [](const Request &, ws::WebSocket &ws) {
  22226. std::string msg;
  22227. while (ws.read(msg)) {}
  22228. });
  22229. auto port = svr.bind_to_any_port(HOST);
  22230. std::thread t([&]() { svr.listen_after_bind(); });
  22231. svr.wait_until_ready();
  22232. auto another_host = "example.com";
  22233. auto wrong_ip = "192.0.2.1";
  22234. ws::WebSocketClient client("ws://localhost:" + std::to_string(port) + "/ws");
  22235. client.set_hostname_addr_map({{another_host, wrong_ip}});
  22236. ASSERT_TRUE(client.connect());
  22237. EXPECT_TRUE(client.is_open());
  22238. client.close();
  22239. svr.stop();
  22240. t.join();
  22241. }
  22242. TEST(WebSocketTest, SpecifyServerIPAddress_RealHostname) {
  22243. Server svr;
  22244. svr.WebSocket("/ws", [](const Request &, ws::WebSocket &ws) {
  22245. std::string msg;
  22246. while (ws.read(msg)) {}
  22247. });
  22248. auto port = svr.bind_to_any_port(HOST);
  22249. std::thread t([&]() { svr.listen_after_bind(); });
  22250. svr.wait_until_ready();
  22251. auto wrong_ip = "192.0.2.1";
  22252. ws::WebSocketClient client("ws://localhost:" + std::to_string(port) + "/ws");
  22253. client.set_hostname_addr_map({{"localhost", wrong_ip}});
  22254. client.set_connection_timeout(1);
  22255. client.set_read_timeout(1);
  22256. client.set_write_timeout(1);
  22257. EXPECT_FALSE(client.connect());
  22258. EXPECT_FALSE(client.is_open());
  22259. svr.stop();
  22260. t.join();
  22261. }
  22262. TEST(WebSocketTest, SpecifyServerIPAddress_HostnameAsAddrMapValue) {
  22263. // A mapped value that is not an IP literal must be resolved. HOST resolves
  22264. // from the hosts file, so this test needs no external DNS. "target.invalid"
  22265. // (RFC 6761) is only a map key and the Host header value.
  22266. auto host = "target.invalid";
  22267. Server svr;
  22268. std::string received_host;
  22269. svr.WebSocket("/ws", [&](const Request &req, ws::WebSocket &ws) {
  22270. received_host = req.get_header_value("Host");
  22271. std::string msg;
  22272. while (ws.read(msg)) {}
  22273. });
  22274. auto port = svr.bind_to_any_port(HOST);
  22275. std::thread t([&]() { svr.listen_after_bind(); });
  22276. // ASSERT_* below returns from the test body, which would leave t joinable
  22277. // and make ~thread call std::terminate.
  22278. auto se = detail::scope_exit([&] {
  22279. svr.stop();
  22280. if (t.joinable()) { t.join(); }
  22281. });
  22282. svr.wait_until_ready();
  22283. ws::WebSocketClient client("ws://" + std::string(host) + ":" +
  22284. std::to_string(port) + "/ws");
  22285. client.set_hostname_addr_map({{host, HOST}});
  22286. ASSERT_TRUE(client.connect());
  22287. EXPECT_TRUE(client.is_open());
  22288. client.close();
  22289. svr.stop();
  22290. t.join();
  22291. // The mapping only redirects the connection; the identity stays host_.
  22292. EXPECT_EQ(std::string(host) + ":" + std::to_string(port), received_host);
  22293. }
  22294. class WebSocketIntegrationTest : public ::testing::Test {
  22295. protected:
  22296. void SetUp() override {
  22297. server_ = httplib::detail::make_unique<Server>();
  22298. setup_server();
  22299. start_server();
  22300. }
  22301. void TearDown() override {
  22302. server_->stop();
  22303. if (server_thread_.joinable()) { server_thread_.join(); }
  22304. }
  22305. void setup_server() {
  22306. server_->WebSocket("/ws-echo", [](const Request &, ws::WebSocket &ws) {
  22307. std::string msg;
  22308. ws::ReadResult ret;
  22309. while ((ret = ws.read(msg))) {
  22310. if (ret == ws::Binary) {
  22311. ws.send(msg.data(), msg.size());
  22312. } else {
  22313. ws.send(msg);
  22314. }
  22315. }
  22316. });
  22317. server_->WebSocket("/ws-echo-string",
  22318. [](const Request &, ws::WebSocket &ws) {
  22319. std::string msg;
  22320. while (ws.read(msg)) {
  22321. ws.send("echo: " + msg);
  22322. }
  22323. });
  22324. server_->WebSocket(
  22325. "/ws-request-info", [](const Request &req, ws::WebSocket &ws) {
  22326. // Echo back request metadata
  22327. ws.send("path:" + req.path);
  22328. ws.send("header:" + req.get_header_value("X-Test-Header"));
  22329. std::string msg;
  22330. while (ws.read(msg)) {}
  22331. });
  22332. server_->WebSocket("/ws-close", [](const Request &, ws::WebSocket &ws) {
  22333. std::string msg;
  22334. ws.read(msg); // wait for a message
  22335. ws.close();
  22336. });
  22337. server_->WebSocket("/ws-close-status",
  22338. [](const Request &, ws::WebSocket &ws) {
  22339. std::string msg;
  22340. ws.read(msg); // wait for a message
  22341. ws.close(ws::CloseStatus::GoingAway, "shutting down");
  22342. });
  22343. server_->WebSocket(
  22344. "/ws-subprotocol",
  22345. [](const Request &, ws::WebSocket &ws) {
  22346. std::string msg;
  22347. while (ws.read(msg)) {
  22348. ws.send(msg);
  22349. }
  22350. },
  22351. [](const std::vector<std::string> &protocols) -> std::string {
  22352. for (const auto &p : protocols) {
  22353. if (p == "graphql-ws") { return p; }
  22354. }
  22355. return "";
  22356. });
  22357. server_->WebSocket(
  22358. "/ws-subprotocol-unoffered",
  22359. [](const Request &, ws::WebSocket &ws) {
  22360. std::string msg;
  22361. while (ws.read(msg)) {
  22362. ws.send(msg);
  22363. }
  22364. },
  22365. [](const std::vector<std::string> &) -> std::string {
  22366. return "admin";
  22367. });
  22368. }
  22369. void start_server() {
  22370. port_ = server_->bind_to_any_port(HOST);
  22371. server_thread_ = std::thread([this]() { server_->listen_after_bind(); });
  22372. server_->wait_until_ready();
  22373. }
  22374. std::unique_ptr<Server> server_;
  22375. std::thread server_thread_;
  22376. int port_ = 0;
  22377. };
  22378. TEST_F(WebSocketIntegrationTest, TextEcho) {
  22379. ws::WebSocketClient client("ws://localhost:" + std::to_string(port_) +
  22380. "/ws-echo");
  22381. ASSERT_TRUE(client.connect());
  22382. ASSERT_TRUE(client.is_open());
  22383. ASSERT_TRUE(client.send("Hello WebSocket"));
  22384. std::string msg;
  22385. EXPECT_EQ(ws::Text, client.read(msg));
  22386. EXPECT_EQ("Hello WebSocket", msg);
  22387. client.close();
  22388. }
  22389. TEST_F(WebSocketIntegrationTest, BinaryEcho) {
  22390. ws::WebSocketClient client("ws://localhost:" + std::to_string(port_) +
  22391. "/ws-echo");
  22392. ASSERT_TRUE(client.connect());
  22393. std::string binary_data = {'\x00', '\x01', '\x02', '\xFF', '\xFE'};
  22394. ASSERT_TRUE(client.send(binary_data.data(), binary_data.size()));
  22395. std::string msg;
  22396. EXPECT_EQ(ws::Binary, client.read(msg));
  22397. EXPECT_EQ(binary_data, msg);
  22398. client.close();
  22399. }
  22400. TEST_F(WebSocketIntegrationTest, MultipleMessages) {
  22401. ws::WebSocketClient client("ws://localhost:" + std::to_string(port_) +
  22402. "/ws-echo");
  22403. ASSERT_TRUE(client.connect());
  22404. for (int i = 0; i < 10; i++) {
  22405. auto text = "message " + std::to_string(i);
  22406. ASSERT_TRUE(client.send(text));
  22407. std::string msg;
  22408. ASSERT_TRUE(client.read(msg));
  22409. EXPECT_EQ(text, msg);
  22410. }
  22411. client.close();
  22412. }
  22413. TEST_F(WebSocketIntegrationTest, CloseHandshake) {
  22414. ws::WebSocketClient client("ws://localhost:" + std::to_string(port_) +
  22415. "/ws-close");
  22416. ASSERT_TRUE(client.connect());
  22417. // Send a message to trigger the server to close
  22418. ASSERT_TRUE(client.send("trigger close"));
  22419. // The server will close, so read should return false
  22420. std::string msg;
  22421. EXPECT_FALSE(client.read(msg));
  22422. EXPECT_FALSE(client.is_open());
  22423. }
  22424. TEST_F(WebSocketIntegrationTest, LargeMessage) {
  22425. ws::WebSocketClient client("ws://localhost:" + std::to_string(port_) +
  22426. "/ws-echo");
  22427. ASSERT_TRUE(client.connect());
  22428. // 128KB message
  22429. std::string large_data(128 * 1024, 'X');
  22430. ASSERT_TRUE(client.send(large_data));
  22431. std::string msg;
  22432. ASSERT_TRUE(client.read(msg));
  22433. EXPECT_EQ(large_data, msg);
  22434. client.close();
  22435. }
  22436. TEST_F(WebSocketIntegrationTest, ConcurrentSend) {
  22437. ws::WebSocketClient client("ws://localhost:" + std::to_string(port_) +
  22438. "/ws-echo");
  22439. ASSERT_TRUE(client.connect());
  22440. const int num_threads = 4;
  22441. std::vector<std::thread> threads;
  22442. std::atomic<int> send_count{0};
  22443. for (int t = 0; t < num_threads; t++) {
  22444. threads.emplace_back([&client, &send_count, t]() {
  22445. for (int i = 0; i < 5; i++) {
  22446. auto text = "thread" + std::to_string(t) + "_msg" + std::to_string(i);
  22447. if (client.send(text)) { send_count++; }
  22448. }
  22449. });
  22450. }
  22451. for (auto &th : threads) {
  22452. th.join();
  22453. }
  22454. int received = 0;
  22455. std::string msg;
  22456. while (received < send_count.load()) {
  22457. if (!client.read(msg)) { break; }
  22458. received++;
  22459. }
  22460. EXPECT_EQ(send_count.load(), received);
  22461. client.close();
  22462. }
  22463. TEST_F(WebSocketIntegrationTest, ReadString) {
  22464. ws::WebSocketClient client("ws://localhost:" + std::to_string(port_) +
  22465. "/ws-echo-string");
  22466. ASSERT_TRUE(client.connect());
  22467. ASSERT_TRUE(client.send("hello"));
  22468. std::string msg;
  22469. ASSERT_TRUE(client.read(msg));
  22470. EXPECT_EQ("echo: hello", msg);
  22471. ASSERT_TRUE(client.send("world"));
  22472. ASSERT_TRUE(client.read(msg));
  22473. EXPECT_EQ("echo: world", msg);
  22474. client.close();
  22475. }
  22476. TEST_F(WebSocketIntegrationTest, RequestAccess) {
  22477. Headers headers = {{"X-Test-Header", "test-value"}};
  22478. ws::WebSocketClient client(
  22479. "ws://localhost:" + std::to_string(port_) + "/ws-request-info", headers);
  22480. ASSERT_TRUE(client.connect());
  22481. std::string msg;
  22482. ASSERT_TRUE(client.read(msg));
  22483. EXPECT_EQ("path:/ws-request-info", msg);
  22484. ASSERT_TRUE(client.read(msg));
  22485. EXPECT_EQ("header:test-value", msg);
  22486. client.close();
  22487. }
  22488. TEST_F(WebSocketIntegrationTest, ReadTimeout) {
  22489. ws::WebSocketClient client("ws://localhost:" + std::to_string(port_) +
  22490. "/ws-echo");
  22491. client.set_read_timeout(1, 0); // 1 second
  22492. ASSERT_TRUE(client.connect());
  22493. // Don't send anything — server echo handler waits for a message, so read()
  22494. // should time out. The connection survives it: nothing was consumed.
  22495. std::string msg;
  22496. EXPECT_EQ(client.read(msg), ws::Timeout);
  22497. EXPECT_TRUE(client.is_open());
  22498. // And it is still usable afterwards.
  22499. EXPECT_TRUE(client.send("after timeout"));
  22500. EXPECT_EQ(client.read(msg), ws::Text);
  22501. EXPECT_EQ(msg, "after timeout");
  22502. }
  22503. TEST_F(WebSocketIntegrationTest, ReadTimeoutLeavesMessageUntouched) {
  22504. ws::WebSocketClient client("ws://localhost:" + std::to_string(port_) +
  22505. "/ws-echo");
  22506. client.set_read_timeout(1, 0);
  22507. ASSERT_TRUE(client.connect());
  22508. ASSERT_TRUE(client.send("first"));
  22509. std::string msg;
  22510. ASSERT_EQ(client.read(msg), ws::Text);
  22511. ASSERT_EQ(msg, "first");
  22512. // A timeout does not write to msg. This is why `while (ws.read(msg))` must
  22513. // not be used with a read timeout: it would reprocess the previous message.
  22514. EXPECT_EQ(client.read(msg), ws::Timeout);
  22515. EXPECT_EQ(msg, "first");
  22516. }
  22517. TEST_F(WebSocketIntegrationTest, ReadTimeoutSetAfterConnect) {
  22518. ws::WebSocketClient client("ws://localhost:" + std::to_string(port_) +
  22519. "/ws-echo");
  22520. ASSERT_TRUE(client.connect());
  22521. // Setting it once the connection is open reaches the live stream, not just
  22522. // the seed for the next connect().
  22523. client.set_read_timeout(1, 0);
  22524. std::string msg;
  22525. EXPECT_EQ(client.read(msg), ws::Timeout);
  22526. EXPECT_TRUE(client.is_open());
  22527. }
  22528. TEST_F(WebSocketIntegrationTest, MaxPayloadExceeded) {
  22529. ws::WebSocketClient client("ws://localhost:" + std::to_string(port_) +
  22530. "/ws-echo");
  22531. client.set_read_timeout(5, 0);
  22532. ASSERT_TRUE(client.connect());
  22533. // Send a message exceeding CPPHTTPLIB_WEBSOCKET_MAX_PAYLOAD_LENGTH (16MB).
  22534. // The server should reject it and close the connection.
  22535. std::string oversized(CPPHTTPLIB_WEBSOCKET_MAX_PAYLOAD_LENGTH + 1, 'A');
  22536. client.send(oversized);
  22537. // The server's read() should have failed due to payload limit,
  22538. // so our read() should return false (connection closed).
  22539. std::string msg;
  22540. EXPECT_FALSE(client.read(msg));
  22541. }
  22542. TEST_F(WebSocketIntegrationTest, MaxPayloadAtLimit) {
  22543. ws::WebSocketClient client("ws://localhost:" + std::to_string(port_) +
  22544. "/ws-echo");
  22545. client.set_read_timeout(10, 0);
  22546. ASSERT_TRUE(client.connect());
  22547. // Send a message exactly at CPPHTTPLIB_WEBSOCKET_MAX_PAYLOAD_LENGTH (16MB).
  22548. // This should succeed.
  22549. std::string at_limit(CPPHTTPLIB_WEBSOCKET_MAX_PAYLOAD_LENGTH, 'B');
  22550. ASSERT_TRUE(client.send(at_limit));
  22551. std::string msg;
  22552. ASSERT_TRUE(client.read(msg));
  22553. EXPECT_EQ(at_limit.size(), msg.size());
  22554. client.close();
  22555. }
  22556. TEST_F(WebSocketIntegrationTest, ConnectToInvalidPath) {
  22557. ws::WebSocketClient client("ws://localhost:" + std::to_string(port_) +
  22558. "/nonexistent");
  22559. auto res = client.connect();
  22560. EXPECT_FALSE(res);
  22561. EXPECT_EQ(Error::WebSocketHandshake, res.error());
  22562. EXPECT_EQ(StatusCode::NotFound_404, res.status());
  22563. EXPECT_FALSE(client.is_open());
  22564. }
  22565. TEST_F(WebSocketIntegrationTest, EmptyMessage) {
  22566. ws::WebSocketClient client("ws://localhost:" + std::to_string(port_) +
  22567. "/ws-echo");
  22568. ASSERT_TRUE(client.connect());
  22569. ASSERT_TRUE(client.send(""));
  22570. std::string msg;
  22571. EXPECT_EQ(ws::Text, client.read(msg));
  22572. EXPECT_EQ("", msg);
  22573. client.close();
  22574. }
  22575. TEST_F(WebSocketIntegrationTest, Reconnect) {
  22576. ws::WebSocketClient client("ws://localhost:" + std::to_string(port_) +
  22577. "/ws-echo");
  22578. // First connection
  22579. ASSERT_TRUE(client.connect());
  22580. ASSERT_TRUE(client.send("first"));
  22581. std::string msg;
  22582. ASSERT_TRUE(client.read(msg));
  22583. EXPECT_EQ("first", msg);
  22584. client.close();
  22585. EXPECT_FALSE(client.is_open());
  22586. // Reconnect using the same client object
  22587. ASSERT_TRUE(client.connect());
  22588. ASSERT_TRUE(client.is_open());
  22589. ASSERT_TRUE(client.send("second"));
  22590. ASSERT_TRUE(client.read(msg));
  22591. EXPECT_EQ("second", msg);
  22592. client.close();
  22593. }
  22594. TEST_F(WebSocketIntegrationTest, CloseWithStatus) {
  22595. ws::WebSocketClient client("ws://localhost:" + std::to_string(port_) +
  22596. "/ws-close-status");
  22597. ASSERT_TRUE(client.connect());
  22598. // Trigger the server to close with GoingAway status
  22599. ASSERT_TRUE(client.send("trigger"));
  22600. // read() should return false after receiving the close frame
  22601. std::string msg;
  22602. EXPECT_FALSE(client.read(msg));
  22603. EXPECT_FALSE(client.is_open());
  22604. }
  22605. TEST_F(WebSocketIntegrationTest, ClientCloseWithStatus) {
  22606. ws::WebSocketClient client("ws://localhost:" + std::to_string(port_) +
  22607. "/ws-echo");
  22608. ASSERT_TRUE(client.connect());
  22609. client.close(ws::CloseStatus::GoingAway, "client leaving");
  22610. EXPECT_FALSE(client.is_open());
  22611. }
  22612. TEST_F(WebSocketIntegrationTest, SubProtocolNegotiation) {
  22613. Headers headers = {{"Sec-WebSocket-Protocol", "mqtt, graphql-ws"}};
  22614. ws::WebSocketClient client(
  22615. "ws://localhost:" + std::to_string(port_) + "/ws-subprotocol", headers);
  22616. ASSERT_TRUE(client.connect());
  22617. // Server should have selected graphql-ws
  22618. EXPECT_EQ("graphql-ws", client.subprotocol());
  22619. client.close();
  22620. }
  22621. TEST_F(WebSocketIntegrationTest, SubProtocolSplitAcrossFieldLines) {
  22622. Headers headers;
  22623. headers.emplace("Sec-WebSocket-Protocol", "mqtt");
  22624. headers.emplace("Sec-WebSocket-Protocol", "graphql-ws");
  22625. ws::WebSocketClient client(
  22626. "ws://localhost:" + std::to_string(port_) + "/ws-subprotocol", headers);
  22627. ASSERT_TRUE(client.connect());
  22628. // The offer on the second field line counts too, so graphql-ws is selected
  22629. EXPECT_EQ("graphql-ws", client.subprotocol());
  22630. client.close();
  22631. }
  22632. TEST_F(WebSocketIntegrationTest, SubProtocolNoMatch) {
  22633. Headers headers = {{"Sec-WebSocket-Protocol", "mqtt, wamp"}};
  22634. ws::WebSocketClient client(
  22635. "ws://localhost:" + std::to_string(port_) + "/ws-subprotocol", headers);
  22636. ASSERT_TRUE(client.connect());
  22637. // Server should not have selected any subprotocol
  22638. EXPECT_TRUE(client.subprotocol().empty());
  22639. client.close();
  22640. }
  22641. TEST_F(WebSocketIntegrationTest, SubProtocolSelectorReturnsUnoffered) {
  22642. Headers headers = {{"Sec-WebSocket-Protocol", "chat"}};
  22643. ws::WebSocketClient client("ws://localhost:" + std::to_string(port_) +
  22644. "/ws-subprotocol-unoffered",
  22645. headers);
  22646. ASSERT_TRUE(client.connect());
  22647. EXPECT_TRUE(client.subprotocol().empty());
  22648. client.close();
  22649. }
  22650. TEST_F(WebSocketIntegrationTest, SubProtocolNotRequested) {
  22651. // Connect without requesting any subprotocol
  22652. ws::WebSocketClient client("ws://localhost:" + std::to_string(port_) +
  22653. "/ws-subprotocol");
  22654. ASSERT_TRUE(client.connect());
  22655. EXPECT_TRUE(client.subprotocol().empty());
  22656. client.close();
  22657. }
  22658. TEST_F(WebSocketIntegrationTest, SocketSettings) {
  22659. ws::WebSocketClient client("ws://localhost:" + std::to_string(port_) +
  22660. "/ws-echo");
  22661. client.set_tcp_nodelay(true);
  22662. client.set_connection_timeout(3, 0);
  22663. bool socket_options_called = false;
  22664. client.set_socket_options([&](socket_t) { socket_options_called = true; });
  22665. ASSERT_TRUE(client.connect());
  22666. ASSERT_TRUE(client.is_open());
  22667. EXPECT_TRUE(socket_options_called);
  22668. ASSERT_TRUE(client.send("hello"));
  22669. std::string msg;
  22670. auto result = client.read(msg);
  22671. EXPECT_EQ(result, ws::ReadResult::Text);
  22672. EXPECT_EQ(msg, "hello");
  22673. client.close();
  22674. }
  22675. TEST_F(WebSocketIntegrationTest, ChronoTimeoutSetters) {
  22676. ws::WebSocketClient client("ws://localhost:" + std::to_string(port_) +
  22677. "/ws-echo");
  22678. client.set_connection_timeout(std::chrono::seconds(3));
  22679. client.set_write_timeout(std::chrono::seconds(3));
  22680. // A sub-second remainder exercises the seconds/microseconds split.
  22681. client.set_read_timeout(std::chrono::milliseconds(1500));
  22682. ASSERT_TRUE(client.connect());
  22683. auto start = std::chrono::steady_clock::now();
  22684. std::string msg;
  22685. EXPECT_EQ(client.read(msg), ws::ReadResult::Timeout);
  22686. auto elapsed = std::chrono::duration_cast<std::chrono::milliseconds>(
  22687. std::chrono::steady_clock::now() - start)
  22688. .count();
  22689. // Above 1s so that dropping the microseconds half of the split fails here.
  22690. // Ignoring the setter altogether would not reach this line at all: a client
  22691. // waits forever by default.
  22692. EXPECT_GE(elapsed, 1400);
  22693. EXPECT_LT(elapsed, 30000);
  22694. }
  22695. TEST(WebSocketPreRoutingTest, RejectWithoutAuth) {
  22696. Server svr;
  22697. svr.set_pre_routing_handler([](const Request &req, Response &res) {
  22698. if (!req.has_header("Authorization")) {
  22699. res.status = StatusCode::Unauthorized_401;
  22700. res.set_content("Unauthorized", "text/plain");
  22701. return Server::HandlerResponse::Handled;
  22702. }
  22703. return Server::HandlerResponse::Unhandled;
  22704. });
  22705. svr.WebSocket("/ws", [](const Request &, ws::WebSocket &ws) {
  22706. std::string msg;
  22707. while (ws.read(msg)) {
  22708. ws.send(msg);
  22709. }
  22710. });
  22711. auto port = svr.bind_to_any_port("localhost");
  22712. std::thread t([&]() { svr.listen_after_bind(); });
  22713. svr.wait_until_ready();
  22714. // Without Authorization header - should be rejected before upgrade
  22715. ws::WebSocketClient client1("ws://localhost:" + std::to_string(port) + "/ws");
  22716. EXPECT_FALSE(client1.connect());
  22717. // The rejection is framed like any other HTTP response
  22718. {
  22719. Client cli("localhost", port);
  22720. Headers headers = {{"Upgrade", "websocket"},
  22721. {"Connection", "Upgrade"},
  22722. {"Sec-WebSocket-Key", "dGhlIHNhbXBsZSBub25jZQ=="},
  22723. {"Sec-WebSocket-Version", "13"}};
  22724. auto res = cli.Get("/ws", headers);
  22725. ASSERT_TRUE(res);
  22726. EXPECT_EQ(StatusCode::Unauthorized_401, res->status);
  22727. EXPECT_EQ("12", res->get_header_value("Content-Length"));
  22728. EXPECT_EQ("Unauthorized", res->body);
  22729. }
  22730. // With Authorization header - should succeed
  22731. Headers headers = {{"Authorization", "Bearer token123"}};
  22732. ws::WebSocketClient client2("ws://localhost:" + std::to_string(port) + "/ws",
  22733. headers);
  22734. ASSERT_TRUE(client2.connect());
  22735. ASSERT_TRUE(client2.send("hello"));
  22736. std::string msg;
  22737. ASSERT_TRUE(client2.read(msg));
  22738. EXPECT_EQ("hello", msg);
  22739. client2.close();
  22740. svr.stop();
  22741. t.join();
  22742. }
  22743. TEST(WebSocketPreRequestTest, RejectWithoutAuth) {
  22744. Server svr;
  22745. std::atomic<int> pre_request_calls{0};
  22746. std::atomic<bool> route_matched{false};
  22747. svr.set_pre_request_handler([&](const Request &req, Response &res) {
  22748. pre_request_calls++;
  22749. if (req.matched_route == "/ws/:id") { route_matched = true; }
  22750. if (req.get_header_value("Authorization") != "Bearer token123") {
  22751. res.status = StatusCode::Unauthorized_401;
  22752. res.set_content("Unauthorized", "text/plain");
  22753. return Server::HandlerResponse::Handled;
  22754. }
  22755. return Server::HandlerResponse::Unhandled;
  22756. });
  22757. std::atomic<bool> handler_called{false};
  22758. svr.WebSocket("/ws/:id", [&](const Request &req, ws::WebSocket &ws) {
  22759. handler_called = true;
  22760. ws.send(req.matched_route + " " + req.path_params.at("id"));
  22761. });
  22762. auto port = svr.bind_to_any_port("localhost");
  22763. std::thread t([&]() { svr.listen_after_bind(); });
  22764. svr.wait_until_ready();
  22765. // Without Authorization header - should be rejected before upgrade
  22766. ws::WebSocketClient client1("ws://localhost:" + std::to_string(port) +
  22767. "/ws/1");
  22768. EXPECT_FALSE(client1.connect());
  22769. EXPECT_FALSE(handler_called);
  22770. EXPECT_EQ(1, pre_request_calls);
  22771. EXPECT_TRUE(route_matched);
  22772. // The rejection is an ordinary HTTP response, not a protocol switch
  22773. {
  22774. Client cli("localhost", port);
  22775. Headers headers = {{"Upgrade", "websocket"},
  22776. {"Connection", "Upgrade"},
  22777. {"Sec-WebSocket-Key", "dGhlIHNhbXBsZSBub25jZQ=="},
  22778. {"Sec-WebSocket-Version", "13"}};
  22779. auto res = cli.Get("/ws/1", headers);
  22780. ASSERT_TRUE(res);
  22781. EXPECT_EQ(StatusCode::Unauthorized_401, res->status);
  22782. EXPECT_EQ("12", res->get_header_value("Content-Length"));
  22783. EXPECT_EQ("Unauthorized", res->body);
  22784. }
  22785. EXPECT_FALSE(handler_called);
  22786. // With Authorization header - should succeed
  22787. Headers headers = {{"Authorization", "Bearer token123"}};
  22788. ws::WebSocketClient client2(
  22789. "ws://localhost:" + std::to_string(port) + "/ws/2", headers);
  22790. ASSERT_TRUE(client2.connect());
  22791. std::string msg;
  22792. ASSERT_TRUE(client2.read(msg));
  22793. EXPECT_EQ("/ws/:id 2", msg);
  22794. EXPECT_TRUE(handler_called);
  22795. client2.close();
  22796. svr.stop();
  22797. t.join();
  22798. }
  22799. TEST(WebSocketServerTimeoutTest, HandlerSendsWhileNothingArrives) {
  22800. Server svr;
  22801. svr.WebSocket("/ws", [](const Request &, ws::WebSocket &ws) {
  22802. // A read timeout is how a handler gets control back. Without it, a handler
  22803. // parked in read() can never write on the connection it is reading.
  22804. ws.set_read_timeout(std::chrono::milliseconds(100));
  22805. std::string msg;
  22806. while (ws.is_open()) {
  22807. auto r = ws.read(msg);
  22808. if (r == httplib::ws::Timeout) {
  22809. ws.send("tick");
  22810. continue;
  22811. }
  22812. if (r == httplib::ws::Fail) { break; }
  22813. ws.send(msg);
  22814. }
  22815. });
  22816. auto port = svr.bind_to_any_port("localhost");
  22817. std::thread t([&]() { svr.listen_after_bind(); });
  22818. svr.wait_until_ready();
  22819. ws::WebSocketClient client("ws://localhost:" + std::to_string(port) + "/ws");
  22820. client.set_read_timeout(10, 0); // fail rather than hang if no tick arrives
  22821. ASSERT_TRUE(client.connect());
  22822. // The client sends nothing, so anything it receives came out of the
  22823. // handler's timeout path.
  22824. std::string msg;
  22825. ASSERT_EQ(client.read(msg), ws::Text);
  22826. EXPECT_EQ("tick", msg);
  22827. client.close();
  22828. svr.stop();
  22829. t.join();
  22830. }
  22831. // Stream::read may return fewer bytes than asked for. This is that contract at
  22832. // its worst -- one byte per call -- which is what a frame header straddling a
  22833. // read buffer's boundary looks like to the frame parser.
  22834. class WsByteAtATimeStream : public Stream {
  22835. public:
  22836. explicit WsByteAtATimeStream(std::string data) : data_(std::move(data)) {}
  22837. bool is_readable() const override { return true; }
  22838. bool wait_readable() const override { return true; }
  22839. bool wait_writable() const override { return true; }
  22840. ssize_t read(char *ptr, size_t size) override {
  22841. if (size == 0 || pos_ >= data_.size()) { return 0; }
  22842. *ptr = data_[pos_++];
  22843. return 1;
  22844. }
  22845. ssize_t write(const char *, size_t size) override {
  22846. return static_cast<ssize_t>(size);
  22847. }
  22848. void get_remote_ip_and_port(std::string &ip, int &port) const override {
  22849. ip = "127.0.0.1";
  22850. port = 0;
  22851. }
  22852. void get_local_ip_and_port(std::string &ip, int &port) const override {
  22853. ip = "127.0.0.1";
  22854. port = 0;
  22855. }
  22856. socket_t socket() const override { return INVALID_SOCKET; }
  22857. time_t duration() const override { return 0; }
  22858. private:
  22859. std::string data_;
  22860. size_t pos_ = 0;
  22861. };
  22862. TEST(WebSocketFrameTest, MultiByteFieldsSplitAcrossReads) {
  22863. // The payload uses the 16-bit extended length, so the header, the length
  22864. // and the mask key are all multi-byte fields here. Each used to be read
  22865. // with a single read() call, which fails as soon as one is split. The
  22866. // payload is also a little over one read chunk, so it is read in two.
  22867. std::string body;
  22868. for (size_t i = 0; i < CPPHTTPLIB_RECV_BUFSIZ + 3; i++) {
  22869. body += static_cast<char>(i % 251);
  22870. }
  22871. const uint8_t mask[4] = {0x0a, 0x0b, 0x0c, 0x0d};
  22872. std::string frame;
  22873. frame += static_cast<char>(0x81); // FIN + Text
  22874. frame += static_cast<char>(0x80 | 126); // masked, 16-bit length follows
  22875. frame += static_cast<char>(body.size() >> 8);
  22876. frame += static_cast<char>(body.size() & 0xff);
  22877. for (size_t i = 0; i < 4; i++) {
  22878. frame += static_cast<char>(mask[i]);
  22879. }
  22880. for (size_t i = 0; i < body.size(); i++) {
  22881. frame += static_cast<char>(body[i] ^ mask[i % 4]);
  22882. }
  22883. WsByteAtATimeStream strm(frame);
  22884. ws::Opcode opcode;
  22885. std::string payload;
  22886. bool fin = false;
  22887. ASSERT_EQ(ws::impl::read_websocket_frame(strm, opcode, payload, fin,
  22888. /*expect_masked=*/true, body.size()),
  22889. ws::impl::FrameRead::Ok);
  22890. EXPECT_TRUE(fin);
  22891. EXPECT_EQ(opcode, ws::Opcode::Text);
  22892. EXPECT_EQ(payload, body);
  22893. }
  22894. TEST(WebSocketFrameTest, ZeroMaxLenMeansNoLimit) {
  22895. std::string body(2000, 'x');
  22896. std::string frame;
  22897. frame += static_cast<char>(0x82); // FIN + Binary
  22898. frame += static_cast<char>(126); // 16-bit length follows
  22899. frame += static_cast<char>(body.size() >> 8);
  22900. frame += static_cast<char>(body.size() & 0xff);
  22901. frame += body;
  22902. detail::BufferStream strm;
  22903. strm.write(frame.data(), frame.size());
  22904. ws::Opcode opcode;
  22905. std::string payload;
  22906. bool fin;
  22907. EXPECT_EQ(
  22908. ws::impl::read_websocket_frame(strm, opcode, payload, fin, false, 0),
  22909. ws::impl::FrameRead::Ok);
  22910. EXPECT_EQ(body, payload);
  22911. }
  22912. TEST(WebSocketFrameTest, PayloadGrowsOnlyAsItArrives) {
  22913. // The header announces the largest payload allowed, and only 3 bytes of it
  22914. // ever arrive.
  22915. uint64_t len = CPPHTTPLIB_WEBSOCKET_MAX_PAYLOAD_LENGTH;
  22916. std::string frame;
  22917. frame += static_cast<char>(0x82); // FIN + Binary
  22918. frame += static_cast<char>(127); // 64-bit length follows
  22919. for (int shift = 56; shift >= 0; shift -= 8) {
  22920. frame += static_cast<char>((len >> shift) & 0xff);
  22921. }
  22922. frame += "abc";
  22923. detail::BufferStream strm;
  22924. strm.write(frame.data(), frame.size());
  22925. ws::Opcode opcode;
  22926. std::string payload;
  22927. bool fin;
  22928. EXPECT_EQ(
  22929. ws::impl::read_websocket_frame(strm, opcode, payload, fin, false,
  22930. CPPHTTPLIB_WEBSOCKET_MAX_PAYLOAD_LENGTH),
  22931. ws::impl::FrameRead::Fail);
  22932. EXPECT_LT(payload.capacity(), 2 * CPPHTTPLIB_RECV_BUFSIZ);
  22933. }
  22934. TEST(WebSocketTest, QueryStringInHandshake) {
  22935. Server svr;
  22936. std::mutex mtx;
  22937. std::string received_target;
  22938. std::string received_token;
  22939. svr.WebSocket("/ws", [&](const Request &req, ws::WebSocket &ws) {
  22940. {
  22941. std::lock_guard<std::mutex> lock(mtx);
  22942. received_target = req.target;
  22943. if (req.has_param("token")) {
  22944. received_token = req.get_param_value("token");
  22945. }
  22946. }
  22947. std::string msg;
  22948. while (ws.read(msg)) {
  22949. ws.send(msg);
  22950. }
  22951. });
  22952. auto port = svr.bind_to_any_port("localhost");
  22953. std::thread t([&]() { svr.listen_after_bind(); });
  22954. svr.wait_until_ready();
  22955. ws::WebSocketClient client("ws://localhost:" + std::to_string(port) +
  22956. "/ws?token=ABC&session=123");
  22957. ASSERT_TRUE(client.connect());
  22958. // Round-trip ensures the handler has run and captured the request.
  22959. ASSERT_TRUE(client.send("hello"));
  22960. std::string msg;
  22961. ASSERT_TRUE(client.read(msg));
  22962. EXPECT_EQ("hello", msg);
  22963. client.close();
  22964. {
  22965. std::lock_guard<std::mutex> lock(mtx);
  22966. EXPECT_EQ("/ws?token=ABC&session=123", received_target);
  22967. EXPECT_EQ("ABC", received_token);
  22968. }
  22969. svr.stop();
  22970. t.join();
  22971. }
  22972. // Run a handshake against a throwaway server and hand the request the server
  22973. // received back to the caller, so tests can assert on the headers the client
  22974. // actually put on the wire.
  22975. static void capture_websocket_handshake_request(
  22976. const Headers &client_headers,
  22977. std::function<void(const Request &, int port)> verify) {
  22978. Server svr;
  22979. std::mutex mtx;
  22980. Request received;
  22981. svr.WebSocket("/ws", [&](const Request &req, ws::WebSocket &ws) {
  22982. {
  22983. std::lock_guard<std::mutex> lock(mtx);
  22984. received = req;
  22985. }
  22986. std::string msg;
  22987. while (ws.read(msg)) {
  22988. ws.send(msg);
  22989. }
  22990. });
  22991. auto port = svr.bind_to_any_port("localhost");
  22992. std::thread t([&]() { svr.listen_after_bind(); });
  22993. auto se = detail::scope_exit([&] {
  22994. svr.stop();
  22995. t.join();
  22996. });
  22997. svr.wait_until_ready();
  22998. ws::WebSocketClient client("ws://localhost:" + std::to_string(port) + "/ws",
  22999. client_headers);
  23000. ASSERT_TRUE(client.connect());
  23001. ASSERT_TRUE(client.send("hello"));
  23002. std::string msg;
  23003. ASSERT_TRUE(client.read(msg));
  23004. client.close();
  23005. {
  23006. std::lock_guard<std::mutex> lock(mtx);
  23007. verify(received, port);
  23008. }
  23009. }
  23010. TEST(WebSocketTest, DefaultHeadersInHandshake) {
  23011. capture_websocket_handshake_request({}, [](const Request &req, int port) {
  23012. // Non-default port must be present in the Host header. Default ports
  23013. // (80/443) are omitted; that logic is covered by
  23014. // MakeHostAndPortStringTest.
  23015. EXPECT_EQ("localhost:" + std::to_string(port),
  23016. req.get_header_value("Host"));
  23017. EXPECT_EQ(std::string("cpp-httplib/") + CPPHTTPLIB_VERSION,
  23018. req.get_header_value("User-Agent"));
  23019. EXPECT_FALSE(req.has_header("Accept"));
  23020. EXPECT_FALSE(req.has_header("Accept-Encoding"));
  23021. EXPECT_FALSE(req.has_header("Content-Length"));
  23022. });
  23023. }
  23024. TEST(WebSocketTest, UserHeadersOverrideGeneratedOnesInHandshake) {
  23025. capture_websocket_handshake_request(
  23026. {{"Host", "example.com"},
  23027. {"User-Agent", "custom-agent"},
  23028. {"X-Custom", "value"}},
  23029. [](const Request &req, int) {
  23030. EXPECT_EQ("example.com", req.get_header_value("Host"));
  23031. EXPECT_EQ(1U, req.get_header_value_count("Host"));
  23032. EXPECT_EQ("custom-agent", req.get_header_value("User-Agent"));
  23033. EXPECT_EQ(1U, req.get_header_value_count("User-Agent"));
  23034. EXPECT_EQ("value", req.get_header_value("X-Custom"));
  23035. });
  23036. }
  23037. TEST(WebSocketTest, MandatoryHeadersInHandshakeAreEnforced) {
  23038. capture_websocket_handshake_request(
  23039. {{"Upgrade", "bogus"},
  23040. {"Connection", "close"},
  23041. {"Sec-WebSocket-Key", "AAAAAAAAAAAAAAAAAAAAAA=="},
  23042. {"Sec-WebSocket-Version", "8"}},
  23043. [](const Request &req, int) {
  23044. EXPECT_EQ("websocket", req.get_header_value("Upgrade"));
  23045. EXPECT_EQ(1U, req.get_header_value_count("Upgrade"));
  23046. EXPECT_EQ("Upgrade", req.get_header_value("Connection"));
  23047. EXPECT_EQ(1U, req.get_header_value_count("Connection"));
  23048. EXPECT_EQ("13", req.get_header_value("Sec-WebSocket-Version"));
  23049. EXPECT_EQ(1U, req.get_header_value_count("Sec-WebSocket-Version"));
  23050. EXPECT_EQ(1U, req.get_header_value_count("Sec-WebSocket-Key"));
  23051. EXPECT_NE("AAAAAAAAAAAAAAAAAAAAAA==",
  23052. req.get_header_value("Sec-WebSocket-Key"));
  23053. });
  23054. }
  23055. TEST(WebSocketTest, InvalidHeaderInHandshakeWritesNothing) {
  23056. // A header the client refuses to send must abort the handshake before any
  23057. // part of it reaches the wire; a lone request line would otherwise sit in
  23058. // the peer's buffer as a truncated request.
  23059. auto srv = ::socket(AF_INET, SOCK_STREAM, 0);
  23060. ASSERT_NE(INVALID_SOCKET, srv);
  23061. auto se_srv = detail::scope_exit([&] { detail::close_socket(srv); });
  23062. sockaddr_in addr{};
  23063. addr.sin_family = AF_INET;
  23064. addr.sin_port = 0; // ephemeral, so parallel shards don't collide
  23065. ::inet_pton(AF_INET, "127.0.0.1", &addr.sin_addr);
  23066. ASSERT_EQ(0, ::bind(srv, reinterpret_cast<sockaddr *>(&addr), sizeof(addr)));
  23067. ASSERT_EQ(0, ::listen(srv, 1));
  23068. sockaddr_in bound{};
  23069. socklen_t bound_len = sizeof(bound);
  23070. ASSERT_EQ(
  23071. 0, ::getsockname(srv, reinterpret_cast<sockaddr *>(&bound), &bound_len));
  23072. auto port = ntohs(bound.sin_port);
  23073. ssize_t received = -1;
  23074. std::thread t([&] {
  23075. // Bound every blocking call so a regression fails the test with a bad
  23076. // value instead of hanging the suite.
  23077. fd_set rfds;
  23078. FD_ZERO(&rfds);
  23079. FD_SET(srv, &rfds);
  23080. timeval tv{5, 0};
  23081. if (::select(static_cast<int>(srv + 1), &rfds, nullptr, nullptr, &tv) <=
  23082. 0) {
  23083. return;
  23084. }
  23085. sockaddr_in cli_addr{};
  23086. socklen_t cli_len = sizeof(cli_addr);
  23087. auto cli = ::accept(srv, reinterpret_cast<sockaddr *>(&cli_addr), &cli_len);
  23088. if (cli == INVALID_SOCKET) { return; }
  23089. auto se_cli = detail::scope_exit([&] { detail::close_socket(cli); });
  23090. detail::set_socket_opt_time(cli, SOL_SOCKET, SO_RCVTIMEO, 5, 0);
  23091. char buf[4096];
  23092. received = ::recv(cli, buf, sizeof(buf), 0);
  23093. });
  23094. // The CR/LF makes the value invalid, so check_and_write_headers rejects it.
  23095. // connect() has already shut the socket down by the time it returns false,
  23096. // so the peer sees EOF without waiting for the client to be destroyed.
  23097. ws::WebSocketClient client("ws://127.0.0.1:" + std::to_string(port) + "/ws",
  23098. {{"X-Bad", "a\r\nInjected: 1"}});
  23099. EXPECT_FALSE(client.connect());
  23100. t.join();
  23101. // 0 means the peer saw a clean EOF without a single byte of the handshake.
  23102. EXPECT_EQ(0, received);
  23103. }
  23104. TEST(WebSocketTest, ConnectionHeaderNeedsCompleteUpgradeToken) {
  23105. // RFC 6455 4.2.1: Connection is a token list, so a value that merely
  23106. // contains "upgrade" as a substring is a different token and must not
  23107. // start a WebSocket handshake.
  23108. auto make_request = [](const std::vector<std::string> &connection_values) {
  23109. Request req;
  23110. req.method = "GET";
  23111. req.headers.emplace("Upgrade", "websocket");
  23112. for (const auto &value : connection_values) {
  23113. req.headers.emplace("Connection", value);
  23114. }
  23115. req.headers.emplace("Sec-WebSocket-Key", "dGhlIHNhbXBsZSBub25jZQ==");
  23116. req.headers.emplace("Sec-WebSocket-Version", "13");
  23117. return req;
  23118. };
  23119. EXPECT_TRUE(detail::is_websocket_upgrade(make_request({"Upgrade"})));
  23120. EXPECT_TRUE(detail::is_websocket_upgrade(make_request({"upgrade"})));
  23121. EXPECT_TRUE(
  23122. detail::is_websocket_upgrade(make_request({"keep-alive, Upgrade"})));
  23123. EXPECT_TRUE(
  23124. detail::is_websocket_upgrade(make_request({"Upgrade , keep-alive"})));
  23125. EXPECT_TRUE(
  23126. detail::is_websocket_upgrade(make_request({"keep-alive", "Upgrade"})));
  23127. EXPECT_FALSE(detail::is_websocket_upgrade(make_request({"notupgrade"})));
  23128. EXPECT_FALSE(detail::is_websocket_upgrade(make_request({"upgrade-not"})));
  23129. EXPECT_FALSE(detail::is_websocket_upgrade(make_request({"xupgrade"})));
  23130. EXPECT_FALSE(
  23131. detail::is_websocket_upgrade(make_request({"keep-alive, notupgrade"})));
  23132. EXPECT_FALSE(detail::is_websocket_upgrade(make_request({"close"})));
  23133. EXPECT_FALSE(detail::is_websocket_upgrade(make_request({})));
  23134. }
  23135. TEST(WebSocketTest, UpgradeHeaderNeedsCompleteWebsocketToken) {
  23136. // RFC 9110 7.8 defines Upgrade as a comma-separated list of protocols and
  23137. // asks recipients to match each protocol-name case-insensitively, and RFC
  23138. // 6455 4.2.1 asks for a header field containing the value "websocket". A
  23139. // client naming websocket alongside another protocol, or on a second field
  23140. // line, is offering websocket; a value that merely contains "websocket" as a
  23141. // substring is a different protocol name and is not.
  23142. auto make_request = [](const std::vector<std::string> &upgrade_values) {
  23143. Request req;
  23144. req.method = "GET";
  23145. for (const auto &value : upgrade_values) {
  23146. req.headers.emplace("Upgrade", value);
  23147. }
  23148. req.headers.emplace("Connection", "Upgrade");
  23149. req.headers.emplace("Sec-WebSocket-Key", "dGhlIHNhbXBsZSBub25jZQ==");
  23150. req.headers.emplace("Sec-WebSocket-Version", "13");
  23151. return req;
  23152. };
  23153. EXPECT_TRUE(detail::is_websocket_upgrade(make_request({"websocket"})));
  23154. EXPECT_TRUE(detail::is_websocket_upgrade(make_request({"WebSocket"})));
  23155. EXPECT_TRUE(
  23156. detail::is_websocket_upgrade(make_request({"websocket, HTTP/3.0"})));
  23157. EXPECT_TRUE(
  23158. detail::is_websocket_upgrade(make_request({"HTTP/3.0 , websocket"})));
  23159. EXPECT_TRUE(
  23160. detail::is_websocket_upgrade(make_request({"HTTP/3.0", "websocket"})));
  23161. EXPECT_FALSE(detail::is_websocket_upgrade(make_request({"notwebsocket"})));
  23162. EXPECT_FALSE(detail::is_websocket_upgrade(make_request({"websocket-2"})));
  23163. EXPECT_FALSE(detail::is_websocket_upgrade(make_request({"xwebsocket"})));
  23164. EXPECT_FALSE(
  23165. detail::is_websocket_upgrade(make_request({"HTTP/3.0, notwebsocket"})));
  23166. EXPECT_FALSE(detail::is_websocket_upgrade(make_request({"h2c"})));
  23167. EXPECT_FALSE(detail::is_websocket_upgrade(make_request({})));
  23168. }
  23169. TEST(WebSocketTest, ServerRejectsHandshakeWithoutUpgradeToken) {
  23170. Server svr;
  23171. svr.WebSocket("/ws", [](const Request &, ws::WebSocket &) {});
  23172. auto port = svr.bind_to_any_port("localhost");
  23173. std::thread t([&]() { svr.listen_after_bind(); });
  23174. auto se = detail::scope_exit([&] {
  23175. svr.stop();
  23176. t.join();
  23177. });
  23178. svr.wait_until_ready();
  23179. Headers headers = {{"Upgrade", "websocket"},
  23180. {"Connection", "notupgrade"},
  23181. {"Sec-WebSocket-Key", "dGhlIHNhbXBsZSBub25jZQ=="},
  23182. {"Sec-WebSocket-Version", "13"}};
  23183. Client cli("localhost", port);
  23184. auto res = cli.Get("/ws", headers);
  23185. // The route exists only as a WebSocket route, so a request that fails the
  23186. // handshake check falls through to ordinary routing.
  23187. ASSERT_TRUE(res);
  23188. EXPECT_EQ(StatusCode::NotFound_404, res->status);
  23189. }
  23190. TEST(WebSocketTest, ClientRejectsResponseWithoutUpgradeToken) {
  23191. // The peer answers 101 with a correct Sec-WebSocket-Accept, so the
  23192. // Connection value is the only thing left for the client to reject.
  23193. Server svr;
  23194. svr.Get("/ws", [](const Request &req, Response &res) {
  23195. res.status = StatusCode::SwitchingProtocol_101;
  23196. res.set_header("Upgrade", "websocket");
  23197. res.set_header("Connection", "notupgrade");
  23198. res.set_header("Sec-WebSocket-Accept",
  23199. detail::websocket_accept_key(
  23200. req.get_header_value("Sec-WebSocket-Key")));
  23201. });
  23202. auto port = svr.bind_to_any_port("localhost");
  23203. std::thread t([&]() { svr.listen_after_bind(); });
  23204. auto se = detail::scope_exit([&] {
  23205. svr.stop();
  23206. t.join();
  23207. });
  23208. svr.wait_until_ready();
  23209. ws::WebSocketClient client("ws://localhost:" + std::to_string(port) + "/ws");
  23210. auto res = client.connect();
  23211. EXPECT_FALSE(res);
  23212. EXPECT_EQ(Error::WebSocketHandshake, res.error());
  23213. EXPECT_FALSE(client.is_open());
  23214. }
  23215. TEST(WebSocketTest, ClientRejectsUnofferedSubprotocol) {
  23216. Server svr;
  23217. svr.Get("/ws", [](const Request &req, Response &res) {
  23218. res.status = StatusCode::SwitchingProtocol_101;
  23219. res.set_header("Upgrade", "websocket");
  23220. res.set_header("Connection", "Upgrade");
  23221. res.set_header("Sec-WebSocket-Accept",
  23222. detail::websocket_accept_key(
  23223. req.get_header_value("Sec-WebSocket-Key")));
  23224. res.set_header("Sec-WebSocket-Protocol", "admin");
  23225. });
  23226. auto port = svr.bind_to_any_port("localhost");
  23227. std::thread t([&]() { svr.listen_after_bind(); });
  23228. auto se = detail::scope_exit([&] {
  23229. svr.stop();
  23230. t.join();
  23231. });
  23232. svr.wait_until_ready();
  23233. const auto url = "ws://localhost:" + std::to_string(port) + "/ws";
  23234. // Server selects a subprotocol the client never offered
  23235. {
  23236. Headers headers = {{"Sec-WebSocket-Protocol", "chat"}};
  23237. ws::WebSocketClient client(url, headers);
  23238. auto res = client.connect();
  23239. EXPECT_FALSE(res);
  23240. EXPECT_EQ(Error::WebSocketHandshake, res.error());
  23241. EXPECT_FALSE(client.is_open());
  23242. EXPECT_TRUE(client.subprotocol().empty());
  23243. }
  23244. // Client offered none but the server named one anyway
  23245. {
  23246. ws::WebSocketClient client(url);
  23247. auto res = client.connect();
  23248. EXPECT_FALSE(res);
  23249. EXPECT_EQ(Error::WebSocketHandshake, res.error());
  23250. EXPECT_FALSE(client.is_open());
  23251. EXPECT_TRUE(client.subprotocol().empty());
  23252. }
  23253. }
  23254. TEST(WebSocketTest, HostHeaderOverUnixSocket) {
  23255. // The socket path doubles as the URL host, so it must not contain '/'.
  23256. const char *shard = getenv("GTEST_SHARD_INDEX");
  23257. const std::string sock_path =
  23258. shard ? std::string("httplib-ws-") + shard + ".sock"
  23259. : std::string("httplib-ws.sock");
  23260. std::remove(sock_path.c_str());
  23261. Server svr;
  23262. std::mutex mtx;
  23263. std::string received_host;
  23264. svr.WebSocket("/ws", [&](const Request &req, ws::WebSocket &ws) {
  23265. {
  23266. std::lock_guard<std::mutex> lock(mtx);
  23267. received_host = req.get_header_value("Host");
  23268. }
  23269. std::string msg;
  23270. while (ws.read(msg)) {
  23271. ws.send(msg);
  23272. }
  23273. });
  23274. svr.set_address_family(AF_UNIX);
  23275. std::thread t([&]() { ASSERT_TRUE(svr.listen(sock_path, 80)); });
  23276. auto se = detail::scope_exit([&] {
  23277. svr.stop();
  23278. t.join();
  23279. std::remove(sock_path.c_str());
  23280. });
  23281. svr.wait_until_ready();
  23282. ws::WebSocketClient client("ws://" + sock_path + "/ws");
  23283. client.set_address_family(AF_UNIX);
  23284. ASSERT_TRUE(client.connect());
  23285. ASSERT_TRUE(client.send("hello"));
  23286. std::string msg;
  23287. ASSERT_TRUE(client.read(msg));
  23288. client.close();
  23289. {
  23290. std::lock_guard<std::mutex> lock(mtx);
  23291. // There is no host:port for a Unix socket, so the same "localhost"
  23292. // placeholder the HTTP client uses is expected.
  23293. EXPECT_EQ("localhost", received_host);
  23294. }
  23295. }
  23296. // Two threads must never parse WebSocket frames from the same stream.
  23297. // close() used to read the peer's Close reply with its own frame read, so it
  23298. // raced a reader thread that was in the middle of a payload: the payload loop
  23299. // in read_websocket_frame() keeps reading until payload_len bytes are in hand,
  23300. // so bytes taken by close() were replaced with bytes from further along the
  23301. // stream. The message kept its length and silently changed content.
  23302. //
  23303. // The raw peer below sends a frame header plus part of the payload, waits for
  23304. // the handler to call close(), and only then sends the rest. Whichever thread
  23305. // would win the race for those bytes, the message must arrive intact, because
  23306. // close() must not touch the stream while read() owns it.
  23307. TEST(WebSocketTest, CloseDoesNotStealBytesFromConcurrentRead) {
  23308. #ifndef _WIN32
  23309. signal(SIGPIPE, SIG_IGN);
  23310. #endif
  23311. const size_t payload_len = 120; // fits the 7-bit length field
  23312. const size_t prefix_len = 8;
  23313. const int attempts = 8;
  23314. std::string expected(payload_len, '\0');
  23315. for (size_t i = 0; i < payload_len; i++) {
  23316. expected[i] = static_cast<char>('a' + i % 26);
  23317. }
  23318. std::atomic<bool> peer_stalled{false};
  23319. std::atomic<bool> handler_done{false};
  23320. std::mutex received_mutex;
  23321. std::vector<std::string> received;
  23322. // Bound every wait, so a regression fails the test instead of hanging the
  23323. // suite.
  23324. auto wait_for = [](const std::atomic<bool> &flag) {
  23325. for (int i = 0; i < 500 && !flag; i++) {
  23326. std::this_thread::sleep_for(std::chrono::milliseconds(10));
  23327. }
  23328. };
  23329. Server svr;
  23330. svr.set_websocket_ping_interval(0);
  23331. svr.WebSocket("/ws", [&](const Request &, ws::WebSocket &ws) {
  23332. std::thread reader([&]() {
  23333. std::string msg;
  23334. while (ws.read(msg)) {
  23335. std::lock_guard<std::mutex> guard(received_mutex);
  23336. received.push_back(msg);
  23337. }
  23338. });
  23339. // Wait until the peer stalls mid-payload, so the reader thread is parked
  23340. // inside read_websocket_frame() when close() runs.
  23341. wait_for(peer_stalled);
  23342. ws.close();
  23343. reader.join();
  23344. handler_done = true;
  23345. });
  23346. auto port = svr.bind_to_any_port("127.0.0.1");
  23347. std::thread t([&]() { svr.listen_after_bind(); });
  23348. auto se = detail::scope_exit([&] {
  23349. svr.stop();
  23350. t.join();
  23351. });
  23352. svr.wait_until_ready();
  23353. auto send_bytes = [](socket_t s, const std::string &data) {
  23354. #ifdef _WIN32
  23355. auto n = ::send(s, data.data(), static_cast<int>(data.size()), 0);
  23356. #else
  23357. auto n = ::send(s, data.data(), data.size(), 0);
  23358. #endif
  23359. return n == static_cast<decltype(n)>(data.size());
  23360. };
  23361. // Frame header with an all-zero mask key, so the payload goes out verbatim.
  23362. // Every length used here fits the 7-bit length field.
  23363. auto masked_header = [](uint8_t first_byte, size_t len) {
  23364. std::string h;
  23365. h += static_cast<char>(first_byte);
  23366. h += static_cast<char>(0x80 | len); // masked, 7-bit length
  23367. h.append(4, '\0'); // mask key
  23368. return h;
  23369. };
  23370. for (int attempt = 0; attempt < attempts; attempt++) {
  23371. peer_stalled = false;
  23372. handler_done = false;
  23373. auto sock = ::socket(AF_INET, SOCK_STREAM, 0);
  23374. ASSERT_NE(INVALID_SOCKET, sock) << "attempt " << attempt;
  23375. auto se_sock = detail::scope_exit([&] {
  23376. if (sock != INVALID_SOCKET) { detail::close_socket(sock); }
  23377. });
  23378. detail::set_socket_opt_time(sock, SOL_SOCKET, SO_RCVTIMEO, 5, 0);
  23379. detail::set_socket_opt_time(sock, SOL_SOCKET, SO_SNDTIMEO, 5, 0);
  23380. sockaddr_in addr{};
  23381. addr.sin_family = AF_INET;
  23382. addr.sin_port = htons(static_cast<uint16_t>(port));
  23383. ::inet_pton(AF_INET, "127.0.0.1", &addr.sin_addr);
  23384. ASSERT_EQ(
  23385. 0, ::connect(sock, reinterpret_cast<sockaddr *>(&addr), sizeof(addr)))
  23386. << "attempt " << attempt;
  23387. ASSERT_TRUE(send_bytes(sock,
  23388. "GET /ws HTTP/1.1\r\n"
  23389. "Host: 127.0.0.1\r\n"
  23390. "Upgrade: websocket\r\n"
  23391. "Connection: Upgrade\r\n"
  23392. "Sec-WebSocket-Key: AAAAAAAAAAAAAAAAAAAAAA==\r\n"
  23393. "Sec-WebSocket-Version: 13\r\n"
  23394. "\r\n"))
  23395. << "attempt " << attempt;
  23396. std::string response;
  23397. while (response.find("\r\n\r\n") == std::string::npos) {
  23398. char buf[512];
  23399. auto n = ::recv(sock, buf, static_cast<int>(sizeof(buf)), 0);
  23400. if (n <= 0) { break; }
  23401. response.append(buf, static_cast<size_t>(n));
  23402. }
  23403. ASSERT_NE(std::string::npos, response.find(" 101 "))
  23404. << "attempt " << attempt;
  23405. // Send the header of a Binary message but only the first prefix_len bytes
  23406. // of its payload, leaving the reader thread stalled inside the payload.
  23407. ASSERT_TRUE(send_bytes(sock, masked_header(0x82, payload_len) +
  23408. expected.substr(0, prefix_len)))
  23409. << "attempt " << attempt;
  23410. std::this_thread::sleep_for(std::chrono::milliseconds(50));
  23411. peer_stalled = true;
  23412. // Let close() send its Close frame and park in its own read before the
  23413. // rest of the payload arrives, so both threads are waiting for it.
  23414. std::this_thread::sleep_for(std::chrono::milliseconds(50));
  23415. std::string close_frame = masked_header(0x88, 2); // FIN + Close
  23416. close_frame += static_cast<char>(0x03); // status 1000
  23417. close_frame += static_cast<char>(0xE8);
  23418. ASSERT_TRUE(send_bytes(sock, expected.substr(prefix_len) + close_frame))
  23419. << "attempt " << attempt;
  23420. // Closing the peer releases the reader thread even on the buggy path,
  23421. // where it waits for bytes another thread already consumed.
  23422. std::this_thread::sleep_for(std::chrono::milliseconds(50));
  23423. detail::close_socket(sock);
  23424. sock = INVALID_SOCKET;
  23425. wait_for(handler_done);
  23426. ASSERT_TRUE(handler_done) << "attempt " << attempt;
  23427. }
  23428. std::lock_guard<std::mutex> guard(received_mutex);
  23429. EXPECT_EQ(static_cast<size_t>(attempts), received.size())
  23430. << "a message in flight when close() ran was dropped";
  23431. for (size_t i = 0; i < received.size(); i++) {
  23432. EXPECT_EQ(expected, received[i]) << "message " << i;
  23433. }
  23434. }
  23435. // Connects to 127.0.0.1:port and completes a WebSocket handshake for path,
  23436. // returning the socket, or INVALID_SOCKET.
  23437. static socket_t connect_raw_websocket(int port, const std::string &path) {
  23438. auto sock = ::socket(AF_INET, SOCK_STREAM, 0);
  23439. if (sock == INVALID_SOCKET) { return sock; }
  23440. detail::set_socket_opt_time(sock, SOL_SOCKET, SO_RCVTIMEO, 5, 0);
  23441. sockaddr_in addr{};
  23442. addr.sin_family = AF_INET;
  23443. addr.sin_port = htons(static_cast<uint16_t>(port));
  23444. ::inet_pton(AF_INET, "127.0.0.1", &addr.sin_addr);
  23445. std::string req = "GET " + path +
  23446. " HTTP/1.1\r\n"
  23447. "Host: 127.0.0.1\r\n"
  23448. "Upgrade: websocket\r\n"
  23449. "Connection: Upgrade\r\n"
  23450. "Sec-WebSocket-Key: AAAAAAAAAAAAAAAAAAAAAA==\r\n"
  23451. "Sec-WebSocket-Version: 13\r\n"
  23452. "\r\n";
  23453. std::string res;
  23454. if (::connect(sock, reinterpret_cast<sockaddr *>(&addr), sizeof(addr)) == 0 &&
  23455. ::send(sock, req.data(), static_cast<int>(req.size()), 0) ==
  23456. static_cast<int>(req.size())) {
  23457. char c;
  23458. while (res.find("\r\n\r\n") == std::string::npos &&
  23459. ::recv(sock, &c, 1, 0) == 1) {
  23460. res += c;
  23461. }
  23462. }
  23463. if (res.find(" 101 ") == std::string::npos) {
  23464. detail::close_socket(sock);
  23465. return INVALID_SOCKET;
  23466. }
  23467. return sock;
  23468. }
  23469. // A client frame with an all-zero mask key, so the payload goes out verbatim.
  23470. // The payload must fit the 7-bit length field.
  23471. static std::string masked_frame(uint8_t first_byte,
  23472. const std::string &payload) {
  23473. std::string f;
  23474. f += static_cast<char>(first_byte);
  23475. f += static_cast<char>(0x80 | payload.size());
  23476. f.append(4, '\0');
  23477. return f + payload;
  23478. }
  23479. TEST(WebSocketTest, AssemblesFragmentsAroundAPing) {
  23480. std::atomic<bool> done{false};
  23481. std::string received;
  23482. Server svr;
  23483. svr.set_websocket_ping_interval(0);
  23484. svr.WebSocket("/ws", [&](const Request &, ws::WebSocket &ws) {
  23485. std::string msg;
  23486. if (ws.read(msg) == ws::Binary) { received = msg; }
  23487. done = true;
  23488. });
  23489. auto port = svr.bind_to_any_port("127.0.0.1");
  23490. std::thread t([&]() { svr.listen_after_bind(); });
  23491. auto se = detail::scope_exit([&] {
  23492. svr.stop();
  23493. t.join();
  23494. });
  23495. svr.wait_until_ready();
  23496. auto sock = connect_raw_websocket(port, "/ws");
  23497. ASSERT_NE(INVALID_SOCKET, sock);
  23498. auto se_sock = detail::scope_exit([&] { detail::close_socket(sock); });
  23499. auto frames = masked_frame(0x02, "Hel") + // Binary, more to come
  23500. masked_frame(0x89, "p") + // FIN + Ping
  23501. masked_frame(0x80, "lo"); // FIN + Continuation
  23502. ::send(sock, frames.data(), static_cast<int>(frames.size()), 0);
  23503. for (int i = 0; i < 500 && !done; i++) {
  23504. std::this_thread::sleep_for(std::chrono::milliseconds(10));
  23505. }
  23506. ASSERT_TRUE(done);
  23507. EXPECT_EQ("Hello", received);
  23508. // The Ping between the fragments is answered with a Pong.
  23509. char pong[3];
  23510. ASSERT_EQ(3, ::recv(sock, pong, sizeof(pong), MSG_WAITALL));
  23511. EXPECT_EQ(std::string("\x8a\x01p", 3), std::string(pong, 3));
  23512. }
  23513. TEST(WebSocketTest, NegativePingIntervalSendsNoPings) {
  23514. Server svr;
  23515. svr.set_websocket_ping_interval(-1);
  23516. svr.WebSocket("/ws", [&](const Request &, ws::WebSocket &ws) {
  23517. std::string msg;
  23518. while (ws.read(msg)) {}
  23519. });
  23520. auto port = svr.bind_to_any_port("127.0.0.1");
  23521. std::thread t([&]() { svr.listen_after_bind(); });
  23522. auto se = detail::scope_exit([&] {
  23523. svr.stop();
  23524. t.join();
  23525. });
  23526. svr.wait_until_ready();
  23527. auto sock = connect_raw_websocket(port, "/ws");
  23528. ASSERT_NE(INVALID_SOCKET, sock);
  23529. auto se_sock = detail::scope_exit([&] { detail::close_socket(sock); });
  23530. // Nothing comes while the client stays quiet.
  23531. detail::set_socket_opt_time(sock, SOL_SOCKET, SO_RCVTIMEO, 0, 300000);
  23532. char c;
  23533. EXPECT_EQ(-1, ::recv(sock, &c, 1, 0));
  23534. }
  23535. TEST(WebSocketTest, AnswersAMalformedCloseWithProtocolError) {
  23536. Server svr;
  23537. svr.set_websocket_ping_interval(0);
  23538. svr.WebSocket("/ws", [&](const Request &, ws::WebSocket &ws) {
  23539. std::string msg;
  23540. while (ws.read(msg)) {}
  23541. });
  23542. auto port = svr.bind_to_any_port("127.0.0.1");
  23543. std::thread t([&]() { svr.listen_after_bind(); });
  23544. auto se = detail::scope_exit([&] {
  23545. svr.stop();
  23546. t.join();
  23547. });
  23548. svr.wait_until_ready();
  23549. // Each Close payload and the reply it should get: an echo when valid, 1002
  23550. // otherwise.
  23551. std::vector<std::pair<std::string, std::string>> cases = {
  23552. {std::string("\x03\xe8") + "bye", std::string("\x03\xe8") + "bye"},
  23553. {std::string("\x03"), std::string("\x03\xea")}, // 1 byte
  23554. {std::string("\x03\xed"), std::string("\x03\xea")}, // 1005
  23555. {std::string("\x03\xe8\xff"), std::string("\x03\xea")}, // bad UTF-8
  23556. };
  23557. // Also between the fragments of a message.
  23558. for (const auto &prefix : {std::string(), masked_frame(0x02, "a")}) {
  23559. for (const auto &c : cases) {
  23560. auto sock = connect_raw_websocket(port, "/ws");
  23561. ASSERT_NE(INVALID_SOCKET, sock);
  23562. auto frames = prefix + masked_frame(0x88, c.first);
  23563. ::send(sock, frames.data(), static_cast<int>(frames.size()), 0);
  23564. std::string reply;
  23565. char buf[256];
  23566. while (reply.size() < 2 + c.second.size()) {
  23567. auto n = ::recv(sock, buf, sizeof(buf), 0);
  23568. if (n <= 0) { break; }
  23569. reply.append(buf, static_cast<size_t>(n));
  23570. }
  23571. detail::close_socket(sock);
  23572. EXPECT_EQ(std::string("\x88") + static_cast<char>(c.second.size()) +
  23573. c.second,
  23574. reply);
  23575. }
  23576. }
  23577. }
  23578. #ifdef CPPHTTPLIB_OPENSSL_SUPPORT
  23579. class WebSocketSSLIntegrationTest : public ::testing::Test {
  23580. protected:
  23581. void SetUp() override {
  23582. server_ = httplib::detail::make_unique<SSLServer>(SERVER_CERT_FILE,
  23583. SERVER_PRIVATE_KEY_FILE);
  23584. server_->WebSocket("/ws-echo", [](const Request &, ws::WebSocket &ws) {
  23585. std::string msg;
  23586. ws::ReadResult ret;
  23587. while ((ret = ws.read(msg))) {
  23588. if (ret == ws::Binary) {
  23589. ws.send(msg.data(), msg.size());
  23590. } else {
  23591. ws.send(msg);
  23592. }
  23593. }
  23594. });
  23595. port_ = server_->bind_to_any_port(HOST);
  23596. server_thread_ = std::thread([this]() { server_->listen_after_bind(); });
  23597. server_->wait_until_ready();
  23598. }
  23599. void TearDown() override {
  23600. server_->stop();
  23601. if (server_thread_.joinable()) { server_thread_.join(); }
  23602. }
  23603. std::unique_ptr<SSLServer> server_;
  23604. std::thread server_thread_;
  23605. int port_ = 0;
  23606. };
  23607. TEST_F(WebSocketSSLIntegrationTest, VerifiersDecide) {
  23608. auto url = "wss://localhost:" + std::to_string(port_) + "/ws-echo";
  23609. {
  23610. ws::WebSocketClient client(url);
  23611. client.enable_server_certificate_verification(false);
  23612. auto calls = 0;
  23613. client.set_server_certificate_verifier([&](const tls::VerifyContext &) {
  23614. calls++;
  23615. return false;
  23616. });
  23617. EXPECT_FALSE(client.connect());
  23618. EXPECT_GT(calls, 0);
  23619. }
  23620. {
  23621. ws::WebSocketClient client(url);
  23622. client.enable_server_certificate_verification(false);
  23623. client.set_session_verifier([](tls::session_t) {
  23624. return SSLVerifierResponse::CertificateRejected;
  23625. });
  23626. EXPECT_FALSE(client.connect());
  23627. }
  23628. {
  23629. ws::WebSocketClient client(url);
  23630. client.enable_server_certificate_verification(false);
  23631. client.set_session_verifier([](tls::session_t) {
  23632. return SSLVerifierResponse::CertificateAccepted;
  23633. });
  23634. EXPECT_TRUE(client.connect());
  23635. }
  23636. }
  23637. TEST_F(WebSocketSSLIntegrationTest, TextEcho) {
  23638. ws::WebSocketClient client("wss://localhost:" + std::to_string(port_) +
  23639. "/ws-echo");
  23640. client.enable_server_certificate_verification(false);
  23641. ASSERT_TRUE(client.connect());
  23642. ASSERT_TRUE(client.is_open());
  23643. ASSERT_TRUE(client.send("Hello WSS"));
  23644. std::string msg;
  23645. EXPECT_EQ(ws::Text, client.read(msg));
  23646. EXPECT_EQ("Hello WSS", msg);
  23647. client.close();
  23648. }
  23649. // Regression test (GHSA-w7p7-f35j-mw7q): shutdown_and_close() used to free the
  23650. // TLS session before ws_->close() sent the close frame. Because the WebSocket's
  23651. // SSLSocketStream keeps a raw pointer to that session, sending the close frame
  23652. // then read/wrote a freed SSL object (use-after-free). Destroying an open wss
  23653. // client (without calling close() first) is the only path that runs
  23654. // shutdown_and_close() while the WebSocket is still open, so it reproduces the
  23655. // bug exactly.
  23656. //
  23657. // NOTE: the offending read/write happens inside OpenSSL, so ASan only flags it
  23658. // when linked against an instrumented libssl; run under Valgrind to catch it
  23659. // with a stock OpenSSL. The short timeouts keep a regression from wedging the
  23660. // suite (the freed session otherwise stalls on the close handshake) — this test
  23661. // is a memory-tool tripwire, not a pass/fail assertion on stock builds.
  23662. TEST_F(WebSocketSSLIntegrationTest, DestroyWhileOpenSendsCloseOverLiveSession) {
  23663. {
  23664. ws::WebSocketClient client("wss://localhost:" + std::to_string(port_) +
  23665. "/ws-echo");
  23666. client.enable_server_certificate_verification(false);
  23667. client.set_read_timeout(2, 0);
  23668. client.set_write_timeout(2, 0);
  23669. ASSERT_TRUE(client.connect());
  23670. ASSERT_TRUE(client.is_open());
  23671. ASSERT_TRUE(client.send("still open"));
  23672. // Intentionally do NOT call client.close(): leaving scope runs
  23673. // shutdown_and_close() with the WebSocket still open, which must send the
  23674. // close frame while the TLS session is still alive.
  23675. }
  23676. }
  23677. // Regression test (GHSA-w7p7-f35j-mw7q): reconnecting an open wss client runs
  23678. // shutdown_and_close() at the start of connect(), reproducing the same
  23679. // use-after-free within the test body rather than at scope exit. The second
  23680. // connect must succeed and echo, proving the close handshake ran over a live
  23681. // session. See the note above about memory-tool requirements.
  23682. TEST_F(WebSocketSSLIntegrationTest,
  23683. ReconnectWhileOpenSendsCloseOverLiveSession) {
  23684. ws::WebSocketClient client("wss://localhost:" + std::to_string(port_) +
  23685. "/ws-echo");
  23686. client.enable_server_certificate_verification(false);
  23687. client.set_read_timeout(2, 0);
  23688. client.set_write_timeout(2, 0);
  23689. ASSERT_TRUE(client.connect());
  23690. ASSERT_TRUE(client.is_open());
  23691. ASSERT_TRUE(client.send("still open"));
  23692. // Reconnect without closing first: connect() calls shutdown_and_close() on
  23693. // the still-open connection, which must not touch a freed TLS session.
  23694. ASSERT_TRUE(client.connect());
  23695. ASSERT_TRUE(client.is_open());
  23696. ASSERT_TRUE(client.send("after reconnect"));
  23697. std::string msg;
  23698. EXPECT_EQ(ws::Text, client.read(msg));
  23699. EXPECT_EQ("after reconnect", msg);
  23700. client.close();
  23701. }
  23702. #endif
  23703. #ifdef CPPHTTPLIB_SSL_ENABLED
  23704. class WebSocketSSLCATest : public ::testing::Test {
  23705. protected:
  23706. void SetUp() override {
  23707. server_ = httplib::detail::make_unique<SSLServer>(SERVER_CERT2_FILE,
  23708. SERVER_PRIVATE_KEY_FILE);
  23709. server_->WebSocket("/echo", [](const Request &, ws::WebSocket &ws) {
  23710. std::string msg;
  23711. while (ws.read(msg)) {
  23712. ws.send(msg);
  23713. }
  23714. });
  23715. port_ = server_->bind_to_any_port("127.0.0.1");
  23716. server_thread_ = std::thread([this]() { server_->listen_after_bind(); });
  23717. server_->wait_until_ready();
  23718. }
  23719. void TearDown() override {
  23720. server_->stop();
  23721. if (server_thread_.joinable()) { server_thread_.join(); }
  23722. }
  23723. std::string url() const {
  23724. return "wss://127.0.0.1:" + std::to_string(port_) + "/echo";
  23725. }
  23726. std::unique_ptr<SSLServer> server_;
  23727. std::thread server_thread_;
  23728. int port_ = 0;
  23729. };
  23730. // A custom CA loaded as PEM verifies the server with full certificate
  23731. // verification enabled
  23732. TEST_F(WebSocketSSLCATest, LoadCaCertStoreVerifiesServer) {
  23733. ws::WebSocketClient client(url());
  23734. std::string cert;
  23735. read_file(SERVER_CERT2_FILE, cert);
  23736. client.load_ca_cert_store(cert.c_str(), cert.size());
  23737. ASSERT_TRUE(client.connect());
  23738. ASSERT_TRUE(client.send("hello"));
  23739. std::string msg;
  23740. EXPECT_EQ(ws::Text, client.read(msg));
  23741. EXPECT_EQ("hello", msg);
  23742. client.close();
  23743. }
  23744. // A custom CA that does not cover the server must fail verification (the
  23745. // custom CA is exclusive; system certs are not loaded alongside it)
  23746. TEST_F(WebSocketSSLCATest, WrongCustomCaFailsVerification) {
  23747. ws::WebSocketClient client(url());
  23748. std::string cert;
  23749. read_file(CLIENT_CA_CERT_FILE, cert);
  23750. client.load_ca_cert_store(cert.c_str(), cert.size());
  23751. auto res = client.connect();
  23752. ASSERT_FALSE(res);
  23753. EXPECT_EQ(Error::SSLServerVerification, res.error());
  23754. EXPECT_EQ(-1, res.status());
  23755. EXPECT_NE(0u, res.ssl_backend_error());
  23756. }
  23757. // The same CA as a file path rather than PEM in memory
  23758. TEST_F(WebSocketSSLCATest, SetCaCertPathVerifiesServer) {
  23759. ws::WebSocketClient client(url());
  23760. client.set_ca_cert_path(SERVER_CERT2_FILE);
  23761. ASSERT_TRUE(client.connect());
  23762. ASSERT_TRUE(client.send("hello"));
  23763. std::string msg;
  23764. EXPECT_EQ(ws::Text, client.read(msg));
  23765. EXPECT_EQ("hello", msg);
  23766. client.close();
  23767. }
  23768. // ...and a CA file that does not cover the server still fails, so it is the
  23769. // path above that decides the outcome
  23770. TEST_F(WebSocketSSLCATest, WrongCaCertPathFailsVerification) {
  23771. ws::WebSocketClient client(url());
  23772. client.set_ca_cert_path(CLIENT_CA_CERT_FILE);
  23773. ASSERT_FALSE(client.connect());
  23774. }
  23775. // Regression test: reconnecting with a native custom CA store used to reuse
  23776. // a store handle the previous TLS context had already freed (use-after-free
  23777. // under the OpenSSL backend). The context now lives as long as the client.
  23778. TEST_F(WebSocketSSLCATest, ReconnectWithCustomCaStore) {
  23779. ws::WebSocketClient client(url());
  23780. std::string cert;
  23781. read_file(SERVER_CERT2_FILE, cert);
  23782. client.set_ca_cert_store(tls::create_ca_store(cert.c_str(), cert.size()));
  23783. ASSERT_TRUE(client.connect());
  23784. client.close();
  23785. ASSERT_TRUE(client.connect());
  23786. ASSERT_TRUE(client.send("again"));
  23787. std::string msg;
  23788. EXPECT_EQ(ws::Text, client.read(msg));
  23789. EXPECT_EQ("again", msg);
  23790. client.close();
  23791. }
  23792. // Regression test: a certificate with a trusted chain but no identity match
  23793. // for the server IP must be rejected. The Mbed TLS backend used to skip
  23794. // verification entirely for IP hosts, so this connection succeeded there.
  23795. // SERVER_CERT_FILE has no IP SAN (CN only), so trusting it as a CA satisfies
  23796. // chain verification while the identity check must still fail.
  23797. TEST(WebSocketSSLVerifyTest, TrustedChainWrongIdentityFails) {
  23798. SSLServer svr(SERVER_CERT_FILE, SERVER_PRIVATE_KEY_FILE);
  23799. ASSERT_TRUE(svr.is_valid());
  23800. svr.WebSocket("/echo", [](const Request &, ws::WebSocket &ws) {
  23801. std::string msg;
  23802. while (ws.read(msg)) {
  23803. ws.send(msg);
  23804. }
  23805. });
  23806. auto port = svr.bind_to_any_port("127.0.0.1");
  23807. auto t = std::thread([&]() { svr.listen_after_bind(); });
  23808. auto se = detail::scope_exit([&] {
  23809. svr.stop();
  23810. t.join();
  23811. });
  23812. svr.wait_until_ready();
  23813. ws::WebSocketClient client("wss://127.0.0.1:" + std::to_string(port) +
  23814. "/echo");
  23815. std::string cert;
  23816. read_file(SERVER_CERT_FILE, cert);
  23817. client.load_ca_cert_store(cert.c_str(), cert.size());
  23818. ASSERT_FALSE(client.connect());
  23819. }
  23820. // The tests above all connect to an IP literal, for which RFC 6066 forbids
  23821. // SNI, so nothing binds the host name to the TLS session. These bind the
  23822. // server to "localhost" instead, the only shape that exercises the SNI and
  23823. // hostname-verification path with certificate verification left enabled.
  23824. class WebSocketSSLDnsHostTest : public ::testing::Test {
  23825. protected:
  23826. void Start(const char *cert_file) {
  23827. server_ = httplib::detail::make_unique<SSLServer>(cert_file,
  23828. SERVER_PRIVATE_KEY_FILE);
  23829. ASSERT_TRUE(server_->is_valid());
  23830. server_->WebSocket("/echo", [](const Request &, ws::WebSocket &ws) {
  23831. std::string msg;
  23832. while (ws.read(msg)) {
  23833. ws.send(msg);
  23834. }
  23835. });
  23836. port_ = server_->bind_to_any_port("localhost");
  23837. server_thread_ = std::thread([this]() { server_->listen_after_bind(); });
  23838. server_->wait_until_ready();
  23839. }
  23840. void TearDown() override {
  23841. if (server_) { server_->stop(); }
  23842. if (server_thread_.joinable()) { server_thread_.join(); }
  23843. }
  23844. std::string url() const {
  23845. return "wss://localhost:" + std::to_string(port_) + "/echo";
  23846. }
  23847. std::unique_ptr<SSLServer> server_;
  23848. std::thread server_thread_;
  23849. int port_ = 0;
  23850. };
  23851. // cert2 carries a DNS:localhost SAN, so both the chain and the identity check
  23852. // out and the connection is usable
  23853. TEST_F(WebSocketSSLDnsHostTest, TrustedChainMatchingNameVerifies) {
  23854. Start(SERVER_CERT2_FILE);
  23855. ws::WebSocketClient client(url());
  23856. client.set_ca_cert_path(SERVER_CERT2_FILE);
  23857. ASSERT_TRUE(client.connect());
  23858. ASSERT_TRUE(client.send("hello"));
  23859. std::string msg;
  23860. EXPECT_EQ(ws::Text, client.read(msg));
  23861. EXPECT_EQ("hello", msg);
  23862. client.close();
  23863. }
  23864. // cert.pem has a CN but no SAN, so trusting it as a CA satisfies the chain
  23865. // while the identity check must still reject "localhost"
  23866. TEST_F(WebSocketSSLDnsHostTest, TrustedChainWrongNameFails) {
  23867. Start(SERVER_CERT_FILE);
  23868. ws::WebSocketClient client(url());
  23869. client.set_ca_cert_path(SERVER_CERT_FILE);
  23870. auto res = client.connect();
  23871. ASSERT_FALSE(res);
  23872. EXPECT_EQ(Error::SSLServerHostnameVerification, res.error());
  23873. EXPECT_EQ(-1, res.status());
  23874. }
  23875. // Same setup as TrustedChainWrongNameFails, but with hostname verification
  23876. // disabled: the chain is still checked, only the identity check is skipped
  23877. TEST_F(WebSocketSSLDnsHostTest, HostnameVerificationDisabledAcceptsWrongName) {
  23878. Start(SERVER_CERT_FILE);
  23879. ws::WebSocketClient client(url());
  23880. client.set_ca_cert_path(SERVER_CERT_FILE);
  23881. client.enable_server_hostname_verification(false);
  23882. ASSERT_TRUE(client.connect());
  23883. ASSERT_TRUE(client.send("hello"));
  23884. std::string msg;
  23885. EXPECT_EQ(ws::Text, client.read(msg));
  23886. EXPECT_EQ("hello", msg);
  23887. client.close();
  23888. }
  23889. // A CA that did not sign the server certificate fails the chain, even though
  23890. // the name would match
  23891. TEST_F(WebSocketSSLDnsHostTest, UntrustedChainFails) {
  23892. Start(SERVER_CERT2_FILE);
  23893. ws::WebSocketClient client(url());
  23894. client.set_ca_cert_path(CLIENT_CA_CERT_FILE);
  23895. ASSERT_FALSE(client.connect());
  23896. }
  23897. // With verification disabled, neither the chain nor the name is checked
  23898. TEST_F(WebSocketSSLDnsHostTest, VerificationDisabledAcceptsAnyName) {
  23899. Start(SERVER_CERT_FILE);
  23900. ws::WebSocketClient client(url());
  23901. client.enable_server_certificate_verification(false);
  23902. ASSERT_TRUE(client.connect());
  23903. ASSERT_TRUE(client.send("hello"));
  23904. std::string msg;
  23905. EXPECT_EQ(ws::Text, client.read(msg));
  23906. EXPECT_EQ("hello", msg);
  23907. client.close();
  23908. }
  23909. class WebSocketSSLPemMemoryTest : public ::testing::Test {
  23910. protected:
  23911. void SetUp() override {
  23912. server_ = httplib::detail::make_unique<SSLServer>(
  23913. SERVER_CERT_FILE, SERVER_PRIVATE_KEY_FILE, CLIENT_CA_CERT_FILE);
  23914. ASSERT_TRUE(server_->is_valid());
  23915. server_->WebSocket("/ws-echo", [](const Request &, ws::WebSocket &ws) {
  23916. std::string msg;
  23917. while (ws.read(msg)) {
  23918. ws.send(msg);
  23919. }
  23920. });
  23921. port_ = server_->bind_to_any_port("localhost");
  23922. server_thread_ = std::thread([this]() { server_->listen_after_bind(); });
  23923. server_->wait_until_ready();
  23924. }
  23925. void TearDown() override {
  23926. server_->stop();
  23927. if (server_thread_.joinable()) { server_thread_.join(); }
  23928. }
  23929. std::string url() const {
  23930. return "wss://localhost:" + std::to_string(port_) + "/ws-echo";
  23931. }
  23932. void ConnectWithClientCert(const std::string &client_cert_file,
  23933. const std::string &client_private_key_file,
  23934. const char *private_key_password) {
  23935. std::string cert_pem, key_pem;
  23936. read_file(client_cert_file, cert_pem);
  23937. read_file(client_private_key_file, key_pem);
  23938. ws::WebSocketClient::PemMemory pem = {cert_pem.c_str(), cert_pem.size(),
  23939. key_pem.c_str(), key_pem.size(),
  23940. private_key_password};
  23941. ws::WebSocketClient client(url(), pem);
  23942. ASSERT_TRUE(client.is_valid());
  23943. client.enable_server_certificate_verification(false);
  23944. ASSERT_TRUE(client.connect());
  23945. ASSERT_TRUE(client.send("hello"));
  23946. std::string msg;
  23947. EXPECT_EQ(ws::Text, client.read(msg));
  23948. EXPECT_EQ("hello", msg);
  23949. client.close();
  23950. }
  23951. std::unique_ptr<SSLServer> server_;
  23952. std::thread server_thread_;
  23953. int port_ = 0;
  23954. };
  23955. TEST_F(WebSocketSSLPemMemoryTest, ClientCertAccepted) {
  23956. ConnectWithClientCert(CLIENT_CERT_FILE, CLIENT_PRIVATE_KEY_FILE, nullptr);
  23957. }
  23958. // Control for the tests above: the fixture's server really does require a
  23959. // client certificate, so it is the PEM the constructor installed that decides
  23960. // the outcome.
  23961. TEST_F(WebSocketSSLPemMemoryTest, NoClientCertRejected) {
  23962. ws::WebSocketClient client(url());
  23963. ASSERT_TRUE(client.is_valid());
  23964. client.enable_server_certificate_verification(false);
  23965. EXPECT_FALSE(client.connect());
  23966. }
  23967. TEST_F(WebSocketSSLPemMemoryTest, EncryptedClientCertAccepted) {
  23968. ConnectWithClientCert(CLIENT_ENCRYPTED_CERT_FILE,
  23969. CLIENT_ENCRYPTED_PRIVATE_KEY_FILE,
  23970. CLIENT_ENCRYPTED_PRIVATE_KEY_PASS);
  23971. }
  23972. #endif
  23973. #if !defined(_WIN32)
  23974. TEST(SymlinkTest, SymlinkEscapeFromBaseDirectory) {
  23975. auto secret_dir = std::string("./symlink_test_secret");
  23976. auto served_dir = std::string("./symlink_test_served");
  23977. auto secret_file = secret_dir + "/secret.txt";
  23978. auto symlink_path = served_dir + "/escape";
  23979. // Setup: create directories and files
  23980. mkdir(secret_dir.c_str(), 0755);
  23981. mkdir(served_dir.c_str(), 0755);
  23982. {
  23983. std::ofstream ofs(secret_file);
  23984. ofs << "SECRET_DATA";
  23985. }
  23986. // Create symlink using absolute path so it resolves correctly
  23987. #ifdef PATH_MAX
  23988. char abs_secret[PATH_MAX];
  23989. ASSERT_NE(nullptr, realpath(secret_dir.c_str(), abs_secret));
  23990. #else
  23991. auto abs_secret = realpath(secret_dir.c_str(), nullptr);
  23992. auto abs_secret_guard = detail::scope_exit([&]() { std::free(abs_secret); });
  23993. ASSERT_NE(nullptr, abs_secret);
  23994. #endif
  23995. ASSERT_EQ(0, symlink(abs_secret, symlink_path.c_str()));
  23996. auto se = detail::scope_exit([&] {
  23997. unlink(symlink_path.c_str());
  23998. unlink(secret_file.c_str());
  23999. rmdir(served_dir.c_str());
  24000. rmdir(secret_dir.c_str());
  24001. });
  24002. Server svr;
  24003. svr.set_mount_point("/", served_dir);
  24004. auto listen_thread = std::thread([&svr]() { svr.listen("localhost", PORT); });
  24005. auto se2 = detail::scope_exit([&] {
  24006. svr.stop();
  24007. listen_thread.join();
  24008. });
  24009. svr.wait_until_ready();
  24010. Client cli("localhost", PORT);
  24011. // Symlink pointing outside base dir should be blocked
  24012. auto res = cli.Get("/escape/secret.txt");
  24013. ASSERT_TRUE(res) << "Error: " << to_string(res.error());
  24014. EXPECT_EQ(StatusCode::Forbidden_403, res->status);
  24015. }
  24016. #endif
  24017. // Sends `outer_head` (with every "{len}" replaced by the length of an embedded
  24018. // "GET /smuggled" request), reads the first response, and only then sends the
  24019. // embedded request as the body. Returns how many times /smuggled ran.
  24020. //
  24021. // The body is sent AFTER receiving the first response (as in the original
  24022. // PoC) so that the stream_line_reader cannot buffer it together with the
  24023. // headers of the first request.
  24024. static int count_smuggled_requests(const std::string &outer_head,
  24025. std::string &first_response) {
  24026. Server svr;
  24027. svr.set_mount_point("/", "./www");
  24028. std::atomic<int> smuggled_count(0);
  24029. svr.Get("/smuggled", [&](const Request &, Response &res) {
  24030. smuggled_count++;
  24031. res.set_content("oops", "text/plain");
  24032. });
  24033. svr.Post("/post", [&](const Request &req, Response &res) {
  24034. res.set_content(req.body, "text/plain");
  24035. });
  24036. auto port = svr.bind_to_any_port("localhost");
  24037. thread t = thread([&] { svr.listen_after_bind(); });
  24038. auto se = detail::scope_exit([&] {
  24039. svr.stop();
  24040. t.join();
  24041. });
  24042. svr.wait_until_ready();
  24043. auto error = Error::Success;
  24044. auto sock = detail::create_client_socket(
  24045. "localhost", "", port, AF_UNSPEC, false, false, nullptr,
  24046. /*connection_timeout_sec=*/2, 0,
  24047. /*read_timeout_sec=*/2, 0,
  24048. /*write_timeout_sec=*/2, 0, std::string(), error);
  24049. EXPECT_NE(INVALID_SOCKET, sock);
  24050. if (sock == INVALID_SOCKET) { return -1; }
  24051. auto sock_se = detail::scope_exit([&] { detail::close_socket(sock); });
  24052. // The "smuggled" request will be sent as the body of the outer request
  24053. std::string smuggled = "GET /smuggled HTTP/1.1\r\n"
  24054. "Host: localhost\r\n"
  24055. "Connection: close\r\n"
  24056. "\r\n";
  24057. auto head = outer_head;
  24058. auto len = std::to_string(smuggled.size());
  24059. for (auto pos = head.find("{len}"); pos != std::string::npos;
  24060. pos = head.find("{len}", pos + len.size())) {
  24061. head.replace(pos, 5, len);
  24062. }
  24063. // Step 1: Send only the outer request headers (no body yet)
  24064. auto sent = send(sock, head.data(), head.size(), 0);
  24065. EXPECT_EQ(static_cast<ssize_t>(head.size()), sent);
  24066. // Step 2: Read the first response
  24067. char buf[4096];
  24068. for (;;) {
  24069. auto n = recv(sock, buf, sizeof(buf), 0);
  24070. if (n <= 0) break;
  24071. first_response.append(buf, static_cast<size_t>(n));
  24072. // Stop once we have a complete response (headers + body)
  24073. auto hdr_end = first_response.find("\r\n\r\n");
  24074. if (hdr_end != std::string::npos) {
  24075. // Check for Content-Length to know when the body is complete
  24076. auto cl_pos = first_response.find("Content-Length:");
  24077. if (cl_pos != std::string::npos) {
  24078. auto cl_val_start = cl_pos + 15; // length of "Content-Length:"
  24079. auto cl_val_end = first_response.find("\r\n", cl_val_start);
  24080. auto cl = std::stoul(
  24081. first_response.substr(cl_val_start, cl_val_end - cl_val_start));
  24082. if (first_response.size() >= hdr_end + 4 + cl) { break; }
  24083. } else {
  24084. break; // No Content-Length, assume headers-only response
  24085. }
  24086. }
  24087. }
  24088. // Step 3: Now send the body, which looks like a new HTTP request. On a
  24089. // vulnerable server the keep-alive loop reads this as a second request. The
  24090. // server may already have closed the connection, so the result is ignored.
  24091. send(sock, smuggled.data(), smuggled.size(), 0);
  24092. // Half-close so that a server which drained the body sees EOF and closes,
  24093. // instead of the read below waiting for the read timeout.
  24094. #ifdef _WIN32
  24095. ::shutdown(sock, SD_SEND);
  24096. #else
  24097. ::shutdown(sock, SHUT_WR);
  24098. #endif
  24099. // Step 4: Read until the server closes the connection
  24100. for (;;) {
  24101. auto n = recv(sock, buf, sizeof(buf), 0);
  24102. if (n <= 0) break;
  24103. }
  24104. return smuggled_count.load();
  24105. }
  24106. TEST(RequestSmugglingTest, UnconsumedGETBodyOnFileHandler) {
  24107. // A GET request with Content-Length to a static file handler must have its
  24108. // body drained before the keep-alive connection is reused. Otherwise the
  24109. // unread body bytes are interpreted as the next HTTP request.
  24110. std::string first_response;
  24111. EXPECT_EQ(0, count_smuggled_requests("GET /file HTTP/1.1\r\n"
  24112. "Host: localhost\r\n"
  24113. "Content-Length: {len}\r\n"
  24114. "\r\n",
  24115. first_response));
  24116. EXPECT_EQ(0u, first_response.find("HTTP/1.1 200"));
  24117. }
  24118. TEST(RequestSmugglingTest, InvalidContentLengthRejected) {
  24119. // RFC 9112 §6.3: a Content-Length that is not a valid decimal length must
  24120. // be answered with 400 and the connection closed. Treating it as "no body"
  24121. // leaves the body to be parsed as the next request.
  24122. const char *values[] = {"{len}, {len}", "+{len}", "0x2e", "", " {len}x"};
  24123. const char *targets[] = {
  24124. "GET /file", // handler that never reads the body
  24125. "GET /not-found", // no handler matches (404)
  24126. "POST /post", // handler that reads the body
  24127. };
  24128. for (auto target : targets) {
  24129. for (auto value : values) {
  24130. std::string first_response;
  24131. EXPECT_EQ(0, count_smuggled_requests(std::string(target) +
  24132. " HTTP/1.1\r\n"
  24133. "Host: localhost\r\n"
  24134. "Content-Length: " +
  24135. value + "\r\n\r\n",
  24136. first_response))
  24137. << target << " with Content-Length: " << value;
  24138. EXPECT_EQ(0u, first_response.find("HTTP/1.1 400"))
  24139. << target << " with Content-Length: " << value;
  24140. }
  24141. }
  24142. }
  24143. TEST(RequestSmugglingTest, RejectedRequestLineClosesConnection) {
  24144. // A 400 for an unparseable request line leaves the rest of the message
  24145. // unread, so the connection must be closed rather than reused.
  24146. std::string first_response;
  24147. EXPECT_EQ(0, count_smuggled_requests("FOO /file HTTP/1.1\r\n"
  24148. "Host: localhost\r\n"
  24149. "Content-Length: {len}\r\n"
  24150. "\r\n",
  24151. first_response));
  24152. EXPECT_EQ(0u, first_response.find("HTTP/1.1 400"));
  24153. }
  24154. TEST(RequestSmugglingTest, RejectedHeadersCloseConnection) {
  24155. // Same as above for a header block that fails to parse.
  24156. std::string first_response;
  24157. EXPECT_EQ(0, count_smuggled_requests("GET /file HTTP/1.1\r\n"
  24158. "Host: localhost\r\n"
  24159. "Bad Header\r\n"
  24160. "Content-Length: {len}\r\n"
  24161. "\r\n",
  24162. first_response));
  24163. EXPECT_EQ(0u, first_response.find("HTTP/1.1 400"));
  24164. }
  24165. TEST(RequestSmugglingTest, ErrorResponseClosesConnection) {
  24166. // RFC 9112 §9.6: an error response carries "Connection: close", so the
  24167. // server must not read another request on that connection, even when the
  24168. // request had no body to drain.
  24169. std::string first_response;
  24170. EXPECT_EQ(0, count_smuggled_requests("GET /not-found HTTP/1.1\r\n"
  24171. "Host: localhost\r\n"
  24172. "\r\n",
  24173. first_response));
  24174. EXPECT_EQ(0u, first_response.find("HTTP/1.1 404"));
  24175. EXPECT_NE(std::string::npos, first_response.find("Connection: close"));
  24176. }
  24177. TEST(RequestSmugglingTest, AbortedContentReaderClosesConnection) {
  24178. // A content reader that stops early leaves the stream inside the body.
  24179. // Draining the whole Content-Length from there, or reading the body again,
  24180. // reads into the next request, and whatever follows is parsed as a request
  24181. // of its own.
  24182. Server svr;
  24183. std::atomic<int> smuggled_count(0);
  24184. svr.Get("/smuggled", [&](const Request &, Response &) { smuggled_count++; });
  24185. svr.Post("/upload", [](const Request &req, Response &res,
  24186. const ContentReader &content_reader) {
  24187. // Stop at the last chunk, so the whole body has been read however it
  24188. // arrives.
  24189. auto length = req.get_header_value_u64("Content-Length");
  24190. size_t total = 0;
  24191. auto consumed = content_reader([&](const char *, size_t n) {
  24192. total += n;
  24193. return total < length;
  24194. });
  24195. EXPECT_FALSE(consumed);
  24196. if (req.has_param("retry")) {
  24197. EXPECT_FALSE(content_reader([](const char *, size_t) { return true; }));
  24198. }
  24199. // Replace the 400 the aborted read set, which would close the connection.
  24200. res.set_redirect("/done");
  24201. });
  24202. auto port = svr.bind_to_any_port(HOST);
  24203. thread t = thread([&] { svr.listen_after_bind(); });
  24204. auto se = detail::scope_exit([&] {
  24205. svr.stop();
  24206. t.join();
  24207. });
  24208. svr.wait_until_ready();
  24209. // A front end sees the second request as a POST whose body is the GET. The
  24210. // first body is as long as the POST's headers, so draining it again reads
  24211. // exactly those and leaves the GET to be parsed next.
  24212. std::string inner = "GET /smuggled HTTP/1.1\r\n"
  24213. "Host: localhost\r\n"
  24214. "\r\n";
  24215. std::string second_head = "POST /post HTTP/1.1\r\n"
  24216. "Host: localhost\r\n"
  24217. "Content-Length: " +
  24218. std::to_string(inner.size()) +
  24219. "\r\n"
  24220. "\r\n";
  24221. for (auto target : {"/upload", "/upload?retry"}) {
  24222. smuggled_count = 0;
  24223. std::string request = "POST " + std::string(target) +
  24224. " HTTP/1.1\r\n"
  24225. "Host: localhost\r\n"
  24226. "Content-Length: " +
  24227. std::to_string(second_head.size()) +
  24228. "\r\n"
  24229. "\r\n" +
  24230. std::string(second_head.size(), 'A') + second_head +
  24231. inner;
  24232. std::string response;
  24233. ASSERT_TRUE(send_request(2, request, &response, port)) << target;
  24234. EXPECT_EQ(0u, response.find("HTTP/1.1 302")) << target;
  24235. EXPECT_NE(std::string::npos, response.find("Connection: close")) << target;
  24236. EXPECT_EQ(std::string::npos, response.find("HTTP/1.1", 1)) << target;
  24237. EXPECT_EQ(0, smuggled_count.load()) << target;
  24238. }
  24239. }
  24240. TEST(RequestSmugglingTest, ContentLengthAndTransferEncodingRejected) {
  24241. // RFC 9112 §6.3: A request with both Content-Length and Transfer-Encoding
  24242. // must be rejected with 400 Bad Request.
  24243. Server svr;
  24244. svr.Post("/test", [&](const Request &, Response &res) {
  24245. res.set_content("ok", "text/plain");
  24246. });
  24247. thread t = thread([&] { svr.listen(HOST, PORT); });
  24248. auto se = detail::scope_exit([&] {
  24249. svr.stop();
  24250. t.join();
  24251. ASSERT_FALSE(svr.is_running());
  24252. });
  24253. svr.wait_until_ready();
  24254. // Exact "chunked"
  24255. {
  24256. auto req = "POST /test HTTP/1.1\r\n"
  24257. "Host: localhost\r\n"
  24258. "Content-Length: 5\r\n"
  24259. "Transfer-Encoding: chunked\r\n"
  24260. "Connection: close\r\n"
  24261. "\r\n"
  24262. "hello";
  24263. std::string response;
  24264. ASSERT_TRUE(send_request(1, req, &response));
  24265. EXPECT_EQ("HTTP/1.1 400 Bad Request",
  24266. response.substr(0, response.find("\r\n")));
  24267. }
  24268. // Multi-valued Transfer-Encoding (e.g., "gzip, chunked")
  24269. {
  24270. auto req = "POST /test HTTP/1.1\r\n"
  24271. "Host: localhost\r\n"
  24272. "Content-Length: 5\r\n"
  24273. "Transfer-Encoding: gzip, chunked\r\n"
  24274. "Connection: close\r\n"
  24275. "\r\n"
  24276. "hello";
  24277. std::string response;
  24278. ASSERT_TRUE(send_request(1, req, &response));
  24279. EXPECT_EQ("HTTP/1.1 400 Bad Request",
  24280. response.substr(0, response.find("\r\n")));
  24281. }
  24282. }
  24283. TEST(RequestSmugglingTest, NonFinalChunkedTransferEncodingRejected) {
  24284. Server svr;
  24285. svr.Post("/test", [&](const Request &, Response &res) {
  24286. res.set_content("ok", "text/plain");
  24287. });
  24288. thread t = thread([&] { svr.listen(HOST, PORT); });
  24289. auto se = detail::scope_exit([&] {
  24290. svr.stop();
  24291. t.join();
  24292. ASSERT_FALSE(svr.is_running());
  24293. });
  24294. svr.wait_until_ready();
  24295. // RFC 9112 6.3: when chunked is not the final transfer coding the body
  24296. // length cannot be determined, so the server must answer 400 and close
  24297. // rather than treat the request as bodyless and leave the body in the
  24298. // socket for the next request to pick up.
  24299. for (const auto &transfer_encoding : {"gzip", "chunked, gzip"}) {
  24300. auto req = std::string("POST /test HTTP/1.1\r\n") + "Host: localhost\r\n" +
  24301. "Transfer-Encoding: " + transfer_encoding + "\r\n" + "\r\n";
  24302. std::string response;
  24303. ASSERT_TRUE(send_request(1, req, &response));
  24304. EXPECT_EQ("HTTP/1.1 400 Bad Request",
  24305. response.substr(0, response.find("\r\n")))
  24306. << transfer_encoding;
  24307. }
  24308. // RFC 9110 5.3: the codings may also be split across several
  24309. // Transfer-Encoding lines, which combine in the order they were received.
  24310. // "chunked" followed by "gzip" therefore ends in gzip and must be rejected
  24311. // just like the single-line "chunked, gzip" above.
  24312. {
  24313. auto req = "POST /test HTTP/1.1\r\n"
  24314. "Host: localhost\r\n"
  24315. "Transfer-Encoding: chunked\r\n"
  24316. "Transfer-Encoding: gzip\r\n"
  24317. "\r\n"
  24318. "0\r\n\r\n";
  24319. std::string response;
  24320. ASSERT_TRUE(send_request(1, req, &response));
  24321. EXPECT_EQ("HTTP/1.1 400 Bad Request",
  24322. response.substr(0, response.find("\r\n")));
  24323. }
  24324. // A sequence ending in chunked stays valid.
  24325. auto req = "POST /test HTTP/1.1\r\n"
  24326. "Host: localhost\r\n"
  24327. "Transfer-Encoding: gzip, chunked\r\n"
  24328. "Connection: close\r\n"
  24329. "\r\n"
  24330. "0\r\n\r\n";
  24331. std::string response;
  24332. ASSERT_TRUE(send_request(1, req, &response));
  24333. EXPECT_EQ("HTTP/1.1 200 OK", response.substr(0, response.find("\r\n")));
  24334. // ...including when it is spread over several lines.
  24335. auto split_req = "POST /test HTTP/1.1\r\n"
  24336. "Host: localhost\r\n"
  24337. "Transfer-Encoding: gzip\r\n"
  24338. "Transfer-Encoding: chunked\r\n"
  24339. "Connection: close\r\n"
  24340. "\r\n"
  24341. "0\r\n\r\n";
  24342. std::string split_response;
  24343. ASSERT_TRUE(send_request(1, split_req, &split_response));
  24344. EXPECT_EQ("HTTP/1.1 200 OK",
  24345. split_response.substr(0, split_response.find("\r\n")));
  24346. }
  24347. // Regression for issue #2450: a DELETE without Content-Length on a
  24348. // keep-alive connection must not let the post-response drain consume the
  24349. // next request's bytes.
  24350. TEST(KeepAliveTest, DeleteWithoutContentLengthDoesNotEatNextRequest) {
  24351. Server svr;
  24352. std::atomic<int> delete_count(0);
  24353. svr.Delete("/items/:id", [&](const Request &, Response &res) {
  24354. delete_count++;
  24355. res.status = StatusCode::NoContent_204;
  24356. });
  24357. auto port = svr.bind_to_any_port(HOST);
  24358. thread t = thread([&] { svr.listen_after_bind(); });
  24359. auto se = detail::scope_exit([&] {
  24360. svr.stop();
  24361. t.join();
  24362. });
  24363. svr.wait_until_ready();
  24364. auto error = Error::Success;
  24365. auto sock = detail::create_client_socket(
  24366. HOST, "", port, AF_UNSPEC, false, false, nullptr,
  24367. /*connection_timeout_sec=*/2, 0,
  24368. /*read_timeout_sec=*/2, 0,
  24369. /*write_timeout_sec=*/2, 0, std::string(), error);
  24370. ASSERT_NE(INVALID_SOCKET, sock);
  24371. auto sock_se = detail::scope_exit([&] { detail::close_socket(sock); });
  24372. auto send_request_and_read_response = [&](const std::string &req,
  24373. std::string &out) -> bool {
  24374. auto sent = send(sock, req.data(), req.size(), 0);
  24375. if (sent != static_cast<ssize_t>(req.size())) { return false; }
  24376. char buf[4096];
  24377. for (;;) {
  24378. auto n = recv(sock, buf, sizeof(buf), 0);
  24379. if (n <= 0) { return !out.empty(); }
  24380. out.append(buf, static_cast<size_t>(n));
  24381. if (out.find("\r\n\r\n") != std::string::npos) { return true; }
  24382. }
  24383. };
  24384. std::string req1 = "DELETE /items/1 HTTP/1.1\r\n"
  24385. "Host: localhost\r\n"
  24386. "\r\n";
  24387. std::string resp1;
  24388. ASSERT_TRUE(send_request_and_read_response(req1, resp1));
  24389. EXPECT_NE(std::string::npos, resp1.find("HTTP/1.1 204"));
  24390. std::string req2 = "DELETE /items/2 HTTP/1.1\r\n"
  24391. "Host: localhost\r\n"
  24392. "Connection: close\r\n"
  24393. "\r\n";
  24394. std::string resp2;
  24395. ASSERT_TRUE(send_request_and_read_response(req2, resp2));
  24396. EXPECT_NE(std::string::npos, resp2.find("HTTP/1.1 204"));
  24397. EXPECT_EQ(2, delete_count.load());
  24398. }
  24399. TEST(KeepAliveTest, UnconsumedChunkedBodyIsNotDrainedWhenResponseCloses) {
  24400. Server svr;
  24401. svr.Post("/ingest", [&](const Request &, Response &res,
  24402. const ContentReader &content_reader) {
  24403. auto consumed = content_reader([](const char *, size_t) { return false; });
  24404. EXPECT_FALSE(consumed);
  24405. res.status = StatusCode::Conflict_409;
  24406. res.set_header("Connection", "close");
  24407. });
  24408. auto port = svr.bind_to_any_port(HOST);
  24409. thread t = thread([&] { svr.listen_after_bind(); });
  24410. auto se = detail::scope_exit([&] {
  24411. svr.stop();
  24412. t.join();
  24413. });
  24414. svr.wait_until_ready();
  24415. auto error = Error::Success;
  24416. auto sock = detail::create_client_socket(
  24417. HOST, "", port, AF_UNSPEC, false, false, nullptr,
  24418. /*connection_timeout_sec=*/2, 0,
  24419. /*read_timeout_sec=*/1, 0,
  24420. /*write_timeout_sec=*/2, 0, std::string(), error);
  24421. ASSERT_NE(INVALID_SOCKET, sock);
  24422. auto sock_se = detail::scope_exit([&] { detail::close_socket(sock); });
  24423. std::string request = "POST /ingest HTTP/1.1\r\n"
  24424. "Host: localhost\r\n"
  24425. "Transfer-Encoding: chunked\r\n"
  24426. "\r\n"
  24427. "4\r\n"
  24428. "data\r\n";
  24429. auto sent = send(sock, request.data(), request.size(), 0);
  24430. ASSERT_EQ(static_cast<ssize_t>(request.size()), sent);
  24431. std::string response;
  24432. ssize_t received = 0;
  24433. do {
  24434. char buf[4096];
  24435. received = recv(sock, buf, sizeof(buf), 0);
  24436. if (received > 0) { response.append(buf, static_cast<size_t>(received)); }
  24437. } while (received > 0);
  24438. EXPECT_NE(std::string::npos, response.find("HTTP/1.1 409 Conflict"));
  24439. EXPECT_NE(std::string::npos, response.find("Connection: close"));
  24440. EXPECT_EQ(0, received);
  24441. }
  24442. namespace no_proxy_test {
  24443. // Server bound to 127.0.0.1:<dynamic>, listen thread spawned by listen(),
  24444. // auto-stopped + joined on scope exit. Register handlers via svr() BEFORE
  24445. // calling listen().
  24446. class ScopedServer {
  24447. public:
  24448. ScopedServer() { port_ = svr_.bind_to_any_port("127.0.0.1"); }
  24449. ~ScopedServer() {
  24450. svr_.stop();
  24451. if (th_.joinable()) { th_.join(); }
  24452. }
  24453. Server &svr() { return svr_; }
  24454. int port() const { return port_; }
  24455. void listen() {
  24456. th_ = std::thread([this] { svr_.listen_after_bind(); });
  24457. svr_.wait_until_ready();
  24458. }
  24459. private:
  24460. Server svr_;
  24461. std::thread th_;
  24462. int port_ = 0;
  24463. };
  24464. class ProxyAndTargetServers {
  24465. public:
  24466. ProxyAndTargetServers() {
  24467. proxy_mock_.Get(".*", [this](const Request &req, Response &res) {
  24468. proxy_hits_++;
  24469. last_had_proxy_authz_ = req.has_header("Proxy-Authorization");
  24470. res.set_content("via-proxy", "text/plain");
  24471. });
  24472. target_.Get(".*", [this](const Request &req, Response &res) {
  24473. target_hits_++;
  24474. last_had_proxy_authz_ = req.has_header("Proxy-Authorization");
  24475. res.set_content("direct", "text/plain");
  24476. });
  24477. proxy_port_ = proxy_mock_.bind_to_any_port("127.0.0.1");
  24478. target_port_ = target_.bind_to_any_port("127.0.0.1");
  24479. proxy_thread_ = std::thread([this] { proxy_mock_.listen_after_bind(); });
  24480. target_thread_ = std::thread([this] { target_.listen_after_bind(); });
  24481. proxy_mock_.wait_until_ready();
  24482. target_.wait_until_ready();
  24483. }
  24484. ~ProxyAndTargetServers() {
  24485. proxy_mock_.stop();
  24486. target_.stop();
  24487. if (proxy_thread_.joinable()) { proxy_thread_.join(); }
  24488. if (target_thread_.joinable()) { target_thread_.join(); }
  24489. }
  24490. Server &proxy_mock() { return proxy_mock_; }
  24491. Server &target() { return target_; }
  24492. int proxy_port() const { return proxy_port_; }
  24493. int target_port() const { return target_port_; }
  24494. int proxy_hits() const { return proxy_hits_.load(); }
  24495. int target_hits() const { return target_hits_.load(); }
  24496. bool last_had_proxy_authz() const { return last_had_proxy_authz_.load(); }
  24497. void reset_counters() {
  24498. proxy_hits_ = 0;
  24499. target_hits_ = 0;
  24500. last_had_proxy_authz_ = false;
  24501. }
  24502. private:
  24503. Server proxy_mock_;
  24504. Server target_;
  24505. std::thread proxy_thread_;
  24506. std::thread target_thread_;
  24507. int proxy_port_ = 0;
  24508. int target_port_ = 0;
  24509. std::atomic<int> proxy_hits_{0};
  24510. std::atomic<int> target_hits_{0};
  24511. std::atomic<bool> last_had_proxy_authz_{false};
  24512. };
  24513. inline std::unique_ptr<Client> make_client(const std::string &host,
  24514. ProxyAndTargetServers &s) {
  24515. auto cli = detail::make_unique<Client>(host, s.target_port());
  24516. cli->set_hostname_addr_map({{host, "127.0.0.1"}});
  24517. cli->set_proxy("127.0.0.1", s.proxy_port());
  24518. return cli;
  24519. }
  24520. } // namespace no_proxy_test
  24521. using no_proxy_test::make_client;
  24522. using no_proxy_test::ProxyAndTargetServers;
  24523. TEST(NoProxyTest, ExactHostnameBypasses) {
  24524. ProxyAndTargetServers s;
  24525. auto cli = make_client("example.com", s);
  24526. cli->set_no_proxy({"example.com"});
  24527. auto res = cli->Get("/");
  24528. ASSERT_TRUE(res) << "Error: " << to_string(res.error());
  24529. EXPECT_EQ(0, s.proxy_hits());
  24530. EXPECT_EQ(1, s.target_hits());
  24531. }
  24532. TEST(NoProxyTest, SubdomainBypasses) {
  24533. ProxyAndTargetServers s;
  24534. auto cli = make_client("foo.example.com", s);
  24535. cli->set_no_proxy({"example.com"});
  24536. auto res = cli->Get("/");
  24537. ASSERT_TRUE(res) << "Error: " << to_string(res.error());
  24538. EXPECT_EQ(0, s.proxy_hits());
  24539. EXPECT_EQ(1, s.target_hits());
  24540. }
  24541. TEST(NoProxyTest, EvilExampleDoesNotMatchExample) {
  24542. // Regression guard: "evilexample.com" must not be considered a subdomain
  24543. // of "example.com". Without the dot-boundary rule, a naive endsWith
  24544. // check would let traffic bypass the proxy and leak credentials direct
  24545. // to the attacker host.
  24546. ProxyAndTargetServers s;
  24547. auto cli = make_client("evilexample.com", s);
  24548. cli->set_no_proxy({"example.com"});
  24549. auto res = cli->Get("/");
  24550. ASSERT_TRUE(res) << "Error: " << to_string(res.error());
  24551. EXPECT_GE(s.proxy_hits(), 1);
  24552. EXPECT_EQ(0, s.target_hits());
  24553. }
  24554. TEST(NoProxyTest, ExampleDotEvilDoesNotMatchExample) {
  24555. ProxyAndTargetServers s;
  24556. auto cli = make_client("example.com.evil.com", s);
  24557. cli->set_no_proxy({"example.com"});
  24558. auto res = cli->Get("/");
  24559. ASSERT_TRUE(res) << "Error: " << to_string(res.error());
  24560. EXPECT_GE(s.proxy_hits(), 1);
  24561. EXPECT_EQ(0, s.target_hits());
  24562. }
  24563. TEST(NoProxyTest, LeadingDotPatternMatchesBareDomain) {
  24564. ProxyAndTargetServers s;
  24565. auto cli = make_client("example.com", s);
  24566. cli->set_no_proxy({".example.com"});
  24567. auto res = cli->Get("/");
  24568. ASSERT_TRUE(res) << "Error: " << to_string(res.error());
  24569. EXPECT_EQ(0, s.proxy_hits());
  24570. EXPECT_EQ(1, s.target_hits());
  24571. }
  24572. TEST(NoProxyTest, CaseInsensitiveHostname) {
  24573. ProxyAndTargetServers s;
  24574. auto cli = make_client("Example.COM", s);
  24575. cli->set_no_proxy({"EXAMPLE.com"});
  24576. auto res = cli->Get("/");
  24577. ASSERT_TRUE(res) << "Error: " << to_string(res.error());
  24578. EXPECT_EQ(0, s.proxy_hits());
  24579. EXPECT_EQ(1, s.target_hits());
  24580. }
  24581. TEST(NoProxyTest, TrailingDotIsNormalized) {
  24582. ProxyAndTargetServers s;
  24583. auto cli = make_client("example.com.", s);
  24584. cli->set_no_proxy({"example.com"});
  24585. auto res = cli->Get("/");
  24586. ASSERT_TRUE(res) << "Error: " << to_string(res.error());
  24587. EXPECT_EQ(0, s.proxy_hits());
  24588. EXPECT_EQ(1, s.target_hits());
  24589. }
  24590. TEST(NoProxyTest, TrailingDotOnEntryIsNormalized) {
  24591. // Trailing dots must be normalized on BOTH sides — host and entry.
  24592. // An implementation that only strips the host-side trailing dot would
  24593. // fail to match host "example.com" against entry "example.com." because
  24594. // a literal substring search would compare 11 chars against 12.
  24595. ProxyAndTargetServers s;
  24596. auto cli = make_client("example.com", s);
  24597. cli->set_no_proxy({"example.com."});
  24598. auto res = cli->Get("/");
  24599. ASSERT_TRUE(res) << "Error: " << to_string(res.error());
  24600. EXPECT_EQ(0, s.proxy_hits());
  24601. EXPECT_EQ(1, s.target_hits());
  24602. }
  24603. TEST(NoProxyTest, WildcardBypassesEverything) {
  24604. ProxyAndTargetServers s;
  24605. auto cli = make_client("anything.invalid.test", s);
  24606. cli->set_no_proxy({"*"});
  24607. auto res = cli->Get("/");
  24608. ASSERT_TRUE(res) << "Error: " << to_string(res.error());
  24609. EXPECT_EQ(0, s.proxy_hits());
  24610. EXPECT_EQ(1, s.target_hits());
  24611. }
  24612. TEST(NoProxyTest, IPv4LiteralExactMatch) {
  24613. ProxyAndTargetServers s;
  24614. Client cli("127.0.0.1", s.target_port());
  24615. cli.set_proxy("127.0.0.1", s.proxy_port());
  24616. cli.set_no_proxy({"127.0.0.1"});
  24617. auto res = cli.Get("/");
  24618. ASSERT_TRUE(res) << "Error: " << to_string(res.error());
  24619. EXPECT_EQ(0, s.proxy_hits());
  24620. EXPECT_EQ(1, s.target_hits());
  24621. }
  24622. TEST(NoProxyTest, IPv6LiteralExactMatchAcrossEquivalentForms) {
  24623. ProxyAndTargetServers s;
  24624. Client cli("0:0:0:0:0:0:0:1", s.target_port());
  24625. cli.set_hostname_addr_map({{"0:0:0:0:0:0:0:1", "127.0.0.1"}});
  24626. cli.set_proxy("127.0.0.1", s.proxy_port());
  24627. cli.set_no_proxy({"::1"});
  24628. auto res = cli.Get("/");
  24629. ASSERT_TRUE(res) << "Error: " << to_string(res.error());
  24630. EXPECT_EQ(0, s.proxy_hits());
  24631. EXPECT_EQ(1, s.target_hits());
  24632. }
  24633. TEST(NoProxyTest, BareIPv6LiteralMatchesIPv6Cidr) {
  24634. // Regression guard: a bare IPv6 host literal (no surrounding brackets)
  24635. // must still be recognized as IPv6 for CIDR matching. Implementations
  24636. // that detect IPv6 only when the host begins with '[' would parse the
  24637. // host as a hostname and miss the match.
  24638. ProxyAndTargetServers s;
  24639. Client cli("fe80::1", s.target_port());
  24640. cli.set_hostname_addr_map({{"fe80::1", "127.0.0.1"}});
  24641. cli.set_proxy("127.0.0.1", s.proxy_port());
  24642. cli.set_no_proxy({"fe80::/10"});
  24643. auto res = cli.Get("/");
  24644. ASSERT_TRUE(res) << "Error: " << to_string(res.error());
  24645. EXPECT_EQ(0, s.proxy_hits());
  24646. EXPECT_EQ(1, s.target_hits());
  24647. }
  24648. TEST(NoProxyTest, BracketedIPv6EntryAccepted) {
  24649. ProxyAndTargetServers s;
  24650. Client cli("::1", s.target_port());
  24651. cli.set_hostname_addr_map({{"::1", "127.0.0.1"}});
  24652. cli.set_proxy("127.0.0.1", s.proxy_port());
  24653. cli.set_no_proxy({"[::1]"});
  24654. auto res = cli.Get("/");
  24655. ASSERT_TRUE(res) << "Error: " << to_string(res.error());
  24656. EXPECT_EQ(0, s.proxy_hits());
  24657. EXPECT_EQ(1, s.target_hits());
  24658. }
  24659. TEST(NoProxyTest, BracketedIPv6CidrEntryAccepted) {
  24660. ProxyAndTargetServers s;
  24661. Client cli("fe80::1", s.target_port());
  24662. cli.set_hostname_addr_map({{"fe80::1", "127.0.0.1"}});
  24663. cli.set_proxy("127.0.0.1", s.proxy_port());
  24664. cli.set_no_proxy({"[fe80::]/10"});
  24665. auto res = cli.Get("/");
  24666. ASSERT_TRUE(res) << "Error: " << to_string(res.error());
  24667. EXPECT_EQ(0, s.proxy_hits());
  24668. EXPECT_EQ(1, s.target_hits());
  24669. }
  24670. TEST(NoProxyTest, IPv4MappedIPv6IsNotCrossMatchedAgainstIPv4Entry) {
  24671. // Policy: keep address families separate. "::ffff:1.2.3.4" must NOT
  24672. // satisfy a NO_PROXY entry of "1.2.3.4". This avoids subtle bypass
  24673. // tricks via address-family conversion.
  24674. ProxyAndTargetServers s;
  24675. Client cli("::ffff:127.0.0.1", s.target_port());
  24676. cli.set_hostname_addr_map({{"::ffff:127.0.0.1", "127.0.0.1"}});
  24677. cli.set_proxy("127.0.0.1", s.proxy_port());
  24678. cli.set_no_proxy({"127.0.0.1"});
  24679. auto res = cli.Get("/");
  24680. ASSERT_TRUE(res) << "Error: " << to_string(res.error());
  24681. EXPECT_GE(s.proxy_hits(), 1);
  24682. EXPECT_EQ(0, s.target_hits());
  24683. }
  24684. TEST(NoProxyTest, IPv4CidrMatch) {
  24685. ProxyAndTargetServers s;
  24686. Client cli("127.0.0.1", s.target_port());
  24687. cli.set_proxy("127.0.0.1", s.proxy_port());
  24688. cli.set_no_proxy({"127.0.0.0/8"});
  24689. auto res = cli.Get("/");
  24690. ASSERT_TRUE(res) << "Error: " << to_string(res.error());
  24691. EXPECT_EQ(0, s.proxy_hits());
  24692. EXPECT_EQ(1, s.target_hits());
  24693. }
  24694. TEST(NoProxyTest, IPv4CidrNonMatch) {
  24695. ProxyAndTargetServers s;
  24696. Client cli("127.0.0.1", s.target_port());
  24697. cli.set_proxy("127.0.0.1", s.proxy_port());
  24698. cli.set_no_proxy({"10.0.0.0/8"});
  24699. auto res = cli.Get("/");
  24700. ASSERT_TRUE(res) << "Error: " << to_string(res.error());
  24701. EXPECT_GE(s.proxy_hits(), 1);
  24702. EXPECT_EQ(0, s.target_hits());
  24703. }
  24704. TEST(NoProxyTest, IPv4CidrPrefixZeroMatchesAll) {
  24705. // Prefix 0 must not trigger the (1u << 32) shift UB. Result: every
  24706. // IPv4 target matches.
  24707. ProxyAndTargetServers s;
  24708. Client cli("127.0.0.1", s.target_port());
  24709. cli.set_proxy("127.0.0.1", s.proxy_port());
  24710. cli.set_no_proxy({"0.0.0.0/0"});
  24711. auto res = cli.Get("/");
  24712. ASSERT_TRUE(res) << "Error: " << to_string(res.error());
  24713. EXPECT_EQ(0, s.proxy_hits());
  24714. EXPECT_EQ(1, s.target_hits());
  24715. }
  24716. TEST(NoProxyTest, IPv4CidrSingleHostNoSlash) {
  24717. ProxyAndTargetServers s;
  24718. Client cli("127.0.0.1", s.target_port());
  24719. cli.set_proxy("127.0.0.1", s.proxy_port());
  24720. cli.set_no_proxy({"127.0.0.1"});
  24721. auto res = cli.Get("/");
  24722. ASSERT_TRUE(res) << "Error: " << to_string(res.error());
  24723. EXPECT_EQ(0, s.proxy_hits());
  24724. EXPECT_EQ(1, s.target_hits());
  24725. }
  24726. TEST(NoProxyTest, MalformedCidrPrefixIsDropped) {
  24727. ProxyAndTargetServers s;
  24728. Client cli("127.0.0.1", s.target_port());
  24729. cli.set_proxy("127.0.0.1", s.proxy_port());
  24730. cli.set_no_proxy({"127.0.0.0/33"});
  24731. auto res = cli.Get("/");
  24732. ASSERT_TRUE(res) << "Error: " << to_string(res.error());
  24733. EXPECT_GE(s.proxy_hits(), 1);
  24734. EXPECT_EQ(0, s.target_hits());
  24735. }
  24736. TEST(NoProxyTest, TrailingSlashCidrIsRejected) {
  24737. // Empty prefix after the slash must be rejected, not silently treated as /32.
  24738. ProxyAndTargetServers s;
  24739. Client cli("127.0.0.1", s.target_port());
  24740. cli.set_proxy("127.0.0.1", s.proxy_port());
  24741. cli.set_no_proxy({"127.0.0.1/"});
  24742. auto res = cli.Get("/");
  24743. ASSERT_TRUE(res) << "Error: " << to_string(res.error());
  24744. EXPECT_GE(s.proxy_hits(), 1);
  24745. EXPECT_EQ(0, s.target_hits());
  24746. }
  24747. TEST(NoProxyTest, ProxyAuthorizationSuppressedWhenBypassed) {
  24748. ProxyAndTargetServers s;
  24749. auto cli = make_client("internal.corp", s);
  24750. cli->set_proxy_basic_auth("u", "p");
  24751. cli->set_no_proxy({"internal.corp"});
  24752. auto res = cli->Get("/");
  24753. ASSERT_TRUE(res) << "Error: " << to_string(res.error());
  24754. EXPECT_EQ(1, s.target_hits());
  24755. EXPECT_EQ(0, s.proxy_hits());
  24756. EXPECT_FALSE(s.last_had_proxy_authz())
  24757. << "Proxy-Authorization must not be sent direct to the target";
  24758. }
  24759. TEST(NoProxyTest, ProxyAuthorizationSentWhenNotBypassed) {
  24760. ProxyAndTargetServers s;
  24761. auto cli = make_client("public.example", s);
  24762. cli->set_proxy_basic_auth("u", "p");
  24763. cli->set_no_proxy({"internal.corp"}); // does not match
  24764. auto res = cli->Get("/");
  24765. ASSERT_TRUE(res) << "Error: " << to_string(res.error());
  24766. EXPECT_GE(s.proxy_hits(), 1);
  24767. EXPECT_TRUE(s.last_had_proxy_authz());
  24768. }
  24769. TEST(NoProxyTest, ProxyAuthorizationSentWithOneEmptyCredential) {
  24770. std::atomic<int> hits{0};
  24771. std::atomic<int> hits_with_authz{0};
  24772. no_proxy_test::ScopedServer proxy_mock;
  24773. proxy_mock.svr().Get(".*", [&](const Request &req, Response &res) {
  24774. hits++;
  24775. if (req.has_header("Proxy-Authorization")) { hits_with_authz++; }
  24776. if (req.target.find("/redir") != std::string::npos) {
  24777. res.set_redirect("http://other.example/landed");
  24778. } else {
  24779. res.set_content("via-proxy", "text/plain");
  24780. }
  24781. });
  24782. proxy_mock.listen();
  24783. for (const auto &c : {std::make_pair("u", ""), std::make_pair("", "p")}) {
  24784. hits = 0;
  24785. hits_with_authz = 0;
  24786. Client cli("public.example", 80);
  24787. cli.set_proxy("127.0.0.1", proxy_mock.port());
  24788. cli.set_proxy_basic_auth(c.first, c.second);
  24789. cli.set_follow_location(true);
  24790. // The redirect to another host goes through the proxy as well
  24791. auto res = cli.Get("/redir");
  24792. ASSERT_TRUE(res) << "Error: " << to_string(res.error());
  24793. EXPECT_EQ(2, hits.load());
  24794. EXPECT_EQ(2, hits_with_authz.load());
  24795. }
  24796. }
  24797. TEST(NoProxyTest, EmptyNoProxyKeepsProxyOn) {
  24798. ProxyAndTargetServers s;
  24799. auto cli = make_client("anything.test", s);
  24800. auto res = cli->Get("/");
  24801. ASSERT_TRUE(res) << "Error: " << to_string(res.error());
  24802. EXPECT_GE(s.proxy_hits(), 1);
  24803. EXPECT_EQ(0, s.target_hits());
  24804. }
  24805. TEST(NoProxyTest, PortSpecificEntryRejected) {
  24806. ProxyAndTargetServers s;
  24807. auto cli = make_client("example.com", s);
  24808. cli->set_no_proxy({"example.com:8080"});
  24809. auto res = cli->Get("/");
  24810. ASSERT_TRUE(res) << "Error: " << to_string(res.error());
  24811. EXPECT_GE(s.proxy_hits(), 1);
  24812. EXPECT_EQ(0, s.target_hits());
  24813. }
  24814. TEST(NoProxyTest, EmptyAndWhitespaceEntriesDropped) {
  24815. ProxyAndTargetServers s;
  24816. auto cli = make_client("anything.test", s);
  24817. cli->set_no_proxy({"", " ", "\t"});
  24818. auto res = cli->Get("/");
  24819. ASSERT_TRUE(res) << "Error: " << to_string(res.error());
  24820. EXPECT_GE(s.proxy_hits(), 1);
  24821. EXPECT_EQ(0, s.target_hits());
  24822. }
  24823. TEST(NoProxyTest, ValidEntryWithSurroundingWhitespaceStillMatches) {
  24824. // An entry with leading/trailing whitespace must still match — env-style
  24825. // values are commonly pasted with stray spaces and an implementation
  24826. // that feeds the raw token directly to inet_pton would fail to match
  24827. // valid CIDRs because of the spaces.
  24828. ProxyAndTargetServers s;
  24829. Client cli("127.0.0.1", s.target_port());
  24830. cli.set_proxy("127.0.0.1", s.proxy_port());
  24831. cli.set_no_proxy({" 127.0.0.0/8 "});
  24832. auto res = cli.Get("/");
  24833. ASSERT_TRUE(res) << "Error: " << to_string(res.error());
  24834. EXPECT_EQ(0, s.proxy_hits());
  24835. EXPECT_EQ(1, s.target_hits());
  24836. }
  24837. TEST(NoProxyTest, RedirectToBypassedHostStripsProxyAndProxyAuth) {
  24838. // Analog of GHSA-6hrp-7fq9-3qv2: redirect to a NO_PROXY-matched host must
  24839. // go direct and must NOT carry Proxy-Authorization.
  24840. std::atomic<int> proxy_hits{0};
  24841. std::atomic<int> target_hits{0};
  24842. std::atomic<bool> target_saw_authz{false};
  24843. no_proxy_test::ScopedServer proxy_mock, target;
  24844. proxy_mock.svr().Get(".*", [&](const Request &, Response &res) {
  24845. proxy_hits++;
  24846. res.status = 302;
  24847. res.set_header("Location", "http://127.0.0.1:" +
  24848. std::to_string(target.port()) + "/landed");
  24849. });
  24850. target.svr().Get(".*", [&](const Request &req, Response &res) {
  24851. target_hits++;
  24852. if (req.has_header("Proxy-Authorization")) { target_saw_authz = true; }
  24853. res.set_content("direct", "text/plain");
  24854. });
  24855. proxy_mock.listen();
  24856. target.listen();
  24857. Client cli("public.example", target.port());
  24858. cli.set_hostname_addr_map({{"public.example", "127.0.0.1"}});
  24859. cli.set_proxy("127.0.0.1", proxy_mock.port());
  24860. cli.set_proxy_basic_auth("u", "p");
  24861. cli.set_no_proxy({"127.0.0.1"});
  24862. cli.set_follow_location(true);
  24863. auto res = cli.Get("/redir");
  24864. ASSERT_TRUE(res) << "Error: " << to_string(res.error());
  24865. EXPECT_GE(proxy_hits.load(), 1);
  24866. EXPECT_GE(target_hits.load(), 1);
  24867. EXPECT_FALSE(target_saw_authz.load());
  24868. }
  24869. #ifdef CPPHTTPLIB_SSL_ENABLED
  24870. TEST(NoProxyTest, BypassedTargetReturning407DoesNotLeakProxyDigestCredentials) {
  24871. // Direct origin replying 407 must not trigger the digest retry; otherwise
  24872. // proxy creds would be sent to the (possibly hostile) origin.
  24873. std::atomic<int> target_hits{0};
  24874. std::atomic<bool> target_saw_proxy_authz{false};
  24875. no_proxy_test::ScopedServer target;
  24876. target.svr().Get(".*", [&](const Request &req, Response &res) {
  24877. target_hits++;
  24878. if (req.has_header("Proxy-Authorization")) {
  24879. target_saw_proxy_authz = true;
  24880. }
  24881. res.status = StatusCode::ProxyAuthenticationRequired_407;
  24882. res.set_header("Proxy-Authenticate", "Digest realm=\"evil\", qop=\"auth\", "
  24883. "nonce=\"abc\", algorithm=MD5");
  24884. });
  24885. target.listen();
  24886. // The proxy address is set to the target's port: the bypass MUST kick in;
  24887. // if it doesn't, the test still routes "via proxy" to the same server and
  24888. // the Proxy-Authorization assertion below catches the leak.
  24889. Client cli("evil.example", target.port());
  24890. cli.set_hostname_addr_map({{"evil.example", "127.0.0.1"}});
  24891. cli.set_proxy("127.0.0.1", target.port());
  24892. cli.set_proxy_digest_auth("proxy-user", "proxy-pass");
  24893. cli.set_no_proxy({"evil.example"});
  24894. auto res = cli.Get("/x");
  24895. ASSERT_TRUE(res) << "Error: " << to_string(res.error());
  24896. EXPECT_EQ(StatusCode::ProxyAuthenticationRequired_407, res->status);
  24897. EXPECT_EQ(1, target_hits.load());
  24898. EXPECT_FALSE(target_saw_proxy_authz.load());
  24899. }
  24900. #endif
  24901. TEST(NoProxyTest, MultiHopRedirectThroughBypassedHostKeepsProxy) {
  24902. // A (via proxy) → B (NO_PROXY-matched, direct) → C must re-engage the proxy.
  24903. std::atomic<int> proxy_hits{0};
  24904. std::atomic<int> bypass_hits{0};
  24905. std::atomic<bool> proxy_saw_c_url{false};
  24906. no_proxy_test::ScopedServer proxy_mock, bypass_server;
  24907. proxy_mock.svr().Get(".*", [&](const Request &req, Response &res) {
  24908. proxy_hits++;
  24909. if (req.path.find("/start") != std::string::npos) {
  24910. res.status = 302;
  24911. res.set_header("Location", "http://127.0.0.1:" +
  24912. std::to_string(bypass_server.port()) +
  24913. "/middle");
  24914. return;
  24915. }
  24916. if (req.path.find("/end") != std::string::npos) {
  24917. proxy_saw_c_url = true;
  24918. res.set_content("c-via-proxy", "text/plain");
  24919. return;
  24920. }
  24921. res.set_content("unexpected", "text/plain");
  24922. });
  24923. // public.example's "advertised" port is arbitrary (the request never lands
  24924. // there — it goes through the proxy), but use a dynamic value to stay
  24925. // friendly with sharded parallel runs.
  24926. int public_port = bypass_server.port();
  24927. bypass_server.svr().Get(".*", [&](const Request &, Response &res) {
  24928. bypass_hits++;
  24929. res.status = 302;
  24930. res.set_header("Location", "http://public.example:" +
  24931. std::to_string(public_port) + "/end");
  24932. });
  24933. proxy_mock.listen();
  24934. bypass_server.listen();
  24935. Client cli("public.example", public_port);
  24936. cli.set_hostname_addr_map({{"public.example", "127.0.0.1"}});
  24937. cli.set_proxy("127.0.0.1", proxy_mock.port());
  24938. cli.set_no_proxy({"127.0.0.1"});
  24939. cli.set_follow_location(true);
  24940. auto res = cli.Get("/start");
  24941. ASSERT_TRUE(res) << "Error: " << to_string(res.error());
  24942. EXPECT_EQ(StatusCode::OK_200, res->status);
  24943. EXPECT_EQ("c-via-proxy", res->body);
  24944. EXPECT_GE(proxy_hits.load(), 2);
  24945. EXPECT_GE(bypass_hits.load(), 1);
  24946. EXPECT_TRUE(proxy_saw_c_url.load());
  24947. }
  24948. TEST(NoProxyTest, KeepAliveSocketInvalidatedOnSetNoProxy) {
  24949. // Mid-session set_no_proxy must drop any keep-alive socket so the next
  24950. // request reconnects to the correct endpoint.
  24951. std::atomic<int> proxy_hits{0};
  24952. std::atomic<int> target_hits{0};
  24953. no_proxy_test::ScopedServer proxy_mock, target;
  24954. proxy_mock.svr().Get(".*", [&](const Request &, Response &res) {
  24955. proxy_hits++;
  24956. res.set_content("via-proxy", "text/plain");
  24957. });
  24958. target.svr().Get(".*", [&](const Request &, Response &res) {
  24959. target_hits++;
  24960. res.set_content("direct", "text/plain");
  24961. });
  24962. proxy_mock.listen();
  24963. target.listen();
  24964. Client cli("public.example", target.port());
  24965. cli.set_hostname_addr_map({{"public.example", "127.0.0.1"}});
  24966. cli.set_proxy("127.0.0.1", proxy_mock.port());
  24967. cli.set_keep_alive(true);
  24968. auto res1 = cli.Get("/a");
  24969. ASSERT_TRUE(res1);
  24970. EXPECT_EQ("via-proxy", res1->body);
  24971. EXPECT_EQ(1, proxy_hits.load());
  24972. EXPECT_EQ(0, target_hits.load());
  24973. cli.set_no_proxy({"public.example"});
  24974. auto res2 = cli.Get("/b");
  24975. ASSERT_TRUE(res2);
  24976. EXPECT_EQ("direct", res2->body);
  24977. EXPECT_EQ(1, proxy_hits.load());
  24978. EXPECT_EQ(1, target_hits.load());
  24979. }
  24980. #if defined(CPPHTTPLIB_SSL_ENABLED) && !defined(_WIN32)
  24981. namespace proxy_tunnel_test {
  24982. // SSLServer counterpart to no_proxy_test::ScopedServer.
  24983. class ScopedSSLServer {
  24984. public:
  24985. ScopedSSLServer() : svr_(SERVER_CERT_FILE, SERVER_PRIVATE_KEY_FILE) {
  24986. port_ = svr_.bind_to_any_port("127.0.0.1");
  24987. }
  24988. ~ScopedSSLServer() {
  24989. svr_.stop();
  24990. if (th_.joinable()) { th_.join(); }
  24991. }
  24992. SSLServer &svr() { return svr_; }
  24993. int port() const { return port_; }
  24994. void listen() {
  24995. th_ = std::thread([this] { svr_.listen_after_bind(); });
  24996. svr_.wait_until_ready();
  24997. }
  24998. private:
  24999. SSLServer svr_;
  25000. std::thread th_;
  25001. int port_ = 0;
  25002. };
  25003. // Accepts CONNECT, replies 200, byte-forwards to forward_port.
  25004. class ScopedConnectProxy {
  25005. public:
  25006. explicit ScopedConnectProxy(int forward_port) : forward_port_(forward_port) {
  25007. listen_fd_ = ::socket(AF_INET, SOCK_STREAM, 0);
  25008. if (listen_fd_ < 0) { return; }
  25009. int yes = 1;
  25010. ::setsockopt(listen_fd_, SOL_SOCKET, SO_REUSEADDR, &yes, sizeof(yes));
  25011. sockaddr_in a{};
  25012. a.sin_family = AF_INET;
  25013. a.sin_addr.s_addr = htonl(INADDR_LOOPBACK);
  25014. a.sin_port = 0;
  25015. if (::bind(listen_fd_, reinterpret_cast<sockaddr *>(&a), sizeof(a)) != 0) {
  25016. return;
  25017. }
  25018. socklen_t alen = sizeof(a);
  25019. if (::getsockname(listen_fd_, reinterpret_cast<sockaddr *>(&a), &alen) !=
  25020. 0) {
  25021. return;
  25022. }
  25023. port_ = ntohs(a.sin_port);
  25024. if (::listen(listen_fd_, 1) != 0) { return; }
  25025. th_ = std::thread([this] { run(); });
  25026. }
  25027. ~ScopedConnectProxy() {
  25028. stop_ = true;
  25029. if (listen_fd_ >= 0) {
  25030. ::shutdown(listen_fd_, SHUT_RDWR);
  25031. ::close(listen_fd_);
  25032. }
  25033. if (th_.joinable()) { th_.join(); }
  25034. }
  25035. int port() const { return port_; }
  25036. int connect_hits() const { return connect_hits_.load(); }
  25037. // Head of the last CONNECT request, as the proxy saw it on the wire.
  25038. std::string connect_request() const {
  25039. std::lock_guard<std::mutex> lock(connect_request_mutex_);
  25040. return connect_request_;
  25041. }
  25042. private:
  25043. void run() {
  25044. while (!stop_.load()) {
  25045. fd_set rfds;
  25046. FD_ZERO(&rfds);
  25047. FD_SET(listen_fd_, &rfds);
  25048. timeval tv{0, 100 * 1000};
  25049. int sel = ::select(listen_fd_ + 1, &rfds, nullptr, nullptr, &tv);
  25050. if (sel <= 0) { continue; }
  25051. int client_fd = ::accept(listen_fd_, nullptr, nullptr);
  25052. if (client_fd < 0) { continue; }
  25053. std::string req;
  25054. char buf[2048];
  25055. while (req.find("\r\n\r\n") == std::string::npos) {
  25056. ssize_t n = ::recv(client_fd, buf, sizeof(buf), 0);
  25057. if (n <= 0) { break; }
  25058. req.append(buf, static_cast<size_t>(n));
  25059. }
  25060. if (req.compare(0, 7, "CONNECT") != 0) {
  25061. ::close(client_fd);
  25062. continue;
  25063. }
  25064. connect_hits_++;
  25065. {
  25066. std::lock_guard<std::mutex> lock(connect_request_mutex_);
  25067. connect_request_ = req;
  25068. }
  25069. const char *ok = "HTTP/1.1 200 Connection established\r\n\r\n";
  25070. ::send(client_fd, ok, std::strlen(ok), 0);
  25071. int origin_fd = ::socket(AF_INET, SOCK_STREAM, 0);
  25072. sockaddr_in o{};
  25073. o.sin_family = AF_INET;
  25074. o.sin_addr.s_addr = htonl(INADDR_LOOPBACK);
  25075. o.sin_port = htons(static_cast<unsigned short>(forward_port_));
  25076. if (::connect(origin_fd, reinterpret_cast<sockaddr *>(&o), sizeof(o)) !=
  25077. 0) {
  25078. ::close(client_fd);
  25079. ::close(origin_fd);
  25080. continue;
  25081. }
  25082. auto forward = [](int from, int to) {
  25083. char b[8192];
  25084. for (;;) {
  25085. ssize_t n = ::recv(from, b, sizeof(b), 0);
  25086. if (n <= 0) { break; }
  25087. ssize_t off = 0;
  25088. while (off < n) {
  25089. ssize_t s = ::send(to, b + off, static_cast<size_t>(n - off), 0);
  25090. if (s <= 0) {
  25091. off = n;
  25092. break;
  25093. }
  25094. off += s;
  25095. }
  25096. }
  25097. ::shutdown(to, SHUT_WR);
  25098. };
  25099. std::thread t1([&] { forward(client_fd, origin_fd); });
  25100. std::thread t2([&] { forward(origin_fd, client_fd); });
  25101. t1.join();
  25102. t2.join();
  25103. ::close(client_fd);
  25104. ::close(origin_fd);
  25105. }
  25106. }
  25107. int forward_port_ = -1;
  25108. int listen_fd_ = -1;
  25109. int port_ = 0;
  25110. std::thread th_;
  25111. std::atomic<bool> stop_{false};
  25112. std::atomic<int> connect_hits_{0};
  25113. mutable std::mutex connect_request_mutex_;
  25114. std::string connect_request_;
  25115. };
  25116. // Sends one request through the CONNECT proxy to the TLS origin with a
  25117. // credential configured for each hop, and checks that each credential reaches
  25118. // only the hop it was configured for: the proxy's on the CONNECT request, the
  25119. // origin's (every header in origin_headers) on the tunnelled request.
  25120. void CredentialsStayWithTheirHop(
  25121. const std::function<void(SSLClient &)> &set_credentials,
  25122. const std::string &scheme,
  25123. const std::vector<std::string> &origin_headers = {"Authorization"}) {
  25124. std::atomic<int> origin_hits{0};
  25125. std::atomic<bool> origin_saw_proxy_authz{false};
  25126. std::atomic<bool> origin_saw_headers{false};
  25127. ScopedSSLServer origin;
  25128. origin.svr().Get(".*", [&](const Request &req, Response &res) {
  25129. origin_hits++;
  25130. origin_saw_proxy_authz = req.has_header("Proxy-Authorization");
  25131. origin_saw_headers =
  25132. std::all_of(origin_headers.begin(), origin_headers.end(),
  25133. [&](const std::string &h) { return req.has_header(h); });
  25134. res.set_content("ok", "text/plain");
  25135. });
  25136. origin.listen();
  25137. ScopedConnectProxy proxy(origin.port());
  25138. ASSERT_NE(0, proxy.port());
  25139. // Pinned to 127.0.0.1 for the same reason as the test below.
  25140. SSLClient cli("127.0.0.1", origin.port());
  25141. cli.enable_server_certificate_verification(false);
  25142. cli.set_proxy("127.0.0.1", proxy.port());
  25143. set_credentials(cli);
  25144. auto res = cli.Get("/x");
  25145. ASSERT_TRUE(res) << "Error: " << to_string(res.error());
  25146. EXPECT_EQ(StatusCode::OK_200, res->status);
  25147. EXPECT_EQ(1, origin_hits.load());
  25148. EXPECT_EQ(1, proxy.connect_hits());
  25149. EXPECT_TRUE(origin_saw_headers.load());
  25150. EXPECT_FALSE(origin_saw_proxy_authz.load())
  25151. << "Proxy-Authorization must not be sent inside the tunnel";
  25152. auto connect_req = proxy.connect_request();
  25153. EXPECT_NE(std::string::npos,
  25154. connect_req.find("\r\nProxy-Authorization: " + scheme + " "));
  25155. for (const auto &h : origin_headers) {
  25156. EXPECT_EQ(std::string::npos, connect_req.find("\r\n" + h + ": "))
  25157. << h << " must not be sent to the proxy on CONNECT";
  25158. }
  25159. }
  25160. } // namespace proxy_tunnel_test
  25161. TEST(ProxyTunnelTest, BasicCredentialsStayWithTheirHop) {
  25162. proxy_tunnel_test::CredentialsStayWithTheirHop(
  25163. [](SSLClient &cli) {
  25164. cli.set_proxy_basic_auth("proxy-user", "proxy-pass");
  25165. cli.set_basic_auth("origin-user", "origin-pass");
  25166. },
  25167. "Basic");
  25168. }
  25169. TEST(ProxyTunnelTest, BearerCredentialsStayWithTheirHop) {
  25170. proxy_tunnel_test::CredentialsStayWithTheirHop(
  25171. [](SSLClient &cli) {
  25172. cli.set_proxy_bearer_token_auth("proxy-token");
  25173. cli.set_bearer_token_auth("origin-token");
  25174. },
  25175. "Bearer");
  25176. }
  25177. TEST(ProxyTunnelTest, DefaultHeadersStayOffConnect) {
  25178. proxy_tunnel_test::CredentialsStayWithTheirHop(
  25179. [](SSLClient &cli) {
  25180. cli.set_proxy_basic_auth("proxy-user", "proxy-pass");
  25181. cli.set_default_headers({{"Authorization", "Bearer origin-token"},
  25182. {"Cookie", "sid=origin-session"},
  25183. {"X-Api-Key", "origin-key"}});
  25184. },
  25185. "Basic", {"Authorization", "Cookie", "X-Api-Key"});
  25186. }
  25187. TEST(ProxyTunnelTest, OriginReturning407InsideTunnelDoesNotLeakProxyDigest) {
  25188. // Origin inside a CONNECT tunnel replying 407 must not trigger the digest
  25189. // retry; otherwise proxy creds would be sent to the origin.
  25190. std::atomic<int> origin_hits{0};
  25191. std::atomic<bool> origin_saw_proxy_authz{false};
  25192. proxy_tunnel_test::ScopedSSLServer origin;
  25193. origin.svr().Get(".*", [&](const Request &req, Response &res) {
  25194. origin_hits++;
  25195. if (req.has_header("Proxy-Authorization")) {
  25196. origin_saw_proxy_authz = true;
  25197. }
  25198. res.status = StatusCode::ProxyAuthenticationRequired_407;
  25199. res.set_header("Proxy-Authenticate",
  25200. "Digest realm=\"evil\", qop=\"auth\", nonce=\"abc\", "
  25201. "algorithm=MD5");
  25202. });
  25203. origin.listen();
  25204. proxy_tunnel_test::ScopedConnectProxy proxy(origin.port());
  25205. ASSERT_NE(0, proxy.port());
  25206. // Pin to 127.0.0.1: the proxy listens on 127.0.0.1 only, while "localhost"
  25207. // may resolve to ::1 first. A concurrent test (e.g. another gtest shard)
  25208. // holding ::1 with the same ephemeral port number would hijack the CONNECT
  25209. // and answer with its own status, making this test flaky.
  25210. SSLClient cli("127.0.0.1", origin.port());
  25211. cli.enable_server_certificate_verification(false);
  25212. cli.set_proxy("127.0.0.1", proxy.port());
  25213. cli.set_proxy_digest_auth("proxy-user", "proxy-pass");
  25214. auto res = cli.Get("/x");
  25215. ASSERT_TRUE(res) << "Error: " << to_string(res.error());
  25216. EXPECT_EQ(StatusCode::ProxyAuthenticationRequired_407, res->status);
  25217. EXPECT_EQ(1, origin_hits.load());
  25218. EXPECT_FALSE(origin_saw_proxy_authz.load());
  25219. EXPECT_EQ(1, proxy.connect_hits());
  25220. }
  25221. #endif