httplib.h 825 KB

1234567891011121314151617181920212223242526272829303132333435363738394041424344454647484950515253545556575859606162636465666768697071727374757677787980818283848586878889909192939495969798991001011021031041051061071081091101111121131141151161171181191201211221231241251261271281291301311321331341351361371381391401411421431441451461471481491501511521531541551561571581591601611621631641651661671681691701711721731741751761771781791801811821831841851861871881891901911921931941951961971981992002012022032042052062072082092102112122132142152162172182192202212222232242252262272282292302312322332342352362372382392402412422432442452462472482492502512522532542552562572582592602612622632642652662672682692702712722732742752762772782792802812822832842852862872882892902912922932942952962972982993003013023033043053063073083093103113123133143153163173183193203213223233243253263273283293303313323333343353363373383393403413423433443453463473483493503513523533543553563573583593603613623633643653663673683693703713723733743753763773783793803813823833843853863873883893903913923933943953963973983994004014024034044054064074084094104114124134144154164174184194204214224234244254264274284294304314324334344354364374384394404414424434444454464474484494504514524534544554564574584594604614624634644654664674684694704714724734744754764774784794804814824834844854864874884894904914924934944954964974984995005015025035045055065075085095105115125135145155165175185195205215225235245255265275285295305315325335345355365375385395405415425435445455465475485495505515525535545555565575585595605615625635645655665675685695705715725735745755765775785795805815825835845855865875885895905915925935945955965975985996006016026036046056066076086096106116126136146156166176186196206216226236246256266276286296306316326336346356366376386396406416426436446456466476486496506516526536546556566576586596606616626636646656666676686696706716726736746756766776786796806816826836846856866876886896906916926936946956966976986997007017027037047057067077087097107117127137147157167177187197207217227237247257267277287297307317327337347357367377387397407417427437447457467477487497507517527537547557567577587597607617627637647657667677687697707717727737747757767777787797807817827837847857867877887897907917927937947957967977987998008018028038048058068078088098108118128138148158168178188198208218228238248258268278288298308318328338348358368378388398408418428438448458468478488498508518528538548558568578588598608618628638648658668678688698708718728738748758768778788798808818828838848858868878888898908918928938948958968978988999009019029039049059069079089099109119129139149159169179189199209219229239249259269279289299309319329339349359369379389399409419429439449459469479489499509519529539549559569579589599609619629639649659669679689699709719729739749759769779789799809819829839849859869879889899909919929939949959969979989991000100110021003100410051006100710081009101010111012101310141015101610171018101910201021102210231024102510261027102810291030103110321033103410351036103710381039104010411042104310441045104610471048104910501051105210531054105510561057105810591060106110621063106410651066106710681069107010711072107310741075107610771078107910801081108210831084108510861087108810891090109110921093109410951096109710981099110011011102110311041105110611071108110911101111111211131114111511161117111811191120112111221123112411251126112711281129113011311132113311341135113611371138113911401141114211431144114511461147114811491150115111521153115411551156115711581159116011611162116311641165116611671168116911701171117211731174117511761177117811791180118111821183118411851186118711881189119011911192119311941195119611971198119912001201120212031204120512061207120812091210121112121213121412151216121712181219122012211222122312241225122612271228122912301231123212331234123512361237123812391240124112421243124412451246124712481249125012511252125312541255125612571258125912601261126212631264126512661267126812691270127112721273127412751276127712781279128012811282128312841285128612871288128912901291129212931294129512961297129812991300130113021303130413051306130713081309131013111312131313141315131613171318131913201321132213231324132513261327132813291330133113321333133413351336133713381339134013411342134313441345134613471348134913501351135213531354135513561357135813591360136113621363136413651366136713681369137013711372137313741375137613771378137913801381138213831384138513861387138813891390139113921393139413951396139713981399140014011402140314041405140614071408140914101411141214131414141514161417141814191420142114221423142414251426142714281429143014311432143314341435143614371438143914401441144214431444144514461447144814491450145114521453145414551456145714581459146014611462146314641465146614671468146914701471147214731474147514761477147814791480148114821483148414851486148714881489149014911492149314941495149614971498149915001501150215031504150515061507150815091510151115121513151415151516151715181519152015211522152315241525152615271528152915301531153215331534153515361537153815391540154115421543154415451546154715481549155015511552155315541555155615571558155915601561156215631564156515661567156815691570157115721573157415751576157715781579158015811582158315841585158615871588158915901591159215931594159515961597159815991600160116021603160416051606160716081609161016111612161316141615161616171618161916201621162216231624162516261627162816291630163116321633163416351636163716381639164016411642164316441645164616471648164916501651165216531654165516561657165816591660166116621663166416651666166716681669167016711672167316741675167616771678167916801681168216831684168516861687168816891690169116921693169416951696169716981699170017011702170317041705170617071708170917101711171217131714171517161717171817191720172117221723172417251726172717281729173017311732173317341735173617371738173917401741174217431744174517461747174817491750175117521753175417551756175717581759176017611762176317641765176617671768176917701771177217731774177517761777177817791780178117821783178417851786178717881789179017911792179317941795179617971798179918001801180218031804180518061807180818091810181118121813181418151816181718181819182018211822182318241825182618271828182918301831183218331834183518361837183818391840184118421843184418451846184718481849185018511852185318541855185618571858185918601861186218631864186518661867186818691870187118721873187418751876187718781879188018811882188318841885188618871888188918901891189218931894189518961897189818991900190119021903190419051906190719081909191019111912191319141915191619171918191919201921192219231924192519261927192819291930193119321933193419351936193719381939194019411942194319441945194619471948194919501951195219531954195519561957195819591960196119621963196419651966196719681969197019711972197319741975197619771978197919801981198219831984198519861987198819891990199119921993199419951996199719981999200020012002200320042005200620072008200920102011201220132014201520162017201820192020202120222023202420252026202720282029203020312032203320342035203620372038203920402041204220432044204520462047204820492050205120522053205420552056205720582059206020612062206320642065206620672068206920702071207220732074207520762077207820792080208120822083208420852086208720882089209020912092209320942095209620972098209921002101210221032104210521062107210821092110211121122113211421152116211721182119212021212122212321242125212621272128212921302131213221332134213521362137213821392140214121422143214421452146214721482149215021512152215321542155215621572158215921602161216221632164216521662167216821692170217121722173217421752176217721782179218021812182218321842185218621872188218921902191219221932194219521962197219821992200220122022203220422052206220722082209221022112212221322142215221622172218221922202221222222232224222522262227222822292230223122322233223422352236223722382239224022412242224322442245224622472248224922502251225222532254225522562257225822592260226122622263226422652266226722682269227022712272227322742275227622772278227922802281228222832284228522862287228822892290229122922293229422952296229722982299230023012302230323042305230623072308230923102311231223132314231523162317231823192320232123222323232423252326232723282329233023312332233323342335233623372338233923402341234223432344234523462347234823492350235123522353235423552356235723582359236023612362236323642365236623672368236923702371237223732374237523762377237823792380238123822383238423852386238723882389239023912392239323942395239623972398239924002401240224032404240524062407240824092410241124122413241424152416241724182419242024212422242324242425242624272428242924302431243224332434243524362437243824392440244124422443244424452446244724482449245024512452245324542455245624572458245924602461246224632464246524662467246824692470247124722473247424752476247724782479248024812482248324842485248624872488248924902491249224932494249524962497249824992500250125022503250425052506250725082509251025112512251325142515251625172518251925202521252225232524252525262527252825292530253125322533253425352536253725382539254025412542254325442545254625472548254925502551255225532554255525562557255825592560256125622563256425652566256725682569257025712572257325742575257625772578257925802581258225832584258525862587258825892590259125922593259425952596259725982599260026012602260326042605260626072608260926102611261226132614261526162617261826192620262126222623262426252626262726282629263026312632263326342635263626372638263926402641264226432644264526462647264826492650265126522653265426552656265726582659266026612662266326642665266626672668266926702671267226732674267526762677267826792680268126822683268426852686268726882689269026912692269326942695269626972698269927002701270227032704270527062707270827092710271127122713271427152716271727182719272027212722272327242725272627272728272927302731273227332734273527362737273827392740274127422743274427452746274727482749275027512752275327542755275627572758275927602761276227632764276527662767276827692770277127722773277427752776277727782779278027812782278327842785278627872788278927902791279227932794279527962797279827992800280128022803280428052806280728082809281028112812281328142815281628172818281928202821282228232824282528262827282828292830283128322833283428352836283728382839284028412842284328442845284628472848284928502851285228532854285528562857285828592860286128622863286428652866286728682869287028712872287328742875287628772878287928802881288228832884288528862887288828892890289128922893289428952896289728982899290029012902290329042905290629072908290929102911291229132914291529162917291829192920292129222923292429252926292729282929293029312932293329342935293629372938293929402941294229432944294529462947294829492950295129522953295429552956295729582959296029612962296329642965296629672968296929702971297229732974297529762977297829792980298129822983298429852986298729882989299029912992299329942995299629972998299930003001300230033004300530063007300830093010301130123013301430153016301730183019302030213022302330243025302630273028302930303031303230333034303530363037303830393040304130423043304430453046304730483049305030513052305330543055305630573058305930603061306230633064306530663067306830693070307130723073307430753076307730783079308030813082308330843085308630873088308930903091309230933094309530963097309830993100310131023103310431053106310731083109311031113112311331143115311631173118311931203121312231233124312531263127312831293130313131323133313431353136313731383139314031413142314331443145314631473148314931503151315231533154315531563157315831593160316131623163316431653166316731683169317031713172317331743175317631773178317931803181318231833184318531863187318831893190319131923193319431953196319731983199320032013202320332043205320632073208320932103211321232133214321532163217321832193220322132223223322432253226322732283229323032313232323332343235323632373238323932403241324232433244324532463247324832493250325132523253325432553256325732583259326032613262326332643265326632673268326932703271327232733274327532763277327832793280328132823283328432853286328732883289329032913292329332943295329632973298329933003301330233033304330533063307330833093310331133123313331433153316331733183319332033213322332333243325332633273328332933303331333233333334333533363337333833393340334133423343334433453346334733483349335033513352335333543355335633573358335933603361336233633364336533663367336833693370337133723373337433753376337733783379338033813382338333843385338633873388338933903391339233933394339533963397339833993400340134023403340434053406340734083409341034113412341334143415341634173418341934203421342234233424342534263427342834293430343134323433343434353436343734383439344034413442344334443445344634473448344934503451345234533454345534563457345834593460346134623463346434653466346734683469347034713472347334743475347634773478347934803481348234833484348534863487348834893490349134923493349434953496349734983499350035013502350335043505350635073508350935103511351235133514351535163517351835193520352135223523352435253526352735283529353035313532353335343535353635373538353935403541354235433544354535463547354835493550355135523553355435553556355735583559356035613562356335643565356635673568356935703571357235733574357535763577357835793580358135823583358435853586358735883589359035913592359335943595359635973598359936003601360236033604360536063607360836093610361136123613361436153616361736183619362036213622362336243625362636273628362936303631363236333634363536363637363836393640364136423643364436453646364736483649365036513652365336543655365636573658365936603661366236633664366536663667366836693670367136723673367436753676367736783679368036813682368336843685368636873688368936903691369236933694369536963697369836993700370137023703370437053706370737083709371037113712371337143715371637173718371937203721372237233724372537263727372837293730373137323733373437353736373737383739374037413742374337443745374637473748374937503751375237533754375537563757375837593760376137623763376437653766376737683769377037713772377337743775377637773778377937803781378237833784378537863787378837893790379137923793379437953796379737983799380038013802380338043805380638073808380938103811381238133814381538163817381838193820382138223823382438253826382738283829383038313832383338343835383638373838383938403841384238433844384538463847384838493850385138523853385438553856385738583859386038613862386338643865386638673868386938703871387238733874387538763877387838793880388138823883388438853886388738883889389038913892389338943895389638973898389939003901390239033904390539063907390839093910391139123913391439153916391739183919392039213922392339243925392639273928392939303931393239333934393539363937393839393940394139423943394439453946394739483949395039513952395339543955395639573958395939603961396239633964396539663967396839693970397139723973397439753976397739783979398039813982398339843985398639873988398939903991399239933994399539963997399839994000400140024003400440054006400740084009401040114012401340144015401640174018401940204021402240234024402540264027402840294030403140324033403440354036403740384039404040414042404340444045404640474048404940504051405240534054405540564057405840594060406140624063406440654066406740684069407040714072407340744075407640774078407940804081408240834084408540864087408840894090409140924093409440954096409740984099410041014102410341044105410641074108410941104111411241134114411541164117411841194120412141224123412441254126412741284129413041314132413341344135413641374138413941404141414241434144414541464147414841494150415141524153415441554156415741584159416041614162416341644165416641674168416941704171417241734174417541764177417841794180418141824183418441854186418741884189419041914192419341944195419641974198419942004201420242034204420542064207420842094210421142124213421442154216421742184219422042214222422342244225422642274228422942304231423242334234423542364237423842394240424142424243424442454246424742484249425042514252425342544255425642574258425942604261426242634264426542664267426842694270427142724273427442754276427742784279428042814282428342844285428642874288428942904291429242934294429542964297429842994300430143024303430443054306430743084309431043114312431343144315431643174318431943204321432243234324432543264327432843294330433143324333433443354336433743384339434043414342434343444345434643474348434943504351435243534354435543564357435843594360436143624363436443654366436743684369437043714372437343744375437643774378437943804381438243834384438543864387438843894390439143924393439443954396439743984399440044014402440344044405440644074408440944104411441244134414441544164417441844194420442144224423442444254426442744284429443044314432443344344435443644374438443944404441444244434444444544464447444844494450445144524453445444554456445744584459446044614462446344644465446644674468446944704471447244734474447544764477447844794480448144824483448444854486448744884489449044914492449344944495449644974498449945004501450245034504450545064507450845094510451145124513451445154516451745184519452045214522452345244525452645274528452945304531453245334534453545364537453845394540454145424543454445454546454745484549455045514552455345544555455645574558455945604561456245634564456545664567456845694570457145724573457445754576457745784579458045814582458345844585458645874588458945904591459245934594459545964597459845994600460146024603460446054606460746084609461046114612461346144615461646174618461946204621462246234624462546264627462846294630463146324633463446354636463746384639464046414642464346444645464646474648464946504651465246534654465546564657465846594660466146624663466446654666466746684669467046714672467346744675467646774678467946804681468246834684468546864687468846894690469146924693469446954696469746984699470047014702470347044705470647074708470947104711471247134714471547164717471847194720472147224723472447254726472747284729473047314732473347344735473647374738473947404741474247434744474547464747474847494750475147524753475447554756475747584759476047614762476347644765476647674768476947704771477247734774477547764777477847794780478147824783478447854786478747884789479047914792479347944795479647974798479948004801480248034804480548064807480848094810481148124813481448154816481748184819482048214822482348244825482648274828482948304831483248334834483548364837483848394840484148424843484448454846484748484849485048514852485348544855485648574858485948604861486248634864486548664867486848694870487148724873487448754876487748784879488048814882488348844885488648874888488948904891489248934894489548964897489848994900490149024903490449054906490749084909491049114912491349144915491649174918491949204921492249234924492549264927492849294930493149324933493449354936493749384939494049414942494349444945494649474948494949504951495249534954495549564957495849594960496149624963496449654966496749684969497049714972497349744975497649774978497949804981498249834984498549864987498849894990499149924993499449954996499749984999500050015002500350045005500650075008500950105011501250135014501550165017501850195020502150225023502450255026502750285029503050315032503350345035503650375038503950405041504250435044504550465047504850495050505150525053505450555056505750585059506050615062506350645065506650675068506950705071507250735074507550765077507850795080508150825083508450855086508750885089509050915092509350945095509650975098509951005101510251035104510551065107510851095110511151125113511451155116511751185119512051215122512351245125512651275128512951305131513251335134513551365137513851395140514151425143514451455146514751485149515051515152515351545155515651575158515951605161516251635164516551665167516851695170517151725173517451755176517751785179518051815182518351845185518651875188518951905191519251935194519551965197519851995200520152025203520452055206520752085209521052115212521352145215521652175218521952205221522252235224522552265227522852295230523152325233523452355236523752385239524052415242524352445245524652475248524952505251525252535254525552565257525852595260526152625263526452655266526752685269527052715272527352745275527652775278527952805281528252835284528552865287528852895290529152925293529452955296529752985299530053015302530353045305530653075308530953105311531253135314531553165317531853195320532153225323532453255326532753285329533053315332533353345335533653375338533953405341534253435344534553465347534853495350535153525353535453555356535753585359536053615362536353645365536653675368536953705371537253735374537553765377537853795380538153825383538453855386538753885389539053915392539353945395539653975398539954005401540254035404540554065407540854095410541154125413541454155416541754185419542054215422542354245425542654275428542954305431543254335434543554365437543854395440544154425443544454455446544754485449545054515452545354545455545654575458545954605461546254635464546554665467546854695470547154725473547454755476547754785479548054815482548354845485548654875488548954905491549254935494549554965497549854995500550155025503550455055506550755085509551055115512551355145515551655175518551955205521552255235524552555265527552855295530553155325533553455355536553755385539554055415542554355445545554655475548554955505551555255535554555555565557555855595560556155625563556455655566556755685569557055715572557355745575557655775578557955805581558255835584558555865587558855895590559155925593559455955596559755985599560056015602560356045605560656075608560956105611561256135614561556165617561856195620562156225623562456255626562756285629563056315632563356345635563656375638563956405641564256435644564556465647564856495650565156525653565456555656565756585659566056615662566356645665566656675668566956705671567256735674567556765677567856795680568156825683568456855686568756885689569056915692569356945695569656975698569957005701570257035704570557065707570857095710571157125713571457155716571757185719572057215722572357245725572657275728572957305731573257335734573557365737573857395740574157425743574457455746574757485749575057515752575357545755575657575758575957605761576257635764576557665767576857695770577157725773577457755776577757785779578057815782578357845785578657875788578957905791579257935794579557965797579857995800580158025803580458055806580758085809581058115812581358145815581658175818581958205821582258235824582558265827582858295830583158325833583458355836583758385839584058415842584358445845584658475848584958505851585258535854585558565857585858595860586158625863586458655866586758685869587058715872587358745875587658775878587958805881588258835884588558865887588858895890589158925893589458955896589758985899590059015902590359045905590659075908590959105911591259135914591559165917591859195920592159225923592459255926592759285929593059315932593359345935593659375938593959405941594259435944594559465947594859495950595159525953595459555956595759585959596059615962596359645965596659675968596959705971597259735974597559765977597859795980598159825983598459855986598759885989599059915992599359945995599659975998599960006001600260036004600560066007600860096010601160126013601460156016601760186019602060216022602360246025602660276028602960306031603260336034603560366037603860396040604160426043604460456046604760486049605060516052605360546055605660576058605960606061606260636064606560666067606860696070607160726073607460756076607760786079608060816082608360846085608660876088608960906091609260936094609560966097609860996100610161026103610461056106610761086109611061116112611361146115611661176118611961206121612261236124612561266127612861296130613161326133613461356136613761386139614061416142614361446145614661476148614961506151615261536154615561566157615861596160616161626163616461656166616761686169617061716172617361746175617661776178617961806181618261836184618561866187618861896190619161926193619461956196619761986199620062016202620362046205620662076208620962106211621262136214621562166217621862196220622162226223622462256226622762286229623062316232623362346235623662376238623962406241624262436244624562466247624862496250625162526253625462556256625762586259626062616262626362646265626662676268626962706271627262736274627562766277627862796280628162826283628462856286628762886289629062916292629362946295629662976298629963006301630263036304630563066307630863096310631163126313631463156316631763186319632063216322632363246325632663276328632963306331633263336334633563366337633863396340634163426343634463456346634763486349635063516352635363546355635663576358635963606361636263636364636563666367636863696370637163726373637463756376637763786379638063816382638363846385638663876388638963906391639263936394639563966397639863996400640164026403640464056406640764086409641064116412641364146415641664176418641964206421642264236424642564266427642864296430643164326433643464356436643764386439644064416442644364446445644664476448644964506451645264536454645564566457645864596460646164626463646464656466646764686469647064716472647364746475647664776478647964806481648264836484648564866487648864896490649164926493649464956496649764986499650065016502650365046505650665076508650965106511651265136514651565166517651865196520652165226523652465256526652765286529653065316532653365346535653665376538653965406541654265436544654565466547654865496550655165526553655465556556655765586559656065616562656365646565656665676568656965706571657265736574657565766577657865796580658165826583658465856586658765886589659065916592659365946595659665976598659966006601660266036604660566066607660866096610661166126613661466156616661766186619662066216622662366246625662666276628662966306631663266336634663566366637663866396640664166426643664466456646664766486649665066516652665366546655665666576658665966606661666266636664666566666667666866696670667166726673667466756676667766786679668066816682668366846685668666876688668966906691669266936694669566966697669866996700670167026703670467056706670767086709671067116712671367146715671667176718671967206721672267236724672567266727672867296730673167326733673467356736673767386739674067416742674367446745674667476748674967506751675267536754675567566757675867596760676167626763676467656766676767686769677067716772677367746775677667776778677967806781678267836784678567866787678867896790679167926793679467956796679767986799680068016802680368046805680668076808680968106811681268136814681568166817681868196820682168226823682468256826682768286829683068316832683368346835683668376838683968406841684268436844684568466847684868496850685168526853685468556856685768586859686068616862686368646865686668676868686968706871687268736874687568766877687868796880688168826883688468856886688768886889689068916892689368946895689668976898689969006901690269036904690569066907690869096910691169126913691469156916691769186919692069216922692369246925692669276928692969306931693269336934693569366937693869396940694169426943694469456946694769486949695069516952695369546955695669576958695969606961696269636964696569666967696869696970697169726973697469756976697769786979698069816982698369846985698669876988698969906991699269936994699569966997699869997000700170027003700470057006700770087009701070117012701370147015701670177018701970207021702270237024702570267027702870297030703170327033703470357036703770387039704070417042704370447045704670477048704970507051705270537054705570567057705870597060706170627063706470657066706770687069707070717072707370747075707670777078707970807081708270837084708570867087708870897090709170927093709470957096709770987099710071017102710371047105710671077108710971107111711271137114711571167117711871197120712171227123712471257126712771287129713071317132713371347135713671377138713971407141714271437144714571467147714871497150715171527153715471557156715771587159716071617162716371647165716671677168716971707171717271737174717571767177717871797180718171827183718471857186718771887189719071917192719371947195719671977198719972007201720272037204720572067207720872097210721172127213721472157216721772187219722072217222722372247225722672277228722972307231723272337234723572367237723872397240724172427243724472457246724772487249725072517252725372547255725672577258725972607261726272637264726572667267726872697270727172727273727472757276727772787279728072817282728372847285728672877288728972907291729272937294729572967297729872997300730173027303730473057306730773087309731073117312731373147315731673177318731973207321732273237324732573267327732873297330733173327333733473357336733773387339734073417342734373447345734673477348734973507351735273537354735573567357735873597360736173627363736473657366736773687369737073717372737373747375737673777378737973807381738273837384738573867387738873897390739173927393739473957396739773987399740074017402740374047405740674077408740974107411741274137414741574167417741874197420742174227423742474257426742774287429743074317432743374347435743674377438743974407441744274437444744574467447744874497450745174527453745474557456745774587459746074617462746374647465746674677468746974707471747274737474747574767477747874797480748174827483748474857486748774887489749074917492749374947495749674977498749975007501750275037504750575067507750875097510751175127513751475157516751775187519752075217522752375247525752675277528752975307531753275337534753575367537753875397540754175427543754475457546754775487549755075517552755375547555755675577558755975607561756275637564756575667567756875697570757175727573757475757576757775787579758075817582758375847585758675877588758975907591759275937594759575967597759875997600760176027603760476057606760776087609761076117612761376147615761676177618761976207621762276237624762576267627762876297630763176327633763476357636763776387639764076417642764376447645764676477648764976507651765276537654765576567657765876597660766176627663766476657666766776687669767076717672767376747675767676777678767976807681768276837684768576867687768876897690769176927693769476957696769776987699770077017702770377047705770677077708770977107711771277137714771577167717771877197720772177227723772477257726772777287729773077317732773377347735773677377738773977407741774277437744774577467747774877497750775177527753775477557756775777587759776077617762776377647765776677677768776977707771777277737774777577767777777877797780778177827783778477857786778777887789779077917792779377947795779677977798779978007801780278037804780578067807780878097810781178127813781478157816781778187819782078217822782378247825782678277828782978307831783278337834783578367837783878397840784178427843784478457846784778487849785078517852785378547855785678577858785978607861786278637864786578667867786878697870787178727873787478757876787778787879788078817882788378847885788678877888788978907891789278937894789578967897789878997900790179027903790479057906790779087909791079117912791379147915791679177918791979207921792279237924792579267927792879297930793179327933793479357936793779387939794079417942794379447945794679477948794979507951795279537954795579567957795879597960796179627963796479657966796779687969797079717972797379747975797679777978797979807981798279837984798579867987798879897990799179927993799479957996799779987999800080018002800380048005800680078008800980108011801280138014801580168017801880198020802180228023802480258026802780288029803080318032803380348035803680378038803980408041804280438044804580468047804880498050805180528053805480558056805780588059806080618062806380648065806680678068806980708071807280738074807580768077807880798080808180828083808480858086808780888089809080918092809380948095809680978098809981008101810281038104810581068107810881098110811181128113811481158116811781188119812081218122812381248125812681278128812981308131813281338134813581368137813881398140814181428143814481458146814781488149815081518152815381548155815681578158815981608161816281638164816581668167816881698170817181728173817481758176817781788179818081818182818381848185818681878188818981908191819281938194819581968197819881998200820182028203820482058206820782088209821082118212821382148215821682178218821982208221822282238224822582268227822882298230823182328233823482358236823782388239824082418242824382448245824682478248824982508251825282538254825582568257825882598260826182628263826482658266826782688269827082718272827382748275827682778278827982808281828282838284828582868287828882898290829182928293829482958296829782988299830083018302830383048305830683078308830983108311831283138314831583168317831883198320832183228323832483258326832783288329833083318332833383348335833683378338833983408341834283438344834583468347834883498350835183528353835483558356835783588359836083618362836383648365836683678368836983708371837283738374837583768377837883798380838183828383838483858386838783888389839083918392839383948395839683978398839984008401840284038404840584068407840884098410841184128413841484158416841784188419842084218422842384248425842684278428842984308431843284338434843584368437843884398440844184428443844484458446844784488449845084518452845384548455845684578458845984608461846284638464846584668467846884698470847184728473847484758476847784788479848084818482848384848485848684878488848984908491849284938494849584968497849884998500850185028503850485058506850785088509851085118512851385148515851685178518851985208521852285238524852585268527852885298530853185328533853485358536853785388539854085418542854385448545854685478548854985508551855285538554855585568557855885598560856185628563856485658566856785688569857085718572857385748575857685778578857985808581858285838584858585868587858885898590859185928593859485958596859785988599860086018602860386048605860686078608860986108611861286138614861586168617861886198620862186228623862486258626862786288629863086318632863386348635863686378638863986408641864286438644864586468647864886498650865186528653865486558656865786588659866086618662866386648665866686678668866986708671867286738674867586768677867886798680868186828683868486858686868786888689869086918692869386948695869686978698869987008701870287038704870587068707870887098710871187128713871487158716871787188719872087218722872387248725872687278728872987308731873287338734873587368737873887398740874187428743874487458746874787488749875087518752875387548755875687578758875987608761876287638764876587668767876887698770877187728773877487758776877787788779878087818782878387848785878687878788878987908791879287938794879587968797879887998800880188028803880488058806880788088809881088118812881388148815881688178818881988208821882288238824882588268827882888298830883188328833883488358836883788388839884088418842884388448845884688478848884988508851885288538854885588568857885888598860886188628863886488658866886788688869887088718872887388748875887688778878887988808881888288838884888588868887888888898890889188928893889488958896889788988899890089018902890389048905890689078908890989108911891289138914891589168917891889198920892189228923892489258926892789288929893089318932893389348935893689378938893989408941894289438944894589468947894889498950895189528953895489558956895789588959896089618962896389648965896689678968896989708971897289738974897589768977897889798980898189828983898489858986898789888989899089918992899389948995899689978998899990009001900290039004900590069007900890099010901190129013901490159016901790189019902090219022902390249025902690279028902990309031903290339034903590369037903890399040904190429043904490459046904790489049905090519052905390549055905690579058905990609061906290639064906590669067906890699070907190729073907490759076907790789079908090819082908390849085908690879088908990909091909290939094909590969097909890999100910191029103910491059106910791089109911091119112911391149115911691179118911991209121912291239124912591269127912891299130913191329133913491359136913791389139914091419142914391449145914691479148914991509151915291539154915591569157915891599160916191629163916491659166916791689169917091719172917391749175917691779178917991809181918291839184918591869187918891899190919191929193919491959196919791989199920092019202920392049205920692079208920992109211921292139214921592169217921892199220922192229223922492259226922792289229923092319232923392349235923692379238923992409241924292439244924592469247924892499250925192529253925492559256925792589259926092619262926392649265926692679268926992709271927292739274927592769277927892799280928192829283928492859286928792889289929092919292929392949295929692979298929993009301930293039304930593069307930893099310931193129313931493159316931793189319932093219322932393249325932693279328932993309331933293339334933593369337933893399340934193429343934493459346934793489349935093519352935393549355935693579358935993609361936293639364936593669367936893699370937193729373937493759376937793789379938093819382938393849385938693879388938993909391939293939394939593969397939893999400940194029403940494059406940794089409941094119412941394149415941694179418941994209421942294239424942594269427942894299430943194329433943494359436943794389439944094419442944394449445944694479448944994509451945294539454945594569457945894599460946194629463946494659466946794689469947094719472947394749475947694779478947994809481948294839484948594869487948894899490949194929493949494959496949794989499950095019502950395049505950695079508950995109511951295139514951595169517951895199520952195229523952495259526952795289529953095319532953395349535953695379538953995409541954295439544954595469547954895499550955195529553955495559556955795589559956095619562956395649565956695679568956995709571957295739574957595769577957895799580958195829583958495859586958795889589959095919592959395949595959695979598959996009601960296039604960596069607960896099610961196129613961496159616961796189619962096219622962396249625962696279628962996309631963296339634963596369637963896399640964196429643964496459646964796489649965096519652965396549655965696579658965996609661966296639664966596669667966896699670967196729673967496759676967796789679968096819682968396849685968696879688968996909691969296939694969596969697969896999700970197029703970497059706970797089709971097119712971397149715971697179718971997209721972297239724972597269727972897299730973197329733973497359736973797389739974097419742974397449745974697479748974997509751975297539754975597569757975897599760976197629763976497659766976797689769977097719772977397749775977697779778977997809781978297839784978597869787978897899790979197929793979497959796979797989799980098019802980398049805980698079808980998109811981298139814981598169817981898199820982198229823982498259826982798289829983098319832983398349835983698379838983998409841984298439844984598469847984898499850985198529853985498559856985798589859986098619862986398649865986698679868986998709871987298739874987598769877987898799880988198829883988498859886988798889889989098919892989398949895989698979898989999009901990299039904990599069907990899099910991199129913991499159916991799189919992099219922992399249925992699279928992999309931993299339934993599369937993899399940994199429943994499459946994799489949995099519952995399549955995699579958995999609961996299639964996599669967996899699970997199729973997499759976997799789979998099819982998399849985998699879988998999909991999299939994999599969997999899991000010001100021000310004100051000610007100081000910010100111001210013100141001510016100171001810019100201002110022100231002410025100261002710028100291003010031100321003310034100351003610037100381003910040100411004210043100441004510046100471004810049100501005110052100531005410055100561005710058100591006010061100621006310064100651006610067100681006910070100711007210073100741007510076100771007810079100801008110082100831008410085100861008710088100891009010091100921009310094100951009610097100981009910100101011010210103101041010510106101071010810109101101011110112101131011410115101161011710118101191012010121101221012310124101251012610127101281012910130101311013210133101341013510136101371013810139101401014110142101431014410145101461014710148101491015010151101521015310154101551015610157101581015910160101611016210163101641016510166101671016810169101701017110172101731017410175101761017710178101791018010181101821018310184101851018610187101881018910190101911019210193101941019510196101971019810199102001020110202102031020410205102061020710208102091021010211102121021310214102151021610217102181021910220102211022210223102241022510226102271022810229102301023110232102331023410235102361023710238102391024010241102421024310244102451024610247102481024910250102511025210253102541025510256102571025810259102601026110262102631026410265102661026710268102691027010271102721027310274102751027610277102781027910280102811028210283102841028510286102871028810289102901029110292102931029410295102961029710298102991030010301103021030310304103051030610307103081030910310103111031210313103141031510316103171031810319103201032110322103231032410325103261032710328103291033010331103321033310334103351033610337103381033910340103411034210343103441034510346103471034810349103501035110352103531035410355103561035710358103591036010361103621036310364103651036610367103681036910370103711037210373103741037510376103771037810379103801038110382103831038410385103861038710388103891039010391103921039310394103951039610397103981039910400104011040210403104041040510406104071040810409104101041110412104131041410415104161041710418104191042010421104221042310424104251042610427104281042910430104311043210433104341043510436104371043810439104401044110442104431044410445104461044710448104491045010451104521045310454104551045610457104581045910460104611046210463104641046510466104671046810469104701047110472104731047410475104761047710478104791048010481104821048310484104851048610487104881048910490104911049210493104941049510496104971049810499105001050110502105031050410505105061050710508105091051010511105121051310514105151051610517105181051910520105211052210523105241052510526105271052810529105301053110532105331053410535105361053710538105391054010541105421054310544105451054610547105481054910550105511055210553105541055510556105571055810559105601056110562105631056410565105661056710568105691057010571105721057310574105751057610577105781057910580105811058210583105841058510586105871058810589105901059110592105931059410595105961059710598105991060010601106021060310604106051060610607106081060910610106111061210613106141061510616106171061810619106201062110622106231062410625106261062710628106291063010631106321063310634106351063610637106381063910640106411064210643106441064510646106471064810649106501065110652106531065410655106561065710658106591066010661106621066310664106651066610667106681066910670106711067210673106741067510676106771067810679106801068110682106831068410685106861068710688106891069010691106921069310694106951069610697106981069910700107011070210703107041070510706107071070810709107101071110712107131071410715107161071710718107191072010721107221072310724107251072610727107281072910730107311073210733107341073510736107371073810739107401074110742107431074410745107461074710748107491075010751107521075310754107551075610757107581075910760107611076210763107641076510766107671076810769107701077110772107731077410775107761077710778107791078010781107821078310784107851078610787107881078910790107911079210793107941079510796107971079810799108001080110802108031080410805108061080710808108091081010811108121081310814108151081610817108181081910820108211082210823108241082510826108271082810829108301083110832108331083410835108361083710838108391084010841108421084310844108451084610847108481084910850108511085210853108541085510856108571085810859108601086110862108631086410865108661086710868108691087010871108721087310874108751087610877108781087910880108811088210883108841088510886108871088810889108901089110892108931089410895108961089710898108991090010901109021090310904109051090610907109081090910910109111091210913109141091510916109171091810919109201092110922109231092410925109261092710928109291093010931109321093310934109351093610937109381093910940109411094210943109441094510946109471094810949109501095110952109531095410955109561095710958109591096010961109621096310964109651096610967109681096910970109711097210973109741097510976109771097810979109801098110982109831098410985109861098710988109891099010991109921099310994109951099610997109981099911000110011100211003110041100511006110071100811009110101101111012110131101411015110161101711018110191102011021110221102311024110251102611027110281102911030110311103211033110341103511036110371103811039110401104111042110431104411045110461104711048110491105011051110521105311054110551105611057110581105911060110611106211063110641106511066110671106811069110701107111072110731107411075110761107711078110791108011081110821108311084110851108611087110881108911090110911109211093110941109511096110971109811099111001110111102111031110411105111061110711108111091111011111111121111311114111151111611117111181111911120111211112211123111241112511126111271112811129111301113111132111331113411135111361113711138111391114011141111421114311144111451114611147111481114911150111511115211153111541115511156111571115811159111601116111162111631116411165111661116711168111691117011171111721117311174111751117611177111781117911180111811118211183111841118511186111871118811189111901119111192111931119411195111961119711198111991120011201112021120311204112051120611207112081120911210112111121211213112141121511216112171121811219112201122111222112231122411225112261122711228112291123011231112321123311234112351123611237112381123911240112411124211243112441124511246112471124811249112501125111252112531125411255112561125711258112591126011261112621126311264112651126611267112681126911270112711127211273112741127511276112771127811279112801128111282112831128411285112861128711288112891129011291112921129311294112951129611297112981129911300113011130211303113041130511306113071130811309113101131111312113131131411315113161131711318113191132011321113221132311324113251132611327113281132911330113311133211333113341133511336113371133811339113401134111342113431134411345113461134711348113491135011351113521135311354113551135611357113581135911360113611136211363113641136511366113671136811369113701137111372113731137411375113761137711378113791138011381113821138311384113851138611387113881138911390113911139211393113941139511396113971139811399114001140111402114031140411405114061140711408114091141011411114121141311414114151141611417114181141911420114211142211423114241142511426114271142811429114301143111432114331143411435114361143711438114391144011441114421144311444114451144611447114481144911450114511145211453114541145511456114571145811459114601146111462114631146411465114661146711468114691147011471114721147311474114751147611477114781147911480114811148211483114841148511486114871148811489114901149111492114931149411495114961149711498114991150011501115021150311504115051150611507115081150911510115111151211513115141151511516115171151811519115201152111522115231152411525115261152711528115291153011531115321153311534115351153611537115381153911540115411154211543115441154511546115471154811549115501155111552115531155411555115561155711558115591156011561115621156311564115651156611567115681156911570115711157211573115741157511576115771157811579115801158111582115831158411585115861158711588115891159011591115921159311594115951159611597115981159911600116011160211603116041160511606116071160811609116101161111612116131161411615116161161711618116191162011621116221162311624116251162611627116281162911630116311163211633116341163511636116371163811639116401164111642116431164411645116461164711648116491165011651116521165311654116551165611657116581165911660116611166211663116641166511666116671166811669116701167111672116731167411675116761167711678116791168011681116821168311684116851168611687116881168911690116911169211693116941169511696116971169811699117001170111702117031170411705117061170711708117091171011711117121171311714117151171611717117181171911720117211172211723117241172511726117271172811729117301173111732117331173411735117361173711738117391174011741117421174311744117451174611747117481174911750117511175211753117541175511756117571175811759117601176111762117631176411765117661176711768117691177011771117721177311774117751177611777117781177911780117811178211783117841178511786117871178811789117901179111792117931179411795117961179711798117991180011801118021180311804118051180611807118081180911810118111181211813118141181511816118171181811819118201182111822118231182411825118261182711828118291183011831118321183311834118351183611837118381183911840118411184211843118441184511846118471184811849118501185111852118531185411855118561185711858118591186011861118621186311864118651186611867118681186911870118711187211873118741187511876118771187811879118801188111882118831188411885118861188711888118891189011891118921189311894118951189611897118981189911900119011190211903119041190511906119071190811909119101191111912119131191411915119161191711918119191192011921119221192311924119251192611927119281192911930119311193211933119341193511936119371193811939119401194111942119431194411945119461194711948119491195011951119521195311954119551195611957119581195911960119611196211963119641196511966119671196811969119701197111972119731197411975119761197711978119791198011981119821198311984119851198611987119881198911990119911199211993119941199511996119971199811999120001200112002120031200412005120061200712008120091201012011120121201312014120151201612017120181201912020120211202212023120241202512026120271202812029120301203112032120331203412035120361203712038120391204012041120421204312044120451204612047120481204912050120511205212053120541205512056120571205812059120601206112062120631206412065120661206712068120691207012071120721207312074120751207612077120781207912080120811208212083120841208512086120871208812089120901209112092120931209412095120961209712098120991210012101121021210312104121051210612107121081210912110121111211212113121141211512116121171211812119121201212112122121231212412125121261212712128121291213012131121321213312134121351213612137121381213912140121411214212143121441214512146121471214812149121501215112152121531215412155121561215712158121591216012161121621216312164121651216612167121681216912170121711217212173121741217512176121771217812179121801218112182121831218412185121861218712188121891219012191121921219312194121951219612197121981219912200122011220212203122041220512206122071220812209122101221112212122131221412215122161221712218122191222012221122221222312224122251222612227122281222912230122311223212233122341223512236122371223812239122401224112242122431224412245122461224712248122491225012251122521225312254122551225612257122581225912260122611226212263122641226512266122671226812269122701227112272122731227412275122761227712278122791228012281122821228312284122851228612287122881228912290122911229212293122941229512296122971229812299123001230112302123031230412305123061230712308123091231012311123121231312314123151231612317123181231912320123211232212323123241232512326123271232812329123301233112332123331233412335123361233712338123391234012341123421234312344123451234612347123481234912350123511235212353123541235512356123571235812359123601236112362123631236412365123661236712368123691237012371123721237312374123751237612377123781237912380123811238212383123841238512386123871238812389123901239112392123931239412395123961239712398123991240012401124021240312404124051240612407124081240912410124111241212413124141241512416124171241812419124201242112422124231242412425124261242712428124291243012431124321243312434124351243612437124381243912440124411244212443124441244512446124471244812449124501245112452124531245412455124561245712458124591246012461124621246312464124651246612467124681246912470124711247212473124741247512476124771247812479124801248112482124831248412485124861248712488124891249012491124921249312494124951249612497124981249912500125011250212503125041250512506125071250812509125101251112512125131251412515125161251712518125191252012521125221252312524125251252612527125281252912530125311253212533125341253512536125371253812539125401254112542125431254412545125461254712548125491255012551125521255312554125551255612557125581255912560125611256212563125641256512566125671256812569125701257112572125731257412575125761257712578125791258012581125821258312584125851258612587125881258912590125911259212593125941259512596125971259812599126001260112602126031260412605126061260712608126091261012611126121261312614126151261612617126181261912620126211262212623126241262512626126271262812629126301263112632126331263412635126361263712638126391264012641126421264312644126451264612647126481264912650126511265212653126541265512656126571265812659126601266112662126631266412665126661266712668126691267012671126721267312674126751267612677126781267912680126811268212683126841268512686126871268812689126901269112692126931269412695126961269712698126991270012701127021270312704127051270612707127081270912710127111271212713127141271512716127171271812719127201272112722127231272412725127261272712728127291273012731127321273312734127351273612737127381273912740127411274212743127441274512746127471274812749127501275112752127531275412755127561275712758127591276012761127621276312764127651276612767127681276912770127711277212773127741277512776127771277812779127801278112782127831278412785127861278712788127891279012791127921279312794127951279612797127981279912800128011280212803128041280512806128071280812809128101281112812128131281412815128161281712818128191282012821128221282312824128251282612827128281282912830128311283212833128341283512836128371283812839128401284112842128431284412845128461284712848128491285012851128521285312854128551285612857128581285912860128611286212863128641286512866128671286812869128701287112872128731287412875128761287712878128791288012881128821288312884128851288612887128881288912890128911289212893128941289512896128971289812899129001290112902129031290412905129061290712908129091291012911129121291312914129151291612917129181291912920129211292212923129241292512926129271292812929129301293112932129331293412935129361293712938129391294012941129421294312944129451294612947129481294912950129511295212953129541295512956129571295812959129601296112962129631296412965129661296712968129691297012971129721297312974129751297612977129781297912980129811298212983129841298512986129871298812989129901299112992129931299412995129961299712998129991300013001130021300313004130051300613007130081300913010130111301213013130141301513016130171301813019130201302113022130231302413025130261302713028130291303013031130321303313034130351303613037130381303913040130411304213043130441304513046130471304813049130501305113052130531305413055130561305713058130591306013061130621306313064130651306613067130681306913070130711307213073130741307513076130771307813079130801308113082130831308413085130861308713088130891309013091130921309313094130951309613097130981309913100131011310213103131041310513106131071310813109131101311113112131131311413115131161311713118131191312013121131221312313124131251312613127131281312913130131311313213133131341313513136131371313813139131401314113142131431314413145131461314713148131491315013151131521315313154131551315613157131581315913160131611316213163131641316513166131671316813169131701317113172131731317413175131761317713178131791318013181131821318313184131851318613187131881318913190131911319213193131941319513196131971319813199132001320113202132031320413205132061320713208132091321013211132121321313214132151321613217132181321913220132211322213223132241322513226132271322813229132301323113232132331323413235132361323713238132391324013241132421324313244132451324613247132481324913250132511325213253132541325513256132571325813259132601326113262132631326413265132661326713268132691327013271132721327313274132751327613277132781327913280132811328213283132841328513286132871328813289132901329113292132931329413295132961329713298132991330013301133021330313304133051330613307133081330913310133111331213313133141331513316133171331813319133201332113322133231332413325133261332713328133291333013331133321333313334133351333613337133381333913340133411334213343133441334513346133471334813349133501335113352133531335413355133561335713358133591336013361133621336313364133651336613367133681336913370133711337213373133741337513376133771337813379133801338113382133831338413385133861338713388133891339013391133921339313394133951339613397133981339913400134011340213403134041340513406134071340813409134101341113412134131341413415134161341713418134191342013421134221342313424134251342613427134281342913430134311343213433134341343513436134371343813439134401344113442134431344413445134461344713448134491345013451134521345313454134551345613457134581345913460134611346213463134641346513466134671346813469134701347113472134731347413475134761347713478134791348013481134821348313484134851348613487134881348913490134911349213493134941349513496134971349813499135001350113502135031350413505135061350713508135091351013511135121351313514135151351613517135181351913520135211352213523135241352513526135271352813529135301353113532135331353413535135361353713538135391354013541135421354313544135451354613547135481354913550135511355213553135541355513556135571355813559135601356113562135631356413565135661356713568135691357013571135721357313574135751357613577135781357913580135811358213583135841358513586135871358813589135901359113592135931359413595135961359713598135991360013601136021360313604136051360613607136081360913610136111361213613136141361513616136171361813619136201362113622136231362413625136261362713628136291363013631136321363313634136351363613637136381363913640136411364213643136441364513646136471364813649136501365113652136531365413655136561365713658136591366013661136621366313664136651366613667136681366913670136711367213673136741367513676136771367813679136801368113682136831368413685136861368713688136891369013691136921369313694136951369613697136981369913700137011370213703137041370513706137071370813709137101371113712137131371413715137161371713718137191372013721137221372313724137251372613727137281372913730137311373213733137341373513736137371373813739137401374113742137431374413745137461374713748137491375013751137521375313754137551375613757137581375913760137611376213763137641376513766137671376813769137701377113772137731377413775137761377713778137791378013781137821378313784137851378613787137881378913790137911379213793137941379513796137971379813799138001380113802138031380413805138061380713808138091381013811138121381313814138151381613817138181381913820138211382213823138241382513826138271382813829138301383113832138331383413835138361383713838138391384013841138421384313844138451384613847138481384913850138511385213853138541385513856138571385813859138601386113862138631386413865138661386713868138691387013871138721387313874138751387613877138781387913880138811388213883138841388513886138871388813889138901389113892138931389413895138961389713898138991390013901139021390313904139051390613907139081390913910139111391213913139141391513916139171391813919139201392113922139231392413925139261392713928139291393013931139321393313934139351393613937139381393913940139411394213943139441394513946139471394813949139501395113952139531395413955139561395713958139591396013961139621396313964139651396613967139681396913970139711397213973139741397513976139771397813979139801398113982139831398413985139861398713988139891399013991139921399313994139951399613997139981399914000140011400214003140041400514006140071400814009140101401114012140131401414015140161401714018140191402014021140221402314024140251402614027140281402914030140311403214033140341403514036140371403814039140401404114042140431404414045140461404714048140491405014051140521405314054140551405614057140581405914060140611406214063140641406514066140671406814069140701407114072140731407414075140761407714078140791408014081140821408314084140851408614087140881408914090140911409214093140941409514096140971409814099141001410114102141031410414105141061410714108141091411014111141121411314114141151411614117141181411914120141211412214123141241412514126141271412814129141301413114132141331413414135141361413714138141391414014141141421414314144141451414614147141481414914150141511415214153141541415514156141571415814159141601416114162141631416414165141661416714168141691417014171141721417314174141751417614177141781417914180141811418214183141841418514186141871418814189141901419114192141931419414195141961419714198141991420014201142021420314204142051420614207142081420914210142111421214213142141421514216142171421814219142201422114222142231422414225142261422714228142291423014231142321423314234142351423614237142381423914240142411424214243142441424514246142471424814249142501425114252142531425414255142561425714258142591426014261142621426314264142651426614267142681426914270142711427214273142741427514276142771427814279142801428114282142831428414285142861428714288142891429014291142921429314294142951429614297142981429914300143011430214303143041430514306143071430814309143101431114312143131431414315143161431714318143191432014321143221432314324143251432614327143281432914330143311433214333143341433514336143371433814339143401434114342143431434414345143461434714348143491435014351143521435314354143551435614357143581435914360143611436214363143641436514366143671436814369143701437114372143731437414375143761437714378143791438014381143821438314384143851438614387143881438914390143911439214393143941439514396143971439814399144001440114402144031440414405144061440714408144091441014411144121441314414144151441614417144181441914420144211442214423144241442514426144271442814429144301443114432144331443414435144361443714438144391444014441144421444314444144451444614447144481444914450144511445214453144541445514456144571445814459144601446114462144631446414465144661446714468144691447014471144721447314474144751447614477144781447914480144811448214483144841448514486144871448814489144901449114492144931449414495144961449714498144991450014501145021450314504145051450614507145081450914510145111451214513145141451514516145171451814519145201452114522145231452414525145261452714528145291453014531145321453314534145351453614537145381453914540145411454214543145441454514546145471454814549145501455114552145531455414555145561455714558145591456014561145621456314564145651456614567145681456914570145711457214573145741457514576145771457814579145801458114582145831458414585145861458714588145891459014591145921459314594145951459614597145981459914600146011460214603146041460514606146071460814609146101461114612146131461414615146161461714618146191462014621146221462314624146251462614627146281462914630146311463214633146341463514636146371463814639146401464114642146431464414645146461464714648146491465014651146521465314654146551465614657146581465914660146611466214663146641466514666146671466814669146701467114672146731467414675146761467714678146791468014681146821468314684146851468614687146881468914690146911469214693146941469514696146971469814699147001470114702147031470414705147061470714708147091471014711147121471314714147151471614717147181471914720147211472214723147241472514726147271472814729147301473114732147331473414735147361473714738147391474014741147421474314744147451474614747147481474914750147511475214753147541475514756147571475814759147601476114762147631476414765147661476714768147691477014771147721477314774147751477614777147781477914780147811478214783147841478514786147871478814789147901479114792147931479414795147961479714798147991480014801148021480314804148051480614807148081480914810148111481214813148141481514816148171481814819148201482114822148231482414825148261482714828148291483014831148321483314834148351483614837148381483914840148411484214843148441484514846148471484814849148501485114852148531485414855148561485714858148591486014861148621486314864148651486614867148681486914870148711487214873148741487514876148771487814879148801488114882148831488414885148861488714888148891489014891148921489314894148951489614897148981489914900149011490214903149041490514906149071490814909149101491114912149131491414915149161491714918149191492014921149221492314924149251492614927149281492914930149311493214933149341493514936149371493814939149401494114942149431494414945149461494714948149491495014951149521495314954149551495614957149581495914960149611496214963149641496514966149671496814969149701497114972149731497414975149761497714978149791498014981149821498314984149851498614987149881498914990149911499214993149941499514996149971499814999150001500115002150031500415005150061500715008150091501015011150121501315014150151501615017150181501915020150211502215023150241502515026150271502815029150301503115032150331503415035150361503715038150391504015041150421504315044150451504615047150481504915050150511505215053150541505515056150571505815059150601506115062150631506415065150661506715068150691507015071150721507315074150751507615077150781507915080150811508215083150841508515086150871508815089150901509115092150931509415095150961509715098150991510015101151021510315104151051510615107151081510915110151111511215113151141511515116151171511815119151201512115122151231512415125151261512715128151291513015131151321513315134151351513615137151381513915140151411514215143151441514515146151471514815149151501515115152151531515415155151561515715158151591516015161151621516315164151651516615167151681516915170151711517215173151741517515176151771517815179151801518115182151831518415185151861518715188151891519015191151921519315194151951519615197151981519915200152011520215203152041520515206152071520815209152101521115212152131521415215152161521715218152191522015221152221522315224152251522615227152281522915230152311523215233152341523515236152371523815239152401524115242152431524415245152461524715248152491525015251152521525315254152551525615257152581525915260152611526215263152641526515266152671526815269152701527115272152731527415275152761527715278152791528015281152821528315284152851528615287152881528915290152911529215293152941529515296152971529815299153001530115302153031530415305153061530715308153091531015311153121531315314153151531615317153181531915320153211532215323153241532515326153271532815329153301533115332153331533415335153361533715338153391534015341153421534315344153451534615347153481534915350153511535215353153541535515356153571535815359153601536115362153631536415365153661536715368153691537015371153721537315374153751537615377153781537915380153811538215383153841538515386153871538815389153901539115392153931539415395153961539715398153991540015401154021540315404154051540615407154081540915410154111541215413154141541515416154171541815419154201542115422154231542415425154261542715428154291543015431154321543315434154351543615437154381543915440154411544215443154441544515446154471544815449154501545115452154531545415455154561545715458154591546015461154621546315464154651546615467154681546915470154711547215473154741547515476154771547815479154801548115482154831548415485154861548715488154891549015491154921549315494154951549615497154981549915500155011550215503155041550515506155071550815509155101551115512155131551415515155161551715518155191552015521155221552315524155251552615527155281552915530155311553215533155341553515536155371553815539155401554115542155431554415545155461554715548155491555015551155521555315554155551555615557155581555915560155611556215563155641556515566155671556815569155701557115572155731557415575155761557715578155791558015581155821558315584155851558615587155881558915590155911559215593155941559515596155971559815599156001560115602156031560415605156061560715608156091561015611156121561315614156151561615617156181561915620156211562215623156241562515626156271562815629156301563115632156331563415635156361563715638156391564015641156421564315644156451564615647156481564915650156511565215653156541565515656156571565815659156601566115662156631566415665156661566715668156691567015671156721567315674156751567615677156781567915680156811568215683156841568515686156871568815689156901569115692156931569415695156961569715698156991570015701157021570315704157051570615707157081570915710157111571215713157141571515716157171571815719157201572115722157231572415725157261572715728157291573015731157321573315734157351573615737157381573915740157411574215743157441574515746157471574815749157501575115752157531575415755157561575715758157591576015761157621576315764157651576615767157681576915770157711577215773157741577515776157771577815779157801578115782157831578415785157861578715788157891579015791157921579315794157951579615797157981579915800158011580215803158041580515806158071580815809158101581115812158131581415815158161581715818158191582015821158221582315824158251582615827158281582915830158311583215833158341583515836158371583815839158401584115842158431584415845158461584715848158491585015851158521585315854158551585615857158581585915860158611586215863158641586515866158671586815869158701587115872158731587415875158761587715878158791588015881158821588315884158851588615887158881588915890158911589215893158941589515896158971589815899159001590115902159031590415905159061590715908159091591015911159121591315914159151591615917159181591915920159211592215923159241592515926159271592815929159301593115932159331593415935159361593715938159391594015941159421594315944159451594615947159481594915950159511595215953159541595515956159571595815959159601596115962159631596415965159661596715968159691597015971159721597315974159751597615977159781597915980159811598215983159841598515986159871598815989159901599115992159931599415995159961599715998159991600016001160021600316004160051600616007160081600916010160111601216013160141601516016160171601816019160201602116022160231602416025160261602716028160291603016031160321603316034160351603616037160381603916040160411604216043160441604516046160471604816049160501605116052160531605416055160561605716058160591606016061160621606316064160651606616067160681606916070160711607216073160741607516076160771607816079160801608116082160831608416085160861608716088160891609016091160921609316094160951609616097160981609916100161011610216103161041610516106161071610816109161101611116112161131611416115161161611716118161191612016121161221612316124161251612616127161281612916130161311613216133161341613516136161371613816139161401614116142161431614416145161461614716148161491615016151161521615316154161551615616157161581615916160161611616216163161641616516166161671616816169161701617116172161731617416175161761617716178161791618016181161821618316184161851618616187161881618916190161911619216193161941619516196161971619816199162001620116202162031620416205162061620716208162091621016211162121621316214162151621616217162181621916220162211622216223162241622516226162271622816229162301623116232162331623416235162361623716238162391624016241162421624316244162451624616247162481624916250162511625216253162541625516256162571625816259162601626116262162631626416265162661626716268162691627016271162721627316274162751627616277162781627916280162811628216283162841628516286162871628816289162901629116292162931629416295162961629716298162991630016301163021630316304163051630616307163081630916310163111631216313163141631516316163171631816319163201632116322163231632416325163261632716328163291633016331163321633316334163351633616337163381633916340163411634216343163441634516346163471634816349163501635116352163531635416355163561635716358163591636016361163621636316364163651636616367163681636916370163711637216373163741637516376163771637816379163801638116382163831638416385163861638716388163891639016391163921639316394163951639616397163981639916400164011640216403164041640516406164071640816409164101641116412164131641416415164161641716418164191642016421164221642316424164251642616427164281642916430164311643216433164341643516436164371643816439164401644116442164431644416445164461644716448164491645016451164521645316454164551645616457164581645916460164611646216463164641646516466164671646816469164701647116472164731647416475164761647716478164791648016481164821648316484164851648616487164881648916490164911649216493164941649516496164971649816499165001650116502165031650416505165061650716508165091651016511165121651316514165151651616517165181651916520165211652216523165241652516526165271652816529165301653116532165331653416535165361653716538165391654016541165421654316544165451654616547165481654916550165511655216553165541655516556165571655816559165601656116562165631656416565165661656716568165691657016571165721657316574165751657616577165781657916580165811658216583165841658516586165871658816589165901659116592165931659416595165961659716598165991660016601166021660316604166051660616607166081660916610166111661216613166141661516616166171661816619166201662116622166231662416625166261662716628166291663016631166321663316634166351663616637166381663916640166411664216643166441664516646166471664816649166501665116652166531665416655166561665716658166591666016661166621666316664166651666616667166681666916670166711667216673166741667516676166771667816679166801668116682166831668416685166861668716688166891669016691166921669316694166951669616697166981669916700167011670216703167041670516706167071670816709167101671116712167131671416715167161671716718167191672016721167221672316724167251672616727167281672916730167311673216733167341673516736167371673816739167401674116742167431674416745167461674716748167491675016751167521675316754167551675616757167581675916760167611676216763167641676516766167671676816769167701677116772167731677416775167761677716778167791678016781167821678316784167851678616787167881678916790167911679216793167941679516796167971679816799168001680116802168031680416805168061680716808168091681016811168121681316814168151681616817168181681916820168211682216823168241682516826168271682816829168301683116832168331683416835168361683716838168391684016841168421684316844168451684616847168481684916850168511685216853168541685516856168571685816859168601686116862168631686416865168661686716868168691687016871168721687316874168751687616877168781687916880168811688216883168841688516886168871688816889168901689116892168931689416895168961689716898168991690016901169021690316904169051690616907169081690916910169111691216913169141691516916169171691816919169201692116922169231692416925169261692716928169291693016931169321693316934169351693616937169381693916940169411694216943169441694516946169471694816949169501695116952169531695416955169561695716958169591696016961169621696316964169651696616967169681696916970169711697216973169741697516976169771697816979169801698116982169831698416985169861698716988169891699016991169921699316994169951699616997169981699917000170011700217003170041700517006170071700817009170101701117012170131701417015170161701717018170191702017021170221702317024170251702617027170281702917030170311703217033170341703517036170371703817039170401704117042170431704417045170461704717048170491705017051170521705317054170551705617057170581705917060170611706217063170641706517066170671706817069170701707117072170731707417075170761707717078170791708017081170821708317084170851708617087170881708917090170911709217093170941709517096170971709817099171001710117102171031710417105171061710717108171091711017111171121711317114171151711617117171181711917120171211712217123171241712517126171271712817129171301713117132171331713417135171361713717138171391714017141171421714317144171451714617147171481714917150171511715217153171541715517156171571715817159171601716117162171631716417165171661716717168171691717017171171721717317174171751717617177171781717917180171811718217183171841718517186171871718817189171901719117192171931719417195171961719717198171991720017201172021720317204172051720617207172081720917210172111721217213172141721517216172171721817219172201722117222172231722417225172261722717228172291723017231172321723317234172351723617237172381723917240172411724217243172441724517246172471724817249172501725117252172531725417255172561725717258172591726017261172621726317264172651726617267172681726917270172711727217273172741727517276172771727817279172801728117282172831728417285172861728717288172891729017291172921729317294172951729617297172981729917300173011730217303173041730517306173071730817309173101731117312173131731417315173161731717318173191732017321173221732317324173251732617327173281732917330173311733217333173341733517336173371733817339173401734117342173431734417345173461734717348173491735017351173521735317354173551735617357173581735917360173611736217363173641736517366173671736817369173701737117372173731737417375173761737717378173791738017381173821738317384173851738617387173881738917390173911739217393173941739517396173971739817399174001740117402174031740417405174061740717408174091741017411174121741317414174151741617417174181741917420174211742217423174241742517426174271742817429174301743117432174331743417435174361743717438174391744017441174421744317444174451744617447174481744917450174511745217453174541745517456174571745817459174601746117462174631746417465174661746717468174691747017471174721747317474174751747617477174781747917480174811748217483174841748517486174871748817489174901749117492174931749417495174961749717498174991750017501175021750317504175051750617507175081750917510175111751217513175141751517516175171751817519175201752117522175231752417525175261752717528175291753017531175321753317534175351753617537175381753917540175411754217543175441754517546175471754817549175501755117552175531755417555175561755717558175591756017561175621756317564175651756617567175681756917570175711757217573175741757517576175771757817579175801758117582175831758417585175861758717588175891759017591175921759317594175951759617597175981759917600176011760217603176041760517606176071760817609176101761117612176131761417615176161761717618176191762017621176221762317624176251762617627176281762917630176311763217633176341763517636176371763817639176401764117642176431764417645176461764717648176491765017651176521765317654176551765617657176581765917660176611766217663176641766517666176671766817669176701767117672176731767417675176761767717678176791768017681176821768317684176851768617687176881768917690176911769217693176941769517696176971769817699177001770117702177031770417705177061770717708177091771017711177121771317714177151771617717177181771917720177211772217723177241772517726177271772817729177301773117732177331773417735177361773717738177391774017741177421774317744177451774617747177481774917750177511775217753177541775517756177571775817759177601776117762177631776417765177661776717768177691777017771177721777317774177751777617777177781777917780177811778217783177841778517786177871778817789177901779117792177931779417795177961779717798177991780017801178021780317804178051780617807178081780917810178111781217813178141781517816178171781817819178201782117822178231782417825178261782717828178291783017831178321783317834178351783617837178381783917840178411784217843178441784517846178471784817849178501785117852178531785417855178561785717858178591786017861178621786317864178651786617867178681786917870178711787217873178741787517876178771787817879178801788117882178831788417885178861788717888178891789017891178921789317894178951789617897178981789917900179011790217903179041790517906179071790817909179101791117912179131791417915179161791717918179191792017921179221792317924179251792617927179281792917930179311793217933179341793517936179371793817939179401794117942179431794417945179461794717948179491795017951179521795317954179551795617957179581795917960179611796217963179641796517966179671796817969179701797117972179731797417975179761797717978179791798017981179821798317984179851798617987179881798917990179911799217993179941799517996179971799817999180001800118002180031800418005180061800718008180091801018011180121801318014180151801618017180181801918020180211802218023180241802518026180271802818029180301803118032180331803418035180361803718038180391804018041180421804318044180451804618047180481804918050180511805218053180541805518056180571805818059180601806118062180631806418065180661806718068180691807018071180721807318074180751807618077180781807918080180811808218083180841808518086180871808818089180901809118092180931809418095180961809718098180991810018101181021810318104181051810618107181081810918110181111811218113181141811518116181171811818119181201812118122181231812418125181261812718128181291813018131181321813318134181351813618137181381813918140181411814218143181441814518146181471814818149181501815118152181531815418155181561815718158181591816018161181621816318164181651816618167181681816918170181711817218173181741817518176181771817818179181801818118182181831818418185181861818718188181891819018191181921819318194181951819618197181981819918200182011820218203182041820518206182071820818209182101821118212182131821418215182161821718218182191822018221182221822318224182251822618227182281822918230182311823218233182341823518236182371823818239182401824118242182431824418245182461824718248182491825018251182521825318254182551825618257182581825918260182611826218263182641826518266182671826818269182701827118272182731827418275182761827718278182791828018281182821828318284182851828618287182881828918290182911829218293182941829518296182971829818299183001830118302183031830418305183061830718308183091831018311183121831318314183151831618317183181831918320183211832218323183241832518326183271832818329183301833118332183331833418335183361833718338183391834018341183421834318344183451834618347183481834918350183511835218353183541835518356183571835818359183601836118362183631836418365183661836718368183691837018371183721837318374183751837618377183781837918380183811838218383183841838518386183871838818389183901839118392183931839418395183961839718398183991840018401184021840318404184051840618407184081840918410184111841218413184141841518416184171841818419184201842118422184231842418425184261842718428184291843018431184321843318434184351843618437184381843918440184411844218443184441844518446184471844818449184501845118452184531845418455184561845718458184591846018461184621846318464184651846618467184681846918470184711847218473184741847518476184771847818479184801848118482184831848418485184861848718488184891849018491184921849318494184951849618497184981849918500185011850218503185041850518506185071850818509185101851118512185131851418515185161851718518185191852018521185221852318524185251852618527185281852918530185311853218533185341853518536185371853818539185401854118542185431854418545185461854718548185491855018551185521855318554185551855618557185581855918560185611856218563185641856518566185671856818569185701857118572185731857418575185761857718578185791858018581185821858318584185851858618587185881858918590185911859218593185941859518596185971859818599186001860118602186031860418605186061860718608186091861018611186121861318614186151861618617186181861918620186211862218623186241862518626186271862818629186301863118632186331863418635186361863718638186391864018641186421864318644186451864618647186481864918650186511865218653186541865518656186571865818659186601866118662186631866418665186661866718668186691867018671186721867318674186751867618677186781867918680186811868218683186841868518686186871868818689186901869118692186931869418695186961869718698186991870018701187021870318704187051870618707187081870918710187111871218713187141871518716187171871818719187201872118722187231872418725187261872718728187291873018731187321873318734187351873618737187381873918740187411874218743187441874518746187471874818749187501875118752187531875418755187561875718758187591876018761187621876318764187651876618767187681876918770187711877218773187741877518776187771877818779187801878118782187831878418785187861878718788187891879018791187921879318794187951879618797187981879918800188011880218803188041880518806188071880818809188101881118812188131881418815188161881718818188191882018821188221882318824188251882618827188281882918830188311883218833188341883518836188371883818839188401884118842188431884418845188461884718848188491885018851188521885318854188551885618857188581885918860188611886218863188641886518866188671886818869188701887118872188731887418875188761887718878188791888018881188821888318884188851888618887188881888918890188911889218893188941889518896188971889818899189001890118902189031890418905189061890718908189091891018911189121891318914189151891618917189181891918920189211892218923189241892518926189271892818929189301893118932189331893418935189361893718938189391894018941189421894318944189451894618947189481894918950189511895218953189541895518956189571895818959189601896118962189631896418965189661896718968189691897018971189721897318974189751897618977189781897918980189811898218983189841898518986189871898818989189901899118992189931899418995189961899718998189991900019001190021900319004190051900619007190081900919010190111901219013190141901519016190171901819019190201902119022190231902419025190261902719028190291903019031190321903319034190351903619037190381903919040190411904219043190441904519046190471904819049190501905119052190531905419055190561905719058190591906019061190621906319064190651906619067190681906919070190711907219073190741907519076190771907819079190801908119082190831908419085190861908719088190891909019091190921909319094190951909619097190981909919100191011910219103191041910519106191071910819109191101911119112191131911419115191161911719118191191912019121191221912319124191251912619127191281912919130191311913219133191341913519136191371913819139191401914119142191431914419145191461914719148191491915019151191521915319154191551915619157191581915919160191611916219163191641916519166191671916819169191701917119172191731917419175191761917719178191791918019181191821918319184191851918619187191881918919190191911919219193191941919519196191971919819199192001920119202192031920419205192061920719208192091921019211192121921319214192151921619217192181921919220192211922219223192241922519226192271922819229192301923119232192331923419235192361923719238192391924019241192421924319244192451924619247192481924919250192511925219253192541925519256192571925819259192601926119262192631926419265192661926719268192691927019271192721927319274192751927619277192781927919280192811928219283192841928519286192871928819289192901929119292192931929419295192961929719298192991930019301193021930319304193051930619307193081930919310193111931219313193141931519316193171931819319193201932119322193231932419325193261932719328193291933019331193321933319334193351933619337193381933919340193411934219343193441934519346193471934819349193501935119352193531935419355193561935719358193591936019361193621936319364193651936619367193681936919370193711937219373193741937519376193771937819379193801938119382193831938419385193861938719388193891939019391193921939319394193951939619397193981939919400194011940219403194041940519406194071940819409194101941119412194131941419415194161941719418194191942019421194221942319424194251942619427194281942919430194311943219433194341943519436194371943819439194401944119442194431944419445194461944719448194491945019451194521945319454194551945619457194581945919460194611946219463194641946519466194671946819469194701947119472194731947419475194761947719478194791948019481194821948319484194851948619487194881948919490194911949219493194941949519496194971949819499195001950119502195031950419505195061950719508195091951019511195121951319514195151951619517195181951919520195211952219523195241952519526195271952819529195301953119532195331953419535195361953719538195391954019541195421954319544195451954619547195481954919550195511955219553195541955519556195571955819559195601956119562195631956419565195661956719568195691957019571195721957319574195751957619577195781957919580195811958219583195841958519586195871958819589195901959119592195931959419595195961959719598195991960019601196021960319604196051960619607196081960919610196111961219613196141961519616196171961819619196201962119622196231962419625196261962719628196291963019631196321963319634196351963619637196381963919640196411964219643196441964519646196471964819649196501965119652196531965419655196561965719658196591966019661196621966319664196651966619667196681966919670196711967219673196741967519676196771967819679196801968119682196831968419685196861968719688196891969019691196921969319694196951969619697196981969919700197011970219703197041970519706197071970819709197101971119712197131971419715197161971719718197191972019721197221972319724197251972619727197281972919730197311973219733197341973519736197371973819739197401974119742197431974419745197461974719748197491975019751197521975319754197551975619757197581975919760197611976219763197641976519766197671976819769197701977119772197731977419775197761977719778197791978019781197821978319784197851978619787197881978919790197911979219793197941979519796197971979819799198001980119802198031980419805198061980719808198091981019811198121981319814198151981619817198181981919820198211982219823198241982519826198271982819829198301983119832198331983419835198361983719838198391984019841198421984319844198451984619847198481984919850198511985219853198541985519856198571985819859198601986119862198631986419865198661986719868198691987019871198721987319874198751987619877198781987919880198811988219883198841988519886198871988819889198901989119892198931989419895198961989719898198991990019901199021990319904199051990619907199081990919910199111991219913199141991519916199171991819919199201992119922199231992419925199261992719928199291993019931199321993319934199351993619937199381993919940199411994219943199441994519946199471994819949199501995119952199531995419955199561995719958199591996019961199621996319964199651996619967199681996919970199711997219973199741997519976199771997819979199801998119982199831998419985199861998719988199891999019991199921999319994199951999619997199981999920000200012000220003200042000520006200072000820009200102001120012200132001420015200162001720018200192002020021200222002320024200252002620027200282002920030200312003220033200342003520036200372003820039200402004120042200432004420045200462004720048200492005020051200522005320054200552005620057200582005920060200612006220063200642006520066200672006820069200702007120072200732007420075200762007720078200792008020081200822008320084200852008620087200882008920090200912009220093200942009520096200972009820099201002010120102201032010420105201062010720108201092011020111201122011320114201152011620117201182011920120201212012220123201242012520126201272012820129201302013120132201332013420135201362013720138201392014020141201422014320144201452014620147201482014920150201512015220153201542015520156201572015820159201602016120162201632016420165201662016720168201692017020171201722017320174201752017620177201782017920180201812018220183201842018520186201872018820189201902019120192201932019420195201962019720198201992020020201202022020320204202052020620207202082020920210202112021220213202142021520216202172021820219202202022120222202232022420225202262022720228202292023020231202322023320234202352023620237202382023920240202412024220243202442024520246202472024820249202502025120252202532025420255202562025720258202592026020261202622026320264202652026620267202682026920270202712027220273202742027520276202772027820279202802028120282202832028420285202862028720288202892029020291202922029320294202952029620297202982029920300203012030220303203042030520306203072030820309203102031120312203132031420315203162031720318203192032020321203222032320324203252032620327203282032920330203312033220333203342033520336203372033820339203402034120342203432034420345203462034720348203492035020351203522035320354203552035620357203582035920360203612036220363203642036520366203672036820369203702037120372203732037420375203762037720378203792038020381203822038320384203852038620387203882038920390203912039220393203942039520396203972039820399204002040120402204032040420405204062040720408204092041020411204122041320414204152041620417204182041920420204212042220423204242042520426204272042820429204302043120432204332043420435204362043720438204392044020441204422044320444204452044620447204482044920450204512045220453204542045520456204572045820459204602046120462204632046420465204662046720468204692047020471204722047320474204752047620477204782047920480204812048220483204842048520486204872048820489204902049120492204932049420495204962049720498204992050020501205022050320504205052050620507205082050920510205112051220513205142051520516205172051820519205202052120522205232052420525205262052720528205292053020531205322053320534205352053620537205382053920540205412054220543205442054520546205472054820549205502055120552205532055420555205562055720558205592056020561205622056320564205652056620567205682056920570205712057220573205742057520576205772057820579205802058120582205832058420585205862058720588205892059020591205922059320594205952059620597205982059920600206012060220603206042060520606206072060820609206102061120612206132061420615206162061720618206192062020621206222062320624206252062620627206282062920630206312063220633206342063520636206372063820639206402064120642206432064420645206462064720648206492065020651206522065320654206552065620657206582065920660206612066220663206642066520666206672066820669206702067120672206732067420675206762067720678206792068020681206822068320684206852068620687206882068920690206912069220693206942069520696206972069820699207002070120702207032070420705207062070720708207092071020711207122071320714207152071620717207182071920720207212072220723207242072520726207272072820729207302073120732207332073420735207362073720738207392074020741207422074320744207452074620747207482074920750207512075220753207542075520756207572075820759207602076120762207632076420765207662076720768207692077020771207722077320774207752077620777207782077920780207812078220783207842078520786207872078820789207902079120792207932079420795207962079720798207992080020801208022080320804208052080620807208082080920810208112081220813208142081520816208172081820819208202082120822208232082420825208262082720828208292083020831208322083320834208352083620837208382083920840208412084220843208442084520846208472084820849208502085120852208532085420855208562085720858208592086020861208622086320864208652086620867208682086920870208712087220873208742087520876208772087820879208802088120882208832088420885208862088720888208892089020891208922089320894208952089620897208982089920900209012090220903209042090520906209072090820909209102091120912209132091420915209162091720918209192092020921209222092320924209252092620927209282092920930209312093220933209342093520936209372093820939209402094120942209432094420945209462094720948209492095020951209522095320954209552095620957209582095920960209612096220963209642096520966209672096820969209702097120972209732097420975209762097720978209792098020981209822098320984209852098620987209882098920990209912099220993209942099520996209972099820999210002100121002210032100421005210062100721008210092101021011210122101321014210152101621017210182101921020210212102221023210242102521026210272102821029210302103121032210332103421035210362103721038210392104021041210422104321044210452104621047210482104921050210512105221053210542105521056210572105821059210602106121062210632106421065210662106721068210692107021071210722107321074210752107621077210782107921080210812108221083210842108521086210872108821089210902109121092210932109421095210962109721098210992110021101211022110321104211052110621107211082110921110211112111221113211142111521116211172111821119211202112121122211232112421125211262112721128211292113021131211322113321134211352113621137211382113921140211412114221143211442114521146211472114821149211502115121152211532115421155211562115721158211592116021161211622116321164211652116621167211682116921170211712117221173211742117521176211772117821179211802118121182211832118421185211862118721188211892119021191211922119321194211952119621197211982119921200212012120221203212042120521206212072120821209212102121121212212132121421215212162121721218212192122021221212222122321224212252122621227212282122921230212312123221233212342123521236212372123821239212402124121242212432124421245212462124721248212492125021251212522125321254212552125621257212582125921260212612126221263212642126521266212672126821269212702127121272212732127421275212762127721278212792128021281212822128321284212852128621287212882128921290212912129221293212942129521296212972129821299213002130121302213032130421305213062130721308213092131021311213122131321314213152131621317213182131921320213212132221323213242132521326213272132821329213302133121332213332133421335213362133721338213392134021341213422134321344213452134621347213482134921350213512135221353213542135521356213572135821359213602136121362213632136421365213662136721368213692137021371213722137321374213752137621377213782137921380213812138221383213842138521386213872138821389213902139121392213932139421395213962139721398213992140021401214022140321404214052140621407214082140921410214112141221413214142141521416214172141821419214202142121422214232142421425214262142721428214292143021431214322143321434214352143621437214382143921440214412144221443214442144521446214472144821449214502145121452214532145421455214562145721458214592146021461214622146321464214652146621467214682146921470214712147221473214742147521476214772147821479214802148121482214832148421485214862148721488214892149021491214922149321494214952149621497214982149921500215012150221503215042150521506215072150821509215102151121512215132151421515215162151721518215192152021521215222152321524215252152621527215282152921530215312153221533215342153521536215372153821539215402154121542215432154421545215462154721548215492155021551215522155321554215552155621557215582155921560215612156221563215642156521566215672156821569215702157121572215732157421575215762157721578215792158021581215822158321584215852158621587215882158921590215912159221593215942159521596215972159821599216002160121602216032160421605216062160721608216092161021611216122161321614216152161621617216182161921620216212162221623216242162521626216272162821629216302163121632216332163421635216362163721638216392164021641216422164321644216452164621647216482164921650216512165221653216542165521656216572165821659216602166121662216632166421665216662166721668216692167021671216722167321674216752167621677216782167921680216812168221683216842168521686216872168821689216902169121692216932169421695216962169721698216992170021701217022170321704217052170621707217082170921710217112171221713217142171521716217172171821719217202172121722217232172421725217262172721728217292173021731217322173321734217352173621737217382173921740217412174221743217442174521746217472174821749217502175121752217532175421755217562175721758217592176021761217622176321764217652176621767217682176921770217712177221773217742177521776217772177821779217802178121782217832178421785217862178721788217892179021791217922179321794217952179621797217982179921800218012180221803218042180521806218072180821809218102181121812218132181421815218162181721818218192182021821218222182321824218252182621827218282182921830218312183221833218342183521836218372183821839218402184121842218432184421845218462184721848218492185021851218522185321854218552185621857218582185921860218612186221863218642186521866218672186821869218702187121872218732187421875218762187721878218792188021881218822188321884218852188621887218882188921890218912189221893218942189521896218972189821899219002190121902219032190421905219062190721908219092191021911219122191321914219152191621917219182191921920219212192221923219242192521926219272192821929219302193121932219332193421935219362193721938219392194021941219422194321944219452194621947219482194921950219512195221953219542195521956219572195821959219602196121962219632196421965219662196721968219692197021971219722197321974219752197621977219782197921980219812198221983219842198521986219872198821989219902199121992219932199421995219962199721998219992200022001220022200322004220052200622007220082200922010220112201222013220142201522016220172201822019220202202122022220232202422025220262202722028220292203022031220322203322034220352203622037220382203922040220412204222043220442204522046220472204822049220502205122052220532205422055220562205722058220592206022061220622206322064220652206622067220682206922070220712207222073220742207522076220772207822079220802208122082220832208422085220862208722088220892209022091220922209322094220952209622097220982209922100221012210222103221042210522106221072210822109221102211122112221132211422115221162211722118221192212022121221222212322124221252212622127221282212922130221312213222133221342213522136221372213822139221402214122142221432214422145221462214722148221492215022151221522215322154221552215622157221582215922160221612216222163221642216522166221672216822169221702217122172221732217422175221762217722178221792218022181221822218322184221852218622187221882218922190221912219222193221942219522196221972219822199222002220122202222032220422205222062220722208222092221022211222122221322214222152221622217222182221922220222212222222223222242222522226222272222822229222302223122232222332223422235222362223722238222392224022241222422224322244222452224622247222482224922250222512225222253222542225522256222572225822259222602226122262222632226422265222662226722268222692227022271222722227322274222752227622277222782227922280222812228222283222842228522286222872228822289222902229122292222932229422295222962229722298222992230022301223022230322304223052230622307223082230922310223112231222313223142231522316223172231822319223202232122322223232232422325223262232722328223292233022331223322233322334223352233622337223382233922340223412234222343223442234522346223472234822349223502235122352223532235422355223562235722358223592236022361223622236322364223652236622367223682236922370223712237222373223742237522376223772237822379223802238122382223832238422385223862238722388223892239022391223922239322394223952239622397223982239922400224012240222403224042240522406224072240822409224102241122412224132241422415224162241722418224192242022421224222242322424224252242622427224282242922430224312243222433224342243522436224372243822439224402244122442224432244422445224462244722448224492245022451224522245322454224552245622457224582245922460224612246222463224642246522466224672246822469224702247122472224732247422475224762247722478224792248022481224822248322484224852248622487224882248922490224912249222493224942249522496224972249822499225002250122502225032250422505225062250722508225092251022511225122251322514225152251622517225182251922520225212252222523225242252522526225272252822529225302253122532225332253422535225362253722538225392254022541225422254322544225452254622547225482254922550225512255222553225542255522556225572255822559225602256122562225632256422565225662256722568225692257022571225722257322574225752257622577225782257922580225812258222583225842258522586225872258822589225902259122592225932259422595225962259722598225992260022601226022260322604226052260622607226082260922610226112261222613226142261522616226172261822619226202262122622226232262422625226262262722628226292263022631226322263322634226352263622637226382263922640226412264222643226442264522646226472264822649226502265122652226532265422655226562265722658226592266022661226622266322664226652266622667226682266922670226712267222673226742267522676226772267822679226802268122682226832268422685226862268722688226892269022691226922269322694226952269622697226982269922700227012270222703227042270522706227072270822709227102271122712227132271422715227162271722718227192272022721227222272322724227252272622727227282272922730227312273222733227342273522736227372273822739227402274122742227432274422745227462274722748227492275022751227522275322754227552275622757227582275922760227612276222763227642276522766227672276822769227702277122772227732277422775227762277722778227792278022781227822278322784227852278622787227882278922790227912279222793227942279522796227972279822799228002280122802228032280422805228062280722808228092281022811228122281322814228152281622817228182281922820228212282222823228242282522826228272282822829228302283122832228332283422835228362283722838228392284022841228422284322844228452284622847228482284922850228512285222853228542285522856228572285822859228602286122862228632286422865228662286722868228692287022871228722287322874228752287622877228782287922880228812288222883228842288522886228872288822889228902289122892228932289422895228962289722898228992290022901229022290322904229052290622907229082290922910229112291222913229142291522916229172291822919229202292122922229232292422925229262292722928229292293022931229322293322934229352293622937229382293922940229412294222943229442294522946229472294822949229502295122952229532295422955229562295722958229592296022961229622296322964229652296622967229682296922970229712297222973229742297522976229772297822979229802298122982229832298422985229862298722988229892299022991229922299322994229952299622997229982299923000230012300223003230042300523006230072300823009230102301123012230132301423015230162301723018230192302023021230222302323024230252302623027230282302923030230312303223033230342303523036230372303823039230402304123042230432304423045230462304723048230492305023051230522305323054230552305623057230582305923060230612306223063230642306523066230672306823069230702307123072230732307423075230762307723078230792308023081230822308323084230852308623087230882308923090230912309223093230942309523096230972309823099231002310123102231032310423105231062310723108231092311023111231122311323114231152311623117231182311923120231212312223123231242312523126231272312823129231302313123132231332313423135231362313723138231392314023141231422314323144231452314623147231482314923150231512315223153231542315523156231572315823159231602316123162231632316423165231662316723168231692317023171231722317323174231752317623177231782317923180231812318223183231842318523186231872318823189231902319123192231932319423195231962319723198231992320023201232022320323204232052320623207232082320923210232112321223213232142321523216232172321823219232202322123222232232322423225232262322723228232292323023231232322323323234232352323623237232382323923240232412324223243232442324523246232472324823249232502325123252232532325423255232562325723258232592326023261232622326323264232652326623267232682326923270232712327223273232742327523276232772327823279232802328123282232832328423285232862328723288232892329023291232922329323294232952329623297232982329923300233012330223303233042330523306233072330823309233102331123312233132331423315233162331723318233192332023321233222332323324233252332623327233282332923330233312333223333233342333523336233372333823339233402334123342233432334423345233462334723348233492335023351233522335323354233552335623357233582335923360233612336223363233642336523366233672336823369233702337123372233732337423375233762337723378233792338023381233822338323384233852338623387233882338923390233912339223393233942339523396233972339823399234002340123402234032340423405234062340723408234092341023411234122341323414234152341623417234182341923420234212342223423234242342523426234272342823429234302343123432234332343423435234362343723438234392344023441234422344323444234452344623447234482344923450234512345223453234542345523456234572345823459234602346123462234632346423465234662346723468234692347023471234722347323474234752347623477234782347923480234812348223483234842348523486234872348823489234902349123492234932349423495234962349723498234992350023501235022350323504235052350623507235082350923510235112351223513235142351523516235172351823519235202352123522235232352423525235262352723528235292353023531235322353323534235352353623537235382353923540235412354223543235442354523546235472354823549235502355123552235532355423555235562355723558235592356023561235622356323564235652356623567235682356923570235712357223573235742357523576235772357823579235802358123582235832358423585235862358723588235892359023591235922359323594235952359623597235982359923600236012360223603236042360523606236072360823609236102361123612236132361423615236162361723618236192362023621236222362323624236252362623627236282362923630236312363223633236342363523636236372363823639236402364123642236432364423645236462364723648236492365023651236522365323654236552365623657236582365923660236612366223663236642366523666236672366823669236702367123672236732367423675236762367723678236792368023681236822368323684236852368623687236882368923690236912369223693236942369523696236972369823699237002370123702237032370423705237062370723708237092371023711237122371323714237152371623717237182371923720237212372223723237242372523726237272372823729237302373123732237332373423735237362373723738237392374023741237422374323744237452374623747237482374923750237512375223753237542375523756237572375823759237602376123762237632376423765237662376723768237692377023771237722377323774237752377623777237782377923780237812378223783237842378523786237872378823789237902379123792237932379423795237962379723798237992380023801238022380323804238052380623807238082380923810238112381223813238142381523816238172381823819238202382123822238232382423825238262382723828238292383023831238322383323834238352383623837238382383923840238412384223843238442384523846238472384823849238502385123852238532385423855238562385723858238592386023861238622386323864238652386623867238682386923870238712387223873238742387523876238772387823879238802388123882238832388423885238862388723888238892389023891238922389323894238952389623897238982389923900239012390223903239042390523906239072390823909239102391123912239132391423915239162391723918239192392023921239222392323924239252392623927239282392923930239312393223933239342393523936239372393823939239402394123942239432394423945239462394723948239492395023951239522395323954239552395623957239582395923960239612396223963239642396523966239672396823969239702397123972239732397423975239762397723978
  1. //
  2. // httplib.h
  3. //
  4. // Copyright (c) 2026 Yuji Hirose. All rights reserved.
  5. // MIT License
  6. //
  7. #ifndef CPPHTTPLIB_HTTPLIB_H
  8. #define CPPHTTPLIB_HTTPLIB_H
  9. #define CPPHTTPLIB_VERSION "0.61.0"
  10. #define CPPHTTPLIB_VERSION_NUM "0x003d00"
  11. #ifdef _WIN32
  12. #if defined(_WIN32_WINNT) && _WIN32_WINNT < 0x0A00
  13. #error \
  14. "cpp-httplib doesn't support Windows 8 or lower. Please use Windows 10 or later."
  15. #endif
  16. #endif
  17. #if defined(__SANITIZE_THREAD__)
  18. #define CPPHTTPLIB_THREAD_SANITIZER
  19. #elif defined(__has_feature)
  20. #if __has_feature(thread_sanitizer)
  21. #define CPPHTTPLIB_THREAD_SANITIZER
  22. #endif
  23. #endif
  24. /*
  25. * Configuration
  26. */
  27. #ifndef CPPHTTPLIB_KEEPALIVE_TIMEOUT_SECOND
  28. #define CPPHTTPLIB_KEEPALIVE_TIMEOUT_SECOND 5
  29. #endif
  30. #ifndef CPPHTTPLIB_KEEPALIVE_TIMEOUT_CHECK_INTERVAL_USECOND
  31. #define CPPHTTPLIB_KEEPALIVE_TIMEOUT_CHECK_INTERVAL_USECOND 10000
  32. #endif
  33. #ifndef CPPHTTPLIB_KEEPALIVE_MAX_COUNT
  34. #define CPPHTTPLIB_KEEPALIVE_MAX_COUNT 100
  35. #endif
  36. #ifndef CPPHTTPLIB_CONNECTION_TIMEOUT_SECOND
  37. #define CPPHTTPLIB_CONNECTION_TIMEOUT_SECOND 300
  38. #endif
  39. #ifndef CPPHTTPLIB_CONNECTION_TIMEOUT_USECOND
  40. #define CPPHTTPLIB_CONNECTION_TIMEOUT_USECOND 0
  41. #endif
  42. #ifndef CPPHTTPLIB_SERVER_READ_TIMEOUT_SECOND
  43. #define CPPHTTPLIB_SERVER_READ_TIMEOUT_SECOND 5
  44. #endif
  45. #ifndef CPPHTTPLIB_SERVER_READ_TIMEOUT_USECOND
  46. #define CPPHTTPLIB_SERVER_READ_TIMEOUT_USECOND 0
  47. #endif
  48. #ifndef CPPHTTPLIB_SERVER_WRITE_TIMEOUT_SECOND
  49. #define CPPHTTPLIB_SERVER_WRITE_TIMEOUT_SECOND 5
  50. #endif
  51. #ifndef CPPHTTPLIB_SERVER_WRITE_TIMEOUT_USECOND
  52. #define CPPHTTPLIB_SERVER_WRITE_TIMEOUT_USECOND 0
  53. #endif
  54. #ifndef CPPHTTPLIB_CLIENT_READ_TIMEOUT_SECOND
  55. #define CPPHTTPLIB_CLIENT_READ_TIMEOUT_SECOND 300
  56. #endif
  57. #ifndef CPPHTTPLIB_CLIENT_READ_TIMEOUT_USECOND
  58. #define CPPHTTPLIB_CLIENT_READ_TIMEOUT_USECOND 0
  59. #endif
  60. #ifndef CPPHTTPLIB_CLIENT_WRITE_TIMEOUT_SECOND
  61. #define CPPHTTPLIB_CLIENT_WRITE_TIMEOUT_SECOND 5
  62. #endif
  63. #ifndef CPPHTTPLIB_CLIENT_WRITE_TIMEOUT_USECOND
  64. #define CPPHTTPLIB_CLIENT_WRITE_TIMEOUT_USECOND 0
  65. #endif
  66. #ifndef CPPHTTPLIB_CLIENT_MAX_TIMEOUT_MSECOND
  67. #define CPPHTTPLIB_CLIENT_MAX_TIMEOUT_MSECOND 0
  68. #endif
  69. #ifndef CPPHTTPLIB_EXPECT_100_THRESHOLD
  70. #define CPPHTTPLIB_EXPECT_100_THRESHOLD 1024
  71. #endif
  72. #ifndef CPPHTTPLIB_EXPECT_100_TIMEOUT_MSECOND
  73. #define CPPHTTPLIB_EXPECT_100_TIMEOUT_MSECOND 1000
  74. #endif
  75. #ifndef CPPHTTPLIB_WAIT_EARLY_SERVER_RESPONSE_THRESHOLD
  76. #define CPPHTTPLIB_WAIT_EARLY_SERVER_RESPONSE_THRESHOLD (1024 * 1024)
  77. #endif
  78. #ifndef CPPHTTPLIB_WAIT_EARLY_SERVER_RESPONSE_TIMEOUT_MSECOND
  79. #define CPPHTTPLIB_WAIT_EARLY_SERVER_RESPONSE_TIMEOUT_MSECOND 50
  80. #endif
  81. #ifndef CPPHTTPLIB_IDLE_INTERVAL_SECOND
  82. #define CPPHTTPLIB_IDLE_INTERVAL_SECOND 0
  83. #endif
  84. #ifndef CPPHTTPLIB_IDLE_INTERVAL_USECOND
  85. #ifdef _WIN32
  86. #define CPPHTTPLIB_IDLE_INTERVAL_USECOND 1000
  87. #else
  88. #define CPPHTTPLIB_IDLE_INTERVAL_USECOND 0
  89. #endif
  90. #endif
  91. #ifndef CPPHTTPLIB_REQUEST_URI_MAX_LENGTH
  92. #define CPPHTTPLIB_REQUEST_URI_MAX_LENGTH 8192
  93. #endif
  94. #ifndef CPPHTTPLIB_HEADER_MAX_LENGTH
  95. #define CPPHTTPLIB_HEADER_MAX_LENGTH 8192
  96. #endif
  97. #ifndef CPPHTTPLIB_HEADER_MAX_COUNT
  98. #define CPPHTTPLIB_HEADER_MAX_COUNT 100
  99. #endif
  100. #ifndef CPPHTTPLIB_REDIRECT_MAX_COUNT
  101. #define CPPHTTPLIB_REDIRECT_MAX_COUNT 20
  102. #endif
  103. #ifndef CPPHTTPLIB_INTERIM_RESPONSE_MAX_COUNT
  104. #define CPPHTTPLIB_INTERIM_RESPONSE_MAX_COUNT 100
  105. #endif
  106. #ifndef CPPHTTPLIB_MULTIPART_FORM_DATA_FILE_MAX_COUNT
  107. #define CPPHTTPLIB_MULTIPART_FORM_DATA_FILE_MAX_COUNT 1024
  108. #endif
  109. #ifndef CPPHTTPLIB_PAYLOAD_MAX_LENGTH
  110. #define CPPHTTPLIB_PAYLOAD_MAX_LENGTH (100 * 1024 * 1024) // 100MB
  111. #endif
  112. #ifndef CPPHTTPLIB_SSE_MAX_EVENT_LENGTH
  113. #define CPPHTTPLIB_SSE_MAX_EVENT_LENGTH (16 * 1024 * 1024) // 16MB
  114. #endif
  115. #ifndef CPPHTTPLIB_FORM_URL_ENCODED_PAYLOAD_MAX_LENGTH
  116. #define CPPHTTPLIB_FORM_URL_ENCODED_PAYLOAD_MAX_LENGTH 8192
  117. #endif
  118. #ifndef CPPHTTPLIB_STATIC_FILE_COMPRESSION_MIN_LENGTH
  119. // 1400 rather than a round number: a body that already fits in one 1500-byte
  120. // MTU gains nothing from being made smaller.
  121. #define CPPHTTPLIB_STATIC_FILE_COMPRESSION_MIN_LENGTH 1400
  122. #endif
  123. #ifndef CPPHTTPLIB_STATIC_FILE_COMPRESSION_MAX_LENGTH
  124. #define CPPHTTPLIB_STATIC_FILE_COMPRESSION_MAX_LENGTH (4 * 1024 * 1024) // 4MB
  125. #endif
  126. #ifndef CPPHTTPLIB_RANGE_MAX_COUNT
  127. #define CPPHTTPLIB_RANGE_MAX_COUNT 1024
  128. #endif
  129. // std::regex_match's backtracking implementation (most acutely on libstdc++)
  130. // recurses roughly once per matched character for quantified patterns such
  131. // as "(.*)", so a long enough path can exhaust the calling thread's stack; on
  132. // a default ~8MB thread stack that has been observed to take on the order of
  133. // a couple thousand characters for a simple pattern. 256 leaves a wide safety
  134. // margin below that (well under the 8192-byte request URI limit) while still
  135. // fitting any realistic route segment; raise it if a route legitimately needs
  136. // longer paths. Regex routes are never applied to paths longer than this.
  137. #ifndef CPPHTTPLIB_REGEX_ROUTE_PATH_MAX_LENGTH
  138. #define CPPHTTPLIB_REGEX_ROUTE_PATH_MAX_LENGTH 256
  139. #endif
  140. #ifndef CPPHTTPLIB_TCP_NODELAY
  141. #define CPPHTTPLIB_TCP_NODELAY false
  142. #endif
  143. #ifndef CPPHTTPLIB_IPV6_V6ONLY
  144. #define CPPHTTPLIB_IPV6_V6ONLY false
  145. #endif
  146. #ifndef CPPHTTPLIB_RECV_BUFSIZ
  147. #define CPPHTTPLIB_RECV_BUFSIZ size_t(16384u)
  148. #endif
  149. #ifndef CPPHTTPLIB_SEND_BUFSIZ
  150. #define CPPHTTPLIB_SEND_BUFSIZ size_t(16384u)
  151. #endif
  152. #ifndef CPPHTTPLIB_COMPRESSION_BUFSIZ
  153. #define CPPHTTPLIB_COMPRESSION_BUFSIZ size_t(16384u)
  154. #endif
  155. #ifndef CPPHTTPLIB_THREAD_POOL_COUNT
  156. #define CPPHTTPLIB_THREAD_POOL_COUNT \
  157. ((std::max)(8u, std::thread::hardware_concurrency() > 0 \
  158. ? std::thread::hardware_concurrency() - 1 \
  159. : 0))
  160. #endif
  161. #ifndef CPPHTTPLIB_THREAD_POOL_MAX_COUNT
  162. #define CPPHTTPLIB_THREAD_POOL_MAX_COUNT (CPPHTTPLIB_THREAD_POOL_COUNT * 4)
  163. #endif
  164. #ifndef CPPHTTPLIB_THREAD_POOL_IDLE_TIMEOUT
  165. #define CPPHTTPLIB_THREAD_POOL_IDLE_TIMEOUT 3 // seconds
  166. #endif
  167. #ifndef CPPHTTPLIB_RECV_FLAGS
  168. #define CPPHTTPLIB_RECV_FLAGS 0
  169. #endif
  170. #ifndef CPPHTTPLIB_SEND_FLAGS
  171. #define CPPHTTPLIB_SEND_FLAGS 0
  172. #endif
  173. #ifndef CPPHTTPLIB_LISTEN_BACKLOG
  174. #define CPPHTTPLIB_LISTEN_BACKLOG 128
  175. #endif
  176. #ifndef CPPHTTPLIB_MAX_LINE_LENGTH
  177. #define CPPHTTPLIB_MAX_LINE_LENGTH 32768
  178. #endif
  179. // These bound the parsing of every request, so 0 cannot lift them.
  180. static_assert(CPPHTTPLIB_REQUEST_URI_MAX_LENGTH > 0,
  181. "CPPHTTPLIB_REQUEST_URI_MAX_LENGTH must be positive");
  182. static_assert(CPPHTTPLIB_HEADER_MAX_LENGTH > 0,
  183. "CPPHTTPLIB_HEADER_MAX_LENGTH must be positive");
  184. static_assert(CPPHTTPLIB_HEADER_MAX_COUNT > 0,
  185. "CPPHTTPLIB_HEADER_MAX_COUNT must be positive");
  186. static_assert(CPPHTTPLIB_MAX_LINE_LENGTH > 0,
  187. "CPPHTTPLIB_MAX_LINE_LENGTH must be positive");
  188. #ifndef CPPHTTPLIB_WEBSOCKET_MAX_PAYLOAD_LENGTH
  189. #define CPPHTTPLIB_WEBSOCKET_MAX_PAYLOAD_LENGTH 16777216
  190. #endif
  191. // One macro used to set the read timeout for both sides. They want different
  192. // defaults: a client's read timeout is the caller's own tool (it waits forever
  193. // until asked not to), while a server keeps a ceiling that reclaims a worker
  194. // from a peer that has gone quiet. The old name still works and sets both.
  195. #ifdef CPPHTTPLIB_WEBSOCKET_READ_TIMEOUT_SECOND
  196. #pragma message( \
  197. "CPPHTTPLIB_WEBSOCKET_READ_TIMEOUT_SECOND is deprecated; define " \
  198. "CPPHTTPLIB_WEBSOCKET_CLIENT_READ_TIMEOUT_SECOND and/or " \
  199. "CPPHTTPLIB_WEBSOCKET_SERVER_READ_TIMEOUT_SECOND instead")
  200. #ifndef CPPHTTPLIB_WEBSOCKET_CLIENT_READ_TIMEOUT_SECOND
  201. #define CPPHTTPLIB_WEBSOCKET_CLIENT_READ_TIMEOUT_SECOND \
  202. CPPHTTPLIB_WEBSOCKET_READ_TIMEOUT_SECOND
  203. #endif
  204. #ifndef CPPHTTPLIB_WEBSOCKET_SERVER_READ_TIMEOUT_SECOND
  205. #define CPPHTTPLIB_WEBSOCKET_SERVER_READ_TIMEOUT_SECOND \
  206. CPPHTTPLIB_WEBSOCKET_READ_TIMEOUT_SECOND
  207. #endif
  208. #endif
  209. // 0 waits forever. A read timeout is how a caller gets control back to send on
  210. // the same connection; it is not a liveness check (that is ping/pong). Only a
  211. // timeout set at runtime through set_read_timeout() is reported as
  212. // ws::Timeout; when one of these compile-time defaults elapses, read() returns
  213. // ws::Fail and closes the connection.
  214. #ifndef CPPHTTPLIB_WEBSOCKET_CLIENT_READ_TIMEOUT_SECOND
  215. #define CPPHTTPLIB_WEBSOCKET_CLIENT_READ_TIMEOUT_SECOND 0
  216. #endif
  217. #ifndef CPPHTTPLIB_WEBSOCKET_SERVER_READ_TIMEOUT_SECOND
  218. #define CPPHTTPLIB_WEBSOCKET_SERVER_READ_TIMEOUT_SECOND 300
  219. #endif
  220. #ifndef CPPHTTPLIB_WEBSOCKET_CLOSE_TIMEOUT_SECOND
  221. #define CPPHTTPLIB_WEBSOCKET_CLOSE_TIMEOUT_SECOND 5
  222. #endif
  223. #ifndef CPPHTTPLIB_WEBSOCKET_PING_INTERVAL_SECOND
  224. #define CPPHTTPLIB_WEBSOCKET_PING_INTERVAL_SECOND 30
  225. #endif
  226. #ifndef CPPHTTPLIB_WEBSOCKET_MAX_MISSED_PONGS
  227. #define CPPHTTPLIB_WEBSOCKET_MAX_MISSED_PONGS 0
  228. #endif
  229. /*
  230. * Headers
  231. */
  232. #ifdef _WIN32
  233. #ifndef _CRT_SECURE_NO_WARNINGS
  234. #define _CRT_SECURE_NO_WARNINGS
  235. #endif //_CRT_SECURE_NO_WARNINGS
  236. #ifndef _CRT_NONSTDC_NO_DEPRECATE
  237. #define _CRT_NONSTDC_NO_DEPRECATE
  238. #endif //_CRT_NONSTDC_NO_DEPRECATE
  239. #if defined(_MSC_VER)
  240. #if _MSC_VER < 1900
  241. #error Sorry, Visual Studio versions prior to 2015 are not supported
  242. #endif
  243. #pragma comment(lib, "ws2_32.lib")
  244. #ifndef _SSIZE_T_DEFINED
  245. using ssize_t = __int64;
  246. #define _SSIZE_T_DEFINED
  247. #endif
  248. #endif // _MSC_VER
  249. #ifndef S_ISREG
  250. #define S_ISREG(m) (((m) & S_IFREG) == S_IFREG)
  251. #endif // S_ISREG
  252. #ifndef S_ISDIR
  253. #define S_ISDIR(m) (((m) & S_IFDIR) == S_IFDIR)
  254. #endif // S_ISDIR
  255. #ifndef NOMINMAX
  256. #define NOMINMAX
  257. #endif // NOMINMAX
  258. #include <io.h>
  259. #include <winsock2.h>
  260. #include <ws2tcpip.h>
  261. #if defined(__has_include)
  262. #if __has_include(<afunix.h>)
  263. // afunix.h uses types declared in winsock2.h, so has to be included after it.
  264. #include <afunix.h>
  265. #define CPPHTTPLIB_HAVE_AFUNIX_H 1
  266. #endif
  267. #endif
  268. #ifndef WSA_FLAG_NO_HANDLE_INHERIT
  269. #define WSA_FLAG_NO_HANDLE_INHERIT 0x80
  270. #endif
  271. using nfds_t = unsigned long;
  272. using socket_t = SOCKET;
  273. using socklen_t = int;
  274. #else // not _WIN32
  275. #include <arpa/inet.h>
  276. #if !defined(_AIX) && !defined(__MVS__)
  277. #include <ifaddrs.h>
  278. #endif
  279. #ifdef __MVS__
  280. #include <strings.h>
  281. #ifndef NI_MAXHOST
  282. #define NI_MAXHOST 1025
  283. #endif
  284. #endif
  285. #include <net/if.h>
  286. #include <netdb.h>
  287. #include <netinet/in.h>
  288. #ifdef __linux__
  289. #include <resolv.h>
  290. #undef _res // Undefine _res macro to avoid conflicts with user code (#2278)
  291. #endif
  292. #include <csignal>
  293. #include <netinet/tcp.h>
  294. #include <poll.h>
  295. #include <pthread.h>
  296. #include <sys/socket.h>
  297. #include <sys/un.h>
  298. #include <unistd.h>
  299. using socket_t = int;
  300. #ifndef INVALID_SOCKET
  301. #define INVALID_SOCKET (-1)
  302. #endif
  303. #endif //_WIN32
  304. #if defined(__APPLE__)
  305. #include <TargetConditionals.h>
  306. #endif
  307. #include <algorithm>
  308. #include <array>
  309. #include <atomic>
  310. #include <cassert>
  311. #include <chrono>
  312. #include <climits>
  313. #include <condition_variable>
  314. #include <cstdlib>
  315. #include <cstring>
  316. #include <errno.h>
  317. #include <exception>
  318. #include <fcntl.h>
  319. #include <fstream>
  320. #include <functional>
  321. #include <iomanip>
  322. #include <iostream>
  323. #include <iterator>
  324. #include <list>
  325. #include <map>
  326. #include <memory>
  327. #include <mutex>
  328. #include <random>
  329. #include <regex>
  330. #include <set>
  331. #include <sstream>
  332. #include <string>
  333. #include <sys/stat.h>
  334. #include <system_error>
  335. #include <thread>
  336. #include <type_traits>
  337. #include <unordered_map>
  338. #include <unordered_set>
  339. #include <utility>
  340. #include <vector>
  341. // On macOS with a TLS backend, enable Keychain root certificates by default
  342. // unless the user explicitly opts out. Not enabled on iOS/tvOS/watchOS since
  343. // the SecTrustSettings APIs used to enumerate anchor certificates are macOS
  344. // only; on those platforms the user must provide a CA bundle explicitly.
  345. #if defined(__APPLE__) && defined(__clang__) && \
  346. !defined(CPPHTTPLIB_DISABLE_MACOSX_AUTOMATIC_ROOT_CERTIFICATES) && \
  347. (defined(CPPHTTPLIB_OPENSSL_SUPPORT) || \
  348. defined(CPPHTTPLIB_MBEDTLS_SUPPORT) || \
  349. defined(CPPHTTPLIB_WOLFSSL_SUPPORT))
  350. #if TARGET_OS_OSX
  351. #ifndef CPPHTTPLIB_USE_CERTS_FROM_MACOSX_KEYCHAIN
  352. #define CPPHTTPLIB_USE_CERTS_FROM_MACOSX_KEYCHAIN
  353. #endif
  354. #endif
  355. #endif
  356. #if defined(CPPHTTPLIB_USE_CERTS_FROM_MACOSX_KEYCHAIN) && \
  357. defined(__APPLE__) && !TARGET_OS_OSX
  358. #error \
  359. "CPPHTTPLIB_USE_CERTS_FROM_MACOSX_KEYCHAIN is only supported on macOS. On iOS/tvOS/watchOS, supply a CA bundle via set_ca_cert_path()."
  360. #endif
  361. // On Windows, enable Schannel certificate verification by default
  362. // unless the user explicitly opts out.
  363. #if defined(_WIN32) && \
  364. !defined(CPPHTTPLIB_DISABLE_WINDOWS_AUTOMATIC_ROOT_CERTIFICATES_UPDATE)
  365. #define CPPHTTPLIB_WINDOWS_AUTOMATIC_ROOT_CERTIFICATES_UPDATE
  366. #endif
  367. #if defined(CPPHTTPLIB_USE_NON_BLOCKING_GETADDRINFO) || \
  368. defined(CPPHTTPLIB_USE_CERTS_FROM_MACOSX_KEYCHAIN)
  369. #if TARGET_OS_MAC && defined(__clang__)
  370. #include <CFNetwork/CFHost.h>
  371. #include <CoreFoundation/CoreFoundation.h>
  372. #endif
  373. #endif
  374. #ifdef CPPHTTPLIB_OPENSSL_SUPPORT
  375. #ifdef _WIN32
  376. #include <wincrypt.h>
  377. // these are defined in wincrypt.h and it breaks compilation if BoringSSL is
  378. // used
  379. #undef X509_NAME
  380. #undef X509_CERT_PAIR
  381. #undef X509_EXTENSIONS
  382. #undef PKCS7_SIGNER_INFO
  383. #ifdef _MSC_VER
  384. #pragma comment(lib, "crypt32.lib")
  385. #endif
  386. #endif // _WIN32
  387. #ifdef CPPHTTPLIB_USE_CERTS_FROM_MACOSX_KEYCHAIN
  388. #if TARGET_OS_OSX
  389. #include <Security/Security.h>
  390. #endif
  391. #endif
  392. #include <openssl/err.h>
  393. #include <openssl/evp.h>
  394. #include <openssl/rand.h>
  395. #include <openssl/ssl.h>
  396. #include <openssl/x509v3.h>
  397. #if defined(_WIN32) && defined(OPENSSL_USE_APPLINK)
  398. #include <openssl/applink.c>
  399. #endif
  400. #include <iostream>
  401. #include <sstream>
  402. #if defined(OPENSSL_IS_BORINGSSL) || defined(LIBRESSL_VERSION_NUMBER)
  403. #if OPENSSL_VERSION_NUMBER < 0x1010107f
  404. #error Please use OpenSSL or a current version of BoringSSL
  405. #endif
  406. #define SSL_get1_peer_certificate SSL_get_peer_certificate
  407. #elif OPENSSL_VERSION_NUMBER < 0x30000000L
  408. #error Sorry, OpenSSL versions prior to 3.0.0 are not supported
  409. #endif
  410. #endif // CPPHTTPLIB_OPENSSL_SUPPORT
  411. #ifdef CPPHTTPLIB_MBEDTLS_SUPPORT
  412. // version.h defines MBEDTLS_VERSION_MAJOR (on 2.x/3.x/4.x alike); it is pulled
  413. // in with this first include group so the version gating below can use it.
  414. #include <mbedtls/error.h>
  415. #include <mbedtls/net_sockets.h>
  416. #include <mbedtls/oid.h>
  417. #include <mbedtls/pk.h>
  418. #include <mbedtls/ssl.h>
  419. #include <mbedtls/version.h>
  420. #include <mbedtls/x509_crt.h>
  421. #if MBEDTLS_VERSION_MAJOR >= 4
  422. // Mbed TLS 4.x moved hashing/RNG to PSA Crypto and removed these headers.
  423. #include <psa/crypto.h>
  424. #else
  425. #include <mbedtls/ctr_drbg.h>
  426. #include <mbedtls/entropy.h>
  427. #include <mbedtls/md5.h>
  428. #include <mbedtls/sha1.h>
  429. #include <mbedtls/sha256.h>
  430. #include <mbedtls/sha512.h>
  431. #endif
  432. #ifdef _WIN32
  433. #include <wincrypt.h>
  434. #ifdef _MSC_VER
  435. #pragma comment(lib, "crypt32.lib")
  436. #endif
  437. #endif // _WIN32
  438. #ifdef CPPHTTPLIB_USE_CERTS_FROM_MACOSX_KEYCHAIN
  439. #if TARGET_OS_OSX
  440. #include <Security/Security.h>
  441. #endif
  442. #endif
  443. // Mbed TLS version API compatibility. Note: V4 implies V3 (both defined on
  444. // 4.x), so version-specific 3.x-only code must check V3 && !V4.
  445. #if MBEDTLS_VERSION_MAJOR >= 4
  446. #define CPPHTTPLIB_MBEDTLS_V4
  447. #endif
  448. #if MBEDTLS_VERSION_MAJOR >= 3
  449. #define CPPHTTPLIB_MBEDTLS_V3
  450. #endif
  451. #endif // CPPHTTPLIB_MBEDTLS_SUPPORT
  452. #ifdef CPPHTTPLIB_WOLFSSL_SUPPORT
  453. #include <wolfssl/options.h>
  454. #include <wolfssl/openssl/x509v3.h>
  455. // Fallback definitions for older wolfSSL versions (e.g., 5.6.6)
  456. #ifndef WOLFSSL_GEN_EMAIL
  457. #define WOLFSSL_GEN_EMAIL 1
  458. #endif
  459. #ifndef WOLFSSL_GEN_DNS
  460. #define WOLFSSL_GEN_DNS 2
  461. #endif
  462. #ifndef WOLFSSL_GEN_URI
  463. #define WOLFSSL_GEN_URI 6
  464. #endif
  465. #ifndef WOLFSSL_GEN_IPADD
  466. #define WOLFSSL_GEN_IPADD 7
  467. #endif
  468. #include <wolfssl/ssl.h>
  469. #include <wolfssl/wolfcrypt/hash.h>
  470. #include <wolfssl/wolfcrypt/md5.h>
  471. #include <wolfssl/wolfcrypt/sha256.h>
  472. #include <wolfssl/wolfcrypt/sha512.h>
  473. #ifdef _WIN32
  474. #include <wincrypt.h>
  475. #ifdef _MSC_VER
  476. #pragma comment(lib, "crypt32.lib")
  477. #endif
  478. #endif // _WIN32
  479. #ifdef CPPHTTPLIB_USE_CERTS_FROM_MACOSX_KEYCHAIN
  480. #if TARGET_OS_OSX
  481. #include <Security/Security.h>
  482. #endif
  483. #endif
  484. #endif // CPPHTTPLIB_WOLFSSL_SUPPORT
  485. // Define CPPHTTPLIB_SSL_ENABLED if any SSL backend is available
  486. #if defined(CPPHTTPLIB_OPENSSL_SUPPORT) || \
  487. defined(CPPHTTPLIB_MBEDTLS_SUPPORT) || defined(CPPHTTPLIB_WOLFSSL_SUPPORT)
  488. #define CPPHTTPLIB_SSL_ENABLED
  489. #endif
  490. #ifdef CPPHTTPLIB_ZLIB_SUPPORT
  491. #include <zlib.h>
  492. #endif
  493. #ifdef CPPHTTPLIB_BROTLI_SUPPORT
  494. #include <brotli/decode.h>
  495. #include <brotli/encode.h>
  496. #endif
  497. #ifdef CPPHTTPLIB_ZSTD_SUPPORT
  498. #include <zstd.h>
  499. #endif
  500. /*
  501. * Declaration
  502. */
  503. namespace httplib {
  504. namespace ws {
  505. class WebSocket;
  506. } // namespace ws
  507. namespace sse {
  508. class SSEClient;
  509. } // namespace sse
  510. namespace detail {
  511. /*
  512. * Backport std::make_unique from C++14.
  513. *
  514. * NOTE: This code came up with the following stackoverflow post:
  515. * https://stackoverflow.com/questions/10149840/c-arrays-and-make-unique
  516. *
  517. */
  518. template <class T, class... Args>
  519. typename std::enable_if<!std::is_array<T>::value, std::unique_ptr<T>>::type
  520. make_unique(Args &&...args) {
  521. return std::unique_ptr<T>(new T(std::forward<Args>(args)...));
  522. }
  523. template <class T>
  524. typename std::enable_if<std::is_array<T>::value, std::unique_ptr<T>>::type
  525. make_unique(std::size_t n) {
  526. typedef typename std::remove_extent<T>::type RT;
  527. return std::unique_ptr<T>(new RT[n]);
  528. }
  529. // Locale-independent ASCII character classification. The <cctype>
  530. // counterparts (std::isalnum, std::isdigit, ...) consult the global C locale,
  531. // so e.g. std::isalnum(0xC5) can return true once an embedder calls
  532. // setlocale(). HTTP grammars are defined over ASCII, so raw bytes must be
  533. // classified without regard to the locale.
  534. inline bool is_ascii_digit(char c) { return '0' <= c && c <= '9'; }
  535. inline bool is_ascii_alpha(char c) {
  536. return ('a' <= c && c <= 'z') || ('A' <= c && c <= 'Z');
  537. }
  538. inline bool is_ascii_alnum(char c) {
  539. return is_ascii_digit(c) || is_ascii_alpha(c);
  540. }
  541. namespace case_ignore {
  542. inline unsigned char to_lower(int c) {
  543. const static unsigned char table[256] = {
  544. 0, 1, 2, 3, 4, 5, 6, 7, 8, 9, 10, 11, 12, 13, 14,
  545. 15, 16, 17, 18, 19, 20, 21, 22, 23, 24, 25, 26, 27, 28, 29,
  546. 30, 31, 32, 33, 34, 35, 36, 37, 38, 39, 40, 41, 42, 43, 44,
  547. 45, 46, 47, 48, 49, 50, 51, 52, 53, 54, 55, 56, 57, 58, 59,
  548. 60, 61, 62, 63, 64, 97, 98, 99, 100, 101, 102, 103, 104, 105, 106,
  549. 107, 108, 109, 110, 111, 112, 113, 114, 115, 116, 117, 118, 119, 120, 121,
  550. 122, 91, 92, 93, 94, 95, 96, 97, 98, 99, 100, 101, 102, 103, 104,
  551. 105, 106, 107, 108, 109, 110, 111, 112, 113, 114, 115, 116, 117, 118, 119,
  552. 120, 121, 122, 123, 124, 125, 126, 127, 128, 129, 130, 131, 132, 133, 134,
  553. 135, 136, 137, 138, 139, 140, 141, 142, 143, 144, 145, 146, 147, 148, 149,
  554. 150, 151, 152, 153, 154, 155, 156, 157, 158, 159, 160, 161, 162, 163, 164,
  555. 165, 166, 167, 168, 169, 170, 171, 172, 173, 174, 175, 176, 177, 178, 179,
  556. 180, 181, 182, 183, 184, 185, 186, 187, 188, 189, 190, 191, 224, 225, 226,
  557. 227, 228, 229, 230, 231, 232, 233, 234, 235, 236, 237, 238, 239, 240, 241,
  558. 242, 243, 244, 245, 246, 215, 248, 249, 250, 251, 252, 253, 254, 223, 224,
  559. 225, 226, 227, 228, 229, 230, 231, 232, 233, 234, 235, 236, 237, 238, 239,
  560. 240, 241, 242, 243, 244, 245, 246, 247, 248, 249, 250, 251, 252, 253, 254,
  561. 255,
  562. };
  563. return table[(unsigned char)(char)c];
  564. }
  565. inline std::string to_lower(const std::string &s) {
  566. std::string result = s;
  567. std::transform(
  568. result.begin(), result.end(), result.begin(),
  569. [](unsigned char c) { return static_cast<char>(to_lower(c)); });
  570. return result;
  571. }
  572. inline bool equal(const std::string &a, const std::string &b) {
  573. return a.size() == b.size() &&
  574. std::equal(a.begin(), a.end(), b.begin(), [](char ca, char cb) {
  575. return to_lower(ca) == to_lower(cb);
  576. });
  577. }
  578. // For a literal, without building a std::string from it.
  579. template <size_t N>
  580. inline bool equal(const std::string &a, const char (&b)[N]) {
  581. return a.size() == N - 1 &&
  582. std::equal(a.begin(), a.end(), b, [](char ca, char cb) {
  583. return to_lower(ca) == to_lower(cb);
  584. });
  585. }
  586. struct equal_to {
  587. bool operator()(const std::string &a, const std::string &b) const {
  588. return equal(a, b);
  589. }
  590. };
  591. struct hash {
  592. size_t operator()(const std::string &key) const {
  593. size_t h = 0;
  594. for (auto c : key) {
  595. // Unsets the 6 high bits of h, therefore no overflow happens
  596. h = (((std::numeric_limits<size_t>::max)() >> 6) & h * 33) ^
  597. static_cast<unsigned char>(to_lower(c));
  598. }
  599. return h;
  600. }
  601. };
  602. template <typename T>
  603. using unordered_set = std::unordered_set<T, detail::case_ignore::hash,
  604. detail::case_ignore::equal_to>;
  605. } // namespace case_ignore
  606. // This is based on
  607. // "http://www.open-std.org/jtc1/sc22/wg21/docs/papers/2014/n4189".
  608. struct scope_exit {
  609. explicit scope_exit(std::function<void(void)> &&f)
  610. : exit_function(std::move(f)), execute_on_destruction{true} {}
  611. scope_exit(scope_exit &&rhs) noexcept
  612. : exit_function(std::move(rhs.exit_function)),
  613. execute_on_destruction{rhs.execute_on_destruction} {
  614. rhs.release();
  615. }
  616. ~scope_exit() {
  617. if (execute_on_destruction) { this->exit_function(); }
  618. }
  619. void release() { this->execute_on_destruction = false; }
  620. private:
  621. scope_exit(const scope_exit &) = delete;
  622. void operator=(const scope_exit &) = delete;
  623. scope_exit &operator=(scope_exit &&) = delete;
  624. std::function<void(void)> exit_function;
  625. bool execute_on_destruction;
  626. };
  627. // Simple from_chars implementation for integer and double types (C++17
  628. // substitute)
  629. template <typename T> struct from_chars_result {
  630. const char *ptr;
  631. std::errc ec;
  632. };
  633. template <typename T>
  634. inline from_chars_result<T> from_chars(const char *first, const char *last,
  635. T &value, int base = 10) {
  636. value = 0;
  637. const char *p = first;
  638. bool negative = false;
  639. if (p != last && *p == '-') {
  640. negative = true;
  641. ++p;
  642. }
  643. if (p == last) { return {first, std::errc::invalid_argument}; }
  644. auto radix = static_cast<T>(base);
  645. T result = 0;
  646. for (; p != last; ++p) {
  647. char c = *p;
  648. int digit = -1;
  649. if (is_ascii_digit(c)) {
  650. digit = c - '0';
  651. } else if ('a' <= c && c <= 'z') {
  652. digit = c - 'a' + 10;
  653. } else if ('A' <= c && c <= 'Z') {
  654. digit = c - 'A' + 10;
  655. } else {
  656. break;
  657. }
  658. if (digit < 0 || digit >= base) { break; }
  659. auto d = static_cast<T>(digit);
  660. if (result > ((std::numeric_limits<T>::max)() - d) / radix) {
  661. return {p, std::errc::result_out_of_range};
  662. }
  663. result = result * radix + d;
  664. }
  665. if (p == first || (negative && p == first + 1)) {
  666. return {first, std::errc::invalid_argument};
  667. }
  668. value = negative ? T(0) - result : result;
  669. return {p, std::errc{}};
  670. }
  671. // from_chars for double (hand-written, locale-independent)
  672. //
  673. // The only double consumed by this library is the HTTP quality value, whose
  674. // grammar is (RFC 9110 12.4.2):
  675. // qvalue = ( "0" [ "." 0*3DIGIT ] ) / ( "1" [ "." 0*3("0") ] )
  676. // i.e. a non-negative decimal with no sign, exponent, "inf"/"nan", or wide
  677. // magnitude. So this parser recognizes exactly 1*DIGIT [ "." *DIGIT ] with
  678. // '.' always the decimal separator (std::strtod would instead read it from the
  679. // global C locale, mis-parsing q-values once an embedder calls
  680. // setlocale(LC_ALL, "") into a comma-decimal locale). The caller range-checks
  681. // the result to [0, 1], so inputs outside that range need not be distinguished
  682. // here. Allocation-free, single pass, and free of the overflow/rounding edge
  683. // cases that exponent and wide-range handling would introduce.
  684. inline from_chars_result<double> from_chars(const char *first, const char *last,
  685. double &value) {
  686. value = 0.0;
  687. const char *p = first;
  688. // Each 1eN is exactly representable, so a single final division by the
  689. // matching entry yields a correctly-rounded result.
  690. static const double powers_of_ten[] = {
  691. 1e0, 1e1, 1e2, 1e3, 1e4, 1e5, 1e6, 1e7, 1e8, 1e9,
  692. 1e10, 1e11, 1e12, 1e13, 1e14, 1e15, 1e16, 1e17, 1e18};
  693. const int max_frac_digits =
  694. static_cast<int>(sizeof(powers_of_ten) / sizeof(powers_of_ten[0])) - 1;
  695. // Accumulate digits into a 64-bit integer and remember how many were
  696. // fractional. Two independent caps keep this bounded and safe:
  697. // * accumulation saturates before mantissa could overflow uint64_t, and
  698. // * frac_digits is capped at max_frac_digits so it is always a valid index
  699. // into powers_of_ten (without this an input like "0.000...0" would never
  700. // grow mantissa, so the saturation cap alone would not bound it).
  701. // Both caps only drop digits far beyond the precision a q-value needs; any
  702. // value they would change is well outside [0, 1] and rejected by the caller.
  703. uint64_t mantissa = 0;
  704. int frac_digits = 0;
  705. bool seen_digit = false;
  706. const uint64_t limit = ((std::numeric_limits<uint64_t>::max)() - 9) / 10;
  707. auto accumulate = [&](char c) {
  708. if (mantissa <= limit) {
  709. mantissa = mantissa * 10 + static_cast<uint64_t>(c - '0');
  710. return true;
  711. }
  712. return false;
  713. };
  714. for (; p != last && is_ascii_digit(*p); ++p) {
  715. seen_digit = true;
  716. accumulate(*p);
  717. }
  718. if (p != last && *p == '.') {
  719. ++p;
  720. for (; p != last && is_ascii_digit(*p); ++p) {
  721. seen_digit = true;
  722. if (frac_digits < max_frac_digits && accumulate(*p)) { ++frac_digits; }
  723. }
  724. }
  725. if (!seen_digit) { return {first, std::errc::invalid_argument}; }
  726. value = static_cast<double>(mantissa) / powers_of_ten[frac_digits];
  727. return {p, std::errc{}};
  728. }
  729. inline bool parse_int_in_range(const char *s, size_t len, int lo, int hi,
  730. int &out) {
  731. int val = 0;
  732. auto r = from_chars(s, s + len, val);
  733. if (r.ec != std::errc{} || r.ptr != s + len || val < lo || val > hi) {
  734. return false;
  735. }
  736. out = val;
  737. return true;
  738. }
  739. inline bool parse_port(const char *s, size_t len, int &port) {
  740. return parse_int_in_range(s, len, 1, 65535, port);
  741. }
  742. inline bool parse_port(const std::string &s, int &port) {
  743. return parse_port(s.data(), s.size(), port);
  744. }
  745. struct UrlComponents {
  746. std::string scheme;
  747. std::string host;
  748. std::string port;
  749. std::string path;
  750. std::string query;
  751. };
  752. inline bool parse_url(const std::string &url, UrlComponents &uc) {
  753. uc = {};
  754. size_t pos = 0;
  755. auto sep = url.find("://");
  756. if (sep != std::string::npos) {
  757. uc.scheme = url.substr(0, sep);
  758. // Scheme must be [a-z]+ only
  759. if (uc.scheme.empty()) { return false; }
  760. for (auto c : uc.scheme) {
  761. if (c < 'a' || c > 'z') { return false; }
  762. }
  763. pos = sep + 3;
  764. } else if (url.compare(0, 2, "//") == 0) {
  765. pos = 2;
  766. }
  767. auto has_authority_prefix = pos > 0;
  768. auto has_authority = has_authority_prefix || (!url.empty() && url[0] != '/' &&
  769. url[0] != '?' && url[0] != '#');
  770. if (has_authority) {
  771. // userinfo is not supported, and a backslash that some parsers take for
  772. // '/' would leave them seeing another host than this one.
  773. if (url.find_first_of("@\\", pos) < url.find_first_of("/?#", pos)) {
  774. return false;
  775. }
  776. if (pos < url.size() && url[pos] == '[') {
  777. auto close = url.find(']', pos);
  778. if (close == std::string::npos) { return false; }
  779. uc.host = url.substr(pos + 1, close - pos - 1);
  780. // IPv6 host must be [a-fA-F0-9:]+ only
  781. if (uc.host.empty()) { return false; }
  782. for (auto c : uc.host) {
  783. if (!(is_ascii_digit(c) || (c >= 'a' && c <= 'f') ||
  784. (c >= 'A' && c <= 'F') || c == ':')) {
  785. return false;
  786. }
  787. }
  788. pos = close + 1;
  789. // The IPv6 literal is the whole host, so ']' must be followed by a port,
  790. // path, query or fragment delimiter (or the end of input). Otherwise the
  791. // trailing bytes would be folded into the path while the connection
  792. // still targets the bracketed address.
  793. if (pos < url.size()) {
  794. auto c = url[pos];
  795. if (c != ':' && c != '/' && c != '?' && c != '#') { return false; }
  796. }
  797. } else {
  798. auto end = url.find_first_of(":/?#", pos);
  799. if (end == std::string::npos) { end = url.size(); }
  800. uc.host = url.substr(pos, end - pos);
  801. pos = end;
  802. }
  803. if (pos < url.size() && url[pos] == ':') {
  804. ++pos;
  805. auto end = url.find_first_of("/?#", pos);
  806. if (end == std::string::npos) { end = url.size(); }
  807. uc.port = url.substr(pos, end - pos);
  808. pos = end;
  809. }
  810. // Without :// or //, the entire input must be consumed as host[:port].
  811. // If there is leftover (path, query, etc.), this is not a valid
  812. // host[:port] string — clear and reparse as a plain path.
  813. if (!has_authority_prefix && pos < url.size()) {
  814. uc.host.clear();
  815. uc.port.clear();
  816. pos = 0;
  817. }
  818. }
  819. if (pos < url.size() && url[pos] != '?' && url[pos] != '#') {
  820. auto end = url.find_first_of("?#", pos);
  821. if (end == std::string::npos) { end = url.size(); }
  822. uc.path = url.substr(pos, end - pos);
  823. pos = end;
  824. }
  825. if (pos < url.size() && url[pos] == '?') {
  826. auto end = url.find('#', pos);
  827. if (end == std::string::npos) { end = url.size(); }
  828. uc.query = url.substr(pos, end - pos);
  829. }
  830. return true;
  831. }
  832. // Resolves a relative-path or query-only Location value against the path of
  833. // the request being redirected (RFC 3986 section 5.2). Absolute URIs and
  834. // references starting with '/' are returned unchanged.
  835. inline std::string resolve_relative_location(const std::string &location,
  836. const std::string &base) {
  837. if (location.empty() || location[0] == '/') { return location; }
  838. // A ':' in the first segment means the value has a scheme.
  839. if (location.find(':') < location.find_first_of("/?#")) { return location; }
  840. if (location[0] == '#') { return base.substr(0, base.find('#')) + location; }
  841. auto base_path = base.substr(0, base.find_first_of("?#"));
  842. if (location[0] == '?') { return base_path + location; }
  843. if (base_path.empty() || base_path[0] != '/') { base_path = "/"; }
  844. auto merged = base_path.substr(0, base_path.rfind('/') + 1) + location;
  845. // Remove "." and ".." segments from the merged path.
  846. auto path_end = (std::min)(merged.find_first_of("?#"), merged.size());
  847. std::string path;
  848. size_t i = 0;
  849. while (i < path_end) {
  850. auto next = (std::min)(merged.find('/', i + 1), path_end);
  851. auto segment = merged.substr(i + 1, next - i - 1);
  852. auto is_last = next == path_end;
  853. if (segment == "." || segment == "..") {
  854. if (segment == "..") {
  855. path.erase((std::min)(path.rfind('/'), path.size()));
  856. }
  857. if (is_last) { path += '/'; }
  858. } else {
  859. path += '/';
  860. path += segment;
  861. }
  862. i = next;
  863. }
  864. if (path.empty()) { path = "/"; }
  865. return path + merged.substr(path_end);
  866. }
  867. } // namespace detail
  868. enum class SSLVerifierResponse {
  869. // no decision has been made, use the built-in certificate verifier
  870. NoDecisionMade,
  871. // connection certificate is verified and accepted
  872. CertificateAccepted,
  873. // connection certificate was processed but is rejected
  874. CertificateRejected
  875. };
  876. // System CA loading policy for SSL clients. Auto (the default) loads system
  877. // CA certs only when no custom CA is configured; enable_system_ca() switches
  878. // to an explicit policy.
  879. enum class SystemCAMode { Auto, Enabled, Disabled };
  880. enum StatusCode {
  881. // Information responses
  882. Continue_100 = 100,
  883. SwitchingProtocol_101 = 101,
  884. Processing_102 = 102,
  885. EarlyHints_103 = 103,
  886. // Successful responses
  887. OK_200 = 200,
  888. Created_201 = 201,
  889. Accepted_202 = 202,
  890. NonAuthoritativeInformation_203 = 203,
  891. NoContent_204 = 204,
  892. ResetContent_205 = 205,
  893. PartialContent_206 = 206,
  894. MultiStatus_207 = 207,
  895. AlreadyReported_208 = 208,
  896. IMUsed_226 = 226,
  897. // Redirection messages
  898. MultipleChoices_300 = 300,
  899. MovedPermanently_301 = 301,
  900. Found_302 = 302,
  901. SeeOther_303 = 303,
  902. NotModified_304 = 304,
  903. UseProxy_305 = 305,
  904. unused_306 = 306,
  905. TemporaryRedirect_307 = 307,
  906. PermanentRedirect_308 = 308,
  907. // Client error responses
  908. BadRequest_400 = 400,
  909. Unauthorized_401 = 401,
  910. PaymentRequired_402 = 402,
  911. Forbidden_403 = 403,
  912. NotFound_404 = 404,
  913. MethodNotAllowed_405 = 405,
  914. NotAcceptable_406 = 406,
  915. ProxyAuthenticationRequired_407 = 407,
  916. RequestTimeout_408 = 408,
  917. Conflict_409 = 409,
  918. Gone_410 = 410,
  919. LengthRequired_411 = 411,
  920. PreconditionFailed_412 = 412,
  921. PayloadTooLarge_413 = 413,
  922. UriTooLong_414 = 414,
  923. UnsupportedMediaType_415 = 415,
  924. RangeNotSatisfiable_416 = 416,
  925. ExpectationFailed_417 = 417,
  926. ImATeapot_418 = 418,
  927. MisdirectedRequest_421 = 421,
  928. UnprocessableContent_422 = 422,
  929. Locked_423 = 423,
  930. FailedDependency_424 = 424,
  931. TooEarly_425 = 425,
  932. UpgradeRequired_426 = 426,
  933. PreconditionRequired_428 = 428,
  934. TooManyRequests_429 = 429,
  935. RequestHeaderFieldsTooLarge_431 = 431,
  936. UnavailableForLegalReasons_451 = 451,
  937. // Server error responses
  938. InternalServerError_500 = 500,
  939. NotImplemented_501 = 501,
  940. BadGateway_502 = 502,
  941. ServiceUnavailable_503 = 503,
  942. GatewayTimeout_504 = 504,
  943. HttpVersionNotSupported_505 = 505,
  944. VariantAlsoNegotiates_506 = 506,
  945. InsufficientStorage_507 = 507,
  946. LoopDetected_508 = 508,
  947. NotExtended_510 = 510,
  948. NetworkAuthenticationRequired_511 = 511,
  949. };
  950. namespace detail {
  951. // A multimap that keeps its entries in the order they were inserted.
  952. //
  953. // HTTP needs that order in two places. RFC 9110 5.3 makes the order of header
  954. // fields sharing a field name significant and forbids a proxy from reordering
  955. // them, and a query string's parameters are meaningful in the order the caller
  956. // wrote them. Neither standard container expresses it: std::unordered_multimap
  957. // gives no ordering guarantee at all for equivalent keys (libstdc++ yields
  958. // reverse insertion order, libc++ insertion order), and std::multimap sorts by
  959. // key, which would drop control data such as Host behind whatever else the
  960. // message carries and alphabetise a query string.
  961. //
  962. // Entries are therefore kept in a flat vector, in order. Lookup is a linear
  963. // scan, which beats hashing for the handful of entries a message carries
  964. // (headers are capped at CPPHTTPLIB_HEADER_MAX_COUNT).
  965. //
  966. // KeyEqual compares keys; it is what makes Headers case-insensitive and
  967. // Params, whose parameter names are case-sensitive, not.
  968. template <typename Mapped, typename KeyEqual> class insertion_ordered_multimap {
  969. public:
  970. using key_type = std::string;
  971. using mapped_type = Mapped;
  972. using value_type = std::pair<std::string, Mapped>;
  973. using size_type = std::size_t;
  974. using difference_type = std::ptrdiff_t;
  975. using reference = value_type &;
  976. using const_reference = const value_type &;
  977. private:
  978. static size_type npos() { return static_cast<size_type>(-1); }
  979. static bool keys_equal(const std::string &a, const std::string &b) {
  980. return KeyEqual()(a, b);
  981. }
  982. // Iterating yields every entry in insertion order, but equal_range() and
  983. // find() have to walk only the entries sharing one key, which are not
  984. // adjacent. Both are the same iterator type: key_idx_ selects between the
  985. // two traversals, and since equality compares only the position, an iterator
  986. // restricted to one key still compares equal to end().
  987. template <typename V> class iterator_t {
  988. public:
  989. using iterator_category = std::bidirectional_iterator_tag;
  990. using value_type = insertion_ordered_multimap::value_type;
  991. using difference_type = insertion_ordered_multimap::difference_type;
  992. using pointer = V *;
  993. using reference = V &;
  994. iterator_t() : data_(nullptr), idx_(0), size_(0), key_idx_(npos()) {}
  995. template <typename U,
  996. typename std::enable_if<std::is_convertible<U *, V *>::value,
  997. int>::type = 0>
  998. iterator_t(const iterator_t<U> &rhs)
  999. : data_(rhs.data_), idx_(rhs.idx_), size_(rhs.size_),
  1000. key_idx_(rhs.key_idx_) {}
  1001. reference operator*() const { return data_[idx_]; }
  1002. pointer operator->() const { return data_ + idx_; }
  1003. iterator_t &operator++() {
  1004. // Saturating, so that advancing past the last entry of a key stays at
  1005. // end() instead of running off the container.
  1006. if (idx_ >= size_) { return *this; }
  1007. ++idx_;
  1008. if (key_idx_ != npos()) {
  1009. while (idx_ < size_ && !matches(idx_)) {
  1010. ++idx_;
  1011. }
  1012. }
  1013. return *this;
  1014. }
  1015. iterator_t operator++(int) {
  1016. auto tmp = *this;
  1017. ++*this;
  1018. return tmp;
  1019. }
  1020. iterator_t &operator--() {
  1021. if (idx_ == 0) { return *this; }
  1022. --idx_;
  1023. if (key_idx_ != npos()) {
  1024. while (idx_ > 0 && !matches(idx_)) {
  1025. --idx_;
  1026. }
  1027. }
  1028. return *this;
  1029. }
  1030. iterator_t operator--(int) {
  1031. auto tmp = *this;
  1032. --*this;
  1033. return tmp;
  1034. }
  1035. template <typename U> bool operator==(const iterator_t<U> &rhs) const {
  1036. return idx_ == rhs.idx_;
  1037. }
  1038. template <typename U> bool operator!=(const iterator_t<U> &rhs) const {
  1039. return idx_ != rhs.idx_;
  1040. }
  1041. private:
  1042. friend class insertion_ordered_multimap;
  1043. template <typename> friend class iterator_t;
  1044. iterator_t(V *data, size_type idx, size_type size, size_type key_idx)
  1045. : data_(data), idx_(idx), size_(size), key_idx_(key_idx) {}
  1046. bool matches(size_type i) const {
  1047. return keys_equal(data_[i].first, data_[key_idx_].first);
  1048. }
  1049. V *data_;
  1050. size_type idx_;
  1051. size_type size_;
  1052. size_type key_idx_;
  1053. };
  1054. public:
  1055. using iterator = iterator_t<value_type>;
  1056. using const_iterator = iterator_t<const value_type>;
  1057. insertion_ordered_multimap() = default;
  1058. insertion_ordered_multimap(std::initializer_list<value_type> il)
  1059. : entries_(il) {}
  1060. template <typename InputIt>
  1061. insertion_ordered_multimap(InputIt first, InputIt last)
  1062. : entries_(first, last) {}
  1063. iterator begin() { return make_iter(0, npos()); }
  1064. iterator end() { return make_iter(entries_.size(), npos()); }
  1065. const_iterator begin() const { return make_citer(0, npos()); }
  1066. const_iterator end() const { return make_citer(entries_.size(), npos()); }
  1067. const_iterator cbegin() const { return begin(); }
  1068. const_iterator cend() const { return end(); }
  1069. bool empty() const { return entries_.empty(); }
  1070. size_type size() const { return entries_.size(); }
  1071. void clear() { entries_.clear(); }
  1072. void swap(insertion_ordered_multimap &rhs) { entries_.swap(rhs.entries_); }
  1073. iterator insert(const value_type &val) {
  1074. entries_.push_back(val);
  1075. return make_iter(entries_.size() - 1, npos());
  1076. }
  1077. iterator insert(value_type &&val) {
  1078. entries_.push_back(std::move(val));
  1079. return make_iter(entries_.size() - 1, npos());
  1080. }
  1081. template <typename... Args> iterator emplace(Args &&...args) {
  1082. entries_.emplace_back(std::forward<Args>(args)...);
  1083. return make_iter(entries_.size() - 1, npos());
  1084. }
  1085. // For entries that have to lead the message, such as the Host header field
  1086. // (RFC 9110 5.3 recommends sending control data first).
  1087. template <typename... Args> iterator emplace_front(Args &&...args) {
  1088. entries_.emplace(entries_.begin(), std::forward<Args>(args)...);
  1089. return make_iter(0, npos());
  1090. }
  1091. iterator find(const std::string &key) {
  1092. auto i = index_of(key);
  1093. return i == npos() ? end() : make_iter(i, i);
  1094. }
  1095. const_iterator find(const std::string &key) const {
  1096. auto i = index_of(key);
  1097. return i == npos() ? end() : make_citer(i, i);
  1098. }
  1099. size_type count(const std::string &key) const {
  1100. size_type n = 0;
  1101. for (const auto &entry : entries_) {
  1102. if (keys_equal(entry.first, key)) { n++; }
  1103. }
  1104. return n;
  1105. }
  1106. std::pair<iterator, iterator> equal_range(const std::string &key) {
  1107. auto i = index_of(key);
  1108. return i == npos() ? std::make_pair(end(), end())
  1109. : std::make_pair(make_iter(i, i), end());
  1110. }
  1111. std::pair<const_iterator, const_iterator>
  1112. equal_range(const std::string &key) const {
  1113. auto i = index_of(key);
  1114. return i == npos() ? std::make_pair(end(), end())
  1115. : std::make_pair(make_citer(i, i), end());
  1116. }
  1117. size_type erase(const std::string &key) {
  1118. auto before = entries_.size();
  1119. entries_.erase(std::remove_if(entries_.begin(), entries_.end(),
  1120. [&](const value_type &entry) {
  1121. return keys_equal(entry.first, key);
  1122. }),
  1123. entries_.end());
  1124. return before - entries_.size();
  1125. }
  1126. iterator erase(const_iterator pos) {
  1127. entries_.erase(entries_.begin() + static_cast<difference_type>(pos.idx_));
  1128. return make_iter(pos.idx_, npos());
  1129. }
  1130. // Erases what iterating [first, last) would actually visit, so erasing an
  1131. // equal_range() removes only the entries with that key, not everything
  1132. // positioned between them.
  1133. iterator erase(const_iterator first, const_iterator last) {
  1134. auto from = first.idx_;
  1135. auto to = last.idx_;
  1136. if (from >= to) { return make_iter(from, npos()); }
  1137. auto begin_it = entries_.begin();
  1138. auto from_it = begin_it + static_cast<difference_type>(from);
  1139. auto to_it = begin_it + static_cast<difference_type>(to);
  1140. if (first.key_idx_ == npos()) {
  1141. entries_.erase(from_it, to_it);
  1142. } else {
  1143. auto key = entries_[first.key_idx_].first;
  1144. auto keep = from_it;
  1145. for (auto it = from_it; it != to_it; ++it) {
  1146. if (!keys_equal(it->first, key)) {
  1147. if (keep != it) { *keep = std::move(*it); }
  1148. ++keep;
  1149. }
  1150. }
  1151. if (keep != to_it) {
  1152. keep = std::move(to_it, entries_.end(), keep);
  1153. } else {
  1154. keep = entries_.end();
  1155. }
  1156. entries_.erase(keep, entries_.end());
  1157. }
  1158. return make_iter(from, npos());
  1159. }
  1160. friend bool operator==(const insertion_ordered_multimap &lhs,
  1161. const insertion_ordered_multimap &rhs) {
  1162. return lhs.entries_ == rhs.entries_;
  1163. }
  1164. friend bool operator!=(const insertion_ordered_multimap &lhs,
  1165. const insertion_ordered_multimap &rhs) {
  1166. return !(lhs == rhs);
  1167. }
  1168. private:
  1169. size_type index_of(const std::string &key) const {
  1170. for (size_type i = 0; i < entries_.size(); i++) {
  1171. if (keys_equal(entries_[i].first, key)) { return i; }
  1172. }
  1173. return npos();
  1174. }
  1175. iterator make_iter(size_type idx, size_type key_idx) {
  1176. return iterator(entries_.data(), idx, entries_.size(), key_idx);
  1177. }
  1178. const_iterator make_citer(size_type idx, size_type key_idx) const {
  1179. return const_iterator(entries_.data(), idx, entries_.size(), key_idx);
  1180. }
  1181. std::vector<value_type> entries_;
  1182. };
  1183. } // namespace detail
  1184. using Headers =
  1185. detail::insertion_ordered_multimap<std::string,
  1186. detail::case_ignore::equal_to>;
  1187. // Query parameter names are case-sensitive, unlike header field names.
  1188. using Params =
  1189. detail::insertion_ordered_multimap<std::string, std::equal_to<std::string>>;
  1190. using Match = std::smatch;
  1191. using DownloadProgress = std::function<bool(size_t current, size_t total)>;
  1192. using UploadProgress = std::function<bool(size_t current, size_t total)>;
  1193. /*
  1194. * detail: type-erased storage used by UserData.
  1195. * ABI-stable regardless of C++ standard — always uses this custom
  1196. * implementation instead of std::any.
  1197. */
  1198. namespace detail {
  1199. using any_type_id = const void *;
  1200. template <typename T> any_type_id any_typeid() noexcept {
  1201. static const char id = 0;
  1202. return &id;
  1203. }
  1204. struct any_storage {
  1205. virtual ~any_storage() = default;
  1206. virtual std::unique_ptr<any_storage> clone() const = 0;
  1207. virtual any_type_id type_id() const noexcept = 0;
  1208. };
  1209. template <typename T> struct any_value final : any_storage {
  1210. T value;
  1211. template <typename U> explicit any_value(U &&v) : value(std::forward<U>(v)) {}
  1212. std::unique_ptr<any_storage> clone() const override {
  1213. return std::unique_ptr<any_storage>(new any_value<T>(value));
  1214. }
  1215. any_type_id type_id() const noexcept override { return any_typeid<T>(); }
  1216. };
  1217. } // namespace detail
  1218. class UserData {
  1219. public:
  1220. UserData() = default;
  1221. UserData(UserData &&) noexcept = default;
  1222. UserData &operator=(UserData &&) noexcept = default;
  1223. UserData(const UserData &o) {
  1224. for (const auto &e : o.entries_) {
  1225. if (e.second) { entries_[e.first] = e.second->clone(); }
  1226. }
  1227. }
  1228. UserData &operator=(const UserData &o) {
  1229. if (this != &o) {
  1230. entries_.clear();
  1231. for (const auto &e : o.entries_) {
  1232. if (e.second) { entries_[e.first] = e.second->clone(); }
  1233. }
  1234. }
  1235. return *this;
  1236. }
  1237. template <typename T> void set(const std::string &key, T &&value) {
  1238. using D = typename std::decay<T>::type;
  1239. entries_[key].reset(new detail::any_value<D>(std::forward<T>(value)));
  1240. }
  1241. template <typename T> T *get(const std::string &key) noexcept {
  1242. auto it = entries_.find(key);
  1243. if (it == entries_.end() || !it->second) { return nullptr; }
  1244. if (it->second->type_id() != detail::any_typeid<T>()) { return nullptr; }
  1245. return &static_cast<detail::any_value<T> *>(it->second.get())->value;
  1246. }
  1247. template <typename T> const T *get(const std::string &key) const noexcept {
  1248. auto it = entries_.find(key);
  1249. if (it == entries_.end() || !it->second) { return nullptr; }
  1250. if (it->second->type_id() != detail::any_typeid<T>()) { return nullptr; }
  1251. return &static_cast<const detail::any_value<T> *>(it->second.get())->value;
  1252. }
  1253. bool has(const std::string &key) const noexcept {
  1254. return entries_.find(key) != entries_.end();
  1255. }
  1256. void erase(const std::string &key) { entries_.erase(key); }
  1257. void clear() noexcept { entries_.clear(); }
  1258. private:
  1259. std::unordered_map<std::string, std::unique_ptr<detail::any_storage>>
  1260. entries_;
  1261. };
  1262. struct Response;
  1263. using ResponseHandler = std::function<bool(const Response &response)>;
  1264. struct FormData {
  1265. std::string name;
  1266. std::string content;
  1267. std::string filename;
  1268. std::string content_type;
  1269. Headers headers;
  1270. };
  1271. struct FormField {
  1272. std::string name;
  1273. std::string content;
  1274. Headers headers;
  1275. };
  1276. // RFC 7578 5.2: a form processor "SHOULD send back results in order" and
  1277. // "Intermediaries MUST NOT reorder the results", so a handler walking these
  1278. // should see the parts as they were sent. A std::multimap sorts by field name
  1279. // and loses that. Field names are case-sensitive, hence std::equal_to rather
  1280. // than the case-insensitive predicate Headers uses.
  1281. using FormFields =
  1282. detail::insertion_ordered_multimap<FormField, std::equal_to<std::string>>;
  1283. using FormFiles =
  1284. detail::insertion_ordered_multimap<FormData, std::equal_to<std::string>>;
  1285. struct MultipartFormData {
  1286. FormFields fields; // Text fields from multipart
  1287. FormFiles files; // Files from multipart
  1288. // Text field access
  1289. std::string get_field(const std::string &key, size_t id = 0) const;
  1290. std::vector<std::string> get_fields(const std::string &key) const;
  1291. bool has_field(const std::string &key) const;
  1292. size_t get_field_count(const std::string &key) const;
  1293. // File access
  1294. FormData get_file(const std::string &key, size_t id = 0) const;
  1295. std::vector<FormData> get_files(const std::string &key) const;
  1296. bool has_file(const std::string &key) const;
  1297. size_t get_file_count(const std::string &key) const;
  1298. };
  1299. struct UploadFormData {
  1300. std::string name;
  1301. std::string content;
  1302. std::string filename;
  1303. std::string content_type;
  1304. };
  1305. using UploadFormDataItems = std::vector<UploadFormData>;
  1306. class DataSink {
  1307. public:
  1308. DataSink() : os(&sb_), sb_(*this) {}
  1309. DataSink(const DataSink &) = delete;
  1310. DataSink &operator=(const DataSink &) = delete;
  1311. DataSink(DataSink &&) = delete;
  1312. DataSink &operator=(DataSink &&) = delete;
  1313. std::function<bool(const char *data, size_t data_len)> write;
  1314. // Only `write` is mandatory. The rest are defaulted so that a provider
  1315. // calling one on a writer that does not set it gets sensible behaviour
  1316. // rather than std::bad_function_call thrown from a worker thread. Capturing
  1317. // `this` is safe: DataSink is neither copyable nor movable.
  1318. std::function<bool()> is_writable = []() { return true; };
  1319. std::function<void()> done = []() {};
  1320. std::function<void(const Headers &trailer)> done_with_trailer =
  1321. [this](const Headers & /*trailer*/) { done(); };
  1322. std::ostream os;
  1323. private:
  1324. class data_sink_streambuf final : public std::streambuf {
  1325. public:
  1326. explicit data_sink_streambuf(DataSink &sink) : sink_(sink) {}
  1327. protected:
  1328. std::streamsize xsputn(const char *s, std::streamsize n) override {
  1329. if (sink_.write(s, static_cast<size_t>(n))) { return n; }
  1330. return 0;
  1331. }
  1332. private:
  1333. DataSink &sink_;
  1334. };
  1335. data_sink_streambuf sb_;
  1336. };
  1337. using ContentProvider =
  1338. std::function<bool(size_t offset, size_t length, DataSink &sink)>;
  1339. using ContentProviderWithoutLength =
  1340. std::function<bool(size_t offset, DataSink &sink)>;
  1341. using ContentProviderResourceReleaser = std::function<void(bool success)>;
  1342. struct FormDataProvider {
  1343. std::string name;
  1344. ContentProviderWithoutLength provider;
  1345. std::string filename;
  1346. std::string content_type;
  1347. };
  1348. using FormDataProviderItems = std::vector<FormDataProvider>;
  1349. inline FormDataProvider
  1350. make_file_provider(const std::string &name, const std::string &filepath,
  1351. const std::string &filename = std::string(),
  1352. const std::string &content_type = std::string()) {
  1353. FormDataProvider fdp;
  1354. fdp.name = name;
  1355. fdp.filename = filename.empty() ? filepath : filename;
  1356. fdp.content_type = content_type;
  1357. fdp.provider = [filepath](size_t offset, DataSink &sink) -> bool {
  1358. std::ifstream f(filepath, std::ios::binary);
  1359. if (!f) { return false; }
  1360. if (offset > 0) {
  1361. f.seekg(static_cast<std::streamoff>(offset));
  1362. if (!f.good()) {
  1363. sink.done();
  1364. return true;
  1365. }
  1366. }
  1367. char buf[8192];
  1368. f.read(buf, sizeof(buf));
  1369. auto n = static_cast<size_t>(f.gcount());
  1370. if (n > 0) { return sink.write(buf, n); }
  1371. sink.done(); // EOF
  1372. return true;
  1373. };
  1374. return fdp;
  1375. }
  1376. inline std::pair<size_t, ContentProvider>
  1377. make_file_body(const std::string &filepath) {
  1378. size_t size = 0;
  1379. {
  1380. std::ifstream f(filepath, std::ios::binary | std::ios::ate);
  1381. if (!f) { return {0, ContentProvider{}}; }
  1382. size = static_cast<size_t>(f.tellg());
  1383. }
  1384. ContentProvider provider = [filepath](size_t offset, size_t length,
  1385. DataSink &sink) -> bool {
  1386. std::ifstream f(filepath, std::ios::binary);
  1387. if (!f) { return false; }
  1388. f.seekg(static_cast<std::streamoff>(offset));
  1389. if (!f.good()) { return false; }
  1390. char buf[8192];
  1391. while (length > 0) {
  1392. auto to_read = (std::min)(sizeof(buf), length);
  1393. f.read(buf, static_cast<std::streamsize>(to_read));
  1394. auto n = static_cast<size_t>(f.gcount());
  1395. // The file is shorter than the size make_file_body() measured, which the
  1396. // caller has already committed to as Content-Length. The body cannot be
  1397. // completed, so fail as every other error here does.
  1398. if (n == 0) { return false; }
  1399. if (!sink.write(buf, n)) { return false; }
  1400. length -= n;
  1401. }
  1402. return true;
  1403. };
  1404. return {size, std::move(provider)};
  1405. }
  1406. using ContentReceiverWithProgress = std::function<bool(
  1407. const char *data, size_t data_length, size_t offset, size_t total_length)>;
  1408. using ContentReceiver =
  1409. std::function<bool(const char *data, size_t data_length)>;
  1410. using FormDataHeader = std::function<bool(const FormData &file)>;
  1411. class ContentReader {
  1412. public:
  1413. using Reader = std::function<bool(ContentReceiver receiver)>;
  1414. using FormDataReader =
  1415. std::function<bool(FormDataHeader header, ContentReceiver receiver)>;
  1416. ContentReader(Reader reader, FormDataReader multipart_reader)
  1417. : reader_(std::move(reader)),
  1418. formdata_reader_(std::move(multipart_reader)) {}
  1419. bool operator()(FormDataHeader header, ContentReceiver receiver) const {
  1420. return formdata_reader_(std::move(header), std::move(receiver));
  1421. }
  1422. bool operator()(ContentReceiver receiver) const {
  1423. return reader_(std::move(receiver));
  1424. }
  1425. Reader reader_;
  1426. FormDataReader formdata_reader_;
  1427. };
  1428. using Range = std::pair<ssize_t, ssize_t>;
  1429. using Ranges = std::vector<Range>;
  1430. #ifdef CPPHTTPLIB_SSL_ENABLED
  1431. // TLS abstraction layer - public type definitions and API
  1432. namespace tls {
  1433. // Opaque handles (defined as void* for abstraction)
  1434. using ctx_t = void *;
  1435. using session_t = void *;
  1436. using const_session_t = const void *; // For read-only session access
  1437. using cert_t = void *;
  1438. using ca_store_t = void *;
  1439. // TLS versions
  1440. enum class Version {
  1441. TLS1_2 = 0x0303,
  1442. TLS1_3 = 0x0304,
  1443. };
  1444. // Subject Alternative Names (SAN) entry types
  1445. enum class SanType { DNS, IP, EMAIL, URI, OTHER };
  1446. // SAN entry structure
  1447. struct SanEntry {
  1448. SanType type;
  1449. std::string value;
  1450. };
  1451. // Verification context for certificate verification callback
  1452. struct VerifyContext {
  1453. session_t session; // TLS session handle
  1454. cert_t cert; // Current certificate being verified
  1455. int depth; // Certificate chain depth (0 = leaf)
  1456. bool preverify_ok; // OpenSSL/Mbed TLS pre-verification result
  1457. long error_code; // Backend-specific error code (0 = no error)
  1458. const char *error_string; // Human-readable error description
  1459. // Certificate introspection methods
  1460. std::string subject_cn() const;
  1461. std::string issuer_name() const;
  1462. bool check_hostname(const char *hostname) const;
  1463. std::vector<SanEntry> sans() const;
  1464. bool validity(time_t &not_before, time_t &not_after) const;
  1465. std::string serial() const;
  1466. };
  1467. using VerifyCallback = std::function<bool(const VerifyContext &ctx)>;
  1468. // TlsError codes for TLS operations (backend-independent)
  1469. enum class ErrorCode : int {
  1470. Success = 0,
  1471. WantRead, // Non-blocking: need to wait for read
  1472. WantWrite, // Non-blocking: need to wait for write
  1473. PeerClosed, // Peer closed the connection
  1474. Fatal, // Unrecoverable error
  1475. SyscallError, // System call error (check sys_errno)
  1476. CertVerifyFailed, // Certificate verification failed
  1477. HostnameMismatch, // Hostname verification failed
  1478. };
  1479. // TLS error information
  1480. struct TlsError {
  1481. ErrorCode code = ErrorCode::Fatal;
  1482. uint64_t backend_code = 0; // OpenSSL: ERR_get_error(), mbedTLS: return value
  1483. int sys_errno = 0; // errno when SyscallError
  1484. // Convert verification error code to human-readable string
  1485. static std::string verify_error_to_string(long error_code);
  1486. };
  1487. // RAII wrapper for peer certificate
  1488. class PeerCert {
  1489. public:
  1490. PeerCert();
  1491. PeerCert(PeerCert &&other) noexcept;
  1492. PeerCert &operator=(PeerCert &&other) noexcept;
  1493. ~PeerCert();
  1494. PeerCert(const PeerCert &) = delete;
  1495. PeerCert &operator=(const PeerCert &) = delete;
  1496. explicit operator bool() const;
  1497. std::string subject_cn() const;
  1498. std::string issuer_name() const;
  1499. bool check_hostname(const char *hostname) const;
  1500. std::vector<SanEntry> sans() const;
  1501. bool validity(time_t &not_before, time_t &not_after) const;
  1502. std::string serial() const;
  1503. private:
  1504. explicit PeerCert(cert_t cert);
  1505. cert_t cert_ = nullptr;
  1506. friend PeerCert get_peer_cert_from_session(const_session_t session);
  1507. };
  1508. // Callback for TLS context setup (used by SSLServer constructor)
  1509. using ContextSetupCallback = std::function<bool(ctx_t ctx)>;
  1510. } // namespace tls
  1511. #endif
  1512. struct Request {
  1513. std::string method;
  1514. std::string path;
  1515. std::string matched_route;
  1516. Params params;
  1517. Headers headers;
  1518. Headers trailers;
  1519. std::string body;
  1520. std::string remote_addr;
  1521. int remote_port = -1;
  1522. std::string local_addr;
  1523. int local_port = -1;
  1524. // for server
  1525. std::string version;
  1526. std::string target;
  1527. MultipartFormData form;
  1528. Ranges ranges;
  1529. Match matches;
  1530. std::unordered_map<std::string, std::string> path_params;
  1531. std::function<bool()> is_connection_closed = []() { return true; };
  1532. // for client
  1533. std::vector<std::string> accept_content_types;
  1534. ResponseHandler response_handler;
  1535. ContentReceiverWithProgress content_receiver;
  1536. DownloadProgress download_progress;
  1537. UploadProgress upload_progress;
  1538. bool has_header(const std::string &key) const;
  1539. std::string get_header_value(const std::string &key, const char *def = "",
  1540. size_t id = 0) const;
  1541. size_t get_header_value_u64(const std::string &key, size_t def = 0,
  1542. size_t id = 0) const;
  1543. size_t get_header_value_count(const std::string &key) const;
  1544. void set_header(const std::string &key, const std::string &val);
  1545. bool has_trailer(const std::string &key) const;
  1546. std::string get_trailer_value(const std::string &key, size_t id = 0) const;
  1547. size_t get_trailer_value_count(const std::string &key) const;
  1548. bool has_param(const std::string &key) const;
  1549. std::string get_param_value(const std::string &key, size_t id = 0) const;
  1550. std::vector<std::string> get_param_values(const std::string &key) const;
  1551. size_t get_param_value_count(const std::string &key) const;
  1552. bool is_multipart_form_data() const;
  1553. // private members...
  1554. bool body_read_started_ = false;
  1555. bool body_consumed_ = false;
  1556. bool expect_100_continue_pending_ = false;
  1557. size_t redirect_count_ = CPPHTTPLIB_REDIRECT_MAX_COUNT;
  1558. size_t content_length_ = 0;
  1559. ContentProvider content_provider_;
  1560. bool is_chunked_content_provider_ = false;
  1561. size_t authorization_count_ = 0;
  1562. std::chrono::time_point<std::chrono::steady_clock> start_time_ =
  1563. (std::chrono::steady_clock::time_point::min)();
  1564. #ifdef CPPHTTPLIB_SSL_ENABLED
  1565. tls::const_session_t ssl = nullptr;
  1566. tls::PeerCert peer_cert() const;
  1567. std::string sni() const;
  1568. #endif
  1569. };
  1570. namespace detail {
  1571. // Declared up here, away from the rest of the compression helpers, because
  1572. // `Response` stores one.
  1573. enum class EncodingType { None = 0, Gzip, Brotli, Zstd };
  1574. } // namespace detail
  1575. struct Response {
  1576. std::string version;
  1577. int status = -1;
  1578. std::string reason;
  1579. Headers headers;
  1580. Headers trailers;
  1581. std::string body;
  1582. std::string location; // Redirect location
  1583. // User-defined context — set by pre-routing/pre-request handlers and read
  1584. // by route handlers to pass arbitrary data (e.g. decoded auth tokens).
  1585. UserData user_data;
  1586. bool has_header(const std::string &key) const;
  1587. std::string get_header_value(const std::string &key, const char *def = "",
  1588. size_t id = 0) const;
  1589. size_t get_header_value_u64(const std::string &key, size_t def = 0,
  1590. size_t id = 0) const;
  1591. size_t get_header_value_count(const std::string &key) const;
  1592. void set_header(const std::string &key, const std::string &val);
  1593. bool has_trailer(const std::string &key) const;
  1594. std::string get_trailer_value(const std::string &key, size_t id = 0) const;
  1595. size_t get_trailer_value_count(const std::string &key) const;
  1596. void set_redirect(const std::string &url, int status = StatusCode::Found_302);
  1597. void set_content(const char *s, size_t n, const std::string &content_type);
  1598. void set_content(const std::string &s, const std::string &content_type);
  1599. void set_content(std::string &&s, const std::string &content_type);
  1600. void set_content_provider(
  1601. size_t length, const std::string &content_type, ContentProvider provider,
  1602. ContentProviderResourceReleaser resource_releaser = nullptr);
  1603. void set_content_provider(
  1604. const std::string &content_type, ContentProviderWithoutLength provider,
  1605. ContentProviderResourceReleaser resource_releaser = nullptr);
  1606. void set_chunked_content_provider(
  1607. const std::string &content_type, ContentProviderWithoutLength provider,
  1608. ContentProviderResourceReleaser resource_releaser = nullptr);
  1609. void set_file_content(const std::string &path,
  1610. const std::string &content_type);
  1611. void set_file_content(const std::string &path);
  1612. Response() = default;
  1613. Response(const Response &) = default;
  1614. Response &operator=(const Response &) = default;
  1615. Response(Response &&) = default;
  1616. Response &operator=(Response &&) = default;
  1617. ~Response() {
  1618. if (content_provider_resource_releaser_) {
  1619. content_provider_resource_releaser_(content_provider_success_);
  1620. }
  1621. }
  1622. // private members...
  1623. size_t content_length_ = 0;
  1624. ContentProvider content_provider_;
  1625. ContentProviderResourceReleaser content_provider_resource_releaser_;
  1626. bool is_chunked_content_provider_ = false;
  1627. bool is_file_content_provider_ = false;
  1628. bool content_provider_success_ = false;
  1629. std::string file_content_path_;
  1630. std::string file_content_content_type_;
  1631. // Content coding chosen for the response body, decided once so that the
  1632. // headers and the body cannot disagree: where the file is opened for a
  1633. // file-backed content provider (keeping the ETag honest), and in
  1634. // `apply_ranges()` for a chunked content provider. `EncodingType::None`
  1635. // for every other kind of response.
  1636. detail::EncodingType content_coding_ = detail::EncodingType::None;
  1637. };
  1638. enum class Error {
  1639. Success = 0,
  1640. Unknown,
  1641. Connection,
  1642. BindIPAddress,
  1643. Read,
  1644. Write,
  1645. ExceedRedirectCount,
  1646. Canceled,
  1647. SSLConnection,
  1648. SSLLoadingCerts,
  1649. SSLServerVerification,
  1650. SSLServerHostnameVerification,
  1651. UnsupportedMultipartBoundaryChars,
  1652. Compression,
  1653. ConnectionTimeout,
  1654. ProxyConnection,
  1655. ConnectionClosed,
  1656. Timeout,
  1657. ResourceExhaustion,
  1658. TooManyFormDataFiles,
  1659. ExceedMaxPayloadSize,
  1660. ExceedUriMaxLength,
  1661. ExceedMaxSocketDescriptorCount,
  1662. InvalidRequestLine,
  1663. InvalidHTTPMethod,
  1664. InvalidHTTPVersion,
  1665. InvalidHeaders,
  1666. MultipartParsing,
  1667. OpenFile,
  1668. Listen,
  1669. GetSockName,
  1670. UnsupportedAddressFamily,
  1671. HTTPParsing,
  1672. InvalidRangeHeader,
  1673. UnsupportedContentEncoding,
  1674. WebSocketHandshake,
  1675. UserCallbackException,
  1676. // For internal use only
  1677. SSLPeerCouldBeClosed_,
  1678. };
  1679. std::string to_string(Error error);
  1680. std::ostream &operator<<(std::ostream &os, const Error &obj);
  1681. class Stream {
  1682. public:
  1683. virtual ~Stream() = default;
  1684. virtual bool is_readable() const = 0;
  1685. virtual bool wait_readable() const = 0;
  1686. virtual bool wait_writable() const = 0;
  1687. virtual bool is_peer_alive() const { return wait_writable(); }
  1688. virtual ssize_t read(char *ptr, size_t size) = 0;
  1689. virtual ssize_t write(const char *ptr, size_t size) = 0;
  1690. virtual void get_remote_ip_and_port(std::string &ip, int &port) const = 0;
  1691. virtual void get_local_ip_and_port(std::string &ip, int &port) const = 0;
  1692. virtual socket_t socket() const = 0;
  1693. virtual time_t duration() const = 0;
  1694. virtual void set_read_timeout(time_t sec, time_t usec = 0) {
  1695. (void)sec;
  1696. (void)usec;
  1697. }
  1698. // Bounds the reads from now on to `msec` in total, on top of the timeout of
  1699. // each one. 0 lifts the bound.
  1700. virtual void set_max_timeout(time_t msec) { (void)msec; }
  1701. // Bytes already pulled off the socket and sitting in this stream's own
  1702. // buffer. Exposing them lets a line reader scan for a terminator in one
  1703. // pass instead of asking for a byte at a time. A stream that does no
  1704. // buffering of its own reports none, and readers fall back to read().
  1705. virtual const char *buffered_data(size_t &size) const {
  1706. size = 0;
  1707. return nullptr;
  1708. }
  1709. // Discards `size` bytes previously returned by buffered_data().
  1710. virtual void consume_buffered(size_t size) { (void)size; }
  1711. ssize_t write(const char *ptr);
  1712. ssize_t write(const std::string &s);
  1713. Error get_error() const { return error_; }
  1714. protected:
  1715. Error error_ = Error::Success;
  1716. };
  1717. class TaskQueue {
  1718. public:
  1719. TaskQueue() = default;
  1720. virtual ~TaskQueue() = default;
  1721. virtual bool enqueue(std::function<void()> fn) = 0;
  1722. virtual void shutdown() = 0;
  1723. virtual void on_idle() {}
  1724. };
  1725. class ThreadPool final : public TaskQueue {
  1726. public:
  1727. explicit ThreadPool(
  1728. size_t n, size_t max_n = 0, size_t mqr = 0,
  1729. time_t idle_timeout_sec = CPPHTTPLIB_THREAD_POOL_IDLE_TIMEOUT);
  1730. ThreadPool(const ThreadPool &) = delete;
  1731. ~ThreadPool() override = default;
  1732. bool enqueue(std::function<void()> fn) override;
  1733. void shutdown() override;
  1734. private:
  1735. void worker(bool is_dynamic);
  1736. void move_to_finished(std::thread::id id);
  1737. void cleanup_finished_threads();
  1738. size_t base_thread_count_;
  1739. size_t max_thread_count_;
  1740. size_t max_queued_requests_;
  1741. time_t idle_timeout_sec_;
  1742. size_t idle_thread_count_;
  1743. bool shutdown_;
  1744. std::list<std::function<void()>> jobs_;
  1745. std::vector<std::thread> threads_; // base threads
  1746. std::list<std::thread> dynamic_threads_; // dynamic threads
  1747. std::vector<std::thread>
  1748. finished_threads_; // exited dynamic threads awaiting join
  1749. std::condition_variable cond_;
  1750. std::mutex mutex_;
  1751. };
  1752. using Logger = std::function<void(const Request &, const Response &)>;
  1753. // Forward declaration for Error type
  1754. enum class Error;
  1755. using ErrorLogger = std::function<void(const Error &, const Request *)>;
  1756. using SocketOptions = std::function<void(socket_t sock)>;
  1757. void default_socket_options(socket_t sock);
  1758. bool set_socket_opt(socket_t sock, int level, int optname, int optval);
  1759. const char *status_message(int status);
  1760. std::string to_string(Error error);
  1761. std::ostream &operator<<(std::ostream &os, const Error &obj);
  1762. std::string get_bearer_token_auth(const Request &req);
  1763. namespace detail {
  1764. class MatcherBase {
  1765. public:
  1766. MatcherBase(std::string pattern) : pattern_(std::move(pattern)) {}
  1767. virtual ~MatcherBase() = default;
  1768. const std::string &pattern() const { return pattern_; }
  1769. // Match request path and populate its matches and
  1770. virtual bool match(Request &request) const = 0;
  1771. private:
  1772. std::string pattern_;
  1773. };
  1774. /**
  1775. * Captures parameters in request path and stores them in Request::path_params
  1776. *
  1777. * Capture name is a substring of a pattern from : to /.
  1778. * The rest of the pattern is matched against the request path directly
  1779. * Parameters are captured starting from the next character after
  1780. * the end of the last matched static pattern fragment until the next /.
  1781. *
  1782. * Example pattern:
  1783. * "/path/fragments/:capture/more/fragments/:second_capture"
  1784. * Static fragments:
  1785. * "/path/fragments/", "more/fragments/"
  1786. *
  1787. * Given the following request path:
  1788. * "/path/fragments/:1/more/fragments/:2"
  1789. * the resulting capture will be
  1790. * {{"capture", "1"}, {"second_capture", "2"}}
  1791. */
  1792. class PathParamsMatcher final : public MatcherBase {
  1793. public:
  1794. PathParamsMatcher(const std::string &pattern);
  1795. bool match(Request &request) const override;
  1796. private:
  1797. // Treat segment separators as the end of path parameter capture
  1798. // Does not need to handle query parameters as they are parsed before path
  1799. // matching
  1800. static constexpr char separator = '/';
  1801. // Contains static path fragments to match against, excluding the '/' after
  1802. // path params
  1803. // Fragments are separated by path params
  1804. std::vector<std::string> static_fragments_;
  1805. // Stores the names of the path parameters to be used as keys in the
  1806. // Request::path_params map
  1807. std::vector<std::string> param_names_;
  1808. };
  1809. /**
  1810. * Performs std::regex_match on request path
  1811. * and stores the result in Request::matches
  1812. *
  1813. * Note that regex match is performed directly on the whole request.
  1814. * This means that wildcard patterns may match multiple path segments with /:
  1815. * "/begin/(.*)/end" will match both "/begin/middle/end" and "/begin/1/2/end".
  1816. */
  1817. class RegexMatcher final : public MatcherBase {
  1818. public:
  1819. RegexMatcher(const std::string &pattern)
  1820. : MatcherBase(pattern), regex_(pattern) {}
  1821. bool match(Request &request) const override;
  1822. private:
  1823. std::regex regex_;
  1824. };
  1825. int close_socket(socket_t sock) noexcept;
  1826. bool is_accept_resource_error();
  1827. bool is_accept_transient_error();
  1828. ssize_t write_headers(Stream &strm, const Headers &headers);
  1829. bool set_socket_opt_time(socket_t sock, int level, int optname, time_t sec,
  1830. time_t usec);
  1831. size_t get_multipart_content_length(const UploadFormDataItems &items,
  1832. const std::string &boundary);
  1833. ContentProvider
  1834. make_multipart_content_provider(const UploadFormDataItems &items,
  1835. const std::string &boundary);
  1836. } // namespace detail
  1837. bool is_valid_multipart_boundary(const std::string &boundary);
  1838. // Serializer for multipart/form-data request bodies. The boundary is owned
  1839. // by the writer so that per-part framing and the final terminator always
  1840. // agree. Field names and filenames are escaped following the WHATWG HTML
  1841. // standard ('"' -> %22, CR -> %0D, LF -> %0A); CR and LF are also escaped
  1842. // in content types.
  1843. class MultipartFormDataWriter {
  1844. public:
  1845. MultipartFormDataWriter();
  1846. // precondition: is_valid_multipart_boundary(boundary)
  1847. explicit MultipartFormDataWriter(std::string boundary);
  1848. const std::string &boundary() const;
  1849. std::string content_type() const;
  1850. // In-memory items -> whole body (known length)
  1851. std::string serialize(const UploadFormDataItems &items) const;
  1852. size_t content_length(const UploadFormDataItems &items) const;
  1853. // Per-part framing for streaming via a content provider
  1854. std::string item_begin(const UploadFormData &item) const;
  1855. static std::string item_end();
  1856. std::string finish() const;
  1857. private:
  1858. std::string boundary_;
  1859. };
  1860. class Server {
  1861. public:
  1862. using Handler = std::function<void(const Request &, Response &)>;
  1863. using ExceptionHandler =
  1864. std::function<void(const Request &, Response &, std::exception_ptr ep)>;
  1865. enum class HandlerResponse {
  1866. Handled,
  1867. Unhandled,
  1868. };
  1869. using HandlerWithResponse =
  1870. std::function<HandlerResponse(const Request &, Response &)>;
  1871. using HandlerWithContentReader = std::function<void(
  1872. const Request &, Response &, const ContentReader &content_reader)>;
  1873. using Expect100ContinueHandler =
  1874. std::function<int(const Request &, Response &)>;
  1875. using StartHandler = std::function<void()>;
  1876. using WebSocketHandler =
  1877. std::function<void(const Request &, ws::WebSocket &)>;
  1878. using SubProtocolSelector =
  1879. std::function<std::string(const std::vector<std::string> &protocols)>;
  1880. Server();
  1881. virtual ~Server();
  1882. virtual bool is_valid() const;
  1883. Server &Get(const std::string &pattern, Handler handler);
  1884. Server &Post(const std::string &pattern, Handler handler);
  1885. Server &Post(const std::string &pattern, HandlerWithContentReader handler);
  1886. Server &Put(const std::string &pattern, Handler handler);
  1887. Server &Put(const std::string &pattern, HandlerWithContentReader handler);
  1888. Server &Patch(const std::string &pattern, Handler handler);
  1889. Server &Patch(const std::string &pattern, HandlerWithContentReader handler);
  1890. Server &Delete(const std::string &pattern, Handler handler);
  1891. Server &Delete(const std::string &pattern, HandlerWithContentReader handler);
  1892. Server &Options(const std::string &pattern, Handler handler);
  1893. // Register a handler for an HTTP method outside the built-in set (e.g. the
  1894. // WebDAV methods from RFC 4918). Registering a method here is what makes the
  1895. // server accept it; an unregistered method is still rejected with 400.
  1896. // `method` must be a valid HTTP method token and must not be one of the
  1897. // built-in methods, which have their own registration functions above. A
  1898. // rejected registration makes is_valid() return false, so listen() fails.
  1899. Server &CustomRoute(const std::string &method, const std::string &pattern,
  1900. Handler handler);
  1901. Server &CustomRoute(const std::string &method, const std::string &pattern,
  1902. HandlerWithContentReader handler);
  1903. Server &WebSocket(const std::string &pattern, WebSocketHandler handler);
  1904. Server &WebSocket(const std::string &pattern, WebSocketHandler handler,
  1905. SubProtocolSelector sub_protocol_selector);
  1906. bool set_base_dir(const std::string &dir,
  1907. const std::string &mount_point = std::string());
  1908. bool set_mount_point(const std::string &mount_point, const std::string &dir,
  1909. Headers headers = Headers());
  1910. bool remove_mount_point(const std::string &mount_point);
  1911. Server &set_file_extension_and_mimetype_mapping(const std::string &ext,
  1912. const std::string &mime);
  1913. Server &set_default_file_mimetype(const std::string &mime);
  1914. Server &set_file_request_handler(Handler handler);
  1915. template <class ErrorHandlerFunc>
  1916. Server &set_error_handler(ErrorHandlerFunc &&handler) {
  1917. return set_error_handler_core(
  1918. std::forward<ErrorHandlerFunc>(handler),
  1919. std::is_convertible<ErrorHandlerFunc, HandlerWithResponse>{});
  1920. }
  1921. Server &set_exception_handler(ExceptionHandler handler);
  1922. Server &set_pre_routing_handler(HandlerWithResponse handler);
  1923. Server &set_post_routing_handler(Handler handler);
  1924. Server &set_pre_request_handler(HandlerWithResponse handler);
  1925. Server &set_expect_100_continue_handler(Expect100ContinueHandler handler);
  1926. Server &set_start_handler(StartHandler handler);
  1927. Server &set_logger(Logger logger);
  1928. Server &set_pre_compression_logger(Logger logger);
  1929. Server &set_error_logger(ErrorLogger error_logger);
  1930. Server &set_address_family(int family);
  1931. Server &set_tcp_nodelay(bool on);
  1932. Server &set_ipv6_v6only(bool on);
  1933. Server &set_socket_options(SocketOptions socket_options);
  1934. Server &set_default_headers(Headers headers);
  1935. Server &
  1936. set_header_writer(std::function<ssize_t(Stream &, Headers &)> const &writer);
  1937. Server &set_trusted_proxies(const std::vector<std::string> &proxies);
  1938. Server &set_keep_alive_max_count(size_t count);
  1939. Server &set_keep_alive_timeout(time_t sec);
  1940. template <class Rep, class Period>
  1941. Server &
  1942. set_keep_alive_timeout(const std::chrono::duration<Rep, Period> &duration);
  1943. Server &set_read_timeout(time_t sec, time_t usec = 0);
  1944. template <class Rep, class Period>
  1945. Server &set_read_timeout(const std::chrono::duration<Rep, Period> &duration);
  1946. Server &set_write_timeout(time_t sec, time_t usec = 0);
  1947. template <class Rep, class Period>
  1948. Server &set_write_timeout(const std::chrono::duration<Rep, Period> &duration);
  1949. Server &set_idle_interval(time_t sec, time_t usec = 0);
  1950. template <class Rep, class Period>
  1951. Server &set_idle_interval(const std::chrono::duration<Rep, Period> &duration);
  1952. Server &set_payload_max_length(size_t length);
  1953. Server &set_static_file_compression(bool on);
  1954. Server &set_static_file_compression_min_length(size_t length);
  1955. Server &set_static_file_compression_max_length(size_t length);
  1956. Server &set_websocket_ping_interval(time_t sec);
  1957. template <class Rep, class Period>
  1958. Server &set_websocket_ping_interval(
  1959. const std::chrono::duration<Rep, Period> &duration);
  1960. Server &set_websocket_max_missed_pongs(int count);
  1961. bool bind_to_port(const std::string &host, int port, int socket_flags = 0);
  1962. int bind_to_any_port(const std::string &host, int socket_flags = 0);
  1963. bool listen_after_bind();
  1964. bool listen(const std::string &host, int port, int socket_flags = 0);
  1965. bool is_running() const;
  1966. void wait_until_ready() const;
  1967. void stop() noexcept;
  1968. void decommission();
  1969. std::function<TaskQueue *(void)> new_task_queue;
  1970. protected:
  1971. bool process_request(Stream &strm, const std::string &remote_addr,
  1972. int remote_port, const std::string &local_addr,
  1973. int local_port, bool close_connection,
  1974. bool &connection_closed,
  1975. const std::function<void(Request &)> &setup_request,
  1976. bool *websocket_upgraded = nullptr);
  1977. // Runs the per-connection serving loop and stops an exception thrown by a
  1978. // user callback from escaping the worker thread.
  1979. //
  1980. // process_request() wraps only routing() in a try/catch. Content providers,
  1981. // the post-routing, error, logging and expect-100 handlers and WebSocket
  1982. // handlers all run outside it, and the task queue calls the job without a
  1983. // catch, so an exception from any of those would terminate the process.
  1984. //
  1985. // No 500 is possible here: by the time a content provider runs, the status
  1986. // line and headers are already on the wire. Report it through the error
  1987. // logger and drop the connection, which is what the peer observes either
  1988. // way. Other connections are unaffected.
  1989. template <typename Serve> bool serve_guarded(Serve &&serve) const {
  1990. #ifdef CPPHTTPLIB_NO_EXCEPTIONS
  1991. return serve();
  1992. #else
  1993. try {
  1994. return serve();
  1995. } catch (...) {
  1996. // The error logger is a user callback too, so it must not be able to
  1997. // throw the guard back open.
  1998. try {
  1999. output_error_log(Error::UserCallbackException, nullptr);
  2000. } catch (...) {}
  2001. return false;
  2002. }
  2003. #endif
  2004. }
  2005. std::atomic<socket_t> svr_sock_{INVALID_SOCKET};
  2006. std::vector<std::string> trusted_proxies_;
  2007. size_t keep_alive_max_count_ = CPPHTTPLIB_KEEPALIVE_MAX_COUNT;
  2008. time_t keep_alive_timeout_sec_ = CPPHTTPLIB_KEEPALIVE_TIMEOUT_SECOND;
  2009. time_t read_timeout_sec_ = CPPHTTPLIB_SERVER_READ_TIMEOUT_SECOND;
  2010. time_t read_timeout_usec_ = CPPHTTPLIB_SERVER_READ_TIMEOUT_USECOND;
  2011. time_t write_timeout_sec_ = CPPHTTPLIB_SERVER_WRITE_TIMEOUT_SECOND;
  2012. time_t write_timeout_usec_ = CPPHTTPLIB_SERVER_WRITE_TIMEOUT_USECOND;
  2013. time_t idle_interval_sec_ = CPPHTTPLIB_IDLE_INTERVAL_SECOND;
  2014. time_t idle_interval_usec_ = CPPHTTPLIB_IDLE_INTERVAL_USECOND;
  2015. size_t payload_max_length_ = CPPHTTPLIB_PAYLOAD_MAX_LENGTH;
  2016. bool static_file_compression_ = false;
  2017. size_t static_file_compression_min_length_ =
  2018. CPPHTTPLIB_STATIC_FILE_COMPRESSION_MIN_LENGTH;
  2019. size_t static_file_compression_max_length_ =
  2020. CPPHTTPLIB_STATIC_FILE_COMPRESSION_MAX_LENGTH;
  2021. time_t websocket_ping_interval_sec_ =
  2022. CPPHTTPLIB_WEBSOCKET_PING_INTERVAL_SECOND;
  2023. int websocket_max_missed_pongs_ = CPPHTTPLIB_WEBSOCKET_MAX_MISSED_PONGS;
  2024. private:
  2025. using Handlers =
  2026. std::vector<std::pair<std::unique_ptr<detail::MatcherBase>, Handler>>;
  2027. using HandlersForContentReader =
  2028. std::vector<std::pair<std::unique_ptr<detail::MatcherBase>,
  2029. HandlerWithContentReader>>;
  2030. // Both handler tables for one custom method live in a single entry, so that
  2031. // routing() needs only one map lookup per request to reach either of them.
  2032. struct CustomHandlerEntry {
  2033. Handlers handlers;
  2034. HandlersForContentReader handlers_for_content_reader;
  2035. };
  2036. using CustomHandlers = std::map<std::string, CustomHandlerEntry>;
  2037. static std::unique_ptr<detail::MatcherBase>
  2038. make_matcher(const std::string &pattern);
  2039. static const std::set<std::string> &builtin_methods();
  2040. CustomHandlerEntry *custom_entry_for_registration(const std::string &method);
  2041. const CustomHandlerEntry *find_custom_entry(const std::string &method) const;
  2042. template <typename H>
  2043. Server &add_handler(
  2044. std::vector<std::pair<std::unique_ptr<detail::MatcherBase>, H>> &handlers,
  2045. const std::string &pattern, H handler) {
  2046. handlers.emplace_back(make_matcher(pattern), std::move(handler));
  2047. return *this;
  2048. }
  2049. Server &set_error_handler_core(HandlerWithResponse handler, std::true_type);
  2050. Server &set_error_handler_core(Handler handler, std::false_type);
  2051. socket_t create_server_socket(const std::string &host, int port,
  2052. int socket_flags,
  2053. SocketOptions socket_options) const;
  2054. int bind_internal(const std::string &host, int port, int socket_flags);
  2055. bool listen_internal();
  2056. bool routing(Request &req, Response &res, Stream &strm,
  2057. bool skip_pre_routing);
  2058. bool handle_file_request(Request &req, Response &res);
  2059. bool check_if_not_modified(const Request &req, Response &res,
  2060. const std::string &etag, time_t mtime) const;
  2061. bool check_if_range(Request &req, const std::string &etag,
  2062. time_t mtime) const;
  2063. bool dispatch_request(Request &req, Response &res, const Handlers &handlers,
  2064. Stream &strm);
  2065. bool dispatch_request_for_content_reader(
  2066. Request &req, Response &res, ContentReader content_reader,
  2067. const HandlersForContentReader &handlers) const;
  2068. bool parse_request_line(const char *s, Request &req) const;
  2069. detail::EncodingType static_file_encoding(const Request &req,
  2070. const Response &res,
  2071. const std::string &content_type,
  2072. size_t length) const;
  2073. bool apply_static_file_compression(const Request &req, Response &res) const;
  2074. void apply_ranges(const Request &req, Response &res,
  2075. std::string &content_type, std::string &boundary) const;
  2076. bool write_response(Stream &strm, bool close_connection, Request &req,
  2077. Response &res);
  2078. bool write_response_with_content(Stream &strm, bool close_connection,
  2079. const Request &req, Response &res);
  2080. bool write_response_core(Stream &strm, bool close_connection,
  2081. const Request &req, Response &res,
  2082. bool need_apply_ranges);
  2083. bool write_content_with_provider(Stream &strm, const Request &req,
  2084. Response &res, const std::string &boundary,
  2085. const std::string &content_type);
  2086. bool read_content(Stream &strm, Request &req, Response &res);
  2087. bool read_content_with_content_receiver(Stream &strm, Request &req,
  2088. Response &res,
  2089. ContentReceiver receiver,
  2090. FormDataHeader multipart_header,
  2091. ContentReceiver multipart_receiver);
  2092. bool read_content_core(Stream &strm, Request &req, Response &res,
  2093. ContentReceiver receiver,
  2094. FormDataHeader multipart_header,
  2095. ContentReceiver multipart_receiver) const;
  2096. virtual bool process_and_close_socket(socket_t sock);
  2097. void output_log(const Request &req, const Response &res) const;
  2098. void output_pre_compression_log(const Request &req,
  2099. const Response &res) const;
  2100. void output_error_log(const Error &err, const Request *req) const;
  2101. std::atomic<bool> is_running_{false};
  2102. std::atomic<bool> is_decommissioned{false};
  2103. // Set when CustomRoute() refuses a registration. Written before listen(),
  2104. // read by is_valid() on the same thread, so it needs no synchronization.
  2105. bool has_invalid_registration_ = false;
  2106. struct MountPointEntry {
  2107. std::string mount_point;
  2108. std::string base_dir;
  2109. std::string resolved_base_dir;
  2110. Headers headers;
  2111. };
  2112. std::vector<MountPointEntry> base_dirs_;
  2113. std::map<std::string, std::string> file_extension_and_mimetype_map_;
  2114. std::string default_file_mimetype_ = "application/octet-stream";
  2115. Handler file_request_handler_;
  2116. Handlers get_handlers_;
  2117. Handlers post_handlers_;
  2118. HandlersForContentReader post_handlers_for_content_reader_;
  2119. Handlers put_handlers_;
  2120. HandlersForContentReader put_handlers_for_content_reader_;
  2121. Handlers patch_handlers_;
  2122. HandlersForContentReader patch_handlers_for_content_reader_;
  2123. Handlers delete_handlers_;
  2124. HandlersForContentReader delete_handlers_for_content_reader_;
  2125. Handlers options_handlers_;
  2126. CustomHandlers custom_handlers_;
  2127. struct WebSocketHandlerEntry {
  2128. std::unique_ptr<detail::MatcherBase> matcher;
  2129. WebSocketHandler handler;
  2130. SubProtocolSelector sub_protocol_selector;
  2131. };
  2132. using WebSocketHandlers = std::vector<WebSocketHandlerEntry>;
  2133. WebSocketHandlers websocket_handlers_;
  2134. HandlerWithResponse error_handler_;
  2135. ExceptionHandler exception_handler_;
  2136. HandlerWithResponse pre_routing_handler_;
  2137. Handler post_routing_handler_;
  2138. HandlerWithResponse pre_request_handler_;
  2139. Expect100ContinueHandler expect_100_continue_handler_;
  2140. StartHandler start_handler_;
  2141. mutable std::mutex logger_mutex_;
  2142. Logger logger_;
  2143. Logger pre_compression_logger_;
  2144. ErrorLogger error_logger_;
  2145. int address_family_ = AF_UNSPEC;
  2146. bool tcp_nodelay_ = CPPHTTPLIB_TCP_NODELAY;
  2147. bool ipv6_v6only_ = CPPHTTPLIB_IPV6_V6ONLY;
  2148. SocketOptions socket_options_ = default_socket_options;
  2149. Headers default_headers_;
  2150. std::function<ssize_t(Stream &, Headers &)> header_writer_ =
  2151. detail::write_headers;
  2152. };
  2153. class Result {
  2154. public:
  2155. Result() = default;
  2156. Result(std::unique_ptr<Response> &&res, Error err,
  2157. Headers &&request_headers = Headers{})
  2158. : res_(std::move(res)), err_(err),
  2159. request_headers_(std::move(request_headers)) {}
  2160. // Response
  2161. operator bool() const { return res_ != nullptr; }
  2162. bool operator==(std::nullptr_t) const { return res_ == nullptr; }
  2163. bool operator!=(std::nullptr_t) const { return res_ != nullptr; }
  2164. const Response &value() const { return *res_; }
  2165. Response &value() { return *res_; }
  2166. const Response &operator*() const { return *res_; }
  2167. Response &operator*() { return *res_; }
  2168. const Response *operator->() const { return res_.get(); }
  2169. Response *operator->() { return res_.get(); }
  2170. // Error
  2171. Error error() const { return err_; }
  2172. // Request Headers
  2173. bool has_request_header(const std::string &key) const;
  2174. std::string get_request_header_value(const std::string &key,
  2175. const char *def = "",
  2176. size_t id = 0) const;
  2177. size_t get_request_header_value_u64(const std::string &key, size_t def = 0,
  2178. size_t id = 0) const;
  2179. size_t get_request_header_value_count(const std::string &key) const;
  2180. private:
  2181. std::unique_ptr<Response> res_;
  2182. Error err_ = Error::Unknown;
  2183. Headers request_headers_;
  2184. #ifdef CPPHTTPLIB_SSL_ENABLED
  2185. public:
  2186. Result(std::unique_ptr<Response> &&res, Error err, Headers &&request_headers,
  2187. int ssl_error)
  2188. : res_(std::move(res)), err_(err),
  2189. request_headers_(std::move(request_headers)), ssl_error_(ssl_error) {}
  2190. Result(std::unique_ptr<Response> &&res, Error err, Headers &&request_headers,
  2191. int ssl_error, uint64_t ssl_backend_error)
  2192. : res_(std::move(res)), err_(err),
  2193. request_headers_(std::move(request_headers)), ssl_error_(ssl_error),
  2194. ssl_backend_error_(ssl_backend_error) {}
  2195. int ssl_error() const { return ssl_error_; }
  2196. uint64_t ssl_backend_error() const { return ssl_backend_error_; }
  2197. private:
  2198. int ssl_error_ = 0;
  2199. uint64_t ssl_backend_error_ = 0;
  2200. #endif
  2201. };
  2202. struct ClientConnection {
  2203. socket_t sock = INVALID_SOCKET;
  2204. bool is_open() const { return sock != INVALID_SOCKET; }
  2205. ClientConnection() = default;
  2206. ~ClientConnection();
  2207. ClientConnection(const ClientConnection &) = delete;
  2208. ClientConnection &operator=(const ClientConnection &) = delete;
  2209. ClientConnection(ClientConnection &&other) noexcept
  2210. : sock(other.sock)
  2211. #ifdef CPPHTTPLIB_SSL_ENABLED
  2212. ,
  2213. session(other.session)
  2214. #endif
  2215. {
  2216. other.sock = INVALID_SOCKET;
  2217. #ifdef CPPHTTPLIB_SSL_ENABLED
  2218. other.session = nullptr;
  2219. #endif
  2220. }
  2221. ClientConnection &operator=(ClientConnection &&other) noexcept {
  2222. if (this != &other) {
  2223. sock = other.sock;
  2224. other.sock = INVALID_SOCKET;
  2225. #ifdef CPPHTTPLIB_SSL_ENABLED
  2226. session = other.session;
  2227. other.session = nullptr;
  2228. #endif
  2229. }
  2230. return *this;
  2231. }
  2232. #ifdef CPPHTTPLIB_SSL_ENABLED
  2233. tls::session_t session = nullptr;
  2234. #endif
  2235. };
  2236. namespace detail {
  2237. struct ChunkedDecoder;
  2238. struct BodyReader {
  2239. Stream *stream = nullptr;
  2240. bool has_content_length = false;
  2241. size_t content_length = 0;
  2242. size_t payload_max_length = CPPHTTPLIB_PAYLOAD_MAX_LENGTH;
  2243. size_t bytes_read = 0;
  2244. bool chunked = false;
  2245. bool eof = false;
  2246. std::unique_ptr<ChunkedDecoder> chunked_decoder;
  2247. Error last_error = Error::Success;
  2248. ssize_t read(char *buf, size_t len);
  2249. bool has_error() const { return last_error != Error::Success; }
  2250. };
  2251. inline ssize_t read_body_content(Stream *stream, BodyReader &br, char *buf,
  2252. size_t len) {
  2253. (void)stream;
  2254. return br.read(buf, len);
  2255. }
  2256. class decompressor;
  2257. enum class NoProxyKind {
  2258. Wildcard, // "*"
  2259. HostnameSuffix, // "example.com" or ".example.com"
  2260. IPv4Cidr, // "10.0.0.0/8" (or single IP, treated as /32)
  2261. IPv6Cidr, // "fe80::/10" (or single IP, treated as /128)
  2262. };
  2263. // Unified 16-byte buffer holding either a v4 (first 4 bytes) or v6 address.
  2264. // Lets one CIDR matcher cover both families.
  2265. using IPBytes = std::array<uint8_t, 16>;
  2266. struct NoProxyEntry {
  2267. NoProxyKind kind = NoProxyKind::Wildcard;
  2268. std::string hostname_pattern; // lowercased, leading/trailing dot stripped
  2269. IPBytes net{};
  2270. int prefix_bits = 0;
  2271. };
  2272. struct NormalizedTarget {
  2273. std::string hostname; // lowercase; brackets and trailing dot removed
  2274. bool is_ipv4 = false;
  2275. bool is_ipv6 = false;
  2276. IPBytes ip{};
  2277. };
  2278. } // namespace detail
  2279. class ClientImpl {
  2280. public:
  2281. explicit ClientImpl(const std::string &host);
  2282. explicit ClientImpl(const std::string &host, int port);
  2283. explicit ClientImpl(const std::string &host, int port,
  2284. const std::string &client_cert_path,
  2285. const std::string &client_key_path);
  2286. virtual ~ClientImpl();
  2287. virtual bool is_valid() const;
  2288. struct StreamHandle {
  2289. std::unique_ptr<Response> response;
  2290. Error error = Error::Success;
  2291. StreamHandle() = default;
  2292. StreamHandle(const StreamHandle &) = delete;
  2293. StreamHandle &operator=(const StreamHandle &) = delete;
  2294. StreamHandle(StreamHandle &&) = default;
  2295. StreamHandle &operator=(StreamHandle &&) = default;
  2296. ~StreamHandle() = default;
  2297. bool is_valid() const {
  2298. return response != nullptr && error == Error::Success;
  2299. }
  2300. ssize_t read(char *buf, size_t len);
  2301. void parse_trailers_if_needed();
  2302. Error get_read_error() const { return body_reader_.last_error; }
  2303. bool has_read_error() const { return body_reader_.has_error(); }
  2304. bool trailers_parsed_ = false;
  2305. private:
  2306. friend class ClientImpl;
  2307. friend class sse::SSEClient;
  2308. ssize_t read_with_decompression(char *buf, size_t len);
  2309. std::unique_ptr<ClientConnection> connection_;
  2310. std::unique_ptr<Stream> socket_stream_;
  2311. Stream *stream_ = nullptr;
  2312. detail::BodyReader body_reader_;
  2313. std::unique_ptr<detail::decompressor> decompressor_;
  2314. std::string decompress_buffer_;
  2315. size_t decompress_offset_ = 0;
  2316. size_t decompressed_bytes_read_ = 0;
  2317. };
  2318. // clang-format off
  2319. Result Get(const std::string &path, DownloadProgress progress = nullptr);
  2320. Result Get(const std::string &path, ContentReceiver content_receiver, DownloadProgress progress = nullptr);
  2321. Result Get(const std::string &path, ResponseHandler response_handler, ContentReceiver content_receiver, DownloadProgress progress = nullptr);
  2322. Result Get(const std::string &path, const Headers &headers, DownloadProgress progress = nullptr);
  2323. Result Get(const std::string &path, const Headers &headers, ContentReceiver content_receiver, DownloadProgress progress = nullptr);
  2324. Result Get(const std::string &path, const Headers &headers, ResponseHandler response_handler, ContentReceiver content_receiver, DownloadProgress progress = nullptr);
  2325. Result Get(const std::string &path, const Params &params, DownloadProgress progress = nullptr);
  2326. Result Get(const std::string &path, const Params &params, const Headers &headers, DownloadProgress progress = nullptr);
  2327. Result Get(const std::string &path, const Params &params, const Headers &headers, ContentReceiver content_receiver, DownloadProgress progress = nullptr);
  2328. Result Get(const std::string &path, const Params &params, const Headers &headers, ResponseHandler response_handler, ContentReceiver content_receiver, DownloadProgress progress = nullptr);
  2329. Result Head(const std::string &path);
  2330. Result Head(const std::string &path, const Headers &headers);
  2331. Result Post(const std::string &path);
  2332. Result Post(const std::string &path, const char *body, size_t content_length, const std::string &content_type, UploadProgress progress = nullptr);
  2333. Result Post(const std::string &path, const std::string &body, const std::string &content_type, UploadProgress progress = nullptr);
  2334. Result Post(const std::string &path, size_t content_length, ContentProvider content_provider, const std::string &content_type, UploadProgress progress = nullptr);
  2335. Result Post(const std::string &path, size_t content_length, ContentProvider content_provider, const std::string &content_type, ContentReceiver content_receiver, UploadProgress progress = nullptr);
  2336. Result Post(const std::string &path, ContentProviderWithoutLength content_provider, const std::string &content_type, UploadProgress progress = nullptr);
  2337. Result Post(const std::string &path, ContentProviderWithoutLength content_provider, const std::string &content_type, ContentReceiver content_receiver, UploadProgress progress = nullptr);
  2338. Result Post(const std::string &path, const Params &params);
  2339. Result Post(const std::string &path, const UploadFormDataItems &items, UploadProgress progress = nullptr);
  2340. Result Post(const std::string &path, const Headers &headers);
  2341. Result Post(const std::string &path, const Headers &headers, const char *body, size_t content_length, const std::string &content_type, UploadProgress progress = nullptr);
  2342. Result Post(const std::string &path, const Headers &headers, const std::string &body, const std::string &content_type, UploadProgress progress = nullptr);
  2343. Result Post(const std::string &path, const Headers &headers, size_t content_length, ContentProvider content_provider, const std::string &content_type, UploadProgress progress = nullptr);
  2344. Result Post(const std::string &path, const Headers &headers, size_t content_length, ContentProvider content_provider, const std::string &content_type, ContentReceiver content_receiver, DownloadProgress progress = nullptr);
  2345. Result Post(const std::string &path, const Headers &headers, ContentProviderWithoutLength content_provider, const std::string &content_type, UploadProgress progress = nullptr);
  2346. Result Post(const std::string &path, const Headers &headers, ContentProviderWithoutLength content_provider, const std::string &content_type, ContentReceiver content_receiver, DownloadProgress progress = nullptr);
  2347. Result Post(const std::string &path, const Headers &headers, const Params &params);
  2348. Result Post(const std::string &path, const Headers &headers, const UploadFormDataItems &items, UploadProgress progress = nullptr);
  2349. Result Post(const std::string &path, const Headers &headers, const UploadFormDataItems &items, const std::string &boundary, UploadProgress progress = nullptr);
  2350. Result Post(const std::string &path, const Headers &headers, const UploadFormDataItems &items, const FormDataProviderItems &provider_items, UploadProgress progress = nullptr);
  2351. Result Post(const std::string &path, const Headers &headers, const std::string &body, const std::string &content_type, ContentReceiver content_receiver, DownloadProgress progress = nullptr);
  2352. Result Put(const std::string &path);
  2353. Result Put(const std::string &path, const char *body, size_t content_length, const std::string &content_type, UploadProgress progress = nullptr);
  2354. Result Put(const std::string &path, const std::string &body, const std::string &content_type, UploadProgress progress = nullptr);
  2355. Result Put(const std::string &path, size_t content_length, ContentProvider content_provider, const std::string &content_type, UploadProgress progress = nullptr);
  2356. Result Put(const std::string &path, size_t content_length, ContentProvider content_provider, const std::string &content_type, ContentReceiver content_receiver, UploadProgress progress = nullptr);
  2357. Result Put(const std::string &path, ContentProviderWithoutLength content_provider, const std::string &content_type, UploadProgress progress = nullptr);
  2358. Result Put(const std::string &path, ContentProviderWithoutLength content_provider, const std::string &content_type, ContentReceiver content_receiver, UploadProgress progress = nullptr);
  2359. Result Put(const std::string &path, const Params &params);
  2360. Result Put(const std::string &path, const UploadFormDataItems &items, UploadProgress progress = nullptr);
  2361. Result Put(const std::string &path, const Headers &headers);
  2362. Result Put(const std::string &path, const Headers &headers, const char *body, size_t content_length, const std::string &content_type, UploadProgress progress = nullptr);
  2363. Result Put(const std::string &path, const Headers &headers, const std::string &body, const std::string &content_type, UploadProgress progress = nullptr);
  2364. Result Put(const std::string &path, const Headers &headers, size_t content_length, ContentProvider content_provider, const std::string &content_type, UploadProgress progress = nullptr);
  2365. Result Put(const std::string &path, const Headers &headers, size_t content_length, ContentProvider content_provider, const std::string &content_type, ContentReceiver content_receiver, UploadProgress progress = nullptr);
  2366. Result Put(const std::string &path, const Headers &headers, ContentProviderWithoutLength content_provider, const std::string &content_type, UploadProgress progress = nullptr);
  2367. Result Put(const std::string &path, const Headers &headers, ContentProviderWithoutLength content_provider, const std::string &content_type, ContentReceiver content_receiver, UploadProgress progress = nullptr);
  2368. Result Put(const std::string &path, const Headers &headers, const Params &params);
  2369. Result Put(const std::string &path, const Headers &headers, const UploadFormDataItems &items, UploadProgress progress = nullptr);
  2370. Result Put(const std::string &path, const Headers &headers, const UploadFormDataItems &items, const std::string &boundary, UploadProgress progress = nullptr);
  2371. Result Put(const std::string &path, const Headers &headers, const UploadFormDataItems &items, const FormDataProviderItems &provider_items, UploadProgress progress = nullptr);
  2372. Result Put(const std::string &path, const Headers &headers, const std::string &body, const std::string &content_type, ContentReceiver content_receiver, DownloadProgress progress = nullptr);
  2373. Result Patch(const std::string &path);
  2374. Result Patch(const std::string &path, const char *body, size_t content_length, const std::string &content_type, UploadProgress progress = nullptr);
  2375. Result Patch(const std::string &path, const std::string &body, const std::string &content_type, UploadProgress progress = nullptr);
  2376. Result Patch(const std::string &path, size_t content_length, ContentProvider content_provider, const std::string &content_type, UploadProgress progress = nullptr);
  2377. Result Patch(const std::string &path, size_t content_length, ContentProvider content_provider, const std::string &content_type, ContentReceiver content_receiver, UploadProgress progress = nullptr);
  2378. Result Patch(const std::string &path, ContentProviderWithoutLength content_provider, const std::string &content_type, UploadProgress progress = nullptr);
  2379. Result Patch(const std::string &path, ContentProviderWithoutLength content_provider, const std::string &content_type, ContentReceiver content_receiver, UploadProgress progress = nullptr);
  2380. Result Patch(const std::string &path, const Params &params);
  2381. Result Patch(const std::string &path, const UploadFormDataItems &items, UploadProgress progress = nullptr);
  2382. Result Patch(const std::string &path, const Headers &headers, UploadProgress progress = nullptr);
  2383. Result Patch(const std::string &path, const Headers &headers, const char *body, size_t content_length, const std::string &content_type, UploadProgress progress = nullptr);
  2384. Result Patch(const std::string &path, const Headers &headers, const std::string &body, const std::string &content_type, UploadProgress progress = nullptr);
  2385. Result Patch(const std::string &path, const Headers &headers, size_t content_length, ContentProvider content_provider, const std::string &content_type, UploadProgress progress = nullptr);
  2386. Result Patch(const std::string &path, const Headers &headers, size_t content_length, ContentProvider content_provider, const std::string &content_type, ContentReceiver content_receiver, UploadProgress progress = nullptr);
  2387. Result Patch(const std::string &path, const Headers &headers, ContentProviderWithoutLength content_provider, const std::string &content_type, UploadProgress progress = nullptr);
  2388. Result Patch(const std::string &path, const Headers &headers, ContentProviderWithoutLength content_provider, const std::string &content_type, ContentReceiver content_receiver, UploadProgress progress = nullptr);
  2389. Result Patch(const std::string &path, const Headers &headers, const Params &params);
  2390. Result Patch(const std::string &path, const Headers &headers, const UploadFormDataItems &items, UploadProgress progress = nullptr);
  2391. Result Patch(const std::string &path, const Headers &headers, const UploadFormDataItems &items, const std::string &boundary, UploadProgress progress = nullptr);
  2392. Result Patch(const std::string &path, const Headers &headers, const UploadFormDataItems &items, const FormDataProviderItems &provider_items, UploadProgress progress = nullptr);
  2393. Result Patch(const std::string &path, const Headers &headers, const std::string &body, const std::string &content_type, ContentReceiver content_receiver, DownloadProgress progress = nullptr);
  2394. Result Delete(const std::string &path, DownloadProgress progress = nullptr);
  2395. Result Delete(const std::string &path, const char *body, size_t content_length, const std::string &content_type, DownloadProgress progress = nullptr);
  2396. Result Delete(const std::string &path, const std::string &body, const std::string &content_type, DownloadProgress progress = nullptr);
  2397. Result Delete(const std::string &path, const Params &params, DownloadProgress progress = nullptr);
  2398. Result Delete(const std::string &path, const Headers &headers, DownloadProgress progress = nullptr);
  2399. Result Delete(const std::string &path, const Headers &headers, const char *body, size_t content_length, const std::string &content_type, DownloadProgress progress = nullptr);
  2400. Result Delete(const std::string &path, const Headers &headers, const std::string &body, const std::string &content_type, DownloadProgress progress = nullptr);
  2401. Result Delete(const std::string &path, const Headers &headers, const Params &params, DownloadProgress progress = nullptr);
  2402. Result Options(const std::string &path);
  2403. Result Options(const std::string &path, const Headers &headers);
  2404. // clang-format on
  2405. // Streaming API: Open a stream for reading response body incrementally
  2406. // Socket ownership is transferred to StreamHandle for true streaming
  2407. // Supports all HTTP methods (GET, POST, PUT, PATCH, DELETE, etc.)
  2408. StreamHandle open_stream(const std::string &method, const std::string &path,
  2409. const Params &params = {},
  2410. const Headers &headers = {},
  2411. const std::string &body = {},
  2412. const std::string &content_type = {});
  2413. bool send(Request &req, Response &res, Error &error);
  2414. Result send(const Request &req);
  2415. void stop();
  2416. std::string host() const;
  2417. int port() const;
  2418. size_t is_socket_open() const;
  2419. socket_t socket() const;
  2420. void set_hostname_addr_map(std::map<std::string, std::string> addr_map);
  2421. void set_default_headers(Headers headers);
  2422. void
  2423. set_header_writer(std::function<ssize_t(Stream &, Headers &)> const &writer);
  2424. void set_address_family(int family);
  2425. void set_tcp_nodelay(bool on);
  2426. void set_ipv6_v6only(bool on);
  2427. void set_socket_options(SocketOptions socket_options);
  2428. void set_connection_timeout(time_t sec, time_t usec = 0);
  2429. template <class Rep, class Period>
  2430. void
  2431. set_connection_timeout(const std::chrono::duration<Rep, Period> &duration);
  2432. void set_read_timeout(time_t sec, time_t usec = 0);
  2433. template <class Rep, class Period>
  2434. void set_read_timeout(const std::chrono::duration<Rep, Period> &duration);
  2435. void set_write_timeout(time_t sec, time_t usec = 0);
  2436. template <class Rep, class Period>
  2437. void set_write_timeout(const std::chrono::duration<Rep, Period> &duration);
  2438. void set_max_timeout(time_t msec);
  2439. template <class Rep, class Period>
  2440. void set_max_timeout(const std::chrono::duration<Rep, Period> &duration);
  2441. void set_basic_auth(const std::string &username, const std::string &password);
  2442. void set_bearer_token_auth(const std::string &token);
  2443. void set_keep_alive(bool on);
  2444. void set_follow_location(bool on);
  2445. void set_path_encode(bool on);
  2446. void set_compress(bool on);
  2447. void set_decompress(bool on);
  2448. void set_payload_max_length(size_t length);
  2449. void set_interface(const std::string &intf);
  2450. void set_proxy(const std::string &host, int port);
  2451. void set_proxy_basic_auth(const std::string &username,
  2452. const std::string &password);
  2453. void set_proxy_bearer_token_auth(const std::string &token);
  2454. void set_no_proxy(const std::vector<std::string> &patterns);
  2455. void set_logger(Logger logger);
  2456. void set_error_logger(ErrorLogger error_logger);
  2457. protected:
  2458. struct Socket {
  2459. socket_t sock = INVALID_SOCKET;
  2460. // For Mbed TLS compatibility: start_time for request timeout tracking
  2461. std::chrono::time_point<std::chrono::steady_clock> start_time_;
  2462. bool is_open() const { return sock != INVALID_SOCKET; }
  2463. #ifdef CPPHTTPLIB_SSL_ENABLED
  2464. tls::session_t ssl = nullptr;
  2465. #endif
  2466. };
  2467. virtual bool create_and_connect_socket(Socket &socket, Error &error);
  2468. virtual bool ensure_socket_connection(Socket &socket, Error &error);
  2469. virtual bool setup_proxy_connection(
  2470. Socket &socket,
  2471. std::chrono::time_point<std::chrono::steady_clock> start_time,
  2472. Response &res, bool &success, Error &error);
  2473. bool is_proxy_enabled_for_host(const std::string &host) const;
  2474. // All of:
  2475. // shutdown_ssl
  2476. // shutdown_socket
  2477. // close_socket
  2478. // disconnect
  2479. // should ONLY be called when socket_mutex_ is locked, and only when
  2480. // no other thread is using the socket.
  2481. virtual void shutdown_ssl(Socket &socket, bool shutdown_gracefully);
  2482. void shutdown_socket(Socket &socket) const;
  2483. void close_socket(Socket &socket);
  2484. void disconnect(bool gracefully);
  2485. std::string make_request_target(const Request &req) const;
  2486. bool process_request(Stream &strm, Request &req, Response &res,
  2487. bool close_connection, Error &error);
  2488. bool write_content_with_provider(Stream &strm, const Request &req,
  2489. Error &error) const;
  2490. void output_log(const Request &req, const Response &res) const;
  2491. void output_error_log(const Error &err, const Request *req) const;
  2492. // Socket endpoint information
  2493. const std::string host_;
  2494. const int port_;
  2495. // Current open socket
  2496. Socket socket_;
  2497. mutable std::mutex socket_mutex_;
  2498. std::recursive_mutex request_mutex_;
  2499. // These are all protected under socket_mutex
  2500. size_t socket_requests_in_flight_ = 0;
  2501. std::thread::id socket_requests_are_from_thread_ = std::thread::id();
  2502. bool socket_should_be_closed_when_request_is_done_ = false;
  2503. // Hostname to connection target map. The value is an IP literal or another
  2504. // hostname; only the connection target changes, never the identity.
  2505. std::map<std::string, std::string> addr_map_;
  2506. // Default headers
  2507. Headers default_headers_;
  2508. // Header writer
  2509. std::function<ssize_t(Stream &, Headers &)> header_writer_ =
  2510. detail::write_headers;
  2511. // Settings
  2512. std::string client_cert_path_;
  2513. std::string client_key_path_;
  2514. time_t connection_timeout_sec_ = CPPHTTPLIB_CONNECTION_TIMEOUT_SECOND;
  2515. time_t connection_timeout_usec_ = CPPHTTPLIB_CONNECTION_TIMEOUT_USECOND;
  2516. time_t read_timeout_sec_ = CPPHTTPLIB_CLIENT_READ_TIMEOUT_SECOND;
  2517. time_t read_timeout_usec_ = CPPHTTPLIB_CLIENT_READ_TIMEOUT_USECOND;
  2518. time_t write_timeout_sec_ = CPPHTTPLIB_CLIENT_WRITE_TIMEOUT_SECOND;
  2519. time_t write_timeout_usec_ = CPPHTTPLIB_CLIENT_WRITE_TIMEOUT_USECOND;
  2520. time_t max_timeout_msec_ = CPPHTTPLIB_CLIENT_MAX_TIMEOUT_MSECOND;
  2521. std::string basic_auth_username_;
  2522. std::string basic_auth_password_;
  2523. std::string bearer_token_auth_token_;
  2524. bool keep_alive_ = false;
  2525. bool follow_location_ = false;
  2526. bool path_encode_ = true;
  2527. int address_family_ = AF_UNSPEC;
  2528. bool tcp_nodelay_ = CPPHTTPLIB_TCP_NODELAY;
  2529. bool ipv6_v6only_ = CPPHTTPLIB_IPV6_V6ONLY;
  2530. SocketOptions socket_options_ = nullptr;
  2531. bool compress_ = false;
  2532. bool decompress_ = true;
  2533. size_t payload_max_length_ = CPPHTTPLIB_PAYLOAD_MAX_LENGTH;
  2534. bool has_payload_max_length_ = false;
  2535. std::string interface_;
  2536. std::string proxy_host_;
  2537. int proxy_port_ = -1;
  2538. std::string proxy_basic_auth_username_;
  2539. std::string proxy_basic_auth_password_;
  2540. std::string proxy_bearer_token_auth_token_;
  2541. std::vector<detail::NoProxyEntry> no_proxy_entries_;
  2542. mutable detail::NormalizedTarget host_normalized_;
  2543. mutable bool host_normalized_valid_ = false;
  2544. mutable std::mutex logger_mutex_;
  2545. Logger logger_;
  2546. ErrorLogger error_logger_;
  2547. private:
  2548. bool send_(Request &req, Response &res, Error &error);
  2549. Result send_(Request &&req);
  2550. socket_t create_client_socket(Error &error) const;
  2551. bool read_response_line(Stream &strm, const Request &req, Response &res,
  2552. bool skip_100_continue = true) const;
  2553. bool write_request(Stream &strm, Request &req, bool close_connection,
  2554. Error &error, bool skip_body, bool &rejected_locally);
  2555. bool write_request_body(Stream &strm, Request &req, Error &error);
  2556. void prepare_default_headers(Request &r, bool for_stream,
  2557. const std::string &ct);
  2558. bool redirect(Request &req, Response &res, Error &error);
  2559. bool create_redirect_client(const std::string &scheme,
  2560. const std::string &host, int port, Request &req,
  2561. Response &res, const std::string &path,
  2562. const std::string &location, Error &error);
  2563. template <typename ClientType> void setup_redirect_client(ClientType &client);
  2564. bool handle_request(Stream &strm, Request &req, Response &res,
  2565. bool close_connection, Error &error);
  2566. std::unique_ptr<Response> send_with_content_provider_and_receiver(
  2567. Request &req, const char *body, size_t content_length,
  2568. ContentProvider content_provider,
  2569. ContentProviderWithoutLength content_provider_without_length,
  2570. const std::string &content_type, ContentReceiver content_receiver,
  2571. Error &error);
  2572. Result send_with_content_provider_and_receiver(
  2573. const std::string &method, const std::string &path,
  2574. const Headers &headers, const char *body, size_t content_length,
  2575. ContentProvider content_provider,
  2576. ContentProviderWithoutLength content_provider_without_length,
  2577. const std::string &content_type, ContentReceiver content_receiver,
  2578. UploadProgress progress);
  2579. ContentProviderWithoutLength get_multipart_content_provider(
  2580. const std::string &boundary, const UploadFormDataItems &items,
  2581. const FormDataProviderItems &provider_items) const;
  2582. virtual bool
  2583. process_socket(const Socket &socket,
  2584. std::chrono::time_point<std::chrono::steady_clock> start_time,
  2585. std::function<bool(Stream &strm)> callback);
  2586. virtual bool is_ssl() const;
  2587. void transfer_socket_ownership_to_handle(StreamHandle &handle);
  2588. #ifdef CPPHTTPLIB_SSL_ENABLED
  2589. public:
  2590. void set_digest_auth(const std::string &username,
  2591. const std::string &password);
  2592. void set_proxy_digest_auth(const std::string &username,
  2593. const std::string &password);
  2594. void set_ca_cert_path(const std::string &ca_cert_file_path,
  2595. const std::string &ca_cert_dir_path = std::string());
  2596. void enable_server_certificate_verification(bool enabled);
  2597. void enable_server_hostname_verification(bool enabled);
  2598. void enable_system_ca(bool enabled);
  2599. protected:
  2600. std::string digest_auth_username_;
  2601. std::string digest_auth_password_;
  2602. std::string proxy_digest_auth_username_;
  2603. std::string proxy_digest_auth_password_;
  2604. std::string ca_cert_file_path_;
  2605. std::string ca_cert_dir_path_;
  2606. bool server_certificate_verification_ = true;
  2607. bool server_hostname_verification_ = true;
  2608. SystemCAMode system_ca_mode_ = SystemCAMode::Auto;
  2609. std::string ca_cert_pem_; // Store CA cert PEM for redirect transfer
  2610. int last_ssl_error_ = 0;
  2611. uint64_t last_backend_error_ = 0;
  2612. #endif
  2613. };
  2614. namespace detail {
  2615. // Stands in for a client that Client could not make from its arguments, so a
  2616. // request fails rather than going through a null pointer.
  2617. class InvalidClientImpl final : public ClientImpl {
  2618. public:
  2619. InvalidClientImpl() : ClientImpl(std::string(), 0) {}
  2620. bool is_valid() const override { return false; }
  2621. private:
  2622. bool create_and_connect_socket(Socket &, Error &error) override {
  2623. error = Error::Connection;
  2624. return false;
  2625. }
  2626. };
  2627. } // namespace detail
  2628. class Client {
  2629. public:
  2630. // Universal interface
  2631. explicit Client(const std::string &scheme_host_port);
  2632. explicit Client(const std::string &scheme_host_port,
  2633. const std::string &client_cert_path,
  2634. const std::string &client_key_path);
  2635. // HTTP only interface
  2636. explicit Client(const std::string &host, int port);
  2637. explicit Client(const std::string &host, int port,
  2638. const std::string &client_cert_path,
  2639. const std::string &client_key_path);
  2640. Client(Client &&) = default;
  2641. Client &operator=(Client &&) = default;
  2642. ~Client();
  2643. bool is_valid() const;
  2644. // clang-format off
  2645. Result Get(const std::string &path, DownloadProgress progress = nullptr);
  2646. Result Get(const std::string &path, ContentReceiver content_receiver, DownloadProgress progress = nullptr);
  2647. Result Get(const std::string &path, ResponseHandler response_handler, ContentReceiver content_receiver, DownloadProgress progress = nullptr);
  2648. Result Get(const std::string &path, const Headers &headers, DownloadProgress progress = nullptr);
  2649. Result Get(const std::string &path, const Headers &headers, ContentReceiver content_receiver, DownloadProgress progress = nullptr);
  2650. Result Get(const std::string &path, const Headers &headers, ResponseHandler response_handler, ContentReceiver content_receiver, DownloadProgress progress = nullptr);
  2651. Result Get(const std::string &path, const Params &params, DownloadProgress progress = nullptr);
  2652. Result Get(const std::string &path, const Params &params, const Headers &headers, DownloadProgress progress = nullptr);
  2653. Result Get(const std::string &path, const Params &params, const Headers &headers, ContentReceiver content_receiver, DownloadProgress progress = nullptr);
  2654. Result Get(const std::string &path, const Params &params, const Headers &headers, ResponseHandler response_handler, ContentReceiver content_receiver, DownloadProgress progress = nullptr);
  2655. Result Head(const std::string &path);
  2656. Result Head(const std::string &path, const Headers &headers);
  2657. Result Post(const std::string &path);
  2658. Result Post(const std::string &path, const char *body, size_t content_length, const std::string &content_type, UploadProgress progress = nullptr);
  2659. Result Post(const std::string &path, const std::string &body, const std::string &content_type, UploadProgress progress = nullptr);
  2660. Result Post(const std::string &path, size_t content_length, ContentProvider content_provider, const std::string &content_type, UploadProgress progress = nullptr);
  2661. Result Post(const std::string &path, size_t content_length, ContentProvider content_provider, const std::string &content_type, ContentReceiver content_receiver, UploadProgress progress = nullptr);
  2662. Result Post(const std::string &path, ContentProviderWithoutLength content_provider, const std::string &content_type, UploadProgress progress = nullptr);
  2663. Result Post(const std::string &path, ContentProviderWithoutLength content_provider, const std::string &content_type, ContentReceiver content_receiver, UploadProgress progress = nullptr);
  2664. Result Post(const std::string &path, const Params &params);
  2665. Result Post(const std::string &path, const UploadFormDataItems &items, UploadProgress progress = nullptr);
  2666. Result Post(const std::string &path, const Headers &headers);
  2667. Result Post(const std::string &path, const Headers &headers, const char *body, size_t content_length, const std::string &content_type, UploadProgress progress = nullptr);
  2668. Result Post(const std::string &path, const Headers &headers, const std::string &body, const std::string &content_type, UploadProgress progress = nullptr);
  2669. Result Post(const std::string &path, const Headers &headers, size_t content_length, ContentProvider content_provider, const std::string &content_type, UploadProgress progress = nullptr);
  2670. Result Post(const std::string &path, const Headers &headers, size_t content_length, ContentProvider content_provider, const std::string &content_type, ContentReceiver content_receiver, DownloadProgress progress = nullptr);
  2671. Result Post(const std::string &path, const Headers &headers, ContentProviderWithoutLength content_provider, const std::string &content_type, UploadProgress progress = nullptr);
  2672. Result Post(const std::string &path, const Headers &headers, ContentProviderWithoutLength content_provider, const std::string &content_type, ContentReceiver content_receiver, DownloadProgress progress = nullptr);
  2673. Result Post(const std::string &path, const Headers &headers, const Params &params);
  2674. Result Post(const std::string &path, const Headers &headers, const UploadFormDataItems &items, UploadProgress progress = nullptr);
  2675. Result Post(const std::string &path, const Headers &headers, const UploadFormDataItems &items, const std::string &boundary, UploadProgress progress = nullptr);
  2676. Result Post(const std::string &path, const Headers &headers, const UploadFormDataItems &items, const FormDataProviderItems &provider_items, UploadProgress progress = nullptr);
  2677. Result Post(const std::string &path, const Headers &headers, const std::string &body, const std::string &content_type, ContentReceiver content_receiver, DownloadProgress progress = nullptr);
  2678. Result Put(const std::string &path);
  2679. Result Put(const std::string &path, const char *body, size_t content_length, const std::string &content_type, UploadProgress progress = nullptr);
  2680. Result Put(const std::string &path, const std::string &body, const std::string &content_type, UploadProgress progress = nullptr);
  2681. Result Put(const std::string &path, size_t content_length, ContentProvider content_provider, const std::string &content_type, UploadProgress progress = nullptr);
  2682. Result Put(const std::string &path, size_t content_length, ContentProvider content_provider, const std::string &content_type, ContentReceiver content_receiver, UploadProgress progress = nullptr);
  2683. Result Put(const std::string &path, ContentProviderWithoutLength content_provider, const std::string &content_type, UploadProgress progress = nullptr);
  2684. Result Put(const std::string &path, ContentProviderWithoutLength content_provider, const std::string &content_type, ContentReceiver content_receiver, UploadProgress progress = nullptr);
  2685. Result Put(const std::string &path, const Params &params);
  2686. Result Put(const std::string &path, const UploadFormDataItems &items, UploadProgress progress = nullptr);
  2687. Result Put(const std::string &path, const Headers &headers);
  2688. Result Put(const std::string &path, const Headers &headers, const char *body, size_t content_length, const std::string &content_type, UploadProgress progress = nullptr);
  2689. Result Put(const std::string &path, const Headers &headers, const std::string &body, const std::string &content_type, UploadProgress progress = nullptr);
  2690. Result Put(const std::string &path, const Headers &headers, size_t content_length, ContentProvider content_provider, const std::string &content_type, UploadProgress progress = nullptr);
  2691. Result Put(const std::string &path, const Headers &headers, size_t content_length, ContentProvider content_provider, const std::string &content_type, ContentReceiver content_receiver, UploadProgress progress = nullptr);
  2692. Result Put(const std::string &path, const Headers &headers, ContentProviderWithoutLength content_provider, const std::string &content_type, UploadProgress progress = nullptr);
  2693. Result Put(const std::string &path, const Headers &headers, ContentProviderWithoutLength content_provider, const std::string &content_type, ContentReceiver content_receiver, UploadProgress progress = nullptr);
  2694. Result Put(const std::string &path, const Headers &headers, const Params &params);
  2695. Result Put(const std::string &path, const Headers &headers, const UploadFormDataItems &items, UploadProgress progress = nullptr);
  2696. Result Put(const std::string &path, const Headers &headers, const UploadFormDataItems &items, const std::string &boundary, UploadProgress progress = nullptr);
  2697. Result Put(const std::string &path, const Headers &headers, const UploadFormDataItems &items, const FormDataProviderItems &provider_items, UploadProgress progress = nullptr);
  2698. Result Put(const std::string &path, const Headers &headers, const std::string &body, const std::string &content_type, ContentReceiver content_receiver, DownloadProgress progress = nullptr);
  2699. Result Patch(const std::string &path);
  2700. Result Patch(const std::string &path, const char *body, size_t content_length, const std::string &content_type, UploadProgress progress = nullptr);
  2701. Result Patch(const std::string &path, const std::string &body, const std::string &content_type, UploadProgress progress = nullptr);
  2702. Result Patch(const std::string &path, size_t content_length, ContentProvider content_provider, const std::string &content_type, UploadProgress progress = nullptr);
  2703. Result Patch(const std::string &path, size_t content_length, ContentProvider content_provider, const std::string &content_type, ContentReceiver content_receiver, UploadProgress progress = nullptr);
  2704. Result Patch(const std::string &path, ContentProviderWithoutLength content_provider, const std::string &content_type, UploadProgress progress = nullptr);
  2705. Result Patch(const std::string &path, ContentProviderWithoutLength content_provider, const std::string &content_type, ContentReceiver content_receiver, UploadProgress progress = nullptr);
  2706. Result Patch(const std::string &path, const Params &params);
  2707. Result Patch(const std::string &path, const UploadFormDataItems &items, UploadProgress progress = nullptr);
  2708. Result Patch(const std::string &path, const Headers &headers);
  2709. Result Patch(const std::string &path, const Headers &headers, const char *body, size_t content_length, const std::string &content_type, UploadProgress progress = nullptr);
  2710. Result Patch(const std::string &path, const Headers &headers, const std::string &body, const std::string &content_type, UploadProgress progress = nullptr);
  2711. Result Patch(const std::string &path, const Headers &headers, size_t content_length, ContentProvider content_provider, const std::string &content_type, UploadProgress progress = nullptr);
  2712. Result Patch(const std::string &path, const Headers &headers, size_t content_length, ContentProvider content_provider, const std::string &content_type, ContentReceiver content_receiver, UploadProgress progress = nullptr);
  2713. Result Patch(const std::string &path, const Headers &headers, ContentProviderWithoutLength content_provider, const std::string &content_type, UploadProgress progress = nullptr);
  2714. Result Patch(const std::string &path, const Headers &headers, ContentProviderWithoutLength content_provider, const std::string &content_type, ContentReceiver content_receiver, UploadProgress progress = nullptr);
  2715. Result Patch(const std::string &path, const Headers &headers, const Params &params);
  2716. Result Patch(const std::string &path, const Headers &headers, const UploadFormDataItems &items, UploadProgress progress = nullptr);
  2717. Result Patch(const std::string &path, const Headers &headers, const UploadFormDataItems &items, const std::string &boundary, UploadProgress progress = nullptr);
  2718. Result Patch(const std::string &path, const Headers &headers, const UploadFormDataItems &items, const FormDataProviderItems &provider_items, UploadProgress progress = nullptr);
  2719. Result Patch(const std::string &path, const Headers &headers, const std::string &body, const std::string &content_type, ContentReceiver content_receiver, DownloadProgress progress = nullptr);
  2720. Result Delete(const std::string &path, DownloadProgress progress = nullptr);
  2721. Result Delete(const std::string &path, const char *body, size_t content_length, const std::string &content_type, DownloadProgress progress = nullptr);
  2722. Result Delete(const std::string &path, const std::string &body, const std::string &content_type, DownloadProgress progress = nullptr);
  2723. Result Delete(const std::string &path, const Params &params, DownloadProgress progress = nullptr);
  2724. Result Delete(const std::string &path, const Headers &headers, DownloadProgress progress = nullptr);
  2725. Result Delete(const std::string &path, const Headers &headers, const char *body, size_t content_length, const std::string &content_type, DownloadProgress progress = nullptr);
  2726. Result Delete(const std::string &path, const Headers &headers, const std::string &body, const std::string &content_type, DownloadProgress progress = nullptr);
  2727. Result Delete(const std::string &path, const Headers &headers, const Params &params, DownloadProgress progress = nullptr);
  2728. Result Options(const std::string &path);
  2729. Result Options(const std::string &path, const Headers &headers);
  2730. // clang-format on
  2731. // Streaming API: Open a stream for reading response body incrementally
  2732. // Socket ownership is transferred to StreamHandle for true streaming
  2733. // Supports all HTTP methods (GET, POST, PUT, PATCH, DELETE, etc.)
  2734. ClientImpl::StreamHandle open_stream(const std::string &method,
  2735. const std::string &path,
  2736. const Params &params = {},
  2737. const Headers &headers = {},
  2738. const std::string &body = {},
  2739. const std::string &content_type = {});
  2740. bool send(Request &req, Response &res, Error &error);
  2741. Result send(const Request &req);
  2742. void stop();
  2743. std::string host() const;
  2744. int port() const;
  2745. size_t is_socket_open() const;
  2746. socket_t socket() const;
  2747. void set_hostname_addr_map(std::map<std::string, std::string> addr_map);
  2748. void set_default_headers(Headers headers);
  2749. void
  2750. set_header_writer(std::function<ssize_t(Stream &, Headers &)> const &writer);
  2751. void set_address_family(int family);
  2752. void set_tcp_nodelay(bool on);
  2753. void set_socket_options(SocketOptions socket_options);
  2754. void set_connection_timeout(time_t sec, time_t usec = 0);
  2755. template <class Rep, class Period>
  2756. void
  2757. set_connection_timeout(const std::chrono::duration<Rep, Period> &duration);
  2758. void set_read_timeout(time_t sec, time_t usec = 0);
  2759. template <class Rep, class Period>
  2760. void set_read_timeout(const std::chrono::duration<Rep, Period> &duration);
  2761. void set_write_timeout(time_t sec, time_t usec = 0);
  2762. template <class Rep, class Period>
  2763. void set_write_timeout(const std::chrono::duration<Rep, Period> &duration);
  2764. void set_max_timeout(time_t msec);
  2765. template <class Rep, class Period>
  2766. void set_max_timeout(const std::chrono::duration<Rep, Period> &duration);
  2767. void set_basic_auth(const std::string &username, const std::string &password);
  2768. void set_bearer_token_auth(const std::string &token);
  2769. void set_keep_alive(bool on);
  2770. void set_follow_location(bool on);
  2771. void set_path_encode(bool on);
  2772. void set_compress(bool on);
  2773. void set_decompress(bool on);
  2774. void set_payload_max_length(size_t length);
  2775. void set_interface(const std::string &intf);
  2776. void set_proxy(const std::string &host, int port);
  2777. void set_proxy_basic_auth(const std::string &username,
  2778. const std::string &password);
  2779. void set_proxy_bearer_token_auth(const std::string &token);
  2780. void set_no_proxy(const std::vector<std::string> &patterns);
  2781. void set_logger(Logger logger);
  2782. void set_error_logger(ErrorLogger error_logger);
  2783. private:
  2784. std::unique_ptr<ClientImpl> cli_;
  2785. #ifdef CPPHTTPLIB_SSL_ENABLED
  2786. public:
  2787. void set_digest_auth(const std::string &username,
  2788. const std::string &password);
  2789. void set_proxy_digest_auth(const std::string &username,
  2790. const std::string &password);
  2791. void enable_server_certificate_verification(bool enabled);
  2792. void enable_server_hostname_verification(bool enabled);
  2793. void enable_system_ca(bool enabled);
  2794. void set_ca_cert_path(const std::string &ca_cert_file_path,
  2795. const std::string &ca_cert_dir_path = std::string());
  2796. void set_ca_cert_store(tls::ca_store_t ca_cert_store);
  2797. void load_ca_cert_store(const char *ca_cert, std::size_t size);
  2798. void set_server_certificate_verifier(tls::VerifyCallback verifier);
  2799. void set_session_verifier(
  2800. std::function<SSLVerifierResponse(tls::session_t)> verifier);
  2801. tls::ctx_t tls_context() const;
  2802. #ifdef CPPHTTPLIB_WINDOWS_AUTOMATIC_ROOT_CERTIFICATES_UPDATE
  2803. void enable_windows_certificate_verification(bool enabled);
  2804. #endif
  2805. private:
  2806. bool is_ssl_ = false;
  2807. #endif
  2808. };
  2809. #ifdef CPPHTTPLIB_SSL_ENABLED
  2810. class SSLServer : public Server {
  2811. public:
  2812. SSLServer(const char *cert_path, const char *private_key_path,
  2813. const char *client_ca_cert_file_path = nullptr,
  2814. const char *client_ca_cert_dir_path = nullptr,
  2815. const char *private_key_password = nullptr);
  2816. struct PemMemory {
  2817. const char *cert_pem;
  2818. size_t cert_pem_len;
  2819. const char *key_pem;
  2820. size_t key_pem_len;
  2821. const char *client_ca_pem;
  2822. size_t client_ca_pem_len;
  2823. const char *private_key_password;
  2824. };
  2825. explicit SSLServer(const PemMemory &pem);
  2826. // The callback receives the ctx_t handle which can be cast to the
  2827. // appropriate backend type (SSL_CTX* for OpenSSL,
  2828. // tls::impl::MbedTlsContext* for Mbed TLS)
  2829. explicit SSLServer(const tls::ContextSetupCallback &setup_callback);
  2830. ~SSLServer() override;
  2831. bool is_valid() const override;
  2832. bool update_certs_pem(const char *cert_pem, const char *key_pem,
  2833. const char *client_ca_pem = nullptr,
  2834. const char *password = nullptr);
  2835. tls::ctx_t tls_context() const { return ctx_; }
  2836. int ssl_last_error() const { return last_ssl_error_; }
  2837. private:
  2838. bool process_and_close_socket(socket_t sock) override;
  2839. tls::ctx_t ctx_ = nullptr;
  2840. // update_certs_pem() replaces the certificates and CAs that handshakes read
  2841. // from ctx_, so it waits for the handshakes in progress, which their timeout
  2842. // bounds, and new ones wait while it is pending so that they cannot keep it
  2843. // waiting.
  2844. std::mutex ctx_mutex_;
  2845. std::condition_variable ctx_cv_;
  2846. size_t handshakes_in_progress_ = 0;
  2847. size_t updates_pending_ = 0;
  2848. int last_ssl_error_ = 0;
  2849. };
  2850. class SSLClient final : public ClientImpl {
  2851. public:
  2852. explicit SSLClient(const std::string &host);
  2853. explicit SSLClient(const std::string &host, int port);
  2854. explicit SSLClient(const std::string &host, int port,
  2855. const std::string &client_cert_path,
  2856. const std::string &client_key_path,
  2857. const std::string &private_key_password = std::string());
  2858. struct PemMemory {
  2859. const char *cert_pem;
  2860. size_t cert_pem_len;
  2861. const char *key_pem;
  2862. size_t key_pem_len;
  2863. const char *private_key_password;
  2864. };
  2865. explicit SSLClient(const std::string &host, int port, const PemMemory &pem);
  2866. ~SSLClient() override;
  2867. bool is_valid() const override;
  2868. void set_ca_cert_store(tls::ca_store_t ca_cert_store);
  2869. void load_ca_cert_store(const char *ca_cert, std::size_t size);
  2870. void set_server_certificate_verifier(tls::VerifyCallback verifier);
  2871. // Post-handshake session verifier (backend-independent)
  2872. void set_session_verifier(
  2873. std::function<SSLVerifierResponse(tls::session_t)> verifier);
  2874. tls::ctx_t tls_context() const { return ctx_; }
  2875. #ifdef CPPHTTPLIB_WINDOWS_AUTOMATIC_ROOT_CERTIFICATES_UPDATE
  2876. void enable_windows_certificate_verification(bool enabled);
  2877. #endif
  2878. private:
  2879. bool create_and_connect_socket(Socket &socket, Error &error) override;
  2880. bool ensure_socket_connection(Socket &socket, Error &error) override;
  2881. void shutdown_ssl(Socket &socket, bool shutdown_gracefully) override;
  2882. void shutdown_ssl_impl(Socket &socket, bool shutdown_gracefully);
  2883. bool
  2884. process_socket(const Socket &socket,
  2885. std::chrono::time_point<std::chrono::steady_clock> start_time,
  2886. std::function<bool(Stream &strm)> callback) override;
  2887. bool is_ssl() const override;
  2888. bool setup_proxy_connection(
  2889. Socket &socket,
  2890. std::chrono::time_point<std::chrono::steady_clock> start_time,
  2891. Response &res, bool &success, Error &error) override;
  2892. bool connect_with_proxy(
  2893. Socket &sock,
  2894. std::chrono::time_point<std::chrono::steady_clock> start_time,
  2895. Response &res, bool &success, Error &error);
  2896. bool initialize_ssl(Socket &socket, Error &error);
  2897. void init_ctx();
  2898. void reset_ctx_on_error();
  2899. bool load_certs();
  2900. tls::ctx_t ctx_ = nullptr;
  2901. std::mutex ctx_mutex_;
  2902. std::once_flag initialize_cert_;
  2903. // Tracks whether a custom CA store was applied via set_ca_cert_store(),
  2904. // since the store handle itself is owned by ctx_ and leaves no other trace.
  2905. // Used to keep custom CA configuration exclusive with system CA loading.
  2906. bool ca_cert_store_set_ = false;
  2907. std::function<SSLVerifierResponse(tls::session_t)> session_verifier_;
  2908. // Like ca_cert_store_set_, keeps what ctx_ cannot report back: the verifier
  2909. // set_server_certificate_verifier() installed there.
  2910. tls::VerifyCallback server_certificate_verifier_;
  2911. #ifdef CPPHTTPLIB_WINDOWS_AUTOMATIC_ROOT_CERTIFICATES_UPDATE
  2912. bool enable_windows_cert_verification_ = true;
  2913. #endif
  2914. friend class ClientImpl;
  2915. };
  2916. #endif // CPPHTTPLIB_SSL_ENABLED
  2917. namespace detail {
  2918. template <typename T, typename U>
  2919. inline void duration_to_sec_and_usec(const T &duration, U callback) {
  2920. auto sec = std::chrono::duration_cast<std::chrono::seconds>(duration).count();
  2921. auto usec = std::chrono::duration_cast<std::chrono::microseconds>(
  2922. duration - std::chrono::seconds(sec))
  2923. .count();
  2924. callback(static_cast<time_t>(sec), static_cast<time_t>(usec));
  2925. }
  2926. template <size_t N> inline constexpr size_t str_len(const char (&)[N]) {
  2927. return N - 1;
  2928. }
  2929. inline bool is_numeric(const std::string &str) {
  2930. return !str.empty() && std::all_of(str.cbegin(), str.cend(), is_ascii_digit);
  2931. }
  2932. // std::ranges::next(first, n, last) for C++11
  2933. template <typename It> inline It bounded_next(It first, size_t n, It last) {
  2934. for (; n > 0 && first != last; --n) {
  2935. ++first;
  2936. }
  2937. return first;
  2938. }
  2939. inline size_t get_header_value_u64(const Headers &headers,
  2940. const std::string &key, size_t def,
  2941. size_t id, bool &is_invalid_value) {
  2942. is_invalid_value = false;
  2943. auto rng = headers.equal_range(key);
  2944. auto it = bounded_next(rng.first, id, rng.second);
  2945. if (it != rng.second) {
  2946. if (is_numeric(it->second)) {
  2947. // Parse at size_t width so an out-of-range Content-Length is reported
  2948. // rather than silently saturated/truncated (a value above 2^32 would
  2949. // otherwise wrap to a small framing length on 32-bit builds). Flag it
  2950. // and return SIZE_MAX so the existing oversized-value guards reject it.
  2951. size_t val = 0;
  2952. const auto &s = it->second;
  2953. auto r = from_chars(s.data(), s.data() + s.size(), val);
  2954. if (r.ec == std::errc::result_out_of_range) {
  2955. is_invalid_value = true;
  2956. return (std::numeric_limits<size_t>::max)();
  2957. }
  2958. return val;
  2959. } else {
  2960. is_invalid_value = true;
  2961. }
  2962. }
  2963. return def;
  2964. }
  2965. inline size_t get_header_value_u64(const Headers &headers,
  2966. const std::string &key, size_t def,
  2967. size_t id) {
  2968. auto dummy = false;
  2969. return get_header_value_u64(headers, key, def, id, dummy);
  2970. }
  2971. } // namespace detail
  2972. template <class Rep, class Period>
  2973. inline Server &
  2974. Server::set_read_timeout(const std::chrono::duration<Rep, Period> &duration) {
  2975. detail::duration_to_sec_and_usec(
  2976. duration, [&](time_t sec, time_t usec) { set_read_timeout(sec, usec); });
  2977. return *this;
  2978. }
  2979. template <class Rep, class Period>
  2980. inline Server &
  2981. Server::set_write_timeout(const std::chrono::duration<Rep, Period> &duration) {
  2982. detail::duration_to_sec_and_usec(
  2983. duration, [&](time_t sec, time_t usec) { set_write_timeout(sec, usec); });
  2984. return *this;
  2985. }
  2986. template <class Rep, class Period>
  2987. inline Server &
  2988. Server::set_idle_interval(const std::chrono::duration<Rep, Period> &duration) {
  2989. detail::duration_to_sec_and_usec(
  2990. duration, [&](time_t sec, time_t usec) { set_idle_interval(sec, usec); });
  2991. return *this;
  2992. }
  2993. template <class Rep, class Period>
  2994. inline void ClientImpl::set_connection_timeout(
  2995. const std::chrono::duration<Rep, Period> &duration) {
  2996. detail::duration_to_sec_and_usec(duration, [&](time_t sec, time_t usec) {
  2997. set_connection_timeout(sec, usec);
  2998. });
  2999. }
  3000. template <class Rep, class Period>
  3001. inline void ClientImpl::set_read_timeout(
  3002. const std::chrono::duration<Rep, Period> &duration) {
  3003. detail::duration_to_sec_and_usec(
  3004. duration, [&](time_t sec, time_t usec) { set_read_timeout(sec, usec); });
  3005. }
  3006. template <class Rep, class Period>
  3007. inline void ClientImpl::set_write_timeout(
  3008. const std::chrono::duration<Rep, Period> &duration) {
  3009. detail::duration_to_sec_and_usec(
  3010. duration, [&](time_t sec, time_t usec) { set_write_timeout(sec, usec); });
  3011. }
  3012. template <class Rep, class Period>
  3013. inline void ClientImpl::set_max_timeout(
  3014. const std::chrono::duration<Rep, Period> &duration) {
  3015. auto msec =
  3016. std::chrono::duration_cast<std::chrono::milliseconds>(duration).count();
  3017. set_max_timeout(static_cast<time_t>(msec));
  3018. }
  3019. template <class Rep, class Period>
  3020. inline void Client::set_connection_timeout(
  3021. const std::chrono::duration<Rep, Period> &duration) {
  3022. cli_->set_connection_timeout(duration);
  3023. }
  3024. template <class Rep, class Period>
  3025. inline void
  3026. Client::set_read_timeout(const std::chrono::duration<Rep, Period> &duration) {
  3027. cli_->set_read_timeout(duration);
  3028. }
  3029. template <class Rep, class Period>
  3030. inline void
  3031. Client::set_write_timeout(const std::chrono::duration<Rep, Period> &duration) {
  3032. cli_->set_write_timeout(duration);
  3033. }
  3034. inline void Client::set_max_timeout(time_t msec) {
  3035. cli_->set_max_timeout(msec);
  3036. }
  3037. template <class Rep, class Period>
  3038. inline void
  3039. Client::set_max_timeout(const std::chrono::duration<Rep, Period> &duration) {
  3040. cli_->set_max_timeout(duration);
  3041. }
  3042. /*
  3043. * Forward declarations and types that will be part of the .h file if split into
  3044. * .h + .cc.
  3045. */
  3046. std::string hosted_at(const std::string &hostname);
  3047. void hosted_at(const std::string &hostname, std::vector<std::string> &addrs);
  3048. // JavaScript-style URL encoding/decoding functions
  3049. std::string encode_uri_component(const std::string &value);
  3050. std::string encode_uri(const std::string &value);
  3051. std::string decode_uri_component(const std::string &value);
  3052. std::string decode_uri(const std::string &value);
  3053. // RFC 3986 compliant URL component encoding/decoding functions
  3054. std::string encode_path_component(const std::string &component);
  3055. std::string decode_path_component(const std::string &component);
  3056. std::string encode_query_component(const std::string &component,
  3057. bool space_as_plus = true);
  3058. std::string decode_query_component(const std::string &component,
  3059. bool plus_as_space = true);
  3060. std::string sanitize_filename(const std::string &filename);
  3061. std::string append_query_params(const std::string &path, const Params &params);
  3062. std::pair<std::string, std::string> make_range_header(const Ranges &ranges);
  3063. std::pair<std::string, std::string>
  3064. make_basic_authentication_header(const std::string &username,
  3065. const std::string &password,
  3066. bool is_proxy = false);
  3067. namespace detail {
  3068. #if defined(_WIN32)
  3069. inline std::wstring u8string_to_wstring(const char *s) {
  3070. if (!s) { return std::wstring(); }
  3071. auto len = static_cast<int>(strlen(s));
  3072. if (!len) { return std::wstring(); }
  3073. auto wlen = ::MultiByteToWideChar(CP_UTF8, 0, s, len, nullptr, 0);
  3074. if (!wlen) { return std::wstring(); }
  3075. std::wstring ws;
  3076. ws.resize(wlen);
  3077. wlen = ::MultiByteToWideChar(
  3078. CP_UTF8, 0, s, len,
  3079. const_cast<LPWSTR>(reinterpret_cast<LPCWSTR>(ws.data())), wlen);
  3080. if (wlen != static_cast<int>(ws.size())) { ws.clear(); }
  3081. return ws;
  3082. }
  3083. #endif
  3084. struct FileStat {
  3085. FileStat(const std::string &path);
  3086. bool is_file() const;
  3087. bool is_dir() const;
  3088. time_t mtime() const;
  3089. size_t size() const;
  3090. private:
  3091. #if defined(_WIN32)
  3092. struct _stat st_;
  3093. #else
  3094. struct stat st_;
  3095. #endif
  3096. int ret_ = -1;
  3097. };
  3098. std::string make_host_and_port_string(const std::string &host, int port,
  3099. bool is_ssl);
  3100. template <typename T>
  3101. bool check_and_write_headers(Stream &strm, Headers &headers, T header_writer,
  3102. Error &error);
  3103. std::string trim_copy(const std::string &s);
  3104. void divide(
  3105. const char *data, std::size_t size, char d,
  3106. std::function<void(const char *, std::size_t, const char *, std::size_t)>
  3107. fn);
  3108. void divide(
  3109. const std::string &str, char d,
  3110. std::function<void(const char *, std::size_t, const char *, std::size_t)>
  3111. fn);
  3112. void split(const char *b, const char *e, char d,
  3113. std::function<void(const char *, const char *)> fn);
  3114. void split(const char *b, const char *e, char d, size_t m,
  3115. std::function<void(const char *, const char *)> fn);
  3116. bool split_find(const char *b, const char *e, char d,
  3117. std::function<bool(const char *, const char *)> fn);
  3118. bool has_header_token(const Headers &headers, const std::string &key,
  3119. const std::string &token);
  3120. std::string websocket_accept_key(const std::string &client_key);
  3121. bool is_websocket_upgrade(const Request &req);
  3122. bool process_client_socket(
  3123. socket_t sock, time_t read_timeout_sec, time_t read_timeout_usec,
  3124. time_t write_timeout_sec, time_t write_timeout_usec,
  3125. time_t max_timeout_msec,
  3126. std::chrono::time_point<std::chrono::steady_clock> start_time,
  3127. std::function<bool(Stream &)> callback);
  3128. socket_t create_client_socket(const std::string &host, const std::string &ip,
  3129. int port, int address_family, bool tcp_nodelay,
  3130. bool ipv6_v6only, SocketOptions socket_options,
  3131. time_t connection_timeout_sec,
  3132. time_t connection_timeout_usec,
  3133. time_t read_timeout_sec, time_t read_timeout_usec,
  3134. time_t write_timeout_sec,
  3135. time_t write_timeout_usec,
  3136. const std::string &intf, Error &error);
  3137. const char *get_header_value(const Headers &headers, const std::string &key,
  3138. const char *def, size_t id);
  3139. std::string get_combined_header_value(const Headers &headers,
  3140. const std::string &key);
  3141. std::string params_to_query_str(const Params &params);
  3142. void parse_query_text(const char *data, std::size_t size, Params &params);
  3143. void parse_query_text(const std::string &s, Params &params);
  3144. bool parse_multipart_boundary(const std::string &content_type,
  3145. std::string &boundary);
  3146. bool parse_range_header(const std::string &s, Ranges &ranges);
  3147. bool parse_accept_header(const std::string &s,
  3148. std::vector<std::string> &content_types);
  3149. void parse_disposition_params(const std::string &s, Params &params);
  3150. ssize_t send_socket(socket_t sock, const void *ptr, size_t size, int flags);
  3151. ssize_t read_socket(socket_t sock, void *ptr, size_t size, int flags);
  3152. EncodingType encoding_type(const Request &req, const std::string &content_type);
  3153. EncodingType encoding_type(const Request &req, const Response &res,
  3154. const std::string &content_type);
  3155. EncodingType encoding_type(const Request &req, const Response &res);
  3156. class BufferStream final : public Stream {
  3157. public:
  3158. BufferStream() = default;
  3159. ~BufferStream() override = default;
  3160. bool is_readable() const override;
  3161. bool wait_readable() const override;
  3162. bool wait_writable() const override;
  3163. ssize_t read(char *ptr, size_t size) override;
  3164. ssize_t write(const char *ptr, size_t size) override;
  3165. void get_remote_ip_and_port(std::string &ip, int &port) const override;
  3166. void get_local_ip_and_port(std::string &ip, int &port) const override;
  3167. socket_t socket() const override;
  3168. time_t duration() const override;
  3169. const std::string &get_buffer() const;
  3170. private:
  3171. std::string buffer;
  3172. size_t position = 0;
  3173. };
  3174. class compressor {
  3175. public:
  3176. virtual ~compressor() = default;
  3177. typedef std::function<bool(const char *data, size_t data_len)> Callback;
  3178. virtual bool compress(const char *data, size_t data_length, bool last,
  3179. Callback callback) = 0;
  3180. };
  3181. class decompressor {
  3182. public:
  3183. virtual ~decompressor() = default;
  3184. virtual bool is_valid() const = 0;
  3185. typedef std::function<bool(const char *data, size_t data_len)> Callback;
  3186. virtual bool decompress(const char *data, size_t data_length,
  3187. Callback callback) = 0;
  3188. };
  3189. class nocompressor final : public compressor {
  3190. public:
  3191. ~nocompressor() override = default;
  3192. bool compress(const char *data, size_t data_length, bool /*last*/,
  3193. Callback callback) override;
  3194. };
  3195. #ifdef CPPHTTPLIB_ZLIB_SUPPORT
  3196. class gzip_compressor final : public compressor {
  3197. public:
  3198. gzip_compressor();
  3199. ~gzip_compressor() override;
  3200. bool compress(const char *data, size_t data_length, bool last,
  3201. Callback callback) override;
  3202. private:
  3203. bool is_valid_ = false;
  3204. z_stream strm_;
  3205. };
  3206. class gzip_decompressor final : public decompressor {
  3207. public:
  3208. gzip_decompressor();
  3209. ~gzip_decompressor() override;
  3210. bool is_valid() const override;
  3211. bool decompress(const char *data, size_t data_length,
  3212. Callback callback) override;
  3213. private:
  3214. bool is_valid_ = false;
  3215. z_stream strm_;
  3216. };
  3217. #endif
  3218. #ifdef CPPHTTPLIB_BROTLI_SUPPORT
  3219. class brotli_compressor final : public compressor {
  3220. public:
  3221. brotli_compressor();
  3222. ~brotli_compressor();
  3223. bool compress(const char *data, size_t data_length, bool last,
  3224. Callback callback) override;
  3225. private:
  3226. BrotliEncoderState *state_ = nullptr;
  3227. };
  3228. class brotli_decompressor final : public decompressor {
  3229. public:
  3230. brotli_decompressor();
  3231. ~brotli_decompressor();
  3232. bool is_valid() const override;
  3233. bool decompress(const char *data, size_t data_length,
  3234. Callback callback) override;
  3235. private:
  3236. BrotliDecoderResult decoder_r;
  3237. BrotliDecoderState *decoder_s = nullptr;
  3238. };
  3239. #endif
  3240. #ifdef CPPHTTPLIB_ZSTD_SUPPORT
  3241. class zstd_compressor : public compressor {
  3242. public:
  3243. zstd_compressor();
  3244. ~zstd_compressor();
  3245. bool compress(const char *data, size_t data_length, bool last,
  3246. Callback callback) override;
  3247. private:
  3248. ZSTD_CCtx *ctx_ = nullptr;
  3249. };
  3250. class zstd_decompressor : public decompressor {
  3251. public:
  3252. zstd_decompressor();
  3253. ~zstd_decompressor();
  3254. bool is_valid() const override;
  3255. bool decompress(const char *data, size_t data_length,
  3256. Callback callback) override;
  3257. private:
  3258. ZSTD_DCtx *ctx_ = nullptr;
  3259. };
  3260. #endif
  3261. // NOTE: until the read size reaches `fixed_buffer_size`, use `fixed_buffer`
  3262. // to store data. The call can set memory on stack for performance.
  3263. class stream_line_reader {
  3264. public:
  3265. stream_line_reader(Stream &strm, char *fixed_buffer,
  3266. size_t fixed_buffer_size);
  3267. const char *ptr() const;
  3268. size_t size() const;
  3269. bool end_with_crlf() const;
  3270. bool getline();
  3271. private:
  3272. void append(char c);
  3273. void append(const char *data, size_t size);
  3274. Stream &strm_;
  3275. char *fixed_buffer_;
  3276. const size_t fixed_buffer_size_;
  3277. size_t fixed_buffer_used_size_ = 0;
  3278. std::string growable_buffer_;
  3279. };
  3280. bool parse_trailers(stream_line_reader &line_reader, Headers &dest,
  3281. const Headers &src_headers);
  3282. struct ChunkedDecoder {
  3283. Stream &strm;
  3284. size_t chunk_remaining = 0;
  3285. bool finished = false;
  3286. char line_buf[64];
  3287. size_t last_chunk_total = 0;
  3288. size_t last_chunk_offset = 0;
  3289. explicit ChunkedDecoder(Stream &s);
  3290. ssize_t read_payload(char *buf, size_t len, size_t &out_chunk_offset,
  3291. size_t &out_chunk_total);
  3292. bool parse_trailers_into(Headers &dest, const Headers &src_headers);
  3293. };
  3294. // A regular file opened to be served: mapped on Windows, read with pread()
  3295. // elsewhere.
  3296. class mmap {
  3297. public:
  3298. mmap(const char *path);
  3299. ~mmap();
  3300. bool open(const char *path);
  3301. void close();
  3302. bool is_open() const;
  3303. size_t size() const;
  3304. // Copies up to len bytes from offset into buf and returns how many: fewer,
  3305. // down to 0, if the file has shrunk since it was opened.
  3306. size_t read(size_t offset, char *buf, size_t len) const;
  3307. private:
  3308. #if defined(_WIN32)
  3309. HANDLE hFile_ = NULL;
  3310. HANDLE hMapping_ = NULL;
  3311. void *addr_ = nullptr;
  3312. bool is_open_empty_file = false;
  3313. #else
  3314. int fd_ = -1;
  3315. #endif
  3316. size_t size_ = 0;
  3317. };
  3318. // NOTE: https://www.rfc-editor.org/rfc/rfc9110#section-5
  3319. namespace fields {
  3320. bool is_token_char(char c);
  3321. bool is_token(const std::string &s);
  3322. bool is_field_name(const std::string &s);
  3323. bool is_vchar(char c);
  3324. bool is_obs_text(char c);
  3325. bool is_field_vchar(char c);
  3326. bool is_field_content(const std::string &s);
  3327. bool is_field_value(const std::string &s);
  3328. bool is_field_valid(const std::string &name, const std::string &value);
  3329. bool is_request_target(const std::string &s);
  3330. bool is_host(const std::string &s);
  3331. } // namespace fields
  3332. } // namespace detail
  3333. /*
  3334. * TLS Abstraction Layer Declarations
  3335. */
  3336. #ifdef CPPHTTPLIB_SSL_ENABLED
  3337. // TLS abstraction layer - backend-specific type declarations
  3338. #ifdef CPPHTTPLIB_MBEDTLS_SUPPORT
  3339. namespace tls {
  3340. namespace impl {
  3341. // Mbed TLS context wrapper (holds config, entropy, DRBG, CA chain, own
  3342. // cert/key). This struct is accessible via tls::impl for use in SSL context
  3343. // setup callbacks (cast ctx_t to tls::impl::MbedTlsContext*).
  3344. struct MbedTlsContext {
  3345. mbedtls_ssl_config conf;
  3346. #ifndef CPPHTTPLIB_MBEDTLS_V4
  3347. // Mbed TLS 4.x uses PSA Crypto's internal RNG; no explicit entropy/DRBG.
  3348. mbedtls_entropy_context entropy;
  3349. mbedtls_ctr_drbg_context ctr_drbg;
  3350. #endif
  3351. mbedtls_x509_crt ca_chain;
  3352. mbedtls_x509_crt own_cert;
  3353. mbedtls_pk_context own_key;
  3354. bool is_server = false;
  3355. // Peer certificate required (set_verify_client()); a client defaults to true
  3356. bool verify_client = false;
  3357. // Set by tls::set_verify_callback().
  3358. VerifyCallback verify_callback;
  3359. MbedTlsContext();
  3360. ~MbedTlsContext();
  3361. MbedTlsContext(const MbedTlsContext &) = delete;
  3362. MbedTlsContext &operator=(const MbedTlsContext &) = delete;
  3363. };
  3364. } // namespace impl
  3365. } // namespace tls
  3366. #endif
  3367. #ifdef CPPHTTPLIB_WOLFSSL_SUPPORT
  3368. namespace tls {
  3369. namespace impl {
  3370. // wolfSSL context wrapper (holds WOLFSSL_CTX and related state).
  3371. // This struct is accessible via tls::impl for use in SSL context
  3372. // setup callbacks (cast ctx_t to tls::impl::WolfSSLContext*).
  3373. struct WolfSSLContext {
  3374. WOLFSSL_CTX *ctx = nullptr;
  3375. bool is_server = false;
  3376. // Peer certificate required (set_verify_client()); a client defaults to true
  3377. bool verify_client = false;
  3378. // Replaced under verify_callback_mutex()
  3379. std::shared_ptr<VerifyCallback> verify_callback;
  3380. std::string ca_pem_data_; // accumulated PEM for get_ca_names/get_ca_certs
  3381. WolfSSLContext();
  3382. ~WolfSSLContext();
  3383. WolfSSLContext(const WolfSSLContext &) = delete;
  3384. WolfSSLContext &operator=(const WolfSSLContext &) = delete;
  3385. };
  3386. // CA store for wolfSSL: holds raw PEM bytes to allow reloading into any ctx
  3387. struct WolfSSLCAStore {
  3388. std::string pem_data;
  3389. };
  3390. } // namespace impl
  3391. } // namespace tls
  3392. #endif
  3393. #endif // CPPHTTPLIB_SSL_ENABLED
  3394. namespace stream {
  3395. class Result {
  3396. public:
  3397. Result();
  3398. explicit Result(ClientImpl::StreamHandle &&handle, size_t chunk_size = 8192);
  3399. Result(Result &&other) noexcept;
  3400. Result &operator=(Result &&other) noexcept;
  3401. Result(const Result &) = delete;
  3402. Result &operator=(const Result &) = delete;
  3403. // Response info
  3404. bool is_valid() const;
  3405. explicit operator bool() const;
  3406. int status() const;
  3407. const Headers &headers() const;
  3408. std::string get_header_value(const std::string &key,
  3409. const char *def = "") const;
  3410. bool has_header(const std::string &key) const;
  3411. Error error() const;
  3412. Error read_error() const;
  3413. bool has_read_error() const;
  3414. // Stream reading
  3415. bool next();
  3416. const char *data() const;
  3417. size_t size() const;
  3418. std::string read_all();
  3419. private:
  3420. ClientImpl::StreamHandle handle_;
  3421. std::string buffer_;
  3422. size_t current_size_ = 0;
  3423. size_t chunk_size_;
  3424. bool finished_ = false;
  3425. };
  3426. // GET
  3427. template <typename ClientType>
  3428. inline Result Get(ClientType &cli, const std::string &path,
  3429. size_t chunk_size = 8192) {
  3430. return Result{cli.open_stream("GET", path), chunk_size};
  3431. }
  3432. template <typename ClientType>
  3433. inline Result Get(ClientType &cli, const std::string &path,
  3434. const Headers &headers, size_t chunk_size = 8192) {
  3435. return Result{cli.open_stream("GET", path, {}, headers), chunk_size};
  3436. }
  3437. template <typename ClientType>
  3438. inline Result Get(ClientType &cli, const std::string &path,
  3439. const Params &params, size_t chunk_size = 8192) {
  3440. return Result{cli.open_stream("GET", path, params), chunk_size};
  3441. }
  3442. template <typename ClientType>
  3443. inline Result Get(ClientType &cli, const std::string &path,
  3444. const Params &params, const Headers &headers,
  3445. size_t chunk_size = 8192) {
  3446. return Result{cli.open_stream("GET", path, params, headers), chunk_size};
  3447. }
  3448. // POST
  3449. template <typename ClientType>
  3450. inline Result Post(ClientType &cli, const std::string &path,
  3451. const std::string &body, const std::string &content_type,
  3452. size_t chunk_size = 8192) {
  3453. return Result{cli.open_stream("POST", path, {}, {}, body, content_type),
  3454. chunk_size};
  3455. }
  3456. template <typename ClientType>
  3457. inline Result Post(ClientType &cli, const std::string &path,
  3458. const Headers &headers, const std::string &body,
  3459. const std::string &content_type, size_t chunk_size = 8192) {
  3460. return Result{cli.open_stream("POST", path, {}, headers, body, content_type),
  3461. chunk_size};
  3462. }
  3463. template <typename ClientType>
  3464. inline Result Post(ClientType &cli, const std::string &path,
  3465. const Params &params, const std::string &body,
  3466. const std::string &content_type, size_t chunk_size = 8192) {
  3467. return Result{cli.open_stream("POST", path, params, {}, body, content_type),
  3468. chunk_size};
  3469. }
  3470. template <typename ClientType>
  3471. inline Result Post(ClientType &cli, const std::string &path,
  3472. const Params &params, const Headers &headers,
  3473. const std::string &body, const std::string &content_type,
  3474. size_t chunk_size = 8192) {
  3475. return Result{
  3476. cli.open_stream("POST", path, params, headers, body, content_type),
  3477. chunk_size};
  3478. }
  3479. // PUT
  3480. template <typename ClientType>
  3481. inline Result Put(ClientType &cli, const std::string &path,
  3482. const std::string &body, const std::string &content_type,
  3483. size_t chunk_size = 8192) {
  3484. return Result{cli.open_stream("PUT", path, {}, {}, body, content_type),
  3485. chunk_size};
  3486. }
  3487. template <typename ClientType>
  3488. inline Result Put(ClientType &cli, const std::string &path,
  3489. const Headers &headers, const std::string &body,
  3490. const std::string &content_type, size_t chunk_size = 8192) {
  3491. return Result{cli.open_stream("PUT", path, {}, headers, body, content_type),
  3492. chunk_size};
  3493. }
  3494. template <typename ClientType>
  3495. inline Result Put(ClientType &cli, const std::string &path,
  3496. const Params &params, const std::string &body,
  3497. const std::string &content_type, size_t chunk_size = 8192) {
  3498. return Result{cli.open_stream("PUT", path, params, {}, body, content_type),
  3499. chunk_size};
  3500. }
  3501. template <typename ClientType>
  3502. inline Result Put(ClientType &cli, const std::string &path,
  3503. const Params &params, const Headers &headers,
  3504. const std::string &body, const std::string &content_type,
  3505. size_t chunk_size = 8192) {
  3506. return Result{
  3507. cli.open_stream("PUT", path, params, headers, body, content_type),
  3508. chunk_size};
  3509. }
  3510. // PATCH
  3511. template <typename ClientType>
  3512. inline Result Patch(ClientType &cli, const std::string &path,
  3513. const std::string &body, const std::string &content_type,
  3514. size_t chunk_size = 8192) {
  3515. return Result{cli.open_stream("PATCH", path, {}, {}, body, content_type),
  3516. chunk_size};
  3517. }
  3518. template <typename ClientType>
  3519. inline Result Patch(ClientType &cli, const std::string &path,
  3520. const Headers &headers, const std::string &body,
  3521. const std::string &content_type, size_t chunk_size = 8192) {
  3522. return Result{cli.open_stream("PATCH", path, {}, headers, body, content_type),
  3523. chunk_size};
  3524. }
  3525. template <typename ClientType>
  3526. inline Result Patch(ClientType &cli, const std::string &path,
  3527. const Params &params, const std::string &body,
  3528. const std::string &content_type, size_t chunk_size = 8192) {
  3529. return Result{cli.open_stream("PATCH", path, params, {}, body, content_type),
  3530. chunk_size};
  3531. }
  3532. template <typename ClientType>
  3533. inline Result Patch(ClientType &cli, const std::string &path,
  3534. const Params &params, const Headers &headers,
  3535. const std::string &body, const std::string &content_type,
  3536. size_t chunk_size = 8192) {
  3537. return Result{
  3538. cli.open_stream("PATCH", path, params, headers, body, content_type),
  3539. chunk_size};
  3540. }
  3541. // DELETE
  3542. template <typename ClientType>
  3543. inline Result Delete(ClientType &cli, const std::string &path,
  3544. size_t chunk_size = 8192) {
  3545. return Result{cli.open_stream("DELETE", path), chunk_size};
  3546. }
  3547. template <typename ClientType>
  3548. inline Result Delete(ClientType &cli, const std::string &path,
  3549. const Headers &headers, size_t chunk_size = 8192) {
  3550. return Result{cli.open_stream("DELETE", path, {}, headers), chunk_size};
  3551. }
  3552. template <typename ClientType>
  3553. inline Result Delete(ClientType &cli, const std::string &path,
  3554. const std::string &body, const std::string &content_type,
  3555. size_t chunk_size = 8192) {
  3556. return Result{cli.open_stream("DELETE", path, {}, {}, body, content_type),
  3557. chunk_size};
  3558. }
  3559. template <typename ClientType>
  3560. inline Result Delete(ClientType &cli, const std::string &path,
  3561. const Headers &headers, const std::string &body,
  3562. const std::string &content_type,
  3563. size_t chunk_size = 8192) {
  3564. return Result{
  3565. cli.open_stream("DELETE", path, {}, headers, body, content_type),
  3566. chunk_size};
  3567. }
  3568. template <typename ClientType>
  3569. inline Result Delete(ClientType &cli, const std::string &path,
  3570. const Params &params, size_t chunk_size = 8192) {
  3571. return Result{cli.open_stream("DELETE", path, params), chunk_size};
  3572. }
  3573. template <typename ClientType>
  3574. inline Result Delete(ClientType &cli, const std::string &path,
  3575. const Params &params, const Headers &headers,
  3576. size_t chunk_size = 8192) {
  3577. return Result{cli.open_stream("DELETE", path, params, headers), chunk_size};
  3578. }
  3579. template <typename ClientType>
  3580. inline Result Delete(ClientType &cli, const std::string &path,
  3581. const Params &params, const std::string &body,
  3582. const std::string &content_type,
  3583. size_t chunk_size = 8192) {
  3584. return Result{cli.open_stream("DELETE", path, params, {}, body, content_type),
  3585. chunk_size};
  3586. }
  3587. template <typename ClientType>
  3588. inline Result Delete(ClientType &cli, const std::string &path,
  3589. const Params &params, const Headers &headers,
  3590. const std::string &body, const std::string &content_type,
  3591. size_t chunk_size = 8192) {
  3592. return Result{
  3593. cli.open_stream("DELETE", path, params, headers, body, content_type),
  3594. chunk_size};
  3595. }
  3596. // HEAD
  3597. template <typename ClientType>
  3598. inline Result Head(ClientType &cli, const std::string &path,
  3599. size_t chunk_size = 8192) {
  3600. return Result{cli.open_stream("HEAD", path), chunk_size};
  3601. }
  3602. template <typename ClientType>
  3603. inline Result Head(ClientType &cli, const std::string &path,
  3604. const Headers &headers, size_t chunk_size = 8192) {
  3605. return Result{cli.open_stream("HEAD", path, {}, headers), chunk_size};
  3606. }
  3607. template <typename ClientType>
  3608. inline Result Head(ClientType &cli, const std::string &path,
  3609. const Params &params, size_t chunk_size = 8192) {
  3610. return Result{cli.open_stream("HEAD", path, params), chunk_size};
  3611. }
  3612. template <typename ClientType>
  3613. inline Result Head(ClientType &cli, const std::string &path,
  3614. const Params &params, const Headers &headers,
  3615. size_t chunk_size = 8192) {
  3616. return Result{cli.open_stream("HEAD", path, params, headers), chunk_size};
  3617. }
  3618. // OPTIONS
  3619. template <typename ClientType>
  3620. inline Result Options(ClientType &cli, const std::string &path,
  3621. size_t chunk_size = 8192) {
  3622. return Result{cli.open_stream("OPTIONS", path), chunk_size};
  3623. }
  3624. template <typename ClientType>
  3625. inline Result Options(ClientType &cli, const std::string &path,
  3626. const Headers &headers, size_t chunk_size = 8192) {
  3627. return Result{cli.open_stream("OPTIONS", path, {}, headers), chunk_size};
  3628. }
  3629. template <typename ClientType>
  3630. inline Result Options(ClientType &cli, const std::string &path,
  3631. const Params &params, size_t chunk_size = 8192) {
  3632. return Result{cli.open_stream("OPTIONS", path, params), chunk_size};
  3633. }
  3634. template <typename ClientType>
  3635. inline Result Options(ClientType &cli, const std::string &path,
  3636. const Params &params, const Headers &headers,
  3637. size_t chunk_size = 8192) {
  3638. return Result{cli.open_stream("OPTIONS", path, params, headers), chunk_size};
  3639. }
  3640. } // namespace stream
  3641. namespace sse {
  3642. struct SSEMessage {
  3643. std::string event; // Event type (default: "message")
  3644. std::string data; // Event payload
  3645. std::string id; // Event ID for Last-Event-ID header
  3646. SSEMessage();
  3647. void clear();
  3648. };
  3649. class SSEClient {
  3650. public:
  3651. using MessageHandler = std::function<void(const SSEMessage &)>;
  3652. using ErrorHandler = std::function<void(Error)>;
  3653. using OpenHandler = std::function<void()>;
  3654. SSEClient(Client &client, const std::string &path);
  3655. SSEClient(Client &client, const std::string &path, const Headers &headers);
  3656. ~SSEClient();
  3657. SSEClient(const SSEClient &) = delete;
  3658. SSEClient &operator=(const SSEClient &) = delete;
  3659. // Event handlers
  3660. SSEClient &on_message(MessageHandler handler);
  3661. SSEClient &on_event(const std::string &type, MessageHandler handler);
  3662. SSEClient &on_open(OpenHandler handler);
  3663. SSEClient &on_error(ErrorHandler handler);
  3664. SSEClient &set_reconnect_interval(int ms);
  3665. SSEClient &set_max_reconnect_attempts(int n);
  3666. // Update headers (thread-safe)
  3667. SSEClient &set_headers(const Headers &headers);
  3668. // State accessors
  3669. bool is_connected() const;
  3670. const std::string &last_event_id() const;
  3671. // Blocking start - runs event loop with auto-reconnect
  3672. void start();
  3673. // Non-blocking start - runs in background thread
  3674. void start_async();
  3675. // Stop the client (thread-safe)
  3676. void stop();
  3677. private:
  3678. bool parse_sse_line(const std::string &line, SSEMessage &msg, int &retry_ms,
  3679. bool &has_data, bool &has_id);
  3680. void run_event_loop();
  3681. void dispatch_event(const SSEMessage &msg);
  3682. bool should_reconnect(int count) const;
  3683. void wait_for_reconnect();
  3684. // Client and path
  3685. Client &client_;
  3686. std::string path_;
  3687. Headers headers_;
  3688. mutable std::mutex headers_mutex_;
  3689. // Callbacks
  3690. MessageHandler on_message_;
  3691. std::map<std::string, MessageHandler> event_handlers_;
  3692. OpenHandler on_open_;
  3693. ErrorHandler on_error_;
  3694. // Configuration
  3695. int reconnect_interval_ms_ = 3000;
  3696. int max_reconnect_attempts_ = 0; // 0 = unlimited
  3697. // State
  3698. std::atomic<bool> running_{false};
  3699. std::atomic<bool> connected_{false};
  3700. std::string last_event_id_;
  3701. // Socket of the open stream, for stop() to shut down
  3702. std::mutex stream_mutex_;
  3703. socket_t stream_sock_ = INVALID_SOCKET;
  3704. // Async support
  3705. std::thread async_thread_;
  3706. };
  3707. } // namespace sse
  3708. namespace ws {
  3709. class WebSocketClient;
  3710. enum class Opcode : uint8_t {
  3711. Continuation = 0x0,
  3712. Text = 0x1,
  3713. Binary = 0x2,
  3714. Close = 0x8,
  3715. Ping = 0x9,
  3716. Pong = 0xA,
  3717. };
  3718. enum class CloseStatus : uint16_t {
  3719. Normal = 1000,
  3720. GoingAway = 1001,
  3721. ProtocolError = 1002,
  3722. UnsupportedData = 1003,
  3723. NoStatus = 1005,
  3724. Abnormal = 1006,
  3725. InvalidPayload = 1007,
  3726. PolicyViolation = 1008,
  3727. MessageTooBig = 1009,
  3728. MandatoryExtension = 1010,
  3729. InternalError = 1011,
  3730. };
  3731. // Timeout is returned only when a read timeout was set and it elapsed before
  3732. // any byte of a frame arrived: nothing was consumed and the connection is
  3733. // still open, so the caller can send on it and read again. `msg` is left
  3734. // untouched, so a `while (ws.read(msg))` loop must not treat it as a message.
  3735. enum ReadResult : int { Fail = 0, Text = 1, Binary = 2, Timeout = 3 };
  3736. // Result of WebSocketClient::connect(). Truthy only when the WebSocket
  3737. // upgrade handshake fully succeeded. On failure error() identifies the
  3738. // failing layer; status()/headers() expose the server's upgrade response
  3739. // when one was received (status() is -1 otherwise), or the proxy's reply to
  3740. // CONNECT when error() is ProxyConnection.
  3741. class Result {
  3742. public:
  3743. Result() = default;
  3744. Result(Error err, int status, Headers &&headers)
  3745. : err_(err), status_(status), headers_(std::move(headers)) {}
  3746. explicit operator bool() const { return err_ == Error::Success; }
  3747. Error error() const { return err_; }
  3748. // Upgrade response info
  3749. int status() const { return status_; }
  3750. const Headers &headers() const { return headers_; }
  3751. std::string get_header_value(const std::string &key,
  3752. const char *def = "") const {
  3753. return detail::get_header_value(headers_, key, def, 0);
  3754. }
  3755. bool has_header(const std::string &key) const {
  3756. return headers_.find(key) != headers_.end();
  3757. }
  3758. #ifdef CPPHTTPLIB_SSL_ENABLED
  3759. Result(Error err, int status, Headers &&headers, int ssl_error,
  3760. uint64_t ssl_backend_error)
  3761. : err_(err), status_(status), headers_(std::move(headers)),
  3762. ssl_error_(ssl_error), ssl_backend_error_(ssl_backend_error) {}
  3763. int ssl_error() const { return ssl_error_; }
  3764. uint64_t ssl_backend_error() const { return ssl_backend_error_; }
  3765. #endif
  3766. private:
  3767. Error err_ = Error::Unknown; // a default-constructed Result is falsy
  3768. int status_ = -1;
  3769. Headers headers_;
  3770. #ifdef CPPHTTPLIB_SSL_ENABLED
  3771. int ssl_error_ = 0;
  3772. uint64_t ssl_backend_error_ = 0;
  3773. #endif
  3774. };
  3775. class WebSocket {
  3776. public:
  3777. WebSocket(const WebSocket &) = delete;
  3778. WebSocket &operator=(const WebSocket &) = delete;
  3779. ~WebSocket();
  3780. ReadResult read(std::string &msg);
  3781. bool send(const std::string &data);
  3782. bool send(const char *data, size_t len);
  3783. void close(CloseStatus status = CloseStatus::Normal,
  3784. const std::string &reason = "");
  3785. const Request &request() const;
  3786. bool is_open() const;
  3787. // Bound how long read() waits before returning Timeout. 0 waits forever.
  3788. // A server handler owns its connection's timeout this way; a client sets it
  3789. // through WebSocketClient. Safe to call while another thread is in read().
  3790. //
  3791. // Only a timeout set here is reported as Timeout. The compile-time default
  3792. // (CPPHTTPLIB_WEBSOCKET_SERVER_READ_TIMEOUT_SECOND) is a backstop rather
  3793. // than a request for control, so when it elapses read() returns Fail and
  3794. // closes the connection, and `while (ws.read(msg))` ends as it always has.
  3795. void set_read_timeout(time_t sec, time_t usec = 0);
  3796. template <class Rep, class Period>
  3797. void set_read_timeout(const std::chrono::duration<Rep, Period> &duration);
  3798. private:
  3799. friend class httplib::Server;
  3800. friend class httplib::ws::WebSocketClient;
  3801. WebSocket(
  3802. Stream &strm, const Request &req, bool is_server,
  3803. time_t ping_interval_sec = CPPHTTPLIB_WEBSOCKET_PING_INTERVAL_SECOND,
  3804. int max_missed_pongs = CPPHTTPLIB_WEBSOCKET_MAX_MISSED_PONGS)
  3805. : strm_(strm), req_(req), is_server_(is_server),
  3806. ping_interval_sec_(ping_interval_sec),
  3807. max_missed_pongs_(max_missed_pongs) {
  3808. start_heartbeat();
  3809. }
  3810. WebSocket(
  3811. std::unique_ptr<Stream> &&owned_strm, const Request &req, bool is_server,
  3812. time_t ping_interval_sec = CPPHTTPLIB_WEBSOCKET_PING_INTERVAL_SECOND,
  3813. int max_missed_pongs = CPPHTTPLIB_WEBSOCKET_MAX_MISSED_PONGS)
  3814. : strm_(*owned_strm), owned_strm_(std::move(owned_strm)), req_(req),
  3815. is_server_(is_server), ping_interval_sec_(ping_interval_sec),
  3816. max_missed_pongs_(max_missed_pongs) {
  3817. start_heartbeat();
  3818. }
  3819. void start_heartbeat();
  3820. bool send_frame(Opcode op, const char *data, size_t len, bool fin = true);
  3821. Stream &strm_;
  3822. std::unique_ptr<Stream> owned_strm_;
  3823. Request req_;
  3824. bool is_server_;
  3825. time_t ping_interval_sec_;
  3826. int max_missed_pongs_;
  3827. int unacked_pings_ = 0;
  3828. std::atomic<bool> closed_{false};
  3829. // Set once the caller has bounded read() through set_read_timeout(). Until
  3830. // then the timeout in effect is the compile-time default, and elapsing it
  3831. // is a failure that closes the connection, not a Timeout.
  3832. std::atomic<bool> read_timeout_set_{false};
  3833. std::mutex write_mutex_;
  3834. // Owned by whichever thread is parsing frames off strm_. Only one thread
  3835. // may do so: read_websocket_frame() reads a payload until it has the whole
  3836. // declared length, so a second parser stealing bytes silently corrupts the
  3837. // message the first one is assembling.
  3838. std::mutex read_mutex_;
  3839. std::thread ping_thread_;
  3840. std::mutex ping_mutex_;
  3841. std::condition_variable ping_cv_;
  3842. };
  3843. class WebSocketClient {
  3844. public:
  3845. explicit WebSocketClient(const std::string &scheme_host_port_path,
  3846. const Headers &headers = {});
  3847. ~WebSocketClient();
  3848. WebSocketClient(const WebSocketClient &) = delete;
  3849. WebSocketClient &operator=(const WebSocketClient &) = delete;
  3850. bool is_valid() const;
  3851. Result connect();
  3852. ReadResult read(std::string &msg);
  3853. bool send(const std::string &data);
  3854. bool send(const char *data, size_t len);
  3855. void close(CloseStatus status = CloseStatus::Normal,
  3856. const std::string &reason = "");
  3857. bool is_open() const;
  3858. const std::string &subprotocol() const;
  3859. void set_read_timeout(time_t sec, time_t usec = 0);
  3860. template <class Rep, class Period>
  3861. void set_read_timeout(const std::chrono::duration<Rep, Period> &duration);
  3862. void set_write_timeout(time_t sec, time_t usec = 0);
  3863. template <class Rep, class Period>
  3864. void set_write_timeout(const std::chrono::duration<Rep, Period> &duration);
  3865. void set_websocket_ping_interval(time_t sec);
  3866. void set_websocket_max_missed_pongs(int count);
  3867. void set_tcp_nodelay(bool on);
  3868. void set_address_family(int family);
  3869. void set_ipv6_v6only(bool on);
  3870. void set_socket_options(SocketOptions socket_options);
  3871. void set_connection_timeout(time_t sec, time_t usec = 0);
  3872. template <class Rep, class Period>
  3873. void
  3874. set_connection_timeout(const std::chrono::duration<Rep, Period> &duration);
  3875. void set_interface(const std::string &intf);
  3876. void set_hostname_addr_map(std::map<std::string, std::string> addr_map);
  3877. void set_proxy(const std::string &host, int port);
  3878. void set_proxy_basic_auth(const std::string &username,
  3879. const std::string &password);
  3880. void set_proxy_bearer_token_auth(const std::string &token);
  3881. void set_no_proxy(const std::vector<std::string> &patterns);
  3882. #ifdef CPPHTTPLIB_SSL_ENABLED
  3883. struct PemMemory {
  3884. const char *cert_pem;
  3885. size_t cert_pem_len;
  3886. const char *key_pem;
  3887. size_t key_pem_len;
  3888. const char *private_key_password;
  3889. };
  3890. explicit WebSocketClient(const std::string &scheme_host_port_path,
  3891. const PemMemory &pem, const Headers &headers = {});
  3892. void set_ca_cert_path(const std::string &ca_cert_file_path,
  3893. const std::string &ca_cert_dir_path = std::string());
  3894. void set_ca_cert_store(tls::ca_store_t store);
  3895. void load_ca_cert_store(const char *ca_cert, std::size_t size);
  3896. void enable_server_certificate_verification(bool enabled);
  3897. void enable_server_hostname_verification(bool enabled);
  3898. void enable_system_ca(bool enabled);
  3899. void set_server_certificate_verifier(tls::VerifyCallback verifier);
  3900. void set_session_verifier(
  3901. std::function<SSLVerifierResponse(tls::session_t)> verifier);
  3902. void set_proxy_digest_auth(const std::string &username,
  3903. const std::string &password);
  3904. #endif
  3905. private:
  3906. void shutdown_and_close();
  3907. std::pair<time_t, time_t> handshake_timeout() const;
  3908. bool create_stream(std::unique_ptr<Stream> &strm, Error &error,
  3909. int &ssl_error, uint64_t &ssl_backend_error);
  3910. void prepare_default_headers(Request &req);
  3911. bool is_proxy_enabled() const;
  3912. bool create_and_connect_socket(Error &error);
  3913. bool send_proxy_connect(Request &req, Response &proxy_res, Error &error);
  3914. bool connect_with_proxy(Response &proxy_res, Error &error);
  3915. std::string host_;
  3916. int port_;
  3917. std::string path_;
  3918. Headers headers_;
  3919. std::string subprotocol_;
  3920. bool is_valid_ = false;
  3921. socket_t sock_ = INVALID_SOCKET;
  3922. std::unique_ptr<WebSocket> ws_;
  3923. time_t read_timeout_sec_ = CPPHTTPLIB_WEBSOCKET_CLIENT_READ_TIMEOUT_SECOND;
  3924. time_t read_timeout_usec_ = 0;
  3925. bool read_timeout_set_ = false; // see WebSocket::read_timeout_set_
  3926. time_t write_timeout_sec_ = CPPHTTPLIB_CLIENT_WRITE_TIMEOUT_SECOND;
  3927. time_t write_timeout_usec_ = CPPHTTPLIB_CLIENT_WRITE_TIMEOUT_USECOND;
  3928. time_t websocket_ping_interval_sec_ =
  3929. CPPHTTPLIB_WEBSOCKET_PING_INTERVAL_SECOND;
  3930. int websocket_max_missed_pongs_ = CPPHTTPLIB_WEBSOCKET_MAX_MISSED_PONGS;
  3931. int address_family_ = AF_UNSPEC;
  3932. bool tcp_nodelay_ = CPPHTTPLIB_TCP_NODELAY;
  3933. bool ipv6_v6only_ = CPPHTTPLIB_IPV6_V6ONLY;
  3934. SocketOptions socket_options_ = nullptr;
  3935. time_t connection_timeout_sec_ = CPPHTTPLIB_CONNECTION_TIMEOUT_SECOND;
  3936. time_t connection_timeout_usec_ = CPPHTTPLIB_CONNECTION_TIMEOUT_USECOND;
  3937. std::string interface_;
  3938. // Hostname to connection target map. The value is an IP literal or another
  3939. // hostname; only the connection target changes, never the identity.
  3940. std::map<std::string, std::string> addr_map_;
  3941. std::string proxy_host_;
  3942. int proxy_port_ = -1;
  3943. std::string proxy_basic_auth_username_;
  3944. std::string proxy_basic_auth_password_;
  3945. std::string proxy_bearer_token_auth_token_;
  3946. std::vector<detail::NoProxyEntry> no_proxy_entries_;
  3947. #ifdef CPPHTTPLIB_SSL_ENABLED
  3948. bool is_ssl_ = false;
  3949. tls::ctx_t tls_ctx_ = nullptr;
  3950. tls::session_t tls_session_ = nullptr;
  3951. std::string ca_cert_file_path_;
  3952. std::string ca_cert_dir_path_;
  3953. bool custom_ca_loaded_ = false;
  3954. bool certs_loaded_ = false;
  3955. SystemCAMode system_ca_mode_ = SystemCAMode::Auto;
  3956. bool server_certificate_verification_ = true;
  3957. bool server_hostname_verification_ = true;
  3958. std::function<SSLVerifierResponse(tls::session_t)> session_verifier_;
  3959. std::string proxy_digest_auth_username_;
  3960. std::string proxy_digest_auth_password_;
  3961. #endif
  3962. };
  3963. template <class Rep, class Period>
  3964. inline void WebSocket::set_read_timeout(
  3965. const std::chrono::duration<Rep, Period> &duration) {
  3966. detail::duration_to_sec_and_usec(
  3967. duration, [&](time_t sec, time_t usec) { set_read_timeout(sec, usec); });
  3968. }
  3969. template <class Rep, class Period>
  3970. inline void WebSocketClient::set_read_timeout(
  3971. const std::chrono::duration<Rep, Period> &duration) {
  3972. detail::duration_to_sec_and_usec(
  3973. duration, [&](time_t sec, time_t usec) { set_read_timeout(sec, usec); });
  3974. }
  3975. template <class Rep, class Period>
  3976. inline void WebSocketClient::set_write_timeout(
  3977. const std::chrono::duration<Rep, Period> &duration) {
  3978. detail::duration_to_sec_and_usec(
  3979. duration, [&](time_t sec, time_t usec) { set_write_timeout(sec, usec); });
  3980. }
  3981. template <class Rep, class Period>
  3982. inline void WebSocketClient::set_connection_timeout(
  3983. const std::chrono::duration<Rep, Period> &duration) {
  3984. detail::duration_to_sec_and_usec(duration, [&](time_t sec, time_t usec) {
  3985. set_connection_timeout(sec, usec);
  3986. });
  3987. }
  3988. namespace impl {
  3989. bool is_valid_utf8(const std::string &s);
  3990. // Three states, because a failure that consumed bytes and one that consumed
  3991. // none are not the same thing: the first has left the stream in the middle of
  3992. // a frame and the connection cannot be reused, the second can just be retried.
  3993. enum class FrameRead { Ok, Fail, Timeout };
  3994. FrameRead read_websocket_frame(Stream &strm, Opcode &opcode,
  3995. std::string &payload, bool &fin,
  3996. bool expect_masked, size_t max_len);
  3997. } // namespace impl
  3998. } // namespace ws
  3999. // ----------------------------------------------------------------------------
  4000. /*
  4001. * Implementation that will be part of the .cc file if split into .h + .cc.
  4002. */
  4003. namespace stream {
  4004. // stream::Result implementations
  4005. inline Result::Result() : chunk_size_(8192) {}
  4006. inline Result::Result(ClientImpl::StreamHandle &&handle, size_t chunk_size)
  4007. : handle_(std::move(handle)), chunk_size_(chunk_size) {}
  4008. inline Result::Result(Result &&other) noexcept
  4009. : handle_(std::move(other.handle_)), buffer_(std::move(other.buffer_)),
  4010. current_size_(other.current_size_), chunk_size_(other.chunk_size_),
  4011. finished_(other.finished_) {
  4012. other.current_size_ = 0;
  4013. other.finished_ = true;
  4014. }
  4015. inline Result &Result::operator=(Result &&other) noexcept {
  4016. if (this != &other) {
  4017. handle_ = std::move(other.handle_);
  4018. buffer_ = std::move(other.buffer_);
  4019. current_size_ = other.current_size_;
  4020. chunk_size_ = other.chunk_size_;
  4021. finished_ = other.finished_;
  4022. other.current_size_ = 0;
  4023. other.finished_ = true;
  4024. }
  4025. return *this;
  4026. }
  4027. inline bool Result::is_valid() const { return handle_.is_valid(); }
  4028. inline Result::operator bool() const { return is_valid(); }
  4029. inline int Result::status() const {
  4030. return handle_.response ? handle_.response->status : -1;
  4031. }
  4032. inline const Headers &Result::headers() const {
  4033. static const Headers empty_headers;
  4034. return handle_.response ? handle_.response->headers : empty_headers;
  4035. }
  4036. inline std::string Result::get_header_value(const std::string &key,
  4037. const char *def) const {
  4038. return handle_.response ? handle_.response->get_header_value(key, def) : def;
  4039. }
  4040. inline bool Result::has_header(const std::string &key) const {
  4041. return handle_.response ? handle_.response->has_header(key) : false;
  4042. }
  4043. inline Error Result::error() const { return handle_.error; }
  4044. inline Error Result::read_error() const { return handle_.get_read_error(); }
  4045. inline bool Result::has_read_error() const { return handle_.has_read_error(); }
  4046. inline bool Result::next() {
  4047. if (!handle_.is_valid() || finished_) { return false; }
  4048. if (buffer_.size() < chunk_size_) { buffer_.resize(chunk_size_); }
  4049. ssize_t n = handle_.read(&buffer_[0], chunk_size_);
  4050. if (n > 0) {
  4051. current_size_ = static_cast<size_t>(n);
  4052. return true;
  4053. }
  4054. current_size_ = 0;
  4055. finished_ = true;
  4056. return false;
  4057. }
  4058. inline const char *Result::data() const { return buffer_.data(); }
  4059. inline size_t Result::size() const { return current_size_; }
  4060. inline std::string Result::read_all() {
  4061. std::string result;
  4062. while (next()) {
  4063. result.append(data(), size());
  4064. }
  4065. return result;
  4066. }
  4067. } // namespace stream
  4068. namespace sse {
  4069. // SSEMessage implementations
  4070. inline SSEMessage::SSEMessage() : event("message") {}
  4071. inline void SSEMessage::clear() {
  4072. event = "message";
  4073. data.clear();
  4074. id.clear();
  4075. }
  4076. // SSEClient implementations
  4077. inline SSEClient::SSEClient(Client &client, const std::string &path)
  4078. : client_(client), path_(path) {}
  4079. inline SSEClient::SSEClient(Client &client, const std::string &path,
  4080. const Headers &headers)
  4081. : client_(client), path_(path), headers_(headers) {}
  4082. inline SSEClient::~SSEClient() { stop(); }
  4083. inline SSEClient &SSEClient::on_message(MessageHandler handler) {
  4084. on_message_ = std::move(handler);
  4085. return *this;
  4086. }
  4087. inline SSEClient &SSEClient::on_event(const std::string &type,
  4088. MessageHandler handler) {
  4089. event_handlers_[type] = std::move(handler);
  4090. return *this;
  4091. }
  4092. inline SSEClient &SSEClient::on_open(OpenHandler handler) {
  4093. on_open_ = std::move(handler);
  4094. return *this;
  4095. }
  4096. inline SSEClient &SSEClient::on_error(ErrorHandler handler) {
  4097. on_error_ = std::move(handler);
  4098. return *this;
  4099. }
  4100. inline SSEClient &SSEClient::set_reconnect_interval(int ms) {
  4101. reconnect_interval_ms_ = ms;
  4102. return *this;
  4103. }
  4104. inline SSEClient &SSEClient::set_max_reconnect_attempts(int n) {
  4105. max_reconnect_attempts_ = n;
  4106. return *this;
  4107. }
  4108. inline SSEClient &SSEClient::set_headers(const Headers &headers) {
  4109. std::lock_guard<std::mutex> lock(headers_mutex_);
  4110. headers_ = headers;
  4111. return *this;
  4112. }
  4113. inline bool SSEClient::is_connected() const { return connected_.load(); }
  4114. inline const std::string &SSEClient::last_event_id() const {
  4115. return last_event_id_;
  4116. }
  4117. inline void SSEClient::start() {
  4118. running_.store(true);
  4119. run_event_loop();
  4120. }
  4121. inline void SSEClient::start_async() {
  4122. running_.store(true);
  4123. async_thread_ = std::thread([this]() { run_event_loop(); });
  4124. }
  4125. inline void SSEClient::stop() {
  4126. running_.store(false);
  4127. {
  4128. // Ends a blocked read. The loop withdraws the socket under this lock
  4129. // before closing it, so it is still open here.
  4130. std::lock_guard<std::mutex> lock(stream_mutex_);
  4131. if (stream_sock_ != INVALID_SOCKET) {
  4132. #ifdef _WIN32
  4133. ::shutdown(stream_sock_, SD_BOTH);
  4134. #else
  4135. // Only the read side, so that the alert TLS sends on the unexpected EOF
  4136. // does not raise SIGPIPE
  4137. ::shutdown(stream_sock_, SHUT_RD);
  4138. #endif
  4139. }
  4140. }
  4141. client_.stop(); // Cancel any pending operations
  4142. if (async_thread_.joinable()) { async_thread_.join(); }
  4143. }
  4144. inline bool SSEClient::parse_sse_line(const std::string &line, SSEMessage &msg,
  4145. int &retry_ms, bool &has_data,
  4146. bool &has_id) {
  4147. // Blank line signals end of event
  4148. if (line.empty()) { return true; }
  4149. // Lines starting with ':' are comments (ignored)
  4150. if (line[0] == ':') { return false; }
  4151. // Find the colon separator
  4152. auto colon_pos = line.find(':');
  4153. auto field = line.substr(0, colon_pos);
  4154. std::string value;
  4155. // Value starts after colon, skip optional single space
  4156. if (colon_pos != std::string::npos && colon_pos + 1 < line.size()) {
  4157. auto value_start = colon_pos + 1;
  4158. if (line[value_start] == ' ') { value_start++; }
  4159. value = line.substr(value_start);
  4160. }
  4161. // Handle known fields
  4162. if (field == "event") {
  4163. // An empty event type is dispatched as "message" per the SSE spec
  4164. msg.event = value.empty() ? std::string("message") : std::move(value);
  4165. } else if (field == "data") {
  4166. // Multiple data lines are concatenated with newlines
  4167. if (has_data) { msg.data += "\n"; }
  4168. msg.data += value;
  4169. has_data = true;
  4170. } else if (field == "id") {
  4171. // An id that cannot be sent back as Last-Event-ID is ignored. Empty id is
  4172. // valid (clears the last event ID)
  4173. if (detail::fields::is_field_value(value)) {
  4174. msg.id = value;
  4175. has_id = true;
  4176. }
  4177. } else if (field == "retry") {
  4178. // Parse retry interval in milliseconds
  4179. // Per the SSE spec, a value that is not all ASCII digits is ignored.
  4180. if (detail::is_numeric(value)) {
  4181. int v = 0;
  4182. auto res =
  4183. detail::from_chars(value.data(), value.data() + value.size(), v);
  4184. if (res.ec == std::errc{}) { retry_ms = v; }
  4185. }
  4186. }
  4187. // Unknown fields are ignored per SSE spec
  4188. return false;
  4189. }
  4190. inline void SSEClient::run_event_loop() {
  4191. auto reconnect_count = 0;
  4192. while (running_.load()) {
  4193. // Build headers, including Last-Event-ID if we have one
  4194. Headers request_headers;
  4195. {
  4196. std::lock_guard<std::mutex> lock(headers_mutex_);
  4197. request_headers = headers_;
  4198. }
  4199. if (!last_event_id_.empty()) {
  4200. request_headers.emplace("Last-Event-ID", last_event_id_);
  4201. }
  4202. // Open streaming connection. An event stream has no end, so each event is
  4203. // bounded instead of the whole body.
  4204. auto handle = client_.open_stream("GET", path_, {}, request_headers);
  4205. handle.body_reader_.payload_max_length = 0;
  4206. auto sock = handle.connection_ ? handle.connection_->sock : INVALID_SOCKET;
  4207. stream::Result result{std::move(handle)};
  4208. // Connection error handling
  4209. if (!result) {
  4210. connected_.store(false);
  4211. if (on_error_) { on_error_(result.error()); }
  4212. if (!should_reconnect(reconnect_count)) { break; }
  4213. wait_for_reconnect();
  4214. reconnect_count++;
  4215. continue;
  4216. }
  4217. if (result.status() != StatusCode::OK_200) {
  4218. connected_.store(false);
  4219. if (on_error_) { on_error_(Error::Connection); }
  4220. // For certain errors, don't reconnect.
  4221. // Note: 401 is intentionally absent so that handlers can refresh
  4222. // credentials via set_headers() and let the client reconnect.
  4223. if (result.status() == StatusCode::NoContent_204 ||
  4224. result.status() == StatusCode::NotFound_404 ||
  4225. result.status() == StatusCode::Forbidden_403) {
  4226. break;
  4227. }
  4228. if (!should_reconnect(reconnect_count)) { break; }
  4229. wait_for_reconnect();
  4230. reconnect_count++;
  4231. continue;
  4232. }
  4233. // Hand the socket to stop(), unless it has already been called
  4234. {
  4235. std::lock_guard<std::mutex> lock(stream_mutex_);
  4236. if (!running_.load()) { break; }
  4237. stream_sock_ = sock;
  4238. }
  4239. // Destroyed before result, so the socket is withdrawn before it is closed
  4240. detail::scope_exit withdraw_sock([this] {
  4241. std::lock_guard<std::mutex> lock(stream_mutex_);
  4242. stream_sock_ = INVALID_SOCKET;
  4243. });
  4244. // Connection successful
  4245. connected_.store(true);
  4246. reconnect_count = 0;
  4247. if (on_open_) { on_open_(); }
  4248. // Event receiving loop
  4249. std::string buffer;
  4250. SSEMessage current_msg;
  4251. auto has_data = false;
  4252. auto has_id = false;
  4253. auto first_line = true;
  4254. auto after_cr = false;
  4255. auto event_too_long = false;
  4256. while (running_.load() && result.next()) {
  4257. // What is left in the buffer has no line ending
  4258. auto search_pos = buffer.size();
  4259. buffer.append(result.data(), result.size());
  4260. // Process complete lines in the buffer. A line ends with \r\n, \n or \r
  4261. // per the SSE spec
  4262. size_t line_start = 0;
  4263. size_t eol_pos;
  4264. while ((eol_pos = buffer.find_first_of("\r\n", search_pos)) !=
  4265. std::string::npos) {
  4266. auto line = buffer.substr(line_start, eol_pos - line_start);
  4267. line_start = eol_pos + 1;
  4268. search_pos = line_start;
  4269. // The \n of a \r\n may arrive in a later chunk than its \r
  4270. auto is_lf_of_crlf =
  4271. after_cr && line.empty() && buffer[eol_pos] == '\n';
  4272. after_cr = buffer[eol_pos] == '\r';
  4273. if (is_lf_of_crlf) { continue; }
  4274. // A UTF-8 BOM at the start of the stream is ignored per the SSE spec
  4275. if (first_line) {
  4276. first_line = false;
  4277. if (line.compare(0, 3, "\xEF\xBB\xBF") == 0) { line.erase(0, 3); }
  4278. }
  4279. // Parse the line and check if event is complete
  4280. auto event_complete = parse_sse_line(
  4281. line, current_msg, reconnect_interval_ms_, has_data, has_id);
  4282. if (event_complete) {
  4283. // Update last_event_id for reconnection, even for an event that
  4284. // has no data. An empty id clears it.
  4285. if (has_id) { last_event_id_ = current_msg.id; }
  4286. // An event without a data field is not dispatched
  4287. if (has_data) { dispatch_event(current_msg); }
  4288. // Reset the message for the next event either way
  4289. current_msg.clear();
  4290. has_data = false;
  4291. has_id = false;
  4292. }
  4293. }
  4294. // Keep unprocessed data in buffer
  4295. buffer.erase(0, line_start);
  4296. // Neither an event nor a line still waiting for its end may grow
  4297. // without bound. 0 means no limit.
  4298. if (CPPHTTPLIB_SSE_MAX_EVENT_LENGTH > 0 &&
  4299. buffer.size() + current_msg.data.size() >
  4300. CPPHTTPLIB_SSE_MAX_EVENT_LENGTH) {
  4301. if (on_error_) { on_error_(Error::ExceedMaxPayloadSize); }
  4302. event_too_long = true;
  4303. break;
  4304. }
  4305. }
  4306. // Connection ended
  4307. connected_.store(false);
  4308. // Reconnecting would only get the same event again
  4309. if (!running_.load() || event_too_long) { break; }
  4310. // Check for read errors
  4311. if (result.has_read_error()) {
  4312. if (on_error_) { on_error_(result.read_error()); }
  4313. }
  4314. if (!should_reconnect(reconnect_count)) { break; }
  4315. wait_for_reconnect();
  4316. reconnect_count++;
  4317. }
  4318. connected_.store(false);
  4319. }
  4320. inline void SSEClient::dispatch_event(const SSEMessage &msg) {
  4321. // Check for specific event type handler first
  4322. auto it = event_handlers_.find(msg.event);
  4323. if (it != event_handlers_.end()) {
  4324. it->second(msg);
  4325. return;
  4326. }
  4327. // Fall back to generic message handler
  4328. if (on_message_) { on_message_(msg); }
  4329. }
  4330. inline bool SSEClient::should_reconnect(int count) const {
  4331. if (!running_.load()) { return false; }
  4332. if (max_reconnect_attempts_ == 0) { return true; } // unlimited
  4333. return count < max_reconnect_attempts_;
  4334. }
  4335. inline void SSEClient::wait_for_reconnect() {
  4336. // Use small increments to check running_ flag frequently.
  4337. // Always wait at least one increment, so that a zero interval (e.g.
  4338. // "retry: 0" from the server) cannot cause a busy reconnect loop.
  4339. const auto step_ms = 100;
  4340. auto interval_ms = (std::max)(reconnect_interval_ms_, step_ms);
  4341. auto waited = 0;
  4342. while (running_.load() && waited < interval_ms) {
  4343. std::this_thread::sleep_for(std::chrono::milliseconds(step_ms));
  4344. waited += step_ms;
  4345. }
  4346. }
  4347. } // namespace sse
  4348. #ifdef CPPHTTPLIB_SSL_ENABLED
  4349. /*
  4350. * TLS abstraction layer - internal function declarations
  4351. * These are implementation details and not part of the public API.
  4352. */
  4353. namespace tls {
  4354. // Client context
  4355. ctx_t create_client_context();
  4356. void free_context(ctx_t ctx);
  4357. bool set_min_version(ctx_t ctx, Version version);
  4358. bool load_ca_pem(ctx_t ctx, const char *pem, size_t len);
  4359. bool load_ca_file(ctx_t ctx, const char *file_path);
  4360. bool load_ca_dir(ctx_t ctx, const char *dir_path);
  4361. bool load_system_certs(ctx_t ctx);
  4362. bool set_client_cert_pem(ctx_t ctx, const char *cert, const char *key,
  4363. const char *password);
  4364. bool set_client_cert_file(ctx_t ctx, const char *cert_path,
  4365. const char *key_path, const char *password);
  4366. // Server context
  4367. ctx_t create_server_context();
  4368. bool set_server_cert_pem(ctx_t ctx, const char *cert, const char *key,
  4369. const char *password);
  4370. bool set_server_cert_file(ctx_t ctx, const char *cert_path,
  4371. const char *key_path, const char *password);
  4372. bool set_client_ca_file(ctx_t ctx, const char *ca_file, const char *ca_dir);
  4373. void set_verify_client(ctx_t ctx, bool require);
  4374. // Session management
  4375. session_t create_session(ctx_t ctx, socket_t sock);
  4376. void free_session(session_t session);
  4377. bool set_sni(session_t session, const char *hostname, bool verify_hostname);
  4378. // Handshake (non-blocking capable)
  4379. TlsError connect(session_t session);
  4380. TlsError accept(session_t session);
  4381. // Handshake with timeout (blocking until timeout)
  4382. bool connect_nonblocking(session_t session, socket_t sock, time_t timeout_sec,
  4383. time_t timeout_usec, TlsError *err);
  4384. bool accept_nonblocking(session_t session, socket_t sock, time_t timeout_sec,
  4385. time_t timeout_usec, TlsError *err);
  4386. // I/O (non-blocking capable)
  4387. ssize_t read(session_t session, void *buf, size_t len, TlsError &err);
  4388. ssize_t write(session_t session, const void *buf, size_t len, TlsError &err);
  4389. int pending(const_session_t session);
  4390. void shutdown(session_t session, bool graceful);
  4391. // Connection state
  4392. bool is_peer_closed(session_t session, socket_t sock);
  4393. // Certificate verification
  4394. cert_t get_peer_cert(const_session_t session);
  4395. // The certificates the peer sent, leaf first. Free each with free_cert(), and
  4396. // do not use them after free_session(), as with get_peer_cert().
  4397. size_t get_peer_certs(const_session_t session, std::vector<cert_t> &certs);
  4398. void free_cert(cert_t cert);
  4399. bool verify_hostname(cert_t cert, const char *hostname);
  4400. uint64_t hostname_mismatch_code();
  4401. long get_verify_result(const_session_t session);
  4402. // Certificate introspection
  4403. std::string get_cert_subject_cn(cert_t cert);
  4404. std::string get_cert_issuer_name(cert_t cert);
  4405. bool get_cert_sans(cert_t cert, std::vector<SanEntry> &sans);
  4406. bool get_cert_validity(cert_t cert, time_t &not_before, time_t &not_after);
  4407. std::string get_cert_serial(cert_t cert);
  4408. bool get_cert_der(cert_t cert, std::vector<unsigned char> &der);
  4409. const char *get_sni(const_session_t session);
  4410. // CA store management
  4411. ca_store_t create_ca_store(const char *pem, size_t len);
  4412. void free_ca_store(ca_store_t store);
  4413. bool set_ca_store(ctx_t ctx, ca_store_t store);
  4414. // Free each with free_cert(), and do not use them once the context's CA
  4415. // certificates change.
  4416. size_t get_ca_certs(ctx_t ctx, std::vector<cert_t> &certs);
  4417. std::vector<std::string> get_ca_names(ctx_t ctx);
  4418. // Dynamic certificate update (for servers)
  4419. bool update_server_cert(ctx_t ctx, const char *cert_pem, const char *key_pem,
  4420. const char *password);
  4421. bool update_server_client_ca(ctx_t ctx, const char *ca_pem);
  4422. // Certificate verification callback
  4423. bool set_verify_callback(ctx_t ctx, VerifyCallback callback);
  4424. long get_verify_error(const_session_t session);
  4425. std::string verify_error_string(long error_code);
  4426. // TlsError information
  4427. uint64_t peek_error();
  4428. uint64_t get_error();
  4429. std::string error_string(uint64_t code);
  4430. } // namespace tls
  4431. #endif // CPPHTTPLIB_SSL_ENABLED
  4432. /*
  4433. * Group 1: detail namespace - Non-SSL utilities
  4434. */
  4435. namespace detail {
  4436. inline bool set_socket_opt_impl(socket_t sock, int level, int optname,
  4437. const void *optval, socklen_t optlen) {
  4438. return setsockopt(sock, level, optname,
  4439. #ifdef _WIN32
  4440. reinterpret_cast<const char *>(optval),
  4441. #else
  4442. optval,
  4443. #endif
  4444. optlen) == 0;
  4445. }
  4446. inline bool set_socket_opt_time(socket_t sock, int level, int optname,
  4447. time_t sec, time_t usec) {
  4448. #ifdef _WIN32
  4449. auto timeout = static_cast<uint32_t>(sec * 1000 + usec / 1000);
  4450. #else
  4451. timeval timeout;
  4452. timeout.tv_sec = static_cast<long>(sec);
  4453. timeout.tv_usec = static_cast<decltype(timeout.tv_usec)>(usec);
  4454. #endif
  4455. return set_socket_opt_impl(sock, level, optname, &timeout, sizeof(timeout));
  4456. }
  4457. inline bool is_hex(char c, int &v) {
  4458. if (is_ascii_digit(c)) {
  4459. v = c - '0';
  4460. return true;
  4461. } else if ('A' <= c && c <= 'F') {
  4462. v = c - 'A' + 10;
  4463. return true;
  4464. } else if ('a' <= c && c <= 'f') {
  4465. v = c - 'a' + 10;
  4466. return true;
  4467. }
  4468. return false;
  4469. }
  4470. inline bool from_hex_to_i(const std::string &s, size_t i, size_t cnt,
  4471. int &val) {
  4472. if (i >= s.size()) { return false; }
  4473. val = 0;
  4474. for (; cnt; i++, cnt--) {
  4475. if (!s[i]) { return false; }
  4476. auto v = 0;
  4477. if (is_hex(s[i], v)) {
  4478. val = val * 16 + v;
  4479. } else {
  4480. return false;
  4481. }
  4482. }
  4483. return true;
  4484. }
  4485. inline std::string from_i_to_hex(size_t n) {
  4486. static const auto charset = "0123456789abcdef";
  4487. std::string ret;
  4488. do {
  4489. ret = charset[n & 15] + ret;
  4490. n >>= 4;
  4491. } while (n > 0);
  4492. return ret;
  4493. }
  4494. // A round trip rather than `n <= SIZE_MAX`, which is always true on 64-bit
  4495. // builds and trips -Wtautological-type-limit-compare.
  4496. inline bool fits_in_size_t(uint64_t n) {
  4497. return static_cast<uint64_t>(static_cast<size_t>(n)) == n;
  4498. }
  4499. inline std::string compute_etag(const FileStat &fs,
  4500. const std::string &suffix = std::string()) {
  4501. if (!fs.is_file()) { return std::string(); }
  4502. // If mtime cannot be determined (negative value indicates an error
  4503. // or sentinel), do not generate an ETag. Returning a neutral / fixed
  4504. // value like 0 could collide with a real file that legitimately has
  4505. // mtime == 0 (epoch) and lead to misleading validators.
  4506. auto mtime_raw = fs.mtime();
  4507. if (mtime_raw < 0) { return std::string(); }
  4508. auto mtime = static_cast<size_t>(mtime_raw);
  4509. auto size = fs.size();
  4510. return std::string("W/\"") + from_i_to_hex(mtime) + "-" +
  4511. from_i_to_hex(size) + suffix + "\"";
  4512. }
  4513. // Format time_t as HTTP-date (RFC 9110 Section 5.6.7): "Sun, 06 Nov 1994
  4514. // 08:49:37 GMT" This implementation is defensive: it validates `mtime`, checks
  4515. // return values from `gmtime_r`/`gmtime_s`, and ensures `strftime` succeeds.
  4516. inline std::string file_mtime_to_http_date(time_t mtime) {
  4517. if (mtime < 0) { return std::string(); }
  4518. struct tm tm_buf;
  4519. #ifdef _WIN32
  4520. if (gmtime_s(&tm_buf, &mtime) != 0) { return std::string(); }
  4521. #else
  4522. if (gmtime_r(&mtime, &tm_buf) == nullptr) { return std::string(); }
  4523. #endif
  4524. char buf[64];
  4525. if (strftime(buf, sizeof(buf), "%a, %d %b %Y %H:%M:%S GMT", &tm_buf) == 0) {
  4526. return std::string();
  4527. }
  4528. return std::string(buf);
  4529. }
  4530. // Parse HTTP-date (RFC 9110 Section 5.6.7) to time_t. Returns -1 on failure.
  4531. inline time_t parse_http_date(const std::string &date_str) {
  4532. struct tm tm_buf;
  4533. // Create a classic locale object once for all parsing attempts
  4534. const std::locale classic_locale = std::locale::classic();
  4535. // Try to parse using std::get_time (C++11, cross-platform)
  4536. auto try_parse = [&](const char *fmt) -> bool {
  4537. std::istringstream ss(date_str);
  4538. ss.imbue(classic_locale);
  4539. memset(&tm_buf, 0, sizeof(tm_buf));
  4540. ss >> std::get_time(&tm_buf, fmt);
  4541. return !ss.fail();
  4542. };
  4543. // RFC 9110 preferred format (HTTP-date): "Sun, 06 Nov 1994 08:49:37 GMT"
  4544. if (!try_parse("%a, %d %b %Y %H:%M:%S")) {
  4545. // RFC 850 format: "Sunday, 06-Nov-94 08:49:37 GMT"
  4546. if (!try_parse("%A, %d-%b-%y %H:%M:%S")) {
  4547. // asctime format: "Sun Nov 6 08:49:37 1994"
  4548. if (!try_parse("%a %b %d %H:%M:%S %Y")) {
  4549. return static_cast<time_t>(-1);
  4550. }
  4551. }
  4552. }
  4553. #ifdef _WIN32
  4554. return _mkgmtime(&tm_buf);
  4555. #elif defined _AIX
  4556. return mktime(&tm_buf);
  4557. #else
  4558. return timegm(&tm_buf);
  4559. #endif
  4560. }
  4561. inline bool is_weak_etag(const std::string &s) {
  4562. // Check if the string is a weak ETag (starts with 'W/"')
  4563. return s.size() > 3 && s[0] == 'W' && s[1] == '/' && s[2] == '"';
  4564. }
  4565. inline bool is_strong_etag(const std::string &s) {
  4566. // Check if the string is a strong ETag (starts and ends with '"', at least 2
  4567. // chars)
  4568. return s.size() >= 2 && s[0] == '"' && s.back() == '"';
  4569. }
  4570. inline size_t to_utf8(int code, char *buff) {
  4571. if (code < 0x0080) {
  4572. buff[0] = static_cast<char>(code & 0x7F);
  4573. return 1;
  4574. } else if (code < 0x0800) {
  4575. buff[0] = static_cast<char>(0xC0 | ((code >> 6) & 0x1F));
  4576. buff[1] = static_cast<char>(0x80 | (code & 0x3F));
  4577. return 2;
  4578. } else if (code < 0xD800) {
  4579. buff[0] = static_cast<char>(0xE0 | ((code >> 12) & 0xF));
  4580. buff[1] = static_cast<char>(0x80 | ((code >> 6) & 0x3F));
  4581. buff[2] = static_cast<char>(0x80 | (code & 0x3F));
  4582. return 3;
  4583. } else if (code < 0xE000) { // D800 - DFFF is invalid...
  4584. return 0;
  4585. } else if (code < 0x10000) {
  4586. buff[0] = static_cast<char>(0xE0 | ((code >> 12) & 0xF));
  4587. buff[1] = static_cast<char>(0x80 | ((code >> 6) & 0x3F));
  4588. buff[2] = static_cast<char>(0x80 | (code & 0x3F));
  4589. return 3;
  4590. } else if (code < 0x110000) {
  4591. buff[0] = static_cast<char>(0xF0 | ((code >> 18) & 0x7));
  4592. buff[1] = static_cast<char>(0x80 | ((code >> 12) & 0x3F));
  4593. buff[2] = static_cast<char>(0x80 | ((code >> 6) & 0x3F));
  4594. buff[3] = static_cast<char>(0x80 | (code & 0x3F));
  4595. return 4;
  4596. }
  4597. // NOTREACHED
  4598. return 0;
  4599. }
  4600. } // namespace detail
  4601. namespace ws {
  4602. namespace impl {
  4603. inline bool is_valid_utf8(const std::string &s) {
  4604. size_t i = 0;
  4605. auto n = s.size();
  4606. while (i < n) {
  4607. auto c = static_cast<unsigned char>(s[i]);
  4608. size_t len;
  4609. uint32_t cp;
  4610. if (c < 0x80) {
  4611. i++;
  4612. continue;
  4613. } else if ((c & 0xE0) == 0xC0) {
  4614. len = 2;
  4615. cp = c & 0x1F;
  4616. } else if ((c & 0xF0) == 0xE0) {
  4617. len = 3;
  4618. cp = c & 0x0F;
  4619. } else if ((c & 0xF8) == 0xF0) {
  4620. len = 4;
  4621. cp = c & 0x07;
  4622. } else {
  4623. return false;
  4624. }
  4625. if (i + len > n) { return false; }
  4626. for (size_t j = 1; j < len; j++) {
  4627. auto b = static_cast<unsigned char>(s[i + j]);
  4628. if ((b & 0xC0) != 0x80) { return false; }
  4629. cp = (cp << 6) | (b & 0x3F);
  4630. }
  4631. // Overlong encoding check
  4632. if (len == 2 && cp < 0x80) { return false; }
  4633. if (len == 3 && cp < 0x800) { return false; }
  4634. if (len == 4 && cp < 0x10000) { return false; }
  4635. // Surrogate halves (U+D800..U+DFFF) and beyond U+10FFFF are invalid
  4636. if (cp >= 0xD800 && cp <= 0xDFFF) { return false; }
  4637. if (cp > 0x10FFFF) { return false; }
  4638. i += len;
  4639. }
  4640. return true;
  4641. }
  4642. } // namespace impl
  4643. } // namespace ws
  4644. namespace detail {
  4645. // NOTE: This code came up with the following stackoverflow post:
  4646. // https://stackoverflow.com/questions/180947/base64-decode-snippet-in-c
  4647. inline std::string base64_encode(const std::string &in) {
  4648. static const auto lookup =
  4649. "ABCDEFGHIJKLMNOPQRSTUVWXYZabcdefghijklmnopqrstuvwxyz0123456789+/";
  4650. std::string out;
  4651. out.reserve(in.size());
  4652. // Unsigned: the accumulator is never masked, so with a signed int the
  4653. // `val << 8` below overflows once enough bytes are folded in (undefined
  4654. // behaviour before C++20). Only the low bits are ever emitted, so the
  4655. // wrap-around of an unsigned accumulator does not affect the output.
  4656. uint32_t val = 0;
  4657. auto valb = -6;
  4658. for (auto c : in) {
  4659. val = (val << 8) + static_cast<uint8_t>(c);
  4660. valb += 8;
  4661. while (valb >= 0) {
  4662. out.push_back(lookup[(val >> valb) & 0x3F]);
  4663. valb -= 6;
  4664. }
  4665. }
  4666. if (valb > -6) { out.push_back(lookup[((val << 8) >> (valb + 8)) & 0x3F]); }
  4667. while (out.size() % 4) {
  4668. out.push_back('=');
  4669. }
  4670. return out;
  4671. }
  4672. inline std::string sha1(const std::string &input) {
  4673. // RFC 3174 SHA-1 implementation
  4674. auto left_rotate = [](uint32_t x, uint32_t n) -> uint32_t {
  4675. return (x << n) | (x >> (32 - n));
  4676. };
  4677. uint32_t h0 = 0x67452301;
  4678. uint32_t h1 = 0xEFCDAB89;
  4679. uint32_t h2 = 0x98BADCFE;
  4680. uint32_t h3 = 0x10325476;
  4681. uint32_t h4 = 0xC3D2E1F0;
  4682. // Pre-processing: adding padding bits
  4683. std::string msg = input;
  4684. uint64_t original_bit_len = static_cast<uint64_t>(msg.size()) * 8;
  4685. msg.push_back(static_cast<char>(0x80u));
  4686. while (msg.size() % 64 != 56) {
  4687. msg.push_back(0);
  4688. }
  4689. // Append original length in bits as 64-bit big-endian
  4690. for (int i = 56; i >= 0; i -= 8) {
  4691. msg.push_back(static_cast<char>((original_bit_len >> i) & 0xFF));
  4692. }
  4693. // Process each 512-bit chunk
  4694. for (size_t offset = 0; offset < msg.size(); offset += 64) {
  4695. uint32_t w[80];
  4696. for (size_t i = 0; i < 16; i++) {
  4697. w[i] =
  4698. (static_cast<uint32_t>(static_cast<uint8_t>(msg[offset + i * 4]))
  4699. << 24) |
  4700. (static_cast<uint32_t>(static_cast<uint8_t>(msg[offset + i * 4 + 1]))
  4701. << 16) |
  4702. (static_cast<uint32_t>(static_cast<uint8_t>(msg[offset + i * 4 + 2]))
  4703. << 8) |
  4704. (static_cast<uint32_t>(
  4705. static_cast<uint8_t>(msg[offset + i * 4 + 3])));
  4706. }
  4707. for (int i = 16; i < 80; i++) {
  4708. w[i] = left_rotate(w[i - 3] ^ w[i - 8] ^ w[i - 14] ^ w[i - 16], 1);
  4709. }
  4710. uint32_t a = h0, b = h1, c = h2, d = h3, e = h4;
  4711. for (int i = 0; i < 80; i++) {
  4712. uint32_t f, k;
  4713. if (i < 20) {
  4714. f = (b & c) | ((~b) & d);
  4715. k = 0x5A827999;
  4716. } else if (i < 40) {
  4717. f = b ^ c ^ d;
  4718. k = 0x6ED9EBA1;
  4719. } else if (i < 60) {
  4720. f = (b & c) | (b & d) | (c & d);
  4721. k = 0x8F1BBCDC;
  4722. } else {
  4723. f = b ^ c ^ d;
  4724. k = 0xCA62C1D6;
  4725. }
  4726. uint32_t temp = left_rotate(a, 5) + f + e + k + w[i];
  4727. e = d;
  4728. d = c;
  4729. c = left_rotate(b, 30);
  4730. b = a;
  4731. a = temp;
  4732. }
  4733. h0 += a;
  4734. h1 += b;
  4735. h2 += c;
  4736. h3 += d;
  4737. h4 += e;
  4738. }
  4739. // Produce the final hash as a 20-byte binary string
  4740. std::string hash(20, '\0');
  4741. for (size_t i = 0; i < 4; i++) {
  4742. hash[i] = static_cast<char>((h0 >> (24 - i * 8)) & 0xFF);
  4743. hash[4 + i] = static_cast<char>((h1 >> (24 - i * 8)) & 0xFF);
  4744. hash[8 + i] = static_cast<char>((h2 >> (24 - i * 8)) & 0xFF);
  4745. hash[12 + i] = static_cast<char>((h3 >> (24 - i * 8)) & 0xFF);
  4746. hash[16 + i] = static_cast<char>((h4 >> (24 - i * 8)) & 0xFF);
  4747. }
  4748. return hash;
  4749. }
  4750. inline std::string websocket_accept_key(const std::string &client_key) {
  4751. const std::string magic = "258EAFA5-E914-47DA-95CA-C5AB0DC85B11";
  4752. return base64_encode(sha1(client_key + magic));
  4753. }
  4754. inline bool is_websocket_upgrade(const Request &req) {
  4755. if (req.method != "GET") { return false; }
  4756. // Check Upgrade: websocket. RFC 9110 7.8 defines Upgrade as a comma-separated
  4757. // list of protocols and asks recipients to match each name
  4758. // case-insensitively, so look for the token rather than compare the whole
  4759. // field value.
  4760. if (!has_header_token(req.headers, "Upgrade", "websocket")) { return false; }
  4761. // Check Connection: Upgrade
  4762. if (!has_header_token(req.headers, "Connection", "upgrade")) { return false; }
  4763. // Check Sec-WebSocket-Key is a valid base64-encoded 16-byte value (24 chars)
  4764. // RFC 6455 Section 4.2.1
  4765. auto ws_key = req.get_header_value("Sec-WebSocket-Key");
  4766. if (ws_key.size() != 24 || ws_key[22] != '=' || ws_key[23] != '=') {
  4767. return false;
  4768. }
  4769. static const std::string b64chars =
  4770. "ABCDEFGHIJKLMNOPQRSTUVWXYZabcdefghijklmnopqrstuvwxyz0123456789+/";
  4771. for (size_t i = 0; i < 22; i++) {
  4772. if (b64chars.find(ws_key[i]) == std::string::npos) { return false; }
  4773. }
  4774. // Check Sec-WebSocket-Version: 13
  4775. auto version = req.get_header_value("Sec-WebSocket-Version");
  4776. if (version != "13") { return false; }
  4777. return true;
  4778. }
  4779. // Unpredictable bytes for masking keys (RFC 6455 Section 5.3) and nonces
  4780. inline void fill_random_bytes(unsigned char *out, size_t n) {
  4781. thread_local std::random_device rd;
  4782. size_t filled = 0;
  4783. while (filled < n) {
  4784. auto v = rd();
  4785. for (size_t b = 0; b < sizeof(v) && filled < n; ++b, ++filled) {
  4786. out[filled] = static_cast<unsigned char>((v >> (b * 8)) & 0xFFu);
  4787. }
  4788. }
  4789. }
  4790. inline bool write_websocket_frame(Stream &strm, ws::Opcode opcode,
  4791. const char *data, size_t len, bool fin,
  4792. bool mask) {
  4793. // First byte: FIN + opcode
  4794. uint8_t header[2];
  4795. header[0] = static_cast<uint8_t>((fin ? 0x80 : 0x00) |
  4796. (static_cast<uint8_t>(opcode) & 0x0F));
  4797. // Second byte: MASK + payload length
  4798. if (len < 126) {
  4799. header[1] = static_cast<uint8_t>(len);
  4800. if (mask) { header[1] |= 0x80; }
  4801. if (strm.write(reinterpret_cast<char *>(header), 2) < 0) { return false; }
  4802. } else if (len <= 0xFFFF) {
  4803. header[1] = 126;
  4804. if (mask) { header[1] |= 0x80; }
  4805. if (strm.write(reinterpret_cast<char *>(header), 2) < 0) { return false; }
  4806. uint8_t ext[2];
  4807. ext[0] = static_cast<uint8_t>((len >> 8) & 0xFF);
  4808. ext[1] = static_cast<uint8_t>(len & 0xFF);
  4809. if (strm.write(reinterpret_cast<char *>(ext), 2) < 0) { return false; }
  4810. } else {
  4811. header[1] = 127;
  4812. if (mask) { header[1] |= 0x80; }
  4813. if (strm.write(reinterpret_cast<char *>(header), 2) < 0) { return false; }
  4814. uint8_t ext[8];
  4815. for (int i = 7; i >= 0; i--) {
  4816. ext[7 - i] =
  4817. static_cast<uint8_t>((static_cast<uint64_t>(len) >> (i * 8)) & 0xFF);
  4818. }
  4819. if (strm.write(reinterpret_cast<char *>(ext), 8) < 0) { return false; }
  4820. }
  4821. if (mask) {
  4822. // Generate random mask key
  4823. uint8_t mask_key[4];
  4824. fill_random_bytes(mask_key, sizeof(mask_key));
  4825. if (strm.write(reinterpret_cast<char *>(mask_key), 4) < 0) { return false; }
  4826. // Write masked payload in chunks
  4827. const size_t chunk_size = 4096;
  4828. std::vector<char> buf((std::min)(len, chunk_size));
  4829. for (size_t offset = 0; offset < len; offset += chunk_size) {
  4830. size_t n = (std::min)(chunk_size, len - offset);
  4831. for (size_t i = 0; i < n; i++) {
  4832. buf[i] =
  4833. data[offset + i] ^ static_cast<char>(mask_key[(offset + i) % 4]);
  4834. }
  4835. if (strm.write(buf.data(), n) < 0) { return false; }
  4836. }
  4837. } else {
  4838. if (len > 0) {
  4839. if (strm.write(data, len) < 0) { return false; }
  4840. }
  4841. }
  4842. return true;
  4843. }
  4844. } // namespace detail
  4845. namespace ws {
  4846. namespace impl {
  4847. // Read exactly `size` bytes. Stream::read may return less than asked for -- it
  4848. // hands back whatever its buffer already holds -- so every multi-byte field has
  4849. // to loop. Reading a 2-byte header with a single read() fails whenever the
  4850. // header straddles the read buffer's boundary.
  4851. //
  4852. // Timeout is reported only when nothing at all was consumed. Once a byte has
  4853. // been taken the stream sits mid-field and cannot be resumed, so a timeout
  4854. // there is a failure like any other. (When read() fails it always records why,
  4855. // so the error belongs to this call and not to an earlier one.)
  4856. inline FrameRead read_exact(Stream &strm, void *buf, size_t size) {
  4857. auto p = static_cast<char *>(buf);
  4858. size_t total = 0;
  4859. while (total < size) {
  4860. auto n = strm.read(p + total, size - total);
  4861. if (n <= 0) {
  4862. auto timed_out = total == 0 && strm.get_error() == Error::Timeout;
  4863. return timed_out ? FrameRead::Timeout : FrameRead::Fail;
  4864. }
  4865. total += static_cast<size_t>(n);
  4866. }
  4867. return FrameRead::Ok;
  4868. }
  4869. inline FrameRead read_websocket_frame(Stream &strm, Opcode &opcode,
  4870. std::string &payload, bool &fin,
  4871. bool expect_masked, size_t max_len) {
  4872. // Read first 2 bytes. This is the only read that may report a timeout: it
  4873. // sits on a frame boundary, where nothing has been consumed yet.
  4874. uint8_t header[2];
  4875. FrameRead first = read_exact(strm, header, 2);
  4876. if (first != FrameRead::Ok) { return first; }
  4877. fin = (header[0] & 0x80) != 0;
  4878. // RSV1, RSV2, RSV3 must be 0 when no extension is negotiated
  4879. if (header[0] & 0x70) { return FrameRead::Fail; }
  4880. opcode = static_cast<Opcode>(header[0] & 0x0F);
  4881. bool masked = (header[1] & 0x80) != 0;
  4882. uint64_t payload_len = header[1] & 0x7F;
  4883. // RFC 6455 Section 5.5: control frames MUST NOT be fragmented and
  4884. // MUST have a payload length of 125 bytes or less
  4885. bool is_control = (static_cast<uint8_t>(opcode) & 0x08) != 0;
  4886. if (is_control) {
  4887. if (!fin) { return FrameRead::Fail; }
  4888. if (payload_len > 125) { return FrameRead::Fail; }
  4889. }
  4890. if (masked != expect_masked) { return FrameRead::Fail; }
  4891. // Extended payload length
  4892. if (payload_len == 126) {
  4893. uint8_t ext[2];
  4894. if (read_exact(strm, ext, 2) != FrameRead::Ok) { return FrameRead::Fail; }
  4895. payload_len = (static_cast<uint64_t>(ext[0]) << 8) | ext[1];
  4896. } else if (payload_len == 127) {
  4897. uint8_t ext[8];
  4898. if (read_exact(strm, ext, 8) != FrameRead::Ok) { return FrameRead::Fail; }
  4899. // RFC 6455 Section 5.2: the most significant bit MUST be 0
  4900. if (ext[0] & 0x80) { return FrameRead::Fail; }
  4901. payload_len = 0;
  4902. for (int i = 0; i < 8; i++) {
  4903. payload_len = (payload_len << 8) | ext[i];
  4904. }
  4905. }
  4906. // A max_len of 0 means no limit, as payload_max_length does, and a length
  4907. // size_t cannot hold (32-bit builds) is refused either way.
  4908. if ((max_len > 0 && payload_len > max_len) ||
  4909. !detail::fits_in_size_t(payload_len)) {
  4910. return FrameRead::Fail;
  4911. }
  4912. // Read mask key if present
  4913. uint8_t mask_key[4] = {0};
  4914. if (masked) {
  4915. if (read_exact(strm, mask_key, 4) != FrameRead::Ok) {
  4916. return FrameRead::Fail;
  4917. }
  4918. }
  4919. // Grow the payload only as it arrives, since a header alone can announce
  4920. // max_len bytes that never come.
  4921. payload.clear();
  4922. auto len = static_cast<size_t>(payload_len);
  4923. while (payload.size() < len) {
  4924. auto offset = payload.size();
  4925. auto n = (std::min)(len - offset, CPPHTTPLIB_RECV_BUFSIZ);
  4926. payload.resize(offset + n);
  4927. if (read_exact(strm, &payload[offset], n) != FrameRead::Ok) {
  4928. return FrameRead::Fail;
  4929. }
  4930. }
  4931. // Unmask if needed
  4932. if (masked) {
  4933. for (size_t i = 0; i < payload.size(); i++) {
  4934. payload[i] ^= static_cast<char>(mask_key[i % 4]);
  4935. }
  4936. }
  4937. return FrameRead::Ok;
  4938. }
  4939. // RFC 6455 §5.5.1, §7.4: a Close payload is empty, or a status code that may
  4940. // be sent followed by a UTF-8 reason.
  4941. inline bool is_valid_close_payload(const std::string &payload) {
  4942. if (payload.empty()) { return true; }
  4943. if (payload.size() < 2) { return false; }
  4944. auto code = (static_cast<uint8_t>(payload[0]) << 8) |
  4945. static_cast<uint8_t>(payload[1]);
  4946. auto may_be_sent = (1000 <= code && code <= 1003) ||
  4947. (1007 <= code && code <= 1014) ||
  4948. (3000 <= code && code <= 4999);
  4949. return may_be_sent && is_valid_utf8(payload.substr(2));
  4950. }
  4951. } // namespace impl
  4952. } // namespace ws
  4953. namespace detail {
  4954. inline bool is_valid_path(const std::string &path) {
  4955. size_t level = 0;
  4956. size_t i = 0;
  4957. // Skip slash
  4958. while (i < path.size() && path[i] == '/') {
  4959. i++;
  4960. }
  4961. while (i < path.size()) {
  4962. // Read component
  4963. auto beg = i;
  4964. while (i < path.size() && path[i] != '/') {
  4965. if (path[i] == '\0') {
  4966. return false;
  4967. } else if (path[i] == '\\') {
  4968. return false;
  4969. }
  4970. i++;
  4971. }
  4972. auto len = i - beg;
  4973. assert(len > 0);
  4974. if (!path.compare(beg, len, ".")) {
  4975. ;
  4976. } else if (!path.compare(beg, len, "..")) {
  4977. if (level == 0) { return false; }
  4978. level--;
  4979. } else {
  4980. level++;
  4981. }
  4982. // Skip slash
  4983. while (i < path.size() && path[i] == '/') {
  4984. i++;
  4985. }
  4986. }
  4987. return true;
  4988. }
  4989. inline bool canonicalize_path(const char *path, std::string &resolved) {
  4990. #if defined(_WIN32)
  4991. char buf[_MAX_PATH];
  4992. if (_fullpath(buf, path, _MAX_PATH) == nullptr) { return false; }
  4993. resolved = buf;
  4994. #elif defined(PATH_MAX)
  4995. char buf[PATH_MAX];
  4996. if (realpath(path, buf) == nullptr) { return false; }
  4997. resolved = buf;
  4998. #else
  4999. auto buf = realpath(path, nullptr);
  5000. auto guard = scope_exit([&]() { std::free(buf); });
  5001. if (buf == nullptr) { return false; }
  5002. resolved = buf;
  5003. #endif
  5004. return true;
  5005. }
  5006. inline bool is_path_within_base(const std::string &resolved_path,
  5007. const std::string &resolved_base) {
  5008. #if defined(_WIN32)
  5009. return _strnicmp(resolved_path.c_str(), resolved_base.c_str(),
  5010. resolved_base.size()) == 0;
  5011. #else
  5012. return strncmp(resolved_path.c_str(), resolved_base.c_str(),
  5013. resolved_base.size()) == 0;
  5014. #endif
  5015. }
  5016. inline FileStat::FileStat(const std::string &path) {
  5017. #if defined(_WIN32)
  5018. auto wpath = u8string_to_wstring(path.c_str());
  5019. ret_ = _wstat(wpath.c_str(), &st_);
  5020. #else
  5021. ret_ = stat(path.c_str(), &st_);
  5022. #endif
  5023. }
  5024. inline bool FileStat::is_file() const {
  5025. return ret_ >= 0 && S_ISREG(st_.st_mode);
  5026. }
  5027. inline bool FileStat::is_dir() const {
  5028. return ret_ >= 0 && S_ISDIR(st_.st_mode);
  5029. }
  5030. inline time_t FileStat::mtime() const {
  5031. return ret_ >= 0 ? static_cast<time_t>(st_.st_mtime)
  5032. : static_cast<time_t>(-1);
  5033. }
  5034. inline size_t FileStat::size() const {
  5035. return ret_ >= 0 ? static_cast<size_t>(st_.st_size) : 0;
  5036. }
  5037. inline std::string encode_path(const std::string &s) {
  5038. std::string result;
  5039. result.reserve(s.size());
  5040. for (size_t i = 0; s[i]; i++) {
  5041. switch (s[i]) {
  5042. case ' ': result += "%20"; break;
  5043. case '+': result += "%2B"; break;
  5044. case '\'': result += "%27"; break;
  5045. case ',': result += "%2C"; break;
  5046. // case ':': result += "%3A"; break; // ok? probably...
  5047. case ';': result += "%3B"; break;
  5048. default:
  5049. auto c = static_cast<uint8_t>(s[i]);
  5050. // Control characters (incl. CR/LF) and non-ASCII bytes are not allowed
  5051. // in a request-target as-is.
  5052. if (c < 0x20 || c == 0x7f || c >= 0x80) {
  5053. result += '%';
  5054. char hex[4];
  5055. auto len = snprintf(hex, sizeof(hex) - 1, "%02X", c);
  5056. assert(len == 2);
  5057. result.append(hex, static_cast<size_t>(len));
  5058. } else {
  5059. result += s[i];
  5060. }
  5061. break;
  5062. }
  5063. }
  5064. return result;
  5065. }
  5066. inline std::string file_extension(const std::string &path) {
  5067. auto i = path.size();
  5068. while (i > 0 && is_ascii_alnum(path[i - 1])) {
  5069. i--;
  5070. }
  5071. if (i == path.size() || i == 0 || path[i - 1] != '.') {
  5072. return std::string();
  5073. }
  5074. return path.substr(i);
  5075. }
  5076. inline bool is_space_or_tab(char c) { return c == ' ' || c == '\t'; }
  5077. template <typename T>
  5078. inline bool parse_header(const char *beg, const char *end, T fn);
  5079. template <typename T>
  5080. inline bool parse_header(const char *beg, const char *end, T fn) {
  5081. // Skip trailing spaces and tabs.
  5082. while (beg < end && is_space_or_tab(end[-1])) {
  5083. end--;
  5084. }
  5085. auto p = beg;
  5086. while (p < end && *p != ':') {
  5087. p++;
  5088. }
  5089. auto name = std::string(beg, p);
  5090. if (!detail::fields::is_field_name(name)) { return false; }
  5091. if (p == end) { return false; }
  5092. auto key_end = p;
  5093. if (*p++ != ':') { return false; }
  5094. while (p < end && is_space_or_tab(*p)) {
  5095. p++;
  5096. }
  5097. if (p <= end) {
  5098. auto key_len = key_end - beg;
  5099. if (!key_len) { return false; }
  5100. auto key = std::string(beg, key_end);
  5101. auto val = std::string(p, end);
  5102. if (!detail::fields::is_field_value(val)) { return false; }
  5103. // RFC 9110 §5.5: header field values are opaque octets and MUST NOT be
  5104. // percent-decoded by the recipient. Applications that need to interpret a
  5105. // value as a URI component should call httplib::decode_uri_component()
  5106. // (or decode_path_component()) explicitly.
  5107. fn(key, val);
  5108. return true;
  5109. }
  5110. return false;
  5111. }
  5112. inline bool parse_trailers(stream_line_reader &line_reader, Headers &dest,
  5113. const Headers &src_headers) {
  5114. // NOTE: In RFC 9112, '7.1 Chunked Transfer Coding' mentions "The chunked
  5115. // transfer coding is complete when a chunk with a chunk-size of zero is
  5116. // received, possibly followed by a trailer section, and finally terminated by
  5117. // an empty line". https://www.rfc-editor.org/rfc/rfc9112.html#section-7.1
  5118. //
  5119. // In '7.1.3. Decoding Chunked', however, the pseudo-code in the section
  5120. // doesn't care for the existence of the final CRLF. In other words, it seems
  5121. // to be ok whether the final CRLF exists or not in the chunked data.
  5122. // https://www.rfc-editor.org/rfc/rfc9112.html#section-7.1.3
  5123. //
  5124. // According to the reference code in RFC 9112, cpp-httplib now allows
  5125. // chunked transfer coding data without the final CRLF.
  5126. // RFC 7230 Section 4.1.2 - Headers prohibited in trailers
  5127. thread_local case_ignore::unordered_set<std::string> prohibited_trailers = {
  5128. "transfer-encoding",
  5129. "content-length",
  5130. "host",
  5131. "authorization",
  5132. "www-authenticate",
  5133. "proxy-authenticate",
  5134. "proxy-authorization",
  5135. "cookie",
  5136. "set-cookie",
  5137. "cache-control",
  5138. "expect",
  5139. "max-forwards",
  5140. "pragma",
  5141. "range",
  5142. "te",
  5143. "age",
  5144. "expires",
  5145. "date",
  5146. "location",
  5147. "retry-after",
  5148. "vary",
  5149. "warning",
  5150. "content-encoding",
  5151. "content-type",
  5152. "content-range",
  5153. "trailer"};
  5154. case_ignore::unordered_set<std::string> declared_trailers;
  5155. auto trailer_header = get_combined_header_value(src_headers, "Trailer");
  5156. if (!trailer_header.empty()) {
  5157. // split() trims each token and skips empty ones, so the name arrives ready
  5158. // to look up.
  5159. split(trailer_header.data(), trailer_header.data() + trailer_header.size(),
  5160. ',', [&](const char *b, const char *e) {
  5161. // A legitimate message declares only a handful of trailers. Cap the
  5162. // set so a peer cannot grow it without bound: an oversized set only
  5163. // arises from an attempt to force many colliding names into
  5164. // quadratic lookups (case_ignore::hash is unkeyed).
  5165. if (declared_trailers.size() >= CPPHTTPLIB_HEADER_MAX_COUNT) {
  5166. return;
  5167. }
  5168. std::string key(b, e);
  5169. if (prohibited_trailers.find(key) == prohibited_trailers.end()) {
  5170. declared_trailers.insert(key);
  5171. }
  5172. });
  5173. }
  5174. size_t trailer_header_count = 0;
  5175. while (strcmp(line_reader.ptr(), "\r\n") != 0) {
  5176. if (line_reader.size() > CPPHTTPLIB_HEADER_MAX_LENGTH) { return false; }
  5177. // Count every received trailer field, not only the declared ones stored in
  5178. // dest, so undeclared fields cannot keep this loop running past the limit.
  5179. if (trailer_header_count >= CPPHTTPLIB_HEADER_MAX_COUNT) { return false; }
  5180. constexpr auto line_terminator_len = 2;
  5181. auto line_beg = line_reader.ptr();
  5182. auto line_end =
  5183. line_reader.ptr() + line_reader.size() - line_terminator_len;
  5184. if (!parse_header(line_beg, line_end,
  5185. [&](const std::string &key, const std::string &val) {
  5186. if (declared_trailers.find(key) !=
  5187. declared_trailers.end()) {
  5188. dest.emplace(key, val);
  5189. }
  5190. })) {
  5191. return false;
  5192. }
  5193. trailer_header_count++;
  5194. if (!line_reader.getline()) { return false; }
  5195. }
  5196. return true;
  5197. }
  5198. inline std::pair<size_t, size_t> trim(const char *b, const char *e, size_t left,
  5199. size_t right) {
  5200. while (b + left < e && is_space_or_tab(b[left])) {
  5201. left++;
  5202. }
  5203. while (right > 0 && is_space_or_tab(b[right - 1])) {
  5204. right--;
  5205. }
  5206. return std::make_pair(left, right);
  5207. }
  5208. inline std::string trim_copy(const std::string &s) {
  5209. auto r = trim(s.data(), s.data() + s.size(), 0, s.size());
  5210. return s.substr(r.first, r.second - r.first);
  5211. }
  5212. inline std::string trim_double_quotes_copy(const std::string &s) {
  5213. if (s.length() >= 2 && s.front() == '"' && s.back() == '"') {
  5214. return s.substr(1, s.size() - 2);
  5215. }
  5216. return s;
  5217. }
  5218. // Takes the quotes off a parameter value. Only \" and \\ are quoted-pairs
  5219. // here, as browsers send any other backslash, such as one in a Windows path,
  5220. // as it is.
  5221. inline std::string unquote_param(const std::string &s) {
  5222. if (s.size() < 2 || s.front() != '"' || s.back() != '"') { return s; }
  5223. std::string out;
  5224. for (size_t i = 1; i + 1 < s.size(); i++) {
  5225. if (s[i] == '\\' && i + 2 < s.size() &&
  5226. (s[i + 1] == '"' || s[i + 1] == '\\')) {
  5227. i++;
  5228. }
  5229. out += s[i];
  5230. }
  5231. return out;
  5232. }
  5233. inline void
  5234. divide(const char *data, std::size_t size, char d,
  5235. std::function<void(const char *, std::size_t, const char *, std::size_t)>
  5236. fn) {
  5237. const auto it = std::find(data, data + size, d);
  5238. const auto found = static_cast<std::size_t>(it != data + size);
  5239. const auto lhs_data = data;
  5240. const auto lhs_size = static_cast<std::size_t>(it - data);
  5241. const auto rhs_data = it + found;
  5242. const auto rhs_size = size - lhs_size - found;
  5243. fn(lhs_data, lhs_size, rhs_data, rhs_size);
  5244. }
  5245. inline void
  5246. divide(const std::string &str, char d,
  5247. std::function<void(const char *, std::size_t, const char *, std::size_t)>
  5248. fn) {
  5249. divide(str.data(), str.size(), d, std::move(fn));
  5250. }
  5251. inline void split(const char *b, const char *e, char d,
  5252. std::function<void(const char *, const char *)> fn) {
  5253. return split(b, e, d, (std::numeric_limits<size_t>::max)(), std::move(fn));
  5254. }
  5255. inline void split(const char *b, const char *e, char d, size_t m,
  5256. std::function<void(const char *, const char *)> fn) {
  5257. size_t i = 0;
  5258. size_t beg = 0;
  5259. size_t count = 1;
  5260. while (e ? (b + i < e) : (b[i] != '\0')) {
  5261. if (b[i] == d && count < m) {
  5262. auto r = trim(b, e, beg, i);
  5263. if (r.first < r.second) { fn(&b[r.first], &b[r.second]); }
  5264. beg = i + 1;
  5265. count++;
  5266. }
  5267. i++;
  5268. }
  5269. if (i) {
  5270. auto r = trim(b, e, beg, i);
  5271. if (r.first < r.second) { fn(&b[r.first], &b[r.second]); }
  5272. }
  5273. }
  5274. // Same contract as split(), except that a delimiter inside a quoted-string is
  5275. // not a delimiter. RFC 9110 Section 5.6.6 lets a parameter value be a
  5276. // quoted-string, and ';' and '=' are legal characters inside one.
  5277. inline void split_unquoted(const char *b, const char *e, char d, size_t m,
  5278. std::function<void(const char *, const char *)> fn) {
  5279. size_t i = 0;
  5280. size_t beg = 0;
  5281. size_t count = 1;
  5282. auto in_quotes = false;
  5283. auto has = [&](size_t j) { return e ? (b + j < e) : (b[j] != '\0'); };
  5284. while (has(i)) {
  5285. if (in_quotes && b[i] == '\\' && has(i + 1)) {
  5286. // A quoted-pair, whose second character does not end the string.
  5287. i++;
  5288. } else if (b[i] == '"') {
  5289. in_quotes = !in_quotes;
  5290. } else if (b[i] == d && !in_quotes && count < m) {
  5291. auto r = trim(b, e, beg, i);
  5292. if (r.first < r.second) { fn(&b[r.first], &b[r.second]); }
  5293. beg = i + 1;
  5294. count++;
  5295. }
  5296. i++;
  5297. }
  5298. if (i) {
  5299. auto r = trim(b, e, beg, i);
  5300. if (r.first < r.second) { fn(&b[r.first], &b[r.second]); }
  5301. }
  5302. }
  5303. inline void split_unquoted(const char *b, const char *e, char d,
  5304. std::function<void(const char *, const char *)> fn) {
  5305. return split_unquoted(b, e, d, (std::numeric_limits<size_t>::max)(),
  5306. std::move(fn));
  5307. }
  5308. // Divide a header parameter at its first '='. RFC 9110 Section 5.6.6 makes the
  5309. // key a token, so the first '=' is the separator even when the value is a
  5310. // quoted-string carrying more of them.
  5311. inline void divide_param_pair(const char *b, const char *e, std::string &key,
  5312. std::string &val) {
  5313. divide(
  5314. b, static_cast<std::size_t>(e - b), '=',
  5315. [&](const char *kb, std::size_t klen, const char *vb, std::size_t vlen) {
  5316. const auto kr = trim(kb, kb + klen, 0, klen);
  5317. key.assign(kb + kr.first, kb + kr.second);
  5318. const auto vr = trim(vb, vb + vlen, 0, vlen);
  5319. val.assign(vb + vr.first, vb + vr.second);
  5320. });
  5321. }
  5322. inline bool split_find(const char *b, const char *e, char d, size_t m,
  5323. std::function<bool(const char *, const char *)> fn) {
  5324. size_t i = 0;
  5325. size_t beg = 0;
  5326. size_t count = 1;
  5327. while (e ? (b + i < e) : (b[i] != '\0')) {
  5328. if (b[i] == d && count < m) {
  5329. auto r = trim(b, e, beg, i);
  5330. if (r.first < r.second) {
  5331. auto found = fn(&b[r.first], &b[r.second]);
  5332. if (found) { return true; }
  5333. }
  5334. beg = i + 1;
  5335. count++;
  5336. }
  5337. i++;
  5338. }
  5339. if (i) {
  5340. auto r = trim(b, e, beg, i);
  5341. if (r.first < r.second) {
  5342. auto found = fn(&b[r.first], &b[r.second]);
  5343. if (found) { return true; }
  5344. }
  5345. }
  5346. return false;
  5347. }
  5348. inline bool split_find(const char *b, const char *e, char d,
  5349. std::function<bool(const char *, const char *)> fn) {
  5350. return split_find(b, e, d, (std::numeric_limits<size_t>::max)(),
  5351. std::move(fn));
  5352. }
  5353. inline stream_line_reader::stream_line_reader(Stream &strm, char *fixed_buffer,
  5354. size_t fixed_buffer_size)
  5355. : strm_(strm), fixed_buffer_(fixed_buffer),
  5356. fixed_buffer_size_(fixed_buffer_size) {}
  5357. inline const char *stream_line_reader::ptr() const {
  5358. if (growable_buffer_.empty()) {
  5359. return fixed_buffer_;
  5360. } else {
  5361. return growable_buffer_.data();
  5362. }
  5363. }
  5364. inline size_t stream_line_reader::size() const {
  5365. if (growable_buffer_.empty()) {
  5366. return fixed_buffer_used_size_;
  5367. } else {
  5368. return growable_buffer_.size();
  5369. }
  5370. }
  5371. inline bool stream_line_reader::end_with_crlf() const {
  5372. auto end = ptr() + size();
  5373. return size() >= 2 && end[-2] == '\r' && end[-1] == '\n';
  5374. }
  5375. inline bool stream_line_reader::getline() {
  5376. fixed_buffer_used_size_ = 0;
  5377. growable_buffer_.clear();
  5378. #ifndef CPPHTTPLIB_ALLOW_LF_AS_LINE_TERMINATOR
  5379. char prev_byte = 0;
  5380. #endif
  5381. for (size_t i = 0;; i++) {
  5382. // Fast path: whatever the stream has already buffered can be scanned for
  5383. // the terminator in one pass. Asking for a byte at a time costs a virtual
  5384. // call, a bounds check and a one-byte copy per character of the request.
  5385. size_t buffered_size = 0;
  5386. if (auto buffered = strm_.buffered_data(buffered_size)) {
  5387. auto take = buffered_size;
  5388. auto terminated = false;
  5389. for (size_t at = 0; at < buffered_size;) {
  5390. auto nl = static_cast<const char *>(
  5391. memchr(buffered + at, '\n', buffered_size - at));
  5392. if (!nl) { break; }
  5393. auto pos = static_cast<size_t>(nl - buffered);
  5394. #ifdef CPPHTTPLIB_ALLOW_LF_AS_LINE_TERMINATOR
  5395. take = pos + 1;
  5396. terminated = true;
  5397. break;
  5398. #else
  5399. // A bare LF does not end the line; keep looking for CRLF. The CR may
  5400. // be the last byte of an earlier chunk, hence prev_byte.
  5401. if ((pos > 0 ? buffered[pos - 1] : prev_byte) == '\r') {
  5402. take = pos + 1;
  5403. terminated = true;
  5404. break;
  5405. }
  5406. at = pos + 1;
  5407. #endif
  5408. }
  5409. if (size() + take > CPPHTTPLIB_MAX_LINE_LENGTH) { return false; }
  5410. #ifndef CPPHTTPLIB_ALLOW_LF_AS_LINE_TERMINATOR
  5411. prev_byte = buffered[take - 1];
  5412. #endif
  5413. append(buffered, take);
  5414. strm_.consume_buffered(take);
  5415. i += take;
  5416. if (terminated) { return true; }
  5417. continue;
  5418. }
  5419. if (size() >= CPPHTTPLIB_MAX_LINE_LENGTH) {
  5420. // Treat exceptionally long lines as an error to
  5421. // prevent infinite loops/memory exhaustion
  5422. return false;
  5423. }
  5424. char byte;
  5425. auto n = strm_.read(&byte, 1);
  5426. if (n < 0) {
  5427. return false;
  5428. } else if (n == 0) {
  5429. if (i == 0) {
  5430. return false;
  5431. } else {
  5432. break;
  5433. }
  5434. }
  5435. append(byte);
  5436. #ifdef CPPHTTPLIB_ALLOW_LF_AS_LINE_TERMINATOR
  5437. if (byte == '\n') { break; }
  5438. #else
  5439. if (prev_byte == '\r' && byte == '\n') { break; }
  5440. prev_byte = byte;
  5441. #endif
  5442. }
  5443. return true;
  5444. }
  5445. inline void stream_line_reader::append(char c) { append(&c, 1); }
  5446. inline void stream_line_reader::append(const char *data, size_t size) {
  5447. // Once the line has outgrown the fixed buffer everything must keep going to
  5448. // the growable one, even if a later chunk would have fit. Without the
  5449. // emptiness check a short append after a long one would land in the fixed
  5450. // buffer, which ptr() and size() no longer look at, and be lost.
  5451. if (growable_buffer_.empty() &&
  5452. fixed_buffer_used_size_ + size < fixed_buffer_size_) {
  5453. memcpy(fixed_buffer_ + fixed_buffer_used_size_, data, size);
  5454. fixed_buffer_used_size_ += size;
  5455. fixed_buffer_[fixed_buffer_used_size_] = '\0';
  5456. } else {
  5457. // Unlike the per-character overload, this can be the very first append of
  5458. // the line, so the fixed buffer may hold nothing and carry no terminator
  5459. // yet. assign() takes an explicit length and does not need one.
  5460. if (growable_buffer_.empty()) {
  5461. growable_buffer_.assign(fixed_buffer_, fixed_buffer_used_size_);
  5462. }
  5463. growable_buffer_.append(data, size);
  5464. }
  5465. }
  5466. inline mmap::mmap(const char *path) { open(path); }
  5467. inline mmap::~mmap() { close(); }
  5468. inline bool mmap::open(const char *path) {
  5469. close();
  5470. #if defined(_WIN32)
  5471. auto wpath = u8string_to_wstring(path);
  5472. if (wpath.empty()) { return false; }
  5473. hFile_ =
  5474. ::CreateFile2(wpath.c_str(), GENERIC_READ,
  5475. FILE_SHARE_READ | FILE_SHARE_WRITE, OPEN_EXISTING, NULL);
  5476. if (hFile_ == INVALID_HANDLE_VALUE) { return false; }
  5477. LARGE_INTEGER size{};
  5478. if (!::GetFileSizeEx(hFile_, &size)) { return false; }
  5479. // If the following line doesn't compile due to QuadPart, update Windows SDK.
  5480. // See:
  5481. // https://github.com/yhirose/cpp-httplib/issues/1903#issuecomment-2316520721
  5482. if (!fits_in_size_t(static_cast<uint64_t>(size.QuadPart))) { return false; }
  5483. size_ = static_cast<size_t>(size.QuadPart);
  5484. hMapping_ =
  5485. ::CreateFileMappingFromApp(hFile_, NULL, PAGE_READONLY, size_, NULL);
  5486. // Special treatment for an empty file...
  5487. if (hMapping_ == NULL && size_ == 0) {
  5488. close();
  5489. is_open_empty_file = true;
  5490. return true;
  5491. }
  5492. if (hMapping_ == NULL) {
  5493. close();
  5494. return false;
  5495. }
  5496. addr_ = ::MapViewOfFileFromApp(hMapping_, FILE_MAP_READ, 0, 0);
  5497. if (addr_ == nullptr) {
  5498. close();
  5499. return false;
  5500. }
  5501. #else
  5502. // O_NONBLOCK so that opening a FIFO does not wait for a writer.
  5503. fd_ = ::open(path, O_RDONLY | O_NONBLOCK | O_CLOEXEC);
  5504. if (fd_ == -1) { return false; }
  5505. // Only a regular file has a size to serve, unlike a directory or a device.
  5506. struct stat sb;
  5507. if (fstat(fd_, &sb) == -1 || !S_ISREG(sb.st_mode) ||
  5508. !fits_in_size_t(static_cast<uint64_t>(sb.st_size))) {
  5509. close();
  5510. return false;
  5511. }
  5512. size_ = static_cast<size_t>(sb.st_size);
  5513. #endif
  5514. return true;
  5515. }
  5516. inline bool mmap::is_open() const {
  5517. #if defined(_WIN32)
  5518. return is_open_empty_file ? true : addr_ != nullptr;
  5519. #else
  5520. return fd_ != -1;
  5521. #endif
  5522. }
  5523. inline size_t mmap::size() const { return size_; }
  5524. inline void mmap::close() {
  5525. #if defined(_WIN32)
  5526. if (addr_) {
  5527. ::UnmapViewOfFile(addr_);
  5528. addr_ = nullptr;
  5529. }
  5530. if (hMapping_) {
  5531. ::CloseHandle(hMapping_);
  5532. hMapping_ = NULL;
  5533. }
  5534. if (hFile_ != INVALID_HANDLE_VALUE) {
  5535. ::CloseHandle(hFile_);
  5536. hFile_ = INVALID_HANDLE_VALUE;
  5537. }
  5538. is_open_empty_file = false;
  5539. #else
  5540. if (fd_ != -1) {
  5541. ::close(fd_);
  5542. fd_ = -1;
  5543. }
  5544. #endif
  5545. size_ = 0;
  5546. }
  5547. inline int close_socket(socket_t sock) noexcept {
  5548. #ifdef _WIN32
  5549. return closesocket(sock);
  5550. #else
  5551. return close(sock);
  5552. #endif
  5553. }
  5554. template <typename T> inline ssize_t handle_EINTR(T fn) {
  5555. ssize_t res = 0;
  5556. while (true) {
  5557. res = fn();
  5558. if (res < 0 && errno == EINTR) {
  5559. std::this_thread::sleep_for(std::chrono::microseconds{1});
  5560. continue;
  5561. }
  5562. break;
  5563. }
  5564. return res;
  5565. }
  5566. inline size_t mmap::read(size_t offset, char *buf, size_t len) const {
  5567. if (offset >= size_) { return 0; }
  5568. len = (std::min)(len, size_ - offset);
  5569. #if defined(_WIN32)
  5570. // Windows does not let a mapped file be truncated.
  5571. std::memcpy(buf, static_cast<const char *>(addr_) + offset, len);
  5572. return len;
  5573. #else
  5574. auto n = handle_EINTR(
  5575. [&]() { return ::pread(fd_, buf, len, static_cast<off_t>(offset)); });
  5576. return n > 0 ? static_cast<size_t>(n) : 0;
  5577. #endif
  5578. }
  5579. inline ssize_t read_socket(socket_t sock, void *ptr, size_t size, int flags) {
  5580. return handle_EINTR([&]() {
  5581. return recv(sock,
  5582. #ifdef _WIN32
  5583. static_cast<char *>(ptr), static_cast<int>(size),
  5584. #else
  5585. ptr, size,
  5586. #endif
  5587. flags);
  5588. });
  5589. }
  5590. inline ssize_t send_socket(socket_t sock, const void *ptr, size_t size,
  5591. int flags) {
  5592. return handle_EINTR([&]() {
  5593. return send(sock,
  5594. #ifdef _WIN32
  5595. static_cast<const char *>(ptr), static_cast<int>(size),
  5596. #else
  5597. ptr, size,
  5598. #endif
  5599. flags);
  5600. });
  5601. }
  5602. inline int poll_wrapper(struct pollfd *fds, nfds_t nfds, int timeout) {
  5603. #ifdef _WIN32
  5604. return ::WSAPoll(fds, nfds, timeout);
  5605. #else
  5606. return ::poll(fds, nfds, timeout);
  5607. #endif
  5608. }
  5609. inline ssize_t select_impl(socket_t sock, short events, time_t sec,
  5610. time_t usec) {
  5611. struct pollfd pfd;
  5612. pfd.fd = sock;
  5613. pfd.events = events;
  5614. pfd.revents = 0;
  5615. // A negative timeout waits forever, poll's own convention. 0 keeps meaning
  5616. // "return immediately", which callers here rely on to probe a socket.
  5617. auto timeout = sec < 0 ? -1 : static_cast<int>(sec * 1000 + usec / 1000);
  5618. return handle_EINTR([&]() { return poll_wrapper(&pfd, 1, timeout); });
  5619. }
  5620. inline ssize_t select_read(socket_t sock, time_t sec, time_t usec) {
  5621. return select_impl(sock, POLLIN, sec, usec);
  5622. }
  5623. inline ssize_t select_write(socket_t sock, time_t sec, time_t usec) {
  5624. return select_impl(sock, POLLOUT, sec, usec);
  5625. }
  5626. // The point sec and usec from now, for select_until(). A negative sec never
  5627. // comes, as a negative timeout waits forever in select_impl().
  5628. inline std::chrono::steady_clock::time_point deadline_after(time_t sec,
  5629. time_t usec) {
  5630. if (sec < 0) { return (std::chrono::steady_clock::time_point::max)(); }
  5631. return std::chrono::steady_clock::now() + std::chrono::seconds(sec) +
  5632. std::chrono::microseconds(usec);
  5633. }
  5634. // Waits only for the time left until deadline, so that all the waits of one
  5635. // TLS handshake come out of a single timeout.
  5636. inline ssize_t select_until(socket_t sock, short events,
  5637. std::chrono::steady_clock::time_point deadline) {
  5638. if (deadline == (std::chrono::steady_clock::time_point::max)()) {
  5639. return select_impl(sock, events, -1, 0);
  5640. }
  5641. auto left = std::chrono::duration_cast<std::chrono::microseconds>(
  5642. deadline - std::chrono::steady_clock::now())
  5643. .count();
  5644. if (left <= 0) { return 0; }
  5645. return select_impl(sock, events, static_cast<time_t>(left / 1000000),
  5646. static_cast<time_t>(left % 1000000));
  5647. }
  5648. inline Error wait_until_socket_is_ready(socket_t sock, time_t sec,
  5649. time_t usec) {
  5650. struct pollfd pfd_read;
  5651. pfd_read.fd = sock;
  5652. pfd_read.events = POLLIN | POLLOUT;
  5653. pfd_read.revents = 0;
  5654. auto timeout = static_cast<int>(sec * 1000 + usec / 1000);
  5655. auto poll_res =
  5656. handle_EINTR([&]() { return poll_wrapper(&pfd_read, 1, timeout); });
  5657. if (poll_res == 0) { return Error::ConnectionTimeout; }
  5658. if (poll_res > 0 && pfd_read.revents & (POLLIN | POLLOUT)) {
  5659. auto error = 0;
  5660. socklen_t len = sizeof(error);
  5661. auto res = getsockopt(sock, SOL_SOCKET, SO_ERROR,
  5662. reinterpret_cast<char *>(&error), &len);
  5663. auto successful = res >= 0 && !error;
  5664. return successful ? Error::Success : Error::Connection;
  5665. }
  5666. return Error::Connection;
  5667. }
  5668. inline bool is_socket_alive(socket_t sock) {
  5669. const auto val = detail::select_read(sock, 0, 0);
  5670. if (val == 0) {
  5671. return true;
  5672. } else if (val < 0 && errno == EBADF) {
  5673. return false;
  5674. }
  5675. char buf[1];
  5676. return detail::read_socket(sock, &buf[0], sizeof(buf), MSG_PEEK) > 0;
  5677. }
  5678. class SocketStream final : public Stream {
  5679. public:
  5680. SocketStream(socket_t sock, time_t read_timeout_sec, time_t read_timeout_usec,
  5681. time_t write_timeout_sec, time_t write_timeout_usec,
  5682. time_t max_timeout_msec = 0,
  5683. std::chrono::time_point<std::chrono::steady_clock> start_time =
  5684. (std::chrono::steady_clock::time_point::min)());
  5685. ~SocketStream() override;
  5686. bool is_readable() const override;
  5687. bool wait_readable() const override;
  5688. bool wait_writable() const override;
  5689. bool is_peer_alive() const override;
  5690. ssize_t read(char *ptr, size_t size) override;
  5691. ssize_t write(const char *ptr, size_t size) override;
  5692. void get_remote_ip_and_port(std::string &ip, int &port) const override;
  5693. void get_local_ip_and_port(std::string &ip, int &port) const override;
  5694. socket_t socket() const override;
  5695. time_t duration() const override;
  5696. void set_read_timeout(time_t sec, time_t usec = 0) override;
  5697. void set_max_timeout(time_t msec) override;
  5698. const char *buffered_data(size_t &size) const override;
  5699. void consume_buffered(size_t size) override;
  5700. // The caller has just seen this socket become readable. Lets the next read
  5701. // skip its own readiness wait, which would otherwise ask the kernel a
  5702. // question that was answered a moment ago. Consumed by that read.
  5703. void set_readable_hint() { readable_hint_ = true; }
  5704. private:
  5705. bool ensure_readable();
  5706. socket_t sock_;
  5707. // Atomic because ws::WebSocket::set_read_timeout() reaches this from another
  5708. // thread while a read is in flight -- that is the point of it, for a caller
  5709. // holding one connection and wanting control back to send on it.
  5710. std::atomic<time_t> read_timeout_sec_;
  5711. std::atomic<time_t> read_timeout_usec_;
  5712. time_t write_timeout_sec_;
  5713. time_t write_timeout_usec_;
  5714. time_t max_timeout_msec_;
  5715. std::chrono::time_point<std::chrono::steady_clock> start_time_;
  5716. std::vector<char> read_buff_;
  5717. size_t read_buff_off_ = 0;
  5718. size_t read_buff_content_size_ = 0;
  5719. bool readable_hint_ = false;
  5720. static const size_t read_buff_size_ = 1024l * 4;
  5721. };
  5722. inline bool keep_alive(const std::atomic<socket_t> &svr_sock, socket_t sock,
  5723. time_t keep_alive_timeout_sec) {
  5724. using namespace std::chrono;
  5725. const auto interval_usec =
  5726. CPPHTTPLIB_KEEPALIVE_TIMEOUT_CHECK_INTERVAL_USECOND;
  5727. // Avoid expensive `steady_clock::now()` call for the first time
  5728. if (select_read(sock, 0, interval_usec) > 0) { return true; }
  5729. const auto start = steady_clock::now() - microseconds{interval_usec};
  5730. const auto timeout = seconds{keep_alive_timeout_sec};
  5731. while (true) {
  5732. if (svr_sock == INVALID_SOCKET) {
  5733. break; // Server socket is closed
  5734. }
  5735. auto val = select_read(sock, 0, interval_usec);
  5736. if (val < 0) {
  5737. break; // Ssocket error
  5738. } else if (val == 0) {
  5739. if (steady_clock::now() - start > timeout) {
  5740. break; // Timeout
  5741. }
  5742. } else {
  5743. return true; // Ready for read
  5744. }
  5745. }
  5746. return false;
  5747. }
  5748. // `has_buffered_request` reports whether the connection's stream already holds
  5749. // bytes of the next request. A client may pipeline its requests (RFC 9112
  5750. // 9.3.2), so reading one request can pull the start of the next one into the
  5751. // stream's buffer; that request must be served without waiting for the socket
  5752. // to become readable again, since its bytes are no longer on the socket.
  5753. // `callback` is told whether keep_alive() has just seen the socket go readable.
  5754. template <typename P, typename T>
  5755. inline bool process_server_socket_core(const std::atomic<socket_t> &svr_sock,
  5756. socket_t sock,
  5757. size_t keep_alive_max_count,
  5758. time_t keep_alive_timeout_sec,
  5759. P has_buffered_request, T callback) {
  5760. auto ret = false;
  5761. // A keep_alive_max_count of 0 sets no limit.
  5762. for (size_t served = 0;
  5763. keep_alive_max_count == 0 || served < keep_alive_max_count; served++) {
  5764. auto socket_readable = false;
  5765. if (!has_buffered_request()) {
  5766. if (!keep_alive(svr_sock, sock, keep_alive_timeout_sec)) { break; }
  5767. socket_readable = true;
  5768. }
  5769. auto close_connection = served + 1 == keep_alive_max_count;
  5770. auto connection_closed = false;
  5771. ret = callback(socket_readable, close_connection, connection_closed);
  5772. if (!ret || connection_closed) { break; }
  5773. }
  5774. return ret;
  5775. }
  5776. template <typename T>
  5777. inline bool
  5778. process_server_socket(const std::atomic<socket_t> &svr_sock, socket_t sock,
  5779. size_t keep_alive_max_count,
  5780. time_t keep_alive_timeout_sec, time_t read_timeout_sec,
  5781. time_t read_timeout_usec, time_t write_timeout_sec,
  5782. time_t write_timeout_usec, T callback) {
  5783. // One stream per connection: its read buffer can already hold the start of
  5784. // the next, pipelined request.
  5785. SocketStream strm(sock, read_timeout_sec, read_timeout_usec,
  5786. write_timeout_sec, write_timeout_usec);
  5787. return process_server_socket_core(
  5788. svr_sock, sock, keep_alive_max_count, keep_alive_timeout_sec,
  5789. [&]() { return strm.is_readable(); },
  5790. [&](bool socket_readable, bool close_connection,
  5791. bool &connection_closed) {
  5792. if (socket_readable) { strm.set_readable_hint(); }
  5793. return callback(strm, close_connection, connection_closed);
  5794. });
  5795. }
  5796. inline bool process_client_socket(
  5797. socket_t sock, time_t read_timeout_sec, time_t read_timeout_usec,
  5798. time_t write_timeout_sec, time_t write_timeout_usec,
  5799. time_t max_timeout_msec,
  5800. std::chrono::time_point<std::chrono::steady_clock> start_time,
  5801. std::function<bool(Stream &)> callback) {
  5802. SocketStream strm(sock, read_timeout_sec, read_timeout_usec,
  5803. write_timeout_sec, write_timeout_usec, max_timeout_msec,
  5804. start_time);
  5805. return callback(strm);
  5806. }
  5807. inline int shutdown_socket(socket_t sock) noexcept {
  5808. #ifdef _WIN32
  5809. return shutdown(sock, SD_BOTH);
  5810. #else
  5811. return shutdown(sock, SHUT_RDWR);
  5812. #endif
  5813. }
  5814. // Half-closes the write side and drains any in-flight/queued bytes before
  5815. // the final shutdown+close. Closing with unread data in the receive queue
  5816. // (or bytes arriving after the receive side is closed) makes the stack send
  5817. // an abortive RST instead of a graceful FIN, which can make the peer see the
  5818. // response as a failed read even though it was fully written.
  5819. inline void drain_and_close_socket(socket_t sock) noexcept {
  5820. #ifdef _WIN32
  5821. shutdown(sock, SD_SEND);
  5822. #else
  5823. shutdown(sock, SHUT_WR);
  5824. #endif
  5825. char buf[CPPHTTPLIB_RECV_BUFSIZ];
  5826. size_t total = 0;
  5827. const auto deadline = std::chrono::steady_clock::now() +
  5828. std::chrono::milliseconds(100); // bound #1
  5829. while (total < size_t(1024u * 1024u)) { // bound #2
  5830. const auto remaining =
  5831. std::chrono::duration_cast<std::chrono::microseconds>(
  5832. deadline - std::chrono::steady_clock::now())
  5833. .count();
  5834. if (remaining <= 0) { break; }
  5835. if (select_read(sock, 0, static_cast<time_t>(remaining)) <= 0) { break; }
  5836. const auto n = read_socket(sock, buf, sizeof(buf), CPPHTTPLIB_RECV_FLAGS);
  5837. if (n <= 0) { break; }
  5838. total += static_cast<size_t>(n);
  5839. }
  5840. shutdown_socket(sock);
  5841. close_socket(sock);
  5842. }
  5843. inline std::string escape_abstract_namespace_unix_domain(const std::string &s) {
  5844. if (s.size() > 1 && s[0] == '\0') {
  5845. auto ret = s;
  5846. ret[0] = '@';
  5847. return ret;
  5848. }
  5849. return s;
  5850. }
  5851. inline std::string
  5852. unescape_abstract_namespace_unix_domain(const std::string &s) {
  5853. if (s.size() > 1 && s[0] == '@') {
  5854. auto ret = s;
  5855. ret[0] = '\0';
  5856. return ret;
  5857. }
  5858. return s;
  5859. }
  5860. inline int getaddrinfo_with_timeout(const char *node, const char *service,
  5861. const struct addrinfo *hints,
  5862. struct addrinfo **res, time_t timeout_sec) {
  5863. #ifdef CPPHTTPLIB_USE_NON_BLOCKING_GETADDRINFO
  5864. if (timeout_sec <= 0) {
  5865. // No timeout specified, use standard getaddrinfo
  5866. return getaddrinfo(node, service, hints, res);
  5867. }
  5868. #ifdef _WIN32
  5869. // Windows-specific implementation using GetAddrInfoEx with overlapped I/O
  5870. OVERLAPPED overlapped = {};
  5871. HANDLE event = CreateEventW(nullptr, TRUE, FALSE, nullptr);
  5872. if (!event) { return EAI_FAIL; }
  5873. overlapped.hEvent = event;
  5874. PADDRINFOEXW result_addrinfo = nullptr;
  5875. HANDLE cancel_handle = nullptr;
  5876. ADDRINFOEXW hints_ex = {};
  5877. if (hints) {
  5878. hints_ex.ai_flags = hints->ai_flags;
  5879. hints_ex.ai_family = hints->ai_family;
  5880. hints_ex.ai_socktype = hints->ai_socktype;
  5881. hints_ex.ai_protocol = hints->ai_protocol;
  5882. }
  5883. auto wnode = u8string_to_wstring(node);
  5884. auto wservice = u8string_to_wstring(service);
  5885. auto ret = ::GetAddrInfoExW(wnode.data(), wservice.data(), NS_DNS, nullptr,
  5886. hints ? &hints_ex : nullptr, &result_addrinfo,
  5887. nullptr, &overlapped, nullptr, &cancel_handle);
  5888. if (ret == WSA_IO_PENDING) {
  5889. auto wait_result =
  5890. ::WaitForSingleObject(event, static_cast<DWORD>(timeout_sec * 1000));
  5891. if (wait_result == WAIT_TIMEOUT) {
  5892. if (cancel_handle) { ::GetAddrInfoExCancel(&cancel_handle); }
  5893. ::CloseHandle(event);
  5894. return EAI_AGAIN;
  5895. }
  5896. DWORD bytes_returned;
  5897. if (!::GetOverlappedResult((HANDLE)INVALID_SOCKET, &overlapped,
  5898. &bytes_returned, FALSE)) {
  5899. ::CloseHandle(event);
  5900. return ::WSAGetLastError();
  5901. }
  5902. }
  5903. ::CloseHandle(event);
  5904. if (ret == NO_ERROR || ret == WSA_IO_PENDING) {
  5905. *res = reinterpret_cast<struct addrinfo *>(result_addrinfo);
  5906. return 0;
  5907. }
  5908. return ret;
  5909. #elif TARGET_OS_MAC && defined(__clang__)
  5910. if (!node) { return EAI_NONAME; }
  5911. // macOS implementation using CFHost API for asynchronous DNS resolution
  5912. CFStringRef hostname_ref = CFStringCreateWithCString(
  5913. kCFAllocatorDefault, node, kCFStringEncodingUTF8);
  5914. if (!hostname_ref) { return EAI_MEMORY; }
  5915. CFHostRef host_ref = CFHostCreateWithName(kCFAllocatorDefault, hostname_ref);
  5916. CFRelease(hostname_ref);
  5917. if (!host_ref) { return EAI_MEMORY; }
  5918. // Set up context for callback
  5919. struct CFHostContext {
  5920. bool completed = false;
  5921. bool success = false;
  5922. CFArrayRef addresses = nullptr;
  5923. std::mutex mutex;
  5924. std::condition_variable cv;
  5925. } context;
  5926. CFHostClientContext client_context;
  5927. memset(&client_context, 0, sizeof(client_context));
  5928. client_context.info = &context;
  5929. // Set callback
  5930. auto callback = [](CFHostRef theHost, CFHostInfoType /*typeInfo*/,
  5931. const CFStreamError *error, void *info) {
  5932. auto ctx = static_cast<CFHostContext *>(info);
  5933. std::lock_guard<std::mutex> lock(ctx->mutex);
  5934. if (error && error->error != 0) {
  5935. ctx->success = false;
  5936. } else {
  5937. Boolean hasBeenResolved;
  5938. ctx->addresses = CFHostGetAddressing(theHost, &hasBeenResolved);
  5939. if (ctx->addresses && hasBeenResolved) {
  5940. CFRetain(ctx->addresses);
  5941. ctx->success = true;
  5942. } else {
  5943. ctx->success = false;
  5944. }
  5945. }
  5946. ctx->completed = true;
  5947. ctx->cv.notify_one();
  5948. };
  5949. if (!CFHostSetClient(host_ref, callback, &client_context)) {
  5950. CFRelease(host_ref);
  5951. return EAI_SYSTEM;
  5952. }
  5953. // Schedule on run loop
  5954. CFRunLoopRef run_loop = CFRunLoopGetCurrent();
  5955. CFHostScheduleWithRunLoop(host_ref, run_loop, kCFRunLoopDefaultMode);
  5956. // Start resolution
  5957. CFStreamError stream_error;
  5958. if (!CFHostStartInfoResolution(host_ref, kCFHostAddresses, &stream_error)) {
  5959. CFHostUnscheduleFromRunLoop(host_ref, run_loop, kCFRunLoopDefaultMode);
  5960. CFRelease(host_ref);
  5961. return EAI_FAIL;
  5962. }
  5963. // Wait for completion with timeout
  5964. auto timeout_time =
  5965. std::chrono::steady_clock::now() + std::chrono::seconds(timeout_sec);
  5966. bool timed_out = false;
  5967. {
  5968. std::unique_lock<std::mutex> lock(context.mutex);
  5969. while (!context.completed) {
  5970. auto now = std::chrono::steady_clock::now();
  5971. if (now >= timeout_time) {
  5972. timed_out = true;
  5973. break;
  5974. }
  5975. // Run the runloop for a short time
  5976. lock.unlock();
  5977. CFRunLoopRunInMode(kCFRunLoopDefaultMode, 0.1, true);
  5978. lock.lock();
  5979. }
  5980. }
  5981. // Clean up
  5982. CFHostUnscheduleFromRunLoop(host_ref, run_loop, kCFRunLoopDefaultMode);
  5983. CFHostSetClient(host_ref, nullptr, nullptr);
  5984. if (timed_out || !context.completed) {
  5985. CFHostCancelInfoResolution(host_ref, kCFHostAddresses);
  5986. CFRelease(host_ref);
  5987. return EAI_AGAIN;
  5988. }
  5989. if (!context.success || !context.addresses) {
  5990. CFRelease(host_ref);
  5991. return EAI_NODATA;
  5992. }
  5993. // Convert CFArray to addrinfo
  5994. CFIndex count = CFArrayGetCount(context.addresses);
  5995. if (count == 0) {
  5996. CFRelease(context.addresses);
  5997. CFRelease(host_ref);
  5998. return EAI_NODATA;
  5999. }
  6000. struct addrinfo *result_addrinfo = nullptr;
  6001. struct addrinfo **current = &result_addrinfo;
  6002. for (CFIndex i = 0; i < count; i++) {
  6003. CFDataRef addr_data =
  6004. static_cast<CFDataRef>(CFArrayGetValueAtIndex(context.addresses, i));
  6005. if (!addr_data) continue;
  6006. const struct sockaddr *sockaddr_ptr =
  6007. reinterpret_cast<const struct sockaddr *>(CFDataGetBytePtr(addr_data));
  6008. socklen_t sockaddr_len = static_cast<socklen_t>(CFDataGetLength(addr_data));
  6009. // Allocate addrinfo structure
  6010. *current = static_cast<struct addrinfo *>(malloc(sizeof(struct addrinfo)));
  6011. if (!*current) {
  6012. freeaddrinfo(result_addrinfo);
  6013. CFRelease(context.addresses);
  6014. CFRelease(host_ref);
  6015. return EAI_MEMORY;
  6016. }
  6017. memset(*current, 0, sizeof(struct addrinfo));
  6018. // Set up addrinfo fields
  6019. (*current)->ai_family = sockaddr_ptr->sa_family;
  6020. (*current)->ai_socktype = hints ? hints->ai_socktype : SOCK_STREAM;
  6021. (*current)->ai_protocol = hints ? hints->ai_protocol : IPPROTO_TCP;
  6022. (*current)->ai_addrlen = sockaddr_len;
  6023. // Copy sockaddr
  6024. (*current)->ai_addr = static_cast<struct sockaddr *>(malloc(sockaddr_len));
  6025. if (!(*current)->ai_addr) {
  6026. freeaddrinfo(result_addrinfo);
  6027. CFRelease(context.addresses);
  6028. CFRelease(host_ref);
  6029. return EAI_MEMORY;
  6030. }
  6031. memcpy((*current)->ai_addr, sockaddr_ptr, sockaddr_len);
  6032. // Set port if service is specified
  6033. if (service && *service) {
  6034. int port = 0;
  6035. if (parse_port(service, strlen(service), port)) {
  6036. if (sockaddr_ptr->sa_family == AF_INET) {
  6037. reinterpret_cast<struct sockaddr_in *>((*current)->ai_addr)
  6038. ->sin_port = htons(static_cast<uint16_t>(port));
  6039. } else if (sockaddr_ptr->sa_family == AF_INET6) {
  6040. reinterpret_cast<struct sockaddr_in6 *>((*current)->ai_addr)
  6041. ->sin6_port = htons(static_cast<uint16_t>(port));
  6042. }
  6043. }
  6044. }
  6045. current = &((*current)->ai_next);
  6046. }
  6047. CFRelease(context.addresses);
  6048. CFRelease(host_ref);
  6049. *res = result_addrinfo;
  6050. return 0;
  6051. #elif defined(_GNU_SOURCE) && defined(__GLIBC__) && \
  6052. (__GLIBC__ > 2 || (__GLIBC__ == 2 && __GLIBC_MINOR__ >= 2)) && \
  6053. !defined(CPPHTTPLIB_THREAD_SANITIZER)
  6054. // Skipped under TSan: glibc's internal resolver thread is invisible to it.
  6055. // #2431: gai_cancel() is non-blocking and may return EAI_NOTCANCELED while
  6056. // the resolver worker still references the stack-local gaicb. The cancel
  6057. // path therefore waits (gai_suspend with no timeout) for the worker to
  6058. // actually finish before letting the stack frame go. The trade-off is that
  6059. // a wedged DNS server can hold this thread for the system resolver timeout
  6060. // (~30s by default) past the caller's connection timeout.
  6061. struct gaicb request{};
  6062. struct gaicb *requests[1] = {&request};
  6063. struct sigevent sevp{};
  6064. struct timespec timeout{timeout_sec, 0};
  6065. request.ar_name = node;
  6066. request.ar_service = service;
  6067. request.ar_request = hints;
  6068. sevp.sigev_notify = SIGEV_NONE;
  6069. int rc = getaddrinfo_a(GAI_NOWAIT, requests, 1, &sevp);
  6070. if (rc != 0) { return rc; }
  6071. auto cleanup = scope_exit([&] {
  6072. if (request.ar_result) { freeaddrinfo(request.ar_result); }
  6073. });
  6074. int wait_result = gai_suspend(requests, 1, &timeout);
  6075. if (wait_result == 0 || wait_result == EAI_ALLDONE) {
  6076. int gai_result = gai_error(&request);
  6077. if (gai_result == 0) {
  6078. *res = request.ar_result;
  6079. request.ar_result = nullptr;
  6080. return 0;
  6081. }
  6082. return gai_result;
  6083. }
  6084. gai_cancel(&request);
  6085. while (gai_error(&request) == EAI_INPROGRESS) {
  6086. gai_suspend(requests, 1, nullptr);
  6087. }
  6088. return wait_result;
  6089. #else
  6090. // Fallback implementation using thread-based timeout for other Unix systems.
  6091. struct GetAddrInfoState {
  6092. ~GetAddrInfoState() {
  6093. if (info) { freeaddrinfo(info); }
  6094. }
  6095. std::mutex mutex;
  6096. std::condition_variable result_cv;
  6097. bool completed = false;
  6098. int result = EAI_SYSTEM;
  6099. std::string node;
  6100. std::string service;
  6101. struct addrinfo hints;
  6102. struct addrinfo *info = nullptr;
  6103. };
  6104. // Allocate on the heap, so the resolver thread can keep using the data.
  6105. auto state = std::make_shared<GetAddrInfoState>();
  6106. if (node) { state->node = node; }
  6107. state->service = service;
  6108. state->hints = *hints;
  6109. std::thread resolve_thread([state]() {
  6110. auto thread_result =
  6111. getaddrinfo(state->node.c_str(), state->service.c_str(), &state->hints,
  6112. &state->info);
  6113. std::lock_guard<std::mutex> lock(state->mutex);
  6114. state->result = thread_result;
  6115. state->completed = true;
  6116. state->result_cv.notify_one();
  6117. });
  6118. // Wait for completion or timeout
  6119. std::unique_lock<std::mutex> lock(state->mutex);
  6120. auto finished =
  6121. state->result_cv.wait_for(lock, std::chrono::seconds(timeout_sec),
  6122. [&] { return state->completed; });
  6123. if (finished) {
  6124. // Operation completed within timeout
  6125. resolve_thread.join();
  6126. *res = state->info;
  6127. state->info = nullptr; // Pass ownership to caller
  6128. return state->result;
  6129. } else {
  6130. // Timeout occurred
  6131. resolve_thread.detach(); // Let the thread finish in background
  6132. return EAI_AGAIN; // Return timeout error
  6133. }
  6134. #endif
  6135. #else
  6136. (void)(timeout_sec); // Unused parameter for non-blocking getaddrinfo
  6137. return getaddrinfo(node, service, hints, res);
  6138. #endif
  6139. }
  6140. template <typename BindOrConnect>
  6141. socket_t create_socket(const std::string &host, const std::string &ip, int port,
  6142. int address_family, int socket_flags, bool tcp_nodelay,
  6143. bool ipv6_v6only, SocketOptions socket_options,
  6144. BindOrConnect bind_or_connect, time_t timeout_sec = 0) {
  6145. // Get address info
  6146. const char *node = nullptr;
  6147. struct addrinfo hints;
  6148. struct addrinfo *result;
  6149. memset(&hints, 0, sizeof(struct addrinfo));
  6150. hints.ai_socktype = SOCK_STREAM;
  6151. hints.ai_protocol = IPPROTO_IP;
  6152. if (!ip.empty()) {
  6153. node = ip.c_str();
  6154. // Ask getaddrinfo to convert IP in c-string to address
  6155. hints.ai_family = AF_UNSPEC;
  6156. hints.ai_flags = AI_NUMERICHOST;
  6157. } else {
  6158. if (!host.empty()) { node = host.c_str(); }
  6159. hints.ai_family = address_family;
  6160. hints.ai_flags = socket_flags;
  6161. }
  6162. #if !defined(_WIN32) || defined(CPPHTTPLIB_HAVE_AFUNIX_H)
  6163. if (hints.ai_family == AF_UNIX) {
  6164. const auto addrlen = host.length();
  6165. if (addrlen > sizeof(sockaddr_un::sun_path)) { return INVALID_SOCKET; }
  6166. #ifdef SOCK_CLOEXEC
  6167. auto sock = socket(hints.ai_family, hints.ai_socktype | SOCK_CLOEXEC,
  6168. hints.ai_protocol);
  6169. #else
  6170. auto sock = socket(hints.ai_family, hints.ai_socktype, hints.ai_protocol);
  6171. #endif
  6172. if (sock != INVALID_SOCKET) {
  6173. sockaddr_un addr{};
  6174. addr.sun_family = AF_UNIX;
  6175. auto unescaped_host = unescape_abstract_namespace_unix_domain(host);
  6176. std::copy(unescaped_host.begin(), unescaped_host.end(), addr.sun_path);
  6177. hints.ai_addr = reinterpret_cast<sockaddr *>(&addr);
  6178. hints.ai_addrlen = static_cast<socklen_t>(
  6179. sizeof(addr) - sizeof(addr.sun_path) + addrlen);
  6180. #ifndef SOCK_CLOEXEC
  6181. #ifndef _WIN32
  6182. fcntl(sock, F_SETFD, FD_CLOEXEC);
  6183. #endif
  6184. #endif
  6185. if (socket_options) { socket_options(sock); }
  6186. #ifdef _WIN32
  6187. // Setting SO_REUSEADDR seems not to work well with AF_UNIX on windows, so
  6188. // remove the option.
  6189. set_socket_opt(sock, SOL_SOCKET, SO_REUSEADDR, 0);
  6190. #endif
  6191. bool dummy;
  6192. if (!bind_or_connect(sock, hints, dummy)) {
  6193. close_socket(sock);
  6194. sock = INVALID_SOCKET;
  6195. }
  6196. }
  6197. return sock;
  6198. }
  6199. #endif
  6200. auto service = std::to_string(port);
  6201. if (getaddrinfo_with_timeout(node, service.c_str(), &hints, &result,
  6202. timeout_sec)) {
  6203. #if defined __linux__ && !defined __ANDROID__
  6204. res_init();
  6205. #endif
  6206. return INVALID_SOCKET;
  6207. }
  6208. auto se = detail::scope_exit([&] { freeaddrinfo(result); });
  6209. for (auto rp = result; rp; rp = rp->ai_next) {
  6210. // Create a socket
  6211. #ifdef _WIN32
  6212. auto sock =
  6213. WSASocketW(rp->ai_family, rp->ai_socktype, rp->ai_protocol, nullptr, 0,
  6214. WSA_FLAG_NO_HANDLE_INHERIT | WSA_FLAG_OVERLAPPED);
  6215. /**
  6216. * Since the WSA_FLAG_NO_HANDLE_INHERIT is only supported on Windows 7 SP1
  6217. * and above the socket creation fails on older Windows Systems.
  6218. *
  6219. * Let's try to create a socket the old way in this case.
  6220. *
  6221. * Reference:
  6222. * https://docs.microsoft.com/en-us/windows/win32/api/winsock2/nf-winsock2-wsasocketa
  6223. *
  6224. * WSA_FLAG_NO_HANDLE_INHERIT:
  6225. * This flag is supported on Windows 7 with SP1, Windows Server 2008 R2 with
  6226. * SP1, and later
  6227. *
  6228. */
  6229. if (sock == INVALID_SOCKET) {
  6230. sock = socket(rp->ai_family, rp->ai_socktype, rp->ai_protocol);
  6231. }
  6232. #else
  6233. #ifdef SOCK_CLOEXEC
  6234. auto sock =
  6235. socket(rp->ai_family, rp->ai_socktype | SOCK_CLOEXEC, rp->ai_protocol);
  6236. #else
  6237. auto sock = socket(rp->ai_family, rp->ai_socktype, rp->ai_protocol);
  6238. #endif
  6239. #endif
  6240. if (sock == INVALID_SOCKET) { continue; }
  6241. #if !defined _WIN32 && !defined SOCK_CLOEXEC
  6242. if (fcntl(sock, F_SETFD, FD_CLOEXEC) == -1) {
  6243. close_socket(sock);
  6244. continue;
  6245. }
  6246. #endif
  6247. if (tcp_nodelay) { set_socket_opt(sock, IPPROTO_TCP, TCP_NODELAY, 1); }
  6248. if (rp->ai_family == AF_INET6) {
  6249. set_socket_opt(sock, IPPROTO_IPV6, IPV6_V6ONLY, ipv6_v6only ? 1 : 0);
  6250. }
  6251. if (socket_options) { socket_options(sock); }
  6252. // bind or connect
  6253. auto quit = false;
  6254. if (bind_or_connect(sock, *rp, quit)) { return sock; }
  6255. close_socket(sock);
  6256. if (quit) { break; }
  6257. }
  6258. return INVALID_SOCKET;
  6259. }
  6260. inline void set_nonblocking(socket_t sock, bool nonblocking) {
  6261. #ifdef _WIN32
  6262. auto flags = nonblocking ? 1UL : 0UL;
  6263. ioctlsocket(sock, FIONBIO, &flags);
  6264. #else
  6265. auto flags = fcntl(sock, F_GETFL, 0);
  6266. fcntl(sock, F_SETFL,
  6267. nonblocking ? (flags | O_NONBLOCK) : (flags & (~O_NONBLOCK)));
  6268. #endif
  6269. }
  6270. inline bool is_connection_error() {
  6271. #ifdef _WIN32
  6272. return WSAGetLastError() != WSAEWOULDBLOCK;
  6273. #else
  6274. return errno != EINPROGRESS;
  6275. #endif
  6276. }
  6277. // accept() failed because the process or the network stack is temporarily out
  6278. // of resources. The listening socket is still usable, so back off briefly and
  6279. // try again.
  6280. inline bool is_accept_resource_error() {
  6281. #ifdef _WIN32
  6282. auto err = WSAGetLastError();
  6283. return err == WSAEMFILE || err == WSAENOBUFS;
  6284. #else
  6285. auto err = errno;
  6286. return err == EMFILE || err == ENFILE || err == ENOBUFS || err == ENOMEM;
  6287. #endif
  6288. }
  6289. // accept() failed for a reason that says nothing about the listening socket:
  6290. // the pending connection went away before it could be accepted, or the call
  6291. // was interrupted. Retry immediately. WSAAccept()'s own documentation omits
  6292. // WSAECONNRESET, but the accept() it wraps reports an aborted pending
  6293. // connection that way.
  6294. inline bool is_accept_transient_error() {
  6295. #ifdef _WIN32
  6296. auto err = WSAGetLastError();
  6297. return err == WSAEINTR || err == WSAEWOULDBLOCK || err == WSAECONNRESET ||
  6298. err == WSAECONNABORTED;
  6299. #else
  6300. auto err = errno;
  6301. return err == EINTR || err == EAGAIN || err == EWOULDBLOCK ||
  6302. err == ECONNABORTED;
  6303. #endif
  6304. }
  6305. inline bool bind_ip_address(socket_t sock, const std::string &host) {
  6306. struct addrinfo hints;
  6307. struct addrinfo *result;
  6308. memset(&hints, 0, sizeof(struct addrinfo));
  6309. hints.ai_family = AF_UNSPEC;
  6310. hints.ai_socktype = SOCK_STREAM;
  6311. hints.ai_protocol = 0;
  6312. if (getaddrinfo_with_timeout(host.c_str(), "0", &hints, &result, 0)) {
  6313. return false;
  6314. }
  6315. auto se = detail::scope_exit([&] { freeaddrinfo(result); });
  6316. auto ret = false;
  6317. for (auto rp = result; rp; rp = rp->ai_next) {
  6318. const auto &ai = *rp;
  6319. if (!::bind(sock, ai.ai_addr, static_cast<socklen_t>(ai.ai_addrlen))) {
  6320. ret = true;
  6321. break;
  6322. }
  6323. }
  6324. return ret;
  6325. }
  6326. #if !defined _WIN32 && !defined ANDROID && !defined _AIX && !defined __MVS__
  6327. #define USE_IF2IP
  6328. #endif
  6329. #ifdef USE_IF2IP
  6330. inline std::string if2ip(int address_family, const std::string &ifn) {
  6331. struct ifaddrs *ifap;
  6332. getifaddrs(&ifap);
  6333. auto se = detail::scope_exit([&] { freeifaddrs(ifap); });
  6334. std::string addr_candidate;
  6335. for (auto ifa = ifap; ifa; ifa = ifa->ifa_next) {
  6336. if (ifa->ifa_addr && ifn == ifa->ifa_name &&
  6337. (AF_UNSPEC == address_family ||
  6338. ifa->ifa_addr->sa_family == address_family)) {
  6339. if (ifa->ifa_addr->sa_family == AF_INET) {
  6340. auto sa = reinterpret_cast<struct sockaddr_in *>(ifa->ifa_addr);
  6341. char buf[INET_ADDRSTRLEN];
  6342. if (inet_ntop(AF_INET, &sa->sin_addr, buf, INET_ADDRSTRLEN)) {
  6343. return std::string(buf, INET_ADDRSTRLEN);
  6344. }
  6345. } else if (ifa->ifa_addr->sa_family == AF_INET6) {
  6346. auto sa = reinterpret_cast<struct sockaddr_in6 *>(ifa->ifa_addr);
  6347. if (!IN6_IS_ADDR_LINKLOCAL(&sa->sin6_addr)) {
  6348. char buf[INET6_ADDRSTRLEN] = {};
  6349. if (inet_ntop(AF_INET6, &sa->sin6_addr, buf, INET6_ADDRSTRLEN)) {
  6350. // equivalent to mac's IN6_IS_ADDR_UNIQUE_LOCAL
  6351. auto s6_addr_head = sa->sin6_addr.s6_addr[0];
  6352. if (s6_addr_head == 0xfc || s6_addr_head == 0xfd) {
  6353. addr_candidate = std::string(buf, INET6_ADDRSTRLEN);
  6354. } else {
  6355. return std::string(buf, INET6_ADDRSTRLEN);
  6356. }
  6357. }
  6358. }
  6359. }
  6360. }
  6361. }
  6362. return addr_candidate;
  6363. }
  6364. #endif
  6365. inline socket_t create_client_socket(
  6366. const std::string &host, const std::string &ip, int port,
  6367. int address_family, bool tcp_nodelay, bool ipv6_v6only,
  6368. SocketOptions socket_options, time_t connection_timeout_sec,
  6369. time_t connection_timeout_usec, time_t read_timeout_sec,
  6370. time_t read_timeout_usec, time_t write_timeout_sec,
  6371. time_t write_timeout_usec, const std::string &intf, Error &error) {
  6372. auto sock = create_socket(
  6373. host, ip, port, address_family, 0, tcp_nodelay, ipv6_v6only,
  6374. std::move(socket_options),
  6375. [&](socket_t sock2, struct addrinfo &ai, bool &quit) -> bool {
  6376. if (!intf.empty()) {
  6377. #ifdef USE_IF2IP
  6378. auto ip_from_if = if2ip(address_family, intf);
  6379. if (ip_from_if.empty()) { ip_from_if = intf; }
  6380. if (!bind_ip_address(sock2, ip_from_if)) {
  6381. error = Error::BindIPAddress;
  6382. return false;
  6383. }
  6384. #endif
  6385. }
  6386. set_nonblocking(sock2, true);
  6387. auto ret =
  6388. ::connect(sock2, ai.ai_addr, static_cast<socklen_t>(ai.ai_addrlen));
  6389. if (ret < 0) {
  6390. if (is_connection_error()) {
  6391. error = Error::Connection;
  6392. return false;
  6393. }
  6394. error = wait_until_socket_is_ready(sock2, connection_timeout_sec,
  6395. connection_timeout_usec);
  6396. if (error != Error::Success) {
  6397. if (error == Error::ConnectionTimeout) { quit = true; }
  6398. return false;
  6399. }
  6400. }
  6401. set_nonblocking(sock2, false);
  6402. set_socket_opt_time(sock2, SOL_SOCKET, SO_RCVTIMEO, read_timeout_sec,
  6403. read_timeout_usec);
  6404. set_socket_opt_time(sock2, SOL_SOCKET, SO_SNDTIMEO, write_timeout_sec,
  6405. write_timeout_usec);
  6406. error = Error::Success;
  6407. return true;
  6408. },
  6409. connection_timeout_sec); // Pass DNS timeout
  6410. if (sock != INVALID_SOCKET) {
  6411. error = Error::Success;
  6412. } else {
  6413. if (error == Error::Success) { error = Error::Connection; }
  6414. }
  6415. return sock;
  6416. }
  6417. inline bool get_ip_and_port(const struct sockaddr_storage &addr,
  6418. socklen_t addr_len, std::string &ip, int &port) {
  6419. if (addr.ss_family == AF_INET) {
  6420. port = ntohs(reinterpret_cast<const struct sockaddr_in *>(&addr)->sin_port);
  6421. } else if (addr.ss_family == AF_INET6) {
  6422. port =
  6423. ntohs(reinterpret_cast<const struct sockaddr_in6 *>(&addr)->sin6_port);
  6424. } else {
  6425. return false;
  6426. }
  6427. std::array<char, NI_MAXHOST> ipstr{};
  6428. if (getnameinfo(reinterpret_cast<const struct sockaddr *>(&addr), addr_len,
  6429. ipstr.data(), static_cast<socklen_t>(ipstr.size()), nullptr,
  6430. 0, NI_NUMERICHOST)) {
  6431. return false;
  6432. }
  6433. ip = ipstr.data();
  6434. return true;
  6435. }
  6436. inline void get_local_ip_and_port(socket_t sock, std::string &ip, int &port) {
  6437. struct sockaddr_storage addr;
  6438. socklen_t addr_len = sizeof(addr);
  6439. if (!getsockname(sock, reinterpret_cast<struct sockaddr *>(&addr),
  6440. &addr_len)) {
  6441. get_ip_and_port(addr, addr_len, ip, port);
  6442. }
  6443. }
  6444. inline void get_remote_ip_and_port(socket_t sock, std::string &ip, int &port) {
  6445. struct sockaddr_storage addr;
  6446. socklen_t addr_len = sizeof(addr);
  6447. if (!getpeername(sock, reinterpret_cast<struct sockaddr *>(&addr),
  6448. &addr_len)) {
  6449. #ifndef _WIN32
  6450. if (addr.ss_family == AF_UNIX) {
  6451. #if defined(__linux__)
  6452. struct ucred ucred;
  6453. socklen_t len = sizeof(ucred);
  6454. if (getsockopt(sock, SOL_SOCKET, SO_PEERCRED, &ucred, &len) == 0) {
  6455. port = ucred.pid;
  6456. }
  6457. #elif defined(SOL_LOCAL) && defined(SO_PEERPID)
  6458. pid_t pid;
  6459. socklen_t len = sizeof(pid);
  6460. if (getsockopt(sock, SOL_LOCAL, SO_PEERPID, &pid, &len) == 0) {
  6461. port = pid;
  6462. }
  6463. #endif
  6464. return;
  6465. }
  6466. #endif
  6467. get_ip_and_port(addr, addr_len, ip, port);
  6468. }
  6469. }
  6470. inline std::string
  6471. find_content_type(const std::string &path,
  6472. const std::map<std::string, std::string> &user_data,
  6473. const std::string &default_content_type) {
  6474. auto ext = file_extension(path);
  6475. // Extensions are matched regardless of case, as web servers do, with an
  6476. // exact match to a user mapping first
  6477. auto lower_ext = case_ignore::to_lower(ext);
  6478. auto it = user_data.find(ext);
  6479. if (it == user_data.end()) { it = user_data.find(lower_ext); }
  6480. if (it != user_data.end()) { return it->second; }
  6481. static const struct {
  6482. const char *ext;
  6483. const char *type;
  6484. } types[] = {
  6485. {"css", "text/css"},
  6486. {"csv", "text/csv"},
  6487. {"htm", "text/html"},
  6488. {"html", "text/html"},
  6489. {"js", "text/javascript"},
  6490. {"mjs", "text/javascript"},
  6491. {"txt", "text/plain"},
  6492. {"vtt", "text/vtt"},
  6493. {"apng", "image/apng"},
  6494. {"avif", "image/avif"},
  6495. {"bmp", "image/bmp"},
  6496. {"gif", "image/gif"},
  6497. {"png", "image/png"},
  6498. {"svg", "image/svg+xml"},
  6499. {"webp", "image/webp"},
  6500. {"ico", "image/x-icon"},
  6501. {"tif", "image/tiff"},
  6502. {"tiff", "image/tiff"},
  6503. {"jpg", "image/jpeg"},
  6504. {"jpeg", "image/jpeg"},
  6505. {"mp4", "video/mp4"},
  6506. {"mpeg", "video/mpeg"},
  6507. {"webm", "video/webm"},
  6508. {"mp3", "audio/mp3"},
  6509. {"mpga", "audio/mpeg"},
  6510. {"weba", "audio/webm"},
  6511. {"wav", "audio/wave"},
  6512. {"otf", "font/otf"},
  6513. {"ttf", "font/ttf"},
  6514. {"woff", "font/woff"},
  6515. {"woff2", "font/woff2"},
  6516. {"7z", "application/x-7z-compressed"},
  6517. {"atom", "application/atom+xml"},
  6518. {"pdf", "application/pdf"},
  6519. {"json", "application/json"},
  6520. {"rss", "application/rss+xml"},
  6521. {"tar", "application/x-tar"},
  6522. {"xht", "application/xhtml+xml"},
  6523. {"xhtml", "application/xhtml+xml"},
  6524. {"xslt", "application/xslt+xml"},
  6525. {"xml", "application/xml"},
  6526. {"gz", "application/gzip"},
  6527. {"zip", "application/zip"},
  6528. {"wasm", "application/wasm"},
  6529. };
  6530. for (const auto &t : types) {
  6531. if (lower_ext == t.ext) { return t.type; }
  6532. }
  6533. return default_content_type;
  6534. }
  6535. inline std::string
  6536. extract_media_type(const std::string &content_type,
  6537. std::map<std::string, std::string> *params = nullptr) {
  6538. // Extract type/subtype from Content-Type value (RFC 2045)
  6539. // e.g. "application/json; charset=utf-8" -> "application/json"
  6540. auto media_type = content_type;
  6541. auto semicolon_pos = media_type.find(';');
  6542. if (semicolon_pos != std::string::npos) {
  6543. auto param_str = media_type.substr(semicolon_pos + 1);
  6544. media_type = media_type.substr(0, semicolon_pos);
  6545. if (params) {
  6546. // Parse parameters: key=value pairs separated by ';'
  6547. split_unquoted(param_str.data(), param_str.data() + param_str.size(), ';',
  6548. [&](const char *b, const char *e) {
  6549. std::string key;
  6550. std::string val;
  6551. divide_param_pair(b, e, key, val);
  6552. // Parameter names are case-insensitive (RFC 9110
  6553. // §5.6.6)
  6554. if (!key.empty()) {
  6555. params->emplace(case_ignore::to_lower(trim_copy(key)),
  6556. unquote_param(val));
  6557. }
  6558. });
  6559. }
  6560. }
  6561. // Trim whitespace from media type
  6562. return trim_copy(media_type);
  6563. }
  6564. inline bool can_compress_content_type(const std::string &content_type) {
  6565. // Media types are case-insensitive (RFC 9110 §8.3.1)
  6566. auto mime_type = case_ignore::to_lower(extract_media_type(content_type));
  6567. static const char *const compressible[] = {
  6568. "image/svg+xml",
  6569. "application/javascript",
  6570. "application/x-javascript",
  6571. "application/json",
  6572. "application/ld+json",
  6573. "application/xml",
  6574. "application/xhtml+xml",
  6575. "application/rss+xml",
  6576. "application/atom+xml",
  6577. "application/xslt+xml",
  6578. "application/protobuf",
  6579. };
  6580. for (auto type : compressible) {
  6581. if (mime_type == type) { return true; }
  6582. }
  6583. return mime_type != "text/event-stream" && !mime_type.rfind("text/", 0);
  6584. }
  6585. inline bool parse_quality(const char *b, const char *e, std::string &token,
  6586. double &quality) {
  6587. quality = 1.0;
  6588. token.clear();
  6589. // Split on first ';': left = token name, right = parameters
  6590. const char *params_b = nullptr;
  6591. std::size_t params_len = 0;
  6592. divide(
  6593. b, static_cast<std::size_t>(e - b), ';',
  6594. [&](const char *lb, std::size_t llen, const char *rb, std::size_t rlen) {
  6595. auto r = trim(lb, lb + llen, 0, llen);
  6596. if (r.first < r.second) { token.assign(lb + r.first, lb + r.second); }
  6597. params_b = rb;
  6598. params_len = rlen;
  6599. });
  6600. if (token.empty()) { return false; }
  6601. if (params_len == 0) { return true; }
  6602. // Scan parameters for q= (stops on first match)
  6603. bool invalid = false;
  6604. split_find(params_b, params_b + params_len, ';',
  6605. (std::numeric_limits<size_t>::max)(),
  6606. [&](const char *pb, const char *pe) -> bool {
  6607. // Match exactly "q=" or "Q=" (not "query=" etc.)
  6608. auto len = static_cast<size_t>(pe - pb);
  6609. if (len < 2) { return false; }
  6610. if ((pb[0] != 'q' && pb[0] != 'Q') || pb[1] != '=') {
  6611. return false;
  6612. }
  6613. // Trim the value portion
  6614. auto r = trim(pb, pe, 2, len);
  6615. if (r.first >= r.second) {
  6616. invalid = true;
  6617. return true;
  6618. }
  6619. double v = 0.0;
  6620. auto res = from_chars(pb + r.first, pb + r.second, v);
  6621. if (res.ec != std::errc{} || res.ptr != pb + r.second ||
  6622. v < 0.0 || v > 1.0) {
  6623. invalid = true;
  6624. return true;
  6625. }
  6626. quality = v;
  6627. return true;
  6628. });
  6629. return !invalid;
  6630. }
  6631. inline EncodingType encoding_type(const Request &req,
  6632. const std::string &content_type) {
  6633. if (!can_compress_content_type(content_type)) { return EncodingType::None; }
  6634. auto s = get_combined_header_value(req.headers, "Accept-Encoding");
  6635. if (s.empty()) { return EncodingType::None; }
  6636. // Single-pass: iterate tokens and track the best supported encoding.
  6637. // Server preference breaks ties (br > gzip > zstd).
  6638. EncodingType best = EncodingType::None;
  6639. double best_q = 0.0; // q=0 means "not acceptable"
  6640. // Server preference: Brotli > Gzip > Zstd (lower = more preferred)
  6641. auto priority = [](EncodingType t) -> int {
  6642. switch (t) {
  6643. case EncodingType::Brotli: return 0;
  6644. case EncodingType::Gzip: return 1;
  6645. case EncodingType::Zstd: return 2;
  6646. default: return 3;
  6647. }
  6648. };
  6649. std::string name;
  6650. split(s.data(), s.data() + s.size(), ',', [&](const char *b, const char *e) {
  6651. double quality = 1.0;
  6652. if (!parse_quality(b, e, name, quality)) { return; }
  6653. if (quality <= 0.0) { return; }
  6654. EncodingType type = EncodingType::None;
  6655. #ifdef CPPHTTPLIB_BROTLI_SUPPORT
  6656. if (case_ignore::equal(name, "br")) { type = EncodingType::Brotli; }
  6657. #endif
  6658. #ifdef CPPHTTPLIB_ZLIB_SUPPORT
  6659. if (type == EncodingType::None && case_ignore::equal(name, "gzip")) {
  6660. type = EncodingType::Gzip;
  6661. }
  6662. #endif
  6663. #ifdef CPPHTTPLIB_ZSTD_SUPPORT
  6664. if (type == EncodingType::None && case_ignore::equal(name, "zstd")) {
  6665. type = EncodingType::Zstd;
  6666. }
  6667. #endif
  6668. if (type == EncodingType::None) { return; }
  6669. // Higher q-value wins; for equal q, server preference breaks ties
  6670. if (quality > best_q ||
  6671. (quality == best_q && priority(type) < priority(best))) {
  6672. best_q = quality;
  6673. best = type;
  6674. }
  6675. });
  6676. return best;
  6677. }
  6678. // `content_type` is taken separately because a file-backed response has not
  6679. // been given one yet when its coding has to be decided.
  6680. inline EncodingType encoding_type(const Request &req, const Response &res,
  6681. const std::string &content_type) {
  6682. // The response already names a content coding of its own: a handler serving
  6683. // a body it encoded itself (pre-compressed static assets, say), or a mount
  6684. // point whose headers name the coding its files are stored in. Applying one
  6685. // on top of that would double-encode the body and append a second
  6686. // `Content-Encoding` field line.
  6687. if (res.has_header("Content-Encoding")) { return EncodingType::None; }
  6688. return encoding_type(req, content_type);
  6689. }
  6690. inline EncodingType encoding_type(const Request &req, const Response &res) {
  6691. return encoding_type(req, res, res.get_header_value("Content-Type"));
  6692. }
  6693. inline std::unique_ptr<compressor> make_compressor(EncodingType type) {
  6694. #ifdef CPPHTTPLIB_ZLIB_SUPPORT
  6695. if (type == EncodingType::Gzip) {
  6696. return detail::make_unique<gzip_compressor>();
  6697. }
  6698. #endif
  6699. #ifdef CPPHTTPLIB_BROTLI_SUPPORT
  6700. if (type == EncodingType::Brotli) {
  6701. return detail::make_unique<brotli_compressor>();
  6702. }
  6703. #endif
  6704. #ifdef CPPHTTPLIB_ZSTD_SUPPORT
  6705. if (type == EncodingType::Zstd) {
  6706. return detail::make_unique<zstd_compressor>();
  6707. }
  6708. #endif
  6709. (void)type;
  6710. return nullptr;
  6711. }
  6712. inline const char *encoding_name(EncodingType type) {
  6713. switch (type) {
  6714. case EncodingType::Gzip: return "gzip";
  6715. case EncodingType::Brotli: return "br";
  6716. case EncodingType::Zstd: return "zstd";
  6717. default: return "";
  6718. }
  6719. }
  6720. inline bool nocompressor::compress(const char *data, size_t data_length,
  6721. bool /*last*/, Callback callback) {
  6722. if (!data_length) { return true; }
  6723. return callback(data, data_length);
  6724. }
  6725. #ifdef CPPHTTPLIB_ZLIB_SUPPORT
  6726. inline gzip_compressor::gzip_compressor() {
  6727. std::memset(&strm_, 0, sizeof(strm_));
  6728. strm_.zalloc = Z_NULL;
  6729. strm_.zfree = Z_NULL;
  6730. strm_.opaque = Z_NULL;
  6731. is_valid_ = deflateInit2(&strm_, Z_DEFAULT_COMPRESSION, Z_DEFLATED, 31, 8,
  6732. Z_DEFAULT_STRATEGY) == Z_OK;
  6733. }
  6734. inline gzip_compressor::~gzip_compressor() { deflateEnd(&strm_); }
  6735. inline bool gzip_compressor::compress(const char *data, size_t data_length,
  6736. bool last, Callback callback) {
  6737. assert(is_valid_);
  6738. do {
  6739. constexpr size_t max_avail_in =
  6740. (std::numeric_limits<decltype(strm_.avail_in)>::max)();
  6741. strm_.avail_in = static_cast<decltype(strm_.avail_in)>(
  6742. (std::min)(data_length, max_avail_in));
  6743. strm_.next_in = const_cast<Bytef *>(reinterpret_cast<const Bytef *>(data));
  6744. data_length -= strm_.avail_in;
  6745. data += strm_.avail_in;
  6746. auto flush = (last && data_length == 0) ? Z_FINISH : Z_NO_FLUSH;
  6747. auto ret = Z_OK;
  6748. std::array<char, CPPHTTPLIB_COMPRESSION_BUFSIZ> buff{};
  6749. do {
  6750. strm_.avail_out = static_cast<uInt>(buff.size());
  6751. strm_.next_out = reinterpret_cast<Bytef *>(buff.data());
  6752. ret = deflate(&strm_, flush);
  6753. if (ret == Z_STREAM_ERROR) { return false; }
  6754. if (!callback(buff.data(), buff.size() - strm_.avail_out)) {
  6755. return false;
  6756. }
  6757. } while (strm_.avail_out == 0);
  6758. assert((flush == Z_FINISH && ret == Z_STREAM_END) ||
  6759. (flush == Z_NO_FLUSH && ret == Z_OK));
  6760. assert(strm_.avail_in == 0);
  6761. } while (data_length > 0);
  6762. return true;
  6763. }
  6764. inline gzip_decompressor::gzip_decompressor() {
  6765. std::memset(&strm_, 0, sizeof(strm_));
  6766. strm_.zalloc = Z_NULL;
  6767. strm_.zfree = Z_NULL;
  6768. strm_.opaque = Z_NULL;
  6769. // 15 is the value of wbits, which should be at the maximum possible value
  6770. // to ensure that any gzip stream can be decoded. The offset of 32 specifies
  6771. // that the stream type should be automatically detected either gzip or
  6772. // deflate.
  6773. is_valid_ = inflateInit2(&strm_, 32 + 15) == Z_OK;
  6774. }
  6775. inline gzip_decompressor::~gzip_decompressor() { inflateEnd(&strm_); }
  6776. inline bool gzip_decompressor::is_valid() const { return is_valid_; }
  6777. inline bool gzip_decompressor::decompress(const char *data, size_t data_length,
  6778. Callback callback) {
  6779. assert(is_valid_);
  6780. auto ret = Z_OK;
  6781. do {
  6782. constexpr size_t max_avail_in =
  6783. (std::numeric_limits<decltype(strm_.avail_in)>::max)();
  6784. strm_.avail_in = static_cast<decltype(strm_.avail_in)>(
  6785. (std::min)(data_length, max_avail_in));
  6786. strm_.next_in = const_cast<Bytef *>(reinterpret_cast<const Bytef *>(data));
  6787. data_length -= strm_.avail_in;
  6788. data += strm_.avail_in;
  6789. std::array<char, CPPHTTPLIB_COMPRESSION_BUFSIZ> buff{};
  6790. while (strm_.avail_in > 0 && ret == Z_OK) {
  6791. strm_.avail_out = static_cast<uInt>(buff.size());
  6792. strm_.next_out = reinterpret_cast<Bytef *>(buff.data());
  6793. ret = inflate(&strm_, Z_NO_FLUSH);
  6794. assert(ret != Z_STREAM_ERROR);
  6795. switch (ret) {
  6796. case Z_NEED_DICT:
  6797. case Z_DATA_ERROR:
  6798. case Z_MEM_ERROR: inflateEnd(&strm_); return false;
  6799. }
  6800. if (!callback(buff.data(), buff.size() - strm_.avail_out)) {
  6801. return false;
  6802. }
  6803. }
  6804. if (ret != Z_OK && ret != Z_STREAM_END) { return false; }
  6805. } while (data_length > 0);
  6806. return true;
  6807. }
  6808. #endif
  6809. #ifdef CPPHTTPLIB_BROTLI_SUPPORT
  6810. inline brotli_compressor::brotli_compressor() {
  6811. state_ = BrotliEncoderCreateInstance(nullptr, nullptr, nullptr);
  6812. }
  6813. inline brotli_compressor::~brotli_compressor() {
  6814. BrotliEncoderDestroyInstance(state_);
  6815. }
  6816. inline bool brotli_compressor::compress(const char *data, size_t data_length,
  6817. bool last, Callback callback) {
  6818. std::array<uint8_t, CPPHTTPLIB_COMPRESSION_BUFSIZ> buff{};
  6819. auto operation = last ? BROTLI_OPERATION_FINISH : BROTLI_OPERATION_PROCESS;
  6820. auto available_in = data_length;
  6821. auto next_in = reinterpret_cast<const uint8_t *>(data);
  6822. for (;;) {
  6823. if (last) {
  6824. if (BrotliEncoderIsFinished(state_)) { break; }
  6825. } else {
  6826. if (!available_in) { break; }
  6827. }
  6828. auto available_out = buff.size();
  6829. auto next_out = buff.data();
  6830. if (!BrotliEncoderCompressStream(state_, operation, &available_in, &next_in,
  6831. &available_out, &next_out, nullptr)) {
  6832. return false;
  6833. }
  6834. auto output_bytes = buff.size() - available_out;
  6835. if (output_bytes) {
  6836. callback(reinterpret_cast<const char *>(buff.data()), output_bytes);
  6837. }
  6838. }
  6839. return true;
  6840. }
  6841. inline brotli_decompressor::brotli_decompressor() {
  6842. decoder_s = BrotliDecoderCreateInstance(0, 0, 0);
  6843. decoder_r = decoder_s ? BROTLI_DECODER_RESULT_NEEDS_MORE_INPUT
  6844. : BROTLI_DECODER_RESULT_ERROR;
  6845. }
  6846. inline brotli_decompressor::~brotli_decompressor() {
  6847. if (decoder_s) { BrotliDecoderDestroyInstance(decoder_s); }
  6848. }
  6849. inline bool brotli_decompressor::is_valid() const { return decoder_s; }
  6850. inline bool brotli_decompressor::decompress(const char *data,
  6851. size_t data_length,
  6852. Callback callback) {
  6853. if (decoder_r == BROTLI_DECODER_RESULT_SUCCESS ||
  6854. decoder_r == BROTLI_DECODER_RESULT_ERROR) {
  6855. return 0;
  6856. }
  6857. auto next_in = reinterpret_cast<const uint8_t *>(data);
  6858. size_t avail_in = data_length;
  6859. size_t total_out;
  6860. decoder_r = BROTLI_DECODER_RESULT_NEEDS_MORE_OUTPUT;
  6861. std::array<char, CPPHTTPLIB_COMPRESSION_BUFSIZ> buff{};
  6862. while (decoder_r == BROTLI_DECODER_RESULT_NEEDS_MORE_OUTPUT) {
  6863. char *next_out = buff.data();
  6864. size_t avail_out = buff.size();
  6865. decoder_r = BrotliDecoderDecompressStream(
  6866. decoder_s, &avail_in, &next_in, &avail_out,
  6867. reinterpret_cast<uint8_t **>(&next_out), &total_out);
  6868. if (decoder_r == BROTLI_DECODER_RESULT_ERROR) { return false; }
  6869. if (!callback(buff.data(), buff.size() - avail_out)) { return false; }
  6870. }
  6871. return decoder_r == BROTLI_DECODER_RESULT_SUCCESS ||
  6872. decoder_r == BROTLI_DECODER_RESULT_NEEDS_MORE_INPUT;
  6873. }
  6874. #endif
  6875. #ifdef CPPHTTPLIB_ZSTD_SUPPORT
  6876. inline zstd_compressor::zstd_compressor() {
  6877. ctx_ = ZSTD_createCCtx();
  6878. ZSTD_CCtx_setParameter(ctx_, ZSTD_c_compressionLevel, ZSTD_fast);
  6879. }
  6880. inline zstd_compressor::~zstd_compressor() { ZSTD_freeCCtx(ctx_); }
  6881. inline bool zstd_compressor::compress(const char *data, size_t data_length,
  6882. bool last, Callback callback) {
  6883. std::array<char, CPPHTTPLIB_COMPRESSION_BUFSIZ> buff{};
  6884. ZSTD_EndDirective mode = last ? ZSTD_e_end : ZSTD_e_continue;
  6885. ZSTD_inBuffer input = {data, data_length, 0};
  6886. bool finished;
  6887. do {
  6888. ZSTD_outBuffer output = {buff.data(), CPPHTTPLIB_COMPRESSION_BUFSIZ, 0};
  6889. size_t const remaining = ZSTD_compressStream2(ctx_, &output, &input, mode);
  6890. if (ZSTD_isError(remaining)) { return false; }
  6891. if (!callback(buff.data(), output.pos)) { return false; }
  6892. finished = last ? (remaining == 0) : (input.pos == input.size);
  6893. } while (!finished);
  6894. return true;
  6895. }
  6896. inline zstd_decompressor::zstd_decompressor() { ctx_ = ZSTD_createDCtx(); }
  6897. inline zstd_decompressor::~zstd_decompressor() { ZSTD_freeDCtx(ctx_); }
  6898. inline bool zstd_decompressor::is_valid() const { return ctx_ != nullptr; }
  6899. inline bool zstd_decompressor::decompress(const char *data, size_t data_length,
  6900. Callback callback) {
  6901. std::array<char, CPPHTTPLIB_COMPRESSION_BUFSIZ> buff{};
  6902. ZSTD_inBuffer input = {data, data_length, 0};
  6903. while (input.pos < input.size) {
  6904. ZSTD_outBuffer output = {buff.data(), CPPHTTPLIB_COMPRESSION_BUFSIZ, 0};
  6905. size_t const remaining = ZSTD_decompressStream(ctx_, &output, &input);
  6906. if (ZSTD_isError(remaining)) { return false; }
  6907. if (!callback(buff.data(), output.pos)) { return false; }
  6908. }
  6909. return true;
  6910. }
  6911. #endif
  6912. // Content codings are case-insensitive (RFC 9110 8.4.1). Matching them
  6913. // case-sensitively would make a response labeled e.g. "GZIP" look like an
  6914. // unknown coding, and its payload would be handed back still compressed.
  6915. inline bool is_zlib_encoding(const std::string &encoding) {
  6916. return case_ignore::equal(encoding, "gzip") ||
  6917. case_ignore::equal(encoding, "deflate");
  6918. }
  6919. inline bool is_brotli_encoding(const std::string &encoding) {
  6920. return case_ignore::equal(encoding, "br");
  6921. }
  6922. inline bool is_zstd_encoding(const std::string &encoding) {
  6923. return case_ignore::equal(encoding, "zstd");
  6924. }
  6925. // Returns true if the content coding is one cpp-httplib is able to decompress
  6926. // when the corresponding support is compiled in.
  6927. inline bool is_known_content_encoding(const std::string &encoding) {
  6928. return is_zlib_encoding(encoding) || is_brotli_encoding(encoding) ||
  6929. is_zstd_encoding(encoding);
  6930. }
  6931. inline std::unique_ptr<decompressor>
  6932. create_decompressor(const std::string &encoding) {
  6933. std::unique_ptr<decompressor> decompressor;
  6934. if (is_zlib_encoding(encoding)) {
  6935. #ifdef CPPHTTPLIB_ZLIB_SUPPORT
  6936. decompressor = detail::make_unique<gzip_decompressor>();
  6937. #endif
  6938. } else if (is_brotli_encoding(encoding)) {
  6939. #ifdef CPPHTTPLIB_BROTLI_SUPPORT
  6940. decompressor = detail::make_unique<brotli_decompressor>();
  6941. #endif
  6942. } else if (is_zstd_encoding(encoding)) {
  6943. #ifdef CPPHTTPLIB_ZSTD_SUPPORT
  6944. decompressor = detail::make_unique<zstd_decompressor>();
  6945. #endif
  6946. }
  6947. return decompressor;
  6948. }
  6949. // Returns the best available compressor and its Content-Encoding name.
  6950. // Priority: Brotli > Gzip > Zstd (matches server-side preference).
  6951. inline std::pair<std::unique_ptr<compressor>, const char *>
  6952. create_compressor() {
  6953. #ifdef CPPHTTPLIB_BROTLI_SUPPORT
  6954. return {detail::make_unique<brotli_compressor>(), "br"};
  6955. #elif defined(CPPHTTPLIB_ZLIB_SUPPORT)
  6956. return {detail::make_unique<gzip_compressor>(), "gzip"};
  6957. #elif defined(CPPHTTPLIB_ZSTD_SUPPORT)
  6958. return {detail::make_unique<zstd_compressor>(), "zstd"};
  6959. #else
  6960. return {nullptr, nullptr};
  6961. #endif
  6962. }
  6963. inline bool is_prohibited_header_name(const std::string &name) {
  6964. // Field names are case-insensitive (RFC 9110 §5.1)
  6965. return case_ignore::equal(name, "REMOTE_ADDR") ||
  6966. case_ignore::equal(name, "REMOTE_PORT") ||
  6967. case_ignore::equal(name, "LOCAL_ADDR") ||
  6968. case_ignore::equal(name, "LOCAL_PORT");
  6969. }
  6970. inline bool has_header(const Headers &headers, const std::string &key) {
  6971. if (is_prohibited_header_name(key)) { return false; }
  6972. return headers.find(key) != headers.end();
  6973. }
  6974. inline const char *get_header_value(const Headers &headers,
  6975. const std::string &key, const char *def,
  6976. size_t id) {
  6977. if (is_prohibited_header_name(key)) {
  6978. #ifndef CPPHTTPLIB_NO_EXCEPTIONS
  6979. std::string msg = "Prohibited header name '" + key + "' is specified.";
  6980. throw std::invalid_argument(msg);
  6981. #else
  6982. return "";
  6983. #endif
  6984. }
  6985. auto rng = headers.equal_range(key);
  6986. auto it = bounded_next(rng.first, id, rng.second);
  6987. if (it != rng.second) { return it->second.c_str(); }
  6988. return def;
  6989. }
  6990. inline size_t get_header_value_count(const Headers &headers,
  6991. const std::string &key) {
  6992. return headers.count(key);
  6993. }
  6994. // RFC 9110 Section 5.2 and 5.3: a field that is defined as a comma-separated
  6995. // list may be sent as several field lines, and the combined field value is
  6996. // those values joined by commas in the order they were received. Callers that
  6997. // parse such a list must work on the combined value; reading only the first
  6998. // occurrence silently drops whatever the later field lines carry.
  6999. inline std::string get_combined_header_value(const Headers &headers,
  7000. const std::string &key) {
  7001. std::string combined;
  7002. auto rng = headers.equal_range(key);
  7003. for (auto it = rng.first; it != rng.second; ++it) {
  7004. // RFC 9110 Section 5.6.1.2: a recipient has to parse and ignore empty list
  7005. // elements, so an empty field line must not contribute a bare comma to the
  7006. // combined value.
  7007. if (it->second.empty()) { continue; }
  7008. if (!combined.empty()) { combined += ", "; }
  7009. combined += it->second;
  7010. }
  7011. return combined;
  7012. }
  7013. inline bool has_header_token(const Headers &headers, const std::string &key,
  7014. const std::string &token) {
  7015. // RFC 9110 7.6.1: a comma-separated token list field such as Connection may
  7016. // carry several tokens, and RFC 9110 5.3 lets that list be split across
  7017. // several lines. Match complete tokens rather than searching the raw value,
  7018. // so that a value such as "notupgrade" is not read as the token "upgrade".
  7019. auto rng = headers.equal_range(key);
  7020. for (auto it = rng.first; it != rng.second; ++it) {
  7021. const auto &value = it->second;
  7022. if (split_find(value.data(), value.data() + value.size(), ',',
  7023. [&](const char *b, const char *e) {
  7024. return case_ignore::equal(std::string(b, e), token);
  7025. })) {
  7026. return true;
  7027. }
  7028. }
  7029. return false;
  7030. }
  7031. template <typename Map>
  7032. inline typename Map::mapped_type
  7033. get_multimap_value(const Map &m, const std::string &key, size_t id) {
  7034. auto rng = m.equal_range(key);
  7035. auto it = bounded_next(rng.first, id, rng.second);
  7036. if (it != rng.second) { return it->second; }
  7037. return typename Map::mapped_type();
  7038. }
  7039. inline void set_header(Headers &headers, const std::string &key,
  7040. const std::string &val) {
  7041. if (fields::is_field_valid(key, val)) { headers.emplace(key, val); }
  7042. }
  7043. inline bool read_headers(Stream &strm, Headers &headers) {
  7044. const auto bufsiz = 2048;
  7045. char buf[bufsiz];
  7046. stream_line_reader line_reader(strm, buf, bufsiz);
  7047. size_t header_count = 0;
  7048. for (;;) {
  7049. if (!line_reader.getline()) { return false; }
  7050. // Check if the line ends with CRLF.
  7051. auto line_terminator_len = 2;
  7052. if (line_reader.end_with_crlf()) {
  7053. // Blank line indicates end of headers.
  7054. if (line_reader.size() == 2) { break; }
  7055. } else {
  7056. #ifdef CPPHTTPLIB_ALLOW_LF_AS_LINE_TERMINATOR
  7057. // Blank line indicates end of headers.
  7058. if (line_reader.size() == 1) { break; }
  7059. line_terminator_len = 1;
  7060. #else
  7061. continue; // Skip invalid line.
  7062. #endif
  7063. }
  7064. if (line_reader.size() > CPPHTTPLIB_HEADER_MAX_LENGTH) { return false; }
  7065. // Check header count limit
  7066. if (header_count >= CPPHTTPLIB_HEADER_MAX_COUNT) { return false; }
  7067. // Exclude line terminator
  7068. auto end = line_reader.ptr() + line_reader.size() - line_terminator_len;
  7069. if (!parse_header(line_reader.ptr(), end,
  7070. [&](const std::string &key, const std::string &val) {
  7071. headers.emplace(key, val);
  7072. })) {
  7073. return false;
  7074. }
  7075. header_count++;
  7076. }
  7077. // RFC 9110 Section 8.6: Reject requests with multiple Content-Length
  7078. // headers that have different values to prevent request smuggling.
  7079. auto cl_range = headers.equal_range("Content-Length");
  7080. if (cl_range.first != cl_range.second) {
  7081. const auto &first_val = cl_range.first->second;
  7082. for (auto it = std::next(cl_range.first); it != cl_range.second; ++it) {
  7083. if (it->second != first_val) { return false; }
  7084. }
  7085. }
  7086. return true;
  7087. }
  7088. // Parsed by hand: std::regex_match recurses once per character of the reason
  7089. // phrase, which a server can make as long as a whole line.
  7090. inline bool parse_status_line(const char *line, std::string &version,
  7091. int &status, std::string &reason) {
  7092. if (std::strncmp(line, "HTTP/1.", 7) != 0 ||
  7093. (line[7] != '0' && line[7] != '1') || line[8] != ' ' ||
  7094. !is_ascii_digit(line[9]) || !is_ascii_digit(line[10]) ||
  7095. !is_ascii_digit(line[11])) {
  7096. return false;
  7097. }
  7098. auto p = line + 12;
  7099. auto reason_begin = p;
  7100. if (*p == ' ') {
  7101. reason_begin = ++p;
  7102. p += std::strcspn(p, "\r\n");
  7103. }
  7104. auto reason_end = p;
  7105. #ifdef CPPHTTPLIB_ALLOW_LF_AS_LINE_TERMINATOR
  7106. if (*p == '\r') { p++; }
  7107. #else
  7108. if (*p++ != '\r') { return false; }
  7109. #endif
  7110. if (*p++ != '\n' || *p != '\0') { return false; }
  7111. version.assign(line, 8);
  7112. status = (line[9] - '0') * 100 + (line[10] - '0') * 10 + (line[11] - '0');
  7113. reason.assign(reason_begin, reason_end);
  7114. return true;
  7115. }
  7116. // Everything WebSocketClient::connect() reports about the upgrade exchange.
  7117. // status stays -1 until a status line is parsed, mirroring stream::Result.
  7118. struct WebSocketUpgradeResponse {
  7119. Error error = Error::Success;
  7120. int status = -1;
  7121. Headers headers;
  7122. std::string selected_subprotocol;
  7123. };
  7124. // Reads a response's status line and headers, leaving any body unread. An
  7125. // unparsable status line is no stream error; it just leaves `status` as is.
  7126. inline bool read_response_head(Stream &strm, int &status, Headers &headers) {
  7127. const auto bufsiz = 2048;
  7128. char buf[bufsiz];
  7129. stream_line_reader line_reader(strm, buf, bufsiz);
  7130. if (!line_reader.getline()) { return false; }
  7131. std::string version;
  7132. std::string reason;
  7133. if (!parse_status_line(line_reader.ptr(), version, status, reason)) {
  7134. return true;
  7135. }
  7136. return read_headers(strm, headers);
  7137. }
  7138. inline bool
  7139. read_websocket_upgrade_response(Stream &strm,
  7140. const std::string &expected_accept,
  7141. const std::string &offered_subprotocols,
  7142. WebSocketUpgradeResponse &upgrade) {
  7143. // The headers of a rejection are kept so the caller can see why the server
  7144. // refused the upgrade.
  7145. if (!read_response_head(strm, upgrade.status, upgrade.headers)) {
  7146. upgrade.error = Error::Read;
  7147. return false;
  7148. }
  7149. const auto &headers = upgrade.headers;
  7150. if (upgrade.status != StatusCode::SwitchingProtocol_101) {
  7151. upgrade.error = Error::WebSocketHandshake;
  7152. return false;
  7153. }
  7154. // Verify Upgrade: websocket (a comma-separated list, matched per token)
  7155. if (!has_header_token(headers, "Upgrade", "websocket")) {
  7156. upgrade.error = Error::WebSocketHandshake;
  7157. return false;
  7158. }
  7159. // Verify Connection: Upgrade
  7160. if (!has_header_token(headers, "Connection", "upgrade")) {
  7161. upgrade.error = Error::WebSocketHandshake;
  7162. return false;
  7163. }
  7164. // Verify Sec-WebSocket-Accept header value
  7165. auto it = headers.find("Sec-WebSocket-Accept");
  7166. if (it == headers.end() || it->second != expected_accept) {
  7167. upgrade.error = Error::WebSocketHandshake;
  7168. return false;
  7169. }
  7170. // Extract negotiated subprotocol
  7171. auto proto_it = headers.find("Sec-WebSocket-Protocol");
  7172. if (proto_it != headers.end()) {
  7173. upgrade.selected_subprotocol = proto_it->second;
  7174. }
  7175. // Verify the subprotocol is one the client offered (RFC 6455 4.1)
  7176. if (!upgrade.selected_subprotocol.empty()) {
  7177. auto was_offered = false;
  7178. split(offered_subprotocols.data(),
  7179. offered_subprotocols.data() + offered_subprotocols.size(), ',',
  7180. [&](const char *b, const char *e) {
  7181. if (std::string(b, e) == upgrade.selected_subprotocol) {
  7182. was_offered = true;
  7183. }
  7184. });
  7185. if (!was_offered) {
  7186. upgrade.error = Error::WebSocketHandshake;
  7187. return false;
  7188. }
  7189. }
  7190. return true;
  7191. }
  7192. enum class ReadContentResult {
  7193. Success, // Successfully read the content
  7194. PayloadTooLarge, // The content exceeds the specified payload limit
  7195. Error // An error occurred while reading the content
  7196. };
  7197. inline ReadContentResult read_content_with_length(
  7198. Stream &strm, size_t len, DownloadProgress progress,
  7199. ContentReceiverWithProgress out,
  7200. size_t payload_max_length = (std::numeric_limits<size_t>::max)()) {
  7201. char buf[CPPHTTPLIB_RECV_BUFSIZ];
  7202. detail::BodyReader br;
  7203. br.stream = &strm;
  7204. br.has_content_length = true;
  7205. br.content_length = len;
  7206. br.payload_max_length = payload_max_length;
  7207. br.chunked = false;
  7208. br.bytes_read = 0;
  7209. br.last_error = Error::Success;
  7210. size_t r = 0;
  7211. while (r < len) {
  7212. auto read_len = static_cast<size_t>(len - r);
  7213. auto to_read = (std::min)(read_len, CPPHTTPLIB_RECV_BUFSIZ);
  7214. auto n = detail::read_body_content(&strm, br, buf, to_read);
  7215. if (n <= 0) {
  7216. // Check if it was a payload size error
  7217. if (br.last_error == Error::ExceedMaxPayloadSize) {
  7218. return ReadContentResult::PayloadTooLarge;
  7219. }
  7220. return ReadContentResult::Error;
  7221. }
  7222. if (!out(buf, static_cast<size_t>(n), r, len)) {
  7223. return ReadContentResult::Error;
  7224. }
  7225. r += static_cast<size_t>(n);
  7226. if (progress) {
  7227. if (!progress(r, len)) { return ReadContentResult::Error; }
  7228. }
  7229. }
  7230. return ReadContentResult::Success;
  7231. }
  7232. inline ReadContentResult
  7233. read_content_without_length(Stream &strm, size_t payload_max_length,
  7234. ContentReceiverWithProgress out) {
  7235. char buf[CPPHTTPLIB_RECV_BUFSIZ];
  7236. size_t r = 0;
  7237. for (;;) {
  7238. auto n = strm.read(buf, CPPHTTPLIB_RECV_BUFSIZ);
  7239. if (n == 0) { return ReadContentResult::Success; }
  7240. if (n < 0) { return ReadContentResult::Error; }
  7241. // Check if adding this data would exceed the payload limit
  7242. if (payload_max_length > 0 &&
  7243. (r > payload_max_length ||
  7244. payload_max_length - r < static_cast<size_t>(n))) {
  7245. return ReadContentResult::PayloadTooLarge;
  7246. }
  7247. if (!out(buf, static_cast<size_t>(n), r, 0)) {
  7248. return ReadContentResult::Error;
  7249. }
  7250. r += static_cast<size_t>(n);
  7251. }
  7252. return ReadContentResult::Success;
  7253. }
  7254. template <typename T>
  7255. inline ReadContentResult read_content_chunked(Stream &strm, T &x,
  7256. size_t payload_max_length,
  7257. ContentReceiverWithProgress out) {
  7258. detail::ChunkedDecoder dec(strm);
  7259. char buf[CPPHTTPLIB_RECV_BUFSIZ];
  7260. size_t total_len = 0;
  7261. for (;;) {
  7262. size_t chunk_offset = 0;
  7263. size_t chunk_total = 0;
  7264. auto n = dec.read_payload(buf, sizeof(buf), chunk_offset, chunk_total);
  7265. if (n < 0) { return ReadContentResult::Error; }
  7266. if (n == 0) {
  7267. if (!dec.parse_trailers_into(x.trailers, x.headers)) {
  7268. return ReadContentResult::Error;
  7269. }
  7270. return ReadContentResult::Success;
  7271. }
  7272. if (payload_max_length > 0 &&
  7273. (total_len > payload_max_length ||
  7274. payload_max_length - total_len < static_cast<size_t>(n))) {
  7275. return ReadContentResult::PayloadTooLarge;
  7276. }
  7277. if (!out(buf, static_cast<size_t>(n), chunk_offset, chunk_total)) {
  7278. return ReadContentResult::Error;
  7279. }
  7280. total_len += static_cast<size_t>(n);
  7281. }
  7282. }
  7283. inline bool is_chunked_transfer_encoding(const Headers &headers) {
  7284. // RFC 9112 6.1: a message is framed with the chunked coding when "chunked"
  7285. // is the final transfer coding. A single field value may list several
  7286. // codings ("gzip, chunked"), and RFC 9110 5.3 lets that list be split across
  7287. // several Transfer-Encoding lines, which combine into one comma-separated
  7288. // list in the order the lines were received. Headers preserves that order,
  7289. // so the final coding is the last token of the last line. Match it
  7290. // case-insensitively rather than comparing the whole value against
  7291. // "chunked".
  7292. //
  7293. // Security: reading a chunked message as unframed leaves its body in the
  7294. // socket, where a keep-alive connection parses it as a smuggled request.
  7295. // Server::process_request() answers 400 and closes when the final coding is
  7296. // not chunked, so a request whose framing cannot be determined never
  7297. // reaches the "no body" path.
  7298. auto rng = headers.equal_range("Transfer-Encoding");
  7299. if (rng.first == rng.second) { return false; }
  7300. // Cleared per line, so a trailing line carrying no coding at all leaves the
  7301. // combined list ending in nothing rather than inheriting the line before it.
  7302. std::string last_coding;
  7303. for (auto it = rng.first; it != rng.second; ++it) {
  7304. const auto &value = it->second;
  7305. last_coding.clear();
  7306. split(value.data(), value.data() + value.size(), ',',
  7307. [&](const char *b, const char *e) { last_coding.assign(b, e); });
  7308. }
  7309. return case_ignore::equal(last_coding, "chunked");
  7310. }
  7311. // RFC 9112 6.1: a message framed by Transfer-Encoding next to a Content-Length,
  7312. // or in HTTP/1.0, leaves the connection unfit to carry another one.
  7313. template <typename T> inline bool has_faulty_transfer_encoding(const T &msg) {
  7314. return msg.has_header("Transfer-Encoding") &&
  7315. (msg.has_header("Content-Length") || msg.version == "HTTP/1.0");
  7316. }
  7317. inline bool has_conflicting_content_length(const Headers &headers) {
  7318. // RFC 9112 §6.3: a message carrying both Transfer-Encoding and a non-zero
  7319. // Content-Length is framed ambiguously. The body readers here delimit it by
  7320. // the transfer coding and drop Content-Length, while an intermediary may do
  7321. // the reverse, so the two disagree on where the body ends and a reused
  7322. // connection is desynchronised (request/response smuggling). Content-Length:
  7323. // 0 is tolerated for compatibility with existing peers.
  7324. return has_header(headers, "Transfer-Encoding") &&
  7325. get_header_value_u64(headers, "Content-Length", 0, 0) > 0;
  7326. }
  7327. template <typename T, typename U>
  7328. bool prepare_content_receiver(T &x, int &status,
  7329. ContentReceiverWithProgress receiver,
  7330. bool decompress, size_t payload_max_length,
  7331. bool &exceed_payload_max_length, U callback) {
  7332. if (decompress) {
  7333. auto encoding = get_combined_header_value(x.headers, "Content-Encoding");
  7334. std::unique_ptr<decompressor> decompressor;
  7335. if (!encoding.empty()) {
  7336. // A coding we know about but were not built with is an error. An
  7337. // unrecognized coding (including "identity") is left alone and the
  7338. // payload is passed through as-is, since some servers misuse the header,
  7339. // e.g. by sending a character set such as "Content-Encoding: UTF-8".
  7340. decompressor = detail::create_decompressor(encoding);
  7341. if (!decompressor && detail::is_known_content_encoding(encoding)) {
  7342. status = StatusCode::UnsupportedMediaType_415;
  7343. return false;
  7344. }
  7345. }
  7346. if (decompressor) {
  7347. if (decompressor->is_valid()) {
  7348. size_t decompressed_size = 0;
  7349. ContentReceiverWithProgress out = [&](const char *buf, size_t n,
  7350. size_t off, size_t len) {
  7351. return decompressor->decompress(
  7352. buf, n, [&](const char *buf2, size_t n2) {
  7353. // Guard against zip-bomb: check
  7354. // decompressed size against limit.
  7355. if (payload_max_length > 0 &&
  7356. (decompressed_size >= payload_max_length ||
  7357. n2 > payload_max_length - decompressed_size)) {
  7358. exceed_payload_max_length = true;
  7359. return false;
  7360. }
  7361. decompressed_size += n2;
  7362. return receiver(buf2, n2, off, len);
  7363. });
  7364. };
  7365. return callback(std::move(out));
  7366. } else {
  7367. status = StatusCode::InternalServerError_500;
  7368. return false;
  7369. }
  7370. }
  7371. }
  7372. ContentReceiverWithProgress out = [&](const char *buf, size_t n, size_t off,
  7373. size_t len) {
  7374. return receiver(buf, n, off, len);
  7375. };
  7376. return callback(std::move(out));
  7377. }
  7378. template <typename T>
  7379. bool read_content(Stream &strm, T &x, size_t payload_max_length, int &status,
  7380. DownloadProgress progress,
  7381. ContentReceiverWithProgress receiver, bool decompress) {
  7382. bool exceed_payload_max_length = false;
  7383. return prepare_content_receiver(
  7384. x, status, std::move(receiver), decompress, payload_max_length,
  7385. exceed_payload_max_length, [&](const ContentReceiverWithProgress &out) {
  7386. auto ret = true;
  7387. // Note: exceed_payload_max_length may also be set by the decompressor
  7388. // wrapper in prepare_content_receiver when the decompressed payload
  7389. // size exceeds the limit.
  7390. if (is_chunked_transfer_encoding(x.headers)) {
  7391. auto result = read_content_chunked(strm, x, payload_max_length, out);
  7392. if (result == ReadContentResult::Success) {
  7393. ret = true;
  7394. } else if (result == ReadContentResult::PayloadTooLarge) {
  7395. exceed_payload_max_length = true;
  7396. ret = false;
  7397. } else {
  7398. ret = false;
  7399. }
  7400. } else if (!has_header(x.headers, "Content-Length")) {
  7401. auto result =
  7402. read_content_without_length(strm, payload_max_length, out);
  7403. if (result == ReadContentResult::Success) {
  7404. ret = true;
  7405. } else if (result == ReadContentResult::PayloadTooLarge) {
  7406. exceed_payload_max_length = true;
  7407. ret = false;
  7408. } else {
  7409. ret = false;
  7410. }
  7411. } else {
  7412. auto is_invalid_value = false;
  7413. auto len = get_header_value_u64(x.headers, "Content-Length",
  7414. (std::numeric_limits<size_t>::max)(),
  7415. 0, is_invalid_value);
  7416. if (is_invalid_value) {
  7417. ret = false;
  7418. } else if (len > 0) {
  7419. auto result = read_content_with_length(
  7420. strm, len, std::move(progress), out, payload_max_length);
  7421. ret = (result == ReadContentResult::Success);
  7422. if (result == ReadContentResult::PayloadTooLarge) {
  7423. exceed_payload_max_length = true;
  7424. }
  7425. }
  7426. }
  7427. if (!ret) {
  7428. status = exceed_payload_max_length ? StatusCode::PayloadTooLarge_413
  7429. : StatusCode::BadRequest_400;
  7430. }
  7431. return ret;
  7432. });
  7433. }
  7434. inline ssize_t write_request_line(Stream &strm, const std::string &method,
  7435. const std::string &path) {
  7436. // Neither the method nor the request target may carry CR/LF, SP or other
  7437. // control octets; otherwise a value smuggled into either splits the request
  7438. // line and injects headers or a whole request.
  7439. if (!fields::is_token(method)) { return -1; }
  7440. if (!fields::is_request_target(path)) { return -1; }
  7441. std::string s = method;
  7442. s += ' ';
  7443. s += path;
  7444. s += " HTTP/1.1\r\n";
  7445. return strm.write(s.data(), s.size());
  7446. }
  7447. inline ssize_t write_response_line(Stream &strm, int status) {
  7448. std::string s = "HTTP/1.1 ";
  7449. s += std::to_string(status);
  7450. s += ' ';
  7451. s += httplib::status_message(status);
  7452. s += "\r\n";
  7453. return strm.write(s.data(), s.size());
  7454. }
  7455. inline ssize_t write_headers(Stream &strm, const Headers &headers) {
  7456. ssize_t write_len = 0;
  7457. for (const auto &x : headers) {
  7458. // Skip fields with invalid names or values to prevent response splitting
  7459. // via CR/LF injection, matching set_header(). The client validates request
  7460. // headers up front in check_and_write_headers, but the server passes
  7461. // res.headers straight to this writer, and res.headers is a public field
  7462. // an application can populate directly with request-derived values.
  7463. if (!fields::is_field_valid(x.first, x.second)) { continue; }
  7464. std::string s;
  7465. s = x.first;
  7466. s += ": ";
  7467. s += x.second;
  7468. s += "\r\n";
  7469. auto len = strm.write(s.data(), s.size());
  7470. if (len < 0) { return len; }
  7471. write_len += len;
  7472. }
  7473. auto len = strm.write("\r\n");
  7474. if (len < 0) { return len; }
  7475. write_len += len;
  7476. return write_len;
  7477. }
  7478. inline bool write_data(Stream &strm, const char *d, size_t l) {
  7479. size_t offset = 0;
  7480. while (offset < l) {
  7481. auto length = strm.write(d + offset, l - offset);
  7482. if (length < 0) { return false; }
  7483. offset += static_cast<size_t>(length);
  7484. }
  7485. return true;
  7486. }
  7487. template <typename T>
  7488. inline bool write_content_with_progress(Stream &strm,
  7489. const ContentProvider &content_provider,
  7490. size_t offset, size_t length,
  7491. T is_shutting_down,
  7492. const UploadProgress &upload_progress,
  7493. Error &error) {
  7494. size_t end_offset = offset + length;
  7495. size_t start_offset = offset;
  7496. auto ok = true;
  7497. auto finished = false;
  7498. DataSink data_sink;
  7499. data_sink.write = [&](const char *d, size_t l) -> bool {
  7500. if (ok) {
  7501. // Bytes past `length` would follow the framed body, where the peer reads
  7502. // them as the next message. Write only what fits and fail the rest.
  7503. if (l > end_offset - offset) {
  7504. l = end_offset - offset;
  7505. ok = false;
  7506. }
  7507. if (write_data(strm, d, l)) {
  7508. offset += l;
  7509. if (upload_progress && length > 0) {
  7510. size_t current_written = offset - start_offset;
  7511. if (!upload_progress(current_written, length)) {
  7512. ok = false;
  7513. return false;
  7514. }
  7515. }
  7516. } else {
  7517. ok = false;
  7518. }
  7519. }
  7520. return ok;
  7521. };
  7522. data_sink.is_writable = [&]() -> bool { return strm.is_peer_alive(); };
  7523. // The body is framed by `length`, so a provider that reports itself done
  7524. // early has truncated it. Record that and let the short-body check below
  7525. // fail the write, rather than calling the provider again forever.
  7526. data_sink.done = [&]() { finished = true; };
  7527. while (offset < end_offset && !finished && !is_shutting_down()) {
  7528. auto last_offset = offset;
  7529. if (!strm.wait_writable() || !strm.is_peer_alive()) {
  7530. error = Error::Write;
  7531. return false;
  7532. } else if (!content_provider(offset, end_offset - offset, data_sink)) {
  7533. error = Error::Canceled;
  7534. return false;
  7535. } else if (!ok) {
  7536. error = Error::Write;
  7537. return false;
  7538. }
  7539. // A provider that reports success without writing anything and without
  7540. // reporting itself done gets handed the same offset and length again on
  7541. // the next pass, so it would spin here for as long as the peer stays
  7542. // connected. Treat making no progress as a short body, like done() early.
  7543. if (!finished && offset == last_offset) {
  7544. error = Error::Write;
  7545. return false;
  7546. }
  7547. }
  7548. if (offset < end_offset) { // done() called early, or is_shutting_down()
  7549. error = Error::Write;
  7550. return false;
  7551. }
  7552. error = Error::Success;
  7553. return true;
  7554. }
  7555. template <typename T>
  7556. inline bool write_content(Stream &strm, const ContentProvider &content_provider,
  7557. size_t offset, size_t length, T is_shutting_down,
  7558. Error &error) {
  7559. return write_content_with_progress<T>(strm, content_provider, offset, length,
  7560. is_shutting_down, nullptr, error);
  7561. }
  7562. template <typename T>
  7563. inline bool write_content(Stream &strm, const ContentProvider &content_provider,
  7564. size_t offset, size_t length,
  7565. const T &is_shutting_down) {
  7566. auto error = Error::Success;
  7567. return write_content(strm, content_provider, offset, length, is_shutting_down,
  7568. error);
  7569. }
  7570. template <typename T>
  7571. inline bool
  7572. write_content_without_length(Stream &strm,
  7573. const ContentProvider &content_provider,
  7574. const T &is_shutting_down) {
  7575. size_t offset = 0;
  7576. auto data_available = true;
  7577. auto ok = true;
  7578. DataSink data_sink;
  7579. data_sink.write = [&](const char *d, size_t l) -> bool {
  7580. if (ok) {
  7581. offset += l;
  7582. if (!write_data(strm, d, l)) { ok = false; }
  7583. }
  7584. return ok;
  7585. };
  7586. data_sink.is_writable = [&]() -> bool { return strm.is_peer_alive(); };
  7587. data_sink.done = [&](void) { data_available = false; };
  7588. while (data_available && !is_shutting_down()) {
  7589. if (!strm.wait_writable() || !strm.is_peer_alive()) {
  7590. return false;
  7591. } else if (!content_provider(offset, 0, data_sink)) {
  7592. return false;
  7593. } else if (!ok) {
  7594. return false;
  7595. }
  7596. }
  7597. return !data_available; // true only if done() was called, false if shutting
  7598. // down
  7599. }
  7600. // Runs a known-length content provider to completion and compresses what it
  7601. // writes into `out`, chunk by chunk, without holding the identity form.
  7602. inline bool compress_content_provider(const ContentProvider &content_provider,
  7603. size_t length, compressor &cmp,
  7604. std::string &out) {
  7605. size_t offset = 0;
  7606. auto ok = true;
  7607. auto finished = false;
  7608. DataSink data_sink;
  7609. auto append = [&](const char *data, size_t data_len) {
  7610. out.append(data, data_len);
  7611. return true;
  7612. };
  7613. data_sink.write = [&](const char *d, size_t l) -> bool {
  7614. if (!ok) { return false; }
  7615. offset += l;
  7616. if (l > 0 && !cmp.compress(d, l, false, append)) { ok = false; }
  7617. return ok;
  7618. };
  7619. // The body is framed by `length`, so a provider that reports itself done
  7620. // early has truncated it; the short-body check below turns that into a
  7621. // failure rather than calling the provider again forever.
  7622. data_sink.done = [&]() { finished = true; };
  7623. while (offset < length && !finished) {
  7624. auto prev_offset = offset;
  7625. if (!content_provider(offset, length - offset, data_sink) || !ok) {
  7626. return false;
  7627. }
  7628. // No Stream to block on here, so a provider that keeps returning true
  7629. // without writing would spin. Treat a pass that made no progress as a
  7630. // failure.
  7631. if (offset == prev_offset) { return false; }
  7632. }
  7633. if (offset != length) { return false; }
  7634. return cmp.compress(nullptr, 0, true, append);
  7635. }
  7636. // Serves `m` as the response body. `set_content_provider()` clears the coding
  7637. // and the file flag, so recording them has to come after; keeping all of it
  7638. // here means a third file-serving path cannot get that order wrong.
  7639. inline void set_file_content_provider(Response &res,
  7640. const std::shared_ptr<mmap> &m,
  7641. const std::string &content_type,
  7642. EncodingType encoding) {
  7643. // One read and one write move up to this much of the file at a time.
  7644. auto buf = std::make_shared<std::vector<char>>(
  7645. (std::min)(m->size(), size_t(256 * 1024)));
  7646. res.set_content_provider(
  7647. m->size(), content_type,
  7648. [m, buf](size_t offset, size_t length, DataSink &sink) -> bool {
  7649. // Never read past the file, which ends the response early if it has
  7650. // shrunk since it was opened.
  7651. auto n = m->read(offset, buf->data(), (std::min)(length, buf->size()));
  7652. if (n == 0) { return false; }
  7653. sink.write(buf->data(), n);
  7654. return true;
  7655. });
  7656. res.is_file_content_provider_ = true;
  7657. res.content_coding_ = encoding;
  7658. }
  7659. template <typename T, typename U>
  7660. inline bool
  7661. write_content_chunked(Stream &strm, const ContentProvider &content_provider,
  7662. const T &is_shutting_down, U &compressor, Error &error) {
  7663. size_t offset = 0;
  7664. auto data_available = true;
  7665. auto ok = true;
  7666. DataSink data_sink;
  7667. data_sink.write = [&](const char *d, size_t l) -> bool {
  7668. // Only done()/done_with_trailer() end a chunked body. A pass with nothing
  7669. // to hand over is ordinary (an empty buffer popped off a queue), and a
  7670. // zero-length chunk is the terminator, so it must not be emitted here.
  7671. if (ok && l > 0) {
  7672. offset += l;
  7673. std::string payload;
  7674. if (compressor.compress(d, l, false,
  7675. [&](const char *data, size_t data_len) {
  7676. payload.append(data, data_len);
  7677. return true;
  7678. })) {
  7679. if (!payload.empty()) {
  7680. // Emit chunked response header and footer for each chunk
  7681. auto chunk =
  7682. from_i_to_hex(payload.size()) + "\r\n" + payload + "\r\n";
  7683. if (!write_data(strm, chunk.data(), chunk.size())) { ok = false; }
  7684. }
  7685. } else {
  7686. ok = false;
  7687. }
  7688. }
  7689. return ok;
  7690. };
  7691. data_sink.is_writable = [&]() -> bool { return strm.is_peer_alive(); };
  7692. auto done_with_trailer = [&](const Headers *trailer) {
  7693. if (!ok) { return; }
  7694. data_available = false;
  7695. std::string payload;
  7696. if (!compressor.compress(nullptr, 0, true,
  7697. [&](const char *data, size_t data_len) {
  7698. payload.append(data, data_len);
  7699. return true;
  7700. })) {
  7701. ok = false;
  7702. return;
  7703. }
  7704. if (!payload.empty()) {
  7705. // Emit chunked response header and footer for each chunk
  7706. auto chunk = from_i_to_hex(payload.size()) + "\r\n" + payload + "\r\n";
  7707. if (!write_data(strm, chunk.data(), chunk.size())) {
  7708. ok = false;
  7709. return;
  7710. }
  7711. }
  7712. constexpr const char done_marker[] = "0\r\n";
  7713. if (!write_data(strm, done_marker, str_len(done_marker))) { ok = false; }
  7714. // Trailer
  7715. if (trailer) {
  7716. for (const auto &kv : *trailer) {
  7717. // Skip fields with invalid names or values to prevent response
  7718. // splitting via CR/LF injection, matching set_header().
  7719. if (!fields::is_field_valid(kv.first, kv.second)) { continue; }
  7720. std::string field_line = kv.first + ": " + kv.second + "\r\n";
  7721. if (!write_data(strm, field_line.data(), field_line.size())) {
  7722. ok = false;
  7723. }
  7724. }
  7725. }
  7726. constexpr const char crlf[] = "\r\n";
  7727. if (!write_data(strm, crlf, str_len(crlf))) { ok = false; }
  7728. };
  7729. data_sink.done = [&](void) { done_with_trailer(nullptr); };
  7730. data_sink.done_with_trailer = [&](const Headers &trailer) {
  7731. done_with_trailer(&trailer);
  7732. };
  7733. while (data_available && !is_shutting_down()) {
  7734. if (!strm.wait_writable() || !strm.is_peer_alive()) {
  7735. error = Error::Write;
  7736. return false;
  7737. } else if (!content_provider(offset, 0, data_sink)) {
  7738. error = Error::Canceled;
  7739. return false;
  7740. } else if (!ok) {
  7741. error = Error::Write;
  7742. return false;
  7743. }
  7744. }
  7745. if (data_available) { // exited due to is_shutting_down(), not done()
  7746. error = Error::Write;
  7747. return false;
  7748. }
  7749. error = Error::Success;
  7750. return true;
  7751. }
  7752. template <typename T, typename U>
  7753. inline bool write_content_chunked(Stream &strm,
  7754. const ContentProvider &content_provider,
  7755. const T &is_shutting_down, U &compressor) {
  7756. auto error = Error::Success;
  7757. return write_content_chunked(strm, content_provider, is_shutting_down,
  7758. compressor, error);
  7759. }
  7760. template <typename T>
  7761. inline bool redirect(T &cli, Request &req, Response &res,
  7762. const std::string &path, const std::string &location,
  7763. Error &error) {
  7764. Request new_req = req;
  7765. new_req.path = path;
  7766. new_req.redirect_count_ -= 1;
  7767. if (res.status == StatusCode::SeeOther_303 &&
  7768. (req.method != "GET" && req.method != "HEAD")) {
  7769. new_req.method = "GET";
  7770. new_req.body.clear();
  7771. new_req.headers.clear();
  7772. new_req.content_length_ = 0;
  7773. new_req.content_provider_ = nullptr;
  7774. new_req.is_chunked_content_provider_ = false;
  7775. }
  7776. Response new_res;
  7777. auto ret = cli.send(new_req, new_res, error);
  7778. if (ret) {
  7779. req = std::move(new_req);
  7780. res = std::move(new_res);
  7781. if (res.location.empty()) { res.location = location; }
  7782. }
  7783. return ret;
  7784. }
  7785. inline std::string params_to_query_str(const Params &params) {
  7786. std::string query;
  7787. for (auto it = params.begin(); it != params.end(); ++it) {
  7788. if (it != params.begin()) { query += '&'; }
  7789. query += encode_query_component(it->first);
  7790. query += '=';
  7791. query += encode_query_component(it->second);
  7792. }
  7793. return query;
  7794. }
  7795. // Splits one "key=value" span of a query string at its first '='. A span with
  7796. // no '=' at all lands entirely in key, leaving val empty, which is how a bare
  7797. // "?flag" keeps its name.
  7798. inline void divide_query_pair(const char *b, const char *e, std::string &key,
  7799. std::string &val) {
  7800. divide(b, static_cast<std::size_t>(e - b), '=',
  7801. [&](const char *lhs_data, std::size_t lhs_size, const char *rhs_data,
  7802. std::size_t rhs_size) {
  7803. key.assign(lhs_data, lhs_size);
  7804. val.assign(rhs_data, rhs_size);
  7805. });
  7806. }
  7807. inline void parse_query_text(const char *data, std::size_t size,
  7808. Params &params) {
  7809. std::set<std::string> cache;
  7810. split(data, data + size, '&', [&](const char *b, const char *e) {
  7811. std::string kv(b, e);
  7812. if (cache.find(kv) != cache.end()) { return; }
  7813. cache.insert(std::move(kv));
  7814. std::string key;
  7815. std::string val;
  7816. divide_query_pair(b, e, key, val);
  7817. if (!key.empty()) {
  7818. params.emplace(decode_query_component(key), decode_query_component(val));
  7819. }
  7820. });
  7821. }
  7822. inline void parse_query_text(const std::string &s, Params &params) {
  7823. parse_query_text(s.data(), s.size(), params);
  7824. }
  7825. // Normalize a query string by decoding and re-encoding each key/value pair
  7826. // while preserving the original parameter order. This avoids double-encoding
  7827. // and ensures consistent encoding. It works on the raw string rather than
  7828. // parsing into Params and re-serializing, because that round trip cannot
  7829. // reproduce the input: params_to_query_str() always emits '=', so a bare
  7830. // "flag" would come back as "flag=", and parse_query_text() drops exactly
  7831. // duplicated pairs.
  7832. inline std::string normalize_query_string(const std::string &query) {
  7833. std::string result;
  7834. split(query.data(), query.data() + query.size(), '&',
  7835. [&](const char *b, const char *e) {
  7836. std::string key;
  7837. std::string val;
  7838. divide_query_pair(b, e, key, val);
  7839. if (!key.empty()) {
  7840. auto dec_key = decode_query_component(key);
  7841. auto dec_val = decode_query_component(val);
  7842. if (!result.empty()) { result += '&'; }
  7843. result += encode_query_component(dec_key);
  7844. if (!val.empty() || std::find(b, e, '=') != e) {
  7845. result += '=';
  7846. result += encode_query_component(dec_val);
  7847. }
  7848. }
  7849. });
  7850. return result;
  7851. }
  7852. // The query of a client's path: what follows '?', up to the fragment.
  7853. inline std::string query_of(const std::string &path) {
  7854. auto fragment_pos = path.find('#');
  7855. auto query_pos = path.find('?');
  7856. return query_pos < fragment_pos
  7857. ? path.substr(query_pos + 1, fragment_pos - query_pos - 1)
  7858. : std::string();
  7859. }
  7860. // Build the request target that goes on the wire from a caller-supplied path.
  7861. // Shared by the buffered send path and the streaming API so that both put the
  7862. // same bytes in the request line for the same input.
  7863. inline std::string encode_request_target(const std::string &uri,
  7864. bool path_encode) {
  7865. // The fragment stays with the client (RFC 9110 §7.1).
  7866. auto target = uri.substr(0, uri.find('#'));
  7867. // `substr(0, npos)` yields the whole string, which is what the no-query
  7868. // case needs.
  7869. auto query_pos = target.find('?');
  7870. auto path_part = target.substr(0, query_pos);
  7871. std::string query_part;
  7872. if (query_pos != std::string::npos) {
  7873. query_part = target.substr(query_pos + 1);
  7874. }
  7875. auto result = path_encode ? encode_path(path_part) : std::move(path_part);
  7876. if (!query_part.empty()) {
  7877. // When path encoding is disabled the caller has supplied an already-encoded
  7878. // target and expects the exact bytes to be sent on the wire, so skip
  7879. // normalization for the query too. Normalizing would decode-then-re-encode
  7880. // it and corrupt pre-encoded binary payloads (e.g. turning `%20` into `+`,
  7881. // which a strict RFC 3986 server decodes back as `+`, not a space).
  7882. if (path_encode) {
  7883. auto normalized = normalize_query_string(query_part);
  7884. if (!normalized.empty()) {
  7885. result += '?';
  7886. result += normalized;
  7887. }
  7888. } else {
  7889. result += '?';
  7890. result += query_part;
  7891. }
  7892. }
  7893. return result;
  7894. }
  7895. inline bool parse_multipart_boundary(const std::string &content_type,
  7896. std::string &boundary) {
  7897. std::map<std::string, std::string> params;
  7898. extract_media_type(content_type, &params);
  7899. auto it = params.find("boundary");
  7900. if (it == params.end()) { return false; }
  7901. boundary = it->second;
  7902. // RFC 2046 5.1.1 caps a boundary at 70 characters. The parser scans the body
  7903. // for "--" + boundary, so a body crafted to repeat that delimiter's leading
  7904. // bytes costs a nearly full comparison at nearly every position: the
  7905. // boundary's length multiplies the worst-case cost of scanning a body.
  7906. return !boundary.empty() && boundary.size() <= 70;
  7907. }
  7908. inline void parse_disposition_params(const std::string &s, Params &params) {
  7909. std::set<std::string> cache;
  7910. split_unquoted(
  7911. s.data(), s.data() + s.size(), ';', [&](const char *b, const char *e) {
  7912. std::string kv(b, e);
  7913. if (cache.find(kv) != cache.end()) { return; }
  7914. cache.insert(kv);
  7915. std::string key;
  7916. std::string val;
  7917. divide_param_pair(b, e, key, val);
  7918. if (!key.empty()) {
  7919. params.emplace(trim_double_quotes_copy(key), unquote_param(val));
  7920. }
  7921. });
  7922. }
  7923. #ifdef CPPHTTPLIB_NO_EXCEPTIONS
  7924. inline bool parse_range_header(const std::string &s, Ranges &ranges) {
  7925. #else
  7926. inline bool parse_range_header(const std::string &s, Ranges &ranges) try {
  7927. #endif
  7928. auto is_valid = [](const std::string &str) {
  7929. return std::all_of(str.cbegin(), str.cend(), is_ascii_digit);
  7930. };
  7931. if (s.size() > 7 && case_ignore::equal(s.substr(0, 6), "bytes=")) {
  7932. const auto pos = static_cast<size_t>(6);
  7933. const auto len = static_cast<size_t>(s.size() - 6);
  7934. auto all_valid_ranges = true;
  7935. split(&s[pos], &s[pos + len], ',', [&](const char *b, const char *e) {
  7936. if (!all_valid_ranges) { return; }
  7937. const auto it = std::find(b, e, '-');
  7938. if (it == e) {
  7939. all_valid_ranges = false;
  7940. return;
  7941. }
  7942. const auto lhs = std::string(b, it);
  7943. const auto rhs = std::string(it + 1, e);
  7944. if (!is_valid(lhs) || !is_valid(rhs)) {
  7945. all_valid_ranges = false;
  7946. return;
  7947. }
  7948. ssize_t first = -1;
  7949. if (!lhs.empty()) {
  7950. // Reject an overflowing first-byte-pos; treating it as absent (-1)
  7951. // would turn the range into a suffix range.
  7952. auto res =
  7953. detail::from_chars(lhs.data(), lhs.data() + lhs.size(), first);
  7954. if (res.ec != std::errc{}) {
  7955. all_valid_ranges = false;
  7956. return;
  7957. }
  7958. }
  7959. ssize_t last = -1;
  7960. if (!rhs.empty()) {
  7961. // An overflowing last-byte-pos is past any content length, so keeping
  7962. // -1 ("remainder", RFC 9110 14.1.2) is correct here.
  7963. ssize_t v;
  7964. auto res = detail::from_chars(rhs.data(), rhs.data() + rhs.size(), v);
  7965. if (res.ec == std::errc{}) { last = v; }
  7966. }
  7967. if ((first == -1 && last == -1) ||
  7968. (first != -1 && last != -1 && first > last)) {
  7969. all_valid_ranges = false;
  7970. return;
  7971. }
  7972. ranges.emplace_back(first, last);
  7973. });
  7974. return all_valid_ranges && !ranges.empty();
  7975. }
  7976. return false;
  7977. #ifdef CPPHTTPLIB_NO_EXCEPTIONS
  7978. }
  7979. #else
  7980. } catch (...) { return false; }
  7981. #endif
  7982. // Removes each quoted-string, honoring a quoted-pair (RFC 9110 Section 5.6.4)
  7983. inline std::string remove_quoted_strings(const std::string &s) {
  7984. std::string out;
  7985. auto in_quotes = false;
  7986. for (size_t i = 0; i < s.size(); i++) {
  7987. if (s[i] == '"') {
  7988. in_quotes = !in_quotes;
  7989. } else if (!in_quotes) {
  7990. out += s[i];
  7991. } else if (s[i] == '\\') {
  7992. i++;
  7993. }
  7994. }
  7995. return out;
  7996. }
  7997. inline bool parse_accept_header(const std::string &s,
  7998. std::vector<std::string> &content_types) {
  7999. // Parameter values are not used here, so a quoted-string is dropped rather
  8000. // than parsed: a ',' or ';' inside one must not be read as a delimiter.
  8001. if (s.find('"') != std::string::npos) {
  8002. return parse_accept_header(remove_quoted_strings(s), content_types);
  8003. }
  8004. content_types.clear();
  8005. // Empty string is considered valid (no preference)
  8006. if (s.empty()) { return true; }
  8007. struct AcceptEntry {
  8008. std::string media_type;
  8009. double quality;
  8010. int order;
  8011. };
  8012. std::vector<AcceptEntry> entries;
  8013. int order = 0;
  8014. bool has_invalid_entry = false;
  8015. // Split by comma and parse each entry. RFC 9110 Section 5.6.1.2: a recipient
  8016. // has to parse and ignore empty list elements, so a leading, trailing or
  8017. // doubled comma must not turn a legal Accept value into 400 Bad Request.
  8018. // split() skips them, and the header length limit bounds how many a sender
  8019. // can send, so ignoring all of them cannot be used as a denial-of-service
  8020. // vector.
  8021. split(s.data(), s.data() + s.size(), ',', [&](const char *b, const char *e) {
  8022. std::string entry(b, e);
  8023. entry = trim_copy(entry);
  8024. AcceptEntry accept_entry;
  8025. accept_entry.order = order++;
  8026. if (!parse_quality(entry.data(), entry.data() + entry.size(),
  8027. accept_entry.media_type, accept_entry.quality)) {
  8028. has_invalid_entry = true;
  8029. return;
  8030. }
  8031. // Remove additional parameters from media type
  8032. accept_entry.media_type = extract_media_type(accept_entry.media_type);
  8033. // Basic validation of media type format
  8034. if (accept_entry.media_type.empty()) {
  8035. has_invalid_entry = true;
  8036. return;
  8037. }
  8038. // Check for basic media type format (should contain '/' or be '*')
  8039. if (accept_entry.media_type != "*" &&
  8040. accept_entry.media_type.find('/') == std::string::npos) {
  8041. has_invalid_entry = true;
  8042. return;
  8043. }
  8044. entries.push_back(std::move(accept_entry));
  8045. });
  8046. // Return false if any invalid entry was found
  8047. if (has_invalid_entry) { return false; }
  8048. // Sort by quality (descending), then by original order (ascending)
  8049. std::sort(entries.begin(), entries.end(),
  8050. [](const AcceptEntry &a, const AcceptEntry &b) {
  8051. if (a.quality != b.quality) {
  8052. return a.quality > b.quality; // Higher quality first
  8053. }
  8054. return a.order < b.order; // Earlier order first for same quality
  8055. });
  8056. // Extract sorted media types
  8057. content_types.reserve(entries.size());
  8058. for (auto &entry : entries) {
  8059. content_types.push_back(std::move(entry.media_type));
  8060. }
  8061. return true;
  8062. }
  8063. class FormDataParser {
  8064. public:
  8065. FormDataParser() = default;
  8066. void set_boundary(std::string &&boundary) {
  8067. boundary_ = std::move(boundary);
  8068. dash_boundary_crlf_ = dash_ + boundary_ + crlf_;
  8069. crlf_dash_boundary_ = crlf_ + dash_ + boundary_;
  8070. }
  8071. bool is_valid() const { return is_valid_; }
  8072. bool parse(const char *buf, size_t n, const FormDataHeader &header_callback,
  8073. const ContentReceiver &content_callback) {
  8074. // Once the close delimiter has been seen the rest of the body is epilogue
  8075. // to be discarded (RFC 2046). Drop it without buffering so a large epilogue
  8076. // spread across reads is not copied in only to be erased right away.
  8077. if (state_ == 5) { return true; }
  8078. buf_append(buf, n);
  8079. while (buf_size() > 0) {
  8080. switch (state_) {
  8081. case 0: { // Initial boundary
  8082. auto pos = buf_find(dash_boundary_crlf_);
  8083. if (pos == buf_size()) {
  8084. // Not found yet: keep only a possible partial boundary at the tail so
  8085. // that a body which never contains the boundary cannot grow the
  8086. // buffer (and get rescanned from the start) without bound.
  8087. auto keep = dash_boundary_crlf_.size() - 1;
  8088. if (buf_size() > keep) { buf_erase(buf_size() - keep); }
  8089. return true;
  8090. }
  8091. buf_erase(pos + dash_boundary_crlf_.size());
  8092. state_ = 1;
  8093. break;
  8094. }
  8095. case 1: { // New entry
  8096. clear_file_info();
  8097. header_searched_ = 0;
  8098. state_ = 2;
  8099. break;
  8100. }
  8101. case 2: { // Headers
  8102. // Resume where the last call stopped looking, so that a line arriving
  8103. // a few bytes at a time is not searched from its start each time.
  8104. auto pos = buf_find(crlf_, header_searched_);
  8105. if (pos > CPPHTTPLIB_HEADER_MAX_LENGTH) { return false; }
  8106. while (pos < buf_size()) {
  8107. // Empty line
  8108. if (pos == 0) {
  8109. if (!header_callback(file_)) {
  8110. is_valid_ = false;
  8111. return false;
  8112. }
  8113. buf_erase(crlf_.size());
  8114. state_ = 3;
  8115. break;
  8116. }
  8117. // Check header count limit
  8118. if (header_count_ >= CPPHTTPLIB_HEADER_MAX_COUNT) {
  8119. is_valid_ = false;
  8120. return false;
  8121. }
  8122. header_count_++;
  8123. const auto header = buf_head(pos);
  8124. if (!parse_header(header.data(), header.data() + header.size(),
  8125. [&](const std::string &, const std::string &) {})) {
  8126. is_valid_ = false;
  8127. return false;
  8128. }
  8129. // Parse and emplace space trimmed headers into a map
  8130. if (!parse_header(
  8131. header.data(), header.data() + header.size(),
  8132. [&](const std::string &key, const std::string &val) {
  8133. file_.headers.emplace(key, val);
  8134. })) {
  8135. is_valid_ = false;
  8136. return false;
  8137. }
  8138. constexpr const char header_content_type[] = "Content-Type:";
  8139. if (start_with_case_ignore(header, header_content_type)) {
  8140. file_.content_type =
  8141. trim_copy(header.substr(str_len(header_content_type)));
  8142. } else {
  8143. std::string disposition_params;
  8144. if (parse_content_disposition(header, disposition_params)) {
  8145. Params params;
  8146. parse_disposition_params(disposition_params, params);
  8147. auto it = params.find("name");
  8148. if (it != params.end()) {
  8149. file_.name = it->second;
  8150. } else {
  8151. is_valid_ = false;
  8152. return false;
  8153. }
  8154. it = params.find("filename");
  8155. if (it != params.end()) { file_.filename = it->second; }
  8156. it = params.find("filename*");
  8157. if (it != params.end()) {
  8158. // RFC 5987: only UTF-8 encoding is allowed
  8159. const auto &val = it->second;
  8160. constexpr const char utf8_prefix[] = "UTF-8''";
  8161. constexpr size_t prefix_len = str_len(utf8_prefix);
  8162. if (val.size() > prefix_len &&
  8163. start_with_case_ignore(val, utf8_prefix)) {
  8164. file_.filename = decode_path_component(
  8165. val.substr(prefix_len)); // override...
  8166. } else {
  8167. is_valid_ = false;
  8168. return false;
  8169. }
  8170. }
  8171. }
  8172. }
  8173. buf_erase(pos + crlf_.size());
  8174. pos = buf_find(crlf_);
  8175. }
  8176. if (state_ != 3) {
  8177. // The CR of the CRLF may be the last byte so far.
  8178. header_searched_ = buf_size() > 0 ? buf_size() - 1 : 0;
  8179. return true;
  8180. }
  8181. break;
  8182. }
  8183. case 3: { // Body
  8184. if (crlf_dash_boundary_.size() > buf_size()) { return true; }
  8185. auto pos = buf_find(crlf_dash_boundary_);
  8186. if (pos < buf_size()) {
  8187. if (!content_callback(buf_data(), pos)) {
  8188. is_valid_ = false;
  8189. return false;
  8190. }
  8191. buf_erase(pos + crlf_dash_boundary_.size());
  8192. state_ = 4;
  8193. } else {
  8194. auto len = buf_size() - crlf_dash_boundary_.size();
  8195. if (len > 0) {
  8196. if (!content_callback(buf_data(), len)) {
  8197. is_valid_ = false;
  8198. return false;
  8199. }
  8200. buf_erase(len);
  8201. }
  8202. return true;
  8203. }
  8204. break;
  8205. }
  8206. case 4: { // Boundary
  8207. if (crlf_.size() > buf_size()) { return true; }
  8208. if (buf_start_with(crlf_)) {
  8209. buf_erase(crlf_.size());
  8210. state_ = 1;
  8211. } else if (buf_start_with(dash_)) {
  8212. buf_erase(dash_.size());
  8213. is_valid_ = true;
  8214. state_ = 5;
  8215. } else {
  8216. // Only CRLF (another part follows) and "--" (close-delimiter) are
  8217. // accepted after a boundary; RFC 2046 allows transport-padding in
  8218. // between, but this parser has never supported it. Either way the
  8219. // body is already destined to be rejected, so fail now instead of
  8220. // buffering the rest of it. Both are two bytes, so the check above
  8221. // already guarantees enough buffered data to decide.
  8222. is_valid_ = false;
  8223. return false;
  8224. }
  8225. break;
  8226. }
  8227. case 5: { // Epilogue
  8228. buf_erase(buf_size());
  8229. break;
  8230. }
  8231. }
  8232. }
  8233. return true;
  8234. }
  8235. private:
  8236. void clear_file_info() {
  8237. file_.name.clear();
  8238. file_.filename.clear();
  8239. file_.content_type.clear();
  8240. file_.headers.clear();
  8241. header_count_ = 0;
  8242. }
  8243. bool start_with_case_ignore(const std::string &a, const char *b,
  8244. size_t offset = 0) const {
  8245. const auto b_len = strlen(b);
  8246. if (a.size() < offset + b_len) { return false; }
  8247. for (size_t i = 0; i < b_len; i++) {
  8248. if (case_ignore::to_lower(a[offset + i]) != case_ignore::to_lower(b[i])) {
  8249. return false;
  8250. }
  8251. }
  8252. return true;
  8253. }
  8254. // Parses "Content-Disposition: form-data; <params>" without std::regex.
  8255. // Returns true if header matches, with the params portion in `params_out`.
  8256. bool parse_content_disposition(const std::string &header,
  8257. std::string &params_out) const {
  8258. constexpr const char prefix[] = "Content-Disposition:";
  8259. constexpr size_t prefix_len = str_len(prefix);
  8260. if (!start_with_case_ignore(header, prefix)) { return false; }
  8261. // Skip whitespace after "Content-Disposition:"
  8262. auto pos = prefix_len;
  8263. while (pos < header.size() && (header[pos] == ' ' || header[pos] == '\t')) {
  8264. pos++;
  8265. }
  8266. // Match "form-data;" (case-insensitive)
  8267. constexpr const char form_data[] = "form-data;";
  8268. constexpr size_t form_data_len = str_len(form_data);
  8269. if (!start_with_case_ignore(header, form_data, pos)) { return false; }
  8270. pos += form_data_len;
  8271. // Skip whitespace after "form-data;"
  8272. while (pos < header.size() && (header[pos] == ' ' || header[pos] == '\t')) {
  8273. pos++;
  8274. }
  8275. params_out = header.substr(pos);
  8276. return true;
  8277. }
  8278. const std::string dash_ = "--";
  8279. const std::string crlf_ = "\r\n";
  8280. std::string boundary_;
  8281. std::string dash_boundary_crlf_;
  8282. std::string crlf_dash_boundary_;
  8283. size_t state_ = 0;
  8284. bool is_valid_ = false;
  8285. FormData file_;
  8286. size_t header_count_ = 0;
  8287. size_t header_searched_ = 0;
  8288. // Buffer
  8289. bool start_with(const std::string &a, size_t spos, size_t epos,
  8290. const std::string &b) const {
  8291. if (epos - spos < b.size()) { return false; }
  8292. for (size_t i = 0; i < b.size(); i++) {
  8293. if (a[i + spos] != b[i]) { return false; }
  8294. }
  8295. return true;
  8296. }
  8297. size_t buf_size() const { return buf_epos_ - buf_spos_; }
  8298. const char *buf_data() const { return &buf_[buf_spos_]; }
  8299. std::string buf_head(size_t l) const { return buf_.substr(buf_spos_, l); }
  8300. bool buf_start_with(const std::string &s) const {
  8301. return start_with(buf_, buf_spos_, buf_epos_, s);
  8302. }
  8303. size_t buf_find(const std::string &s, size_t from = 0) const {
  8304. auto c = s.front();
  8305. size_t off = buf_spos_ + from;
  8306. while (off < buf_epos_) {
  8307. auto pos = off;
  8308. while (true) {
  8309. if (pos == buf_epos_) { return buf_size(); }
  8310. if (buf_[pos] == c) { break; }
  8311. pos++;
  8312. }
  8313. auto remaining_size = buf_epos_ - pos;
  8314. if (s.size() > remaining_size) { return buf_size(); }
  8315. if (start_with(buf_, pos, buf_epos_, s)) { return pos - buf_spos_; }
  8316. off = pos + 1;
  8317. }
  8318. return buf_size();
  8319. }
  8320. void buf_append(const char *data, size_t n) {
  8321. auto remaining_size = buf_size();
  8322. if (remaining_size > 0 && buf_spos_ > 0) {
  8323. for (size_t i = 0; i < remaining_size; i++) {
  8324. buf_[i] = buf_[buf_spos_ + i];
  8325. }
  8326. }
  8327. buf_spos_ = 0;
  8328. buf_epos_ = remaining_size;
  8329. if (remaining_size + n > buf_.size()) { buf_.resize(remaining_size + n); }
  8330. for (size_t i = 0; i < n; i++) {
  8331. buf_[buf_epos_ + i] = data[i];
  8332. }
  8333. buf_epos_ += n;
  8334. }
  8335. void buf_erase(size_t size) { buf_spos_ += size; }
  8336. std::string buf_;
  8337. size_t buf_spos_ = 0;
  8338. size_t buf_epos_ = 0;
  8339. };
  8340. inline std::string random_string(size_t length) {
  8341. constexpr const char data[] =
  8342. "0123456789ABCDEFGHIJKLMNOPQRSTUVWXYZabcdefghijklmnopqrstuvwxyz";
  8343. std::string result(length, '\0');
  8344. fill_random_bytes(reinterpret_cast<unsigned char *>(&result[0]), length);
  8345. for (auto &c : result) {
  8346. c = data[static_cast<unsigned char>(c) % (sizeof(data) - 1)];
  8347. }
  8348. return result;
  8349. }
  8350. inline std::string make_multipart_data_boundary() {
  8351. return "--cpp-httplib-multipart-data-" + detail::random_string(16);
  8352. }
  8353. inline bool is_multipart_boundary_chars_valid(const std::string &boundary) {
  8354. auto valid = true;
  8355. for (size_t i = 0; i < boundary.size(); i++) {
  8356. auto c = boundary[i];
  8357. if (!is_ascii_alnum(c) && c != '-' && c != '_') {
  8358. valid = false;
  8359. break;
  8360. }
  8361. }
  8362. return valid;
  8363. }
  8364. // Escape a multipart field name/filename following the WHATWG HTML standard
  8365. // ("escape a multipart form-data name"): '"' -> %22, CR -> %0D, LF -> %0A.
  8366. // As the value is a quoted-string, '\' -> '\\' too, which browsers leave out.
  8367. // With quoted = false, only CR and LF are escaped; this is for header values
  8368. // outside a quoted-string (e.g. Content-Type), where '"' and '\' are legal.
  8369. inline std::string escape_multipart_field(const std::string &s,
  8370. bool quoted = true) {
  8371. std::string result;
  8372. result.reserve(s.size());
  8373. for (auto c : s) {
  8374. switch (c) {
  8375. case '"':
  8376. if (quoted) {
  8377. result += "%22";
  8378. } else {
  8379. result += c;
  8380. }
  8381. break;
  8382. case '\\':
  8383. // A lone backslash would escape the character after it (RFC 9110
  8384. // 5.6.4).
  8385. if (quoted) { result += '\\'; }
  8386. result += c;
  8387. break;
  8388. case '\r': result += "%0D"; break;
  8389. case '\n': result += "%0A"; break;
  8390. default: result += c; break;
  8391. }
  8392. }
  8393. return result;
  8394. }
  8395. template <typename T>
  8396. inline std::string
  8397. serialize_multipart_formdata_item_begin(const T &item,
  8398. const std::string &boundary) {
  8399. std::string body = "--" + boundary + "\r\n";
  8400. body += "Content-Disposition: form-data; name=\"" +
  8401. escape_multipart_field(item.name) + "\"";
  8402. if (!item.filename.empty()) {
  8403. body += "; filename=\"" + escape_multipart_field(item.filename) + "\"";
  8404. }
  8405. body += "\r\n";
  8406. if (!item.content_type.empty()) {
  8407. body +=
  8408. "Content-Type: " + escape_multipart_field(item.content_type, false) +
  8409. "\r\n";
  8410. }
  8411. body += "\r\n";
  8412. return body;
  8413. }
  8414. inline std::string serialize_multipart_formdata_item_end() { return "\r\n"; }
  8415. inline std::string
  8416. serialize_multipart_formdata_finish(const std::string &boundary) {
  8417. return "--" + boundary + "--\r\n";
  8418. }
  8419. inline std::string
  8420. serialize_multipart_formdata_get_content_type(const std::string &boundary) {
  8421. return "multipart/form-data; boundary=" + boundary;
  8422. }
  8423. inline std::string
  8424. serialize_multipart_formdata(const UploadFormDataItems &items,
  8425. const std::string &boundary, bool finish = true) {
  8426. std::string body;
  8427. for (const auto &item : items) {
  8428. body += serialize_multipart_formdata_item_begin(item, boundary);
  8429. body += item.content + serialize_multipart_formdata_item_end();
  8430. }
  8431. if (finish) { body += serialize_multipart_formdata_finish(boundary); }
  8432. return body;
  8433. }
  8434. inline size_t get_multipart_content_length(const UploadFormDataItems &items,
  8435. const std::string &boundary) {
  8436. size_t total = 0;
  8437. for (const auto &item : items) {
  8438. total += serialize_multipart_formdata_item_begin(item, boundary).size();
  8439. total += item.content.size();
  8440. total += serialize_multipart_formdata_item_end().size();
  8441. }
  8442. total += serialize_multipart_formdata_finish(boundary).size();
  8443. return total;
  8444. }
  8445. struct MultipartSegment {
  8446. const char *data;
  8447. size_t size;
  8448. };
  8449. // NOTE: items must outlive the returned ContentProvider
  8450. // (safe for synchronous use inside Post/Put/Patch)
  8451. inline ContentProvider
  8452. make_multipart_content_provider(const UploadFormDataItems &items,
  8453. const std::string &boundary) {
  8454. // Own the per-item header strings and the finish string
  8455. std::vector<std::string> owned;
  8456. owned.reserve(items.size() + 1);
  8457. for (const auto &item : items)
  8458. owned.push_back(serialize_multipart_formdata_item_begin(item, boundary));
  8459. owned.push_back(serialize_multipart_formdata_finish(boundary));
  8460. // Flat segment list: [header, content, "\r\n"] * N + [finish]
  8461. std::vector<MultipartSegment> segs;
  8462. segs.reserve(items.size() * 3 + 1);
  8463. static const char crlf[] = "\r\n";
  8464. for (size_t i = 0; i < items.size(); i++) {
  8465. segs.push_back({owned[i].data(), owned[i].size()});
  8466. segs.push_back({items[i].content.data(), items[i].content.size()});
  8467. segs.push_back({crlf, 2});
  8468. }
  8469. segs.push_back({owned.back().data(), owned.back().size()});
  8470. struct MultipartState {
  8471. std::vector<std::string> owned;
  8472. std::vector<MultipartSegment> segs;
  8473. std::vector<char> buf = std::vector<char>(CPPHTTPLIB_SEND_BUFSIZ);
  8474. };
  8475. auto state = std::make_shared<MultipartState>();
  8476. state->owned = std::move(owned);
  8477. // `segs` holds raw pointers into owned strings; std::string move preserves
  8478. // the data pointer, so these pointers remain valid after the move above.
  8479. state->segs = std::move(segs);
  8480. return [state](size_t offset, size_t length, DataSink &sink) -> bool {
  8481. // Buffer multiple small segments into fewer, larger writes to avoid
  8482. // excessive TCP packets when there are many form data items (#2410)
  8483. auto &buf = state->buf;
  8484. auto buf_size = buf.size();
  8485. size_t buf_len = 0;
  8486. size_t remaining = length;
  8487. // Find the first segment containing 'offset'
  8488. size_t pos = 0;
  8489. size_t seg_idx = 0;
  8490. for (; seg_idx < state->segs.size(); seg_idx++) {
  8491. const auto &seg = state->segs[seg_idx];
  8492. if (seg.size > 0 && offset - pos < seg.size) { break; }
  8493. pos += seg.size;
  8494. }
  8495. size_t seg_offset = (seg_idx < state->segs.size()) ? offset - pos : 0;
  8496. for (; seg_idx < state->segs.size() && remaining > 0; seg_idx++) {
  8497. const auto &seg = state->segs[seg_idx];
  8498. size_t available = seg.size - seg_offset;
  8499. size_t to_copy = (std::min)(available, remaining);
  8500. const char *src = seg.data + seg_offset;
  8501. seg_offset = 0; // only the first segment has a non-zero offset
  8502. while (to_copy > 0) {
  8503. size_t space = buf_size - buf_len;
  8504. size_t chunk = (std::min)(to_copy, space);
  8505. std::memcpy(buf.data() + buf_len, src, chunk);
  8506. buf_len += chunk;
  8507. src += chunk;
  8508. to_copy -= chunk;
  8509. remaining -= chunk;
  8510. if (buf_len == buf_size) {
  8511. if (!sink.write(buf.data(), buf_len)) { return false; }
  8512. buf_len = 0;
  8513. }
  8514. }
  8515. }
  8516. if (buf_len > 0) { return sink.write(buf.data(), buf_len); }
  8517. return true;
  8518. };
  8519. }
  8520. inline void coalesce_ranges(Ranges &ranges, size_t content_length) {
  8521. if (ranges.size() <= 1) return;
  8522. // Sort ranges by start position
  8523. std::sort(ranges.begin(), ranges.end(),
  8524. [](const Range &a, const Range &b) { return a.first < b.first; });
  8525. Ranges coalesced;
  8526. coalesced.reserve(ranges.size());
  8527. for (auto &r : ranges) {
  8528. auto first_pos = r.first;
  8529. auto last_pos = r.second;
  8530. // Handle special cases like in range_error
  8531. if (first_pos == -1 && last_pos == -1) {
  8532. first_pos = 0;
  8533. last_pos = static_cast<ssize_t>(content_length);
  8534. }
  8535. if (first_pos == -1) {
  8536. first_pos = static_cast<ssize_t>(content_length) - last_pos;
  8537. last_pos = static_cast<ssize_t>(content_length) - 1;
  8538. }
  8539. if (last_pos == -1 || last_pos >= static_cast<ssize_t>(content_length)) {
  8540. last_pos = static_cast<ssize_t>(content_length) - 1;
  8541. }
  8542. // Skip invalid ranges
  8543. if (!(0 <= first_pos && first_pos <= last_pos &&
  8544. last_pos < static_cast<ssize_t>(content_length))) {
  8545. continue;
  8546. }
  8547. // Coalesce with previous range if overlapping or adjacent (but not
  8548. // identical)
  8549. if (!coalesced.empty()) {
  8550. auto &prev = coalesced.back();
  8551. // Check if current range overlaps or is adjacent to previous range
  8552. // but don't coalesce identical ranges (allow duplicates)
  8553. if (first_pos <= prev.second + 1 &&
  8554. !(first_pos == prev.first && last_pos == prev.second)) {
  8555. // Extend the previous range
  8556. prev.second = (std::max)(prev.second, last_pos);
  8557. continue;
  8558. }
  8559. }
  8560. // Add new range
  8561. coalesced.emplace_back(first_pos, last_pos);
  8562. }
  8563. ranges = std::move(coalesced);
  8564. }
  8565. inline bool range_error(Request &req, Response &res) {
  8566. if (!req.ranges.empty() && 200 <= res.status && res.status < 300) {
  8567. if (res.body.empty() && res.content_provider_ && res.content_length_ == 0) {
  8568. req.ranges.clear();
  8569. if (res.status == StatusCode::PartialContent_206) {
  8570. res.status = StatusCode::OK_200;
  8571. }
  8572. return false;
  8573. }
  8574. ssize_t content_len = static_cast<ssize_t>(
  8575. res.content_length_ ? res.content_length_ : res.body.size());
  8576. std::vector<std::pair<ssize_t, ssize_t>> processed_ranges;
  8577. size_t overwrapping_count = 0;
  8578. // NOTE: The following Range check is based on '14.2. Range' in RFC 9110
  8579. // 'HTTP Semantics' to avoid potential denial-of-service attacks.
  8580. // https://www.rfc-editor.org/rfc/rfc9110#section-14.2
  8581. // Too many ranges
  8582. if (CPPHTTPLIB_RANGE_MAX_COUNT > 0 &&
  8583. req.ranges.size() > CPPHTTPLIB_RANGE_MAX_COUNT) {
  8584. return true;
  8585. }
  8586. for (auto &r : req.ranges) {
  8587. auto &first_pos = r.first;
  8588. auto &last_pos = r.second;
  8589. if (first_pos == -1 && last_pos == -1) {
  8590. first_pos = 0;
  8591. last_pos = content_len;
  8592. }
  8593. // RFC 9110 14.1.2: a suffix-length longer than the representation
  8594. // selects the entire representation.
  8595. if (first_pos == -1) {
  8596. first_pos = (std::max)(static_cast<ssize_t>(0), content_len - last_pos);
  8597. last_pos = content_len - 1;
  8598. }
  8599. // NOTE: RFC-9110 '14.1.2. Byte Ranges':
  8600. // A client can limit the number of bytes requested without knowing the
  8601. // size of the selected representation. If the last-pos value is absent,
  8602. // or if the value is greater than or equal to the current length of the
  8603. // representation data, the byte range is interpreted as the remainder of
  8604. // the representation (i.e., the server replaces the value of last-pos
  8605. // with a value that is one less than the current length of the selected
  8606. // representation).
  8607. // https://www.rfc-editor.org/rfc/rfc9110.html#section-14.1.2-6
  8608. if (last_pos == -1 || last_pos >= content_len) {
  8609. last_pos = content_len - 1;
  8610. }
  8611. // Range must be within content length
  8612. if (!(0 <= first_pos && first_pos <= last_pos &&
  8613. last_pos <= content_len - 1)) {
  8614. return true;
  8615. }
  8616. // Request must not have more than two overlapping ranges
  8617. for (const auto &processed_range : processed_ranges) {
  8618. if (!(last_pos < processed_range.first ||
  8619. first_pos > processed_range.second)) {
  8620. overwrapping_count++;
  8621. if (overwrapping_count > 2) { return true; }
  8622. break; // Only count once per range
  8623. }
  8624. }
  8625. processed_ranges.emplace_back(first_pos, last_pos);
  8626. }
  8627. // After validation, coalesce overlapping ranges as per RFC 9110
  8628. coalesce_ranges(req.ranges, static_cast<size_t>(content_len));
  8629. }
  8630. return false;
  8631. }
  8632. inline std::pair<size_t, size_t>
  8633. get_range_offset_and_length(Range r, size_t content_length) {
  8634. assert(r.first != -1 && r.second != -1);
  8635. assert(0 <= r.first && r.first < static_cast<ssize_t>(content_length));
  8636. assert(r.first <= r.second &&
  8637. r.second < static_cast<ssize_t>(content_length));
  8638. (void)(content_length);
  8639. return std::make_pair(static_cast<size_t>(r.first),
  8640. static_cast<size_t>(r.second - r.first) + 1);
  8641. }
  8642. inline std::string make_content_range_header_field(
  8643. const std::pair<size_t, size_t> &offset_and_length, size_t content_length) {
  8644. auto st = offset_and_length.first;
  8645. auto ed = st + offset_and_length.second - 1;
  8646. std::string field = "bytes ";
  8647. field += std::to_string(st);
  8648. field += '-';
  8649. field += std::to_string(ed);
  8650. field += '/';
  8651. field += std::to_string(content_length);
  8652. return field;
  8653. }
  8654. template <typename SToken, typename CToken, typename Content>
  8655. bool process_multipart_ranges_data(const Request &req,
  8656. const std::string &boundary,
  8657. const std::string &content_type,
  8658. size_t content_length, SToken stoken,
  8659. CToken ctoken, Content content) {
  8660. for (size_t i = 0; i < req.ranges.size(); i++) {
  8661. ctoken("--");
  8662. stoken(boundary);
  8663. ctoken("\r\n");
  8664. if (!content_type.empty()) {
  8665. ctoken("Content-Type: ");
  8666. stoken(content_type);
  8667. ctoken("\r\n");
  8668. }
  8669. auto offset_and_length =
  8670. get_range_offset_and_length(req.ranges[i], content_length);
  8671. ctoken("Content-Range: ");
  8672. stoken(make_content_range_header_field(offset_and_length, content_length));
  8673. ctoken("\r\n");
  8674. ctoken("\r\n");
  8675. if (!content(offset_and_length.first, offset_and_length.second)) {
  8676. return false;
  8677. }
  8678. ctoken("\r\n");
  8679. }
  8680. ctoken("--");
  8681. stoken(boundary);
  8682. ctoken("--");
  8683. return true;
  8684. }
  8685. inline void make_multipart_ranges_data(const Request &req, Response &res,
  8686. const std::string &boundary,
  8687. const std::string &content_type,
  8688. size_t content_length,
  8689. std::string &data) {
  8690. process_multipart_ranges_data(
  8691. req, boundary, content_type, content_length,
  8692. [&](const std::string &token) { data += token; },
  8693. [&](const std::string &token) { data += token; },
  8694. [&](size_t offset, size_t length) {
  8695. assert(offset + length <= content_length);
  8696. data += res.body.substr(offset, length);
  8697. return true;
  8698. });
  8699. }
  8700. inline size_t get_multipart_ranges_data_length(const Request &req,
  8701. const std::string &boundary,
  8702. const std::string &content_type,
  8703. size_t content_length) {
  8704. size_t data_length = 0;
  8705. process_multipart_ranges_data(
  8706. req, boundary, content_type, content_length,
  8707. [&](const std::string &token) { data_length += token.size(); },
  8708. [&](const std::string &token) { data_length += token.size(); },
  8709. [&](size_t /*offset*/, size_t length) {
  8710. data_length += length;
  8711. return true;
  8712. });
  8713. return data_length;
  8714. }
  8715. template <typename T>
  8716. inline bool
  8717. write_multipart_ranges_data(Stream &strm, const Request &req, Response &res,
  8718. const std::string &boundary,
  8719. const std::string &content_type,
  8720. size_t content_length, const T &is_shutting_down) {
  8721. return process_multipart_ranges_data(
  8722. req, boundary, content_type, content_length,
  8723. [&](const std::string &token) { strm.write(token); },
  8724. [&](const std::string &token) { strm.write(token); },
  8725. [&](size_t offset, size_t length) {
  8726. return write_content(strm, res.content_provider_, offset, length,
  8727. is_shutting_down);
  8728. });
  8729. }
  8730. inline bool has_framed_body(const Request &req) {
  8731. return is_chunked_transfer_encoding(req.headers) ||
  8732. req.get_header_value_u64("Content-Length") > 0;
  8733. }
  8734. inline bool is_connection_persistent(const Request &req) {
  8735. if (has_header_token(req.headers, "Connection", "close")) { return false; }
  8736. if (req.version == "HTTP/1.0" &&
  8737. !has_header_token(req.headers, "Connection", "keep-alive")) {
  8738. return false;
  8739. }
  8740. return true;
  8741. }
  8742. inline bool expect_content(const Request &req) {
  8743. if (req.method == "POST" || req.method == "PUT" || req.method == "PATCH" ||
  8744. req.method == "DELETE") {
  8745. return true;
  8746. }
  8747. return has_framed_body(req);
  8748. }
  8749. #ifdef _WIN32
  8750. class WSInit {
  8751. public:
  8752. WSInit() {
  8753. WSADATA wsaData;
  8754. if (WSAStartup(0x0002, &wsaData) == 0) is_valid_ = true;
  8755. }
  8756. ~WSInit() {
  8757. if (is_valid_) WSACleanup();
  8758. }
  8759. bool is_valid_ = false;
  8760. };
  8761. static WSInit wsinit_;
  8762. #endif
  8763. inline std::string unescape_quoted_pairs(const std::string &s) {
  8764. std::string out;
  8765. out.reserve(s.size());
  8766. for (size_t i = 0; i < s.size(); i++) {
  8767. if (s[i] == '\\' && i + 1 < s.size()) {
  8768. out += s[++i];
  8769. } else {
  8770. out += s[i];
  8771. }
  8772. }
  8773. return out;
  8774. }
  8775. // Inverse of unescape_quoted_pairs: prepares a value to sit inside a
  8776. // quoted-string. RFC 9110 §5.6.4 requires a literal '\' or '"' to be sent as a
  8777. // quoted-pair, so the recipient recovers the original value.
  8778. inline std::string escape_quoted_pairs(const std::string &s) {
  8779. std::string out;
  8780. out.reserve(s.size());
  8781. for (auto c : s) {
  8782. if (c == '\\' || c == '"') { out += '\\'; }
  8783. out += c;
  8784. }
  8785. return out;
  8786. }
  8787. // RFC 9110 Section 11.6.1 defines a challenge list as
  8788. // WWW-Authenticate = #challenge
  8789. // challenge = auth-scheme [ 1*SP ( token68 / [ #auth-param ] ) ]
  8790. // auth-param = token BWS "=" BWS ( token / quoted-string )
  8791. // so a server may offer several schemes, each with its own comma-separated
  8792. // auth-param list, in either order and either as separate field lines or
  8793. // packed into one. Splitting on every comma would break apart a challenge's
  8794. // own param list; splitting only on the first space would miss a Digest
  8795. // challenge that isn't first. Split on commas that aren't inside a
  8796. // quoted-string instead (split_unquoted), then track which scheme each
  8797. // resulting segment belongs to: a segment whose text before "=" contains
  8798. // whitespace (or that has no "=" at all) starts a new challenge named by its
  8799. // leading token.
  8800. inline bool parse_www_authenticate(const Response &res,
  8801. std::map<std::string, std::string> &auth,
  8802. bool is_proxy) {
  8803. auto auth_key = is_proxy ? "Proxy-Authenticate" : "WWW-Authenticate";
  8804. auto combined = get_combined_header_value(res.headers, auth_key);
  8805. if (combined.empty()) { return false; }
  8806. auto found_digest = false;
  8807. auto in_digest_challenge = false;
  8808. split_unquoted(
  8809. combined.data(), combined.data() + combined.size(), ',',
  8810. [&](const char *b, const char *e) {
  8811. std::string segment(b, e);
  8812. auto eq_pos = segment.find('=');
  8813. // BWS is allowed on both sides of "=", so the text naming the key (or,
  8814. // for the first segment of a challenge, "<scheme> <key>") must be
  8815. // trimmed before its boundaries are inspected.
  8816. auto key_part = trim_copy(
  8817. eq_pos == std::string::npos ? segment : segment.substr(0, eq_pos));
  8818. auto space_pos = key_part.find_last_of(" \t");
  8819. if (space_pos != std::string::npos || eq_pos == std::string::npos) {
  8820. // "<scheme>[ <key>]" starts a new challenge.
  8821. auto scheme_end =
  8822. space_pos == std::string::npos ? key_part.size() : space_pos;
  8823. // RFC 7616 Section 3.7: a server may offer more than one Digest
  8824. // challenge (e.g. SHA-256 and MD5); keep only the first so a nonce
  8825. // from one challenge is never paired with another's algorithm.
  8826. in_digest_challenge =
  8827. !found_digest &&
  8828. case_ignore::equal(key_part.substr(0, scheme_end), "Digest");
  8829. if (in_digest_challenge) { found_digest = true; }
  8830. if (space_pos == std::string::npos) {
  8831. // Bare scheme (or a token68), no auth-param on this segment.
  8832. return;
  8833. }
  8834. key_part = key_part.substr(space_pos + 1);
  8835. }
  8836. if (!in_digest_challenge) { return; }
  8837. auto val = trim_copy(segment.substr(eq_pos + 1));
  8838. auto unquoted = trim_double_quotes_copy(val);
  8839. if (unquoted.size() != val.size()) {
  8840. unquoted = unescape_quoted_pairs(unquoted);
  8841. }
  8842. auth[std::move(key_part)] = std::move(unquoted);
  8843. });
  8844. // RFC 7616 Section 3.3 requires realm and nonce on every Digest challenge;
  8845. // make_digest_authentication_header() dereferences both unconditionally, so
  8846. // a challenge missing either can't produce a usable Authorization header.
  8847. // Treat it the same as no Digest challenge at all.
  8848. return found_digest && auth.find("realm") != auth.end() &&
  8849. auth.find("nonce") != auth.end();
  8850. }
  8851. class ContentProviderAdapter {
  8852. public:
  8853. explicit ContentProviderAdapter(
  8854. ContentProviderWithoutLength &&content_provider)
  8855. : content_provider_(std::move(content_provider)) {}
  8856. bool operator()(size_t offset, size_t, DataSink &sink) {
  8857. return content_provider_(offset, sink);
  8858. }
  8859. private:
  8860. ContentProviderWithoutLength content_provider_;
  8861. };
  8862. // NOTE: https://www.rfc-editor.org/rfc/rfc9110#section-5
  8863. namespace fields {
  8864. inline bool is_token_char(char c) {
  8865. return is_ascii_alnum(c) || c == '!' || c == '#' || c == '$' || c == '%' ||
  8866. c == '&' || c == '\'' || c == '*' || c == '+' || c == '-' ||
  8867. c == '.' || c == '^' || c == '_' || c == '`' || c == '|' || c == '~';
  8868. }
  8869. inline bool is_token(const std::string &s) {
  8870. if (s.empty()) { return false; }
  8871. for (auto c : s) {
  8872. if (!is_token_char(c)) { return false; }
  8873. }
  8874. return true;
  8875. }
  8876. inline bool is_field_name(const std::string &s) { return is_token(s); }
  8877. inline bool is_vchar(char c) { return c >= 33 && c <= 126; }
  8878. inline bool is_obs_text(char c) { return 128 <= static_cast<unsigned char>(c); }
  8879. inline bool is_field_vchar(char c) { return is_vchar(c) || is_obs_text(c); }
  8880. inline bool is_field_content(const std::string &s) {
  8881. if (s.empty()) { return true; }
  8882. if (s.size() == 1) {
  8883. return is_field_vchar(s[0]);
  8884. } else if (s.size() == 2) {
  8885. return is_field_vchar(s[0]) && is_field_vchar(s[1]);
  8886. } else {
  8887. size_t i = 0;
  8888. if (!is_field_vchar(s[i])) { return false; }
  8889. i++;
  8890. while (i < s.size() - 1) {
  8891. auto c = s[i++];
  8892. if (c == ' ' || c == '\t' || is_field_vchar(c)) {
  8893. } else {
  8894. return false;
  8895. }
  8896. }
  8897. return is_field_vchar(s[i]);
  8898. }
  8899. }
  8900. inline bool is_field_value(const std::string &s) { return is_field_content(s); }
  8901. inline bool is_field_valid(const std::string &name, const std::string &value) {
  8902. return is_field_name(name) && is_field_value(value);
  8903. }
  8904. // RFC 9112 §2.2/§3.2: the request-target has no SP, HTAB or other control
  8905. // characters (incl. bare CR). obs-text (raw UTF-8) is allowed.
  8906. inline bool is_request_target(const std::string &s) {
  8907. return std::all_of(s.begin(), s.end(), is_field_vchar);
  8908. }
  8909. // RFC 9110 §7.2: the bytes of uri-host [ ":" port ], i.e. unreserved,
  8910. // sub-delims, "%", ":" and the IP-literal brackets. An empty value is valid.
  8911. inline bool is_host(const std::string &s) {
  8912. return std::all_of(s.begin(), s.end(), [](char c) {
  8913. return is_ascii_alnum(c) || c == '-' || c == '.' || c == '_' || c == '~' ||
  8914. c == '!' || c == '$' || c == '&' || c == '\'' || c == '(' ||
  8915. c == ')' || c == '*' || c == '+' || c == ',' || c == ';' ||
  8916. c == '=' || c == '%' || c == ':' || c == '[' || c == ']';
  8917. });
  8918. }
  8919. } // namespace fields
  8920. // Built in memory first, like ClientImpl::write_request, so a rejected header
  8921. // never leaves a partial request on the wire.
  8922. inline bool write_request_head(Stream &strm, Request &req, Error &error) {
  8923. BufferStream bstrm;
  8924. if (write_request_line(bstrm, req.method, req.path) < 0) {
  8925. error = Error::Write;
  8926. return false;
  8927. }
  8928. if (!check_and_write_headers(bstrm, req.headers, write_headers, error)) {
  8929. return false;
  8930. }
  8931. const auto &data = bstrm.get_buffer();
  8932. if (!write_data(strm, data.data(), data.size())) {
  8933. error = Error::Write;
  8934. return false;
  8935. }
  8936. return true;
  8937. }
  8938. inline bool perform_websocket_handshake(Stream &strm, Request &req,
  8939. WebSocketUpgradeResponse &upgrade) {
  8940. // Generate a random 16-byte Sec-WebSocket-Key (RFC 6455 Section 4.1)
  8941. std::string key_bytes(16, '\0');
  8942. fill_random_bytes(reinterpret_cast<unsigned char *>(&key_bytes[0]),
  8943. key_bytes.size());
  8944. auto client_key = base64_encode(key_bytes);
  8945. req.headers.erase("Upgrade");
  8946. req.headers.erase("Connection");
  8947. req.headers.erase("Sec-WebSocket-Key");
  8948. req.headers.erase("Sec-WebSocket-Version");
  8949. req.headers.emplace("Upgrade", "websocket");
  8950. req.headers.emplace("Connection", "Upgrade");
  8951. req.headers.emplace("Sec-WebSocket-Key", client_key);
  8952. req.headers.emplace("Sec-WebSocket-Version", "13");
  8953. if (!write_request_head(strm, req, upgrade.error)) { return false; }
  8954. // Verify 101 response and Sec-WebSocket-Accept header
  8955. auto expected_accept = websocket_accept_key(client_key);
  8956. auto offered_subprotocols =
  8957. get_combined_header_value(req.headers, "Sec-WebSocket-Protocol");
  8958. return read_websocket_upgrade_response(strm, expected_accept,
  8959. offered_subprotocols, upgrade);
  8960. }
  8961. inline bool is_ip_address(const std::string &host) {
  8962. struct in_addr addr4;
  8963. struct in6_addr addr6;
  8964. return inet_pton(AF_INET, host.c_str(), &addr4) == 1 ||
  8965. inet_pton(AF_INET6, host.c_str(), &addr6) == 1;
  8966. }
  8967. // Resolve where a client should connect for `host`, honoring a user-supplied
  8968. // hostname-to-address map. `host` itself is never rewritten, so it keeps
  8969. // supplying the Host header and SNI; only the connection target changes.
  8970. //
  8971. // A mapped IP literal goes to `ip`, which keeps create_socket's AI_NUMERICHOST
  8972. // path. Anything else goes to `connect_host`, which create_socket resolves as
  8973. // a name, or uses as the socket path when the address family is AF_UNIX. An
  8974. // absent or empty mapping leaves `host` as the connection target; without the
  8975. // empty check the value would reach getaddrinfo as a null node and silently
  8976. // resolve to loopback.
  8977. inline void apply_addr_map(const std::map<std::string, std::string> &addr_map,
  8978. const std::string &host, std::string &connect_host,
  8979. std::string &ip) {
  8980. connect_host = host;
  8981. ip.clear();
  8982. auto it = addr_map.find(host);
  8983. if (it == addr_map.end() || it->second.empty()) { return; }
  8984. if (is_ip_address(it->second)) {
  8985. ip = it->second;
  8986. } else {
  8987. connect_host = it->second;
  8988. }
  8989. }
  8990. } // namespace detail
  8991. /*
  8992. * Group 2: detail namespace - SSL common utilities
  8993. */
  8994. #ifdef CPPHTTPLIB_SSL_ENABLED
  8995. namespace detail {
  8996. class SSLSocketStream final : public Stream {
  8997. public:
  8998. SSLSocketStream(
  8999. socket_t sock, tls::session_t session, time_t read_timeout_sec,
  9000. time_t read_timeout_usec, time_t write_timeout_sec,
  9001. time_t write_timeout_usec, time_t max_timeout_msec = 0,
  9002. std::chrono::time_point<std::chrono::steady_clock> start_time =
  9003. (std::chrono::steady_clock::time_point::min)());
  9004. ~SSLSocketStream() override;
  9005. bool is_readable() const override;
  9006. bool wait_readable() const override;
  9007. bool wait_writable() const override;
  9008. bool is_peer_alive() const override;
  9009. ssize_t read(char *ptr, size_t size) override;
  9010. ssize_t write(const char *ptr, size_t size) override;
  9011. void get_remote_ip_and_port(std::string &ip, int &port) const override;
  9012. void get_local_ip_and_port(std::string &ip, int &port) const override;
  9013. socket_t socket() const override;
  9014. time_t duration() const override;
  9015. void set_read_timeout(time_t sec, time_t usec = 0) override;
  9016. void set_max_timeout(time_t msec) override;
  9017. // See SocketStream::set_readable_hint().
  9018. void set_readable_hint() { readable_hint_ = true; }
  9019. // The error from the last read() or write() that failed in the TLS layer,
  9020. // with code Success if none did
  9021. const tls::TlsError &tls_error() const { return tls_error_; }
  9022. private:
  9023. bool ensure_readable();
  9024. socket_t sock_;
  9025. tls::session_t session_;
  9026. time_t read_timeout_sec_;
  9027. time_t read_timeout_usec_;
  9028. time_t write_timeout_sec_;
  9029. time_t write_timeout_usec_;
  9030. time_t max_timeout_msec_;
  9031. std::chrono::time_point<std::chrono::steady_clock> start_time_;
  9032. bool readable_hint_ = false;
  9033. tls::TlsError tls_error_;
  9034. };
  9035. // A TLS stream for WebSocket connections, where the receive path and the
  9036. // send path (application send() plus the heartbeat ping thread) run on
  9037. // different threads. A single TLS session must never be entered
  9038. // concurrently, so every call into the session is serialized by one mutex.
  9039. //
  9040. // Unlike SSLSocketStream, the socket is kept non-blocking for the stream's
  9041. // whole lifetime and each read()/write() performs a single non-blocking TLS
  9042. // call under the lock, then waits for readiness with select() outside the
  9043. // lock. The lock is therefore held only for CPU-bound work, so a reader
  9044. // blocked waiting for data never stalls a concurrent sender.
  9045. //
  9046. // This stream is used only for wss:// connections. Plain ws:// and ordinary
  9047. // HTTP/HTTPS keep using SocketStream/SSLSocketStream unchanged.
  9048. class WebSocketSSLStream final : public Stream {
  9049. public:
  9050. WebSocketSSLStream(socket_t sock, tls::session_t session,
  9051. time_t read_timeout_sec, time_t read_timeout_usec,
  9052. time_t write_timeout_sec, time_t write_timeout_usec);
  9053. ~WebSocketSSLStream() override;
  9054. bool is_readable() const override;
  9055. bool wait_readable() const override;
  9056. bool wait_writable() const override;
  9057. ssize_t read(char *ptr, size_t size) override;
  9058. ssize_t write(const char *ptr, size_t size) override;
  9059. void get_remote_ip_and_port(std::string &ip, int &port) const override;
  9060. void get_local_ip_and_port(std::string &ip, int &port) const override;
  9061. socket_t socket() const override;
  9062. time_t duration() const override;
  9063. void set_read_timeout(time_t sec, time_t usec = 0) override;
  9064. private:
  9065. mutable std::mutex session_mutex_;
  9066. socket_t sock_;
  9067. tls::session_t session_;
  9068. // WebSocket::close() shortens the read timeout from the closing thread
  9069. // while the receive thread is inside wait_readable(), so these two are read
  9070. // and written concurrently. The write timeouts are never mutated.
  9071. std::atomic<time_t> read_timeout_sec_;
  9072. std::atomic<time_t> read_timeout_usec_;
  9073. time_t write_timeout_sec_;
  9074. time_t write_timeout_usec_;
  9075. const std::chrono::time_point<std::chrono::steady_clock> start_time_;
  9076. };
  9077. #ifdef CPPHTTPLIB_OPENSSL_SUPPORT
  9078. inline std::string message_digest(const std::string &s, const EVP_MD *algo) {
  9079. auto context = std::unique_ptr<EVP_MD_CTX, decltype(&EVP_MD_CTX_free)>(
  9080. EVP_MD_CTX_new(), EVP_MD_CTX_free);
  9081. unsigned int hash_length = 0;
  9082. unsigned char hash[EVP_MAX_MD_SIZE];
  9083. EVP_DigestInit_ex(context.get(), algo, nullptr);
  9084. EVP_DigestUpdate(context.get(), s.c_str(), s.size());
  9085. EVP_DigestFinal_ex(context.get(), hash, &hash_length);
  9086. std::stringstream ss;
  9087. for (auto i = 0u; i < hash_length; ++i) {
  9088. ss << std::hex << std::setw(2) << std::setfill('0')
  9089. << static_cast<unsigned int>(hash[i]);
  9090. }
  9091. return ss.str();
  9092. }
  9093. inline std::string MD5(const std::string &s) {
  9094. return message_digest(s, EVP_md5());
  9095. }
  9096. inline std::string SHA_256(const std::string &s) {
  9097. return message_digest(s, EVP_sha256());
  9098. }
  9099. inline std::string SHA_512(const std::string &s) {
  9100. return message_digest(s, EVP_sha512());
  9101. }
  9102. #elif defined(CPPHTTPLIB_MBEDTLS_SUPPORT)
  9103. namespace {
  9104. template <size_t N>
  9105. inline std::string hash_to_hex(const unsigned char (&hash)[N]) {
  9106. std::stringstream ss;
  9107. for (size_t i = 0; i < N; ++i) {
  9108. ss << std::hex << std::setw(2) << std::setfill('0')
  9109. << static_cast<unsigned int>(hash[i]);
  9110. }
  9111. return ss.str();
  9112. }
  9113. } // namespace
  9114. #ifdef CPPHTTPLIB_MBEDTLS_V4
  9115. // Mbed TLS 4.x provides hashing (and TLS RNG) via PSA Crypto, which must be
  9116. // initialized once. PSA state is process-global; do not free it.
  9117. inline bool ensure_mbedtls_psa_crypto() {
  9118. static std::once_flag once;
  9119. static bool ok = false;
  9120. std::call_once(once, []() { ok = (psa_crypto_init() == PSA_SUCCESS); });
  9121. return ok;
  9122. }
  9123. inline bool psa_hash(psa_algorithm_t alg, const std::string &s,
  9124. unsigned char *out, size_t out_size) {
  9125. if (!ensure_mbedtls_psa_crypto()) { return false; }
  9126. size_t olen = 0;
  9127. return psa_hash_compute(alg, reinterpret_cast<const uint8_t *>(s.data()),
  9128. s.size(), out, out_size, &olen) == PSA_SUCCESS &&
  9129. olen == out_size;
  9130. }
  9131. #endif
  9132. inline std::string MD5(const std::string &s) {
  9133. unsigned char hash[16];
  9134. #ifdef CPPHTTPLIB_MBEDTLS_V4
  9135. if (!psa_hash(PSA_ALG_MD5, s, hash, sizeof(hash))) { return {}; }
  9136. #elif defined(CPPHTTPLIB_MBEDTLS_V3)
  9137. mbedtls_md5(reinterpret_cast<const unsigned char *>(s.c_str()), s.size(),
  9138. hash);
  9139. #else
  9140. mbedtls_md5_ret(reinterpret_cast<const unsigned char *>(s.c_str()), s.size(),
  9141. hash);
  9142. #endif
  9143. return hash_to_hex(hash);
  9144. }
  9145. inline std::string SHA_256(const std::string &s) {
  9146. unsigned char hash[32];
  9147. #ifdef CPPHTTPLIB_MBEDTLS_V4
  9148. if (!psa_hash(PSA_ALG_SHA_256, s, hash, sizeof(hash))) { return {}; }
  9149. #elif defined(CPPHTTPLIB_MBEDTLS_V3)
  9150. mbedtls_sha256(reinterpret_cast<const unsigned char *>(s.c_str()), s.size(),
  9151. hash, 0);
  9152. #else
  9153. mbedtls_sha256_ret(reinterpret_cast<const unsigned char *>(s.c_str()),
  9154. s.size(), hash, 0);
  9155. #endif
  9156. return hash_to_hex(hash);
  9157. }
  9158. inline std::string SHA_512(const std::string &s) {
  9159. unsigned char hash[64];
  9160. #ifdef CPPHTTPLIB_MBEDTLS_V4
  9161. if (!psa_hash(PSA_ALG_SHA_512, s, hash, sizeof(hash))) { return {}; }
  9162. #elif defined(CPPHTTPLIB_MBEDTLS_V3)
  9163. mbedtls_sha512(reinterpret_cast<const unsigned char *>(s.c_str()), s.size(),
  9164. hash, 0);
  9165. #else
  9166. mbedtls_sha512_ret(reinterpret_cast<const unsigned char *>(s.c_str()),
  9167. s.size(), hash, 0);
  9168. #endif
  9169. return hash_to_hex(hash);
  9170. }
  9171. #elif defined(CPPHTTPLIB_WOLFSSL_SUPPORT)
  9172. namespace {
  9173. template <size_t N>
  9174. inline std::string hash_to_hex(const unsigned char (&hash)[N]) {
  9175. std::stringstream ss;
  9176. for (size_t i = 0; i < N; ++i) {
  9177. ss << std::hex << std::setw(2) << std::setfill('0')
  9178. << static_cast<unsigned int>(hash[i]);
  9179. }
  9180. return ss.str();
  9181. }
  9182. } // namespace
  9183. inline std::string MD5(const std::string &s) {
  9184. unsigned char hash[WC_MD5_DIGEST_SIZE];
  9185. wc_Md5Hash(reinterpret_cast<const unsigned char *>(s.c_str()),
  9186. static_cast<word32>(s.size()), hash);
  9187. return hash_to_hex(hash);
  9188. }
  9189. inline std::string SHA_256(const std::string &s) {
  9190. unsigned char hash[WC_SHA256_DIGEST_SIZE];
  9191. wc_Sha256Hash(reinterpret_cast<const unsigned char *>(s.c_str()),
  9192. static_cast<word32>(s.size()), hash);
  9193. return hash_to_hex(hash);
  9194. }
  9195. inline std::string SHA_512(const std::string &s) {
  9196. unsigned char hash[WC_SHA512_DIGEST_SIZE];
  9197. wc_Sha512Hash(reinterpret_cast<const unsigned char *>(s.c_str()),
  9198. static_cast<word32>(s.size()), hash);
  9199. return hash_to_hex(hash);
  9200. }
  9201. #endif
  9202. template <typename T>
  9203. inline bool process_server_socket_ssl(
  9204. const std::atomic<socket_t> &svr_sock, tls::session_t session,
  9205. socket_t sock, size_t keep_alive_max_count, time_t keep_alive_timeout_sec,
  9206. time_t read_timeout_sec, time_t read_timeout_usec, time_t write_timeout_sec,
  9207. time_t write_timeout_usec, T callback) {
  9208. // See process_server_socket(). The TLS library keeps already decrypted bytes
  9209. // of a pipelined request, which keep_alive() cannot see on the socket.
  9210. SSLSocketStream strm(sock, session, read_timeout_sec, read_timeout_usec,
  9211. write_timeout_sec, write_timeout_usec);
  9212. return process_server_socket_core(
  9213. svr_sock, sock, keep_alive_max_count, keep_alive_timeout_sec,
  9214. [&]() { return strm.is_readable(); },
  9215. [&](bool socket_readable, bool close_connection,
  9216. bool &connection_closed) {
  9217. if (socket_readable) { strm.set_readable_hint(); }
  9218. return callback(strm, close_connection, connection_closed);
  9219. });
  9220. }
  9221. template <typename T>
  9222. inline bool process_client_socket_ssl(
  9223. tls::session_t session, socket_t sock, time_t read_timeout_sec,
  9224. time_t read_timeout_usec, time_t write_timeout_sec,
  9225. time_t write_timeout_usec, time_t max_timeout_msec,
  9226. std::chrono::time_point<std::chrono::steady_clock> start_time, T callback) {
  9227. SSLSocketStream strm(sock, session, read_timeout_sec, read_timeout_usec,
  9228. write_timeout_sec, write_timeout_usec, max_timeout_msec,
  9229. start_time);
  9230. return callback(strm);
  9231. }
  9232. // `uri` is req's request-target in origin form, as curl sends it, also when
  9233. // the request line carries the absolute form for a proxy.
  9234. inline std::pair<std::string, std::string> make_digest_authentication_header(
  9235. const Request &req, const std::string &uri,
  9236. const std::map<std::string, std::string> &auth, size_t cnonce_count,
  9237. const std::string &cnonce, const std::string &username,
  9238. const std::string &password, bool is_proxy = false) {
  9239. std::string nc;
  9240. {
  9241. std::stringstream ss;
  9242. ss << std::setfill('0') << std::setw(8) << std::hex << cnonce_count;
  9243. nc = ss.str();
  9244. }
  9245. std::string qop;
  9246. if (auth.find("qop") != auth.end()) {
  9247. qop = auth.at("qop");
  9248. if (qop.find("auth-int") != std::string::npos) {
  9249. qop = "auth-int";
  9250. } else if (qop.find("auth") != std::string::npos) {
  9251. qop = "auth";
  9252. } else {
  9253. qop.clear();
  9254. }
  9255. }
  9256. std::string algo = "MD5";
  9257. if (auth.find("algorithm") != auth.end()) {
  9258. // algorithm is an unquoted token (RFC 7616 §3.4). A server value that is
  9259. // not a token would otherwise be emitted verbatim and could carry commas
  9260. // or quotes that inject further auth-params into the header below.
  9261. const auto &a = auth.at("algorithm");
  9262. if (fields::is_token(a)) { algo = a; }
  9263. }
  9264. std::string response;
  9265. {
  9266. auto H = algo == "SHA-256" ? detail::SHA_256
  9267. : algo == "SHA-512" ? detail::SHA_512
  9268. : detail::MD5;
  9269. auto A1 = username + ":" + auth.at("realm") + ":" + password;
  9270. auto A2 = req.method + ":" + uri;
  9271. if (qop == "auth-int") { A2 += ":" + H(req.body); }
  9272. if (qop.empty()) {
  9273. response = H(H(A1) + ":" + auth.at("nonce") + ":" + H(A2));
  9274. } else {
  9275. response = H(H(A1) + ":" + auth.at("nonce") + ":" + nc + ":" + cnonce +
  9276. ":" + qop + ":" + H(A2));
  9277. }
  9278. }
  9279. auto opaque = (auth.find("opaque") != auth.end()) ? auth.at("opaque") : "";
  9280. // Every value placed inside a quoted-string is escaped so a '"' in it cannot
  9281. // close the string early. realm, nonce and opaque come straight from the
  9282. // server's challenge (parse_www_authenticate() already de-escaped them), so
  9283. // without this a crafted challenge injects extra auth-params into the header.
  9284. auto field =
  9285. "Digest username=\"" + detail::escape_quoted_pairs(username) +
  9286. "\", realm=\"" + detail::escape_quoted_pairs(auth.at("realm")) +
  9287. "\", nonce=\"" + detail::escape_quoted_pairs(auth.at("nonce")) +
  9288. "\", uri=\"" + detail::escape_quoted_pairs(uri) +
  9289. "\", algorithm=" + algo +
  9290. (qop.empty() ? ", response=\""
  9291. : ", qop=" + qop + ", nc=" + nc + ", cnonce=\"" + cnonce +
  9292. "\", response=\"") +
  9293. response + "\"" +
  9294. (opaque.empty()
  9295. ? ""
  9296. : ", opaque=\"" + detail::escape_quoted_pairs(opaque) + "\"");
  9297. auto key = is_proxy ? "Proxy-Authorization" : "Authorization";
  9298. return std::make_pair(key, field);
  9299. }
  9300. // Follows X509_check_host, which the OpenSSL backend uses, so that every
  9301. // backend accepts the same names.
  9302. inline bool match_hostname(const std::string &pattern,
  9303. const std::string &hostname) {
  9304. // A trailing dot on the host is ignored
  9305. auto host = hostname;
  9306. if (host.size() > 1 && host.back() == '.') { host.pop_back(); }
  9307. // Exact match (case-insensitive)
  9308. if (detail::case_ignore::equal(host, pattern)) { return true; }
  9309. // Split both pattern and hostname into components by '.', keeping any empty
  9310. // one, which no name may have
  9311. auto labels = [](const std::string &s) {
  9312. std::vector<std::string> v;
  9313. size_t b = 0;
  9314. while (true) {
  9315. auto e = s.find('.', b);
  9316. v.push_back(s.substr(b, e - b));
  9317. if (e == std::string::npos) { return v; }
  9318. b = e + 1;
  9319. }
  9320. };
  9321. auto pattern_components = labels(pattern);
  9322. auto host_components = labels(host);
  9323. auto has_empty_label = [](const std::vector<std::string> &v) {
  9324. return std::any_of(v.begin(), v.end(),
  9325. [](const std::string &l) { return l.empty(); });
  9326. };
  9327. if (has_empty_label(pattern_components) || has_empty_label(host_components)) {
  9328. return false;
  9329. }
  9330. // Component count must match
  9331. if (host_components.size() != pattern_components.size()) { return false; }
  9332. // A wildcard needs two labels after it, so that "*.com" matches nothing,
  9333. // and an IDNA label may not have one
  9334. const auto &leftmost = pattern_components.front();
  9335. if (leftmost.find('*') != std::string::npos &&
  9336. (pattern_components.size() < 3 ||
  9337. case_ignore::equal(leftmost.substr(0, 4), "xn--"))) {
  9338. return false;
  9339. }
  9340. // Compare each component with wildcard support
  9341. // Supports: "*" (full wildcard), "prefix*" (partial wildcard)
  9342. // https://bugs.launchpad.net/ubuntu/+source/firefox-3.0/+bug/376484
  9343. // Only the leftmost label may carry a wildcard (RFC 6125 6.4.3)
  9344. auto itr = pattern_components.begin();
  9345. for (const auto &h : host_components) {
  9346. auto &p = *itr;
  9347. auto is_leftmost = itr == pattern_components.begin();
  9348. if (!detail::case_ignore::equal(p, h) && !(is_leftmost && p == "*")) {
  9349. bool partial_match = false;
  9350. if (is_leftmost && !p.empty() && p[p.size() - 1] == '*') {
  9351. const auto prefix_length = p.size() - 1;
  9352. if (prefix_length == 0) {
  9353. partial_match = true;
  9354. } else if (h.size() >= prefix_length) {
  9355. partial_match =
  9356. std::equal(p.begin(),
  9357. p.begin() + static_cast<std::string::difference_type>(
  9358. prefix_length),
  9359. h.begin(), [](const char ca, const char cb) {
  9360. return detail::case_ignore::to_lower(ca) ==
  9361. detail::case_ignore::to_lower(cb);
  9362. });
  9363. }
  9364. }
  9365. if (!partial_match) { return false; }
  9366. }
  9367. ++itr;
  9368. }
  9369. return true;
  9370. }
  9371. #ifdef _WIN32
  9372. // Verify certificate using Windows CertGetCertificateChain API.
  9373. // This provides real-time certificate validation with Windows Update
  9374. // integration, independent of the TLS backend.
  9375. inline bool verify_cert_with_windows_schannel(
  9376. const std::vector<unsigned char> &der_cert, const std::string &hostname,
  9377. bool verify_hostname, uint64_t &out_error, tls::const_session_t session) {
  9378. if (der_cert.empty()) { return false; }
  9379. out_error = 0;
  9380. // Create Windows certificate context from DER data
  9381. auto cert_context = CertCreateCertificateContext(
  9382. X509_ASN_ENCODING | PKCS_7_ASN_ENCODING, der_cert.data(),
  9383. static_cast<DWORD>(der_cert.size()));
  9384. if (!cert_context) {
  9385. out_error = GetLastError();
  9386. return false;
  9387. }
  9388. auto cert_guard =
  9389. scope_exit([&] { CertFreeCertificateContext(cert_context); });
  9390. // Give CryptoAPI the certificates the server sent. Without them it follows
  9391. // the leaf's AIA URL, which may lead to an issuer under an untrusted root.
  9392. std::vector<tls::cert_t> peer_certs;
  9393. tls::get_peer_certs(session, peer_certs);
  9394. auto store = CertOpenStore(CERT_STORE_PROV_MEMORY, 0, 0, 0, nullptr);
  9395. auto store_guard = scope_exit([&] {
  9396. for (auto cert : peer_certs) {
  9397. tls::free_cert(cert);
  9398. }
  9399. if (store) { CertCloseStore(store, 0); }
  9400. });
  9401. for (auto cert : peer_certs) {
  9402. std::vector<unsigned char> der;
  9403. if (store && tls::get_cert_der(cert, der)) {
  9404. CertAddEncodedCertificateToStore(store, X509_ASN_ENCODING, der.data(),
  9405. static_cast<DWORD>(der.size()),
  9406. CERT_STORE_ADD_USE_EXISTING, nullptr);
  9407. }
  9408. }
  9409. // Setup chain parameters
  9410. CERT_CHAIN_PARA chain_para = {};
  9411. chain_para.cbSize = sizeof(chain_para);
  9412. // Require the server authentication usage along the chain, which also
  9413. // rejects roots that Windows trusts only for other purposes.
  9414. LPSTR server_auth = const_cast<LPSTR>(szOID_PKIX_KP_SERVER_AUTH);
  9415. chain_para.RequestedUsage.dwType = USAGE_MATCH_TYPE_AND;
  9416. chain_para.RequestedUsage.Usage.cUsageIdentifier = 1;
  9417. chain_para.RequestedUsage.Usage.rgpszUsageIdentifier = &server_auth;
  9418. // Build certificate chain with revocation checking
  9419. PCCERT_CHAIN_CONTEXT chain_context = nullptr;
  9420. auto chain_result = CertGetCertificateChain(
  9421. nullptr, cert_context, nullptr, store, &chain_para,
  9422. CERT_CHAIN_CACHE_END_CERT | CERT_CHAIN_REVOCATION_CHECK_END_CERT |
  9423. CERT_CHAIN_REVOCATION_ACCUMULATIVE_TIMEOUT,
  9424. nullptr, &chain_context);
  9425. if (!chain_result || !chain_context) {
  9426. out_error = GetLastError();
  9427. return false;
  9428. }
  9429. auto chain_guard =
  9430. scope_exit([&] { CertFreeCertificateChain(chain_context); });
  9431. // Verify SSL policy
  9432. SSL_EXTRA_CERT_CHAIN_POLICY_PARA extra_policy_para = {};
  9433. extra_policy_para.cbSize = sizeof(extra_policy_para);
  9434. #ifdef AUTHTYPE_SERVER
  9435. extra_policy_para.dwAuthType = AUTHTYPE_SERVER;
  9436. #endif
  9437. std::wstring whost;
  9438. if (verify_hostname) {
  9439. whost = u8string_to_wstring(hostname.c_str());
  9440. extra_policy_para.pwszServerName = const_cast<wchar_t *>(whost.c_str());
  9441. }
  9442. CERT_CHAIN_POLICY_PARA policy_para = {};
  9443. policy_para.cbSize = sizeof(policy_para);
  9444. #ifdef CERT_CHAIN_POLICY_IGNORE_ALL_REV_UNKNOWN_FLAGS
  9445. policy_para.dwFlags = CERT_CHAIN_POLICY_IGNORE_ALL_REV_UNKNOWN_FLAGS;
  9446. #else
  9447. policy_para.dwFlags = 0;
  9448. #endif
  9449. policy_para.pvExtraPolicyPara = &extra_policy_para;
  9450. CERT_CHAIN_POLICY_STATUS policy_status = {};
  9451. policy_status.cbSize = sizeof(policy_status);
  9452. if (!CertVerifyCertificateChainPolicy(CERT_CHAIN_POLICY_SSL, chain_context,
  9453. &policy_para, &policy_status)) {
  9454. out_error = GetLastError();
  9455. return false;
  9456. }
  9457. if (policy_status.dwError != 0) {
  9458. out_error = policy_status.dwError;
  9459. return false;
  9460. }
  9461. return true;
  9462. }
  9463. #endif // _WIN32
  9464. // Loads CA file/dir configuration and applies the system CA policy to a
  9465. // client TLS context. PEM data and native stores are applied to the context
  9466. // directly at set time; has_custom_store reflects them for the Auto policy
  9467. // decision.
  9468. inline bool load_client_ca_config(tls::ctx_t ctx,
  9469. const std::string &ca_cert_file_path,
  9470. const std::string &ca_cert_dir_path,
  9471. bool has_custom_store, SystemCAMode mode,
  9472. uint64_t &backend_error) {
  9473. auto ret = true;
  9474. if (!ca_cert_file_path.empty()) {
  9475. if (!tls::load_ca_file(ctx, ca_cert_file_path.c_str())) {
  9476. backend_error = tls::get_error();
  9477. ret = false;
  9478. }
  9479. } else if (!ca_cert_dir_path.empty()) {
  9480. if (!tls::load_ca_dir(ctx, ca_cert_dir_path.c_str())) {
  9481. backend_error = tls::get_error();
  9482. ret = false;
  9483. }
  9484. }
  9485. auto has_custom_ca = !ca_cert_file_path.empty() ||
  9486. !ca_cert_dir_path.empty() || has_custom_store;
  9487. if (mode == SystemCAMode::Enabled ||
  9488. (mode == SystemCAMode::Auto && !has_custom_ca)) {
  9489. if (!tls::load_system_certs(ctx)) { backend_error = tls::get_error(); }
  9490. }
  9491. return ret;
  9492. }
  9493. // Serializes the CA certificates installed in ctx as PEM, so they can be
  9494. // loaded into another context.
  9495. inline std::string ca_certs_to_pem(tls::ctx_t ctx) {
  9496. std::string pem;
  9497. std::vector<tls::cert_t> certs;
  9498. tls::get_ca_certs(ctx, certs);
  9499. for (auto cert : certs) {
  9500. std::vector<unsigned char> der;
  9501. if (tls::get_cert_der(cert, der)) {
  9502. auto b64 = base64_encode(std::string(der.begin(), der.end()));
  9503. pem += "-----BEGIN CERTIFICATE-----\n";
  9504. for (size_t i = 0; i < b64.size(); i += 64) {
  9505. pem += b64.substr(i, 64);
  9506. pem += '\n';
  9507. }
  9508. pem += "-----END CERTIFICATE-----\n";
  9509. }
  9510. tls::free_cert(cert);
  9511. }
  9512. return pem;
  9513. }
  9514. // Returns a PemMemory field as a NUL-terminated string: its first len bytes,
  9515. // copied to buf, or pem itself when len is 0.
  9516. inline const char *pem_c_str(const char *pem, size_t len, std::string &buf) {
  9517. if (!pem || len == 0) { return pem; }
  9518. buf.assign(pem, len);
  9519. return buf.c_str();
  9520. }
  9521. // The parts of session setup that only SSLClient needs, plus the handful
  9522. // WebSocketClient also exposes; everything else takes the defaults, which is
  9523. // what keeps the two clients on one implementation.
  9524. struct ClientTlsSessionOptions {
  9525. // Both SSLClient and WebSocketClient expose this independently of
  9526. // certificate verification.
  9527. bool server_hostname_verification = true;
  9528. std::function<SSLVerifierResponse(tls::session_t)> session_verifier;
  9529. // When non-null, guards session creation against concurrent use of the
  9530. // context. A WebSocketClient is not safe to use from several threads to
  9531. // begin with, so it passes nothing.
  9532. std::mutex *ctx_mutex = nullptr;
  9533. #ifdef CPPHTTPLIB_WINDOWS_AUTOMATIC_ROOT_CERTIFICATES_UPDATE
  9534. // The caller decides whether Schannel has anything to say about this
  9535. // connection; see SSLClient::initialize_ssl().
  9536. bool windows_cert_verification = false;
  9537. // A server certificate verifier works on the backend's chain verification,
  9538. // so the backend keeps deciding and Schannel only adds its own check.
  9539. bool server_certificate_verifier_set = false;
  9540. #endif
  9541. };
  9542. // Filled in on failure for callers that report error details.
  9543. struct ClientTlsSessionError {
  9544. Error error = Error::Success;
  9545. int ssl_error = 0;
  9546. uint64_t backend_error = 0;
  9547. };
  9548. // Establishes a client TLS session on an already connected socket. On failure
  9549. // the session is left for the caller to free: SSLClient frees it right away,
  9550. // WebSocketClient keeps it in a member that shutdown_and_close() cleans up.
  9551. inline bool setup_client_tls_session(
  9552. const std::string &host, tls::ctx_t ctx, tls::session_t &session,
  9553. socket_t sock, bool server_certificate_verification, time_t timeout_sec,
  9554. time_t timeout_usec, ClientTlsSessionError *out_error = nullptr,
  9555. const ClientTlsSessionOptions &options = ClientTlsSessionOptions()) {
  9556. using namespace tls;
  9557. auto fail = [&](Error error, int ssl_error, uint64_t backend_error) {
  9558. if (out_error) {
  9559. out_error->error = error;
  9560. out_error->ssl_error = ssl_error;
  9561. out_error->backend_error = backend_error;
  9562. }
  9563. return false;
  9564. };
  9565. if (!ctx) {
  9566. session = nullptr;
  9567. return fail(Error::SSLConnection, 0, 0);
  9568. }
  9569. // With Windows verification on and no server certificate verifier set,
  9570. // Schannel is the only chain verifier. The backend's trust store is a
  9571. // snapshot of the Windows stores that lacks the roots Windows fetches on
  9572. // demand, so the backend's verdict is not used.
  9573. auto windows_verifies_chain = false;
  9574. #ifdef CPPHTTPLIB_WINDOWS_AUTOMATIC_ROOT_CERTIFICATES_UPDATE
  9575. windows_verifies_chain = options.windows_cert_verification &&
  9576. !options.server_certificate_verifier_set;
  9577. #endif
  9578. {
  9579. std::unique_lock<std::mutex> guard;
  9580. if (options.ctx_mutex) {
  9581. guard = std::unique_lock<std::mutex>(*options.ctx_mutex);
  9582. }
  9583. #if defined(CPPHTTPLIB_MBEDTLS_SUPPORT) || defined(CPPHTTPLIB_WOLFSSL_SUPPORT)
  9584. // Mbed TLS and wolfSSL need the verification mode set explicitly, on the
  9585. // context, so under the same lock; OpenSSL uses SSL_VERIFY_NONE and does
  9586. // all verification post-handshake. Unless Schannel verifies the chain
  9587. // instead, chain verification happens during the handshake even for IP
  9588. // hosts; the certificate identity is verified post-handshake via
  9589. // verify_hostname().
  9590. set_verify_client(ctx, server_certificate_verification &&
  9591. !windows_verifies_chain);
  9592. #endif
  9593. session = create_session(ctx, sock);
  9594. }
  9595. if (!session) { return fail(Error::SSLConnection, 0, get_error()); }
  9596. // RFC 6066: SNI must not be set for IP addresses; skip it for IP hosts, so
  9597. // their identity is checked post-handshake below instead. On Mbed TLS and
  9598. // wolfSSL, set_sni also drives handshake-time hostname verification, so
  9599. // options.server_hostname_verification is threaded through here.
  9600. if (!is_ip_address(host)) {
  9601. if (!set_sni(session, host.c_str(), options.server_hostname_verification)) {
  9602. return fail(Error::SSLConnection, 0, get_error());
  9603. }
  9604. }
  9605. TlsError tls_err;
  9606. if (!connect_nonblocking(session, sock, timeout_sec, timeout_usec,
  9607. &tls_err)) {
  9608. auto error = Error::SSLConnection;
  9609. if (tls_err.code == ErrorCode::CertVerifyFailed) {
  9610. error = Error::SSLServerVerification;
  9611. } else if (tls_err.code == ErrorCode::HostnameMismatch) {
  9612. error = Error::SSLServerHostnameVerification;
  9613. }
  9614. return fail(error, static_cast<int>(tls_err.code), tls_err.backend_code);
  9615. }
  9616. auto verification_status = SSLVerifierResponse::NoDecisionMade;
  9617. if (options.session_verifier) {
  9618. verification_status = options.session_verifier(session);
  9619. }
  9620. if (verification_status == SSLVerifierResponse::CertificateRejected) {
  9621. return fail(Error::SSLServerVerification, 0, get_error());
  9622. }
  9623. if (verification_status == SSLVerifierResponse::NoDecisionMade &&
  9624. server_certificate_verification) {
  9625. if (!windows_verifies_chain) {
  9626. auto verify_result = get_verify_result(session);
  9627. if (verify_result != 0) {
  9628. return fail(Error::SSLServerVerification, 0,
  9629. static_cast<uint64_t>(verify_result));
  9630. }
  9631. }
  9632. auto server_cert = get_peer_cert(session);
  9633. if (!server_cert) {
  9634. return fail(Error::SSLServerVerification, 0, get_error());
  9635. }
  9636. auto cert_guard = detail::scope_exit([&] { free_cert(server_cert); });
  9637. // Identity check against the peer certificate, post-handshake for all
  9638. // backends. For IP hosts this is the only identity verification, since no
  9639. // hostname is bound during the handshake.
  9640. if (options.server_hostname_verification) {
  9641. if (!verify_hostname(server_cert, host.c_str())) {
  9642. return fail(Error::SSLServerHostnameVerification, 0,
  9643. hostname_mismatch_code());
  9644. }
  9645. }
  9646. #ifdef CPPHTTPLIB_WINDOWS_AUTOMATIC_ROOT_CERTIFICATES_UPDATE
  9647. // Windows Schannel verification, which lets Windows fetch missing roots
  9648. // and intermediates on demand. It must not be skipped: unless a server
  9649. // certificate verifier is set, it is the only chain check.
  9650. if (options.windows_cert_verification) {
  9651. std::vector<unsigned char> der;
  9652. uint64_t wincrypt_error = 0;
  9653. if (!get_cert_der(server_cert, der) ||
  9654. !verify_cert_with_windows_schannel(
  9655. der, host, options.server_hostname_verification, wincrypt_error,
  9656. session)) {
  9657. return fail(Error::SSLServerVerification, 0, wincrypt_error);
  9658. }
  9659. }
  9660. #endif
  9661. }
  9662. return true;
  9663. }
  9664. } // namespace detail
  9665. #endif // CPPHTTPLIB_SSL_ENABLED
  9666. /*
  9667. * Group 3: httplib namespace - Non-SSL public API implementations
  9668. */
  9669. inline void default_socket_options(socket_t sock) {
  9670. set_socket_opt(sock, SOL_SOCKET,
  9671. #ifdef SO_REUSEPORT
  9672. SO_REUSEPORT,
  9673. #else
  9674. SO_REUSEADDR,
  9675. #endif
  9676. 1);
  9677. }
  9678. inline bool set_socket_opt(socket_t sock, int level, int optname, int optval) {
  9679. return detail::set_socket_opt_impl(sock, level, optname, &optval,
  9680. sizeof(optval));
  9681. }
  9682. inline std::string get_bearer_token_auth(const Request &req) {
  9683. // The auth scheme is case-insensitive (RFC 9110 11.1), and a value shorter
  9684. // than the prefix carries no token.
  9685. constexpr const char bearer_prefix[] = "Bearer ";
  9686. constexpr auto bearer_prefix_len = detail::str_len(bearer_prefix);
  9687. auto value = req.get_header_value("Authorization");
  9688. if (value.size() >= bearer_prefix_len &&
  9689. detail::case_ignore::equal(value.substr(0, bearer_prefix_len),
  9690. bearer_prefix)) {
  9691. return value.substr(bearer_prefix_len);
  9692. }
  9693. return "";
  9694. }
  9695. inline const char *status_message(int status) {
  9696. switch (status) {
  9697. case StatusCode::Continue_100: return "Continue";
  9698. case StatusCode::SwitchingProtocol_101: return "Switching Protocol";
  9699. case StatusCode::Processing_102: return "Processing";
  9700. case StatusCode::EarlyHints_103: return "Early Hints";
  9701. case StatusCode::OK_200: return "OK";
  9702. case StatusCode::Created_201: return "Created";
  9703. case StatusCode::Accepted_202: return "Accepted";
  9704. case StatusCode::NonAuthoritativeInformation_203:
  9705. return "Non-Authoritative Information";
  9706. case StatusCode::NoContent_204: return "No Content";
  9707. case StatusCode::ResetContent_205: return "Reset Content";
  9708. case StatusCode::PartialContent_206: return "Partial Content";
  9709. case StatusCode::MultiStatus_207: return "Multi-Status";
  9710. case StatusCode::AlreadyReported_208: return "Already Reported";
  9711. case StatusCode::IMUsed_226: return "IM Used";
  9712. case StatusCode::MultipleChoices_300: return "Multiple Choices";
  9713. case StatusCode::MovedPermanently_301: return "Moved Permanently";
  9714. case StatusCode::Found_302: return "Found";
  9715. case StatusCode::SeeOther_303: return "See Other";
  9716. case StatusCode::NotModified_304: return "Not Modified";
  9717. case StatusCode::UseProxy_305: return "Use Proxy";
  9718. case StatusCode::unused_306: return "unused";
  9719. case StatusCode::TemporaryRedirect_307: return "Temporary Redirect";
  9720. case StatusCode::PermanentRedirect_308: return "Permanent Redirect";
  9721. case StatusCode::BadRequest_400: return "Bad Request";
  9722. case StatusCode::Unauthorized_401: return "Unauthorized";
  9723. case StatusCode::PaymentRequired_402: return "Payment Required";
  9724. case StatusCode::Forbidden_403: return "Forbidden";
  9725. case StatusCode::NotFound_404: return "Not Found";
  9726. case StatusCode::MethodNotAllowed_405: return "Method Not Allowed";
  9727. case StatusCode::NotAcceptable_406: return "Not Acceptable";
  9728. case StatusCode::ProxyAuthenticationRequired_407:
  9729. return "Proxy Authentication Required";
  9730. case StatusCode::RequestTimeout_408: return "Request Timeout";
  9731. case StatusCode::Conflict_409: return "Conflict";
  9732. case StatusCode::Gone_410: return "Gone";
  9733. case StatusCode::LengthRequired_411: return "Length Required";
  9734. case StatusCode::PreconditionFailed_412: return "Precondition Failed";
  9735. case StatusCode::PayloadTooLarge_413: return "Payload Too Large";
  9736. case StatusCode::UriTooLong_414: return "URI Too Long";
  9737. case StatusCode::UnsupportedMediaType_415: return "Unsupported Media Type";
  9738. case StatusCode::RangeNotSatisfiable_416: return "Range Not Satisfiable";
  9739. case StatusCode::ExpectationFailed_417: return "Expectation Failed";
  9740. case StatusCode::ImATeapot_418: return "I'm a teapot";
  9741. case StatusCode::MisdirectedRequest_421: return "Misdirected Request";
  9742. case StatusCode::UnprocessableContent_422: return "Unprocessable Content";
  9743. case StatusCode::Locked_423: return "Locked";
  9744. case StatusCode::FailedDependency_424: return "Failed Dependency";
  9745. case StatusCode::TooEarly_425: return "Too Early";
  9746. case StatusCode::UpgradeRequired_426: return "Upgrade Required";
  9747. case StatusCode::PreconditionRequired_428: return "Precondition Required";
  9748. case StatusCode::TooManyRequests_429: return "Too Many Requests";
  9749. case StatusCode::RequestHeaderFieldsTooLarge_431:
  9750. return "Request Header Fields Too Large";
  9751. case StatusCode::UnavailableForLegalReasons_451:
  9752. return "Unavailable For Legal Reasons";
  9753. case StatusCode::NotImplemented_501: return "Not Implemented";
  9754. case StatusCode::BadGateway_502: return "Bad Gateway";
  9755. case StatusCode::ServiceUnavailable_503: return "Service Unavailable";
  9756. case StatusCode::GatewayTimeout_504: return "Gateway Timeout";
  9757. case StatusCode::HttpVersionNotSupported_505:
  9758. return "HTTP Version Not Supported";
  9759. case StatusCode::VariantAlsoNegotiates_506: return "Variant Also Negotiates";
  9760. case StatusCode::InsufficientStorage_507: return "Insufficient Storage";
  9761. case StatusCode::LoopDetected_508: return "Loop Detected";
  9762. case StatusCode::NotExtended_510: return "Not Extended";
  9763. case StatusCode::NetworkAuthenticationRequired_511:
  9764. return "Network Authentication Required";
  9765. default:
  9766. case StatusCode::InternalServerError_500: return "Internal Server Error";
  9767. }
  9768. }
  9769. inline std::string to_string(const Error error) {
  9770. switch (error) {
  9771. case Error::Success: return "Success (no error)";
  9772. case Error::Unknown: return "Unknown";
  9773. case Error::Connection: return "Could not establish connection";
  9774. case Error::BindIPAddress: return "Failed to bind IP address";
  9775. case Error::Read: return "Failed to read connection";
  9776. case Error::Write: return "Failed to write connection";
  9777. case Error::ExceedRedirectCount: return "Maximum redirect count exceeded";
  9778. case Error::Canceled: return "Connection handling canceled";
  9779. case Error::SSLConnection: return "SSL connection failed";
  9780. case Error::SSLLoadingCerts: return "SSL certificate loading failed";
  9781. case Error::SSLServerVerification: return "SSL server verification failed";
  9782. case Error::SSLServerHostnameVerification:
  9783. return "SSL server hostname verification failed";
  9784. case Error::UnsupportedMultipartBoundaryChars:
  9785. return "Unsupported HTTP multipart boundary characters";
  9786. case Error::Compression: return "Compression failed";
  9787. case Error::ConnectionTimeout: return "Connection timed out";
  9788. case Error::ProxyConnection: return "Proxy connection failed";
  9789. case Error::ConnectionClosed: return "Connection closed by server";
  9790. case Error::Timeout: return "Read timeout";
  9791. case Error::ResourceExhaustion: return "Resource exhaustion";
  9792. case Error::TooManyFormDataFiles: return "Too many form data files";
  9793. case Error::ExceedMaxPayloadSize: return "Exceeded maximum payload size";
  9794. case Error::ExceedUriMaxLength: return "Exceeded maximum URI length";
  9795. case Error::ExceedMaxSocketDescriptorCount:
  9796. return "Exceeded maximum socket descriptor count";
  9797. case Error::InvalidRequestLine: return "Invalid request line";
  9798. case Error::InvalidHTTPMethod: return "Invalid HTTP method";
  9799. case Error::InvalidHTTPVersion: return "Invalid HTTP version";
  9800. case Error::InvalidHeaders: return "Invalid headers";
  9801. case Error::MultipartParsing: return "Multipart parsing failed";
  9802. case Error::OpenFile: return "Failed to open file";
  9803. case Error::Listen: return "Failed to listen on socket";
  9804. case Error::GetSockName: return "Failed to get socket name";
  9805. case Error::UnsupportedAddressFamily: return "Unsupported address family";
  9806. case Error::HTTPParsing: return "HTTP parsing failed";
  9807. case Error::InvalidRangeHeader: return "Invalid Range header";
  9808. case Error::UnsupportedContentEncoding: return "Unsupported Content-Encoding";
  9809. case Error::WebSocketHandshake: return "WebSocket handshake failed";
  9810. case Error::UserCallbackException: return "User callback threw an exception";
  9811. default: break;
  9812. }
  9813. return "Invalid";
  9814. }
  9815. inline std::ostream &operator<<(std::ostream &os, const Error &obj) {
  9816. os << to_string(obj);
  9817. os << " (" << static_cast<std::underlying_type<Error>::type>(obj) << ')';
  9818. return os;
  9819. }
  9820. inline std::string hosted_at(const std::string &hostname) {
  9821. std::vector<std::string> addrs;
  9822. hosted_at(hostname, addrs);
  9823. if (addrs.empty()) { return std::string(); }
  9824. return addrs[0];
  9825. }
  9826. inline void hosted_at(const std::string &hostname,
  9827. std::vector<std::string> &addrs) {
  9828. struct addrinfo hints;
  9829. struct addrinfo *result;
  9830. memset(&hints, 0, sizeof(struct addrinfo));
  9831. hints.ai_family = AF_UNSPEC;
  9832. hints.ai_socktype = SOCK_STREAM;
  9833. hints.ai_protocol = 0;
  9834. if (detail::getaddrinfo_with_timeout(hostname.c_str(), nullptr, &hints,
  9835. &result, 0)) {
  9836. #if defined __linux__ && !defined __ANDROID__
  9837. res_init();
  9838. #endif
  9839. return;
  9840. }
  9841. auto se = detail::scope_exit([&] { freeaddrinfo(result); });
  9842. for (auto rp = result; rp; rp = rp->ai_next) {
  9843. const auto &addr =
  9844. *reinterpret_cast<struct sockaddr_storage *>(rp->ai_addr);
  9845. std::string ip;
  9846. auto dummy = -1;
  9847. if (detail::get_ip_and_port(addr, sizeof(struct sockaddr_storage), ip,
  9848. dummy)) {
  9849. addrs.emplace_back(std::move(ip));
  9850. }
  9851. }
  9852. }
  9853. inline std::string encode_uri_component(const std::string &value) {
  9854. std::ostringstream escaped;
  9855. escaped.fill('0');
  9856. escaped << std::hex;
  9857. for (auto c : value) {
  9858. if (detail::is_ascii_alnum(c) || c == '-' || c == '_' || c == '.' ||
  9859. c == '!' || c == '~' || c == '*' || c == '\'' || c == '(' || c == ')') {
  9860. escaped << c;
  9861. } else {
  9862. escaped << std::uppercase;
  9863. escaped << '%' << std::setw(2)
  9864. << static_cast<int>(static_cast<unsigned char>(c));
  9865. escaped << std::nouppercase;
  9866. }
  9867. }
  9868. return escaped.str();
  9869. }
  9870. inline std::string encode_uri(const std::string &value) {
  9871. std::ostringstream escaped;
  9872. escaped.fill('0');
  9873. escaped << std::hex;
  9874. for (auto c : value) {
  9875. if (detail::is_ascii_alnum(c) || c == '-' || c == '_' || c == '.' ||
  9876. c == '!' || c == '~' || c == '*' || c == '\'' || c == '(' || c == ')' ||
  9877. c == ';' || c == '/' || c == '?' || c == ':' || c == '@' || c == '&' ||
  9878. c == '=' || c == '+' || c == '$' || c == ',' || c == '#') {
  9879. escaped << c;
  9880. } else {
  9881. escaped << std::uppercase;
  9882. escaped << '%' << std::setw(2)
  9883. << static_cast<int>(static_cast<unsigned char>(c));
  9884. escaped << std::nouppercase;
  9885. }
  9886. }
  9887. return escaped.str();
  9888. }
  9889. inline std::string decode_uri_component(const std::string &value) {
  9890. std::string result;
  9891. for (size_t i = 0; i < value.size(); i++) {
  9892. if (value[i] == '%' && i + 2 < value.size()) {
  9893. auto val = 0;
  9894. if (detail::from_hex_to_i(value, i + 1, 2, val)) {
  9895. result += static_cast<char>(val);
  9896. i += 2;
  9897. } else {
  9898. result += value[i];
  9899. }
  9900. } else {
  9901. result += value[i];
  9902. }
  9903. }
  9904. return result;
  9905. }
  9906. inline std::string decode_uri(const std::string &value) {
  9907. std::string result;
  9908. for (size_t i = 0; i < value.size(); i++) {
  9909. if (value[i] == '%' && i + 2 < value.size()) {
  9910. auto val = 0;
  9911. if (detail::from_hex_to_i(value, i + 1, 2, val)) {
  9912. auto c = static_cast<char>(val);
  9913. // Keep escapes of the reserved characters that encode_uri leaves
  9914. // literal, so decode_uri is the inverse of encode_uri and an escaped
  9915. // delimiter is not promoted into a real one (as with JS decodeURI).
  9916. if (c == ';' || c == '/' || c == '?' || c == ':' || c == '@' ||
  9917. c == '&' || c == '=' || c == '+' || c == '$' || c == ',' ||
  9918. c == '#') {
  9919. result += value[i];
  9920. result += value[i + 1];
  9921. result += value[i + 2];
  9922. } else {
  9923. result += c;
  9924. }
  9925. i += 2;
  9926. } else {
  9927. result += value[i];
  9928. }
  9929. } else {
  9930. result += value[i];
  9931. }
  9932. }
  9933. return result;
  9934. }
  9935. inline std::string encode_path_component(const std::string &component) {
  9936. std::string result;
  9937. result.reserve(component.size() * 3);
  9938. for (size_t i = 0; i < component.size(); i++) {
  9939. auto c = static_cast<unsigned char>(component[i]);
  9940. // Unreserved characters per RFC 3986: ALPHA / DIGIT / "-" / "." / "_" / "~"
  9941. if (detail::is_ascii_alnum(static_cast<char>(c)) || c == '-' || c == '.' ||
  9942. c == '_' || c == '~') {
  9943. result += static_cast<char>(c);
  9944. }
  9945. // Path-safe sub-delimiters: "!" / "$" / "&" / "'" / "(" / ")" / "*" / "+" /
  9946. // "," / ";" / "="
  9947. else if (c == '!' || c == '$' || c == '&' || c == '\'' || c == '(' ||
  9948. c == ')' || c == '*' || c == '+' || c == ',' || c == ';' ||
  9949. c == '=') {
  9950. result += static_cast<char>(c);
  9951. }
  9952. // Colon is allowed in path segments except first segment
  9953. else if (c == ':') {
  9954. result += static_cast<char>(c);
  9955. }
  9956. // @ is allowed in path
  9957. else if (c == '@') {
  9958. result += static_cast<char>(c);
  9959. } else {
  9960. result += '%';
  9961. char hex[3];
  9962. snprintf(hex, sizeof(hex), "%02X", c);
  9963. result.append(hex, 2);
  9964. }
  9965. }
  9966. return result;
  9967. }
  9968. inline std::string decode_path_component(const std::string &component) {
  9969. std::string result;
  9970. result.reserve(component.size());
  9971. for (size_t i = 0; i < component.size(); i++) {
  9972. if (component[i] == '%' && i + 1 < component.size()) {
  9973. if (component[i + 1] == 'u') {
  9974. // Unicode %uXXXX encoding
  9975. auto val = 0;
  9976. // 4 digits Unicode codes: val is 0x0000-0xFFFF (from 4 hex digits),
  9977. // so to_utf8 writes at most 3 bytes. buff[4] is safe.
  9978. char buff[4];
  9979. size_t len = 0;
  9980. if (detail::from_hex_to_i(component, i + 2, 4, val) &&
  9981. (len = detail::to_utf8(val, buff)) > 0) {
  9982. result.append(buff, len);
  9983. i += 5; // 'u0000'
  9984. } else {
  9985. // Not 4 hex digits, or a surrogate, which is no character: the
  9986. // escape is kept as it is rather than joining its neighbours
  9987. result += component[i];
  9988. }
  9989. } else {
  9990. // Standard %XX encoding
  9991. auto val = 0;
  9992. if (detail::from_hex_to_i(component, i + 1, 2, val)) {
  9993. // 2 digits hex codes
  9994. result += static_cast<char>(val);
  9995. i += 2; // 'XX'
  9996. } else {
  9997. result += component[i];
  9998. }
  9999. }
  10000. } else {
  10001. result += component[i];
  10002. }
  10003. }
  10004. return result;
  10005. }
  10006. inline std::string encode_query_component(const std::string &component,
  10007. bool space_as_plus) {
  10008. std::string result;
  10009. result.reserve(component.size() * 3);
  10010. for (size_t i = 0; i < component.size(); i++) {
  10011. auto c = static_cast<unsigned char>(component[i]);
  10012. // Unreserved characters per RFC 3986
  10013. if (detail::is_ascii_alnum(static_cast<char>(c)) || c == '-' || c == '.' ||
  10014. c == '_' || c == '~') {
  10015. result += static_cast<char>(c);
  10016. }
  10017. // Space handling
  10018. else if (c == ' ') {
  10019. if (space_as_plus) {
  10020. result += '+';
  10021. } else {
  10022. result += "%20";
  10023. }
  10024. }
  10025. // Plus sign handling
  10026. else if (c == '+') {
  10027. if (space_as_plus) {
  10028. result += "%2B";
  10029. } else {
  10030. result += static_cast<char>(c);
  10031. }
  10032. }
  10033. // Query-safe sub-delimiters (excluding & and = which are query delimiters)
  10034. else if (c == '!' || c == '$' || c == '\'' || c == '(' || c == ')' ||
  10035. c == '*' || c == ',' || c == ';') {
  10036. result += static_cast<char>(c);
  10037. }
  10038. // Colon and @ are allowed in query
  10039. else if (c == ':' || c == '@') {
  10040. result += static_cast<char>(c);
  10041. }
  10042. // Forward slash is allowed in query values
  10043. else if (c == '/') {
  10044. result += static_cast<char>(c);
  10045. }
  10046. // Question mark is allowed in query values (after first ?)
  10047. else if (c == '?') {
  10048. result += static_cast<char>(c);
  10049. } else {
  10050. result += '%';
  10051. char hex[3];
  10052. snprintf(hex, sizeof(hex), "%02X", c);
  10053. result.append(hex, 2);
  10054. }
  10055. }
  10056. return result;
  10057. }
  10058. inline std::string decode_query_component(const std::string &component,
  10059. bool plus_as_space) {
  10060. std::string result;
  10061. result.reserve(component.size());
  10062. for (size_t i = 0; i < component.size(); i++) {
  10063. if (component[i] == '%' && i + 2 < component.size()) {
  10064. auto val = 0;
  10065. if (detail::from_hex_to_i(component, i + 1, 2, val)) {
  10066. result += static_cast<char>(val);
  10067. i += 2;
  10068. } else {
  10069. result += component[i];
  10070. }
  10071. } else if (component[i] == '+' && plus_as_space) {
  10072. result += ' '; // + becomes space in form-urlencoded
  10073. } else {
  10074. result += component[i];
  10075. }
  10076. }
  10077. return result;
  10078. }
  10079. inline std::string sanitize_filename(const std::string &filename) {
  10080. // Extract basename: find the last path separator (/ or \)
  10081. auto pos = filename.find_last_of("/\\");
  10082. auto result =
  10083. (pos != std::string::npos) ? filename.substr(pos + 1) : filename;
  10084. // Strip null bytes
  10085. result.erase(std::remove(result.begin(), result.end(), '\0'), result.end());
  10086. // Trim whitespace
  10087. {
  10088. auto start = result.find_first_not_of(" \t");
  10089. auto end = result.find_last_not_of(" \t");
  10090. result = (start == std::string::npos)
  10091. ? ""
  10092. : result.substr(start, end - start + 1);
  10093. }
  10094. // Reject . and ..
  10095. if (result == "." || result == "..") { return ""; }
  10096. return result;
  10097. }
  10098. inline std::string append_query_params(const std::string &path,
  10099. const Params &params) {
  10100. // The query ends at the fragment (RFC 3986 3.5), so the params go before it.
  10101. auto fragment_pos = path.find('#');
  10102. auto path_with_query = path.substr(0, fragment_pos);
  10103. path_with_query += path_with_query.find('?') == std::string::npos ? '?' : '&';
  10104. path_with_query += detail::params_to_query_str(params);
  10105. if (fragment_pos != std::string::npos) {
  10106. path_with_query.append(path, fragment_pos, std::string::npos);
  10107. }
  10108. return path_with_query;
  10109. }
  10110. // Header utilities
  10111. inline std::pair<std::string, std::string>
  10112. make_range_header(const Ranges &ranges) {
  10113. std::string field = "bytes=";
  10114. auto i = 0;
  10115. for (const auto &r : ranges) {
  10116. if (i != 0) { field += ", "; }
  10117. if (r.first != -1) { field += std::to_string(r.first); }
  10118. field += '-';
  10119. if (r.second != -1) { field += std::to_string(r.second); }
  10120. i++;
  10121. }
  10122. return std::make_pair("Range", std::move(field));
  10123. }
  10124. inline std::pair<std::string, std::string>
  10125. make_basic_authentication_header(const std::string &username,
  10126. const std::string &password, bool is_proxy) {
  10127. auto field = "Basic " + detail::base64_encode(username + ":" + password);
  10128. auto key = is_proxy ? "Proxy-Authorization" : "Authorization";
  10129. return std::make_pair(key, std::move(field));
  10130. }
  10131. inline std::pair<std::string, std::string>
  10132. make_bearer_token_authentication_header(const std::string &token,
  10133. bool is_proxy = false) {
  10134. auto field = "Bearer " + token;
  10135. auto key = is_proxy ? "Proxy-Authorization" : "Authorization";
  10136. return std::make_pair(key, std::move(field));
  10137. }
  10138. namespace detail {
  10139. // Basic auth when a username or password is set, otherwise a bearer token,
  10140. // unless the request already carries the header.
  10141. inline void add_authorization_header(Request &req, const std::string &username,
  10142. const std::string &password,
  10143. const std::string &token, bool is_proxy) {
  10144. if (req.has_header(is_proxy ? "Proxy-Authorization" : "Authorization")) {
  10145. return;
  10146. }
  10147. if (!username.empty() || !password.empty()) {
  10148. req.headers.insert(
  10149. make_basic_authentication_header(username, password, is_proxy));
  10150. } else if (!token.empty()) {
  10151. req.headers.insert(
  10152. make_bearer_token_authentication_header(token, is_proxy));
  10153. }
  10154. }
  10155. } // namespace detail
  10156. // Request implementation
  10157. inline size_t Request::get_header_value_u64(const std::string &key, size_t def,
  10158. size_t id) const {
  10159. return detail::get_header_value_u64(headers, key, def, id);
  10160. }
  10161. inline bool Request::has_header(const std::string &key) const {
  10162. return detail::has_header(headers, key);
  10163. }
  10164. inline std::string Request::get_header_value(const std::string &key,
  10165. const char *def, size_t id) const {
  10166. return detail::get_header_value(headers, key, def, id);
  10167. }
  10168. inline size_t Request::get_header_value_count(const std::string &key) const {
  10169. return detail::get_header_value_count(headers, key);
  10170. }
  10171. inline void Request::set_header(const std::string &key,
  10172. const std::string &val) {
  10173. detail::set_header(headers, key, val);
  10174. }
  10175. inline bool Request::has_trailer(const std::string &key) const {
  10176. return trailers.find(key) != trailers.end();
  10177. }
  10178. inline std::string Request::get_trailer_value(const std::string &key,
  10179. size_t id) const {
  10180. return detail::get_multimap_value(trailers, key, id);
  10181. }
  10182. inline size_t Request::get_trailer_value_count(const std::string &key) const {
  10183. return trailers.count(key);
  10184. }
  10185. inline bool Request::has_param(const std::string &key) const {
  10186. return params.find(key) != params.end();
  10187. }
  10188. inline std::string Request::get_param_value(const std::string &key,
  10189. size_t id) const {
  10190. return detail::get_multimap_value(params, key, id);
  10191. }
  10192. inline std::vector<std::string>
  10193. Request::get_param_values(const std::string &key) const {
  10194. auto rng = params.equal_range(key);
  10195. std::vector<std::string> values;
  10196. values.reserve(static_cast<size_t>(std::distance(rng.first, rng.second)));
  10197. for (auto it = rng.first; it != rng.second; ++it) {
  10198. values.push_back(it->second);
  10199. }
  10200. return values;
  10201. }
  10202. inline size_t Request::get_param_value_count(const std::string &key) const {
  10203. return params.count(key);
  10204. }
  10205. inline bool Request::is_multipart_form_data() const {
  10206. const auto &content_type = get_header_value("Content-Type");
  10207. return detail::case_ignore::equal(detail::extract_media_type(content_type),
  10208. "multipart/form-data");
  10209. }
  10210. // Multipart FormData implementation
  10211. inline std::string MultipartFormData::get_field(const std::string &key,
  10212. size_t id) const {
  10213. auto rng = fields.equal_range(key);
  10214. auto it = detail::bounded_next(rng.first, id, rng.second);
  10215. if (it != rng.second) { return it->second.content; }
  10216. return std::string();
  10217. }
  10218. inline std::vector<std::string>
  10219. MultipartFormData::get_fields(const std::string &key) const {
  10220. std::vector<std::string> values;
  10221. auto rng = fields.equal_range(key);
  10222. for (auto it = rng.first; it != rng.second; it++) {
  10223. values.push_back(it->second.content);
  10224. }
  10225. return values;
  10226. }
  10227. inline bool MultipartFormData::has_field(const std::string &key) const {
  10228. return fields.find(key) != fields.end();
  10229. }
  10230. inline size_t MultipartFormData::get_field_count(const std::string &key) const {
  10231. return fields.count(key);
  10232. }
  10233. inline FormData MultipartFormData::get_file(const std::string &key,
  10234. size_t id) const {
  10235. return detail::get_multimap_value(files, key, id);
  10236. }
  10237. inline std::vector<FormData>
  10238. MultipartFormData::get_files(const std::string &key) const {
  10239. std::vector<FormData> values;
  10240. auto rng = files.equal_range(key);
  10241. for (auto it = rng.first; it != rng.second; it++) {
  10242. values.push_back(it->second);
  10243. }
  10244. return values;
  10245. }
  10246. inline bool MultipartFormData::has_file(const std::string &key) const {
  10247. return files.find(key) != files.end();
  10248. }
  10249. inline size_t MultipartFormData::get_file_count(const std::string &key) const {
  10250. return files.count(key);
  10251. }
  10252. // Multipart FormData writer implementation
  10253. inline bool is_valid_multipart_boundary(const std::string &boundary) {
  10254. return detail::is_multipart_boundary_chars_valid(boundary);
  10255. }
  10256. inline MultipartFormDataWriter::MultipartFormDataWriter()
  10257. : boundary_(detail::make_multipart_data_boundary()) {}
  10258. inline MultipartFormDataWriter::MultipartFormDataWriter(std::string boundary)
  10259. : boundary_(std::move(boundary)) {}
  10260. inline const std::string &MultipartFormDataWriter::boundary() const {
  10261. return boundary_;
  10262. }
  10263. inline std::string MultipartFormDataWriter::content_type() const {
  10264. return detail::serialize_multipart_formdata_get_content_type(boundary_);
  10265. }
  10266. inline std::string
  10267. MultipartFormDataWriter::serialize(const UploadFormDataItems &items) const {
  10268. return detail::serialize_multipart_formdata(items, boundary_);
  10269. }
  10270. inline size_t MultipartFormDataWriter::content_length(
  10271. const UploadFormDataItems &items) const {
  10272. return detail::get_multipart_content_length(items, boundary_);
  10273. }
  10274. inline std::string
  10275. MultipartFormDataWriter::item_begin(const UploadFormData &item) const {
  10276. return detail::serialize_multipart_formdata_item_begin(item, boundary_);
  10277. }
  10278. inline std::string MultipartFormDataWriter::item_end() {
  10279. return detail::serialize_multipart_formdata_item_end();
  10280. }
  10281. inline std::string MultipartFormDataWriter::finish() const {
  10282. return detail::serialize_multipart_formdata_finish(boundary_);
  10283. }
  10284. // Response implementation
  10285. namespace detail {
  10286. // A response has one content source: `body`, a content provider, or a file.
  10287. // Each content setter calls this so that the one called last wins.
  10288. inline void clear_content_provider(Response &res) {
  10289. auto releaser = std::move(res.content_provider_resource_releaser_);
  10290. auto success = res.content_provider_success_;
  10291. res.content_length_ = 0;
  10292. res.content_provider_ = nullptr;
  10293. res.content_provider_resource_releaser_ = nullptr;
  10294. res.is_chunked_content_provider_ = false;
  10295. res.is_file_content_provider_ = false;
  10296. res.content_provider_success_ = false;
  10297. res.content_coding_ = EncodingType::None;
  10298. res.file_content_path_.clear();
  10299. res.file_content_content_type_.clear();
  10300. if (releaser) { releaser(success); }
  10301. }
  10302. inline void clear_content(Response &res) {
  10303. res.body.clear();
  10304. clear_content_provider(res);
  10305. }
  10306. // The Content-Type of the old content goes with it.
  10307. inline void set_content_type(Response &res, const std::string &content_type) {
  10308. res.headers.erase("Content-Type");
  10309. res.set_header("Content-Type", content_type);
  10310. }
  10311. // `body` is public, so it can be assigned directly after a provider or a file
  10312. // was set. It came last, so it wins.
  10313. inline void prefer_assigned_body(Response &res) {
  10314. if (!res.body.empty() &&
  10315. (res.content_provider_ || !res.file_content_path_.empty())) {
  10316. clear_content_provider(res);
  10317. }
  10318. }
  10319. // RFC 9112 6.3: a 1xx, 204 or 304 response ends with its header section.
  10320. inline bool body_allowed_for_status(int status) {
  10321. return status >= 200 && status != StatusCode::NoContent_204 &&
  10322. status != StatusCode::NotModified_304;
  10323. }
  10324. // Only a 206 response is served as a partial representation. range_error()
  10325. // validates `req.ranges` only for a 2xx status, so slicing under any other
  10326. // status would start from an unchecked offset.
  10327. inline bool is_partial_content(const Request &req, const Response &res) {
  10328. return !req.ranges.empty() && res.status == StatusCode::PartialContent_206;
  10329. }
  10330. // Sets the Content-Length or Transfer-Encoding framing the body that
  10331. // Server::write_response_core() writes, or closes the connection after a body
  10332. // that has neither. Only the library sets them: one from a handler would go
  10333. // out next to it, or describe some other body.
  10334. inline void set_framing_headers(const Request &req, Response &res,
  10335. const std::string &boundary,
  10336. const std::string &content_type) {
  10337. // A HEAD response may give the length a GET would have had (RFC 9110 9.3.2).
  10338. auto head_length = req.method == "HEAD"
  10339. ? res.get_header_value("Content-Length")
  10340. : std::string();
  10341. res.headers.erase("Content-Length");
  10342. res.headers.erase("Transfer-Encoding");
  10343. if (!body_allowed_for_status(res.status)) { return; }
  10344. if (res.content_provider_) {
  10345. if (res.content_length_ == 0) {
  10346. if (res.is_chunked_content_provider_) {
  10347. res.set_header("Transfer-Encoding", "chunked");
  10348. } else if (req.method != "HEAD") {
  10349. // RFC 9112 6.3: a body with neither ends where the connection does.
  10350. res.headers.erase("Keep-Alive");
  10351. if (!has_header_token(res.headers, "Connection", "close")) {
  10352. res.set_header("Connection", "close");
  10353. }
  10354. }
  10355. return;
  10356. }
  10357. // The part Server::write_content_with_provider() writes.
  10358. auto length = res.content_length_;
  10359. if (is_partial_content(req, res)) {
  10360. length = req.ranges.size() == 1
  10361. ? get_range_offset_and_length(req.ranges[0], length).second
  10362. : get_multipart_ranges_data_length(req, boundary,
  10363. content_type, length);
  10364. }
  10365. res.set_header("Content-Length", std::to_string(length));
  10366. } else if (!res.body.empty()) {
  10367. res.set_header("Content-Length", std::to_string(res.body.size()));
  10368. } else {
  10369. res.set_header("Content-Length", head_length.empty() ? "0" : head_length);
  10370. }
  10371. }
  10372. } // namespace detail
  10373. inline size_t Response::get_header_value_u64(const std::string &key, size_t def,
  10374. size_t id) const {
  10375. return detail::get_header_value_u64(headers, key, def, id);
  10376. }
  10377. inline bool Response::has_header(const std::string &key) const {
  10378. return headers.find(key) != headers.end();
  10379. }
  10380. inline std::string Response::get_header_value(const std::string &key,
  10381. const char *def,
  10382. size_t id) const {
  10383. return detail::get_header_value(headers, key, def, id);
  10384. }
  10385. inline size_t Response::get_header_value_count(const std::string &key) const {
  10386. return detail::get_header_value_count(headers, key);
  10387. }
  10388. inline void Response::set_header(const std::string &key,
  10389. const std::string &val) {
  10390. detail::set_header(headers, key, val);
  10391. }
  10392. inline bool Response::has_trailer(const std::string &key) const {
  10393. return trailers.find(key) != trailers.end();
  10394. }
  10395. inline std::string Response::get_trailer_value(const std::string &key,
  10396. size_t id) const {
  10397. return detail::get_multimap_value(trailers, key, id);
  10398. }
  10399. inline size_t Response::get_trailer_value_count(const std::string &key) const {
  10400. return trailers.count(key);
  10401. }
  10402. inline void Response::set_redirect(const std::string &url, int stat) {
  10403. if (detail::fields::is_field_value(url)) {
  10404. set_header("Location", url);
  10405. if (300 <= stat && stat < 400) {
  10406. this->status = stat;
  10407. } else {
  10408. this->status = StatusCode::Found_302;
  10409. }
  10410. }
  10411. }
  10412. inline void Response::set_content(const char *s, size_t n,
  10413. const std::string &content_type) {
  10414. body.assign(s, n); // Before the releaser runs; it may own `s`.
  10415. detail::clear_content_provider(*this);
  10416. detail::set_content_type(*this, content_type);
  10417. }
  10418. inline void Response::set_content(const std::string &s,
  10419. const std::string &content_type) {
  10420. set_content(s.data(), s.size(), content_type);
  10421. }
  10422. inline void Response::set_content(std::string &&s,
  10423. const std::string &content_type) {
  10424. body = std::move(s);
  10425. detail::clear_content_provider(*this);
  10426. detail::set_content_type(*this, content_type);
  10427. }
  10428. inline void Response::set_content_provider(
  10429. size_t in_length, const std::string &content_type, ContentProvider provider,
  10430. ContentProviderResourceReleaser resource_releaser) {
  10431. detail::clear_content(*this);
  10432. detail::set_content_type(*this, content_type);
  10433. content_length_ = in_length;
  10434. if (in_length > 0) { content_provider_ = std::move(provider); }
  10435. content_provider_resource_releaser_ = std::move(resource_releaser);
  10436. }
  10437. inline void Response::set_content_provider(
  10438. const std::string &content_type, ContentProviderWithoutLength provider,
  10439. ContentProviderResourceReleaser resource_releaser) {
  10440. detail::clear_content(*this);
  10441. detail::set_content_type(*this, content_type);
  10442. content_provider_ = detail::ContentProviderAdapter(std::move(provider));
  10443. content_provider_resource_releaser_ = std::move(resource_releaser);
  10444. }
  10445. inline void Response::set_chunked_content_provider(
  10446. const std::string &content_type, ContentProviderWithoutLength provider,
  10447. ContentProviderResourceReleaser resource_releaser) {
  10448. set_content_provider(content_type, std::move(provider),
  10449. std::move(resource_releaser));
  10450. is_chunked_content_provider_ = true;
  10451. }
  10452. inline void Response::set_file_content(const std::string &path,
  10453. const std::string &content_type) {
  10454. detail::clear_content(*this);
  10455. headers.erase("Content-Type");
  10456. file_content_path_ = path;
  10457. file_content_content_type_ = content_type;
  10458. }
  10459. inline void Response::set_file_content(const std::string &path) {
  10460. set_file_content(path, std::string());
  10461. }
  10462. // Result implementation
  10463. inline size_t Result::get_request_header_value_u64(const std::string &key,
  10464. size_t def,
  10465. size_t id) const {
  10466. return detail::get_header_value_u64(request_headers_, key, def, id);
  10467. }
  10468. inline bool Result::has_request_header(const std::string &key) const {
  10469. return request_headers_.find(key) != request_headers_.end();
  10470. }
  10471. inline std::string Result::get_request_header_value(const std::string &key,
  10472. const char *def,
  10473. size_t id) const {
  10474. return detail::get_header_value(request_headers_, key, def, id);
  10475. }
  10476. inline size_t
  10477. Result::get_request_header_value_count(const std::string &key) const {
  10478. return request_headers_.count(key);
  10479. }
  10480. // Stream implementation
  10481. inline ssize_t Stream::write(const char *ptr) {
  10482. return write(ptr, strlen(ptr));
  10483. }
  10484. inline ssize_t Stream::write(const std::string &s) {
  10485. return write(s.data(), s.size());
  10486. }
  10487. // BodyReader implementation
  10488. inline ssize_t detail::BodyReader::read(char *buf, size_t len) {
  10489. if (!stream) {
  10490. last_error = Error::Connection;
  10491. return -1;
  10492. }
  10493. if (eof) { return 0; }
  10494. if (!chunked) {
  10495. // Content-Length based reading
  10496. if (has_content_length && bytes_read >= content_length) {
  10497. eof = true;
  10498. return 0;
  10499. }
  10500. auto to_read = len;
  10501. if (has_content_length) {
  10502. auto remaining = content_length - bytes_read;
  10503. to_read = (std::min)(len, remaining);
  10504. }
  10505. auto n = stream->read(buf, to_read);
  10506. // Without Content-Length the body ends when the connection closes
  10507. // (RFC 9112 §6.3); with one, an EOF here came too early
  10508. if (n < 0 || (n == 0 && has_content_length)) {
  10509. last_error = stream->get_error();
  10510. if (last_error == Error::Success) { last_error = Error::Read; }
  10511. }
  10512. if (n <= 0) {
  10513. eof = true;
  10514. return n;
  10515. }
  10516. bytes_read += static_cast<size_t>(n);
  10517. if (has_content_length && bytes_read >= content_length) { eof = true; }
  10518. if (payload_max_length > 0 && bytes_read > payload_max_length) {
  10519. last_error = Error::ExceedMaxPayloadSize;
  10520. eof = true;
  10521. return -1;
  10522. }
  10523. return n;
  10524. }
  10525. // Chunked transfer encoding: delegate to shared decoder instance.
  10526. if (!chunked_decoder) { chunked_decoder.reset(new ChunkedDecoder(*stream)); }
  10527. size_t chunk_offset = 0;
  10528. size_t chunk_total = 0;
  10529. auto n = chunked_decoder->read_payload(buf, len, chunk_offset, chunk_total);
  10530. if (n < 0) {
  10531. last_error = stream->get_error();
  10532. if (last_error == Error::Success) { last_error = Error::Read; }
  10533. eof = true;
  10534. return n;
  10535. }
  10536. if (n == 0) {
  10537. // Final chunk observed. Leave trailer parsing to the caller (StreamHandle).
  10538. eof = true;
  10539. return 0;
  10540. }
  10541. bytes_read += static_cast<size_t>(n);
  10542. if (payload_max_length > 0 && bytes_read > payload_max_length) {
  10543. last_error = Error::ExceedMaxPayloadSize;
  10544. eof = true;
  10545. return -1;
  10546. }
  10547. return n;
  10548. }
  10549. // ThreadPool implementation
  10550. inline ThreadPool::ThreadPool(size_t n, size_t max_n, size_t mqr,
  10551. time_t idle_timeout_sec)
  10552. : base_thread_count_(n), max_queued_requests_(mqr),
  10553. idle_timeout_sec_(idle_timeout_sec), idle_thread_count_(0),
  10554. shutdown_(false) {
  10555. #ifndef CPPHTTPLIB_NO_EXCEPTIONS
  10556. if (max_n != 0 && max_n < n) {
  10557. std::string msg = "max_threads must be >= base_threads";
  10558. throw std::invalid_argument(msg);
  10559. }
  10560. #endif
  10561. max_thread_count_ = max_n == 0 ? n : max_n;
  10562. threads_.reserve(base_thread_count_);
  10563. #ifndef CPPHTTPLIB_NO_EXCEPTIONS
  10564. try {
  10565. #endif
  10566. for (size_t i = 0; i < base_thread_count_; i++) {
  10567. threads_.emplace_back(std::thread([this]() { worker(false); }));
  10568. }
  10569. #ifndef CPPHTTPLIB_NO_EXCEPTIONS
  10570. } catch (...) {
  10571. // If thread creation fails partway (e.g., pthread_create returns EAGAIN),
  10572. // signal the workers we already spawned to exit and join them so the
  10573. // vector destructor does not see joinable threads (which would call
  10574. // std::terminate). Then rethrow so the caller learns of the failure.
  10575. {
  10576. std::unique_lock<std::mutex> lock(mutex_);
  10577. shutdown_ = true;
  10578. }
  10579. cond_.notify_all();
  10580. for (auto &t : threads_) {
  10581. if (t.joinable()) { t.join(); }
  10582. }
  10583. throw;
  10584. }
  10585. #endif
  10586. }
  10587. inline bool ThreadPool::enqueue(std::function<void()> fn) {
  10588. {
  10589. std::unique_lock<std::mutex> lock(mutex_);
  10590. if (shutdown_) { return false; }
  10591. if (max_queued_requests_ > 0 && jobs_.size() >= max_queued_requests_) {
  10592. return false;
  10593. }
  10594. jobs_.push_back(std::move(fn));
  10595. // Spawn a dynamic thread if jobs outnumber idle threads and under max
  10596. if (jobs_.size() > idle_thread_count_ &&
  10597. threads_.size() + dynamic_threads_.size() < max_thread_count_) {
  10598. cleanup_finished_threads();
  10599. dynamic_threads_.emplace_back(std::thread([this]() { worker(true); }));
  10600. }
  10601. }
  10602. cond_.notify_one();
  10603. return true;
  10604. }
  10605. inline void ThreadPool::shutdown() {
  10606. {
  10607. std::unique_lock<std::mutex> lock(mutex_);
  10608. shutdown_ = true;
  10609. }
  10610. cond_.notify_all();
  10611. for (auto &t : threads_) {
  10612. if (t.joinable()) { t.join(); }
  10613. }
  10614. // Move dynamic_threads_ to a local list under the lock to avoid racing
  10615. // with worker threads that call move_to_finished() concurrently.
  10616. std::list<std::thread> remaining_dynamic;
  10617. {
  10618. std::unique_lock<std::mutex> lock(mutex_);
  10619. remaining_dynamic = std::move(dynamic_threads_);
  10620. }
  10621. for (auto &t : remaining_dynamic) {
  10622. if (t.joinable()) { t.join(); }
  10623. }
  10624. std::unique_lock<std::mutex> lock(mutex_);
  10625. cleanup_finished_threads();
  10626. }
  10627. inline void ThreadPool::move_to_finished(std::thread::id id) {
  10628. // Must be called with mutex_ held
  10629. for (auto it = dynamic_threads_.begin(); it != dynamic_threads_.end(); ++it) {
  10630. if (it->get_id() == id) {
  10631. finished_threads_.push_back(std::move(*it));
  10632. dynamic_threads_.erase(it);
  10633. return;
  10634. }
  10635. }
  10636. }
  10637. inline void ThreadPool::cleanup_finished_threads() {
  10638. // Must be called with mutex_ held
  10639. for (auto &t : finished_threads_) {
  10640. if (t.joinable()) { t.join(); }
  10641. }
  10642. finished_threads_.clear();
  10643. }
  10644. inline void ThreadPool::worker(bool is_dynamic) {
  10645. for (;;) {
  10646. std::function<void()> fn;
  10647. {
  10648. std::unique_lock<std::mutex> lock(mutex_);
  10649. idle_thread_count_++;
  10650. if (is_dynamic) {
  10651. auto has_work =
  10652. cond_.wait_for(lock, std::chrono::seconds(idle_timeout_sec_),
  10653. [&] { return !jobs_.empty() || shutdown_; });
  10654. if (!has_work) {
  10655. // Timed out with no work - exit this dynamic thread
  10656. idle_thread_count_--;
  10657. move_to_finished(std::this_thread::get_id());
  10658. break;
  10659. }
  10660. } else {
  10661. cond_.wait(lock, [&] { return !jobs_.empty() || shutdown_; });
  10662. }
  10663. idle_thread_count_--;
  10664. if (shutdown_ && jobs_.empty()) { break; }
  10665. fn = std::move(jobs_.front());
  10666. jobs_.pop_front();
  10667. }
  10668. assert(true == static_cast<bool>(fn));
  10669. fn();
  10670. }
  10671. #if defined(CPPHTTPLIB_OPENSSL_SUPPORT) && !defined(OPENSSL_IS_BORINGSSL) && \
  10672. !defined(LIBRESSL_VERSION_NUMBER)
  10673. OPENSSL_thread_stop();
  10674. #endif
  10675. }
  10676. /*
  10677. * Group 1 (continued): detail namespace - Stream implementations
  10678. */
  10679. namespace detail {
  10680. inline void calc_actual_timeout(time_t max_timeout_msec, time_t duration_msec,
  10681. time_t timeout_sec, time_t timeout_usec,
  10682. time_t &actual_timeout_sec,
  10683. time_t &actual_timeout_usec) {
  10684. auto timeout_msec = (timeout_sec * 1000) + (timeout_usec / 1000);
  10685. auto actual_timeout_msec =
  10686. (std::min)(max_timeout_msec - duration_msec, timeout_msec);
  10687. if (actual_timeout_msec < 0) { actual_timeout_msec = 0; }
  10688. actual_timeout_sec = actual_timeout_msec / 1000;
  10689. actual_timeout_usec = (actual_timeout_msec % 1000) * 1000;
  10690. }
  10691. // Socket stream implementation
  10692. inline SocketStream::SocketStream(
  10693. socket_t sock, time_t read_timeout_sec, time_t read_timeout_usec,
  10694. time_t write_timeout_sec, time_t write_timeout_usec,
  10695. time_t max_timeout_msec,
  10696. std::chrono::time_point<std::chrono::steady_clock> start_time)
  10697. : sock_(sock), read_timeout_sec_(read_timeout_sec),
  10698. read_timeout_usec_(read_timeout_usec),
  10699. write_timeout_sec_(write_timeout_sec),
  10700. write_timeout_usec_(write_timeout_usec),
  10701. max_timeout_msec_(max_timeout_msec), start_time_(start_time),
  10702. read_buff_(read_buff_size_, 0) {}
  10703. inline SocketStream::~SocketStream() = default;
  10704. inline bool SocketStream::is_readable() const {
  10705. return read_buff_off_ < read_buff_content_size_;
  10706. }
  10707. inline bool SocketStream::wait_readable() const {
  10708. if (max_timeout_msec_ <= 0) {
  10709. return select_read(sock_, read_timeout_sec_, read_timeout_usec_) > 0;
  10710. }
  10711. time_t read_timeout_sec;
  10712. time_t read_timeout_usec;
  10713. calc_actual_timeout(max_timeout_msec_, duration(), read_timeout_sec_,
  10714. read_timeout_usec_, read_timeout_sec, read_timeout_usec);
  10715. return select_read(sock_, read_timeout_sec, read_timeout_usec) > 0;
  10716. }
  10717. inline bool SocketStream::wait_writable() const {
  10718. return select_write(sock_, write_timeout_sec_, write_timeout_usec_) > 0;
  10719. }
  10720. inline bool SocketStream::ensure_readable() {
  10721. if (readable_hint_) {
  10722. readable_hint_ = false;
  10723. return true;
  10724. }
  10725. return wait_readable();
  10726. }
  10727. inline const char *SocketStream::buffered_data(size_t &size) const {
  10728. size = read_buff_content_size_ - read_buff_off_;
  10729. return size ? read_buff_.data() + read_buff_off_ : nullptr;
  10730. }
  10731. inline void SocketStream::consume_buffered(size_t size) {
  10732. assert(size <= read_buff_content_size_ - read_buff_off_);
  10733. read_buff_off_ += size;
  10734. }
  10735. inline bool SocketStream::is_peer_alive() const {
  10736. return detail::is_socket_alive(sock_);
  10737. }
  10738. inline ssize_t SocketStream::read(char *ptr, size_t size) {
  10739. #ifdef _WIN32
  10740. size =
  10741. (std::min)(size, static_cast<size_t>((std::numeric_limits<int>::max)()));
  10742. #else
  10743. size = (std::min)(size,
  10744. static_cast<size_t>((std::numeric_limits<ssize_t>::max)()));
  10745. #endif
  10746. if (read_buff_off_ < read_buff_content_size_) {
  10747. auto remaining_size = read_buff_content_size_ - read_buff_off_;
  10748. if (size <= remaining_size) {
  10749. memcpy(ptr, read_buff_.data() + read_buff_off_, size);
  10750. read_buff_off_ += size;
  10751. return static_cast<ssize_t>(size);
  10752. } else {
  10753. memcpy(ptr, read_buff_.data() + read_buff_off_, remaining_size);
  10754. read_buff_off_ += remaining_size;
  10755. return static_cast<ssize_t>(remaining_size);
  10756. }
  10757. }
  10758. if (!ensure_readable()) {
  10759. error_ = Error::Timeout;
  10760. return -1;
  10761. }
  10762. read_buff_off_ = 0;
  10763. read_buff_content_size_ = 0;
  10764. if (size < read_buff_size_) {
  10765. auto n = read_socket(sock_, read_buff_.data(), read_buff_size_,
  10766. CPPHTTPLIB_RECV_FLAGS);
  10767. if (n <= 0) {
  10768. if (n == 0) {
  10769. error_ = Error::ConnectionClosed;
  10770. } else {
  10771. error_ = Error::Read;
  10772. }
  10773. return n;
  10774. } else if (n <= static_cast<ssize_t>(size)) {
  10775. memcpy(ptr, read_buff_.data(), static_cast<size_t>(n));
  10776. return n;
  10777. } else {
  10778. memcpy(ptr, read_buff_.data(), size);
  10779. read_buff_off_ = size;
  10780. read_buff_content_size_ = static_cast<size_t>(n);
  10781. return static_cast<ssize_t>(size);
  10782. }
  10783. } else {
  10784. auto n = read_socket(sock_, ptr, size, CPPHTTPLIB_RECV_FLAGS);
  10785. if (n <= 0) {
  10786. if (n == 0) {
  10787. error_ = Error::ConnectionClosed;
  10788. } else {
  10789. error_ = Error::Read;
  10790. }
  10791. }
  10792. return n;
  10793. }
  10794. }
  10795. inline ssize_t SocketStream::write(const char *ptr, size_t size) {
  10796. if (!wait_writable()) { return -1; }
  10797. #if defined(_WIN32) && !defined(_WIN64)
  10798. size =
  10799. (std::min)(size, static_cast<size_t>((std::numeric_limits<int>::max)()));
  10800. #endif
  10801. return send_socket(sock_, ptr, size, CPPHTTPLIB_SEND_FLAGS);
  10802. }
  10803. inline void SocketStream::get_remote_ip_and_port(std::string &ip,
  10804. int &port) const {
  10805. return detail::get_remote_ip_and_port(sock_, ip, port);
  10806. }
  10807. inline void SocketStream::get_local_ip_and_port(std::string &ip,
  10808. int &port) const {
  10809. return detail::get_local_ip_and_port(sock_, ip, port);
  10810. }
  10811. inline socket_t SocketStream::socket() const { return sock_; }
  10812. inline time_t SocketStream::duration() const {
  10813. return static_cast<time_t>(
  10814. std::chrono::duration_cast<std::chrono::milliseconds>(
  10815. std::chrono::steady_clock::now() - start_time_)
  10816. .count());
  10817. }
  10818. inline void SocketStream::set_read_timeout(time_t sec, time_t usec) {
  10819. read_timeout_sec_ = sec;
  10820. read_timeout_usec_ = usec;
  10821. }
  10822. inline void SocketStream::set_max_timeout(time_t msec) {
  10823. max_timeout_msec_ = msec;
  10824. start_time_ = std::chrono::steady_clock::now();
  10825. }
  10826. // Buffer stream implementation
  10827. inline bool BufferStream::is_readable() const { return true; }
  10828. inline bool BufferStream::wait_readable() const { return true; }
  10829. inline bool BufferStream::wait_writable() const { return true; }
  10830. inline ssize_t BufferStream::read(char *ptr, size_t size) {
  10831. #if defined(_MSC_VER) && _MSC_VER < 1910
  10832. auto len_read = buffer._Copy_s(ptr, size, size, position);
  10833. #else
  10834. auto len_read = buffer.copy(ptr, size, position);
  10835. #endif
  10836. position += static_cast<size_t>(len_read);
  10837. return static_cast<ssize_t>(len_read);
  10838. }
  10839. inline ssize_t BufferStream::write(const char *ptr, size_t size) {
  10840. buffer.append(ptr, size);
  10841. return static_cast<ssize_t>(size);
  10842. }
  10843. inline void BufferStream::get_remote_ip_and_port(std::string & /*ip*/,
  10844. int & /*port*/) const {}
  10845. inline void BufferStream::get_local_ip_and_port(std::string & /*ip*/,
  10846. int & /*port*/) const {}
  10847. inline socket_t BufferStream::socket() const { return 0; }
  10848. inline time_t BufferStream::duration() const { return 0; }
  10849. inline const std::string &BufferStream::get_buffer() const { return buffer; }
  10850. inline PathParamsMatcher::PathParamsMatcher(const std::string &pattern)
  10851. : MatcherBase(pattern) {
  10852. constexpr const char marker[] = "/:";
  10853. // One past the last ending position of a path param substring
  10854. std::size_t last_param_end = 0;
  10855. #ifndef CPPHTTPLIB_NO_EXCEPTIONS
  10856. // Needed to ensure that parameter names are unique during matcher
  10857. // construction
  10858. // If exceptions are disabled, only last duplicate path
  10859. // parameter will be set
  10860. std::unordered_set<std::string> param_name_set;
  10861. #endif
  10862. while (true) {
  10863. const auto marker_pos = pattern.find(
  10864. marker, last_param_end == 0 ? last_param_end : last_param_end - 1);
  10865. if (marker_pos == std::string::npos) { break; }
  10866. static_fragments_.push_back(
  10867. pattern.substr(last_param_end, marker_pos - last_param_end + 1));
  10868. const auto param_name_start = marker_pos + str_len(marker);
  10869. auto sep_pos = pattern.find(separator, param_name_start);
  10870. if (sep_pos == std::string::npos) { sep_pos = pattern.length(); }
  10871. auto param_name =
  10872. pattern.substr(param_name_start, sep_pos - param_name_start);
  10873. #ifndef CPPHTTPLIB_NO_EXCEPTIONS
  10874. if (param_name_set.find(param_name) != param_name_set.cend()) {
  10875. std::string msg = "Encountered path parameter '" + param_name +
  10876. "' multiple times in route pattern '" + pattern + "'.";
  10877. throw std::invalid_argument(msg);
  10878. }
  10879. #endif
  10880. param_names_.push_back(std::move(param_name));
  10881. last_param_end = sep_pos + 1;
  10882. }
  10883. if (last_param_end < pattern.length()) {
  10884. static_fragments_.push_back(pattern.substr(last_param_end));
  10885. }
  10886. }
  10887. inline bool PathParamsMatcher::match(Request &request) const {
  10888. request.matches = std::smatch();
  10889. request.path_params.clear();
  10890. // A pattern without parameters is just a literal path to compare against
  10891. if (param_names_.empty()) { return request.path == pattern(); }
  10892. request.path_params.reserve(param_names_.size());
  10893. // One past the position at which the path matched the pattern last time
  10894. std::size_t starting_pos = 0;
  10895. for (size_t i = 0; i < static_fragments_.size(); ++i) {
  10896. const auto &fragment = static_fragments_[i];
  10897. if (starting_pos + fragment.length() > request.path.length()) {
  10898. return false;
  10899. }
  10900. // Avoid unnecessary allocation by using strncmp instead of substr +
  10901. // comparison
  10902. if (std::strncmp(request.path.c_str() + starting_pos, fragment.c_str(),
  10903. fragment.length()) != 0) {
  10904. return false;
  10905. }
  10906. starting_pos += fragment.length();
  10907. // Should only happen when we have a static fragment after a param
  10908. // Example: '/users/:id/subscriptions'
  10909. // The 'subscriptions' fragment here does not have a corresponding param
  10910. if (i >= param_names_.size()) { continue; }
  10911. auto sep_pos = request.path.find(separator, starting_pos);
  10912. if (sep_pos == std::string::npos) { sep_pos = request.path.length(); }
  10913. const auto &param_name = param_names_[i];
  10914. request.path_params.emplace(
  10915. param_name, request.path.substr(starting_pos, sep_pos - starting_pos));
  10916. // Mark everything up to '/' as matched
  10917. starting_pos = sep_pos + 1;
  10918. }
  10919. // Returns false if the path is longer than the pattern
  10920. return starting_pos >= request.path.length();
  10921. }
  10922. inline bool RegexMatcher::match(Request &request) const {
  10923. request.path_params.clear();
  10924. // See CPPHTTPLIB_REGEX_ROUTE_PATH_MAX_LENGTH: an overlong path is treated as
  10925. // a non-match rather than risking a stack overflow in std::regex_match.
  10926. if (request.path.length() > CPPHTTPLIB_REGEX_ROUTE_PATH_MAX_LENGTH) {
  10927. return false;
  10928. }
  10929. return std::regex_match(request.path, request.matches, regex_);
  10930. }
  10931. // Enclose IPv6 address in brackets if needed
  10932. inline std::string prepare_host_string(const std::string &host) {
  10933. // Enclose IPv6 address in brackets (but not if already enclosed)
  10934. if (host.find(':') == std::string::npos ||
  10935. (!host.empty() && host[0] == '[')) {
  10936. // IPv4, hostname, or already bracketed IPv6
  10937. return host;
  10938. } else {
  10939. // IPv6 address without brackets
  10940. return "[" + host + "]";
  10941. }
  10942. }
  10943. inline std::string make_host_and_port_string(const std::string &host, int port,
  10944. bool is_ssl) {
  10945. auto result = prepare_host_string(host);
  10946. // Append port if not default
  10947. if ((!is_ssl && port == 80) || (is_ssl && port == 443)) {
  10948. ; // do nothing
  10949. } else {
  10950. result += ":" + std::to_string(port);
  10951. }
  10952. return result;
  10953. }
  10954. // Create "host:port" string always including port number (for CONNECT method)
  10955. inline std::string
  10956. make_host_and_port_string_always_port(const std::string &host, int port) {
  10957. return prepare_host_string(host) + ":" + std::to_string(port);
  10958. }
  10959. // Value for the Host header a client sends when the caller supplied none.
  10960. // Only the value: callers decide where in their header list it goes.
  10961. inline std::string make_default_host_header_value(const std::string &host,
  10962. int port, bool is_ssl,
  10963. int address_family) {
  10964. if (address_family == AF_UNIX) { return "localhost"; }
  10965. return make_host_and_port_string(host, port, is_ssl);
  10966. }
  10967. inline void add_default_user_agent_header(Request &req) {
  10968. #ifndef CPPHTTPLIB_NO_DEFAULT_USER_AGENT
  10969. if (!req.has_header("User-Agent")) {
  10970. req.set_header("User-Agent",
  10971. std::string("cpp-httplib/") + CPPHTTPLIB_VERSION);
  10972. }
  10973. #else
  10974. (void)req;
  10975. #endif
  10976. }
  10977. bool parse_no_proxy_entry(const std::string &token, NoProxyEntry &out);
  10978. NormalizedTarget normalize_target(const std::string &host);
  10979. bool ip_in_cidr(const IPBytes &ip, const IPBytes &net, int prefix_bits);
  10980. bool host_matches_no_proxy(const NormalizedTarget &target,
  10981. const std::vector<NoProxyEntry> &entries);
  10982. inline bool ip_in_cidr(const IPBytes &ip, const IPBytes &net, int prefix_bits) {
  10983. if (prefix_bits < 0 || prefix_bits > 128) { return false; }
  10984. if (prefix_bits == 0) { return true; }
  10985. int full_bytes = prefix_bits / 8;
  10986. int rem_bits = prefix_bits % 8;
  10987. if (full_bytes > 0 && std::memcmp(ip.data(), net.data(),
  10988. static_cast<size_t>(full_bytes)) != 0) {
  10989. return false;
  10990. }
  10991. if (rem_bits == 0) { return true; }
  10992. auto i = static_cast<size_t>(full_bytes);
  10993. auto mask = static_cast<uint8_t>(0xFFu << (8 - rem_bits));
  10994. return (ip[i] & mask) == (net[i] & mask);
  10995. }
  10996. inline bool parse_no_proxy_entry(const std::string &token, NoProxyEntry &out) {
  10997. if (token.empty()) { return false; }
  10998. if (token == "*") {
  10999. out.kind = NoProxyKind::Wildcard;
  11000. return true;
  11001. }
  11002. auto slash = token.find('/');
  11003. std::string addr_part =
  11004. (slash == std::string::npos) ? token : token.substr(0, slash);
  11005. std::string prefix_part =
  11006. (slash == std::string::npos) ? std::string() : token.substr(slash + 1);
  11007. // A bare slash or trailing-slash CIDR like "10.0.0.0/" is malformed;
  11008. // don't silently treat it as a /32 (or /128).
  11009. if (slash != std::string::npos && prefix_part.empty()) { return false; }
  11010. // Accept the bracketed IPv6 form ("[::1]", "[fe80::]/10") as well as the
  11011. // bare form. Brackets have no meaning for IPv4, so skip the IPv4 attempt
  11012. // when brackets are present.
  11013. bool bracketed = addr_part.size() >= 2 && addr_part.front() == '[' &&
  11014. addr_part.back() == ']';
  11015. if (bracketed) { addr_part = addr_part.substr(1, addr_part.size() - 2); }
  11016. if (!bracketed) {
  11017. struct in_addr v4;
  11018. if (inet_pton(AF_INET, addr_part.c_str(), &v4) == 1) {
  11019. int prefix = 32;
  11020. if (!prefix_part.empty() &&
  11021. !parse_int_in_range(prefix_part.data(), prefix_part.size(), 0, 32,
  11022. prefix)) {
  11023. return false;
  11024. }
  11025. out.kind = NoProxyKind::IPv4Cidr;
  11026. std::memcpy(out.net.data(), &v4, sizeof(v4));
  11027. out.prefix_bits = prefix;
  11028. return true;
  11029. }
  11030. }
  11031. struct in6_addr v6;
  11032. if (inet_pton(AF_INET6, addr_part.c_str(), &v6) == 1) {
  11033. int prefix = 128;
  11034. if (!prefix_part.empty() &&
  11035. !parse_int_in_range(prefix_part.data(), prefix_part.size(), 0, 128,
  11036. prefix)) {
  11037. return false;
  11038. }
  11039. out.kind = NoProxyKind::IPv6Cidr;
  11040. std::memcpy(out.net.data(), &v6, sizeof(v6));
  11041. out.prefix_bits = prefix;
  11042. return true;
  11043. }
  11044. // Bracketed entries can only be IPv6. If the IPv6 parse above failed,
  11045. // the entry is malformed — don't fall through to the hostname branch.
  11046. if (bracketed) { return false; }
  11047. // A '/' on a non-IP token means a CIDR prefix without an address. Reject.
  11048. if (slash != std::string::npos) { return false; }
  11049. // Port-specific entries (host:port) are not supported.
  11050. if (token.find(':') != std::string::npos) { return false; }
  11051. std::string hostname = case_ignore::to_lower(token);
  11052. while (!hostname.empty() && hostname.front() == '.') {
  11053. hostname.erase(hostname.begin());
  11054. }
  11055. while (!hostname.empty() && hostname.back() == '.') {
  11056. hostname.pop_back();
  11057. }
  11058. if (hostname.empty()) { return false; }
  11059. out.kind = NoProxyKind::HostnameSuffix;
  11060. out.hostname_pattern = std::move(hostname);
  11061. return true;
  11062. }
  11063. inline std::vector<NoProxyEntry>
  11064. parse_no_proxy_entries(const std::vector<std::string> &patterns) {
  11065. std::vector<NoProxyEntry> entries;
  11066. entries.reserve(patterns.size());
  11067. for (const auto &p : patterns) {
  11068. auto trimmed = trim_copy(p);
  11069. if (trimmed.empty()) { continue; }
  11070. NoProxyEntry entry;
  11071. if (parse_no_proxy_entry(trimmed, entry)) {
  11072. entries.push_back(std::move(entry));
  11073. }
  11074. }
  11075. return entries;
  11076. }
  11077. inline NormalizedTarget normalize_target(const std::string &host) {
  11078. NormalizedTarget t;
  11079. std::string h = host;
  11080. if (h.size() >= 2 && h.front() == '[' && h.back() == ']') {
  11081. h = h.substr(1, h.size() - 2);
  11082. }
  11083. // Strip a single trailing dot so "example.com." canonicalizes to
  11084. // "example.com".
  11085. if (!h.empty() && h.back() == '.') { h.pop_back(); }
  11086. t.hostname = case_ignore::to_lower(h);
  11087. if (!t.hostname.empty()) {
  11088. struct in_addr v4;
  11089. struct in6_addr v6;
  11090. if (inet_pton(AF_INET, t.hostname.c_str(), &v4) == 1) {
  11091. t.is_ipv4 = true;
  11092. std::memcpy(t.ip.data(), &v4, sizeof(v4));
  11093. } else if (inet_pton(AF_INET6, t.hostname.c_str(), &v6) == 1) {
  11094. t.is_ipv6 = true;
  11095. std::memcpy(t.ip.data(), &v6, sizeof(v6));
  11096. }
  11097. }
  11098. return t;
  11099. }
  11100. inline bool host_matches_no_proxy(const NormalizedTarget &target,
  11101. const std::vector<NoProxyEntry> &entries) {
  11102. if (target.hostname.empty()) { return false; }
  11103. for (const auto &e : entries) {
  11104. switch (e.kind) {
  11105. case NoProxyKind::Wildcard: return true;
  11106. case NoProxyKind::IPv4Cidr:
  11107. if (target.is_ipv4 && ip_in_cidr(target.ip, e.net, e.prefix_bits)) {
  11108. return true;
  11109. }
  11110. break;
  11111. case NoProxyKind::IPv6Cidr:
  11112. if (target.is_ipv6 && ip_in_cidr(target.ip, e.net, e.prefix_bits)) {
  11113. return true;
  11114. }
  11115. break;
  11116. case NoProxyKind::HostnameSuffix:
  11117. if (target.is_ipv4 || target.is_ipv6) { break; }
  11118. if (target.hostname == e.hostname_pattern) { return true; }
  11119. // Dot-boundary suffix match: prevents "evilexample.com" from matching
  11120. // an entry of "example.com".
  11121. if (target.hostname.size() > e.hostname_pattern.size() + 1) {
  11122. auto offset = target.hostname.size() - e.hostname_pattern.size();
  11123. if (target.hostname[offset - 1] == '.' &&
  11124. target.hostname.compare(offset, e.hostname_pattern.size(),
  11125. e.hostname_pattern) == 0) {
  11126. return true;
  11127. }
  11128. }
  11129. break;
  11130. }
  11131. }
  11132. return false;
  11133. }
  11134. template <typename T>
  11135. inline bool check_and_write_headers(Stream &strm, Headers &headers,
  11136. T header_writer, Error &error) {
  11137. for (const auto &h : headers) {
  11138. if (!detail::fields::is_field_valid(h.first, h.second)) {
  11139. error = Error::InvalidHeaders;
  11140. return false;
  11141. }
  11142. }
  11143. if (header_writer(strm, headers) <= 0) {
  11144. error = Error::Write;
  11145. return false;
  11146. }
  11147. return true;
  11148. }
  11149. } // namespace detail
  11150. /*
  11151. * Group 2 (continued): detail namespace - SSLSocketStream implementation
  11152. */
  11153. #ifdef CPPHTTPLIB_SSL_ENABLED
  11154. namespace detail {
  11155. // SSL socket stream implementation
  11156. inline SSLSocketStream::SSLSocketStream(
  11157. socket_t sock, tls::session_t session, time_t read_timeout_sec,
  11158. time_t read_timeout_usec, time_t write_timeout_sec,
  11159. time_t write_timeout_usec, time_t max_timeout_msec,
  11160. std::chrono::time_point<std::chrono::steady_clock> start_time)
  11161. : sock_(sock), session_(session), read_timeout_sec_(read_timeout_sec),
  11162. read_timeout_usec_(read_timeout_usec),
  11163. write_timeout_sec_(write_timeout_sec),
  11164. write_timeout_usec_(write_timeout_usec),
  11165. max_timeout_msec_(max_timeout_msec), start_time_(start_time) {
  11166. tls_error_.code = tls::ErrorCode::Success;
  11167. #ifdef CPPHTTPLIB_OPENSSL_SUPPORT
  11168. // Clear AUTO_RETRY for proper non-blocking I/O timeout handling
  11169. // Note: create_session() also clears this, but SSLClient currently
  11170. // uses ssl_new() which does not. Until full TLS API migration is complete,
  11171. // we need to ensure AUTO_RETRY is cleared here regardless of how the
  11172. // SSL session was created.
  11173. SSL_clear_mode(static_cast<SSL *>(session), SSL_MODE_AUTO_RETRY);
  11174. #endif
  11175. }
  11176. inline SSLSocketStream::~SSLSocketStream() = default;
  11177. inline bool SSLSocketStream::is_readable() const {
  11178. return tls::pending(session_) > 0;
  11179. }
  11180. inline bool SSLSocketStream::wait_readable() const {
  11181. if (max_timeout_msec_ <= 0) {
  11182. return select_read(sock_, read_timeout_sec_, read_timeout_usec_) > 0;
  11183. }
  11184. time_t read_timeout_sec;
  11185. time_t read_timeout_usec;
  11186. calc_actual_timeout(max_timeout_msec_, duration(), read_timeout_sec_,
  11187. read_timeout_usec_, read_timeout_sec, read_timeout_usec);
  11188. return select_read(sock_, read_timeout_sec, read_timeout_usec) > 0;
  11189. }
  11190. inline bool SSLSocketStream::wait_writable() const {
  11191. return select_write(sock_, write_timeout_sec_, write_timeout_usec_) > 0 &&
  11192. !tls::is_peer_closed(session_, sock_);
  11193. }
  11194. inline bool SSLSocketStream::ensure_readable() {
  11195. if (readable_hint_) {
  11196. readable_hint_ = false;
  11197. return true;
  11198. }
  11199. return wait_readable();
  11200. }
  11201. inline bool SSLSocketStream::is_peer_alive() const {
  11202. return !tls::is_peer_closed(session_, sock_);
  11203. }
  11204. inline ssize_t SSLSocketStream::read(char *ptr, size_t size) {
  11205. if (tls::pending(session_) > 0) {
  11206. tls::TlsError err;
  11207. auto ret = tls::read(session_, ptr, size, err);
  11208. if (ret == 0 || err.code == tls::ErrorCode::PeerClosed) {
  11209. error_ = Error::ConnectionClosed;
  11210. } else if (ret < 0) {
  11211. tls_error_ = err;
  11212. }
  11213. return ret;
  11214. } else if (ensure_readable()) {
  11215. tls::TlsError err;
  11216. auto ret = tls::read(session_, ptr, size, err);
  11217. if (ret < 0) {
  11218. auto n = 1000;
  11219. #ifdef _WIN32
  11220. while (--n >= 0 && (err.code == tls::ErrorCode::WantRead ||
  11221. (err.code == tls::ErrorCode::SyscallError &&
  11222. WSAGetLastError() == WSAETIMEDOUT))) {
  11223. #else
  11224. while (--n >= 0 && err.code == tls::ErrorCode::WantRead) {
  11225. #endif
  11226. if (tls::pending(session_) > 0) {
  11227. ret = tls::read(session_, ptr, size, err);
  11228. if (ret >= 0) { return ret; }
  11229. break;
  11230. } else if (wait_readable()) {
  11231. std::this_thread::sleep_for(std::chrono::microseconds{10});
  11232. ret = tls::read(session_, ptr, size, err);
  11233. if (ret >= 0) { return ret; }
  11234. } else {
  11235. break;
  11236. }
  11237. }
  11238. assert(ret < 0);
  11239. tls_error_ = err;
  11240. } else if (ret == 0 || err.code == tls::ErrorCode::PeerClosed) {
  11241. error_ = Error::ConnectionClosed;
  11242. }
  11243. return ret;
  11244. } else {
  11245. error_ = Error::Timeout;
  11246. return -1;
  11247. }
  11248. }
  11249. inline ssize_t SSLSocketStream::write(const char *ptr, size_t size) {
  11250. if (wait_writable()) {
  11251. auto handle_size =
  11252. std::min<size_t>(size, (std::numeric_limits<int>::max)());
  11253. tls::TlsError err;
  11254. auto ret = tls::write(session_, ptr, handle_size, err);
  11255. if (ret < 0) {
  11256. auto n = 1000;
  11257. #ifdef _WIN32
  11258. while (--n >= 0 && (err.code == tls::ErrorCode::WantWrite ||
  11259. (err.code == tls::ErrorCode::SyscallError &&
  11260. WSAGetLastError() == WSAETIMEDOUT))) {
  11261. #else
  11262. while (--n >= 0 && err.code == tls::ErrorCode::WantWrite) {
  11263. #endif
  11264. if (wait_writable()) {
  11265. std::this_thread::sleep_for(std::chrono::microseconds{10});
  11266. ret = tls::write(session_, ptr, handle_size, err);
  11267. if (ret >= 0) { return ret; }
  11268. } else {
  11269. break;
  11270. }
  11271. }
  11272. assert(ret < 0);
  11273. tls_error_ = err;
  11274. }
  11275. return ret;
  11276. }
  11277. return -1;
  11278. }
  11279. inline void SSLSocketStream::get_remote_ip_and_port(std::string &ip,
  11280. int &port) const {
  11281. detail::get_remote_ip_and_port(sock_, ip, port);
  11282. }
  11283. inline void SSLSocketStream::get_local_ip_and_port(std::string &ip,
  11284. int &port) const {
  11285. detail::get_local_ip_and_port(sock_, ip, port);
  11286. }
  11287. inline socket_t SSLSocketStream::socket() const { return sock_; }
  11288. inline time_t SSLSocketStream::duration() const {
  11289. return static_cast<time_t>(
  11290. std::chrono::duration_cast<std::chrono::milliseconds>(
  11291. std::chrono::steady_clock::now() - start_time_)
  11292. .count());
  11293. }
  11294. inline void SSLSocketStream::set_read_timeout(time_t sec, time_t usec) {
  11295. read_timeout_sec_ = sec;
  11296. read_timeout_usec_ = usec;
  11297. }
  11298. inline void SSLSocketStream::set_max_timeout(time_t msec) {
  11299. max_timeout_msec_ = msec;
  11300. start_time_ = std::chrono::steady_clock::now();
  11301. }
  11302. inline WebSocketSSLStream::WebSocketSSLStream(socket_t sock,
  11303. tls::session_t session,
  11304. time_t read_timeout_sec,
  11305. time_t read_timeout_usec,
  11306. time_t write_timeout_sec,
  11307. time_t write_timeout_usec)
  11308. : sock_(sock), session_(session), read_timeout_sec_(read_timeout_sec),
  11309. read_timeout_usec_(read_timeout_usec),
  11310. write_timeout_sec_(write_timeout_sec),
  11311. write_timeout_usec_(write_timeout_usec),
  11312. start_time_(std::chrono::steady_clock::now()) {
  11313. // The receive and send paths run on different threads, so each TLS call is
  11314. // driven in non-blocking mode and readiness is awaited with select()
  11315. // outside the session lock. Set the socket non-blocking once here; it is
  11316. // never flipped back, so no thread races on the flag.
  11317. detail::set_nonblocking(sock_, true);
  11318. #ifdef CPPHTTPLIB_OPENSSL_SUPPORT
  11319. SSL_clear_mode(static_cast<SSL *>(session_), SSL_MODE_AUTO_RETRY);
  11320. #endif
  11321. }
  11322. inline WebSocketSSLStream::~WebSocketSSLStream() = default;
  11323. inline bool WebSocketSSLStream::is_readable() const {
  11324. std::lock_guard<std::mutex> guard(session_mutex_);
  11325. return tls::pending(session_) > 0;
  11326. }
  11327. inline bool WebSocketSSLStream::wait_readable() const {
  11328. return select_read(sock_, read_timeout_sec_, read_timeout_usec_) > 0;
  11329. }
  11330. inline bool WebSocketSSLStream::wait_writable() const {
  11331. // Unlike SSLSocketStream, this deliberately does not call is_peer_closed():
  11332. // that probe toggles the socket's blocking flag, which would race with the
  11333. // concurrent reader on a permanently non-blocking socket.
  11334. return select_write(sock_, write_timeout_sec_, write_timeout_usec_) > 0;
  11335. }
  11336. inline ssize_t WebSocketSSLStream::read(char *ptr, size_t size) {
  11337. tls::TlsError err;
  11338. auto n = 1000;
  11339. while (--n >= 0) {
  11340. {
  11341. std::lock_guard<std::mutex> guard(session_mutex_);
  11342. auto ret = tls::read(session_, ptr, size, err);
  11343. if (ret > 0) { return ret; }
  11344. if (ret == 0 || err.code == tls::ErrorCode::PeerClosed) {
  11345. error_ = Error::ConnectionClosed;
  11346. return ret;
  11347. }
  11348. }
  11349. // ret < 0. On a non-blocking socket a TLS read can stop needing either
  11350. // direction: the send path shares this session, so output it left pending
  11351. // has to be flushed before more input can be decrypted. Anything else is
  11352. // a hard error.
  11353. auto needs_readable = err.code == tls::ErrorCode::WantRead;
  11354. #ifdef _WIN32
  11355. // On Windows a socket timeout surfaces as a syscall error, not WantRead.
  11356. needs_readable =
  11357. needs_readable || (err.code == tls::ErrorCode::SyscallError &&
  11358. WSAGetLastError() == WSAETIMEDOUT);
  11359. #endif
  11360. if (!needs_readable && err.code != tls::ErrorCode::WantWrite) {
  11361. error_ = Error::Read;
  11362. return -1;
  11363. }
  11364. if (!(needs_readable ? wait_readable() : wait_writable())) {
  11365. error_ = Error::Timeout;
  11366. return -1;
  11367. }
  11368. }
  11369. // Out of retries. Recording a reason matters: a caller that reads get_error()
  11370. // to tell a timeout from a close would otherwise see whatever the previous
  11371. // failure left behind (error_ is never cleared on success).
  11372. error_ = Error::Read;
  11373. return -1;
  11374. }
  11375. inline ssize_t WebSocketSSLStream::write(const char *ptr, size_t size) {
  11376. auto handle_size = std::min<size_t>(size, (std::numeric_limits<int>::max)());
  11377. tls::TlsError err;
  11378. auto n = 1000;
  11379. while (--n >= 0) {
  11380. {
  11381. std::lock_guard<std::mutex> guard(session_mutex_);
  11382. auto ret = tls::write(session_, ptr, handle_size, err);
  11383. if (ret >= 0) { return ret; }
  11384. }
  11385. // ret < 0. As in read(), either direction can be needed: a renegotiation
  11386. // or a post-handshake message must be consumed before the record goes
  11387. // out. Anything else is a hard error.
  11388. auto needs_writable = err.code == tls::ErrorCode::WantWrite;
  11389. #ifdef _WIN32
  11390. // On Windows a socket timeout surfaces as a syscall error, not WantWrite.
  11391. needs_writable =
  11392. needs_writable || (err.code == tls::ErrorCode::SyscallError &&
  11393. WSAGetLastError() == WSAETIMEDOUT);
  11394. #endif
  11395. if (!needs_writable && err.code != tls::ErrorCode::WantRead) { return -1; }
  11396. if (!(needs_writable ? wait_writable() : wait_readable())) { return -1; }
  11397. }
  11398. return -1;
  11399. }
  11400. inline void WebSocketSSLStream::get_remote_ip_and_port(std::string &ip,
  11401. int &port) const {
  11402. detail::get_remote_ip_and_port(sock_, ip, port);
  11403. }
  11404. inline void WebSocketSSLStream::get_local_ip_and_port(std::string &ip,
  11405. int &port) const {
  11406. detail::get_local_ip_and_port(sock_, ip, port);
  11407. }
  11408. inline socket_t WebSocketSSLStream::socket() const { return sock_; }
  11409. inline time_t WebSocketSSLStream::duration() const {
  11410. return static_cast<time_t>(
  11411. std::chrono::duration_cast<std::chrono::milliseconds>(
  11412. std::chrono::steady_clock::now() - start_time_)
  11413. .count());
  11414. }
  11415. inline void WebSocketSSLStream::set_read_timeout(time_t sec, time_t usec) {
  11416. read_timeout_sec_ = sec;
  11417. read_timeout_usec_ = usec;
  11418. }
  11419. } // namespace detail
  11420. #endif // CPPHTTPLIB_SSL_ENABLED
  11421. /*
  11422. * Group 4: Server implementation
  11423. */
  11424. // HTTP server implementation
  11425. inline Server::Server()
  11426. : new_task_queue([] {
  11427. return new ThreadPool(CPPHTTPLIB_THREAD_POOL_COUNT,
  11428. CPPHTTPLIB_THREAD_POOL_MAX_COUNT);
  11429. }) {
  11430. #ifndef _WIN32
  11431. signal(SIGPIPE, SIG_IGN);
  11432. #endif
  11433. }
  11434. inline Server::~Server() = default;
  11435. inline std::unique_ptr<detail::MatcherBase>
  11436. Server::make_matcher(const std::string &pattern) {
  11437. // Path params take precedence, so "/users/:id/(.*)" keeps being matched as
  11438. // a path params pattern
  11439. if (pattern.find("/:") != std::string::npos) {
  11440. return detail::make_unique<detail::PathParamsMatcher>(pattern);
  11441. }
  11442. // A pattern with no regex metacharacter only has to be compared literally,
  11443. // which is what PathParamsMatcher already does when it captures no
  11444. // parameter, so std::regex is only worth building for the patterns that
  11445. // actually need it
  11446. if (pattern.find_first_of(".^$|()[]{}*+?\\") == std::string::npos) {
  11447. return detail::make_unique<detail::PathParamsMatcher>(pattern);
  11448. }
  11449. return detail::make_unique<detail::RegexMatcher>(pattern);
  11450. }
  11451. inline Server &Server::Get(const std::string &pattern, Handler handler) {
  11452. return add_handler(get_handlers_, pattern, std::move(handler));
  11453. }
  11454. inline Server &Server::Post(const std::string &pattern, Handler handler) {
  11455. return add_handler(post_handlers_, pattern, std::move(handler));
  11456. }
  11457. inline Server &Server::Post(const std::string &pattern,
  11458. HandlerWithContentReader handler) {
  11459. return add_handler(post_handlers_for_content_reader_, pattern,
  11460. std::move(handler));
  11461. }
  11462. inline Server &Server::Put(const std::string &pattern, Handler handler) {
  11463. return add_handler(put_handlers_, pattern, std::move(handler));
  11464. }
  11465. inline Server &Server::Put(const std::string &pattern,
  11466. HandlerWithContentReader handler) {
  11467. return add_handler(put_handlers_for_content_reader_, pattern,
  11468. std::move(handler));
  11469. }
  11470. inline Server &Server::Patch(const std::string &pattern, Handler handler) {
  11471. return add_handler(patch_handlers_, pattern, std::move(handler));
  11472. }
  11473. inline Server &Server::Patch(const std::string &pattern,
  11474. HandlerWithContentReader handler) {
  11475. return add_handler(patch_handlers_for_content_reader_, pattern,
  11476. std::move(handler));
  11477. }
  11478. inline Server &Server::Delete(const std::string &pattern, Handler handler) {
  11479. return add_handler(delete_handlers_, pattern, std::move(handler));
  11480. }
  11481. inline Server &Server::Delete(const std::string &pattern,
  11482. HandlerWithContentReader handler) {
  11483. return add_handler(delete_handlers_for_content_reader_, pattern,
  11484. std::move(handler));
  11485. }
  11486. inline Server &Server::Options(const std::string &pattern, Handler handler) {
  11487. return add_handler(options_handlers_, pattern, std::move(handler));
  11488. }
  11489. inline const std::set<std::string> &Server::builtin_methods() {
  11490. thread_local const std::set<std::string> methods{
  11491. "GET", "HEAD", "POST", "PUT", "DELETE",
  11492. "CONNECT", "OPTIONS", "TRACE", "PATCH", "PRI"};
  11493. return methods;
  11494. }
  11495. inline Server::CustomHandlerEntry *
  11496. Server::custom_entry_for_registration(const std::string &method) {
  11497. // Built-in methods are refused for two different reasons. GET, HEAD, POST,
  11498. // PUT, DELETE, OPTIONS and PATCH are dispatched by the if/else chain in
  11499. // routing() before the custom tables are consulted, so a route registered
  11500. // for one of them could never fire. CONNECT, TRACE and PRI have no branch
  11501. // there and would be reachable, but they carry protocol-level meaning
  11502. // (tunnel setup, request echo, the HTTP/2 connection preface) that this
  11503. // library does not route.
  11504. if (!detail::fields::is_token(method) || builtin_methods().count(method)) {
  11505. output_error_log(Error::InvalidHTTPMethod, nullptr);
  11506. has_invalid_registration_ = true;
  11507. return nullptr;
  11508. }
  11509. return &custom_handlers_[method];
  11510. }
  11511. inline Server &Server::CustomRoute(const std::string &method,
  11512. const std::string &pattern,
  11513. Handler handler) {
  11514. auto *entry = custom_entry_for_registration(method);
  11515. if (!entry) { return *this; }
  11516. return add_handler(entry->handlers, pattern, std::move(handler));
  11517. }
  11518. inline Server &Server::CustomRoute(const std::string &method,
  11519. const std::string &pattern,
  11520. HandlerWithContentReader handler) {
  11521. auto *entry = custom_entry_for_registration(method);
  11522. if (!entry) { return *this; }
  11523. return add_handler(entry->handlers_for_content_reader, pattern,
  11524. std::move(handler));
  11525. }
  11526. inline const Server::CustomHandlerEntry *
  11527. Server::find_custom_entry(const std::string &method) const {
  11528. // find() alone would be correct here. The empty() check is what keeps the
  11529. // per-request cost off servers that never call CustomRoute(), which is the
  11530. // overwhelmingly common case; keep it rather than walking into the tree.
  11531. if (custom_handlers_.empty()) { return nullptr; }
  11532. auto it = custom_handlers_.find(method);
  11533. return it == custom_handlers_.end() ? nullptr : &it->second;
  11534. }
  11535. inline Server &Server::WebSocket(const std::string &pattern,
  11536. WebSocketHandler handler) {
  11537. websocket_handlers_.push_back(
  11538. {make_matcher(pattern), std::move(handler), nullptr});
  11539. return *this;
  11540. }
  11541. inline Server &Server::WebSocket(const std::string &pattern,
  11542. WebSocketHandler handler,
  11543. SubProtocolSelector sub_protocol_selector) {
  11544. websocket_handlers_.push_back({make_matcher(pattern), std::move(handler),
  11545. std::move(sub_protocol_selector)});
  11546. return *this;
  11547. }
  11548. inline bool Server::set_base_dir(const std::string &dir,
  11549. const std::string &mount_point) {
  11550. return set_mount_point(mount_point, dir);
  11551. }
  11552. inline bool Server::set_mount_point(const std::string &mount_point,
  11553. const std::string &dir, Headers headers) {
  11554. detail::FileStat stat(dir);
  11555. if (stat.is_dir()) {
  11556. std::string mnt = !mount_point.empty() ? mount_point : "/";
  11557. if (!mnt.empty() && mnt[0] == '/') {
  11558. // Without the resolved directory, a file could not be checked to be
  11559. // inside it.
  11560. std::string resolved_base;
  11561. if (!detail::canonicalize_path(dir.c_str(), resolved_base)) {
  11562. return false;
  11563. }
  11564. #if defined(_WIN32)
  11565. if (resolved_base.back() != '\\' && resolved_base.back() != '/') {
  11566. resolved_base += '\\';
  11567. }
  11568. #else
  11569. if (resolved_base.back() != '/') { resolved_base += '/'; }
  11570. #endif
  11571. base_dirs_.push_back(
  11572. {std::move(mnt), dir, std::move(resolved_base), std::move(headers)});
  11573. return true;
  11574. }
  11575. }
  11576. return false;
  11577. }
  11578. inline bool Server::remove_mount_point(const std::string &mount_point) {
  11579. for (auto it = base_dirs_.begin(); it != base_dirs_.end(); ++it) {
  11580. if (it->mount_point == mount_point) {
  11581. base_dirs_.erase(it);
  11582. return true;
  11583. }
  11584. }
  11585. return false;
  11586. }
  11587. inline Server &
  11588. Server::set_file_extension_and_mimetype_mapping(const std::string &ext,
  11589. const std::string &mime) {
  11590. file_extension_and_mimetype_map_[ext] = mime;
  11591. return *this;
  11592. }
  11593. inline Server &Server::set_default_file_mimetype(const std::string &mime) {
  11594. default_file_mimetype_ = mime;
  11595. return *this;
  11596. }
  11597. inline Server &Server::set_file_request_handler(Handler handler) {
  11598. file_request_handler_ = std::move(handler);
  11599. return *this;
  11600. }
  11601. inline Server &Server::set_error_handler_core(HandlerWithResponse handler,
  11602. std::true_type) {
  11603. error_handler_ = std::move(handler);
  11604. return *this;
  11605. }
  11606. inline Server &Server::set_error_handler_core(Handler handler,
  11607. std::false_type) {
  11608. error_handler_ = [handler](const Request &req, Response &res) {
  11609. handler(req, res);
  11610. return HandlerResponse::Handled;
  11611. };
  11612. return *this;
  11613. }
  11614. inline Server &Server::set_exception_handler(ExceptionHandler handler) {
  11615. exception_handler_ = std::move(handler);
  11616. return *this;
  11617. }
  11618. inline Server &Server::set_pre_routing_handler(HandlerWithResponse handler) {
  11619. pre_routing_handler_ = std::move(handler);
  11620. return *this;
  11621. }
  11622. inline Server &Server::set_post_routing_handler(Handler handler) {
  11623. post_routing_handler_ = std::move(handler);
  11624. return *this;
  11625. }
  11626. inline Server &Server::set_pre_request_handler(HandlerWithResponse handler) {
  11627. pre_request_handler_ = std::move(handler);
  11628. return *this;
  11629. }
  11630. inline Server &Server::set_logger(Logger logger) {
  11631. logger_ = std::move(logger);
  11632. return *this;
  11633. }
  11634. inline Server &Server::set_error_logger(ErrorLogger error_logger) {
  11635. error_logger_ = std::move(error_logger);
  11636. return *this;
  11637. }
  11638. inline Server &Server::set_pre_compression_logger(Logger logger) {
  11639. pre_compression_logger_ = std::move(logger);
  11640. return *this;
  11641. }
  11642. inline Server &
  11643. Server::set_expect_100_continue_handler(Expect100ContinueHandler handler) {
  11644. expect_100_continue_handler_ = std::move(handler);
  11645. return *this;
  11646. }
  11647. inline Server &Server::set_start_handler(StartHandler handler) {
  11648. start_handler_ = std::move(handler);
  11649. return *this;
  11650. }
  11651. inline Server &Server::set_address_family(int family) {
  11652. address_family_ = family;
  11653. return *this;
  11654. }
  11655. inline Server &Server::set_tcp_nodelay(bool on) {
  11656. tcp_nodelay_ = on;
  11657. return *this;
  11658. }
  11659. inline Server &Server::set_ipv6_v6only(bool on) {
  11660. ipv6_v6only_ = on;
  11661. return *this;
  11662. }
  11663. inline Server &Server::set_socket_options(SocketOptions socket_options) {
  11664. socket_options_ = std::move(socket_options);
  11665. return *this;
  11666. }
  11667. inline Server &Server::set_default_headers(Headers headers) {
  11668. default_headers_ = std::move(headers);
  11669. return *this;
  11670. }
  11671. inline Server &Server::set_header_writer(
  11672. std::function<ssize_t(Stream &, Headers &)> const &writer) {
  11673. header_writer_ = writer;
  11674. return *this;
  11675. }
  11676. inline Server &
  11677. Server::set_trusted_proxies(const std::vector<std::string> &proxies) {
  11678. trusted_proxies_ = proxies;
  11679. return *this;
  11680. }
  11681. inline Server &Server::set_keep_alive_max_count(size_t count) {
  11682. keep_alive_max_count_ = count;
  11683. return *this;
  11684. }
  11685. inline Server &Server::set_keep_alive_timeout(time_t sec) {
  11686. keep_alive_timeout_sec_ = sec;
  11687. return *this;
  11688. }
  11689. template <class Rep, class Period>
  11690. inline Server &Server::set_keep_alive_timeout(
  11691. const std::chrono::duration<Rep, Period> &duration) {
  11692. detail::duration_to_sec_and_usec(duration, [&](time_t sec, time_t /*usec*/) {
  11693. set_keep_alive_timeout(sec);
  11694. });
  11695. return *this;
  11696. }
  11697. inline Server &Server::set_read_timeout(time_t sec, time_t usec) {
  11698. read_timeout_sec_ = sec;
  11699. read_timeout_usec_ = usec;
  11700. return *this;
  11701. }
  11702. inline Server &Server::set_write_timeout(time_t sec, time_t usec) {
  11703. write_timeout_sec_ = sec;
  11704. write_timeout_usec_ = usec;
  11705. return *this;
  11706. }
  11707. inline Server &Server::set_idle_interval(time_t sec, time_t usec) {
  11708. idle_interval_sec_ = sec;
  11709. idle_interval_usec_ = usec;
  11710. return *this;
  11711. }
  11712. inline Server &Server::set_payload_max_length(size_t length) {
  11713. payload_max_length_ = length;
  11714. return *this;
  11715. }
  11716. inline Server &Server::set_static_file_compression(bool on) {
  11717. static_file_compression_ = on;
  11718. return *this;
  11719. }
  11720. inline Server &Server::set_static_file_compression_min_length(size_t length) {
  11721. static_file_compression_min_length_ = length;
  11722. return *this;
  11723. }
  11724. inline Server &Server::set_static_file_compression_max_length(size_t length) {
  11725. static_file_compression_max_length_ = length;
  11726. return *this;
  11727. }
  11728. inline Server &Server::set_websocket_max_missed_pongs(int count) {
  11729. websocket_max_missed_pongs_ = count;
  11730. return *this;
  11731. }
  11732. inline Server &Server::set_websocket_ping_interval(time_t sec) {
  11733. websocket_ping_interval_sec_ = sec;
  11734. return *this;
  11735. }
  11736. template <class Rep, class Period>
  11737. inline Server &Server::set_websocket_ping_interval(
  11738. const std::chrono::duration<Rep, Period> &duration) {
  11739. detail::duration_to_sec_and_usec(duration, [&](time_t sec, time_t /*usec*/) {
  11740. set_websocket_ping_interval(sec);
  11741. });
  11742. return *this;
  11743. }
  11744. inline bool Server::bind_to_port(const std::string &host, int port,
  11745. int socket_flags) {
  11746. auto ret = bind_internal(host, port, socket_flags);
  11747. if (ret == -1) { is_decommissioned = true; }
  11748. return ret >= 0;
  11749. }
  11750. inline int Server::bind_to_any_port(const std::string &host, int socket_flags) {
  11751. auto ret = bind_internal(host, 0, socket_flags);
  11752. if (ret == -1) { is_decommissioned = true; }
  11753. return ret;
  11754. }
  11755. inline bool Server::listen_after_bind() { return listen_internal(); }
  11756. inline bool Server::listen(const std::string &host, int port,
  11757. int socket_flags) {
  11758. return bind_to_port(host, port, socket_flags) && listen_internal();
  11759. }
  11760. inline bool Server::is_running() const { return is_running_; }
  11761. inline void Server::wait_until_ready() const {
  11762. while (!is_running_ && !is_decommissioned) {
  11763. std::this_thread::sleep_for(std::chrono::milliseconds{1});
  11764. }
  11765. }
  11766. inline void Server::stop() noexcept {
  11767. // Release the listening socket whether or not the accept loop is running:
  11768. // bind_to_port() without listen_after_bind() still owns the descriptor. The
  11769. // exchange is what makes this safe to call concurrently with the accept loop.
  11770. socket_t sock = svr_sock_.exchange(INVALID_SOCKET);
  11771. if (sock != INVALID_SOCKET) {
  11772. detail::shutdown_socket(sock);
  11773. detail::close_socket(sock);
  11774. }
  11775. is_decommissioned = false;
  11776. }
  11777. inline void Server::decommission() { is_decommissioned = true; }
  11778. inline bool Server::parse_request_line(const char *s, Request &req) const {
  11779. auto len = strlen(s);
  11780. if (len < 2 || s[len - 2] != '\r' || s[len - 1] != '\n') { return false; }
  11781. len -= 2;
  11782. {
  11783. // RFC 9112 §3: exactly one SP between the method, the target and the
  11784. // version. Taking other whitespace as a separator too lets recipients
  11785. // that parse more strictly see a different request.
  11786. auto end = s + len;
  11787. if (std::count(s, end, ' ') != 2) { return false; }
  11788. auto sp1 = std::find(s, end, ' ');
  11789. auto sp2 = std::find(sp1 + 1, end, ' ');
  11790. if (sp1 == s || sp2 == sp1 + 1 || sp2 + 1 == end) { return false; }
  11791. req.method.assign(s, sp1);
  11792. req.target.assign(sp1 + 1, sp2);
  11793. req.version.assign(sp2 + 1, end);
  11794. }
  11795. // A method outside the built-in set is accepted only when a handler has been
  11796. // registered for it with CustomRoute().
  11797. const auto &methods = builtin_methods();
  11798. if (methods.find(req.method) == methods.end() &&
  11799. !find_custom_entry(req.method)) {
  11800. output_error_log(Error::InvalidHTTPMethod, &req);
  11801. return false;
  11802. }
  11803. if (req.version != "HTTP/1.1" && req.version != "HTTP/1.0") {
  11804. output_error_log(Error::InvalidHTTPVersion, &req);
  11805. return false;
  11806. }
  11807. // A request-target has no fragment (RFC 9112 §3.2), and one stripped here
  11808. // would leave this server routing a different path than a cache or a
  11809. // filter in front of it sees.
  11810. if (!detail::fields::is_request_target(req.target) ||
  11811. req.target.find('#') != std::string::npos) {
  11812. return false;
  11813. }
  11814. {
  11815. detail::divide(req.target, '?',
  11816. [&](const char *lhs_data, std::size_t lhs_size,
  11817. const char *rhs_data, std::size_t rhs_size) {
  11818. req.path =
  11819. decode_path_component(std::string(lhs_data, lhs_size));
  11820. detail::parse_query_text(rhs_data, rhs_size, req.params);
  11821. });
  11822. }
  11823. return true;
  11824. }
  11825. inline bool Server::write_response(Stream &strm, bool close_connection,
  11826. Request &req, Response &res) {
  11827. // NOTE: `req.ranges` should be empty, otherwise it will be applied
  11828. // incorrectly to the error content.
  11829. req.ranges.clear();
  11830. return write_response_core(strm, close_connection, req, res, false);
  11831. }
  11832. inline bool Server::write_response_with_content(Stream &strm,
  11833. bool close_connection,
  11834. const Request &req,
  11835. Response &res) {
  11836. return write_response_core(strm, close_connection, req, res, true);
  11837. }
  11838. inline bool Server::write_response_core(Stream &strm, bool close_connection,
  11839. const Request &req, Response &res,
  11840. bool need_apply_ranges) {
  11841. assert(res.status != -1);
  11842. if (400 <= res.status && error_handler_ &&
  11843. error_handler_(req, res) == HandlerResponse::Handled) {
  11844. need_apply_ranges = true;
  11845. }
  11846. if (!detail::body_allowed_for_status(res.status)) {
  11847. detail::clear_content(res);
  11848. }
  11849. detail::prefer_assigned_body(res);
  11850. std::string content_type;
  11851. std::string boundary;
  11852. if (need_apply_ranges) { apply_ranges(req, res, content_type, boundary); }
  11853. // Prepare additional headers
  11854. if (close_connection ||
  11855. detail::has_header_token(req.headers, "Connection", "close") ||
  11856. 400 <= res.status || // Don't leave connections open after errors
  11857. // The client withholds the body until `100 Continue`, which was never
  11858. // sent, so whether and when the body follows is unknown.
  11859. (req.expect_100_continue_pending_ && detail::has_framed_body(req)) ||
  11860. // The body was left partway, e.g. by a content receiver that returned
  11861. // false, so the rest of it cannot be told from the next request.
  11862. (req.body_read_started_ && !req.body_consumed_)) {
  11863. res.set_header("Connection", "close");
  11864. } else {
  11865. std::string s = "timeout=";
  11866. s += std::to_string(keep_alive_timeout_sec_);
  11867. if (keep_alive_max_count_ > 0) {
  11868. s += ", max=";
  11869. s += std::to_string(keep_alive_max_count_);
  11870. }
  11871. res.set_header("Keep-Alive", s);
  11872. }
  11873. if ((!res.body.empty() || res.content_length_ > 0 || res.content_provider_) &&
  11874. !res.has_header("Content-Type")) {
  11875. res.set_header("Content-Type", "text/plain");
  11876. }
  11877. detail::set_framing_headers(req, res, boundary, content_type);
  11878. if (req.method == "HEAD" && !res.has_header("Accept-Ranges")) {
  11879. res.set_header("Accept-Ranges", "bytes");
  11880. }
  11881. if (post_routing_handler_) {
  11882. post_routing_handler_(req, res);
  11883. // Again, for a body or framing headers the handler changed.
  11884. detail::set_framing_headers(req, res, boundary, content_type);
  11885. }
  11886. // Response line and headers
  11887. detail::BufferStream bstrm;
  11888. if (!detail::write_response_line(bstrm, res.status)) { return false; }
  11889. if (header_writer_(bstrm, res.headers) <= 0) { return false; }
  11890. // Combine a small body with the headers so the whole response leaves in a
  11891. // single write. A large body is written on its own instead: a copy of it
  11892. // costs more than the extra write saves.
  11893. auto send_body =
  11894. req.method != "HEAD" && detail::body_allowed_for_status(res.status);
  11895. auto body_is_separate = false;
  11896. auto provider_done = false;
  11897. if (send_body && !res.body.empty() && !res.content_provider_) {
  11898. if (res.body.size() < CPPHTTPLIB_SEND_BUFSIZ) {
  11899. bstrm.write(res.body.data(), res.body.size());
  11900. } else {
  11901. body_is_separate = true;
  11902. }
  11903. } else if (send_body && res.content_provider_ &&
  11904. res.is_file_content_provider_ &&
  11905. res.content_length_ < CPPHTTPLIB_SEND_BUFSIZ) {
  11906. // A small file is read into the same buffer. Other providers may produce
  11907. // their data over time, so they are never held back.
  11908. if (!write_content_with_provider(bstrm, req, res, boundary, content_type)) {
  11909. return false;
  11910. }
  11911. provider_done = true;
  11912. }
  11913. // Log before writing to avoid race condition with client-side code that
  11914. // accesses logger-captured data immediately after receiving the response.
  11915. output_log(req, res);
  11916. // Flush buffer
  11917. auto &data = bstrm.get_buffer();
  11918. if (!detail::write_data(strm, data.data(), data.size())) { return false; }
  11919. if (body_is_separate) {
  11920. return detail::write_data(strm, res.body.data(), res.body.size());
  11921. }
  11922. // Streaming body
  11923. if (send_body && res.content_provider_) {
  11924. if (!provider_done &&
  11925. !write_content_with_provider(strm, req, res, boundary, content_type)) {
  11926. return false;
  11927. }
  11928. res.content_provider_success_ = true;
  11929. }
  11930. return true;
  11931. }
  11932. inline bool
  11933. Server::write_content_with_provider(Stream &strm, const Request &req,
  11934. Response &res, const std::string &boundary,
  11935. const std::string &content_type) {
  11936. auto is_shutting_down = [this]() {
  11937. return this->svr_sock_ == INVALID_SOCKET;
  11938. };
  11939. if (res.content_length_ > 0) {
  11940. if (!detail::is_partial_content(req, res)) {
  11941. return detail::write_content(strm, res.content_provider_, 0,
  11942. res.content_length_, is_shutting_down);
  11943. } else if (req.ranges.size() == 1) {
  11944. auto offset_and_length = detail::get_range_offset_and_length(
  11945. req.ranges[0], res.content_length_);
  11946. return detail::write_content(strm, res.content_provider_,
  11947. offset_and_length.first,
  11948. offset_and_length.second, is_shutting_down);
  11949. } else {
  11950. return detail::write_multipart_ranges_data(
  11951. strm, req, res, boundary, content_type, res.content_length_,
  11952. is_shutting_down);
  11953. }
  11954. } else {
  11955. if (res.is_chunked_content_provider_) {
  11956. // Use the coding `apply_ranges()` chose when it wrote the headers;
  11957. // re-negotiating here would disagree with them, e.g. once a handler's
  11958. // own Content-Encoding header suppresses the negotiation.
  11959. auto compressor = detail::make_compressor(res.content_coding_);
  11960. if (!compressor) {
  11961. compressor = detail::make_unique<detail::nocompressor>();
  11962. }
  11963. return detail::write_content_chunked(strm, res.content_provider_,
  11964. is_shutting_down, *compressor);
  11965. } else {
  11966. return detail::write_content_without_length(strm, res.content_provider_,
  11967. is_shutting_down);
  11968. }
  11969. }
  11970. }
  11971. inline bool Server::read_content(Stream &strm, Request &req, Response &res) {
  11972. FormFields::iterator cur_field;
  11973. FormFiles::iterator cur_file;
  11974. auto is_text_field = false;
  11975. size_t count = 0;
  11976. if (read_content_core(
  11977. strm, req, res,
  11978. // Regular
  11979. [&](const char *buf, size_t n) {
  11980. // Prevent arithmetic overflow when checking sizes.
  11981. // Avoid computing (req.body.size() + n) directly because
  11982. // adding two unsigned `size_t` values can wrap around and
  11983. // produce a small result instead of indicating overflow.
  11984. // Instead, check using subtraction: ensure `n` does not
  11985. // exceed the remaining capacity `max_size() - size()`.
  11986. if (req.body.size() >= req.body.max_size() ||
  11987. n > req.body.max_size() - req.body.size()) {
  11988. return false;
  11989. }
  11990. // Limit decompressed body size to payload_max_length_ to protect
  11991. // against "zip bomb" attacks where a small compressed payload
  11992. // decompresses to a massive size.
  11993. if (payload_max_length_ > 0 &&
  11994. (req.body.size() >= payload_max_length_ ||
  11995. n > payload_max_length_ - req.body.size())) {
  11996. return false;
  11997. }
  11998. req.body.append(buf, n);
  11999. return true;
  12000. },
  12001. // Multipart FormData
  12002. [&](const FormData &file) {
  12003. if (CPPHTTPLIB_MULTIPART_FORM_DATA_FILE_MAX_COUNT > 0 &&
  12004. count++ == CPPHTTPLIB_MULTIPART_FORM_DATA_FILE_MAX_COUNT) {
  12005. output_error_log(Error::TooManyFormDataFiles, &req);
  12006. return false;
  12007. }
  12008. if (file.filename.empty()) {
  12009. cur_field = req.form.fields.emplace(
  12010. file.name, FormField{file.name, file.content, file.headers});
  12011. is_text_field = true;
  12012. } else {
  12013. cur_file = req.form.files.emplace(file.name, file);
  12014. is_text_field = false;
  12015. }
  12016. return true;
  12017. },
  12018. [&](const char *buf, size_t n) {
  12019. if (is_text_field) {
  12020. auto &content = cur_field->second.content;
  12021. if (content.size() + n > content.max_size()) { return false; }
  12022. content.append(buf, n);
  12023. } else {
  12024. auto &content = cur_file->second.content;
  12025. if (content.size() + n > content.max_size()) { return false; }
  12026. content.append(buf, n);
  12027. }
  12028. return true;
  12029. })) {
  12030. const auto &content_type = req.get_header_value("Content-Type");
  12031. if (detail::case_ignore::equal(detail::extract_media_type(content_type),
  12032. "application/x-www-form-urlencoded")) {
  12033. if (CPPHTTPLIB_FORM_URL_ENCODED_PAYLOAD_MAX_LENGTH > 0 &&
  12034. req.body.size() > CPPHTTPLIB_FORM_URL_ENCODED_PAYLOAD_MAX_LENGTH) {
  12035. res.status = StatusCode::PayloadTooLarge_413; // NOTE: should be 414?
  12036. output_error_log(Error::ExceedMaxPayloadSize, &req);
  12037. return false;
  12038. }
  12039. detail::parse_query_text(req.body, req.params);
  12040. }
  12041. return true;
  12042. }
  12043. return false;
  12044. }
  12045. inline bool Server::read_content_with_content_receiver(
  12046. Stream &strm, Request &req, Response &res, ContentReceiver receiver,
  12047. FormDataHeader multipart_header, ContentReceiver multipart_receiver) {
  12048. return read_content_core(strm, req, res, std::move(receiver),
  12049. std::move(multipart_header),
  12050. std::move(multipart_receiver));
  12051. }
  12052. inline bool Server::read_content_core(
  12053. Stream &strm, Request &req, Response &res, ContentReceiver receiver,
  12054. FormDataHeader multipart_header, ContentReceiver multipart_receiver) const {
  12055. detail::FormDataParser multipart_form_data_parser;
  12056. ContentReceiverWithProgress out;
  12057. if (req.is_multipart_form_data()) {
  12058. const auto &content_type = req.get_header_value("Content-Type");
  12059. std::string boundary;
  12060. if (!detail::parse_multipart_boundary(content_type, boundary)) {
  12061. res.status = StatusCode::BadRequest_400;
  12062. output_error_log(Error::MultipartParsing, &req);
  12063. return false;
  12064. }
  12065. multipart_form_data_parser.set_boundary(std::move(boundary));
  12066. out = [&](const char *buf, size_t n, size_t /*off*/, size_t /*len*/) {
  12067. return multipart_form_data_parser.parse(buf, n, multipart_header,
  12068. multipart_receiver);
  12069. };
  12070. } else {
  12071. out = [receiver](const char *buf, size_t n, size_t /*off*/,
  12072. size_t /*len*/) { return receiver(buf, n); };
  12073. }
  12074. // RFC 9112 §6: no Transfer-Encoding and no Content-Length means no body.
  12075. // For non-SSL builds we still scan non-persistent connections for stray
  12076. // body bytes so the payload limit is enforced (413). On keep-alive,
  12077. // pending bytes may be the next request (issue #2450), so skip.
  12078. #if !defined(CPPHTTPLIB_SSL_ENABLED)
  12079. if (!req.has_header("Content-Length") &&
  12080. !detail::is_chunked_transfer_encoding(req.headers)) {
  12081. if (!detail::is_connection_persistent(req) && payload_max_length_ > 0 &&
  12082. payload_max_length_ < (std::numeric_limits<size_t>::max)()) {
  12083. auto has_data = strm.is_readable();
  12084. if (!has_data) {
  12085. auto s = strm.socket();
  12086. if (s != INVALID_SOCKET) {
  12087. has_data = detail::select_read(s, 0, 0) > 0;
  12088. }
  12089. }
  12090. if (has_data) {
  12091. // Route through the same decompressing reader used by the
  12092. // length-framed and chunked paths below, so payload_max_length_ is
  12093. // enforced on the decompressed size here too instead of only on the
  12094. // compressed wire bytes.
  12095. return detail::read_content(strm, req, payload_max_length_, res.status,
  12096. nullptr, out, true);
  12097. }
  12098. }
  12099. return true;
  12100. }
  12101. #else
  12102. if (!req.has_header("Content-Length") &&
  12103. !detail::is_chunked_transfer_encoding(req.headers)) {
  12104. return true;
  12105. }
  12106. #endif
  12107. // A second read would start where the first one stopped, or in the next
  12108. // request.
  12109. if (req.body_read_started_) { return false; }
  12110. // The client is waiting for this before it sends the body.
  12111. if (req.expect_100_continue_pending_) {
  12112. req.expect_100_continue_pending_ = false;
  12113. detail::write_response_line(strm, StatusCode::Continue_100);
  12114. strm.write("\r\n");
  12115. }
  12116. // Set before reading, since a receiver may also stop by throwing.
  12117. req.body_read_started_ = true;
  12118. if (!detail::read_content(strm, req, payload_max_length_, res.status, nullptr,
  12119. out, true)) {
  12120. return false;
  12121. }
  12122. req.body_consumed_ = true;
  12123. if (req.is_multipart_form_data()) {
  12124. if (!multipart_form_data_parser.is_valid()) {
  12125. res.status = StatusCode::BadRequest_400;
  12126. output_error_log(Error::MultipartParsing, &req);
  12127. return false;
  12128. }
  12129. }
  12130. return true;
  12131. }
  12132. inline bool Server::handle_file_request(Request &req, Response &res) {
  12133. for (const auto &entry : base_dirs_) {
  12134. // Prefix match, on a path segment boundary. A mount point of "/mount"
  12135. // covers "/mount" and "/mount/...", but must not swallow "/mountdir/...".
  12136. // One that already ends in '/' (the root mount among them) carries its own
  12137. // boundary; set_mount_point() guarantees the mount point is not empty.
  12138. if (!req.path.compare(0, entry.mount_point.size(), entry.mount_point) &&
  12139. (entry.mount_point.back() == '/' ||
  12140. req.path.size() == entry.mount_point.size() ||
  12141. req.path[entry.mount_point.size()] == '/')) {
  12142. std::string sub_path = "/" + req.path.substr(entry.mount_point.size());
  12143. if (detail::is_valid_path(sub_path)) {
  12144. auto path = entry.base_dir + sub_path;
  12145. if (path.back() == '/') { path += "index.html"; }
  12146. // Defense-in-depth: is_valid_path blocks ".." traversal in the URL,
  12147. // but symlinks/junctions can still escape the base directory. A path
  12148. // that cannot be resolved, which includes one that does not exist, is
  12149. // not served from here.
  12150. std::string resolved_path;
  12151. if (!detail::canonicalize_path(path.c_str(), resolved_path)) {
  12152. continue;
  12153. }
  12154. if (!detail::is_path_within_base(resolved_path,
  12155. entry.resolved_base_dir)) {
  12156. res.status = StatusCode::Forbidden_403;
  12157. return true;
  12158. }
  12159. detail::FileStat stat(path);
  12160. if (stat.is_dir()) {
  12161. // Relative, so "//dir" cannot name another host; "./" keeps a ':'
  12162. // in the name from reading as a scheme.
  12163. auto name = req.path.substr(req.path.rfind('/') + 1);
  12164. res.set_redirect("./" + encode_path_component(name) + "/",
  12165. StatusCode::MovedPermanently_301);
  12166. return true;
  12167. }
  12168. if (stat.is_file()) {
  12169. for (const auto &kv : entry.headers) {
  12170. res.set_header(kv.first, kv.second);
  12171. }
  12172. auto content_type = detail::find_content_type(
  12173. path, file_extension_and_mimetype_map_, default_file_mimetype_);
  12174. auto encoding = detail::EncodingType::None;
  12175. if (static_file_compression_) {
  12176. encoding =
  12177. static_file_encoding(req, res, content_type, stat.size());
  12178. }
  12179. // The ETag names the representation actually sent, so a client that
  12180. // cached the compressed form revalidates against the compressed ETag
  12181. // and still gets a 304, while one that took identity keeps the plain
  12182. // ETag.
  12183. auto etag = detail::compute_etag(
  12184. stat, encoding == detail::EncodingType::None
  12185. ? std::string()
  12186. : std::string("-") + detail::encoding_name(encoding));
  12187. if (!etag.empty()) { res.set_header("ETag", etag); }
  12188. auto mtime = stat.mtime();
  12189. auto last_modified = detail::file_mtime_to_http_date(mtime);
  12190. if (!last_modified.empty()) {
  12191. res.set_header("Last-Modified", last_modified);
  12192. }
  12193. if (check_if_not_modified(req, res, etag, mtime)) { return true; }
  12194. check_if_range(req, etag, mtime);
  12195. auto mm = std::make_shared<detail::mmap>(path.c_str());
  12196. if (!mm->is_open()) {
  12197. output_error_log(Error::OpenFile, &req);
  12198. return false;
  12199. }
  12200. detail::set_file_content_provider(res, mm, content_type, encoding);
  12201. if (req.method != "HEAD" && file_request_handler_) {
  12202. file_request_handler_(req, res);
  12203. }
  12204. return true;
  12205. } else {
  12206. output_error_log(Error::OpenFile, &req);
  12207. }
  12208. }
  12209. }
  12210. }
  12211. return false;
  12212. }
  12213. inline bool Server::check_if_not_modified(const Request &req, Response &res,
  12214. const std::string &etag,
  12215. time_t mtime) const {
  12216. // Handle conditional GET:
  12217. // 1. If-None-Match takes precedence (RFC 9110 Section 13.1.2)
  12218. // 2. If-Modified-Since is checked only when If-None-Match is absent
  12219. if (req.has_header("If-None-Match")) {
  12220. if (!etag.empty()) {
  12221. auto val =
  12222. detail::get_combined_header_value(req.headers, "If-None-Match");
  12223. // NOTE: We use exact string matching here. This works correctly
  12224. // because our server always generates weak ETags (W/"..."), and
  12225. // clients typically send back the same ETag they received.
  12226. // RFC 9110 Section 8.8.3.2 allows weak comparison for
  12227. // If-None-Match, where W/"x" and "x" would match, but this
  12228. // simplified implementation requires exact matches.
  12229. auto ret = detail::split_find(val.data(), val.data() + val.size(), ',',
  12230. [&](const char *b, const char *e) {
  12231. auto seg_len = static_cast<size_t>(e - b);
  12232. return (seg_len == 1 && *b == '*') ||
  12233. (seg_len == etag.size() &&
  12234. std::equal(b, e, etag.begin()));
  12235. });
  12236. if (ret) {
  12237. res.status = StatusCode::NotModified_304;
  12238. return true;
  12239. }
  12240. }
  12241. } else if (req.has_header("If-Modified-Since")) {
  12242. auto val = req.get_header_value("If-Modified-Since");
  12243. auto t = detail::parse_http_date(val);
  12244. if (t != static_cast<time_t>(-1) && mtime <= t) {
  12245. res.status = StatusCode::NotModified_304;
  12246. return true;
  12247. }
  12248. }
  12249. return false;
  12250. }
  12251. inline bool Server::check_if_range(Request &req, const std::string &etag,
  12252. time_t mtime) const {
  12253. // Handle If-Range for partial content requests (RFC 9110
  12254. // Section 13.1.5). If-Range is only evaluated when Range header is
  12255. // present. If the validator matches, serve partial content; otherwise
  12256. // serve full content.
  12257. if (!req.ranges.empty() && req.has_header("If-Range")) {
  12258. auto val = req.get_header_value("If-Range");
  12259. auto is_valid_range = [&]() {
  12260. if (detail::is_strong_etag(val)) {
  12261. // RFC 9110 Section 13.1.5: If-Range requires strong ETag
  12262. // comparison.
  12263. return (!etag.empty() && val == etag);
  12264. } else if (detail::is_weak_etag(val)) {
  12265. // Weak ETags are not valid for If-Range (RFC 9110 Section 13.1.5)
  12266. return false;
  12267. } else {
  12268. // HTTP-date comparison
  12269. auto t = detail::parse_http_date(val);
  12270. return (t != static_cast<time_t>(-1) && mtime <= t);
  12271. }
  12272. };
  12273. if (!is_valid_range()) {
  12274. // Validator doesn't match: ignore Range and serve full content
  12275. req.ranges.clear();
  12276. return false;
  12277. }
  12278. }
  12279. return true;
  12280. }
  12281. inline socket_t
  12282. Server::create_server_socket(const std::string &host, int port,
  12283. int socket_flags,
  12284. SocketOptions socket_options) const {
  12285. return detail::create_socket(
  12286. host, std::string(), port, address_family_, socket_flags, tcp_nodelay_,
  12287. ipv6_v6only_, std::move(socket_options),
  12288. [&](socket_t sock, struct addrinfo &ai, bool & /*quit*/) -> bool {
  12289. if (::bind(sock, ai.ai_addr, static_cast<socklen_t>(ai.ai_addrlen))) {
  12290. output_error_log(Error::BindIPAddress, nullptr);
  12291. return false;
  12292. }
  12293. if (::listen(sock, CPPHTTPLIB_LISTEN_BACKLOG)) {
  12294. output_error_log(Error::Listen, nullptr);
  12295. return false;
  12296. }
  12297. return true;
  12298. });
  12299. }
  12300. inline int Server::bind_internal(const std::string &host, int port,
  12301. int socket_flags) {
  12302. if (is_decommissioned) { return -1; }
  12303. if (!is_valid()) { return -1; }
  12304. svr_sock_ = create_server_socket(host, port, socket_flags, socket_options_);
  12305. if (svr_sock_ == INVALID_SOCKET) { return -1; }
  12306. if (port == 0) {
  12307. struct sockaddr_storage addr;
  12308. socklen_t addr_len = sizeof(addr);
  12309. if (getsockname(svr_sock_, reinterpret_cast<struct sockaddr *>(&addr),
  12310. &addr_len) == -1) {
  12311. output_error_log(Error::GetSockName, nullptr);
  12312. return -1;
  12313. }
  12314. if (addr.ss_family == AF_INET) {
  12315. return ntohs(reinterpret_cast<struct sockaddr_in *>(&addr)->sin_port);
  12316. } else if (addr.ss_family == AF_INET6) {
  12317. return ntohs(reinterpret_cast<struct sockaddr_in6 *>(&addr)->sin6_port);
  12318. } else {
  12319. output_error_log(Error::UnsupportedAddressFamily, nullptr);
  12320. return -1;
  12321. }
  12322. } else {
  12323. return port;
  12324. }
  12325. }
  12326. inline bool Server::listen_internal() {
  12327. // A stop() between bind and listen leaves nothing to accept on. Report
  12328. // failure instead of returning success without ever serving, and mark the
  12329. // server decommissioned the way any failed listen does so that a concurrent
  12330. // wait_until_ready() wakes up instead of spinning forever.
  12331. if (is_decommissioned || svr_sock_ == INVALID_SOCKET) {
  12332. is_decommissioned = true;
  12333. return false;
  12334. }
  12335. auto ret = true;
  12336. is_running_ = true;
  12337. auto se = detail::scope_exit([&]() { is_running_ = false; });
  12338. if (start_handler_) { start_handler_(); }
  12339. {
  12340. std::unique_ptr<TaskQueue> task_queue(new_task_queue());
  12341. while (svr_sock_ != INVALID_SOCKET) {
  12342. #ifndef _WIN32
  12343. if (idle_interval_sec_ > 0 || idle_interval_usec_ > 0) {
  12344. #endif
  12345. auto val = detail::select_read(svr_sock_, idle_interval_sec_,
  12346. idle_interval_usec_);
  12347. if (val == 0) { // Timeout
  12348. task_queue->on_idle();
  12349. continue;
  12350. }
  12351. #ifndef _WIN32
  12352. }
  12353. #endif
  12354. #if defined _WIN32
  12355. // sockets connected via WASAccept inherit flags NO_HANDLE_INHERIT,
  12356. // OVERLAPPED
  12357. socket_t sock = WSAAccept(svr_sock_, nullptr, nullptr, nullptr, 0);
  12358. #elif defined SOCK_CLOEXEC
  12359. socket_t sock = accept4(svr_sock_, nullptr, nullptr, SOCK_CLOEXEC);
  12360. #else
  12361. socket_t sock = accept(svr_sock_, nullptr, nullptr);
  12362. #endif
  12363. if (sock == INVALID_SOCKET) {
  12364. // NOTE: Winsock reports failures through WSAGetLastError() and never
  12365. // touches the CRT errno, so the two have to be asked platform by
  12366. // platform rather than by testing errno here.
  12367. if (detail::is_accept_resource_error()) {
  12368. // The per-process descriptor limit or the network stack's buffer
  12369. // space has been reached. Try to accept new connections after a
  12370. // short sleep.
  12371. std::this_thread::sleep_for(std::chrono::microseconds{1});
  12372. continue;
  12373. } else if (detail::is_accept_transient_error()) {
  12374. continue;
  12375. }
  12376. // Take the descriptor out of svr_sock_ before closing it: a later
  12377. // stop() would otherwise shutdown()/close() a value the OS may have
  12378. // reused, and keep_alive() watches svr_sock_ to notice the server is
  12379. // gone. The exchange also settles the race with a concurrent stop(),
  12380. // since whichever side takes the descriptor closes it exactly once.
  12381. auto listen_sock = svr_sock_.exchange(INVALID_SOCKET);
  12382. if (listen_sock != INVALID_SOCKET) {
  12383. detail::close_socket(listen_sock);
  12384. ret = false;
  12385. output_error_log(Error::Connection, nullptr);
  12386. } else {
  12387. ; // The server socket was closed by user.
  12388. }
  12389. break;
  12390. }
  12391. detail::set_socket_opt_time(sock, SOL_SOCKET, SO_RCVTIMEO,
  12392. read_timeout_sec_, read_timeout_usec_);
  12393. detail::set_socket_opt_time(sock, SOL_SOCKET, SO_SNDTIMEO,
  12394. write_timeout_sec_, write_timeout_usec_);
  12395. if (tcp_nodelay_) { set_socket_opt(sock, IPPROTO_TCP, TCP_NODELAY, 1); }
  12396. if (!task_queue->enqueue(
  12397. [this, sock]() { process_and_close_socket(sock); })) {
  12398. output_error_log(Error::ResourceExhaustion, nullptr);
  12399. detail::shutdown_socket(sock);
  12400. detail::close_socket(sock);
  12401. }
  12402. }
  12403. task_queue->shutdown();
  12404. }
  12405. is_decommissioned = !ret;
  12406. return ret;
  12407. }
  12408. inline bool Server::routing(Request &req, Response &res, Stream &strm,
  12409. bool skip_pre_routing) {
  12410. if (!skip_pre_routing && pre_routing_handler_ &&
  12411. pre_routing_handler_(req, res) == HandlerResponse::Handled) {
  12412. return true;
  12413. }
  12414. // File handler
  12415. if ((req.method == "GET" || req.method == "HEAD") &&
  12416. handle_file_request(req, res)) {
  12417. return true;
  12418. }
  12419. const auto *custom = find_custom_entry(req.method);
  12420. // The second clause mirrors what expect_content() does unconditionally for
  12421. // POST/PUT/PATCH/DELETE: a content reader route fires even when the request
  12422. // carries no body. Without it a body-less PROPFIND (RFC 4918 treats one as
  12423. // `allprop`) would skip its handler and fall through to 404.
  12424. if (detail::expect_content(req) ||
  12425. (custom && !custom->handlers_for_content_reader.empty())) {
  12426. // Content reader handler
  12427. {
  12428. // Track whether the ContentReader was aborted due to the decompressed
  12429. // payload exceeding `payload_max_length_`.
  12430. // The user handler runs after the lambda returns, so we must restore the
  12431. // 413 status if the handler overwrites it.
  12432. bool content_reader_payload_too_large = false;
  12433. ContentReader reader(
  12434. [&](ContentReceiver receiver) {
  12435. auto result = read_content_with_content_receiver(
  12436. strm, req, res, std::move(receiver), nullptr, nullptr);
  12437. if (!result) {
  12438. output_error_log(Error::Read, &req);
  12439. if (res.status == StatusCode::PayloadTooLarge_413) {
  12440. content_reader_payload_too_large = true;
  12441. }
  12442. }
  12443. return result;
  12444. },
  12445. [&](FormDataHeader header, ContentReceiver receiver) {
  12446. auto result = read_content_with_content_receiver(
  12447. strm, req, res, nullptr, std::move(header),
  12448. std::move(receiver));
  12449. if (!result) {
  12450. output_error_log(Error::Read, &req);
  12451. if (res.status == StatusCode::PayloadTooLarge_413) {
  12452. content_reader_payload_too_large = true;
  12453. }
  12454. }
  12455. return result;
  12456. });
  12457. bool dispatched = false;
  12458. if (req.method == "POST") {
  12459. dispatched = dispatch_request_for_content_reader(
  12460. req, res, std::move(reader), post_handlers_for_content_reader_);
  12461. } else if (req.method == "PUT") {
  12462. dispatched = dispatch_request_for_content_reader(
  12463. req, res, std::move(reader), put_handlers_for_content_reader_);
  12464. } else if (req.method == "PATCH") {
  12465. dispatched = dispatch_request_for_content_reader(
  12466. req, res, std::move(reader), patch_handlers_for_content_reader_);
  12467. } else if (req.method == "DELETE") {
  12468. dispatched = dispatch_request_for_content_reader(
  12469. req, res, std::move(reader), delete_handlers_for_content_reader_);
  12470. } else if (custom) {
  12471. dispatched = dispatch_request_for_content_reader(
  12472. req, res, std::move(reader), custom->handlers_for_content_reader);
  12473. }
  12474. if (dispatched) {
  12475. if (content_reader_payload_too_large) {
  12476. // Enforce the limit: override any status the handler may have set
  12477. // and return false so the error path sends a plain 413 response.
  12478. res.status = StatusCode::PayloadTooLarge_413;
  12479. detail::clear_content(res);
  12480. return false;
  12481. }
  12482. return true;
  12483. }
  12484. }
  12485. // NOTE: `req.body` is not read here. For a regular handler the body is
  12486. // read inside dispatch_request(), after the route has matched and the
  12487. // pre-request handler has approved the request, so that a rejected
  12488. // request (e.g. failed authentication) never forces us to buffer a
  12489. // potentially large body.
  12490. }
  12491. // Regular handler
  12492. if (req.method == "GET" || req.method == "HEAD") {
  12493. return dispatch_request(req, res, get_handlers_, strm);
  12494. } else if (req.method == "POST") {
  12495. return dispatch_request(req, res, post_handlers_, strm);
  12496. } else if (req.method == "PUT") {
  12497. return dispatch_request(req, res, put_handlers_, strm);
  12498. } else if (req.method == "DELETE") {
  12499. return dispatch_request(req, res, delete_handlers_, strm);
  12500. } else if (req.method == "OPTIONS") {
  12501. return dispatch_request(req, res, options_handlers_, strm);
  12502. } else if (req.method == "PATCH") {
  12503. return dispatch_request(req, res, patch_handlers_, strm);
  12504. } else if (custom) {
  12505. return dispatch_request(req, res, custom->handlers, strm);
  12506. }
  12507. res.status = StatusCode::BadRequest_400;
  12508. return false;
  12509. }
  12510. inline bool Server::dispatch_request(Request &req, Response &res,
  12511. const Handlers &handlers, Stream &strm) {
  12512. for (const auto &x : handlers) {
  12513. const auto &matcher = x.first;
  12514. const auto &handler = x.second;
  12515. if (matcher->match(req)) {
  12516. req.matched_route = matcher->pattern();
  12517. // Run the pre-request handler before reading the body so a rejected
  12518. // request (e.g. failed authentication) never forces us to buffer a
  12519. // potentially large body. `req.matched_route` is available here.
  12520. if (pre_request_handler_ &&
  12521. pre_request_handler_(req, res) == HandlerResponse::Handled) {
  12522. return true;
  12523. }
  12524. // The route matched and the request was approved; read the body now.
  12525. if (detail::expect_content(req) && !read_content(strm, req, res)) {
  12526. output_error_log(Error::Read, &req);
  12527. return false;
  12528. }
  12529. handler(req, res);
  12530. return true;
  12531. }
  12532. }
  12533. return false;
  12534. }
  12535. // Decides the content coding for a response served straight from a file. Both
  12536. // the ETag, which has to name the representation actually sent, and
  12537. // `apply_static_file_compression()` go through this, so the two cannot drift
  12538. // apart.
  12539. inline detail::EncodingType
  12540. Server::static_file_encoding(const Request &req, const Response &res,
  12541. const std::string &content_type,
  12542. size_t length) const {
  12543. if (!static_file_compression_) { return detail::EncodingType::None; }
  12544. // Nothing to compress, and an empty file already answers with
  12545. // `Content-Length: 0`. Checked on its own so that a zero floor still cannot
  12546. // turn an empty body into a 20-byte gzip stream.
  12547. if (length == 0) { return detail::EncodingType::None; }
  12548. // A file that already fits in a single packet gains nothing from being made
  12549. // smaller, since it still travels in that one segment, and a file of a few
  12550. // bytes comes out larger than it went in.
  12551. if (length < static_file_compression_min_length_) {
  12552. return detail::EncodingType::None;
  12553. }
  12554. // RFC 9110 applies Range to the representation after content coding, so a
  12555. // compressed 206 would mean compressing the whole file and then slicing it.
  12556. // Serve ranges from the identity representation instead.
  12557. if (!req.ranges.empty()) { return detail::EncodingType::None; }
  12558. if (static_file_compression_max_length_ > 0 &&
  12559. length > static_file_compression_max_length_) {
  12560. return detail::EncodingType::None;
  12561. }
  12562. return detail::encoding_type(req, res, content_type);
  12563. }
  12564. // Compresses a file-backed content provider into `res.body`. Returns false when
  12565. // the response is left untouched.
  12566. inline bool Server::apply_static_file_compression(const Request &req,
  12567. Response &res) const {
  12568. auto type = res.content_coding_;
  12569. if (type == detail::EncodingType::None || !res.content_provider_) {
  12570. return false;
  12571. }
  12572. auto compressor = detail::make_compressor(type);
  12573. if (!compressor) { return false; }
  12574. output_pre_compression_log(req, res);
  12575. std::string compressed;
  12576. if (!detail::compress_content_provider(res.content_provider_,
  12577. res.content_length_, *compressor,
  12578. compressed)) {
  12579. return false;
  12580. }
  12581. res.body.swap(compressed);
  12582. // The provider was consumed in full, so its releaser hears about a success.
  12583. res.content_provider_success_ = true;
  12584. detail::clear_content_provider(res);
  12585. res.set_header("Content-Encoding", detail::encoding_name(type));
  12586. res.set_header("Vary", "Accept-Encoding");
  12587. return true;
  12588. }
  12589. inline void Server::apply_ranges(const Request &req, Response &res,
  12590. std::string &content_type,
  12591. std::string &boundary) const {
  12592. // A known-length content provider leaves `res.body` empty, so the compressor
  12593. // at the end of this function never runs for one (issue #2545). A file-backed
  12594. // provider is fully readable right here, so compress it and answer with an
  12595. // ordinary body: `Content-Length` and HEAD keep working, and the response
  12596. // takes the same path as `set_content()` from here on. Range requests never
  12597. // get a content coding, so `Content-Range` still names identity bytes and
  12598. // none of the range handling below applies.
  12599. if (apply_static_file_compression(req, res)) { return; }
  12600. if (req.ranges.size() > 1 && res.status == StatusCode::PartialContent_206) {
  12601. auto it = res.headers.find("Content-Type");
  12602. if (it != res.headers.end()) {
  12603. content_type = it->second;
  12604. res.headers.erase(it);
  12605. }
  12606. boundary = detail::make_multipart_data_boundary();
  12607. res.set_header("Content-Type",
  12608. "multipart/byteranges; boundary=" + boundary);
  12609. }
  12610. auto type = detail::encoding_type(req, res);
  12611. if (res.body.empty()) {
  12612. if (res.content_length_ > 0 && req.ranges.size() == 1 &&
  12613. res.status == StatusCode::PartialContent_206) {
  12614. auto offset_and_length = detail::get_range_offset_and_length(
  12615. req.ranges[0], res.content_length_);
  12616. auto content_range = detail::make_content_range_header_field(
  12617. offset_and_length, res.content_length_);
  12618. res.set_header("Content-Range", content_range);
  12619. } else if (res.is_chunked_content_provider_) {
  12620. res.content_coding_ = type;
  12621. if (type != detail::EncodingType::None) {
  12622. res.set_header("Content-Encoding", detail::encoding_name(type));
  12623. res.set_header("Vary", "Accept-Encoding");
  12624. }
  12625. }
  12626. } else {
  12627. if (req.ranges.empty() || res.status != StatusCode::PartialContent_206) {
  12628. ;
  12629. } else if (req.ranges.size() == 1) {
  12630. auto offset_and_length =
  12631. detail::get_range_offset_and_length(req.ranges[0], res.body.size());
  12632. auto offset = offset_and_length.first;
  12633. auto length = offset_and_length.second;
  12634. auto content_range = detail::make_content_range_header_field(
  12635. offset_and_length, res.body.size());
  12636. res.set_header("Content-Range", content_range);
  12637. assert(offset + length <= res.body.size());
  12638. res.body = res.body.substr(offset, length);
  12639. } else {
  12640. std::string data;
  12641. detail::make_multipart_ranges_data(req, res, boundary, content_type,
  12642. res.body.size(), data);
  12643. res.body.swap(data);
  12644. }
  12645. if (type != detail::EncodingType::None) {
  12646. output_pre_compression_log(req, res);
  12647. if (auto compressor = detail::make_compressor(type)) {
  12648. std::string compressed;
  12649. if (compressor->compress(res.body.data(), res.body.size(), true,
  12650. [&](const char *data, size_t data_len) {
  12651. compressed.append(data, data_len);
  12652. return true;
  12653. })) {
  12654. res.body.swap(compressed);
  12655. res.set_header("Content-Encoding", detail::encoding_name(type));
  12656. res.set_header("Vary", "Accept-Encoding");
  12657. }
  12658. }
  12659. }
  12660. res.content_length_ = res.body.size();
  12661. }
  12662. }
  12663. inline bool Server::dispatch_request_for_content_reader(
  12664. Request &req, Response &res, ContentReader content_reader,
  12665. const HandlersForContentReader &handlers) const {
  12666. for (const auto &x : handlers) {
  12667. const auto &matcher = x.first;
  12668. const auto &handler = x.second;
  12669. if (matcher->match(req)) {
  12670. req.matched_route = matcher->pattern();
  12671. if (!pre_request_handler_ ||
  12672. pre_request_handler_(req, res) != HandlerResponse::Handled) {
  12673. handler(req, res, content_reader);
  12674. }
  12675. return true;
  12676. }
  12677. }
  12678. return false;
  12679. }
  12680. inline std::string
  12681. get_client_ip(const std::string &x_forwarded_for,
  12682. const std::vector<std::string> &trusted_proxies) {
  12683. // X-Forwarded-For is a comma-separated list per RFC 7239
  12684. std::vector<std::string> ip_list;
  12685. detail::split(x_forwarded_for.data(),
  12686. x_forwarded_for.data() + x_forwarded_for.size(), ',',
  12687. [&](const char *b, const char *e) {
  12688. auto r = detail::trim(b, e, 0, static_cast<size_t>(e - b));
  12689. ip_list.emplace_back(std::string(b + r.first, b + r.second));
  12690. });
  12691. // A malformed X-Forwarded-For (empty, comma-only, whitespace-only) yields
  12692. // no segments. Signal "no client IP derived" with an empty string so the
  12693. // caller can fall back to the connection-level remote address.
  12694. if (ip_list.empty()) { return std::string(); }
  12695. // Each hop appends the address it received the request from, so the rightmost
  12696. // entries are the ones written by our own infrastructure while the leftmost
  12697. // are whatever the original client chose to send. Walk from the right and
  12698. // skip trusted proxies; the first address that is not a trusted proxy is the
  12699. // furthest point still attributable to a real hop, i.e. the client. Scanning
  12700. // from the left instead lets a client forge an arbitrary address by following
  12701. // it with a trusted proxy's address, which the left-to-right scan then
  12702. // returned as the client.
  12703. for (size_t i = ip_list.size(); i-- > 0;) {
  12704. const auto &ip = ip_list[i];
  12705. auto is_trusted_proxy =
  12706. std::any_of(trusted_proxies.begin(), trusted_proxies.end(),
  12707. [&](const std::string &proxy) { return ip == proxy; });
  12708. if (!is_trusted_proxy) { return ip; }
  12709. }
  12710. // Every hop was a trusted proxy; fall back to the first entry.
  12711. return ip_list.front();
  12712. }
  12713. inline bool
  12714. Server::process_request(Stream &strm, const std::string &remote_addr,
  12715. int remote_port, const std::string &local_addr,
  12716. int local_port, bool close_connection,
  12717. bool &connection_closed,
  12718. const std::function<void(Request &)> &setup_request,
  12719. bool *websocket_upgraded) {
  12720. std::array<char, 2048> buf{};
  12721. detail::stream_line_reader line_reader(strm, buf.data(), buf.size());
  12722. // The read timeout bounds the request line and headers as a whole, so a
  12723. // client sending them a byte at a time cannot hold the worker any longer.
  12724. strm.set_max_timeout(read_timeout_sec_ * 1000 + read_timeout_usec_ / 1000);
  12725. // Connection has been closed on client
  12726. if (!line_reader.getline()) { return false; }
  12727. // RFC 9112 2.2: ignore an empty line received before the request-line. Some
  12728. // clients send an extra CRLF after a request body, which would otherwise be
  12729. // parsed as the next request on a persistent connection.
  12730. if (strcmp(line_reader.ptr(), "\r\n") == 0 && !line_reader.getline()) {
  12731. return false;
  12732. }
  12733. Request req;
  12734. req.start_time_ = std::chrono::steady_clock::now();
  12735. req.remote_addr = remote_addr;
  12736. req.remote_port = remote_port;
  12737. req.local_addr = local_addr;
  12738. req.local_port = local_port;
  12739. Response res;
  12740. res.version = "HTTP/1.1";
  12741. res.headers = default_headers_;
  12742. // RFC 9112 §9.6: a server that sends the "close" connection option must
  12743. // close the connection after that response, whichever path wrote it (an
  12744. // error status, a handler, or a rejected request). Reading on would also
  12745. // parse whatever the client sent next on a connection it considers done.
  12746. auto honor_connection_close = detail::scope_exit([&] {
  12747. if (detail::has_header_token(res.headers, "Connection", "close")) {
  12748. connection_closed = true;
  12749. }
  12750. });
  12751. // Request line and headers. A rejected message leaves the rest of it (and
  12752. // any body) unread, so the connection cannot be reused: the leftover bytes
  12753. // would be parsed as the next request.
  12754. if (!parse_request_line(line_reader.ptr(), req)) {
  12755. connection_closed = true;
  12756. res.status = StatusCode::BadRequest_400;
  12757. output_error_log(Error::InvalidRequestLine, &req);
  12758. return write_response(strm, close_connection, req, res);
  12759. }
  12760. // Request headers
  12761. if (!detail::read_headers(strm, req.headers)) {
  12762. connection_closed = true;
  12763. res.status = StatusCode::BadRequest_400;
  12764. output_error_log(Error::InvalidHeaders, &req);
  12765. return write_response(strm, close_connection, req, res);
  12766. }
  12767. strm.set_max_timeout(0);
  12768. // RFC 9112 §6.3: Reject requests whose framing is invalid or ambiguous,
  12769. // which would otherwise let an intermediary and this parser disagree on
  12770. // where the body ends and enable request smuggling. Three cases: a
  12771. // Content-Length that is not a valid decimal length (e.g. "42, 42", "+42"
  12772. // or empty), which would otherwise be read as "no body"; a non-zero
  12773. // Content-Length alongside any Transfer-Encoding (Content-Length: 0 is
  12774. // tolerated for compatibility with existing clients); and a
  12775. // Transfer-Encoding whose final coding is not chunked, which leaves the body
  12776. // length undeterminable. None of them may fall through to the "no body"
  12777. // path, or the body bytes are parsed as the next request on a persistent
  12778. // connection.
  12779. auto is_invalid_content_length = false;
  12780. detail::get_header_value_u64(req.headers, "Content-Length", 0, 0,
  12781. is_invalid_content_length);
  12782. if (is_invalid_content_length ||
  12783. detail::has_conflicting_content_length(req.headers) ||
  12784. (req.has_header("Transfer-Encoding") &&
  12785. !detail::is_chunked_transfer_encoding(req.headers))) {
  12786. connection_closed = true;
  12787. res.status = StatusCode::BadRequest_400;
  12788. return write_response(strm, close_connection, req, res);
  12789. }
  12790. // RFC 9112 §6.1: a Transfer-Encoding alongside a Content-Length, or in an
  12791. // HTTP/1.0 request, is honoured, but the connection closes after the
  12792. // response.
  12793. if (detail::has_faulty_transfer_encoding(req)) { connection_closed = true; }
  12794. // RFC 9112 §3.2: Reject more than one Host field line, an invalid Host
  12795. // value, or none in HTTP/1.1, so that every recipient of the request sees
  12796. // the same authority.
  12797. auto host_count = req.get_header_value_count("Host");
  12798. if (host_count > 1 || (host_count == 0 && req.version == "HTTP/1.1") ||
  12799. !detail::fields::is_host(req.get_header_value("Host"))) {
  12800. connection_closed = true;
  12801. res.status = StatusCode::BadRequest_400;
  12802. output_error_log(Error::InvalidHeaders, &req);
  12803. return write_response(strm, close_connection, req, res);
  12804. }
  12805. // Check if the request URI doesn't exceed the limit
  12806. if (req.target.size() > CPPHTTPLIB_REQUEST_URI_MAX_LENGTH) {
  12807. connection_closed = true;
  12808. res.status = StatusCode::UriTooLong_414;
  12809. output_error_log(Error::ExceedUriMaxLength, &req);
  12810. return write_response(strm, close_connection, req, res);
  12811. }
  12812. if (detail::has_header_token(req.headers, "Connection", "close")) {
  12813. connection_closed = true;
  12814. }
  12815. if (req.version == "HTTP/1.0" &&
  12816. !detail::has_header_token(req.headers, "Connection", "keep-alive")) {
  12817. connection_closed = true;
  12818. }
  12819. // Only honor X-Forwarded-For if the peer on the actual TCP connection is
  12820. // itself a trusted proxy. Otherwise any direct client could spoof
  12821. // remote_addr simply by sending an arbitrary X-Forwarded-For header.
  12822. auto is_trusted_peer = std::any_of(
  12823. trusted_proxies_.begin(), trusted_proxies_.end(),
  12824. [&](const std::string &proxy) { return proxy == remote_addr; });
  12825. if (is_trusted_peer && req.has_header("X-Forwarded-For")) {
  12826. // Some proxies append the address they observed as a separate
  12827. // X-Forwarded-For field line instead of extending the one the client sent
  12828. // (e.g. HAProxy's "option forwardfor"), so the whole combined value has to
  12829. // be scanned. Reading only the first occurrence would hand back the
  12830. // client-supplied, and therefore forgeable, value.
  12831. auto x_forwarded_for =
  12832. detail::get_combined_header_value(req.headers, "X-Forwarded-For");
  12833. auto derived = get_client_ip(x_forwarded_for, trusted_proxies_);
  12834. req.remote_addr = derived.empty() ? remote_addr : derived;
  12835. } else {
  12836. req.remote_addr = remote_addr;
  12837. }
  12838. req.remote_port = remote_port;
  12839. req.local_addr = local_addr;
  12840. req.local_port = local_port;
  12841. if (req.has_header("Accept")) {
  12842. auto accept_header =
  12843. detail::get_combined_header_value(req.headers, "Accept");
  12844. if (!detail::parse_accept_header(accept_header, req.accept_content_types)) {
  12845. connection_closed = true;
  12846. res.status = StatusCode::BadRequest_400;
  12847. output_error_log(Error::HTTPParsing, &req);
  12848. return write_response(strm, close_connection, req, res);
  12849. }
  12850. }
  12851. if (req.has_header("Range")) {
  12852. const auto &range_header_value = req.get_header_value("Range");
  12853. if (!detail::parse_range_header(range_header_value, req.ranges)) {
  12854. connection_closed = true;
  12855. res.status = StatusCode::RangeNotSatisfiable_416;
  12856. output_error_log(Error::InvalidRangeHeader, &req);
  12857. return write_response(strm, close_connection, req, res);
  12858. }
  12859. }
  12860. if (setup_request) { setup_request(req); }
  12861. // RFC 9110 10.1.1: Expect is a comma-separated list whose value is
  12862. // case-insensitive, and a 100-continue expectation in an HTTP/1.0 request
  12863. // must be ignored. An expectation we do not recognize is left alone; the
  12864. // 417 the section allows for one is a MAY, not a requirement.
  12865. //
  12866. // `100 Continue` itself is deferred until the body is actually read (see
  12867. // read_content_core), so a request rejected by a later handler never
  12868. // invites the client to send a body nobody will read.
  12869. if (req.version != "HTTP/1.0" &&
  12870. detail::has_header_token(req.headers, "Expect", "100-continue")) {
  12871. int status = StatusCode::Continue_100;
  12872. if (expect_100_continue_handler_) {
  12873. status = expect_100_continue_handler_(req, res);
  12874. }
  12875. if (status == StatusCode::Continue_100) {
  12876. req.expect_100_continue_pending_ = true;
  12877. } else {
  12878. if (res.status == -1) { res.status = status; }
  12879. connection_closed = true;
  12880. return write_response(strm, true, req, res);
  12881. }
  12882. }
  12883. // Setup `is_connection_closed` method
  12884. auto sock = strm.socket();
  12885. req.is_connection_closed = [sock]() {
  12886. return !detail::is_socket_alive(sock);
  12887. };
  12888. // WebSocket upgrade
  12889. // Run pre_routing_handler_ and pre_request_handler_ before upgrading so
  12890. // that authentication and other middleware can reject the request with an
  12891. // HTTP response (e.g., 401) before the protocol switches.
  12892. // The response says so when this connection closes after it.
  12893. auto close_after_response = close_connection || connection_closed;
  12894. // An upgrade request has been through pre-routing before it reaches routing()
  12895. auto is_upgrade = detail::is_websocket_upgrade(req);
  12896. if (is_upgrade) {
  12897. if (pre_routing_handler_ &&
  12898. pre_routing_handler_(req, res) == HandlerResponse::Handled) {
  12899. if (res.status == -1) { res.status = StatusCode::OK_200; }
  12900. return write_response_with_content(strm, close_after_response, req, res);
  12901. }
  12902. // Find matching WebSocket handler
  12903. for (const auto &entry : websocket_handlers_) {
  12904. if (entry.matcher->match(req)) {
  12905. req.matched_route = entry.matcher->pattern();
  12906. if (pre_request_handler_ &&
  12907. pre_request_handler_(req, res) == HandlerResponse::Handled) {
  12908. if (res.status == -1) { res.status = StatusCode::OK_200; }
  12909. return write_response_with_content(strm, close_after_response, req,
  12910. res);
  12911. }
  12912. // Compute accept key
  12913. auto client_key = req.get_header_value("Sec-WebSocket-Key");
  12914. auto accept_key = detail::websocket_accept_key(client_key);
  12915. // Negotiate subprotocol
  12916. std::string selected_subprotocol;
  12917. if (entry.sub_protocol_selector) {
  12918. auto protocol_header = detail::get_combined_header_value(
  12919. req.headers, "Sec-WebSocket-Protocol");
  12920. if (!protocol_header.empty()) {
  12921. std::vector<std::string> protocols;
  12922. detail::split(protocol_header.data(),
  12923. protocol_header.data() + protocol_header.size(), ',',
  12924. [&](const char *b, const char *e) {
  12925. protocols.emplace_back(b, e);
  12926. });
  12927. selected_subprotocol = entry.sub_protocol_selector(protocols);
  12928. // Ignore a selection the client did not offer (RFC 6455 4.2.2)
  12929. if (std::find(protocols.begin(), protocols.end(),
  12930. selected_subprotocol) == protocols.end()) {
  12931. selected_subprotocol.clear();
  12932. }
  12933. }
  12934. }
  12935. // Send 101 Switching Protocols
  12936. std::string handshake_response = "HTTP/1.1 101 Switching Protocols\r\n"
  12937. "Upgrade: websocket\r\n"
  12938. "Connection: Upgrade\r\n"
  12939. "Sec-WebSocket-Accept: " +
  12940. accept_key + "\r\n";
  12941. if (!selected_subprotocol.empty()) {
  12942. if (!detail::fields::is_field_value(selected_subprotocol)) {
  12943. return false;
  12944. }
  12945. handshake_response +=
  12946. "Sec-WebSocket-Protocol: " + selected_subprotocol + "\r\n";
  12947. }
  12948. handshake_response += "\r\n";
  12949. if (strm.write(handshake_response.data(), handshake_response.size()) <
  12950. 0) {
  12951. return false;
  12952. }
  12953. connection_closed = true;
  12954. if (websocket_upgraded) { *websocket_upgraded = true; }
  12955. {
  12956. #ifdef CPPHTTPLIB_SSL_ENABLED
  12957. if (req.ssl) {
  12958. // wss: the heartbeat ping thread and the read path enter the same
  12959. // TLS session from different threads. Hand the WebSocket a stream
  12960. // that serializes every TLS call, so the shared SSLSocketStream on
  12961. // the plain HTTP/HTTPS paths stays untouched.
  12962. auto ws_strm =
  12963. std::unique_ptr<Stream>(new detail::WebSocketSSLStream(
  12964. strm.socket(), const_cast<tls::session_t>(req.ssl),
  12965. CPPHTTPLIB_WEBSOCKET_SERVER_READ_TIMEOUT_SECOND, 0,
  12966. write_timeout_sec_, write_timeout_usec_));
  12967. ws::WebSocket ws(std::move(ws_strm), req, true,
  12968. websocket_ping_interval_sec_,
  12969. websocket_max_missed_pongs_);
  12970. entry.handler(req, ws);
  12971. return true;
  12972. }
  12973. #endif
  12974. // Use WebSocket-specific read timeout instead of HTTP timeout
  12975. strm.set_read_timeout(CPPHTTPLIB_WEBSOCKET_SERVER_READ_TIMEOUT_SECOND,
  12976. 0);
  12977. ws::WebSocket ws(strm, req, true, websocket_ping_interval_sec_,
  12978. websocket_max_missed_pongs_);
  12979. entry.handler(req, ws);
  12980. }
  12981. return true;
  12982. }
  12983. }
  12984. // No WebSocket route: route it as a plain HTTP request
  12985. }
  12986. // Routing
  12987. auto routed = false;
  12988. #ifdef CPPHTTPLIB_NO_EXCEPTIONS
  12989. routed = routing(req, res, strm, is_upgrade);
  12990. #else
  12991. try {
  12992. routed = routing(req, res, strm, is_upgrade);
  12993. } catch (std::exception &) {
  12994. if (exception_handler_) {
  12995. auto ep = std::current_exception();
  12996. exception_handler_(req, res, ep);
  12997. routed = true;
  12998. } else {
  12999. res.status = StatusCode::InternalServerError_500;
  13000. }
  13001. } catch (...) {
  13002. if (exception_handler_) {
  13003. auto ep = std::current_exception();
  13004. exception_handler_(req, res, ep);
  13005. routed = true;
  13006. } else {
  13007. res.status = StatusCode::InternalServerError_500;
  13008. }
  13009. }
  13010. #endif
  13011. auto ret = false;
  13012. if (routed) {
  13013. if (res.status == -1) {
  13014. res.status = req.ranges.empty() ? StatusCode::OK_200
  13015. : StatusCode::PartialContent_206;
  13016. }
  13017. // Before the Range checks below, so they see the body's own length.
  13018. detail::prefer_assigned_body(res);
  13019. // Serve file content by using a content provider
  13020. auto file_open_error = false;
  13021. if (!res.file_content_path_.empty()) {
  13022. const auto &path = res.file_content_path_;
  13023. auto mm = std::make_shared<detail::mmap>(path.c_str());
  13024. if (!mm->is_open()) {
  13025. res.status = StatusCode::NotFound_404;
  13026. output_error_log(Error::OpenFile, &req);
  13027. file_open_error = true;
  13028. } else {
  13029. auto content_type = res.file_content_content_type_;
  13030. if (content_type.empty()) {
  13031. // One the handler set after set_file_content()
  13032. content_type = res.get_header_value("Content-Type");
  13033. }
  13034. if (content_type.empty()) {
  13035. content_type = detail::find_content_type(
  13036. path, file_extension_and_mimetype_map_, default_file_mimetype_);
  13037. }
  13038. detail::set_file_content_provider(
  13039. res, mm, content_type,
  13040. static_file_encoding(req, res, content_type, mm->size()));
  13041. }
  13042. }
  13043. if (file_open_error) {
  13044. ret = write_response(strm, close_after_response, req, res);
  13045. } else if (detail::range_error(req, res)) {
  13046. detail::clear_content(res);
  13047. res.status = StatusCode::RangeNotSatisfiable_416;
  13048. ret = write_response(strm, close_after_response, req, res);
  13049. } else {
  13050. ret = write_response_with_content(strm, close_after_response, req, res);
  13051. }
  13052. } else {
  13053. if (res.status == -1) { res.status = StatusCode::NotFound_404; }
  13054. ret = write_response(strm, close_after_response, req, res);
  13055. }
  13056. // Drain any unconsumed framed body to prevent request smuggling on
  13057. // keep-alive. Without framing there is no body to drain — reading would
  13058. // consume the next request (issue #2450). If the response has committed the
  13059. // connection to close, there is no next request to protect. A body read in
  13060. // part cannot be drained from where it stopped, so the connection closes.
  13061. if (!req.body_consumed_ && detail::has_framed_body(req) &&
  13062. !detail::has_header_token(res.headers, "Connection", "close")) {
  13063. int dummy_status;
  13064. if (req.body_read_started_ ||
  13065. !detail::read_content(
  13066. strm, req, payload_max_length_, dummy_status, nullptr,
  13067. [](const char *, size_t, size_t, size_t) { return true; }, false)) {
  13068. connection_closed = true;
  13069. }
  13070. }
  13071. return ret;
  13072. }
  13073. inline bool Server::is_valid() const { return !has_invalid_registration_; }
  13074. inline bool Server::process_and_close_socket(socket_t sock) {
  13075. std::string remote_addr;
  13076. int remote_port = 0;
  13077. detail::get_remote_ip_and_port(sock, remote_addr, remote_port);
  13078. std::string local_addr;
  13079. int local_port = 0;
  13080. detail::get_local_ip_and_port(sock, local_addr, local_port);
  13081. bool websocket_upgraded = false;
  13082. auto ret = serve_guarded([&]() {
  13083. return detail::process_server_socket(
  13084. svr_sock_, sock, keep_alive_max_count_, keep_alive_timeout_sec_,
  13085. read_timeout_sec_, read_timeout_usec_, write_timeout_sec_,
  13086. write_timeout_usec_,
  13087. [&](Stream &strm, bool close_connection, bool &connection_closed) {
  13088. return process_request(strm, remote_addr, remote_port, local_addr,
  13089. local_port, close_connection,
  13090. connection_closed, nullptr,
  13091. &websocket_upgraded);
  13092. });
  13093. });
  13094. detail::drain_and_close_socket(sock);
  13095. return ret;
  13096. }
  13097. inline void Server::output_log(const Request &req, const Response &res) const {
  13098. if (logger_) {
  13099. std::lock_guard<std::mutex> guard(logger_mutex_);
  13100. logger_(req, res);
  13101. }
  13102. }
  13103. inline void Server::output_pre_compression_log(const Request &req,
  13104. const Response &res) const {
  13105. if (pre_compression_logger_) {
  13106. std::lock_guard<std::mutex> guard(logger_mutex_);
  13107. pre_compression_logger_(req, res);
  13108. }
  13109. }
  13110. inline void Server::output_error_log(const Error &err,
  13111. const Request *req) const {
  13112. if (error_logger_) {
  13113. std::lock_guard<std::mutex> guard(logger_mutex_);
  13114. error_logger_(err, req);
  13115. }
  13116. }
  13117. /*
  13118. * Group 5: ClientImpl and Client (Universal) implementation
  13119. */
  13120. // HTTP client implementation
  13121. inline ClientImpl::ClientImpl(const std::string &host)
  13122. : ClientImpl(host, 80, std::string(), std::string()) {}
  13123. inline ClientImpl::ClientImpl(const std::string &host, int port)
  13124. : ClientImpl(host, port, std::string(), std::string()) {}
  13125. inline ClientImpl::ClientImpl(const std::string &host, int port,
  13126. const std::string &client_cert_path,
  13127. const std::string &client_key_path)
  13128. : host_(detail::escape_abstract_namespace_unix_domain(host)), port_(port),
  13129. client_cert_path_(client_cert_path), client_key_path_(client_key_path) {}
  13130. inline ClientImpl::~ClientImpl() {
  13131. // Wait until all the requests in flight are handled.
  13132. size_t retry_count = 10;
  13133. while (retry_count-- > 0) {
  13134. {
  13135. std::lock_guard<std::mutex> guard(socket_mutex_);
  13136. if (socket_requests_in_flight_ == 0) { break; }
  13137. }
  13138. std::this_thread::sleep_for(std::chrono::milliseconds{1});
  13139. }
  13140. std::lock_guard<std::mutex> guard(socket_mutex_);
  13141. shutdown_socket(socket_);
  13142. close_socket(socket_);
  13143. }
  13144. inline bool ClientImpl::is_valid() const { return true; }
  13145. inline bool
  13146. ClientImpl::is_proxy_enabled_for_host(const std::string &host) const {
  13147. if (proxy_host_.empty() || proxy_port_ == -1) { return false; }
  13148. if (no_proxy_entries_.empty()) { return true; }
  13149. // host_ is const so its normalized form is invariant; cache it. The
  13150. // cross-host path (setup_redirect_client passing next_host) re-normalizes.
  13151. if (host == host_) {
  13152. if (!host_normalized_valid_) {
  13153. host_normalized_ = detail::normalize_target(host_);
  13154. host_normalized_valid_ = true;
  13155. }
  13156. return !detail::host_matches_no_proxy(host_normalized_, no_proxy_entries_);
  13157. }
  13158. auto target = detail::normalize_target(host);
  13159. return !detail::host_matches_no_proxy(target, no_proxy_entries_);
  13160. }
  13161. inline socket_t ClientImpl::create_client_socket(Error &error) const {
  13162. if (is_proxy_enabled_for_host(host_)) {
  13163. return detail::create_client_socket(
  13164. proxy_host_, std::string(), proxy_port_, address_family_, tcp_nodelay_,
  13165. ipv6_v6only_, socket_options_, connection_timeout_sec_,
  13166. connection_timeout_usec_, read_timeout_sec_, read_timeout_usec_,
  13167. write_timeout_sec_, write_timeout_usec_, interface_, error);
  13168. }
  13169. // Check is custom IP or hostname specified for host_
  13170. std::string connect_host;
  13171. std::string ip;
  13172. detail::apply_addr_map(addr_map_, host_, connect_host, ip);
  13173. return detail::create_client_socket(
  13174. connect_host, ip, port_, address_family_, tcp_nodelay_, ipv6_v6only_,
  13175. socket_options_, connection_timeout_sec_, connection_timeout_usec_,
  13176. read_timeout_sec_, read_timeout_usec_, write_timeout_sec_,
  13177. write_timeout_usec_, interface_, error);
  13178. }
  13179. inline bool ClientImpl::create_and_connect_socket(Socket &socket,
  13180. Error &error) {
  13181. auto sock = create_client_socket(error);
  13182. if (sock == INVALID_SOCKET) { return false; }
  13183. socket.sock = sock;
  13184. return true;
  13185. }
  13186. inline bool ClientImpl::ensure_socket_connection(Socket &socket, Error &error) {
  13187. return create_and_connect_socket(socket, error);
  13188. }
  13189. inline bool ClientImpl::setup_proxy_connection(
  13190. Socket & /*socket*/,
  13191. std::chrono::time_point<std::chrono::steady_clock> /*start_time*/,
  13192. Response & /*res*/, bool & /*success*/, Error & /*error*/) {
  13193. return true;
  13194. }
  13195. inline void ClientImpl::shutdown_ssl(Socket & /*socket*/,
  13196. bool /*shutdown_gracefully*/) {
  13197. // If there are any requests in flight from threads other than us, then it's
  13198. // a thread-unsafe race because individual ssl* objects are not thread-safe.
  13199. assert(socket_requests_in_flight_ == 0 ||
  13200. socket_requests_are_from_thread_ == std::this_thread::get_id());
  13201. }
  13202. inline void ClientImpl::shutdown_socket(Socket &socket) const {
  13203. if (socket.sock == INVALID_SOCKET) { return; }
  13204. detail::shutdown_socket(socket.sock);
  13205. }
  13206. inline void ClientImpl::close_socket(Socket &socket) {
  13207. // If there are requests in flight in another thread, usually closing
  13208. // the socket will be fine and they will simply receive an error when
  13209. // using the closed socket, but it is still a bug since rarely the OS
  13210. // may reassign the socket id to be used for a new socket, and then
  13211. // suddenly they will be operating on a live socket that is different
  13212. // than the one they intended!
  13213. assert(socket_requests_in_flight_ == 0 ||
  13214. socket_requests_are_from_thread_ == std::this_thread::get_id());
  13215. // It is also a bug if this happens while SSL is still active
  13216. #ifdef CPPHTTPLIB_SSL_ENABLED
  13217. assert(socket.ssl == nullptr);
  13218. #endif
  13219. if (socket.sock == INVALID_SOCKET) { return; }
  13220. detail::close_socket(socket.sock);
  13221. socket.sock = INVALID_SOCKET;
  13222. }
  13223. inline void ClientImpl::disconnect(bool gracefully) {
  13224. shutdown_ssl(socket_, gracefully);
  13225. shutdown_socket(socket_);
  13226. close_socket(socket_);
  13227. }
  13228. inline bool ClientImpl::read_response_line(Stream &strm, const Request &req,
  13229. Response &res,
  13230. bool skip_100_continue) const {
  13231. std::array<char, 2048> buf{};
  13232. detail::stream_line_reader line_reader(strm, buf.data(), buf.size());
  13233. if (!line_reader.getline()) { return false; }
  13234. if (!detail::parse_status_line(line_reader.ptr(), res.version, res.status,
  13235. res.reason)) {
  13236. return req.method == "CONNECT";
  13237. }
  13238. // Skip interim (1xx) responses along with their header fields, except a 100
  13239. // Continue the caller handles itself for Expect: 100-continue. 101 ends
  13240. // HTTP on the connection, so it is final. A server sending them without end
  13241. // would hold the client, so there may be only so many.
  13242. size_t interim_count = 0;
  13243. while (100 <= res.status && res.status < 200 &&
  13244. res.status != StatusCode::SwitchingProtocol_101 &&
  13245. (skip_100_continue || res.status != StatusCode::Continue_100)) {
  13246. if (++interim_count > CPPHTTPLIB_INTERIM_RESPONSE_MAX_COUNT) {
  13247. return false;
  13248. }
  13249. Headers interim_headers;
  13250. if (!detail::read_headers(strm, interim_headers)) { return false; }
  13251. if (!line_reader.getline()) { return false; } // next response line
  13252. if (!detail::parse_status_line(line_reader.ptr(), res.version, res.status,
  13253. res.reason)) {
  13254. return false;
  13255. }
  13256. }
  13257. return true;
  13258. }
  13259. inline bool ClientImpl::send(Request &req, Response &res, Error &error) {
  13260. std::lock_guard<std::recursive_mutex> request_mutex_guard(request_mutex_);
  13261. auto ret = send_(req, res, error);
  13262. if (error == Error::SSLPeerCouldBeClosed_) {
  13263. assert(!ret);
  13264. ret = send_(req, res, error);
  13265. // If still failing with SSLPeerCouldBeClosed_, convert to Read error
  13266. if (error == Error::SSLPeerCouldBeClosed_) { error = Error::Read; }
  13267. }
  13268. return ret;
  13269. }
  13270. inline bool ClientImpl::send_(Request &req, Response &res, Error &error) {
  13271. #ifdef CPPHTTPLIB_SSL_ENABLED
  13272. // Don't let an earlier attempt's TLS error show up in this one's Result. A
  13273. // client that failed to set up its TLS context keeps reporting why.
  13274. if (is_valid()) {
  13275. last_ssl_error_ = 0;
  13276. last_backend_error_ = 0;
  13277. }
  13278. #endif
  13279. {
  13280. std::lock_guard<std::mutex> guard(socket_mutex_);
  13281. // Set this to false immediately - if it ever gets set to true by the end
  13282. // of the request, we know another thread instructed us to close the
  13283. // socket.
  13284. socket_should_be_closed_when_request_is_done_ = false;
  13285. auto is_alive = false;
  13286. if (socket_.is_open()) {
  13287. is_alive = detail::is_socket_alive(socket_.sock);
  13288. #ifdef CPPHTTPLIB_SSL_ENABLED
  13289. if (is_alive && is_ssl()) {
  13290. if (tls::is_peer_closed(socket_.ssl, socket_.sock)) {
  13291. is_alive = false;
  13292. }
  13293. }
  13294. #endif
  13295. if (!is_alive) {
  13296. // Peer seems gone — non-graceful shutdown to avoid SIGPIPE.
  13297. disconnect(/*gracefully=*/false);
  13298. }
  13299. }
  13300. if (!is_alive) {
  13301. if (!ensure_socket_connection(socket_, error)) {
  13302. output_error_log(error, &req);
  13303. return false;
  13304. }
  13305. {
  13306. auto success = true;
  13307. if (!setup_proxy_connection(socket_, req.start_time_, res, success,
  13308. error)) {
  13309. if (!success) { output_error_log(error, &req); }
  13310. return success;
  13311. }
  13312. }
  13313. }
  13314. // Mark the current socket as being in use so that it cannot be closed by
  13315. // anyone else while this request is ongoing, even though we will be
  13316. // releasing the mutex.
  13317. if (socket_requests_in_flight_ > 1) {
  13318. assert(socket_requests_are_from_thread_ == std::this_thread::get_id());
  13319. }
  13320. socket_requests_in_flight_ += 1;
  13321. socket_requests_are_from_thread_ = std::this_thread::get_id();
  13322. }
  13323. for (const auto &header : default_headers_) {
  13324. if (req.headers.find(header.first) == req.headers.end()) {
  13325. req.headers.insert(header);
  13326. }
  13327. }
  13328. auto ret = false;
  13329. auto close_connection = !keep_alive_;
  13330. auto se = detail::scope_exit([&]() {
  13331. // Briefly lock mutex in order to mark that a request is no longer ongoing
  13332. std::lock_guard<std::mutex> guard(socket_mutex_);
  13333. socket_requests_in_flight_ -= 1;
  13334. if (socket_requests_in_flight_ <= 0) {
  13335. assert(socket_requests_in_flight_ == 0);
  13336. socket_requests_are_from_thread_ = std::thread::id();
  13337. }
  13338. if (socket_should_be_closed_when_request_is_done_ || close_connection ||
  13339. !ret) {
  13340. disconnect(/*gracefully=*/true);
  13341. }
  13342. });
  13343. ret = process_socket(socket_, req.start_time_, [&](Stream &strm) {
  13344. return handle_request(strm, req, res, close_connection, error);
  13345. });
  13346. if (!ret) {
  13347. if (error == Error::Success) {
  13348. error = Error::Unknown;
  13349. output_error_log(error, &req);
  13350. }
  13351. }
  13352. return ret;
  13353. }
  13354. inline Result ClientImpl::send(const Request &req) {
  13355. auto req2 = req;
  13356. return send_(std::move(req2));
  13357. }
  13358. inline Result ClientImpl::send_(Request &&req) {
  13359. auto res = detail::make_unique<Response>();
  13360. auto error = Error::Success;
  13361. #ifdef CPPHTTPLIB_SSL_ENABLED
  13362. // Hold the request lock until the Result has read this request's TLS error
  13363. std::lock_guard<std::recursive_mutex> request_mutex_guard(request_mutex_);
  13364. #endif
  13365. auto ret = send(req, *res, error);
  13366. #ifdef CPPHTTPLIB_SSL_ENABLED
  13367. return Result{ret ? std::move(res) : nullptr, error, std::move(req.headers),
  13368. last_ssl_error_, last_backend_error_};
  13369. #else
  13370. return Result{ret ? std::move(res) : nullptr, error, std::move(req.headers)};
  13371. #endif
  13372. }
  13373. inline void ClientImpl::prepare_default_headers(Request &r, bool for_stream,
  13374. const std::string &ct) {
  13375. (void)for_stream;
  13376. // Default headers are meant for the origin and may carry its credentials, so
  13377. // keep them off the CONNECT request the proxy reads.
  13378. if (r.method != "CONNECT") {
  13379. for (const auto &header : default_headers_) {
  13380. if (!r.has_header(header.first)) { r.headers.insert(header); }
  13381. }
  13382. }
  13383. // RFC 9110 5.3 recommends sending control data such as Host first, so
  13384. // prepend it rather than appending it after the caller's own fields.
  13385. if (!r.has_header("Host")) {
  13386. r.headers.emplace_front(
  13387. "Host", detail::make_default_host_header_value(host_, port_, is_ssl(),
  13388. address_family_));
  13389. }
  13390. if (!r.has_header("Accept")) { r.headers.emplace("Accept", "*/*"); }
  13391. if (!r.content_receiver) {
  13392. if (!r.has_header("Accept-Encoding")) {
  13393. std::string accept_encoding;
  13394. #ifdef CPPHTTPLIB_BROTLI_SUPPORT
  13395. accept_encoding = "br";
  13396. #endif
  13397. #ifdef CPPHTTPLIB_ZLIB_SUPPORT
  13398. if (!accept_encoding.empty()) { accept_encoding += ", "; }
  13399. accept_encoding += "gzip, deflate";
  13400. #endif
  13401. #ifdef CPPHTTPLIB_ZSTD_SUPPORT
  13402. if (!accept_encoding.empty()) { accept_encoding += ", "; }
  13403. accept_encoding += "zstd";
  13404. #endif
  13405. r.set_header("Accept-Encoding", accept_encoding);
  13406. }
  13407. detail::add_default_user_agent_header(r);
  13408. }
  13409. if (!r.body.empty()) {
  13410. if (!ct.empty() && !r.has_header("Content-Type")) {
  13411. r.headers.emplace("Content-Type", ct);
  13412. }
  13413. if (!r.has_header("Content-Length")) {
  13414. r.headers.emplace("Content-Length", std::to_string(r.body.size()));
  13415. }
  13416. }
  13417. }
  13418. inline ClientImpl::StreamHandle
  13419. ClientImpl::open_stream(const std::string &method, const std::string &path,
  13420. const Params &params, const Headers &headers,
  13421. const std::string &body,
  13422. const std::string &content_type) {
  13423. StreamHandle handle;
  13424. handle.response = detail::make_unique<Response>();
  13425. handle.error = Error::Success;
  13426. // Encode the target exactly like the buffered send path does, so that the
  13427. // same `path` produces the same request line through either API.
  13428. auto raw_query_path =
  13429. params.empty() ? path : append_query_params(path, params);
  13430. auto query_path = detail::encode_request_target(raw_query_path, path_encode_);
  13431. handle.connection_ = detail::make_unique<ClientConnection>();
  13432. {
  13433. std::lock_guard<std::mutex> guard(socket_mutex_);
  13434. auto is_alive = false;
  13435. if (socket_.is_open()) {
  13436. is_alive = detail::is_socket_alive(socket_.sock);
  13437. #ifdef CPPHTTPLIB_SSL_ENABLED
  13438. if (is_alive && is_ssl()) {
  13439. if (tls::is_peer_closed(socket_.ssl, socket_.sock)) {
  13440. is_alive = false;
  13441. }
  13442. }
  13443. #endif
  13444. if (!is_alive) { disconnect(/*gracefully=*/false); }
  13445. }
  13446. if (!is_alive) {
  13447. if (!ensure_socket_connection(socket_, handle.error)) {
  13448. handle.response.reset();
  13449. return handle;
  13450. }
  13451. {
  13452. auto success = true;
  13453. auto start_time = std::chrono::steady_clock::now();
  13454. if (!setup_proxy_connection(socket_, start_time, *handle.response,
  13455. success, handle.error)) {
  13456. if (!success) { handle.response.reset(); }
  13457. return handle;
  13458. }
  13459. }
  13460. }
  13461. transfer_socket_ownership_to_handle(handle);
  13462. }
  13463. #ifdef CPPHTTPLIB_SSL_ENABLED
  13464. if (is_ssl() && handle.connection_->session) {
  13465. handle.socket_stream_ = detail::make_unique<detail::SSLSocketStream>(
  13466. handle.connection_->sock, handle.connection_->session,
  13467. read_timeout_sec_, read_timeout_usec_, write_timeout_sec_,
  13468. write_timeout_usec_);
  13469. } else {
  13470. handle.socket_stream_ = detail::make_unique<detail::SocketStream>(
  13471. handle.connection_->sock, read_timeout_sec_, read_timeout_usec_,
  13472. write_timeout_sec_, write_timeout_usec_);
  13473. }
  13474. #else
  13475. handle.socket_stream_ = detail::make_unique<detail::SocketStream>(
  13476. handle.connection_->sock, read_timeout_sec_, read_timeout_usec_,
  13477. write_timeout_sec_, write_timeout_usec_);
  13478. #endif
  13479. handle.stream_ = handle.socket_stream_.get();
  13480. Request req;
  13481. req.method = method;
  13482. req.path = query_path;
  13483. req.headers = headers;
  13484. req.body = body;
  13485. prepare_default_headers(req, true, content_type);
  13486. auto &strm = *handle.stream_;
  13487. // Build the request line and headers in memory first, like write_request()
  13488. // does, so that a rejected header leaves nothing on the wire.
  13489. {
  13490. detail::BufferStream bstrm;
  13491. if (detail::write_request_line(bstrm, req.method, req.path) < 0) {
  13492. handle.error = Error::Write;
  13493. handle.response.reset();
  13494. return handle;
  13495. }
  13496. if (!detail::check_and_write_headers(bstrm, req.headers, header_writer_,
  13497. handle.error)) {
  13498. handle.response.reset();
  13499. return handle;
  13500. }
  13501. const auto &data = bstrm.get_buffer();
  13502. if (!detail::write_data(strm, data.data(), data.size())) {
  13503. handle.error = Error::Write;
  13504. handle.response.reset();
  13505. return handle;
  13506. }
  13507. }
  13508. if (!body.empty()) {
  13509. if (strm.write(body.data(), body.size()) < 0) {
  13510. handle.error = Error::Write;
  13511. handle.response.reset();
  13512. return handle;
  13513. }
  13514. }
  13515. if (!read_response_line(strm, req, *handle.response) ||
  13516. !detail::read_headers(strm, handle.response->headers)) {
  13517. handle.error = Error::Read;
  13518. handle.response.reset();
  13519. return handle;
  13520. }
  13521. // Same framing check as ClientImpl::process_request(). A HEAD or bodyless
  13522. // (204/304) response legitimately carries framing headers with no body.
  13523. if (method != "HEAD" &&
  13524. handle.response->status != StatusCode::NoContent_204 &&
  13525. handle.response->status != StatusCode::NotModified_304 &&
  13526. detail::has_conflicting_content_length(handle.response->headers)) {
  13527. handle.error = Error::Read;
  13528. handle.response.reset();
  13529. return handle;
  13530. }
  13531. handle.body_reader_.stream = handle.stream_;
  13532. handle.body_reader_.payload_max_length = payload_max_length_;
  13533. if (handle.response->has_header("Content-Length")) {
  13534. bool is_invalid = false;
  13535. auto content_length = detail::get_header_value_u64(
  13536. handle.response->headers, "Content-Length", 0, 0, is_invalid);
  13537. if (is_invalid) {
  13538. handle.error = Error::Read;
  13539. handle.response.reset();
  13540. return handle;
  13541. }
  13542. handle.body_reader_.has_content_length = true;
  13543. handle.body_reader_.content_length = content_length;
  13544. }
  13545. handle.body_reader_.chunked =
  13546. detail::is_chunked_transfer_encoding(handle.response->headers);
  13547. auto content_encoding = detail::get_combined_header_value(
  13548. handle.response->headers, "Content-Encoding");
  13549. if (!content_encoding.empty()) {
  13550. // Same policy as prepare_content_receiver(): reject a coding we know about
  13551. // but were not built with, pass an unrecognized one through as-is.
  13552. handle.decompressor_ = detail::create_decompressor(content_encoding);
  13553. if (!handle.decompressor_) {
  13554. if (detail::is_known_content_encoding(content_encoding)) {
  13555. handle.error = Error::UnsupportedContentEncoding;
  13556. handle.response.reset();
  13557. return handle;
  13558. }
  13559. } else if (!handle.decompressor_->is_valid()) {
  13560. handle.error = Error::Compression;
  13561. handle.response.reset();
  13562. return handle;
  13563. }
  13564. }
  13565. return handle;
  13566. }
  13567. inline ssize_t ClientImpl::StreamHandle::read(char *buf, size_t len) {
  13568. if (!is_valid() || !response) { return -1; }
  13569. auto n = decompressor_
  13570. ? read_with_decompression(buf, len)
  13571. : detail::read_body_content(stream_, body_reader_, buf, len);
  13572. if (n == 0) { parse_trailers_if_needed(); }
  13573. return n;
  13574. }
  13575. inline ssize_t ClientImpl::StreamHandle::read_with_decompression(char *buf,
  13576. size_t len) {
  13577. if (decompress_offset_ < decompress_buffer_.size()) {
  13578. auto available = decompress_buffer_.size() - decompress_offset_;
  13579. auto to_copy = (std::min)(len, available);
  13580. std::memcpy(buf, decompress_buffer_.data() + decompress_offset_, to_copy);
  13581. decompress_offset_ += to_copy;
  13582. decompressed_bytes_read_ += to_copy;
  13583. return static_cast<ssize_t>(to_copy);
  13584. }
  13585. decompress_buffer_.clear();
  13586. decompress_offset_ = 0;
  13587. constexpr size_t kDecompressionBufferSize = 8192;
  13588. char compressed_buf[kDecompressionBufferSize];
  13589. while (true) {
  13590. auto n = detail::read_body_content(stream_, body_reader_, compressed_buf,
  13591. sizeof(compressed_buf));
  13592. if (n <= 0) { return n; }
  13593. auto exceeded = false;
  13594. bool decompress_ok = decompressor_->decompress(
  13595. compressed_buf, static_cast<size_t>(n),
  13596. [&](const char *data, size_t data_len) {
  13597. decompress_buffer_.append(data, data_len);
  13598. auto limit = body_reader_.payload_max_length;
  13599. exceeded =
  13600. limit > 0 &&
  13601. decompressed_bytes_read_ + decompress_buffer_.size() > limit;
  13602. return !exceeded;
  13603. });
  13604. if (!decompress_ok) {
  13605. body_reader_.last_error =
  13606. exceeded ? Error::ExceedMaxPayloadSize : Error::Read;
  13607. return -1;
  13608. }
  13609. if (!decompress_buffer_.empty()) { break; }
  13610. }
  13611. auto to_copy = (std::min)(len, decompress_buffer_.size());
  13612. std::memcpy(buf, decompress_buffer_.data(), to_copy);
  13613. decompress_offset_ = to_copy;
  13614. decompressed_bytes_read_ += to_copy;
  13615. return static_cast<ssize_t>(to_copy);
  13616. }
  13617. inline void ClientImpl::StreamHandle::parse_trailers_if_needed() {
  13618. // The trailers follow the last chunk, so there are none before it
  13619. auto &decoder = body_reader_.chunked_decoder;
  13620. if (!response || trailers_parsed_ || !decoder || !decoder->finished) {
  13621. return;
  13622. }
  13623. trailers_parsed_ = true;
  13624. decoder->parse_trailers_into(response->trailers, response->headers);
  13625. }
  13626. namespace detail {
  13627. inline ChunkedDecoder::ChunkedDecoder(Stream &s) : strm(s) {}
  13628. inline ssize_t ChunkedDecoder::read_payload(char *buf, size_t len,
  13629. size_t &out_chunk_offset,
  13630. size_t &out_chunk_total) {
  13631. if (finished) { return 0; }
  13632. if (chunk_remaining == 0) {
  13633. stream_line_reader lr(strm, line_buf, sizeof(line_buf));
  13634. if (!lr.getline()) { return -1; }
  13635. // Everything below is bounded by eol rather than by the buffer's NUL, so
  13636. // the line terminator is never mistaken for line content.
  13637. const char *eol = lr.ptr() + lr.size();
  13638. if (lr.end_with_crlf()) {
  13639. eol -= 2;
  13640. } else if (eol != lr.ptr() && eol[-1] == '\n') {
  13641. // Only reachable under CPPHTTPLIB_ALLOW_LF_AS_LINE_TERMINATOR, where
  13642. // getline() ends the line on a bare LF. That LF is the terminator, so it
  13643. // has to come off here or the check below would reject the line.
  13644. eol -= 1;
  13645. }
  13646. // RFC 9112 §7.1: chunk-size = 1*HEXDIG
  13647. const char *p = lr.ptr();
  13648. int v = 0;
  13649. if (p == eol || !is_hex(*p, v)) { return -1; }
  13650. size_t chunk_len = 0;
  13651. constexpr size_t chunk_len_max = (std::numeric_limits<size_t>::max)();
  13652. for (; p < eol && is_hex(*p, v); ++p) {
  13653. if (chunk_len > (chunk_len_max >> 4)) { return -1; }
  13654. chunk_len = (chunk_len << 4) | static_cast<size_t>(v);
  13655. }
  13656. while (p < eol && is_space_or_tab(*p)) {
  13657. ++p;
  13658. }
  13659. // RFC 9112 §7.1.1: only a chunk-ext may sit between the size and the line
  13660. // terminator, and it is built from tokens and quoted-strings, so it never
  13661. // holds a CR, LF or any other control character. getline() reads up to the
  13662. // CRLF, so a bare LF left in here would be swallowed as extension text
  13663. // while an intermediary that ends the line on it delimits the chunks
  13664. // differently, and the two disagree on where the body ends (request
  13665. // smuggling).
  13666. if (p < eol && *p != ';') { return -1; }
  13667. for (; p < eol; ++p) {
  13668. if (!is_space_or_tab(*p) && !fields::is_field_vchar(*p)) { return -1; }
  13669. }
  13670. if (chunk_len == 0) {
  13671. chunk_remaining = 0;
  13672. finished = true;
  13673. out_chunk_offset = 0;
  13674. out_chunk_total = 0;
  13675. return 0;
  13676. }
  13677. chunk_remaining = chunk_len;
  13678. last_chunk_total = chunk_remaining;
  13679. last_chunk_offset = 0;
  13680. }
  13681. auto to_read = (std::min)(chunk_remaining, len);
  13682. auto n = strm.read(buf, to_read);
  13683. if (n <= 0) { return -1; }
  13684. auto offset_before = last_chunk_offset;
  13685. last_chunk_offset += static_cast<size_t>(n);
  13686. chunk_remaining -= static_cast<size_t>(n);
  13687. out_chunk_offset = offset_before;
  13688. out_chunk_total = last_chunk_total;
  13689. if (chunk_remaining == 0) {
  13690. stream_line_reader lr(strm, line_buf, sizeof(line_buf));
  13691. if (!lr.getline()) { return -1; }
  13692. if (std::strcmp(lr.ptr(), "\r\n") != 0) { return -1; }
  13693. }
  13694. return n;
  13695. }
  13696. inline bool ChunkedDecoder::parse_trailers_into(Headers &dest,
  13697. const Headers &src_headers) {
  13698. stream_line_reader lr(strm, line_buf, sizeof(line_buf));
  13699. if (!lr.getline()) { return false; }
  13700. return parse_trailers(lr, dest, src_headers);
  13701. }
  13702. // A 3xx without a Location, such as a 304, is a final response
  13703. inline bool is_redirect(const Response &res) {
  13704. return 300 < res.status && res.status < 400 &&
  13705. !res.get_header_value("Location").empty();
  13706. }
  13707. } // namespace detail
  13708. inline void
  13709. ClientImpl::transfer_socket_ownership_to_handle(StreamHandle &handle) {
  13710. handle.connection_->sock = socket_.sock;
  13711. #ifdef CPPHTTPLIB_SSL_ENABLED
  13712. handle.connection_->session = socket_.ssl;
  13713. socket_.ssl = nullptr;
  13714. #endif
  13715. socket_.sock = INVALID_SOCKET;
  13716. }
  13717. inline bool ClientImpl::handle_request(Stream &strm, Request &req,
  13718. Response &res, bool close_connection,
  13719. Error &error) {
  13720. if (req.path.empty()) {
  13721. error = Error::Connection;
  13722. output_error_log(error, &req);
  13723. return false;
  13724. }
  13725. auto req_save = req;
  13726. bool ret;
  13727. if (!is_ssl() && is_proxy_enabled_for_host(host_)) {
  13728. auto req2 = req;
  13729. req2.path = "http://" +
  13730. detail::make_host_and_port_string(host_, port_, false) +
  13731. req.path;
  13732. ret = process_request(strm, req2, res, close_connection, error);
  13733. req = std::move(req2);
  13734. req.path = req_save.path;
  13735. } else {
  13736. ret = process_request(strm, req, res, close_connection, error);
  13737. }
  13738. if (!ret) { return false; }
  13739. {
  13740. // NOTE: this requires a not-entirely-obvious chain of calls to be correct
  13741. // for this to be safe.
  13742. // This is safe to call because handle_request is only called by send_
  13743. // which locks the request mutex during the process. It would be a bug
  13744. // to call it from a different thread since it's a thread-safety issue
  13745. // to do these things to the socket if another thread is using the socket.
  13746. std::lock_guard<std::mutex> guard(socket_mutex_);
  13747. // Also when the request asked for it (e.g. a body that was never sent),
  13748. // so that a redirect or an auth retry below does not reuse the socket.
  13749. if (socket_should_be_closed_when_request_is_done_ ||
  13750. detail::has_header_token(res.headers, "Connection", "close") ||
  13751. (res.version == "HTTP/1.0" && res.reason != "Connection established")) {
  13752. disconnect(/*gracefully=*/true);
  13753. }
  13754. }
  13755. if (follow_location_ && detail::is_redirect(res)) {
  13756. req = std::move(req_save);
  13757. // The client that followed the redirect has answered any challenge it
  13758. // could. Retrying below would sign another host's challenge and send it
  13759. // here.
  13760. return redirect(req, res, error);
  13761. }
  13762. #ifdef CPPHTTPLIB_SSL_ENABLED
  13763. if ((res.status == StatusCode::Unauthorized_401 ||
  13764. res.status == StatusCode::ProxyAuthenticationRequired_407) &&
  13765. req.authorization_count_ < 5) {
  13766. auto is_proxy = res.status == StatusCode::ProxyAuthenticationRequired_407;
  13767. // Only retry when the 407 actually came from a proxy hop: plain HTTP
  13768. // through an enabled proxy. HTTPS via CONNECT tunnels the 407 from the
  13769. // origin (#2457); direct/bypassed origins have no proxy hop at all.
  13770. if (is_proxy && !(!is_ssl() && is_proxy_enabled_for_host(host_))) {
  13771. return ret;
  13772. }
  13773. const auto &username =
  13774. is_proxy ? proxy_digest_auth_username_ : digest_auth_username_;
  13775. const auto &password =
  13776. is_proxy ? proxy_digest_auth_password_ : digest_auth_password_;
  13777. if (!username.empty() && !password.empty()) {
  13778. std::map<std::string, std::string> auth;
  13779. if (detail::parse_www_authenticate(res, auth, is_proxy)) {
  13780. Request new_req = req;
  13781. new_req.authorization_count_ += 1;
  13782. new_req.headers.erase(is_proxy ? "Proxy-Authorization"
  13783. : "Authorization");
  13784. new_req.headers.insert(detail::make_digest_authentication_header(
  13785. req, make_request_target(req), auth, new_req.authorization_count_,
  13786. detail::random_string(10), username, password, is_proxy));
  13787. Response new_res;
  13788. ret = send(new_req, new_res, error);
  13789. if (ret) { res = std::move(new_res); }
  13790. }
  13791. }
  13792. }
  13793. #endif
  13794. return ret;
  13795. }
  13796. inline bool ClientImpl::redirect(Request &req, Response &res, Error &error) {
  13797. if (req.redirect_count_ == 0) {
  13798. error = Error::ExceedRedirectCount;
  13799. output_error_log(error, &req);
  13800. return false;
  13801. }
  13802. auto location = res.get_header_value("location");
  13803. if (location.empty()) { return false; }
  13804. detail::UrlComponents uc;
  13805. if (!detail::parse_url(detail::resolve_relative_location(location, req.path),
  13806. uc)) {
  13807. return false;
  13808. }
  13809. // Only follow http/https redirects
  13810. if (!uc.scheme.empty() && uc.scheme != "http" && uc.scheme != "https") {
  13811. return false;
  13812. }
  13813. auto scheme = is_ssl() ? "https" : "http";
  13814. auto next_scheme = std::move(uc.scheme);
  13815. auto next_host = std::move(uc.host);
  13816. auto port_str = std::move(uc.port);
  13817. auto next_path = std::move(uc.path);
  13818. auto next_query = std::move(uc.query);
  13819. auto next_port = port_;
  13820. if (!port_str.empty()) {
  13821. if (!detail::parse_port(port_str, next_port)) { return false; }
  13822. } else if (!next_scheme.empty()) {
  13823. next_port = next_scheme == "https" ? 443 : 80;
  13824. }
  13825. if (next_scheme.empty()) { next_scheme = scheme; }
  13826. if (next_host.empty()) { next_host = host_; }
  13827. if (next_path.empty()) { next_path = "/"; }
  13828. auto path = std::move(next_path) + next_query;
  13829. // Same host redirect - use current client
  13830. if (next_scheme == scheme && next_host == host_ && next_port == port_) {
  13831. return detail::redirect(*this, req, res, path, location, error);
  13832. }
  13833. // Cross-host/scheme redirect - create new client with robust setup
  13834. return create_redirect_client(next_scheme, next_host, next_port, req, res,
  13835. path, location, error);
  13836. }
  13837. // New method for robust redirect client creation
  13838. inline bool ClientImpl::create_redirect_client(
  13839. const std::string &scheme, const std::string &host, int port, Request &req,
  13840. Response &res, const std::string &path, const std::string &location,
  13841. Error &error) {
  13842. // Determine if we need SSL
  13843. auto need_ssl = (scheme == "https");
  13844. // Clean up request headers that are host/client specific
  13845. // Remove headers that should not be carried over to new host
  13846. auto headers_to_remove = std::vector<std::string>{
  13847. "Host", "Proxy-Authorization", "Authorization", "Cookie", "Cookie2"};
  13848. for (const auto &header_name : headers_to_remove) {
  13849. auto it = req.headers.find(header_name);
  13850. while (it != req.headers.end()) {
  13851. it = req.headers.erase(it);
  13852. it = req.headers.find(header_name);
  13853. }
  13854. }
  13855. // Create appropriate client type and handle redirect
  13856. if (need_ssl) {
  13857. #ifdef CPPHTTPLIB_SSL_ENABLED
  13858. // Create SSL client for HTTPS redirect
  13859. SSLClient redirect_client(host, port);
  13860. // Setup basic client configuration first
  13861. setup_redirect_client(redirect_client);
  13862. redirect_client.enable_server_certificate_verification(
  13863. server_certificate_verification_);
  13864. redirect_client.enable_server_hostname_verification(
  13865. server_hostname_verification_);
  13866. redirect_client.system_ca_mode_ = system_ca_mode_;
  13867. // Transfer CA certificate to redirect client
  13868. redirect_client.set_ca_cert_path(ca_cert_file_path_, ca_cert_dir_path_);
  13869. if (is_ssl()) {
  13870. auto &self = static_cast<SSLClient &>(*this);
  13871. // A store given to set_ca_cert_store() lives only in this client's
  13872. // context, which then holds all that is trusted.
  13873. if (self.ca_cert_store_set_) {
  13874. std::string pem;
  13875. {
  13876. std::lock_guard<std::mutex> guard(self.ctx_mutex_);
  13877. pem = detail::ca_certs_to_pem(self.ctx_);
  13878. }
  13879. redirect_client.load_ca_cert_store(pem.data(), pem.size());
  13880. redirect_client.ca_cert_store_set_ = true;
  13881. } else {
  13882. redirect_client.load_ca_cert_store(ca_cert_pem_.c_str(),
  13883. ca_cert_pem_.size());
  13884. }
  13885. redirect_client.set_session_verifier(self.session_verifier_);
  13886. if (self.server_certificate_verifier_) {
  13887. redirect_client.set_server_certificate_verifier(
  13888. self.server_certificate_verifier_);
  13889. }
  13890. #ifdef CPPHTTPLIB_WINDOWS_AUTOMATIC_ROOT_CERTIFICATES_UPDATE
  13891. redirect_client.enable_windows_cert_verification_ =
  13892. self.enable_windows_cert_verification_;
  13893. #endif
  13894. }
  13895. // Client certificates are set through constructor for SSLClient
  13896. // NOTE: SSLClient constructor already takes client_cert_path and
  13897. // client_key_path so we need to create it properly if client certs are
  13898. // needed
  13899. // Execute the redirect
  13900. return detail::redirect(redirect_client, req, res, path, location, error);
  13901. #else
  13902. // SSL not supported - set appropriate error
  13903. error = Error::SSLConnection;
  13904. output_error_log(error, &req);
  13905. return false;
  13906. #endif
  13907. } else {
  13908. // HTTP redirect
  13909. ClientImpl redirect_client(host, port);
  13910. // Setup client with robust configuration
  13911. setup_redirect_client(redirect_client);
  13912. // Execute the redirect
  13913. return detail::redirect(redirect_client, req, res, path, location, error);
  13914. }
  13915. }
  13916. // New method for robust client setup (based on basic_manual_redirect.cpp
  13917. // logic)
  13918. template <typename ClientType>
  13919. inline void ClientImpl::setup_redirect_client(ClientType &client) {
  13920. // Copy basic settings first
  13921. client.set_connection_timeout(connection_timeout_sec_,
  13922. connection_timeout_usec_);
  13923. client.set_read_timeout(read_timeout_sec_, read_timeout_usec_);
  13924. client.set_write_timeout(write_timeout_sec_, write_timeout_usec_);
  13925. client.set_max_timeout(max_timeout_msec_);
  13926. if (has_payload_max_length_) {
  13927. client.set_payload_max_length(payload_max_length_);
  13928. }
  13929. client.set_keep_alive(keep_alive_);
  13930. client.set_follow_location(
  13931. true); // Enable redirects to handle multi-step redirects
  13932. client.set_path_encode(path_encode_);
  13933. client.set_compress(compress_);
  13934. client.set_decompress(decompress_);
  13935. // NOTE: Authentication credentials (basic auth, bearer token, digest auth)
  13936. // are intentionally NOT copied to the redirect client. Per RFC 9110 Section
  13937. // 15.4, credentials must not be forwarded when redirecting to a different
  13938. // host. This function is only called for cross-host redirects; same-host
  13939. // redirects are handled directly in ClientImpl::redirect().
  13940. // Copy the proxy configuration unconditionally; the per-target bypass is
  13941. // re-evaluated at send time, so a later hop to a non-bypassed host can
  13942. // still use the proxy.
  13943. client.no_proxy_entries_ = no_proxy_entries_;
  13944. if (!proxy_host_.empty() && proxy_port_ != -1) {
  13945. client.set_proxy(proxy_host_, proxy_port_);
  13946. if (!proxy_basic_auth_username_.empty() ||
  13947. !proxy_basic_auth_password_.empty()) {
  13948. client.set_proxy_basic_auth(proxy_basic_auth_username_,
  13949. proxy_basic_auth_password_);
  13950. }
  13951. if (!proxy_bearer_token_auth_token_.empty()) {
  13952. client.set_proxy_bearer_token_auth(proxy_bearer_token_auth_token_);
  13953. }
  13954. #ifdef CPPHTTPLIB_SSL_ENABLED
  13955. if (!proxy_digest_auth_username_.empty()) {
  13956. client.set_proxy_digest_auth(proxy_digest_auth_username_,
  13957. proxy_digest_auth_password_);
  13958. }
  13959. #endif
  13960. }
  13961. // Copy network and socket settings
  13962. client.addr_map_ = addr_map_;
  13963. client.set_address_family(address_family_);
  13964. client.set_tcp_nodelay(tcp_nodelay_);
  13965. client.set_ipv6_v6only(ipv6_v6only_);
  13966. if (socket_options_) { client.set_socket_options(socket_options_); }
  13967. if (!interface_.empty()) { client.set_interface(interface_); }
  13968. // Copy logging and headers
  13969. if (logger_) { client.set_logger(logger_); }
  13970. if (error_logger_) { client.set_error_logger(error_logger_); }
  13971. // NOTE: DO NOT copy default_headers_ as they may contain stale Host headers
  13972. // Each new client should generate its own headers based on its target host
  13973. }
  13974. inline bool ClientImpl::write_content_with_provider(Stream &strm,
  13975. const Request &req,
  13976. Error &error) const {
  13977. auto is_shutting_down = []() { return false; };
  13978. if (req.is_chunked_content_provider_) {
  13979. auto compressor = compress_ ? detail::create_compressor().first
  13980. : std::unique_ptr<detail::compressor>();
  13981. if (!compressor) {
  13982. compressor = detail::make_unique<detail::nocompressor>();
  13983. }
  13984. return detail::write_content_chunked(strm, req.content_provider_,
  13985. is_shutting_down, *compressor, error);
  13986. } else {
  13987. return detail::write_content_with_progress(
  13988. strm, req.content_provider_, 0, req.content_length_, is_shutting_down,
  13989. req.upload_progress, error);
  13990. }
  13991. }
  13992. // What goes on the request line for req: its path, encoded and without the
  13993. // fragment, with `req.params` as the query when the path has none.
  13994. inline std::string ClientImpl::make_request_target(const Request &req) const {
  13995. auto target = detail::encode_request_target(req.path, path_encode_);
  13996. if (detail::query_of(req.path).empty() && !req.params.empty()) {
  13997. target = append_query_params(target, req.params);
  13998. }
  13999. return target;
  14000. }
  14001. inline bool ClientImpl::write_request(Stream &strm, Request &req,
  14002. bool close_connection, Error &error,
  14003. bool skip_body, bool &rejected_locally) {
  14004. rejected_locally = false;
  14005. // Prepare additional headers
  14006. if (close_connection) {
  14007. if (!req.has_header("Connection")) {
  14008. req.set_header("Connection", "close");
  14009. }
  14010. }
  14011. std::string ct_for_defaults;
  14012. if (!req.has_header("Content-Type") && !req.body.empty()) {
  14013. ct_for_defaults = "text/plain";
  14014. }
  14015. prepare_default_headers(req, false, ct_for_defaults);
  14016. if (req.body.empty()) {
  14017. if (req.content_provider_) {
  14018. if (!req.is_chunked_content_provider_) {
  14019. if (!req.has_header("Content-Length")) {
  14020. auto length = std::to_string(req.content_length_);
  14021. req.set_header("Content-Length", length);
  14022. }
  14023. }
  14024. } else {
  14025. if (req.method == "POST" || req.method == "PUT" ||
  14026. req.method == "PATCH") {
  14027. req.set_header("Content-Length", "0");
  14028. }
  14029. }
  14030. }
  14031. // A CONNECT request is read by the proxy; everything sent through the tunnel
  14032. // it opens is read by the origin. Each credential goes only to its own hop.
  14033. auto is_connect = req.method == "CONNECT";
  14034. if (!is_connect) {
  14035. detail::add_authorization_header(req, basic_auth_username_,
  14036. basic_auth_password_,
  14037. bearer_token_auth_token_, false);
  14038. }
  14039. // Proxy-Authorization is only sent when the proxy reads this message —
  14040. // otherwise NO_PROXY-matched requests, and requests inside a TLS tunnel,
  14041. // would leak proxy credentials to the destination server.
  14042. if (is_proxy_enabled_for_host(host_) && (!is_ssl() || is_connect)) {
  14043. detail::add_authorization_header(req, proxy_basic_auth_username_,
  14044. proxy_basic_auth_password_,
  14045. proxy_bearer_token_auth_token_, true);
  14046. }
  14047. // Request line and headers
  14048. {
  14049. detail::BufferStream bstrm;
  14050. auto path_with_query = make_request_target(req);
  14051. // The query already came in through `req.path`; still populate
  14052. // `req.params` for handlers/users who read them.
  14053. auto query_part = detail::query_of(req.path);
  14054. if (!query_part.empty()) {
  14055. detail::parse_query_text(query_part, req.params);
  14056. }
  14057. // Write request line and headers
  14058. if (detail::write_request_line(bstrm, req.method, path_with_query) < 0) {
  14059. // A rejected method (not a token, e.g. carrying CR/LF) or target (e.g.
  14060. // CR/LF in a caller-supplied path under set_path_encode(false)) must
  14061. // fail the request cleanly instead of emitting a request-line-less,
  14062. // header-injecting request.
  14063. error = Error::Write;
  14064. rejected_locally = true;
  14065. output_error_log(error, &req);
  14066. return false;
  14067. }
  14068. if (!detail::check_and_write_headers(bstrm, req.headers, header_writer_,
  14069. error)) {
  14070. rejected_locally = true;
  14071. output_error_log(error, &req);
  14072. return false;
  14073. }
  14074. // Flush buffer
  14075. auto &data = bstrm.get_buffer();
  14076. if (!detail::write_data(strm, data.data(), data.size())) {
  14077. error = Error::Write;
  14078. output_error_log(error, &req);
  14079. return false;
  14080. }
  14081. }
  14082. // After sending request line and headers, wait briefly for an early server
  14083. // response (e.g. 4xx) and avoid sending a potentially large request body
  14084. // unnecessarily. This workaround is only enabled on Windows because Unix
  14085. // platforms surface write errors (EPIPE) earlier; on Windows kernel send
  14086. // buffering can accept large writes even when the peer already responded.
  14087. // Check the stream first (which covers SSL via `is_readable()`), then
  14088. // fall back to select on the socket. Only perform the wait for very large
  14089. // request bodies to avoid interfering with normal small requests and
  14090. // reduce side-effects. Poll briefly (up to 50ms as default) for an early
  14091. // response. Skip this check when using Expect: 100-continue, as the protocol
  14092. // handles early responses properly.
  14093. #if defined(_WIN32)
  14094. if (!skip_body &&
  14095. req.body.size() > CPPHTTPLIB_WAIT_EARLY_SERVER_RESPONSE_THRESHOLD &&
  14096. req.path.size() > CPPHTTPLIB_REQUEST_URI_MAX_LENGTH) {
  14097. auto start = std::chrono::high_resolution_clock::now();
  14098. for (;;) {
  14099. // Prefer socket-level readiness to avoid SSL_pending() false-positives
  14100. // from SSL internals. If the underlying socket is readable, assume an
  14101. // early response may be present.
  14102. auto sock = strm.socket();
  14103. if (sock != INVALID_SOCKET && detail::select_read(sock, 0, 0) > 0) {
  14104. return false;
  14105. }
  14106. // Fallback to stream-level check for non-socket streams or when the
  14107. // socket isn't reporting readable. Avoid using `is_readable()` for
  14108. // SSL, since `SSL_pending()` may report buffered records that do not
  14109. // indicate a complete application-level response yet.
  14110. if (!is_ssl() && strm.is_readable()) { return false; }
  14111. auto now = std::chrono::high_resolution_clock::now();
  14112. auto elapsed =
  14113. std::chrono::duration_cast<std::chrono::milliseconds>(now - start)
  14114. .count();
  14115. if (elapsed >= CPPHTTPLIB_WAIT_EARLY_SERVER_RESPONSE_TIMEOUT_MSECOND) {
  14116. break;
  14117. }
  14118. std::this_thread::sleep_for(std::chrono::milliseconds(1));
  14119. }
  14120. }
  14121. #endif
  14122. // Body
  14123. if (skip_body) { return true; }
  14124. return write_request_body(strm, req, error);
  14125. }
  14126. inline bool ClientImpl::write_request_body(Stream &strm, Request &req,
  14127. Error &error) {
  14128. if (req.body.empty()) {
  14129. return write_content_with_provider(strm, req, error);
  14130. }
  14131. if (req.upload_progress) {
  14132. auto body_size = req.body.size();
  14133. size_t written = 0;
  14134. auto data = req.body.data();
  14135. while (written < body_size) {
  14136. size_t to_write = (std::min)(CPPHTTPLIB_SEND_BUFSIZ, body_size - written);
  14137. if (!detail::write_data(strm, data + written, to_write)) {
  14138. error = Error::Write;
  14139. output_error_log(error, &req);
  14140. return false;
  14141. }
  14142. written += to_write;
  14143. if (!req.upload_progress(written, body_size)) {
  14144. error = Error::Canceled;
  14145. output_error_log(error, &req);
  14146. return false;
  14147. }
  14148. }
  14149. } else {
  14150. if (!detail::write_data(strm, req.body.data(), req.body.size())) {
  14151. error = Error::Write;
  14152. output_error_log(error, &req);
  14153. return false;
  14154. }
  14155. }
  14156. return true;
  14157. }
  14158. inline std::unique_ptr<Response>
  14159. ClientImpl::send_with_content_provider_and_receiver(
  14160. Request &req, const char *body, size_t content_length,
  14161. ContentProvider content_provider,
  14162. ContentProviderWithoutLength content_provider_without_length,
  14163. const std::string &content_type, ContentReceiver content_receiver,
  14164. Error &error) {
  14165. if (!content_type.empty()) { req.set_header("Content-Type", content_type); }
  14166. auto enc = compress_
  14167. ? detail::create_compressor()
  14168. : std::pair<std::unique_ptr<detail::compressor>, const char *>(
  14169. nullptr, nullptr);
  14170. if (enc.second) { req.set_header("Content-Encoding", enc.second); }
  14171. if (enc.first && !content_provider_without_length) {
  14172. auto &compressor = enc.first;
  14173. if (content_provider) {
  14174. auto ok = true;
  14175. auto finished = false;
  14176. size_t offset = 0;
  14177. DataSink data_sink;
  14178. data_sink.write = [&](const char *data, size_t data_len) -> bool {
  14179. if (ok) {
  14180. auto last = offset + data_len == content_length;
  14181. auto ret = compressor->compress(
  14182. data, data_len, last,
  14183. [&](const char *compressed_data, size_t compressed_data_len) {
  14184. req.body.append(compressed_data, compressed_data_len);
  14185. return true;
  14186. });
  14187. if (ret) {
  14188. offset += data_len;
  14189. } else {
  14190. ok = false;
  14191. }
  14192. }
  14193. return ok;
  14194. };
  14195. // As in detail::write_content_with_progress(): the body is framed by
  14196. // content_length, so a provider that finishes early has truncated it.
  14197. // Stop and report that instead of calling the provider forever.
  14198. data_sink.done = [&]() { finished = true; };
  14199. while (ok && !finished && offset < content_length) {
  14200. if (!content_provider(offset, content_length - offset, data_sink)) {
  14201. error = Error::Canceled;
  14202. output_error_log(error, &req);
  14203. return nullptr;
  14204. }
  14205. }
  14206. // A short body here means either the provider stopped early or the
  14207. // compressor gave up. The branch below reports a failing compressor as
  14208. // Error::Compression, so keep the two distinguishable.
  14209. if (offset < content_length) {
  14210. error = ok ? Error::Write : Error::Compression;
  14211. output_error_log(error, &req);
  14212. return nullptr;
  14213. }
  14214. } else {
  14215. if (!compressor->compress(body, content_length, true,
  14216. [&](const char *data, size_t data_len) {
  14217. req.body.append(data, data_len);
  14218. return true;
  14219. })) {
  14220. error = Error::Compression;
  14221. output_error_log(error, &req);
  14222. return nullptr;
  14223. }
  14224. }
  14225. } else {
  14226. if (content_provider) {
  14227. req.content_length_ = content_length;
  14228. req.content_provider_ = std::move(content_provider);
  14229. req.is_chunked_content_provider_ = false;
  14230. } else if (content_provider_without_length) {
  14231. req.content_length_ = 0;
  14232. req.content_provider_ = detail::ContentProviderAdapter(
  14233. std::move(content_provider_without_length));
  14234. req.is_chunked_content_provider_ = true;
  14235. req.set_header("Transfer-Encoding", "chunked");
  14236. } else {
  14237. req.body.assign(body, content_length);
  14238. }
  14239. }
  14240. if (content_receiver) {
  14241. req.content_receiver =
  14242. [content_receiver](const char *data, size_t data_length,
  14243. size_t /*offset*/, size_t /*total_length*/) {
  14244. return content_receiver(data, data_length);
  14245. };
  14246. }
  14247. auto res = detail::make_unique<Response>();
  14248. return send(req, *res, error) ? std::move(res) : nullptr;
  14249. }
  14250. inline Result ClientImpl::send_with_content_provider_and_receiver(
  14251. const std::string &method, const std::string &path, const Headers &headers,
  14252. const char *body, size_t content_length, ContentProvider content_provider,
  14253. ContentProviderWithoutLength content_provider_without_length,
  14254. const std::string &content_type, ContentReceiver content_receiver,
  14255. UploadProgress progress) {
  14256. Request req;
  14257. req.method = method;
  14258. req.headers = headers;
  14259. req.path = path;
  14260. req.upload_progress = std::move(progress);
  14261. if (max_timeout_msec_ > 0) {
  14262. req.start_time_ = std::chrono::steady_clock::now();
  14263. }
  14264. auto error = Error::Success;
  14265. #ifdef CPPHTTPLIB_SSL_ENABLED
  14266. // Hold the request lock until the Result has read this request's TLS error
  14267. std::lock_guard<std::recursive_mutex> request_mutex_guard(request_mutex_);
  14268. #endif
  14269. auto res = send_with_content_provider_and_receiver(
  14270. req, body, content_length, std::move(content_provider),
  14271. std::move(content_provider_without_length), content_type,
  14272. std::move(content_receiver), error);
  14273. #ifdef CPPHTTPLIB_SSL_ENABLED
  14274. return Result{std::move(res), error, std::move(req.headers), last_ssl_error_,
  14275. last_backend_error_};
  14276. #else
  14277. return Result{std::move(res), error, std::move(req.headers)};
  14278. #endif
  14279. }
  14280. inline void ClientImpl::output_log(const Request &req,
  14281. const Response &res) const {
  14282. if (logger_) {
  14283. std::lock_guard<std::mutex> guard(logger_mutex_);
  14284. logger_(req, res);
  14285. }
  14286. }
  14287. inline void ClientImpl::output_error_log(const Error &err,
  14288. const Request *req) const {
  14289. if (error_logger_) {
  14290. std::lock_guard<std::mutex> guard(logger_mutex_);
  14291. error_logger_(err, req);
  14292. }
  14293. }
  14294. inline bool ClientImpl::process_request(Stream &strm, Request &req,
  14295. Response &res, bool close_connection,
  14296. Error &error) {
  14297. // Auto-add Expect: 100-continue for large bodies
  14298. if (CPPHTTPLIB_EXPECT_100_THRESHOLD > 0 && !req.has_header("Expect")) {
  14299. auto body_size = req.body.empty() ? req.content_length_ : req.body.size();
  14300. if (body_size >= CPPHTTPLIB_EXPECT_100_THRESHOLD) {
  14301. req.set_header("Expect", "100-continue");
  14302. }
  14303. }
  14304. // Check for Expect: 100-continue
  14305. auto expect_100_continue =
  14306. detail::has_header_token(req.headers, "Expect", "100-continue");
  14307. // Send request (skip body if using Expect: 100-continue)
  14308. auto rejected_locally = false;
  14309. auto write_request_success =
  14310. write_request(strm, req, close_connection, error, expect_100_continue,
  14311. rejected_locally);
  14312. // A failed write normally still reads the response below, since the server
  14313. // may have answered early (e.g. 413/414) and closed while the body was being
  14314. // sent. A request rejected before any byte reached the socket gets no such
  14315. // response, and waiting for one would block until the read timeout.
  14316. if (rejected_locally) { return false; }
  14317. #ifdef CPPHTTPLIB_SSL_ENABLED
  14318. if (is_ssl() && !expect_100_continue) {
  14319. auto is_proxy_enabled = is_proxy_enabled_for_host(host_);
  14320. if (!is_proxy_enabled) {
  14321. if (tls::is_peer_closed(socket_.ssl, socket_.sock)) {
  14322. error = Error::SSLPeerCouldBeClosed_;
  14323. output_error_log(error, &req);
  14324. return false;
  14325. }
  14326. }
  14327. }
  14328. #endif
  14329. // Handle Expect: 100-continue.
  14330. //
  14331. // Wait for an interim/early response by attempting to read the status line
  14332. // under a short timeout, instead of trusting raw socket readability. Over
  14333. // TLS, post-handshake records (e.g. session tickets) make the socket
  14334. // readable without any HTTP response being available; relying on
  14335. // `select_read` there caused the body to be withheld forever and the
  14336. // request to fail with `Read` (#2458). If no status line arrives within the
  14337. // timeout, send the body anyway (matching curl's behavior).
  14338. auto status_line_read = false;
  14339. if (expect_100_continue && write_request_success) {
  14340. if (CPPHTTPLIB_EXPECT_100_TIMEOUT_MSECOND > 0) {
  14341. time_t sec = CPPHTTPLIB_EXPECT_100_TIMEOUT_MSECOND / 1000;
  14342. time_t usec = (CPPHTTPLIB_EXPECT_100_TIMEOUT_MSECOND % 1000) * 1000;
  14343. strm.set_read_timeout(sec, usec);
  14344. status_line_read = read_response_line(strm, req, res, false);
  14345. strm.set_read_timeout(read_timeout_sec_, read_timeout_usec_);
  14346. }
  14347. if (!status_line_read) {
  14348. // No interim response within the timeout: send the body and handle the
  14349. // response as usual.
  14350. if (!write_request_body(strm, req, error)) { return false; }
  14351. expect_100_continue = false; // Switch to normal response handling
  14352. }
  14353. }
  14354. // Receive response and headers
  14355. // When using Expect: 100-continue, don't auto-skip `100 Continue` response
  14356. if ((!status_line_read &&
  14357. !read_response_line(strm, req, res, !expect_100_continue)) ||
  14358. !detail::read_headers(strm, res.headers)) {
  14359. if (write_request_success) { error = Error::Read; }
  14360. output_error_log(error, &req);
  14361. return false;
  14362. }
  14363. if (!write_request_success) { return false; }
  14364. // Handle Expect: 100-continue response
  14365. if (expect_100_continue) {
  14366. if (res.status == StatusCode::Continue_100) {
  14367. // Server accepted, send the body
  14368. if (!write_request_body(strm, req, error)) { return false; }
  14369. // Read the actual response
  14370. res.headers.clear();
  14371. res.body.clear();
  14372. if (!read_response_line(strm, req, res) ||
  14373. !detail::read_headers(strm, res.headers)) {
  14374. error = Error::Read;
  14375. output_error_log(error, &req);
  14376. return false;
  14377. }
  14378. } else {
  14379. // A final response came first, so the body this request declared was
  14380. // never sent, and the server may still be waiting for it. The
  14381. // connection cannot carry another request.
  14382. std::lock_guard<std::mutex> guard(socket_mutex_);
  14383. socket_should_be_closed_when_request_is_done_ = true;
  14384. }
  14385. }
  14386. // Body
  14387. if ((res.status != StatusCode::NoContent_204) && req.method != "HEAD" &&
  14388. req.method != "CONNECT") {
  14389. // Reject ambiguous framing (RFC 9112 §6.3). Unlike a request, a response
  14390. // whose final transfer coding is not chunked is not ambiguous: its body
  14391. // runs until the server closes the connection, so it is not rejected.
  14392. // HEAD/204 are excluded above and a 304 carries no body.
  14393. if (res.status != StatusCode::NotModified_304) {
  14394. if (detail::has_conflicting_content_length(res.headers)) {
  14395. error = Error::Read;
  14396. output_error_log(error, &req);
  14397. return false;
  14398. }
  14399. if (detail::has_faulty_transfer_encoding(res)) {
  14400. std::lock_guard<std::mutex> guard(socket_mutex_);
  14401. socket_should_be_closed_when_request_is_done_ = true;
  14402. }
  14403. }
  14404. auto redirect = follow_location_ && detail::is_redirect(res) &&
  14405. res.status != StatusCode::NotModified_304;
  14406. if (req.response_handler && !redirect) {
  14407. if (!req.response_handler(res)) {
  14408. error = Error::Canceled;
  14409. output_error_log(error, &req);
  14410. return false;
  14411. }
  14412. }
  14413. auto out =
  14414. req.content_receiver
  14415. ? static_cast<ContentReceiverWithProgress>(
  14416. [&](const char *buf, size_t n, size_t off, size_t len) {
  14417. if (redirect) { return true; }
  14418. auto ret = req.content_receiver(buf, n, off, len);
  14419. if (!ret) {
  14420. error = Error::Canceled;
  14421. output_error_log(error, &req);
  14422. }
  14423. return ret;
  14424. })
  14425. : static_cast<ContentReceiverWithProgress>(
  14426. [&](const char *buf, size_t n, size_t /*off*/,
  14427. size_t /*len*/) {
  14428. assert(res.body.size() + n <= res.body.max_size());
  14429. if (payload_max_length_ > 0 &&
  14430. (res.body.size() >= payload_max_length_ ||
  14431. n > payload_max_length_ - res.body.size())) {
  14432. return false;
  14433. }
  14434. res.body.append(buf, n);
  14435. return true;
  14436. });
  14437. auto progress = [&](size_t current, size_t total) {
  14438. if (!req.download_progress || redirect) { return true; }
  14439. auto ret = req.download_progress(current, total);
  14440. if (!ret) {
  14441. error = Error::Canceled;
  14442. output_error_log(error, &req);
  14443. }
  14444. return ret;
  14445. };
  14446. if (res.has_header("Content-Length")) {
  14447. if (!req.content_receiver) {
  14448. auto len = res.get_header_value_u64("Content-Length");
  14449. if (len > res.body.max_size()) {
  14450. error = Error::Read;
  14451. output_error_log(error, &req);
  14452. return false;
  14453. }
  14454. // Content-Length is only the server's claim, so reserve no more than
  14455. // payload_max_length_ allows, nor more than 1 MiB before any of the
  14456. // body has arrived. A longer body grows as it is read.
  14457. auto reserve_len =
  14458. (std::min)(static_cast<size_t>(len), size_t(1024 * 1024));
  14459. if (payload_max_length_ > 0) {
  14460. reserve_len = (std::min)(reserve_len, payload_max_length_);
  14461. }
  14462. res.body.reserve(reserve_len);
  14463. }
  14464. }
  14465. if (res.status != StatusCode::NotModified_304) {
  14466. auto content_status = 0;
  14467. auto max_length = (!has_payload_max_length_ && req.content_receiver)
  14468. ? (std::numeric_limits<size_t>::max)()
  14469. : payload_max_length_;
  14470. if (!detail::read_content(strm, res, max_length, content_status,
  14471. std::move(progress), std::move(out),
  14472. decompress_)) {
  14473. if (error != Error::Canceled) {
  14474. // Tell the caller apart from a plain read failure when the body could
  14475. // not be decoded because of its Content-Encoding.
  14476. switch (content_status) {
  14477. case StatusCode::UnsupportedMediaType_415:
  14478. error = Error::UnsupportedContentEncoding;
  14479. break;
  14480. case StatusCode::InternalServerError_500:
  14481. error = Error::Compression;
  14482. break;
  14483. default: error = Error::Read; break;
  14484. }
  14485. }
  14486. output_error_log(error, &req);
  14487. return false;
  14488. }
  14489. }
  14490. }
  14491. // Log
  14492. output_log(req, res);
  14493. return true;
  14494. }
  14495. inline ContentProviderWithoutLength ClientImpl::get_multipart_content_provider(
  14496. const std::string &boundary, const UploadFormDataItems &items,
  14497. const FormDataProviderItems &provider_items) const {
  14498. size_t cur_item = 0;
  14499. size_t cur_start = 0;
  14500. // cur_item and cur_start are copied to within the std::function and
  14501. // maintain state between successive calls
  14502. return [&, cur_item, cur_start](size_t offset,
  14503. DataSink &sink) mutable -> bool {
  14504. if (!offset && !items.empty()) {
  14505. sink.os << detail::serialize_multipart_formdata(items, boundary, false);
  14506. return true;
  14507. } else if (cur_item < provider_items.size()) {
  14508. if (!cur_start) {
  14509. const auto &begin = detail::serialize_multipart_formdata_item_begin(
  14510. provider_items[cur_item], boundary);
  14511. offset += begin.size();
  14512. cur_start = offset;
  14513. sink.os << begin;
  14514. }
  14515. DataSink cur_sink;
  14516. auto has_data = true;
  14517. cur_sink.write = sink.write;
  14518. // Forward is_writable so a provider item asking whether it may keep
  14519. // going gets the outer sink's answer rather than the default `true`.
  14520. cur_sink.is_writable = sink.is_writable;
  14521. cur_sink.done = [&]() { has_data = false; };
  14522. if (!provider_items[cur_item].provider(offset - cur_start, cur_sink)) {
  14523. return false;
  14524. }
  14525. if (!has_data) {
  14526. sink.os << detail::serialize_multipart_formdata_item_end();
  14527. cur_item++;
  14528. cur_start = 0;
  14529. }
  14530. return true;
  14531. } else {
  14532. sink.os << detail::serialize_multipart_formdata_finish(boundary);
  14533. sink.done();
  14534. return true;
  14535. }
  14536. };
  14537. }
  14538. inline bool ClientImpl::process_socket(
  14539. const Socket &socket,
  14540. std::chrono::time_point<std::chrono::steady_clock> start_time,
  14541. std::function<bool(Stream &strm)> callback) {
  14542. return detail::process_client_socket(
  14543. socket.sock, read_timeout_sec_, read_timeout_usec_, write_timeout_sec_,
  14544. write_timeout_usec_, max_timeout_msec_, start_time, std::move(callback));
  14545. }
  14546. inline bool ClientImpl::is_ssl() const { return false; }
  14547. inline Result ClientImpl::Get(const std::string &path,
  14548. DownloadProgress progress) {
  14549. return Get(path, Headers(), std::move(progress));
  14550. }
  14551. inline Result ClientImpl::Get(const std::string &path, const Params &params,
  14552. DownloadProgress progress) {
  14553. return Get(path, params, Headers(), std::move(progress));
  14554. }
  14555. inline Result ClientImpl::Get(const std::string &path, const Params &params,
  14556. const Headers &headers,
  14557. DownloadProgress progress) {
  14558. if (params.empty()) { return Get(path, headers); }
  14559. std::string path_with_query = append_query_params(path, params);
  14560. return Get(path_with_query, headers, std::move(progress));
  14561. }
  14562. inline Result ClientImpl::Get(const std::string &path, const Headers &headers,
  14563. DownloadProgress progress) {
  14564. Request req;
  14565. req.method = "GET";
  14566. req.path = path;
  14567. req.headers = headers;
  14568. req.download_progress = std::move(progress);
  14569. if (max_timeout_msec_ > 0) {
  14570. req.start_time_ = std::chrono::steady_clock::now();
  14571. }
  14572. return send_(std::move(req));
  14573. }
  14574. inline Result ClientImpl::Get(const std::string &path,
  14575. ContentReceiver content_receiver,
  14576. DownloadProgress progress) {
  14577. return Get(path, Headers(), nullptr, std::move(content_receiver),
  14578. std::move(progress));
  14579. }
  14580. inline Result ClientImpl::Get(const std::string &path, const Headers &headers,
  14581. ContentReceiver content_receiver,
  14582. DownloadProgress progress) {
  14583. return Get(path, headers, nullptr, std::move(content_receiver),
  14584. std::move(progress));
  14585. }
  14586. inline Result ClientImpl::Get(const std::string &path,
  14587. ResponseHandler response_handler,
  14588. ContentReceiver content_receiver,
  14589. DownloadProgress progress) {
  14590. return Get(path, Headers(), std::move(response_handler),
  14591. std::move(content_receiver), std::move(progress));
  14592. }
  14593. inline Result ClientImpl::Get(const std::string &path, const Headers &headers,
  14594. ResponseHandler response_handler,
  14595. ContentReceiver content_receiver,
  14596. DownloadProgress progress) {
  14597. Request req;
  14598. req.method = "GET";
  14599. req.path = path;
  14600. req.headers = headers;
  14601. req.response_handler = std::move(response_handler);
  14602. req.content_receiver =
  14603. [content_receiver](const char *data, size_t data_length,
  14604. size_t /*offset*/, size_t /*total_length*/) {
  14605. return content_receiver(data, data_length);
  14606. };
  14607. req.download_progress = std::move(progress);
  14608. if (max_timeout_msec_ > 0) {
  14609. req.start_time_ = std::chrono::steady_clock::now();
  14610. }
  14611. return send_(std::move(req));
  14612. }
  14613. inline Result ClientImpl::Get(const std::string &path, const Params &params,
  14614. const Headers &headers,
  14615. ContentReceiver content_receiver,
  14616. DownloadProgress progress) {
  14617. return Get(path, params, headers, nullptr, std::move(content_receiver),
  14618. std::move(progress));
  14619. }
  14620. inline Result ClientImpl::Get(const std::string &path, const Params &params,
  14621. const Headers &headers,
  14622. ResponseHandler response_handler,
  14623. ContentReceiver content_receiver,
  14624. DownloadProgress progress) {
  14625. if (params.empty()) {
  14626. return Get(path, headers, std::move(response_handler),
  14627. std::move(content_receiver), std::move(progress));
  14628. }
  14629. std::string path_with_query = append_query_params(path, params);
  14630. return Get(path_with_query, headers, std::move(response_handler),
  14631. std::move(content_receiver), std::move(progress));
  14632. }
  14633. inline Result ClientImpl::Head(const std::string &path) {
  14634. return Head(path, Headers());
  14635. }
  14636. inline Result ClientImpl::Head(const std::string &path,
  14637. const Headers &headers) {
  14638. Request req;
  14639. req.method = "HEAD";
  14640. req.headers = headers;
  14641. req.path = path;
  14642. if (max_timeout_msec_ > 0) {
  14643. req.start_time_ = std::chrono::steady_clock::now();
  14644. }
  14645. return send_(std::move(req));
  14646. }
  14647. inline Result ClientImpl::Post(const std::string &path) {
  14648. return Post(path, std::string(), std::string());
  14649. }
  14650. inline Result ClientImpl::Post(const std::string &path,
  14651. const Headers &headers) {
  14652. return Post(path, headers, nullptr, 0, std::string());
  14653. }
  14654. inline Result ClientImpl::Post(const std::string &path, const char *body,
  14655. size_t content_length,
  14656. const std::string &content_type,
  14657. UploadProgress progress) {
  14658. return Post(path, Headers(), body, content_length, content_type, progress);
  14659. }
  14660. inline Result ClientImpl::Post(const std::string &path, const std::string &body,
  14661. const std::string &content_type,
  14662. UploadProgress progress) {
  14663. return Post(path, Headers(), body, content_type, progress);
  14664. }
  14665. inline Result ClientImpl::Post(const std::string &path, const Params &params) {
  14666. return Post(path, Headers(), params);
  14667. }
  14668. inline Result ClientImpl::Post(const std::string &path, size_t content_length,
  14669. ContentProvider content_provider,
  14670. const std::string &content_type,
  14671. UploadProgress progress) {
  14672. return Post(path, Headers(), content_length, std::move(content_provider),
  14673. content_type, progress);
  14674. }
  14675. inline Result ClientImpl::Post(const std::string &path, size_t content_length,
  14676. ContentProvider content_provider,
  14677. const std::string &content_type,
  14678. ContentReceiver content_receiver,
  14679. UploadProgress progress) {
  14680. return Post(path, Headers(), content_length, std::move(content_provider),
  14681. content_type, std::move(content_receiver), progress);
  14682. }
  14683. inline Result ClientImpl::Post(const std::string &path,
  14684. ContentProviderWithoutLength content_provider,
  14685. const std::string &content_type,
  14686. UploadProgress progress) {
  14687. return Post(path, Headers(), std::move(content_provider), content_type,
  14688. progress);
  14689. }
  14690. inline Result ClientImpl::Post(const std::string &path,
  14691. ContentProviderWithoutLength content_provider,
  14692. const std::string &content_type,
  14693. ContentReceiver content_receiver,
  14694. UploadProgress progress) {
  14695. return Post(path, Headers(), std::move(content_provider), content_type,
  14696. std::move(content_receiver), progress);
  14697. }
  14698. inline Result ClientImpl::Post(const std::string &path, const Headers &headers,
  14699. const Params &params) {
  14700. auto query = detail::params_to_query_str(params);
  14701. return Post(path, headers, query, "application/x-www-form-urlencoded");
  14702. }
  14703. inline Result ClientImpl::Post(const std::string &path,
  14704. const UploadFormDataItems &items,
  14705. UploadProgress progress) {
  14706. return Post(path, Headers(), items, progress);
  14707. }
  14708. inline Result ClientImpl::Post(const std::string &path, const Headers &headers,
  14709. const UploadFormDataItems &items,
  14710. UploadProgress progress) {
  14711. const auto &boundary = detail::make_multipart_data_boundary();
  14712. const auto &content_type =
  14713. detail::serialize_multipart_formdata_get_content_type(boundary);
  14714. auto content_length = detail::get_multipart_content_length(items, boundary);
  14715. return Post(path, headers, content_length,
  14716. detail::make_multipart_content_provider(items, boundary),
  14717. content_type, progress);
  14718. }
  14719. inline Result ClientImpl::Post(const std::string &path, const Headers &headers,
  14720. const UploadFormDataItems &items,
  14721. const std::string &boundary,
  14722. UploadProgress progress) {
  14723. if (!detail::is_multipart_boundary_chars_valid(boundary)) {
  14724. return Result{nullptr, Error::UnsupportedMultipartBoundaryChars};
  14725. }
  14726. const auto &content_type =
  14727. detail::serialize_multipart_formdata_get_content_type(boundary);
  14728. auto content_length = detail::get_multipart_content_length(items, boundary);
  14729. return Post(path, headers, content_length,
  14730. detail::make_multipart_content_provider(items, boundary),
  14731. content_type, progress);
  14732. }
  14733. inline Result ClientImpl::Post(const std::string &path, const Headers &headers,
  14734. const char *body, size_t content_length,
  14735. const std::string &content_type,
  14736. UploadProgress progress) {
  14737. return send_with_content_provider_and_receiver(
  14738. "POST", path, headers, body, content_length, nullptr, nullptr,
  14739. content_type, nullptr, progress);
  14740. }
  14741. inline Result ClientImpl::Post(const std::string &path, const Headers &headers,
  14742. const std::string &body,
  14743. const std::string &content_type,
  14744. UploadProgress progress) {
  14745. return send_with_content_provider_and_receiver(
  14746. "POST", path, headers, body.data(), body.size(), nullptr, nullptr,
  14747. content_type, nullptr, progress);
  14748. }
  14749. inline Result ClientImpl::Post(const std::string &path, const Headers &headers,
  14750. size_t content_length,
  14751. ContentProvider content_provider,
  14752. const std::string &content_type,
  14753. UploadProgress progress) {
  14754. return send_with_content_provider_and_receiver(
  14755. "POST", path, headers, nullptr, content_length,
  14756. std::move(content_provider), nullptr, content_type, nullptr, progress);
  14757. }
  14758. inline Result ClientImpl::Post(const std::string &path, const Headers &headers,
  14759. size_t content_length,
  14760. ContentProvider content_provider,
  14761. const std::string &content_type,
  14762. ContentReceiver content_receiver,
  14763. DownloadProgress progress) {
  14764. return send_with_content_provider_and_receiver(
  14765. "POST", path, headers, nullptr, content_length,
  14766. std::move(content_provider), nullptr, content_type,
  14767. std::move(content_receiver), std::move(progress));
  14768. }
  14769. inline Result ClientImpl::Post(const std::string &path, const Headers &headers,
  14770. ContentProviderWithoutLength content_provider,
  14771. const std::string &content_type,
  14772. UploadProgress progress) {
  14773. return send_with_content_provider_and_receiver(
  14774. "POST", path, headers, nullptr, 0, nullptr, std::move(content_provider),
  14775. content_type, nullptr, progress);
  14776. }
  14777. inline Result ClientImpl::Post(const std::string &path, const Headers &headers,
  14778. ContentProviderWithoutLength content_provider,
  14779. const std::string &content_type,
  14780. ContentReceiver content_receiver,
  14781. DownloadProgress progress) {
  14782. return send_with_content_provider_and_receiver(
  14783. "POST", path, headers, nullptr, 0, nullptr, std::move(content_provider),
  14784. content_type, std::move(content_receiver), std::move(progress));
  14785. }
  14786. inline Result ClientImpl::Post(const std::string &path, const Headers &headers,
  14787. const UploadFormDataItems &items,
  14788. const FormDataProviderItems &provider_items,
  14789. UploadProgress progress) {
  14790. const auto &boundary = detail::make_multipart_data_boundary();
  14791. const auto &content_type =
  14792. detail::serialize_multipart_formdata_get_content_type(boundary);
  14793. return send_with_content_provider_and_receiver(
  14794. "POST", path, headers, nullptr, 0, nullptr,
  14795. get_multipart_content_provider(boundary, items, provider_items),
  14796. content_type, nullptr, progress);
  14797. }
  14798. inline Result ClientImpl::Post(const std::string &path, const Headers &headers,
  14799. const std::string &body,
  14800. const std::string &content_type,
  14801. ContentReceiver content_receiver,
  14802. DownloadProgress progress) {
  14803. Request req;
  14804. req.method = "POST";
  14805. req.path = path;
  14806. req.headers = headers;
  14807. req.body = body;
  14808. req.content_receiver =
  14809. [content_receiver](const char *data, size_t data_length,
  14810. size_t /*offset*/, size_t /*total_length*/) {
  14811. return content_receiver(data, data_length);
  14812. };
  14813. req.download_progress = std::move(progress);
  14814. if (max_timeout_msec_ > 0) {
  14815. req.start_time_ = std::chrono::steady_clock::now();
  14816. }
  14817. if (!content_type.empty()) { req.set_header("Content-Type", content_type); }
  14818. return send_(std::move(req));
  14819. }
  14820. inline Result ClientImpl::Put(const std::string &path) {
  14821. return Put(path, std::string(), std::string());
  14822. }
  14823. inline Result ClientImpl::Put(const std::string &path, const Headers &headers) {
  14824. return Put(path, headers, nullptr, 0, std::string());
  14825. }
  14826. inline Result ClientImpl::Put(const std::string &path, const char *body,
  14827. size_t content_length,
  14828. const std::string &content_type,
  14829. UploadProgress progress) {
  14830. return Put(path, Headers(), body, content_length, content_type, progress);
  14831. }
  14832. inline Result ClientImpl::Put(const std::string &path, const std::string &body,
  14833. const std::string &content_type,
  14834. UploadProgress progress) {
  14835. return Put(path, Headers(), body, content_type, progress);
  14836. }
  14837. inline Result ClientImpl::Put(const std::string &path, const Params &params) {
  14838. return Put(path, Headers(), params);
  14839. }
  14840. inline Result ClientImpl::Put(const std::string &path, size_t content_length,
  14841. ContentProvider content_provider,
  14842. const std::string &content_type,
  14843. UploadProgress progress) {
  14844. return Put(path, Headers(), content_length, std::move(content_provider),
  14845. content_type, progress);
  14846. }
  14847. inline Result ClientImpl::Put(const std::string &path, size_t content_length,
  14848. ContentProvider content_provider,
  14849. const std::string &content_type,
  14850. ContentReceiver content_receiver,
  14851. UploadProgress progress) {
  14852. return Put(path, Headers(), content_length, std::move(content_provider),
  14853. content_type, std::move(content_receiver), progress);
  14854. }
  14855. inline Result ClientImpl::Put(const std::string &path,
  14856. ContentProviderWithoutLength content_provider,
  14857. const std::string &content_type,
  14858. UploadProgress progress) {
  14859. return Put(path, Headers(), std::move(content_provider), content_type,
  14860. progress);
  14861. }
  14862. inline Result ClientImpl::Put(const std::string &path,
  14863. ContentProviderWithoutLength content_provider,
  14864. const std::string &content_type,
  14865. ContentReceiver content_receiver,
  14866. UploadProgress progress) {
  14867. return Put(path, Headers(), std::move(content_provider), content_type,
  14868. std::move(content_receiver), progress);
  14869. }
  14870. inline Result ClientImpl::Put(const std::string &path, const Headers &headers,
  14871. const Params &params) {
  14872. auto query = detail::params_to_query_str(params);
  14873. return Put(path, headers, query, "application/x-www-form-urlencoded");
  14874. }
  14875. inline Result ClientImpl::Put(const std::string &path,
  14876. const UploadFormDataItems &items,
  14877. UploadProgress progress) {
  14878. return Put(path, Headers(), items, progress);
  14879. }
  14880. inline Result ClientImpl::Put(const std::string &path, const Headers &headers,
  14881. const UploadFormDataItems &items,
  14882. UploadProgress progress) {
  14883. const auto &boundary = detail::make_multipart_data_boundary();
  14884. const auto &content_type =
  14885. detail::serialize_multipart_formdata_get_content_type(boundary);
  14886. auto content_length = detail::get_multipart_content_length(items, boundary);
  14887. return Put(path, headers, content_length,
  14888. detail::make_multipart_content_provider(items, boundary),
  14889. content_type, progress);
  14890. }
  14891. inline Result ClientImpl::Put(const std::string &path, const Headers &headers,
  14892. const UploadFormDataItems &items,
  14893. const std::string &boundary,
  14894. UploadProgress progress) {
  14895. if (!detail::is_multipart_boundary_chars_valid(boundary)) {
  14896. return Result{nullptr, Error::UnsupportedMultipartBoundaryChars};
  14897. }
  14898. const auto &content_type =
  14899. detail::serialize_multipart_formdata_get_content_type(boundary);
  14900. auto content_length = detail::get_multipart_content_length(items, boundary);
  14901. return Put(path, headers, content_length,
  14902. detail::make_multipart_content_provider(items, boundary),
  14903. content_type, progress);
  14904. }
  14905. inline Result ClientImpl::Put(const std::string &path, const Headers &headers,
  14906. const char *body, size_t content_length,
  14907. const std::string &content_type,
  14908. UploadProgress progress) {
  14909. return send_with_content_provider_and_receiver(
  14910. "PUT", path, headers, body, content_length, nullptr, nullptr,
  14911. content_type, nullptr, progress);
  14912. }
  14913. inline Result ClientImpl::Put(const std::string &path, const Headers &headers,
  14914. const std::string &body,
  14915. const std::string &content_type,
  14916. UploadProgress progress) {
  14917. return send_with_content_provider_and_receiver(
  14918. "PUT", path, headers, body.data(), body.size(), nullptr, nullptr,
  14919. content_type, nullptr, progress);
  14920. }
  14921. inline Result ClientImpl::Put(const std::string &path, const Headers &headers,
  14922. size_t content_length,
  14923. ContentProvider content_provider,
  14924. const std::string &content_type,
  14925. UploadProgress progress) {
  14926. return send_with_content_provider_and_receiver(
  14927. "PUT", path, headers, nullptr, content_length,
  14928. std::move(content_provider), nullptr, content_type, nullptr, progress);
  14929. }
  14930. inline Result ClientImpl::Put(const std::string &path, const Headers &headers,
  14931. size_t content_length,
  14932. ContentProvider content_provider,
  14933. const std::string &content_type,
  14934. ContentReceiver content_receiver,
  14935. UploadProgress progress) {
  14936. return send_with_content_provider_and_receiver(
  14937. "PUT", path, headers, nullptr, content_length,
  14938. std::move(content_provider), nullptr, content_type,
  14939. std::move(content_receiver), progress);
  14940. }
  14941. inline Result ClientImpl::Put(const std::string &path, const Headers &headers,
  14942. ContentProviderWithoutLength content_provider,
  14943. const std::string &content_type,
  14944. UploadProgress progress) {
  14945. return send_with_content_provider_and_receiver(
  14946. "PUT", path, headers, nullptr, 0, nullptr, std::move(content_provider),
  14947. content_type, nullptr, progress);
  14948. }
  14949. inline Result ClientImpl::Put(const std::string &path, const Headers &headers,
  14950. ContentProviderWithoutLength content_provider,
  14951. const std::string &content_type,
  14952. ContentReceiver content_receiver,
  14953. UploadProgress progress) {
  14954. return send_with_content_provider_and_receiver(
  14955. "PUT", path, headers, nullptr, 0, nullptr, std::move(content_provider),
  14956. content_type, std::move(content_receiver), progress);
  14957. }
  14958. inline Result ClientImpl::Put(const std::string &path, const Headers &headers,
  14959. const UploadFormDataItems &items,
  14960. const FormDataProviderItems &provider_items,
  14961. UploadProgress progress) {
  14962. const auto &boundary = detail::make_multipart_data_boundary();
  14963. const auto &content_type =
  14964. detail::serialize_multipart_formdata_get_content_type(boundary);
  14965. return send_with_content_provider_and_receiver(
  14966. "PUT", path, headers, nullptr, 0, nullptr,
  14967. get_multipart_content_provider(boundary, items, provider_items),
  14968. content_type, nullptr, progress);
  14969. }
  14970. inline Result ClientImpl::Put(const std::string &path, const Headers &headers,
  14971. const std::string &body,
  14972. const std::string &content_type,
  14973. ContentReceiver content_receiver,
  14974. DownloadProgress progress) {
  14975. Request req;
  14976. req.method = "PUT";
  14977. req.path = path;
  14978. req.headers = headers;
  14979. req.body = body;
  14980. req.content_receiver =
  14981. [content_receiver](const char *data, size_t data_length,
  14982. size_t /*offset*/, size_t /*total_length*/) {
  14983. return content_receiver(data, data_length);
  14984. };
  14985. req.download_progress = std::move(progress);
  14986. if (max_timeout_msec_ > 0) {
  14987. req.start_time_ = std::chrono::steady_clock::now();
  14988. }
  14989. if (!content_type.empty()) { req.set_header("Content-Type", content_type); }
  14990. return send_(std::move(req));
  14991. }
  14992. inline Result ClientImpl::Patch(const std::string &path) {
  14993. return Patch(path, std::string(), std::string());
  14994. }
  14995. inline Result ClientImpl::Patch(const std::string &path, const Headers &headers,
  14996. UploadProgress progress) {
  14997. return Patch(path, headers, nullptr, 0, std::string(), progress);
  14998. }
  14999. inline Result ClientImpl::Patch(const std::string &path, const char *body,
  15000. size_t content_length,
  15001. const std::string &content_type,
  15002. UploadProgress progress) {
  15003. return Patch(path, Headers(), body, content_length, content_type, progress);
  15004. }
  15005. inline Result ClientImpl::Patch(const std::string &path,
  15006. const std::string &body,
  15007. const std::string &content_type,
  15008. UploadProgress progress) {
  15009. return Patch(path, Headers(), body, content_type, progress);
  15010. }
  15011. inline Result ClientImpl::Patch(const std::string &path, const Params &params) {
  15012. return Patch(path, Headers(), params);
  15013. }
  15014. inline Result ClientImpl::Patch(const std::string &path, size_t content_length,
  15015. ContentProvider content_provider,
  15016. const std::string &content_type,
  15017. UploadProgress progress) {
  15018. return Patch(path, Headers(), content_length, std::move(content_provider),
  15019. content_type, progress);
  15020. }
  15021. inline Result ClientImpl::Patch(const std::string &path, size_t content_length,
  15022. ContentProvider content_provider,
  15023. const std::string &content_type,
  15024. ContentReceiver content_receiver,
  15025. UploadProgress progress) {
  15026. return Patch(path, Headers(), content_length, std::move(content_provider),
  15027. content_type, std::move(content_receiver), progress);
  15028. }
  15029. inline Result ClientImpl::Patch(const std::string &path,
  15030. ContentProviderWithoutLength content_provider,
  15031. const std::string &content_type,
  15032. UploadProgress progress) {
  15033. return Patch(path, Headers(), std::move(content_provider), content_type,
  15034. progress);
  15035. }
  15036. inline Result ClientImpl::Patch(const std::string &path,
  15037. ContentProviderWithoutLength content_provider,
  15038. const std::string &content_type,
  15039. ContentReceiver content_receiver,
  15040. UploadProgress progress) {
  15041. return Patch(path, Headers(), std::move(content_provider), content_type,
  15042. std::move(content_receiver), progress);
  15043. }
  15044. inline Result ClientImpl::Patch(const std::string &path, const Headers &headers,
  15045. const Params &params) {
  15046. auto query = detail::params_to_query_str(params);
  15047. return Patch(path, headers, query, "application/x-www-form-urlencoded");
  15048. }
  15049. inline Result ClientImpl::Patch(const std::string &path,
  15050. const UploadFormDataItems &items,
  15051. UploadProgress progress) {
  15052. return Patch(path, Headers(), items, progress);
  15053. }
  15054. inline Result ClientImpl::Patch(const std::string &path, const Headers &headers,
  15055. const UploadFormDataItems &items,
  15056. UploadProgress progress) {
  15057. const auto &boundary = detail::make_multipart_data_boundary();
  15058. const auto &content_type =
  15059. detail::serialize_multipart_formdata_get_content_type(boundary);
  15060. auto content_length = detail::get_multipart_content_length(items, boundary);
  15061. return Patch(path, headers, content_length,
  15062. detail::make_multipart_content_provider(items, boundary),
  15063. content_type, progress);
  15064. }
  15065. inline Result ClientImpl::Patch(const std::string &path, const Headers &headers,
  15066. const UploadFormDataItems &items,
  15067. const std::string &boundary,
  15068. UploadProgress progress) {
  15069. if (!detail::is_multipart_boundary_chars_valid(boundary)) {
  15070. return Result{nullptr, Error::UnsupportedMultipartBoundaryChars};
  15071. }
  15072. const auto &content_type =
  15073. detail::serialize_multipart_formdata_get_content_type(boundary);
  15074. auto content_length = detail::get_multipart_content_length(items, boundary);
  15075. return Patch(path, headers, content_length,
  15076. detail::make_multipart_content_provider(items, boundary),
  15077. content_type, progress);
  15078. }
  15079. inline Result ClientImpl::Patch(const std::string &path, const Headers &headers,
  15080. const char *body, size_t content_length,
  15081. const std::string &content_type,
  15082. UploadProgress progress) {
  15083. return send_with_content_provider_and_receiver(
  15084. "PATCH", path, headers, body, content_length, nullptr, nullptr,
  15085. content_type, nullptr, progress);
  15086. }
  15087. inline Result ClientImpl::Patch(const std::string &path, const Headers &headers,
  15088. const std::string &body,
  15089. const std::string &content_type,
  15090. UploadProgress progress) {
  15091. return send_with_content_provider_and_receiver(
  15092. "PATCH", path, headers, body.data(), body.size(), nullptr, nullptr,
  15093. content_type, nullptr, progress);
  15094. }
  15095. inline Result ClientImpl::Patch(const std::string &path, const Headers &headers,
  15096. size_t content_length,
  15097. ContentProvider content_provider,
  15098. const std::string &content_type,
  15099. UploadProgress progress) {
  15100. return send_with_content_provider_and_receiver(
  15101. "PATCH", path, headers, nullptr, content_length,
  15102. std::move(content_provider), nullptr, content_type, nullptr, progress);
  15103. }
  15104. inline Result ClientImpl::Patch(const std::string &path, const Headers &headers,
  15105. size_t content_length,
  15106. ContentProvider content_provider,
  15107. const std::string &content_type,
  15108. ContentReceiver content_receiver,
  15109. UploadProgress progress) {
  15110. return send_with_content_provider_and_receiver(
  15111. "PATCH", path, headers, nullptr, content_length,
  15112. std::move(content_provider), nullptr, content_type,
  15113. std::move(content_receiver), progress);
  15114. }
  15115. inline Result ClientImpl::Patch(const std::string &path, const Headers &headers,
  15116. ContentProviderWithoutLength content_provider,
  15117. const std::string &content_type,
  15118. UploadProgress progress) {
  15119. return send_with_content_provider_and_receiver(
  15120. "PATCH", path, headers, nullptr, 0, nullptr, std::move(content_provider),
  15121. content_type, nullptr, progress);
  15122. }
  15123. inline Result ClientImpl::Patch(const std::string &path, const Headers &headers,
  15124. ContentProviderWithoutLength content_provider,
  15125. const std::string &content_type,
  15126. ContentReceiver content_receiver,
  15127. UploadProgress progress) {
  15128. return send_with_content_provider_and_receiver(
  15129. "PATCH", path, headers, nullptr, 0, nullptr, std::move(content_provider),
  15130. content_type, std::move(content_receiver), progress);
  15131. }
  15132. inline Result ClientImpl::Patch(const std::string &path, const Headers &headers,
  15133. const UploadFormDataItems &items,
  15134. const FormDataProviderItems &provider_items,
  15135. UploadProgress progress) {
  15136. const auto &boundary = detail::make_multipart_data_boundary();
  15137. const auto &content_type =
  15138. detail::serialize_multipart_formdata_get_content_type(boundary);
  15139. return send_with_content_provider_and_receiver(
  15140. "PATCH", path, headers, nullptr, 0, nullptr,
  15141. get_multipart_content_provider(boundary, items, provider_items),
  15142. content_type, nullptr, progress);
  15143. }
  15144. inline Result ClientImpl::Patch(const std::string &path, const Headers &headers,
  15145. const std::string &body,
  15146. const std::string &content_type,
  15147. ContentReceiver content_receiver,
  15148. DownloadProgress progress) {
  15149. Request req;
  15150. req.method = "PATCH";
  15151. req.path = path;
  15152. req.headers = headers;
  15153. req.body = body;
  15154. req.content_receiver =
  15155. [content_receiver](const char *data, size_t data_length,
  15156. size_t /*offset*/, size_t /*total_length*/) {
  15157. return content_receiver(data, data_length);
  15158. };
  15159. req.download_progress = std::move(progress);
  15160. if (max_timeout_msec_ > 0) {
  15161. req.start_time_ = std::chrono::steady_clock::now();
  15162. }
  15163. if (!content_type.empty()) { req.set_header("Content-Type", content_type); }
  15164. return send_(std::move(req));
  15165. }
  15166. inline Result ClientImpl::Delete(const std::string &path,
  15167. DownloadProgress progress) {
  15168. return Delete(path, Headers(), std::string(), std::string(), progress);
  15169. }
  15170. inline Result ClientImpl::Delete(const std::string &path,
  15171. const Headers &headers,
  15172. DownloadProgress progress) {
  15173. return Delete(path, headers, std::string(), std::string(), progress);
  15174. }
  15175. inline Result ClientImpl::Delete(const std::string &path, const char *body,
  15176. size_t content_length,
  15177. const std::string &content_type,
  15178. DownloadProgress progress) {
  15179. return Delete(path, Headers(), body, content_length, content_type, progress);
  15180. }
  15181. inline Result ClientImpl::Delete(const std::string &path,
  15182. const std::string &body,
  15183. const std::string &content_type,
  15184. DownloadProgress progress) {
  15185. return Delete(path, Headers(), body.data(), body.size(), content_type,
  15186. progress);
  15187. }
  15188. inline Result ClientImpl::Delete(const std::string &path,
  15189. const Headers &headers,
  15190. const std::string &body,
  15191. const std::string &content_type,
  15192. DownloadProgress progress) {
  15193. return Delete(path, headers, body.data(), body.size(), content_type,
  15194. progress);
  15195. }
  15196. inline Result ClientImpl::Delete(const std::string &path, const Params &params,
  15197. DownloadProgress progress) {
  15198. return Delete(path, Headers(), params, progress);
  15199. }
  15200. inline Result ClientImpl::Delete(const std::string &path,
  15201. const Headers &headers, const Params &params,
  15202. DownloadProgress progress) {
  15203. auto query = detail::params_to_query_str(params);
  15204. return Delete(path, headers, query, "application/x-www-form-urlencoded",
  15205. progress);
  15206. }
  15207. inline Result ClientImpl::Delete(const std::string &path,
  15208. const Headers &headers, const char *body,
  15209. size_t content_length,
  15210. const std::string &content_type,
  15211. DownloadProgress progress) {
  15212. Request req;
  15213. req.method = "DELETE";
  15214. req.headers = headers;
  15215. req.path = path;
  15216. req.download_progress = std::move(progress);
  15217. if (max_timeout_msec_ > 0) {
  15218. req.start_time_ = std::chrono::steady_clock::now();
  15219. }
  15220. if (!content_type.empty()) { req.set_header("Content-Type", content_type); }
  15221. req.body.assign(body, content_length);
  15222. return send_(std::move(req));
  15223. }
  15224. inline Result ClientImpl::Options(const std::string &path) {
  15225. return Options(path, Headers());
  15226. }
  15227. inline Result ClientImpl::Options(const std::string &path,
  15228. const Headers &headers) {
  15229. Request req;
  15230. req.method = "OPTIONS";
  15231. req.headers = headers;
  15232. req.path = path;
  15233. if (max_timeout_msec_ > 0) {
  15234. req.start_time_ = std::chrono::steady_clock::now();
  15235. }
  15236. return send_(std::move(req));
  15237. }
  15238. inline void ClientImpl::stop() {
  15239. std::lock_guard<std::mutex> guard(socket_mutex_);
  15240. // If there is anything ongoing right now, the ONLY thread-safe thing we can
  15241. // do is to shutdown_socket, so that threads using this socket suddenly
  15242. // discover they can't read/write any more and error out. Everything else
  15243. // (closing the socket, shutting ssl down) is unsafe because these actions
  15244. // are not thread-safe.
  15245. if (socket_requests_in_flight_ > 0) {
  15246. shutdown_socket(socket_);
  15247. // Aside from that, we set a flag for the socket to be closed when we're
  15248. // done.
  15249. socket_should_be_closed_when_request_is_done_ = true;
  15250. return;
  15251. }
  15252. disconnect(/*gracefully=*/true);
  15253. }
  15254. inline std::string ClientImpl::host() const { return host_; }
  15255. inline int ClientImpl::port() const { return port_; }
  15256. inline size_t ClientImpl::is_socket_open() const {
  15257. std::lock_guard<std::mutex> guard(socket_mutex_);
  15258. return socket_.is_open();
  15259. }
  15260. inline socket_t ClientImpl::socket() const { return socket_.sock; }
  15261. inline void ClientImpl::set_connection_timeout(time_t sec, time_t usec) {
  15262. connection_timeout_sec_ = sec;
  15263. connection_timeout_usec_ = usec;
  15264. }
  15265. inline void ClientImpl::set_read_timeout(time_t sec, time_t usec) {
  15266. read_timeout_sec_ = sec;
  15267. read_timeout_usec_ = usec;
  15268. }
  15269. inline void ClientImpl::set_write_timeout(time_t sec, time_t usec) {
  15270. write_timeout_sec_ = sec;
  15271. write_timeout_usec_ = usec;
  15272. }
  15273. inline void ClientImpl::set_max_timeout(time_t msec) {
  15274. max_timeout_msec_ = msec;
  15275. }
  15276. inline void ClientImpl::set_basic_auth(const std::string &username,
  15277. const std::string &password) {
  15278. basic_auth_username_ = username;
  15279. basic_auth_password_ = password;
  15280. }
  15281. inline void ClientImpl::set_bearer_token_auth(const std::string &token) {
  15282. bearer_token_auth_token_ = token;
  15283. }
  15284. inline void ClientImpl::set_keep_alive(bool on) { keep_alive_ = on; }
  15285. inline void ClientImpl::set_follow_location(bool on) { follow_location_ = on; }
  15286. inline void ClientImpl::set_path_encode(bool on) { path_encode_ = on; }
  15287. inline void
  15288. ClientImpl::set_hostname_addr_map(std::map<std::string, std::string> addr_map) {
  15289. addr_map_ = std::move(addr_map);
  15290. }
  15291. inline void ClientImpl::set_default_headers(Headers headers) {
  15292. default_headers_ = std::move(headers);
  15293. }
  15294. inline void ClientImpl::set_header_writer(
  15295. std::function<ssize_t(Stream &, Headers &)> const &writer) {
  15296. header_writer_ = writer;
  15297. }
  15298. inline void ClientImpl::set_address_family(int family) {
  15299. address_family_ = family;
  15300. }
  15301. inline void ClientImpl::set_tcp_nodelay(bool on) { tcp_nodelay_ = on; }
  15302. inline void ClientImpl::set_ipv6_v6only(bool on) { ipv6_v6only_ = on; }
  15303. inline void ClientImpl::set_socket_options(SocketOptions socket_options) {
  15304. socket_options_ = std::move(socket_options);
  15305. }
  15306. inline void ClientImpl::set_compress(bool on) { compress_ = on; }
  15307. inline void ClientImpl::set_decompress(bool on) { decompress_ = on; }
  15308. inline void ClientImpl::set_payload_max_length(size_t length) {
  15309. payload_max_length_ = length;
  15310. has_payload_max_length_ = true;
  15311. }
  15312. inline void ClientImpl::set_interface(const std::string &intf) {
  15313. interface_ = intf;
  15314. }
  15315. inline void ClientImpl::set_proxy(const std::string &host, int port) {
  15316. proxy_host_ = host;
  15317. proxy_port_ = port;
  15318. std::lock_guard<std::mutex> guard(socket_mutex_);
  15319. disconnect(/*gracefully=*/true);
  15320. }
  15321. inline void ClientImpl::set_proxy_basic_auth(const std::string &username,
  15322. const std::string &password) {
  15323. proxy_basic_auth_username_ = username;
  15324. proxy_basic_auth_password_ = password;
  15325. }
  15326. inline void ClientImpl::set_proxy_bearer_token_auth(const std::string &token) {
  15327. proxy_bearer_token_auth_token_ = token;
  15328. }
  15329. inline void ClientImpl::set_no_proxy(const std::vector<std::string> &patterns) {
  15330. no_proxy_entries_ = detail::parse_no_proxy_entries(patterns);
  15331. std::lock_guard<std::mutex> guard(socket_mutex_);
  15332. disconnect(/*gracefully=*/true);
  15333. }
  15334. #ifdef CPPHTTPLIB_SSL_ENABLED
  15335. inline void ClientImpl::set_digest_auth(const std::string &username,
  15336. const std::string &password) {
  15337. digest_auth_username_ = username;
  15338. digest_auth_password_ = password;
  15339. }
  15340. inline void ClientImpl::set_ca_cert_path(const std::string &ca_cert_file_path,
  15341. const std::string &ca_cert_dir_path) {
  15342. ca_cert_file_path_ = ca_cert_file_path;
  15343. ca_cert_dir_path_ = ca_cert_dir_path;
  15344. }
  15345. inline void ClientImpl::set_proxy_digest_auth(const std::string &username,
  15346. const std::string &password) {
  15347. proxy_digest_auth_username_ = username;
  15348. proxy_digest_auth_password_ = password;
  15349. }
  15350. inline void ClientImpl::enable_server_certificate_verification(bool enabled) {
  15351. server_certificate_verification_ = enabled;
  15352. }
  15353. inline void ClientImpl::enable_server_hostname_verification(bool enabled) {
  15354. server_hostname_verification_ = enabled;
  15355. }
  15356. inline void ClientImpl::enable_system_ca(bool enabled) {
  15357. system_ca_mode_ = enabled ? SystemCAMode::Enabled : SystemCAMode::Disabled;
  15358. }
  15359. #endif
  15360. inline void ClientImpl::set_logger(Logger logger) {
  15361. logger_ = std::move(logger);
  15362. }
  15363. inline void ClientImpl::set_error_logger(ErrorLogger error_logger) {
  15364. error_logger_ = std::move(error_logger);
  15365. }
  15366. /*
  15367. * SSL/TLS Common Implementation
  15368. */
  15369. inline ClientConnection::~ClientConnection() {
  15370. #ifdef CPPHTTPLIB_SSL_ENABLED
  15371. if (session) {
  15372. tls::shutdown(session, true);
  15373. tls::free_session(session);
  15374. session = nullptr;
  15375. }
  15376. #endif
  15377. if (sock != INVALID_SOCKET) {
  15378. detail::close_socket(sock);
  15379. sock = INVALID_SOCKET;
  15380. }
  15381. }
  15382. // Universal client implementation
  15383. inline Client::Client(const std::string &scheme_host_port)
  15384. : Client(scheme_host_port, std::string(), std::string()) {}
  15385. inline Client::Client(const std::string &scheme_host_port,
  15386. const std::string &client_cert_path,
  15387. const std::string &client_key_path) {
  15388. detail::UrlComponents uc;
  15389. if (detail::parse_url(scheme_host_port, uc) && !uc.host.empty()) {
  15390. auto &scheme = uc.scheme;
  15391. #ifdef CPPHTTPLIB_SSL_ENABLED
  15392. if (!scheme.empty() && (scheme != "http" && scheme != "https")) {
  15393. #else
  15394. if (!scheme.empty() && scheme != "http") {
  15395. #endif
  15396. #ifndef CPPHTTPLIB_NO_EXCEPTIONS
  15397. std::string msg = "'" + scheme + "' scheme is not supported.";
  15398. throw std::invalid_argument(msg);
  15399. #endif
  15400. cli_ = detail::make_unique<detail::InvalidClientImpl>();
  15401. return;
  15402. }
  15403. auto is_ssl = scheme == "https";
  15404. auto host = std::move(uc.host);
  15405. auto port = is_ssl ? 443 : 80;
  15406. if (!uc.port.empty() && !detail::parse_port(uc.port, port)) {
  15407. cli_ = detail::make_unique<detail::InvalidClientImpl>();
  15408. return;
  15409. }
  15410. if (is_ssl) {
  15411. #ifdef CPPHTTPLIB_SSL_ENABLED
  15412. cli_ = detail::make_unique<SSLClient>(host, port, client_cert_path,
  15413. client_key_path);
  15414. is_ssl_ = is_ssl;
  15415. #endif
  15416. } else {
  15417. cli_ = detail::make_unique<ClientImpl>(host, port, client_cert_path,
  15418. client_key_path);
  15419. }
  15420. } else if (scheme_host_port.compare(0, 2, "//") == 0 ||
  15421. scheme_host_port.find("://") < scheme_host_port.find('/')) {
  15422. // A URL, but not one this client can use, such as one with userinfo. A
  15423. // Unix socket path may have "//" further on.
  15424. cli_ = detail::make_unique<detail::InvalidClientImpl>();
  15425. } else {
  15426. // NOTE: Update TEST(UniversalClientImplTest, Ipv6LiteralAddress)
  15427. // if port param below changes.
  15428. cli_ = detail::make_unique<ClientImpl>(scheme_host_port, 80,
  15429. client_cert_path, client_key_path);
  15430. }
  15431. }
  15432. inline Client::Client(const std::string &host, int port)
  15433. : Client(host, port, std::string(), std::string()) {}
  15434. inline Client::Client(const std::string &host, int port,
  15435. const std::string &client_cert_path,
  15436. const std::string &client_key_path)
  15437. : cli_(detail::make_unique<ClientImpl>(host, port, client_cert_path,
  15438. client_key_path)) {}
  15439. inline Client::~Client() = default;
  15440. inline bool Client::is_valid() const {
  15441. return cli_ != nullptr && cli_->is_valid();
  15442. }
  15443. inline Result Client::Get(const std::string &path, DownloadProgress progress) {
  15444. return cli_->Get(path, std::move(progress));
  15445. }
  15446. inline Result Client::Get(const std::string &path, const Headers &headers,
  15447. DownloadProgress progress) {
  15448. return cli_->Get(path, headers, std::move(progress));
  15449. }
  15450. inline Result Client::Get(const std::string &path,
  15451. ContentReceiver content_receiver,
  15452. DownloadProgress progress) {
  15453. return cli_->Get(path, std::move(content_receiver), std::move(progress));
  15454. }
  15455. inline Result Client::Get(const std::string &path, const Headers &headers,
  15456. ContentReceiver content_receiver,
  15457. DownloadProgress progress) {
  15458. return cli_->Get(path, headers, std::move(content_receiver),
  15459. std::move(progress));
  15460. }
  15461. inline Result Client::Get(const std::string &path,
  15462. ResponseHandler response_handler,
  15463. ContentReceiver content_receiver,
  15464. DownloadProgress progress) {
  15465. return cli_->Get(path, std::move(response_handler),
  15466. std::move(content_receiver), std::move(progress));
  15467. }
  15468. inline Result Client::Get(const std::string &path, const Headers &headers,
  15469. ResponseHandler response_handler,
  15470. ContentReceiver content_receiver,
  15471. DownloadProgress progress) {
  15472. return cli_->Get(path, headers, std::move(response_handler),
  15473. std::move(content_receiver), std::move(progress));
  15474. }
  15475. inline Result Client::Get(const std::string &path, const Params &params,
  15476. DownloadProgress progress) {
  15477. return cli_->Get(path, params, std::move(progress));
  15478. }
  15479. inline Result Client::Get(const std::string &path, const Params &params,
  15480. const Headers &headers, DownloadProgress progress) {
  15481. return cli_->Get(path, params, headers, std::move(progress));
  15482. }
  15483. inline Result Client::Get(const std::string &path, const Params &params,
  15484. const Headers &headers,
  15485. ContentReceiver content_receiver,
  15486. DownloadProgress progress) {
  15487. return cli_->Get(path, params, headers, std::move(content_receiver),
  15488. std::move(progress));
  15489. }
  15490. inline Result Client::Get(const std::string &path, const Params &params,
  15491. const Headers &headers,
  15492. ResponseHandler response_handler,
  15493. ContentReceiver content_receiver,
  15494. DownloadProgress progress) {
  15495. return cli_->Get(path, params, headers, std::move(response_handler),
  15496. std::move(content_receiver), std::move(progress));
  15497. }
  15498. inline Result Client::Head(const std::string &path) { return cli_->Head(path); }
  15499. inline Result Client::Head(const std::string &path, const Headers &headers) {
  15500. return cli_->Head(path, headers);
  15501. }
  15502. inline Result Client::Post(const std::string &path) { return cli_->Post(path); }
  15503. inline Result Client::Post(const std::string &path, const Headers &headers) {
  15504. return cli_->Post(path, headers);
  15505. }
  15506. inline Result Client::Post(const std::string &path, const char *body,
  15507. size_t content_length,
  15508. const std::string &content_type,
  15509. UploadProgress progress) {
  15510. return cli_->Post(path, body, content_length, content_type, progress);
  15511. }
  15512. inline Result Client::Post(const std::string &path, const Headers &headers,
  15513. const char *body, size_t content_length,
  15514. const std::string &content_type,
  15515. UploadProgress progress) {
  15516. return cli_->Post(path, headers, body, content_length, content_type,
  15517. progress);
  15518. }
  15519. inline Result Client::Post(const std::string &path, const std::string &body,
  15520. const std::string &content_type,
  15521. UploadProgress progress) {
  15522. return cli_->Post(path, body, content_type, progress);
  15523. }
  15524. inline Result Client::Post(const std::string &path, const Headers &headers,
  15525. const std::string &body,
  15526. const std::string &content_type,
  15527. UploadProgress progress) {
  15528. return cli_->Post(path, headers, body, content_type, progress);
  15529. }
  15530. inline Result Client::Post(const std::string &path, size_t content_length,
  15531. ContentProvider content_provider,
  15532. const std::string &content_type,
  15533. UploadProgress progress) {
  15534. return cli_->Post(path, content_length, std::move(content_provider),
  15535. content_type, progress);
  15536. }
  15537. inline Result Client::Post(const std::string &path, size_t content_length,
  15538. ContentProvider content_provider,
  15539. const std::string &content_type,
  15540. ContentReceiver content_receiver,
  15541. UploadProgress progress) {
  15542. return cli_->Post(path, content_length, std::move(content_provider),
  15543. content_type, std::move(content_receiver), progress);
  15544. }
  15545. inline Result Client::Post(const std::string &path,
  15546. ContentProviderWithoutLength content_provider,
  15547. const std::string &content_type,
  15548. UploadProgress progress) {
  15549. return cli_->Post(path, std::move(content_provider), content_type, progress);
  15550. }
  15551. inline Result Client::Post(const std::string &path,
  15552. ContentProviderWithoutLength content_provider,
  15553. const std::string &content_type,
  15554. ContentReceiver content_receiver,
  15555. UploadProgress progress) {
  15556. return cli_->Post(path, std::move(content_provider), content_type,
  15557. std::move(content_receiver), progress);
  15558. }
  15559. inline Result Client::Post(const std::string &path, const Headers &headers,
  15560. size_t content_length,
  15561. ContentProvider content_provider,
  15562. const std::string &content_type,
  15563. UploadProgress progress) {
  15564. return cli_->Post(path, headers, content_length, std::move(content_provider),
  15565. content_type, progress);
  15566. }
  15567. inline Result Client::Post(const std::string &path, const Headers &headers,
  15568. size_t content_length,
  15569. ContentProvider content_provider,
  15570. const std::string &content_type,
  15571. ContentReceiver content_receiver,
  15572. DownloadProgress progress) {
  15573. return cli_->Post(path, headers, content_length, std::move(content_provider),
  15574. content_type, std::move(content_receiver), progress);
  15575. }
  15576. inline Result Client::Post(const std::string &path, const Headers &headers,
  15577. ContentProviderWithoutLength content_provider,
  15578. const std::string &content_type,
  15579. UploadProgress progress) {
  15580. return cli_->Post(path, headers, std::move(content_provider), content_type,
  15581. progress);
  15582. }
  15583. inline Result Client::Post(const std::string &path, const Headers &headers,
  15584. ContentProviderWithoutLength content_provider,
  15585. const std::string &content_type,
  15586. ContentReceiver content_receiver,
  15587. DownloadProgress progress) {
  15588. return cli_->Post(path, headers, std::move(content_provider), content_type,
  15589. std::move(content_receiver), progress);
  15590. }
  15591. inline Result Client::Post(const std::string &path, const Params &params) {
  15592. return cli_->Post(path, params);
  15593. }
  15594. inline Result Client::Post(const std::string &path, const Headers &headers,
  15595. const Params &params) {
  15596. return cli_->Post(path, headers, params);
  15597. }
  15598. inline Result Client::Post(const std::string &path,
  15599. const UploadFormDataItems &items,
  15600. UploadProgress progress) {
  15601. return cli_->Post(path, items, progress);
  15602. }
  15603. inline Result Client::Post(const std::string &path, const Headers &headers,
  15604. const UploadFormDataItems &items,
  15605. UploadProgress progress) {
  15606. return cli_->Post(path, headers, items, progress);
  15607. }
  15608. inline Result Client::Post(const std::string &path, const Headers &headers,
  15609. const UploadFormDataItems &items,
  15610. const std::string &boundary,
  15611. UploadProgress progress) {
  15612. return cli_->Post(path, headers, items, boundary, progress);
  15613. }
  15614. inline Result Client::Post(const std::string &path, const Headers &headers,
  15615. const UploadFormDataItems &items,
  15616. const FormDataProviderItems &provider_items,
  15617. UploadProgress progress) {
  15618. return cli_->Post(path, headers, items, provider_items, progress);
  15619. }
  15620. inline Result Client::Post(const std::string &path, const Headers &headers,
  15621. const std::string &body,
  15622. const std::string &content_type,
  15623. ContentReceiver content_receiver,
  15624. DownloadProgress progress) {
  15625. return cli_->Post(path, headers, body, content_type,
  15626. std::move(content_receiver), progress);
  15627. }
  15628. inline Result Client::Put(const std::string &path) { return cli_->Put(path); }
  15629. inline Result Client::Put(const std::string &path, const Headers &headers) {
  15630. return cli_->Put(path, headers);
  15631. }
  15632. inline Result Client::Put(const std::string &path, const char *body,
  15633. size_t content_length,
  15634. const std::string &content_type,
  15635. UploadProgress progress) {
  15636. return cli_->Put(path, body, content_length, content_type, progress);
  15637. }
  15638. inline Result Client::Put(const std::string &path, const Headers &headers,
  15639. const char *body, size_t content_length,
  15640. const std::string &content_type,
  15641. UploadProgress progress) {
  15642. return cli_->Put(path, headers, body, content_length, content_type, progress);
  15643. }
  15644. inline Result Client::Put(const std::string &path, const std::string &body,
  15645. const std::string &content_type,
  15646. UploadProgress progress) {
  15647. return cli_->Put(path, body, content_type, progress);
  15648. }
  15649. inline Result Client::Put(const std::string &path, const Headers &headers,
  15650. const std::string &body,
  15651. const std::string &content_type,
  15652. UploadProgress progress) {
  15653. return cli_->Put(path, headers, body, content_type, progress);
  15654. }
  15655. inline Result Client::Put(const std::string &path, size_t content_length,
  15656. ContentProvider content_provider,
  15657. const std::string &content_type,
  15658. UploadProgress progress) {
  15659. return cli_->Put(path, content_length, std::move(content_provider),
  15660. content_type, progress);
  15661. }
  15662. inline Result Client::Put(const std::string &path, size_t content_length,
  15663. ContentProvider content_provider,
  15664. const std::string &content_type,
  15665. ContentReceiver content_receiver,
  15666. UploadProgress progress) {
  15667. return cli_->Put(path, content_length, std::move(content_provider),
  15668. content_type, std::move(content_receiver), progress);
  15669. }
  15670. inline Result Client::Put(const std::string &path,
  15671. ContentProviderWithoutLength content_provider,
  15672. const std::string &content_type,
  15673. UploadProgress progress) {
  15674. return cli_->Put(path, std::move(content_provider), content_type, progress);
  15675. }
  15676. inline Result Client::Put(const std::string &path,
  15677. ContentProviderWithoutLength content_provider,
  15678. const std::string &content_type,
  15679. ContentReceiver content_receiver,
  15680. UploadProgress progress) {
  15681. return cli_->Put(path, std::move(content_provider), content_type,
  15682. std::move(content_receiver), progress);
  15683. }
  15684. inline Result Client::Put(const std::string &path, const Headers &headers,
  15685. size_t content_length,
  15686. ContentProvider content_provider,
  15687. const std::string &content_type,
  15688. UploadProgress progress) {
  15689. return cli_->Put(path, headers, content_length, std::move(content_provider),
  15690. content_type, progress);
  15691. }
  15692. inline Result Client::Put(const std::string &path, const Headers &headers,
  15693. size_t content_length,
  15694. ContentProvider content_provider,
  15695. const std::string &content_type,
  15696. ContentReceiver content_receiver,
  15697. UploadProgress progress) {
  15698. return cli_->Put(path, headers, content_length, std::move(content_provider),
  15699. content_type, std::move(content_receiver), progress);
  15700. }
  15701. inline Result Client::Put(const std::string &path, const Headers &headers,
  15702. ContentProviderWithoutLength content_provider,
  15703. const std::string &content_type,
  15704. UploadProgress progress) {
  15705. return cli_->Put(path, headers, std::move(content_provider), content_type,
  15706. progress);
  15707. }
  15708. inline Result Client::Put(const std::string &path, const Headers &headers,
  15709. ContentProviderWithoutLength content_provider,
  15710. const std::string &content_type,
  15711. ContentReceiver content_receiver,
  15712. UploadProgress progress) {
  15713. return cli_->Put(path, headers, std::move(content_provider), content_type,
  15714. std::move(content_receiver), progress);
  15715. }
  15716. inline Result Client::Put(const std::string &path, const Params &params) {
  15717. return cli_->Put(path, params);
  15718. }
  15719. inline Result Client::Put(const std::string &path, const Headers &headers,
  15720. const Params &params) {
  15721. return cli_->Put(path, headers, params);
  15722. }
  15723. inline Result Client::Put(const std::string &path,
  15724. const UploadFormDataItems &items,
  15725. UploadProgress progress) {
  15726. return cli_->Put(path, items, progress);
  15727. }
  15728. inline Result Client::Put(const std::string &path, const Headers &headers,
  15729. const UploadFormDataItems &items,
  15730. UploadProgress progress) {
  15731. return cli_->Put(path, headers, items, progress);
  15732. }
  15733. inline Result Client::Put(const std::string &path, const Headers &headers,
  15734. const UploadFormDataItems &items,
  15735. const std::string &boundary,
  15736. UploadProgress progress) {
  15737. return cli_->Put(path, headers, items, boundary, progress);
  15738. }
  15739. inline Result Client::Put(const std::string &path, const Headers &headers,
  15740. const UploadFormDataItems &items,
  15741. const FormDataProviderItems &provider_items,
  15742. UploadProgress progress) {
  15743. return cli_->Put(path, headers, items, provider_items, progress);
  15744. }
  15745. inline Result Client::Put(const std::string &path, const Headers &headers,
  15746. const std::string &body,
  15747. const std::string &content_type,
  15748. ContentReceiver content_receiver,
  15749. DownloadProgress progress) {
  15750. return cli_->Put(path, headers, body, content_type, content_receiver,
  15751. progress);
  15752. }
  15753. inline Result Client::Patch(const std::string &path) {
  15754. return cli_->Patch(path);
  15755. }
  15756. inline Result Client::Patch(const std::string &path, const Headers &headers) {
  15757. return cli_->Patch(path, headers);
  15758. }
  15759. inline Result Client::Patch(const std::string &path, const char *body,
  15760. size_t content_length,
  15761. const std::string &content_type,
  15762. UploadProgress progress) {
  15763. return cli_->Patch(path, body, content_length, content_type, progress);
  15764. }
  15765. inline Result Client::Patch(const std::string &path, const Headers &headers,
  15766. const char *body, size_t content_length,
  15767. const std::string &content_type,
  15768. UploadProgress progress) {
  15769. return cli_->Patch(path, headers, body, content_length, content_type,
  15770. progress);
  15771. }
  15772. inline Result Client::Patch(const std::string &path, const std::string &body,
  15773. const std::string &content_type,
  15774. UploadProgress progress) {
  15775. return cli_->Patch(path, body, content_type, progress);
  15776. }
  15777. inline Result Client::Patch(const std::string &path, const Headers &headers,
  15778. const std::string &body,
  15779. const std::string &content_type,
  15780. UploadProgress progress) {
  15781. return cli_->Patch(path, headers, body, content_type, progress);
  15782. }
  15783. inline Result Client::Patch(const std::string &path, size_t content_length,
  15784. ContentProvider content_provider,
  15785. const std::string &content_type,
  15786. UploadProgress progress) {
  15787. return cli_->Patch(path, content_length, std::move(content_provider),
  15788. content_type, progress);
  15789. }
  15790. inline Result Client::Patch(const std::string &path, size_t content_length,
  15791. ContentProvider content_provider,
  15792. const std::string &content_type,
  15793. ContentReceiver content_receiver,
  15794. UploadProgress progress) {
  15795. return cli_->Patch(path, content_length, std::move(content_provider),
  15796. content_type, std::move(content_receiver), progress);
  15797. }
  15798. inline Result Client::Patch(const std::string &path,
  15799. ContentProviderWithoutLength content_provider,
  15800. const std::string &content_type,
  15801. UploadProgress progress) {
  15802. return cli_->Patch(path, std::move(content_provider), content_type, progress);
  15803. }
  15804. inline Result Client::Patch(const std::string &path,
  15805. ContentProviderWithoutLength content_provider,
  15806. const std::string &content_type,
  15807. ContentReceiver content_receiver,
  15808. UploadProgress progress) {
  15809. return cli_->Patch(path, std::move(content_provider), content_type,
  15810. std::move(content_receiver), progress);
  15811. }
  15812. inline Result Client::Patch(const std::string &path, const Headers &headers,
  15813. size_t content_length,
  15814. ContentProvider content_provider,
  15815. const std::string &content_type,
  15816. UploadProgress progress) {
  15817. return cli_->Patch(path, headers, content_length, std::move(content_provider),
  15818. content_type, progress);
  15819. }
  15820. inline Result Client::Patch(const std::string &path, const Headers &headers,
  15821. size_t content_length,
  15822. ContentProvider content_provider,
  15823. const std::string &content_type,
  15824. ContentReceiver content_receiver,
  15825. UploadProgress progress) {
  15826. return cli_->Patch(path, headers, content_length, std::move(content_provider),
  15827. content_type, std::move(content_receiver), progress);
  15828. }
  15829. inline Result Client::Patch(const std::string &path, const Headers &headers,
  15830. ContentProviderWithoutLength content_provider,
  15831. const std::string &content_type,
  15832. UploadProgress progress) {
  15833. return cli_->Patch(path, headers, std::move(content_provider), content_type,
  15834. progress);
  15835. }
  15836. inline Result Client::Patch(const std::string &path, const Headers &headers,
  15837. ContentProviderWithoutLength content_provider,
  15838. const std::string &content_type,
  15839. ContentReceiver content_receiver,
  15840. UploadProgress progress) {
  15841. return cli_->Patch(path, headers, std::move(content_provider), content_type,
  15842. std::move(content_receiver), progress);
  15843. }
  15844. inline Result Client::Patch(const std::string &path, const Params &params) {
  15845. return cli_->Patch(path, params);
  15846. }
  15847. inline Result Client::Patch(const std::string &path, const Headers &headers,
  15848. const Params &params) {
  15849. return cli_->Patch(path, headers, params);
  15850. }
  15851. inline Result Client::Patch(const std::string &path,
  15852. const UploadFormDataItems &items,
  15853. UploadProgress progress) {
  15854. return cli_->Patch(path, items, progress);
  15855. }
  15856. inline Result Client::Patch(const std::string &path, const Headers &headers,
  15857. const UploadFormDataItems &items,
  15858. UploadProgress progress) {
  15859. return cli_->Patch(path, headers, items, progress);
  15860. }
  15861. inline Result Client::Patch(const std::string &path, const Headers &headers,
  15862. const UploadFormDataItems &items,
  15863. const std::string &boundary,
  15864. UploadProgress progress) {
  15865. return cli_->Patch(path, headers, items, boundary, progress);
  15866. }
  15867. inline Result Client::Patch(const std::string &path, const Headers &headers,
  15868. const UploadFormDataItems &items,
  15869. const FormDataProviderItems &provider_items,
  15870. UploadProgress progress) {
  15871. return cli_->Patch(path, headers, items, provider_items, progress);
  15872. }
  15873. inline Result Client::Patch(const std::string &path, const Headers &headers,
  15874. const std::string &body,
  15875. const std::string &content_type,
  15876. ContentReceiver content_receiver,
  15877. DownloadProgress progress) {
  15878. return cli_->Patch(path, headers, body, content_type, content_receiver,
  15879. progress);
  15880. }
  15881. inline Result Client::Delete(const std::string &path,
  15882. DownloadProgress progress) {
  15883. return cli_->Delete(path, progress);
  15884. }
  15885. inline Result Client::Delete(const std::string &path, const Headers &headers,
  15886. DownloadProgress progress) {
  15887. return cli_->Delete(path, headers, progress);
  15888. }
  15889. inline Result Client::Delete(const std::string &path, const char *body,
  15890. size_t content_length,
  15891. const std::string &content_type,
  15892. DownloadProgress progress) {
  15893. return cli_->Delete(path, body, content_length, content_type, progress);
  15894. }
  15895. inline Result Client::Delete(const std::string &path, const Headers &headers,
  15896. const char *body, size_t content_length,
  15897. const std::string &content_type,
  15898. DownloadProgress progress) {
  15899. return cli_->Delete(path, headers, body, content_length, content_type,
  15900. progress);
  15901. }
  15902. inline Result Client::Delete(const std::string &path, const std::string &body,
  15903. const std::string &content_type,
  15904. DownloadProgress progress) {
  15905. return cli_->Delete(path, body, content_type, progress);
  15906. }
  15907. inline Result Client::Delete(const std::string &path, const Headers &headers,
  15908. const std::string &body,
  15909. const std::string &content_type,
  15910. DownloadProgress progress) {
  15911. return cli_->Delete(path, headers, body, content_type, progress);
  15912. }
  15913. inline Result Client::Delete(const std::string &path, const Params &params,
  15914. DownloadProgress progress) {
  15915. return cli_->Delete(path, params, progress);
  15916. }
  15917. inline Result Client::Delete(const std::string &path, const Headers &headers,
  15918. const Params &params, DownloadProgress progress) {
  15919. return cli_->Delete(path, headers, params, progress);
  15920. }
  15921. inline Result Client::Options(const std::string &path) {
  15922. return cli_->Options(path);
  15923. }
  15924. inline Result Client::Options(const std::string &path, const Headers &headers) {
  15925. return cli_->Options(path, headers);
  15926. }
  15927. inline ClientImpl::StreamHandle
  15928. Client::open_stream(const std::string &method, const std::string &path,
  15929. const Params &params, const Headers &headers,
  15930. const std::string &body, const std::string &content_type) {
  15931. return cli_->open_stream(method, path, params, headers, body, content_type);
  15932. }
  15933. inline bool Client::send(Request &req, Response &res, Error &error) {
  15934. return cli_->send(req, res, error);
  15935. }
  15936. inline Result Client::send(const Request &req) { return cli_->send(req); }
  15937. inline void Client::stop() { cli_->stop(); }
  15938. inline std::string Client::host() const { return cli_->host(); }
  15939. inline int Client::port() const { return cli_->port(); }
  15940. inline size_t Client::is_socket_open() const { return cli_->is_socket_open(); }
  15941. inline socket_t Client::socket() const { return cli_->socket(); }
  15942. inline void
  15943. Client::set_hostname_addr_map(std::map<std::string, std::string> addr_map) {
  15944. cli_->set_hostname_addr_map(std::move(addr_map));
  15945. }
  15946. inline void Client::set_default_headers(Headers headers) {
  15947. cli_->set_default_headers(std::move(headers));
  15948. }
  15949. inline void Client::set_header_writer(
  15950. std::function<ssize_t(Stream &, Headers &)> const &writer) {
  15951. cli_->set_header_writer(writer);
  15952. }
  15953. inline void Client::set_address_family(int family) {
  15954. cli_->set_address_family(family);
  15955. }
  15956. inline void Client::set_tcp_nodelay(bool on) { cli_->set_tcp_nodelay(on); }
  15957. inline void Client::set_socket_options(SocketOptions socket_options) {
  15958. cli_->set_socket_options(std::move(socket_options));
  15959. }
  15960. inline void Client::set_connection_timeout(time_t sec, time_t usec) {
  15961. cli_->set_connection_timeout(sec, usec);
  15962. }
  15963. inline void Client::set_read_timeout(time_t sec, time_t usec) {
  15964. cli_->set_read_timeout(sec, usec);
  15965. }
  15966. inline void Client::set_write_timeout(time_t sec, time_t usec) {
  15967. cli_->set_write_timeout(sec, usec);
  15968. }
  15969. inline void Client::set_basic_auth(const std::string &username,
  15970. const std::string &password) {
  15971. cli_->set_basic_auth(username, password);
  15972. }
  15973. inline void Client::set_bearer_token_auth(const std::string &token) {
  15974. cli_->set_bearer_token_auth(token);
  15975. }
  15976. inline void Client::set_keep_alive(bool on) { cli_->set_keep_alive(on); }
  15977. inline void Client::set_follow_location(bool on) {
  15978. cli_->set_follow_location(on);
  15979. }
  15980. inline void Client::set_path_encode(bool on) { cli_->set_path_encode(on); }
  15981. inline void Client::set_compress(bool on) { cli_->set_compress(on); }
  15982. inline void Client::set_decompress(bool on) { cli_->set_decompress(on); }
  15983. inline void Client::set_payload_max_length(size_t length) {
  15984. cli_->set_payload_max_length(length);
  15985. }
  15986. inline void Client::set_interface(const std::string &intf) {
  15987. cli_->set_interface(intf);
  15988. }
  15989. inline void Client::set_proxy(const std::string &host, int port) {
  15990. cli_->set_proxy(host, port);
  15991. }
  15992. inline void Client::set_proxy_basic_auth(const std::string &username,
  15993. const std::string &password) {
  15994. cli_->set_proxy_basic_auth(username, password);
  15995. }
  15996. inline void Client::set_proxy_bearer_token_auth(const std::string &token) {
  15997. cli_->set_proxy_bearer_token_auth(token);
  15998. }
  15999. inline void Client::set_no_proxy(const std::vector<std::string> &patterns) {
  16000. cli_->set_no_proxy(patterns);
  16001. }
  16002. inline void Client::set_logger(Logger logger) {
  16003. cli_->set_logger(std::move(logger));
  16004. }
  16005. inline void Client::set_error_logger(ErrorLogger error_logger) {
  16006. cli_->set_error_logger(std::move(error_logger));
  16007. }
  16008. /*
  16009. * Group 6: SSL Server and Client implementation
  16010. */
  16011. #ifdef CPPHTTPLIB_SSL_ENABLED
  16012. // SSL HTTP server implementation
  16013. inline SSLServer::SSLServer(const char *cert_path, const char *private_key_path,
  16014. const char *client_ca_cert_file_path,
  16015. const char *client_ca_cert_dir_path,
  16016. const char *private_key_password) {
  16017. using namespace tls;
  16018. ctx_ = create_server_context();
  16019. if (!ctx_) { return; }
  16020. // Load server certificate and private key
  16021. if (!set_server_cert_file(ctx_, cert_path, private_key_path,
  16022. private_key_password)) {
  16023. last_ssl_error_ = static_cast<int>(get_error());
  16024. free_context(ctx_);
  16025. ctx_ = nullptr;
  16026. return;
  16027. }
  16028. // Load client CA certificates for client authentication
  16029. if (client_ca_cert_file_path || client_ca_cert_dir_path) {
  16030. if (!set_client_ca_file(ctx_, client_ca_cert_file_path,
  16031. client_ca_cert_dir_path)) {
  16032. last_ssl_error_ = static_cast<int>(get_error());
  16033. free_context(ctx_);
  16034. ctx_ = nullptr;
  16035. return;
  16036. }
  16037. // Enable client certificate verification
  16038. set_verify_client(ctx_, true);
  16039. }
  16040. }
  16041. inline SSLServer::SSLServer(const PemMemory &pem) {
  16042. using namespace tls;
  16043. ctx_ = create_server_context();
  16044. if (ctx_) {
  16045. std::string cert_buf, key_buf;
  16046. if (!set_server_cert_pem(
  16047. ctx_, detail::pem_c_str(pem.cert_pem, pem.cert_pem_len, cert_buf),
  16048. detail::pem_c_str(pem.key_pem, pem.key_pem_len, key_buf),
  16049. pem.private_key_password)) {
  16050. last_ssl_error_ = static_cast<int>(get_error());
  16051. free_context(ctx_);
  16052. ctx_ = nullptr;
  16053. } else if (pem.client_ca_pem && pem.client_ca_pem_len > 0) {
  16054. if (!load_ca_pem(ctx_, pem.client_ca_pem, pem.client_ca_pem_len)) {
  16055. last_ssl_error_ = static_cast<int>(get_error());
  16056. free_context(ctx_);
  16057. ctx_ = nullptr;
  16058. } else {
  16059. set_verify_client(ctx_, true);
  16060. }
  16061. }
  16062. }
  16063. }
  16064. inline SSLServer::SSLServer(const tls::ContextSetupCallback &setup_callback) {
  16065. using namespace tls;
  16066. ctx_ = create_server_context();
  16067. if (ctx_) {
  16068. if (!setup_callback(ctx_)) {
  16069. free_context(ctx_);
  16070. ctx_ = nullptr;
  16071. }
  16072. }
  16073. }
  16074. inline SSLServer::~SSLServer() {
  16075. if (ctx_) { tls::free_context(ctx_); }
  16076. }
  16077. inline bool SSLServer::is_valid() const {
  16078. return ctx_ != nullptr && Server::is_valid();
  16079. }
  16080. inline bool SSLServer::process_and_close_socket(socket_t sock) {
  16081. using namespace tls;
  16082. session_t session = nullptr;
  16083. {
  16084. std::unique_lock<std::mutex> lock(ctx_mutex_);
  16085. ctx_cv_.wait(lock, [&] { return updates_pending_ == 0; });
  16086. session = create_session(static_cast<ctx_t>(ctx_), sock);
  16087. if (session) { handshakes_in_progress_++; }
  16088. }
  16089. if (!session) {
  16090. last_ssl_error_ = static_cast<int>(get_error());
  16091. detail::shutdown_socket(sock);
  16092. detail::close_socket(sock);
  16093. return false;
  16094. }
  16095. // Use scope_exit to ensure cleanup on all paths (including exceptions)
  16096. bool handshake_done = false;
  16097. bool ret = false;
  16098. bool websocket_upgraded = false;
  16099. auto cleanup = detail::scope_exit([&] {
  16100. if (handshake_done) { shutdown(session, !websocket_upgraded && ret); }
  16101. free_session(session);
  16102. detail::shutdown_socket(sock);
  16103. detail::close_socket(sock);
  16104. });
  16105. // Perform TLS accept handshake with timeout
  16106. TlsError tls_err;
  16107. auto accepted = false;
  16108. {
  16109. auto handshake_left = detail::scope_exit([&] {
  16110. std::lock_guard<std::mutex> guard(ctx_mutex_);
  16111. if (--handshakes_in_progress_ == 0) { ctx_cv_.notify_all(); }
  16112. });
  16113. accepted = accept_nonblocking(session, sock, read_timeout_sec_,
  16114. read_timeout_usec_, &tls_err);
  16115. }
  16116. if (!accepted) {
  16117. #ifdef CPPHTTPLIB_OPENSSL_SUPPORT
  16118. // Map TlsError to legacy ssl_error for backward compatibility
  16119. if (tls_err.code == ErrorCode::WantRead) {
  16120. last_ssl_error_ = SSL_ERROR_WANT_READ;
  16121. } else if (tls_err.code == ErrorCode::WantWrite) {
  16122. last_ssl_error_ = SSL_ERROR_WANT_WRITE;
  16123. } else {
  16124. last_ssl_error_ = SSL_ERROR_SSL;
  16125. }
  16126. #else
  16127. last_ssl_error_ = static_cast<int>(get_error());
  16128. #endif
  16129. return false;
  16130. }
  16131. handshake_done = true;
  16132. std::string remote_addr;
  16133. int remote_port = 0;
  16134. detail::get_remote_ip_and_port(sock, remote_addr, remote_port);
  16135. std::string local_addr;
  16136. int local_port = 0;
  16137. detail::get_local_ip_and_port(sock, local_addr, local_port);
  16138. ret = serve_guarded([&]() {
  16139. return detail::process_server_socket_ssl(
  16140. svr_sock_, session, sock, keep_alive_max_count_,
  16141. keep_alive_timeout_sec_, read_timeout_sec_, read_timeout_usec_,
  16142. write_timeout_sec_, write_timeout_usec_,
  16143. [&](Stream &strm, bool close_connection, bool &connection_closed) {
  16144. return process_request(
  16145. strm, remote_addr, remote_port, local_addr, local_port,
  16146. close_connection, connection_closed,
  16147. [&](Request &req) { req.ssl = session; }, &websocket_upgraded);
  16148. });
  16149. });
  16150. return ret;
  16151. }
  16152. inline bool SSLServer::update_certs_pem(const char *cert_pem,
  16153. const char *key_pem,
  16154. const char *client_ca_pem,
  16155. const char *password) {
  16156. if (!ctx_) { return false; }
  16157. std::unique_lock<std::mutex> lock(ctx_mutex_);
  16158. updates_pending_++;
  16159. auto se = detail::scope_exit([&] {
  16160. if (--updates_pending_ == 0) { ctx_cv_.notify_all(); }
  16161. });
  16162. ctx_cv_.wait(lock, [&] { return handshakes_in_progress_ == 0; });
  16163. if (!tls::update_server_cert(ctx_, cert_pem, key_pem, password)) {
  16164. return false;
  16165. }
  16166. if (client_ca_pem) {
  16167. return tls::update_server_client_ca(ctx_, client_ca_pem);
  16168. }
  16169. return true;
  16170. }
  16171. // SSL HTTP client implementation
  16172. inline SSLClient::~SSLClient() {
  16173. // Make sure to shut down SSL since shutdown_ssl will resolve to the
  16174. // base function rather than the derived function once we get to the
  16175. // base class destructor, and won't free the SSL (causing a leak).
  16176. // This must happen before the context is freed below: some backends
  16177. // (e.g. mbedTLS) have the SSL session borrow a raw pointer into the
  16178. // context, so freeing the context first leaves close_notify reading
  16179. // freed memory.
  16180. shutdown_ssl_impl(socket_, true);
  16181. if (ctx_) {
  16182. tls::free_context(ctx_);
  16183. ctx_ = nullptr;
  16184. }
  16185. }
  16186. inline bool SSLClient::is_valid() const { return ctx_ != nullptr; }
  16187. inline void SSLClient::shutdown_ssl(Socket &socket, bool shutdown_gracefully) {
  16188. shutdown_ssl_impl(socket, shutdown_gracefully);
  16189. }
  16190. inline void SSLClient::shutdown_ssl_impl(Socket &socket,
  16191. bool shutdown_gracefully) {
  16192. if (socket.sock == INVALID_SOCKET) {
  16193. assert(socket.ssl == nullptr);
  16194. return;
  16195. }
  16196. if (socket.ssl) {
  16197. tls::shutdown(socket.ssl, shutdown_gracefully);
  16198. {
  16199. std::lock_guard<std::mutex> guard(ctx_mutex_);
  16200. tls::free_session(socket.ssl);
  16201. }
  16202. socket.ssl = nullptr;
  16203. }
  16204. assert(socket.ssl == nullptr);
  16205. }
  16206. inline bool SSLClient::process_socket(
  16207. const Socket &socket,
  16208. std::chrono::time_point<std::chrono::steady_clock> start_time,
  16209. std::function<bool(Stream &strm)> callback) {
  16210. assert(socket.ssl);
  16211. return detail::process_client_socket_ssl(
  16212. socket.ssl, socket.sock, read_timeout_sec_, read_timeout_usec_,
  16213. write_timeout_sec_, write_timeout_usec_, max_timeout_msec_, start_time,
  16214. [&](detail::SSLSocketStream &strm) {
  16215. auto ret = callback(strm);
  16216. // A request that failed after the handshake reports Error::Read or
  16217. // Error::Write; keep the TLS error behind it, such as a fatal alert
  16218. // from the server, for Result::ssl_error() and ssl_backend_error()
  16219. const auto &tls_error = strm.tls_error();
  16220. if (!ret && tls_error.code != tls::ErrorCode::Success) {
  16221. last_ssl_error_ = static_cast<int>(tls_error.code);
  16222. last_backend_error_ = tls_error.backend_code;
  16223. }
  16224. return ret;
  16225. });
  16226. }
  16227. inline bool SSLClient::is_ssl() const { return true; }
  16228. inline bool SSLClient::create_and_connect_socket(Socket &socket, Error &error) {
  16229. if (!is_valid()) {
  16230. error = Error::SSLConnection;
  16231. return false;
  16232. }
  16233. return ClientImpl::create_and_connect_socket(socket, error);
  16234. }
  16235. inline bool SSLClient::setup_proxy_connection(
  16236. Socket &socket,
  16237. std::chrono::time_point<std::chrono::steady_clock> start_time,
  16238. Response &res, bool &success, Error &error) {
  16239. if (!is_proxy_enabled_for_host(host_)) { return true; }
  16240. if (!connect_with_proxy(socket, start_time, res, success, error)) {
  16241. return false;
  16242. }
  16243. if (!initialize_ssl(socket, error)) {
  16244. success = false;
  16245. return false;
  16246. }
  16247. return true;
  16248. }
  16249. // Assumes that socket_mutex_ is locked and that there are no requests in
  16250. // flight
  16251. inline bool SSLClient::connect_with_proxy(
  16252. Socket &socket,
  16253. std::chrono::time_point<std::chrono::steady_clock> start_time,
  16254. Response &res, bool &success, Error &error) {
  16255. success = true;
  16256. Response proxy_res;
  16257. if (!detail::process_client_socket(
  16258. socket.sock, read_timeout_sec_, read_timeout_usec_,
  16259. write_timeout_sec_, write_timeout_usec_, max_timeout_msec_,
  16260. start_time, [&](Stream &strm) {
  16261. Request req2;
  16262. req2.method = "CONNECT";
  16263. req2.path =
  16264. detail::make_host_and_port_string_always_port(host_, port_);
  16265. if (max_timeout_msec_ > 0) {
  16266. req2.start_time_ = std::chrono::steady_clock::now();
  16267. }
  16268. return process_request(strm, req2, proxy_res, false, error);
  16269. })) {
  16270. // Thread-safe to close everything because we are assuming there are no
  16271. // requests in flight
  16272. shutdown_ssl(socket, true);
  16273. shutdown_socket(socket);
  16274. close_socket(socket);
  16275. success = false;
  16276. return false;
  16277. }
  16278. if (proxy_res.status == StatusCode::ProxyAuthenticationRequired_407) {
  16279. if (!proxy_digest_auth_username_.empty() &&
  16280. !proxy_digest_auth_password_.empty()) {
  16281. std::map<std::string, std::string> auth;
  16282. if (detail::parse_www_authenticate(proxy_res, auth, true)) {
  16283. // Close the current socket and create a new one for the authenticated
  16284. // request
  16285. shutdown_ssl(socket, true);
  16286. shutdown_socket(socket);
  16287. close_socket(socket);
  16288. // Create a new socket for the authenticated CONNECT request
  16289. if (!ensure_socket_connection(socket, error)) {
  16290. success = false;
  16291. output_error_log(error, nullptr);
  16292. return false;
  16293. }
  16294. proxy_res = Response();
  16295. if (!detail::process_client_socket(
  16296. socket.sock, read_timeout_sec_, read_timeout_usec_,
  16297. write_timeout_sec_, write_timeout_usec_, max_timeout_msec_,
  16298. start_time, [&](Stream &strm) {
  16299. Request req3;
  16300. req3.method = "CONNECT";
  16301. req3.path = detail::make_host_and_port_string_always_port(
  16302. host_, port_);
  16303. req3.headers.insert(detail::make_digest_authentication_header(
  16304. req3, make_request_target(req3), auth, 1,
  16305. detail::random_string(10), proxy_digest_auth_username_,
  16306. proxy_digest_auth_password_, true));
  16307. if (max_timeout_msec_ > 0) {
  16308. req3.start_time_ = std::chrono::steady_clock::now();
  16309. }
  16310. return process_request(strm, req3, proxy_res, false, error);
  16311. })) {
  16312. // Thread-safe to close everything because we are assuming there are
  16313. // no requests in flight
  16314. shutdown_ssl(socket, true);
  16315. shutdown_socket(socket);
  16316. close_socket(socket);
  16317. success = false;
  16318. return false;
  16319. }
  16320. }
  16321. }
  16322. }
  16323. // If status code is not 200, proxy request is failed.
  16324. // Set error to ProxyConnection. A 407 is returned as the response of the
  16325. // request, so the caller sees the proxy asks for credentials; any other
  16326. // status would read as the answer of the origin, which it never reached.
  16327. if (proxy_res.status != StatusCode::OK_200) {
  16328. error = Error::ProxyConnection;
  16329. output_error_log(error, nullptr);
  16330. if (proxy_res.status == StatusCode::ProxyAuthenticationRequired_407) {
  16331. res = std::move(proxy_res);
  16332. } else {
  16333. success = false;
  16334. }
  16335. // Thread-safe to close everything because we are assuming there are
  16336. // no requests in flight
  16337. shutdown_ssl(socket, true);
  16338. shutdown_socket(socket);
  16339. close_socket(socket);
  16340. return false;
  16341. }
  16342. return true;
  16343. }
  16344. inline bool SSLClient::ensure_socket_connection(Socket &socket, Error &error) {
  16345. if (!ClientImpl::ensure_socket_connection(socket, error)) { return false; }
  16346. if (is_proxy_enabled_for_host(host_)) { return true; }
  16347. if (!initialize_ssl(socket, error)) {
  16348. shutdown_socket(socket);
  16349. close_socket(socket);
  16350. return false;
  16351. }
  16352. return true;
  16353. }
  16354. // SSL HTTP client implementation
  16355. inline SSLClient::SSLClient(const std::string &host)
  16356. : SSLClient(host, 443, std::string(), std::string()) {}
  16357. inline SSLClient::SSLClient(const std::string &host, int port)
  16358. : SSLClient(host, port, std::string(), std::string()) {}
  16359. inline void SSLClient::init_ctx() {
  16360. ctx_ = tls::create_client_context();
  16361. if (ctx_) { tls::set_min_version(ctx_, tls::Version::TLS1_2); }
  16362. }
  16363. inline void SSLClient::reset_ctx_on_error() {
  16364. last_backend_error_ = tls::get_error();
  16365. tls::free_context(ctx_);
  16366. ctx_ = nullptr;
  16367. }
  16368. inline SSLClient::SSLClient(const std::string &host, int port,
  16369. const std::string &client_cert_path,
  16370. const std::string &client_key_path,
  16371. const std::string &private_key_password)
  16372. : ClientImpl(host, port, client_cert_path, client_key_path) {
  16373. init_ctx();
  16374. if (!ctx_) { return; }
  16375. if (!client_cert_path.empty() && !client_key_path.empty()) {
  16376. const char *password =
  16377. private_key_password.empty() ? nullptr : private_key_password.c_str();
  16378. if (!tls::set_client_cert_file(ctx_, client_cert_path.c_str(),
  16379. client_key_path.c_str(), password)) {
  16380. reset_ctx_on_error();
  16381. }
  16382. }
  16383. }
  16384. inline SSLClient::SSLClient(const std::string &host, int port,
  16385. const PemMemory &pem)
  16386. : ClientImpl(host, port) {
  16387. init_ctx();
  16388. if (!ctx_) { return; }
  16389. if (pem.cert_pem && pem.key_pem) {
  16390. std::string cert_buf, key_buf;
  16391. if (!tls::set_client_cert_pem(
  16392. ctx_, detail::pem_c_str(pem.cert_pem, pem.cert_pem_len, cert_buf),
  16393. detail::pem_c_str(pem.key_pem, pem.key_pem_len, key_buf),
  16394. pem.private_key_password)) {
  16395. reset_ctx_on_error();
  16396. }
  16397. }
  16398. }
  16399. inline void SSLClient::set_ca_cert_store(tls::ca_store_t ca_cert_store) {
  16400. if (ca_cert_store && ctx_) {
  16401. // set_ca_store takes ownership of ca_cert_store
  16402. tls::set_ca_store(ctx_, ca_cert_store);
  16403. ca_cert_store_set_ = true;
  16404. } else if (ca_cert_store) {
  16405. tls::free_ca_store(ca_cert_store);
  16406. }
  16407. }
  16408. inline void
  16409. SSLClient::set_server_certificate_verifier(tls::VerifyCallback verifier) {
  16410. if (!ctx_) { return; }
  16411. server_certificate_verifier_ = verifier;
  16412. // Under the lock that creating a session from ctx_ takes
  16413. std::lock_guard<std::mutex> guard(ctx_mutex_);
  16414. tls::set_verify_callback(ctx_, std::move(verifier));
  16415. }
  16416. inline void SSLClient::set_session_verifier(
  16417. std::function<SSLVerifierResponse(tls::session_t)> verifier) {
  16418. session_verifier_ = std::move(verifier);
  16419. }
  16420. #ifdef CPPHTTPLIB_WINDOWS_AUTOMATIC_ROOT_CERTIFICATES_UPDATE
  16421. inline void SSLClient::enable_windows_certificate_verification(bool enabled) {
  16422. enable_windows_cert_verification_ = enabled;
  16423. }
  16424. #endif
  16425. inline void SSLClient::load_ca_cert_store(const char *ca_cert,
  16426. std::size_t size) {
  16427. if (ctx_ && ca_cert && size > 0) {
  16428. // Every PEM loaded, for redirect transfer
  16429. if (!ca_cert_pem_.empty() && ca_cert_pem_.back() != '\n') {
  16430. ca_cert_pem_ += '\n';
  16431. }
  16432. ca_cert_pem_.append(ca_cert, size);
  16433. tls::load_ca_pem(ctx_, ca_cert, size);
  16434. }
  16435. }
  16436. inline bool SSLClient::load_certs() {
  16437. auto ret = true;
  16438. // call_once rather than the plain flag WebSocketClient::create_stream() uses:
  16439. // one client is shared across concurrent requests here.
  16440. std::call_once(initialize_cert_, [&]() {
  16441. std::lock_guard<std::mutex> guard(ctx_mutex_);
  16442. ret = detail::load_client_ca_config(
  16443. ctx_, ca_cert_file_path_, ca_cert_dir_path_,
  16444. !ca_cert_pem_.empty() || ca_cert_store_set_, system_ca_mode_,
  16445. last_backend_error_);
  16446. });
  16447. return ret;
  16448. }
  16449. inline bool SSLClient::initialize_ssl(Socket &socket, Error &error) {
  16450. // Load CA certificates if server verification is enabled
  16451. if (server_certificate_verification_) {
  16452. if (!load_certs()) {
  16453. error = Error::SSLLoadingCerts;
  16454. output_error_log(error, nullptr);
  16455. return false;
  16456. }
  16457. }
  16458. detail::ClientTlsSessionOptions options;
  16459. options.server_hostname_verification = server_hostname_verification_;
  16460. options.session_verifier = session_verifier_;
  16461. options.ctx_mutex = &ctx_mutex_;
  16462. #ifdef CPPHTTPLIB_WINDOWS_AUTOMATIC_ROOT_CERTIFICATES_UPDATE
  16463. // Skip Schannel when a custom CA cert is specified, as the Windows
  16464. // certificate store would not know about user-provided CA certificates.
  16465. // Also skip when system CA trust is explicitly disabled.
  16466. options.windows_cert_verification =
  16467. enable_windows_cert_verification_ &&
  16468. system_ca_mode_ != SystemCAMode::Disabled && ca_cert_file_path_.empty() &&
  16469. ca_cert_dir_path_.empty() && ca_cert_pem_.empty() && !ca_cert_store_set_;
  16470. // Only a verifier set through set_server_certificate_verifier() is seen
  16471. // here, not one installed with tls::set_verify_callback() directly.
  16472. options.server_certificate_verifier_set =
  16473. static_cast<bool>(server_certificate_verifier_);
  16474. #endif
  16475. tls::session_t session = nullptr;
  16476. // Use scope_exit to ensure session is freed on error paths
  16477. bool success = false;
  16478. auto session_guard = detail::scope_exit([&] {
  16479. if (!success) { tls::free_session(session); }
  16480. });
  16481. detail::ClientTlsSessionError tls_error;
  16482. if (!detail::setup_client_tls_session(
  16483. host_, ctx_, session, socket.sock, server_certificate_verification_,
  16484. connection_timeout_sec_, connection_timeout_usec_, &tls_error,
  16485. options)) {
  16486. error = tls_error.error;
  16487. last_ssl_error_ = tls_error.ssl_error;
  16488. last_backend_error_ = tls_error.backend_error;
  16489. output_error_log(error, nullptr);
  16490. return false;
  16491. }
  16492. success = true;
  16493. socket.ssl = session;
  16494. return true;
  16495. }
  16496. inline void Client::set_digest_auth(const std::string &username,
  16497. const std::string &password) {
  16498. cli_->set_digest_auth(username, password);
  16499. }
  16500. inline void Client::set_proxy_digest_auth(const std::string &username,
  16501. const std::string &password) {
  16502. cli_->set_proxy_digest_auth(username, password);
  16503. }
  16504. inline void Client::enable_server_certificate_verification(bool enabled) {
  16505. cli_->enable_server_certificate_verification(enabled);
  16506. }
  16507. inline void Client::enable_server_hostname_verification(bool enabled) {
  16508. cli_->enable_server_hostname_verification(enabled);
  16509. }
  16510. inline void Client::enable_system_ca(bool enabled) {
  16511. cli_->enable_system_ca(enabled);
  16512. }
  16513. #ifdef CPPHTTPLIB_WINDOWS_AUTOMATIC_ROOT_CERTIFICATES_UPDATE
  16514. inline void Client::enable_windows_certificate_verification(bool enabled) {
  16515. if (is_ssl_) {
  16516. static_cast<SSLClient &>(*cli_).enable_windows_certificate_verification(
  16517. enabled);
  16518. }
  16519. }
  16520. #endif
  16521. inline void Client::set_ca_cert_path(const std::string &ca_cert_file_path,
  16522. const std::string &ca_cert_dir_path) {
  16523. cli_->set_ca_cert_path(ca_cert_file_path, ca_cert_dir_path);
  16524. }
  16525. inline void Client::set_ca_cert_store(tls::ca_store_t ca_cert_store) {
  16526. if (is_ssl_) {
  16527. static_cast<SSLClient &>(*cli_).set_ca_cert_store(ca_cert_store);
  16528. } else if (ca_cert_store) {
  16529. tls::free_ca_store(ca_cert_store);
  16530. }
  16531. }
  16532. inline void Client::load_ca_cert_store(const char *ca_cert, std::size_t size) {
  16533. if (is_ssl_) {
  16534. // Use the PEM-based path so the CA data is retained for redirect transfer
  16535. static_cast<SSLClient &>(*cli_).load_ca_cert_store(ca_cert, size);
  16536. }
  16537. }
  16538. inline void
  16539. Client::set_server_certificate_verifier(tls::VerifyCallback verifier) {
  16540. if (is_ssl_) {
  16541. static_cast<SSLClient &>(*cli_).set_server_certificate_verifier(
  16542. std::move(verifier));
  16543. }
  16544. }
  16545. inline void Client::set_session_verifier(
  16546. std::function<SSLVerifierResponse(tls::session_t)> verifier) {
  16547. if (is_ssl_) {
  16548. static_cast<SSLClient &>(*cli_).set_session_verifier(std::move(verifier));
  16549. }
  16550. }
  16551. inline tls::ctx_t Client::tls_context() const {
  16552. if (is_ssl_) { return static_cast<SSLClient &>(*cli_).tls_context(); }
  16553. return nullptr;
  16554. }
  16555. #endif // CPPHTTPLIB_SSL_ENABLED
  16556. /*
  16557. * Group 7: TLS abstraction layer - Common API
  16558. */
  16559. #ifdef CPPHTTPLIB_SSL_ENABLED
  16560. namespace tls {
  16561. // Helper for PeerCert construction
  16562. inline PeerCert get_peer_cert_from_session(const_session_t session) {
  16563. return PeerCert(get_peer_cert(session));
  16564. }
  16565. namespace impl {
  16566. // set_verify_callback() can replace a callback while handshakes on other
  16567. // threads run it, so they share it, and take their reference under this lock.
  16568. inline std::mutex &verify_callback_mutex() {
  16569. static std::mutex mutex;
  16570. return mutex;
  16571. }
  16572. // The TLS libraries are C, so an exception from a verify callback must not
  16573. // unwind through them. It rejects the certificate instead.
  16574. inline bool run_verify_callback(const VerifyCallback &callback,
  16575. const VerifyContext &ctx) {
  16576. #ifdef CPPHTTPLIB_NO_EXCEPTIONS
  16577. return callback(ctx);
  16578. #else
  16579. try {
  16580. return callback(ctx);
  16581. } catch (...) { return false; }
  16582. #endif
  16583. }
  16584. // Check if a string is an IPv4 address
  16585. inline bool is_ipv4_address(const std::string &str) {
  16586. int dots = 0;
  16587. for (char c : str) {
  16588. if (c == '.') {
  16589. dots++;
  16590. } else if (!detail::is_ascii_digit(c)) {
  16591. return false;
  16592. }
  16593. }
  16594. return dots == 3;
  16595. }
  16596. // Parse IPv4 address string to bytes
  16597. inline bool parse_ipv4(const std::string &str, unsigned char *out) {
  16598. const char *p = str.c_str();
  16599. for (int i = 0; i < 4; i++) {
  16600. if (i > 0) {
  16601. if (*p != '.') { return false; }
  16602. p++;
  16603. }
  16604. int val = 0;
  16605. int digits = 0;
  16606. while (detail::is_ascii_digit(*p)) {
  16607. val = val * 10 + (*p - '0');
  16608. if (val > 255) { return false; }
  16609. p++;
  16610. digits++;
  16611. }
  16612. if (digits == 0) { return false; }
  16613. // Reject leading zeros (e.g., "01.002.03.04") to prevent ambiguity
  16614. if (digits > 1 && *(p - digits) == '0') { return false; }
  16615. out[i] = static_cast<unsigned char>(val);
  16616. }
  16617. return *p == '\0';
  16618. }
  16619. // Parse an IP literal (IPv4 or IPv6) into raw network-order bytes.
  16620. // `out` must have room for at least 16 bytes. Returns the address length
  16621. // (4 for IPv4, 16 for IPv6) on success, or 0 if the string is not an IP
  16622. // literal. Used to match a host against iPAddress SANs the same way the
  16623. // OpenSSL backend does via X509_check_ip.
  16624. inline size_t parse_ip_address(const std::string &str, unsigned char *out) {
  16625. if (is_ipv4_address(str)) { return parse_ipv4(str, out) ? 4 : 0; }
  16626. struct in6_addr addr6 = {};
  16627. if (inet_pton(AF_INET6, str.c_str(), &addr6) == 1) {
  16628. memcpy(out, &addr6, 16);
  16629. return 16;
  16630. }
  16631. return 0;
  16632. }
  16633. #ifdef _WIN32
  16634. // Enumerate Windows system certificates and call callback with DER data
  16635. template <typename Callback>
  16636. inline bool enumerate_windows_system_certs(Callback cb) {
  16637. bool loaded = false;
  16638. static const wchar_t *store_names[] = {L"ROOT", L"CA"};
  16639. for (auto store_name : store_names) {
  16640. HCERTSTORE hStore = CertOpenSystemStoreW(0, store_name);
  16641. if (hStore) {
  16642. PCCERT_CONTEXT pContext = nullptr;
  16643. while ((pContext = CertEnumCertificatesInStore(hStore, pContext)) !=
  16644. nullptr) {
  16645. if (cb(pContext->pbCertEncoded, pContext->cbCertEncoded)) {
  16646. loaded = true;
  16647. }
  16648. }
  16649. CertCloseStore(hStore, 0);
  16650. }
  16651. }
  16652. return loaded;
  16653. }
  16654. #endif
  16655. #ifdef CPPHTTPLIB_USE_CERTS_FROM_MACOSX_KEYCHAIN
  16656. // Enumerate macOS Keychain certificates and call callback with DER data
  16657. template <typename Callback>
  16658. inline bool enumerate_macos_keychain_certs(Callback cb) {
  16659. bool loaded = false;
  16660. const SecTrustSettingsDomain domains[] = {
  16661. kSecTrustSettingsDomainSystem,
  16662. kSecTrustSettingsDomainAdmin,
  16663. kSecTrustSettingsDomainUser,
  16664. };
  16665. for (auto domain : domains) {
  16666. CFArrayRef certs = nullptr;
  16667. OSStatus status = SecTrustSettingsCopyCertificates(domain, &certs);
  16668. if (status != errSecSuccess || !certs) {
  16669. if (certs) CFRelease(certs);
  16670. continue;
  16671. }
  16672. CFIndex count = CFArrayGetCount(certs);
  16673. for (CFIndex i = 0; i < count; i++) {
  16674. SecCertificateRef cert =
  16675. (SecCertificateRef)CFArrayGetValueAtIndex(certs, i);
  16676. CFDataRef data = SecCertificateCopyData(cert);
  16677. if (data) {
  16678. if (cb(CFDataGetBytePtr(data),
  16679. static_cast<size_t>(CFDataGetLength(data)))) {
  16680. loaded = true;
  16681. }
  16682. CFRelease(data);
  16683. }
  16684. }
  16685. CFRelease(certs);
  16686. }
  16687. return loaded;
  16688. }
  16689. #endif
  16690. #if !defined(_WIN32) && !(defined(__APPLE__) && \
  16691. defined(CPPHTTPLIB_USE_CERTS_FROM_MACOSX_KEYCHAIN))
  16692. // Common CA certificate file paths on Linux/Unix
  16693. inline const char **system_ca_paths() {
  16694. static const char *paths[] = {
  16695. "/etc/ssl/certs/ca-certificates.crt", // Debian/Ubuntu
  16696. "/etc/pki/tls/certs/ca-bundle.crt", // RHEL/CentOS
  16697. "/etc/ssl/ca-bundle.pem", // OpenSUSE
  16698. "/etc/pki/tls/cacert.pem", // OpenELEC
  16699. "/etc/ssl/cert.pem", // Alpine, FreeBSD
  16700. nullptr};
  16701. return paths;
  16702. }
  16703. // Common CA certificate directory paths on Linux/Unix
  16704. inline const char **system_ca_dirs() {
  16705. static const char *dirs[] = {"/etc/ssl/certs", // Debian/Ubuntu
  16706. "/etc/pki/tls/certs", // RHEL/CentOS
  16707. "/usr/share/ca-certificates", // Other
  16708. nullptr};
  16709. return dirs;
  16710. }
  16711. #endif
  16712. } // namespace impl
  16713. inline bool set_client_ca_file(ctx_t ctx, const char *ca_file,
  16714. const char *ca_dir) {
  16715. if (!ctx) { return false; }
  16716. bool success = true;
  16717. if (ca_file && *ca_file) {
  16718. if (!load_ca_file(ctx, ca_file)) { success = false; }
  16719. }
  16720. if (ca_dir && *ca_dir) {
  16721. if (!load_ca_dir(ctx, ca_dir)) { success = false; }
  16722. }
  16723. #ifdef CPPHTTPLIB_OPENSSL_SUPPORT
  16724. // Set CA list for client certificate request (CertificateRequest message)
  16725. if (ca_file && *ca_file) {
  16726. auto list = SSL_load_client_CA_file(ca_file);
  16727. if (list) { SSL_CTX_set_client_CA_list(static_cast<SSL_CTX *>(ctx), list); }
  16728. }
  16729. #endif
  16730. return success;
  16731. }
  16732. inline bool set_server_cert_pem(ctx_t ctx, const char *cert, const char *key,
  16733. const char *password) {
  16734. return set_client_cert_pem(ctx, cert, key, password);
  16735. }
  16736. inline bool set_server_cert_file(ctx_t ctx, const char *cert_path,
  16737. const char *key_path, const char *password) {
  16738. return set_client_cert_file(ctx, cert_path, key_path, password);
  16739. }
  16740. // PeerCert implementation
  16741. inline PeerCert::PeerCert() = default;
  16742. inline PeerCert::PeerCert(cert_t cert) : cert_(cert) {}
  16743. inline PeerCert::PeerCert(PeerCert &&other) noexcept : cert_(other.cert_) {
  16744. other.cert_ = nullptr;
  16745. }
  16746. inline PeerCert &PeerCert::operator=(PeerCert &&other) noexcept {
  16747. if (this != &other) {
  16748. if (cert_) { free_cert(cert_); }
  16749. cert_ = other.cert_;
  16750. other.cert_ = nullptr;
  16751. }
  16752. return *this;
  16753. }
  16754. inline PeerCert::~PeerCert() {
  16755. if (cert_) { free_cert(cert_); }
  16756. }
  16757. inline PeerCert::operator bool() const { return cert_ != nullptr; }
  16758. inline std::string PeerCert::subject_cn() const {
  16759. return cert_ ? get_cert_subject_cn(cert_) : std::string();
  16760. }
  16761. inline std::string PeerCert::issuer_name() const {
  16762. return cert_ ? get_cert_issuer_name(cert_) : std::string();
  16763. }
  16764. inline bool PeerCert::check_hostname(const char *hostname) const {
  16765. return cert_ ? verify_hostname(cert_, hostname) : false;
  16766. }
  16767. inline std::vector<SanEntry> PeerCert::sans() const {
  16768. std::vector<SanEntry> result;
  16769. if (cert_) { get_cert_sans(cert_, result); }
  16770. return result;
  16771. }
  16772. inline bool PeerCert::validity(time_t &not_before, time_t &not_after) const {
  16773. return cert_ ? get_cert_validity(cert_, not_before, not_after) : false;
  16774. }
  16775. inline std::string PeerCert::serial() const {
  16776. return cert_ ? get_cert_serial(cert_) : std::string();
  16777. }
  16778. // VerifyContext method implementations
  16779. inline std::string VerifyContext::subject_cn() const {
  16780. return cert ? get_cert_subject_cn(cert) : std::string();
  16781. }
  16782. inline std::string VerifyContext::issuer_name() const {
  16783. return cert ? get_cert_issuer_name(cert) : std::string();
  16784. }
  16785. inline bool VerifyContext::check_hostname(const char *hostname) const {
  16786. return cert ? verify_hostname(cert, hostname) : false;
  16787. }
  16788. inline std::vector<SanEntry> VerifyContext::sans() const {
  16789. std::vector<SanEntry> result;
  16790. if (cert) { get_cert_sans(cert, result); }
  16791. return result;
  16792. }
  16793. inline bool VerifyContext::validity(time_t &not_before,
  16794. time_t &not_after) const {
  16795. return cert ? get_cert_validity(cert, not_before, not_after) : false;
  16796. }
  16797. inline std::string VerifyContext::serial() const {
  16798. return cert ? get_cert_serial(cert) : std::string();
  16799. }
  16800. // TlsError static method implementation
  16801. inline std::string TlsError::verify_error_to_string(long error_code) {
  16802. return verify_error_string(error_code);
  16803. }
  16804. } // namespace tls
  16805. // Request::peer_cert() implementation
  16806. inline tls::PeerCert Request::peer_cert() const {
  16807. return tls::get_peer_cert_from_session(ssl);
  16808. }
  16809. // Request::sni() implementation
  16810. inline std::string Request::sni() const {
  16811. if (!ssl) { return std::string(); }
  16812. const char *s = tls::get_sni(ssl);
  16813. return s ? std::string(s) : std::string();
  16814. }
  16815. #endif // CPPHTTPLIB_SSL_ENABLED
  16816. /*
  16817. * Group 8: TLS abstraction layer - OpenSSL backend
  16818. */
  16819. /*
  16820. * OpenSSL Backend Implementation
  16821. */
  16822. #ifdef CPPHTTPLIB_OPENSSL_SUPPORT
  16823. namespace tls {
  16824. namespace impl {
  16825. // Helper to map OpenSSL SSL_get_error to ErrorCode
  16826. inline ErrorCode map_ssl_error(int ssl_error, int &out_errno) {
  16827. switch (ssl_error) {
  16828. case SSL_ERROR_NONE: return ErrorCode::Success;
  16829. case SSL_ERROR_WANT_READ: return ErrorCode::WantRead;
  16830. case SSL_ERROR_WANT_WRITE: return ErrorCode::WantWrite;
  16831. case SSL_ERROR_ZERO_RETURN: return ErrorCode::PeerClosed;
  16832. case SSL_ERROR_SYSCALL: out_errno = errno; return ErrorCode::SyscallError;
  16833. case SSL_ERROR_SSL:
  16834. default: return ErrorCode::Fatal;
  16835. }
  16836. }
  16837. // Helper: Create client CA list from PEM string
  16838. // Returns a new STACK_OF(X509_NAME)* or nullptr on failure
  16839. // Caller takes ownership of returned list
  16840. inline STACK_OF(X509_NAME) *
  16841. create_client_ca_list_from_pem(const char *ca_pem) {
  16842. if (!ca_pem) { return nullptr; }
  16843. auto ca_list = sk_X509_NAME_new_null();
  16844. if (!ca_list) { return nullptr; }
  16845. BIO *bio = BIO_new_mem_buf(ca_pem, -1);
  16846. if (!bio) {
  16847. sk_X509_NAME_pop_free(ca_list, X509_NAME_free);
  16848. return nullptr;
  16849. }
  16850. X509 *cert = nullptr;
  16851. while ((cert = PEM_read_bio_X509(bio, nullptr, nullptr, nullptr)) !=
  16852. nullptr) {
  16853. const X509_NAME *name = X509_get_subject_name(cert);
  16854. if (name) {
  16855. sk_X509_NAME_push(ca_list, X509_NAME_dup(const_cast<X509_NAME *>(name)));
  16856. }
  16857. X509_free(cert);
  16858. }
  16859. BIO_free(bio);
  16860. return ca_list;
  16861. }
  16862. inline void free_verify_callback(void * /*parent*/, void *ptr,
  16863. CRYPTO_EX_DATA * /*ad*/, int /*idx*/,
  16864. long /*argl*/, void * /*argp*/) {
  16865. delete static_cast<std::shared_ptr<VerifyCallback> *>(ptr);
  16866. }
  16867. // The SSL_CTX owns its verify callback, so each client or server sees only
  16868. // its own, on whichever thread runs the handshake.
  16869. inline int verify_callback_index() {
  16870. static const auto index = SSL_CTX_get_ex_new_index(
  16871. 0, nullptr, nullptr, nullptr, free_verify_callback);
  16872. return index;
  16873. }
  16874. // OpenSSL verify callback wrapper
  16875. inline int openssl_verify_callback(int preverify_ok, X509_STORE_CTX *ctx) {
  16876. // Get SSL object from X509_STORE_CTX
  16877. auto ssl = static_cast<SSL *>(
  16878. X509_STORE_CTX_get_ex_data(ctx, SSL_get_ex_data_X509_STORE_CTX_idx()));
  16879. if (!ssl) { return preverify_ok; }
  16880. std::shared_ptr<VerifyCallback> callback;
  16881. {
  16882. std::lock_guard<std::mutex> guard(verify_callback_mutex());
  16883. auto stored = static_cast<std::shared_ptr<VerifyCallback> *>(
  16884. SSL_CTX_get_ex_data(SSL_get_SSL_CTX(ssl), verify_callback_index()));
  16885. if (stored) { callback = *stored; }
  16886. }
  16887. if (!callback) { return preverify_ok; }
  16888. // Get current certificate and depth
  16889. auto cert = X509_STORE_CTX_get_current_cert(ctx);
  16890. int depth = X509_STORE_CTX_get_error_depth(ctx);
  16891. int error = X509_STORE_CTX_get_error(ctx);
  16892. // Build context
  16893. VerifyContext verify_ctx;
  16894. verify_ctx.session = static_cast<session_t>(ssl);
  16895. verify_ctx.cert = static_cast<cert_t>(cert);
  16896. verify_ctx.depth = depth;
  16897. verify_ctx.preverify_ok = (preverify_ok != 0);
  16898. verify_ctx.error_code = error;
  16899. verify_ctx.error_string =
  16900. (error != X509_V_OK) ? X509_verify_cert_error_string(error) : nullptr;
  16901. return run_verify_callback(*callback, verify_ctx) ? 1 : 0;
  16902. }
  16903. // Sets the verify mode from whether the peer's certificate is required and
  16904. // whether a verify callback is set.
  16905. inline void apply_verify_mode(SSL_CTX *ssl_ctx, bool require) {
  16906. auto has_callback =
  16907. SSL_CTX_get_ex_data(ssl_ctx, verify_callback_index()) != nullptr;
  16908. auto mode = require ? (SSL_VERIFY_PEER | SSL_VERIFY_FAIL_IF_NO_PEER_CERT)
  16909. : (has_callback ? SSL_VERIFY_PEER : SSL_VERIFY_NONE);
  16910. SSL_CTX_set_verify(ssl_ctx, mode,
  16911. has_callback ? openssl_verify_callback : nullptr);
  16912. }
  16913. // X509_STORE_get0_objects is deprecated since OpenSSL 4.0 because it is not
  16914. // thread-safe; X509_STORE_get1_objects (OpenSSL 3.3+) returns a snapshot
  16915. // that must be released with release_store_objects
  16916. #if !defined(OPENSSL_IS_BORINGSSL) && !defined(LIBRESSL_VERSION_NUMBER) && \
  16917. OPENSSL_VERSION_NUMBER >= 0x30300000L
  16918. #define CPPHTTPLIB_HAS_X509_STORE_GET1_OBJECTS
  16919. #endif
  16920. inline STACK_OF(X509_OBJECT) * get_store_objects(X509_STORE *store) {
  16921. #ifdef CPPHTTPLIB_HAS_X509_STORE_GET1_OBJECTS
  16922. return X509_STORE_get1_objects(store);
  16923. #else
  16924. return X509_STORE_get0_objects(store);
  16925. #endif
  16926. }
  16927. inline void release_store_objects(STACK_OF(X509_OBJECT) * objs) {
  16928. #ifdef CPPHTTPLIB_HAS_X509_STORE_GET1_OBJECTS
  16929. sk_X509_OBJECT_pop_free(objs, X509_OBJECT_free);
  16930. #else
  16931. (void)objs; // get0 variant returns an internal pointer; nothing to free
  16932. #endif
  16933. }
  16934. } // namespace impl
  16935. inline ctx_t create_client_context() {
  16936. SSL_CTX *ctx = SSL_CTX_new(TLS_client_method());
  16937. if (ctx) {
  16938. // Disable auto-retry to properly handle non-blocking I/O
  16939. SSL_CTX_clear_mode(ctx, SSL_MODE_AUTO_RETRY);
  16940. // Set minimum TLS version
  16941. SSL_CTX_set_min_proto_version(ctx, TLS1_2_VERSION);
  16942. }
  16943. return static_cast<ctx_t>(ctx);
  16944. }
  16945. inline void free_context(ctx_t ctx) {
  16946. if (ctx) { SSL_CTX_free(static_cast<SSL_CTX *>(ctx)); }
  16947. }
  16948. inline bool set_min_version(ctx_t ctx, Version version) {
  16949. if (!ctx) return false;
  16950. return SSL_CTX_set_min_proto_version(static_cast<SSL_CTX *>(ctx),
  16951. static_cast<uint16_t>(version)) == 1;
  16952. }
  16953. inline bool load_ca_pem(ctx_t ctx, const char *pem, size_t len) {
  16954. if (!ctx || !pem || len == 0) return false;
  16955. auto ssl_ctx = static_cast<SSL_CTX *>(ctx);
  16956. auto store = SSL_CTX_get_cert_store(ssl_ctx);
  16957. if (!store) return false;
  16958. auto bio = BIO_new_mem_buf(pem, static_cast<int>(len));
  16959. if (!bio) return false;
  16960. bool ok = true;
  16961. X509 *cert = nullptr;
  16962. while ((cert = PEM_read_bio_X509(bio, nullptr, nullptr, nullptr)) !=
  16963. nullptr) {
  16964. if (X509_STORE_add_cert(store, cert) != 1) {
  16965. // Ignore duplicate errors
  16966. auto err = ERR_peek_last_error();
  16967. if (ERR_GET_REASON(err) != X509_R_CERT_ALREADY_IN_HASH_TABLE) {
  16968. ok = false;
  16969. }
  16970. }
  16971. X509_free(cert);
  16972. if (!ok) break;
  16973. }
  16974. BIO_free(bio);
  16975. // Clear any "no more certificates" errors
  16976. ERR_clear_error();
  16977. return ok;
  16978. }
  16979. inline bool load_ca_file(ctx_t ctx, const char *file_path) {
  16980. if (!ctx || !file_path) return false;
  16981. return SSL_CTX_load_verify_locations(static_cast<SSL_CTX *>(ctx), file_path,
  16982. nullptr) == 1;
  16983. }
  16984. inline bool load_ca_dir(ctx_t ctx, const char *dir_path) {
  16985. if (!ctx || !dir_path) return false;
  16986. return SSL_CTX_load_verify_locations(static_cast<SSL_CTX *>(ctx), nullptr,
  16987. dir_path) == 1;
  16988. }
  16989. inline bool load_system_certs(ctx_t ctx) {
  16990. if (!ctx) return false;
  16991. auto ssl_ctx = static_cast<SSL_CTX *>(ctx);
  16992. #ifdef _WIN32
  16993. // Windows: Load from system certificate store (ROOT and CA)
  16994. auto store = SSL_CTX_get_cert_store(ssl_ctx);
  16995. if (!store) return false;
  16996. bool loaded_any = false;
  16997. static const wchar_t *store_names[] = {L"ROOT", L"CA"};
  16998. for (auto store_name : store_names) {
  16999. auto hStore = CertOpenSystemStoreW(NULL, store_name);
  17000. if (!hStore) continue;
  17001. PCCERT_CONTEXT pContext = nullptr;
  17002. while ((pContext = CertEnumCertificatesInStore(hStore, pContext)) !=
  17003. nullptr) {
  17004. const unsigned char *data = pContext->pbCertEncoded;
  17005. auto x509 = d2i_X509(nullptr, &data, pContext->cbCertEncoded);
  17006. if (x509) {
  17007. if (X509_STORE_add_cert(store, x509) == 1) { loaded_any = true; }
  17008. X509_free(x509);
  17009. }
  17010. }
  17011. CertCloseStore(hStore, 0);
  17012. }
  17013. return loaded_any;
  17014. #elif defined(__APPLE__)
  17015. #ifdef CPPHTTPLIB_USE_CERTS_FROM_MACOSX_KEYCHAIN
  17016. // macOS: Load from Keychain
  17017. auto store = SSL_CTX_get_cert_store(ssl_ctx);
  17018. if (!store) return false;
  17019. bool loaded_any = false;
  17020. const SecTrustSettingsDomain domains[] = {
  17021. kSecTrustSettingsDomainSystem,
  17022. kSecTrustSettingsDomainAdmin,
  17023. kSecTrustSettingsDomainUser,
  17024. };
  17025. for (auto domain : domains) {
  17026. CFArrayRef certs = nullptr;
  17027. if (SecTrustSettingsCopyCertificates(domain, &certs) != errSecSuccess ||
  17028. !certs) {
  17029. if (certs) CFRelease(certs);
  17030. continue;
  17031. }
  17032. auto count = CFArrayGetCount(certs);
  17033. for (CFIndex i = 0; i < count; i++) {
  17034. auto cert = reinterpret_cast<SecCertificateRef>(
  17035. const_cast<void *>(CFArrayGetValueAtIndex(certs, i)));
  17036. CFDataRef der = SecCertificateCopyData(cert);
  17037. if (der) {
  17038. const unsigned char *data = CFDataGetBytePtr(der);
  17039. auto x509 = d2i_X509(nullptr, &data, CFDataGetLength(der));
  17040. if (x509) {
  17041. if (X509_STORE_add_cert(store, x509) == 1) { loaded_any = true; }
  17042. X509_free(x509);
  17043. }
  17044. CFRelease(der);
  17045. }
  17046. }
  17047. CFRelease(certs);
  17048. }
  17049. return loaded_any || SSL_CTX_set_default_verify_paths(ssl_ctx) == 1;
  17050. #else
  17051. return SSL_CTX_set_default_verify_paths(ssl_ctx) == 1;
  17052. #endif
  17053. #else
  17054. // Other Unix: use default verify paths
  17055. return SSL_CTX_set_default_verify_paths(ssl_ctx) == 1;
  17056. #endif
  17057. }
  17058. inline bool set_client_cert_pem(ctx_t ctx, const char *cert, const char *key,
  17059. const char *password) {
  17060. if (!ctx || !cert || !key) return false;
  17061. auto ssl_ctx = static_cast<SSL_CTX *>(ctx);
  17062. // Load certificate
  17063. auto cert_bio = BIO_new_mem_buf(cert, -1);
  17064. if (!cert_bio) return false;
  17065. auto x509 = PEM_read_bio_X509(cert_bio, nullptr, nullptr, nullptr);
  17066. BIO_free(cert_bio);
  17067. if (!x509) return false;
  17068. auto cert_ok = SSL_CTX_use_certificate(ssl_ctx, x509) == 1;
  17069. X509_free(x509);
  17070. if (!cert_ok) return false;
  17071. // Load private key
  17072. auto key_bio = BIO_new_mem_buf(key, -1);
  17073. if (!key_bio) return false;
  17074. auto pkey = PEM_read_bio_PrivateKey(key_bio, nullptr, nullptr,
  17075. password ? const_cast<char *>(password)
  17076. : nullptr);
  17077. BIO_free(key_bio);
  17078. if (!pkey) return false;
  17079. auto key_ok = SSL_CTX_use_PrivateKey(ssl_ctx, pkey) == 1;
  17080. EVP_PKEY_free(pkey);
  17081. return key_ok && SSL_CTX_check_private_key(ssl_ctx) == 1;
  17082. }
  17083. inline bool set_client_cert_file(ctx_t ctx, const char *cert_path,
  17084. const char *key_path, const char *password) {
  17085. if (!ctx || !cert_path || !key_path) return false;
  17086. auto ssl_ctx = static_cast<SSL_CTX *>(ctx);
  17087. if (password && password[0] != '\0') {
  17088. SSL_CTX_set_default_passwd_cb_userdata(
  17089. ssl_ctx, reinterpret_cast<void *>(const_cast<char *>(password)));
  17090. }
  17091. return SSL_CTX_use_certificate_chain_file(ssl_ctx, cert_path) == 1 &&
  17092. SSL_CTX_use_PrivateKey_file(ssl_ctx, key_path, SSL_FILETYPE_PEM) == 1;
  17093. }
  17094. inline ctx_t create_server_context() {
  17095. SSL_CTX *ctx = SSL_CTX_new(TLS_server_method());
  17096. if (ctx) {
  17097. // No renegotiation, as on the other backends: it would run a handshake
  17098. // that SSLServer::update_certs_pem() does not wait for
  17099. SSL_CTX_set_options(ctx, SSL_OP_NO_COMPRESSION |
  17100. SSL_OP_NO_SESSION_RESUMPTION_ON_RENEGOTIATION |
  17101. SSL_OP_NO_RENEGOTIATION);
  17102. SSL_CTX_set_min_proto_version(ctx, TLS1_2_VERSION);
  17103. // Without one, a client resuming its session is sent a fatal alert once
  17104. // client certificates are verified.
  17105. static const unsigned char sid_ctx[] = "cpp-httplib";
  17106. SSL_CTX_set_session_id_context(ctx, sid_ctx, sizeof(sid_ctx) - 1);
  17107. }
  17108. return static_cast<ctx_t>(ctx);
  17109. }
  17110. inline void set_verify_client(ctx_t ctx, bool require) {
  17111. if (!ctx) return;
  17112. impl::apply_verify_mode(static_cast<SSL_CTX *>(ctx), require);
  17113. }
  17114. inline session_t create_session(ctx_t ctx, socket_t sock) {
  17115. if (!ctx || sock == INVALID_SOCKET) return nullptr;
  17116. auto ssl_ctx = static_cast<SSL_CTX *>(ctx);
  17117. SSL *ssl = SSL_new(ssl_ctx);
  17118. if (!ssl) return nullptr;
  17119. // Disable auto-retry for proper non-blocking I/O handling
  17120. SSL_clear_mode(ssl, SSL_MODE_AUTO_RETRY);
  17121. auto bio = BIO_new_socket(static_cast<int>(sock), BIO_NOCLOSE);
  17122. if (!bio) {
  17123. SSL_free(ssl);
  17124. return nullptr;
  17125. }
  17126. SSL_set_bio(ssl, bio, bio);
  17127. return static_cast<session_t>(ssl);
  17128. }
  17129. inline void free_session(session_t session) {
  17130. if (session) { SSL_free(static_cast<SSL *>(session)); }
  17131. }
  17132. inline bool set_sni(session_t session, const char *hostname,
  17133. bool /*verify_hostname*/) {
  17134. if (!session || !hostname) return false;
  17135. auto ssl = static_cast<SSL *>(session);
  17136. // Set SNI (Server Name Indication) only - does not enable verification.
  17137. // OpenSSL never binds identity checking to SNI (that happens post-
  17138. // handshake in setup_client_tls_session()), so verify_hostname is unused.
  17139. #if defined(OPENSSL_IS_BORINGSSL)
  17140. return SSL_set_tlsext_host_name(ssl, hostname) == 1;
  17141. #else
  17142. // Direct call instead of macro to suppress -Wold-style-cast warning
  17143. return SSL_ctrl(ssl, SSL_CTRL_SET_TLSEXT_HOSTNAME, TLSEXT_NAMETYPE_host_name,
  17144. static_cast<void *>(const_cast<char *>(hostname))) == 1;
  17145. #endif
  17146. }
  17147. inline TlsError connect(session_t session) {
  17148. if (!session) { return TlsError(); }
  17149. auto ssl = static_cast<SSL *>(session);
  17150. auto ret = SSL_connect(ssl);
  17151. TlsError err;
  17152. if (ret == 1) {
  17153. err.code = ErrorCode::Success;
  17154. } else {
  17155. auto ssl_err = SSL_get_error(ssl, ret);
  17156. err.code = impl::map_ssl_error(ssl_err, err.sys_errno);
  17157. err.backend_code = ERR_get_error();
  17158. }
  17159. return err;
  17160. }
  17161. inline TlsError accept(session_t session) {
  17162. if (!session) { return TlsError(); }
  17163. auto ssl = static_cast<SSL *>(session);
  17164. auto ret = SSL_accept(ssl);
  17165. TlsError err;
  17166. if (ret == 1) {
  17167. err.code = ErrorCode::Success;
  17168. } else {
  17169. auto ssl_err = SSL_get_error(ssl, ret);
  17170. err.code = impl::map_ssl_error(ssl_err, err.sys_errno);
  17171. err.backend_code = ERR_get_error();
  17172. }
  17173. return err;
  17174. }
  17175. inline bool connect_nonblocking(session_t session, socket_t sock,
  17176. time_t timeout_sec, time_t timeout_usec,
  17177. TlsError *err) {
  17178. if (!session) {
  17179. if (err) { err->code = ErrorCode::Fatal; }
  17180. return false;
  17181. }
  17182. auto ssl = static_cast<SSL *>(session);
  17183. auto bio = SSL_get_rbio(ssl);
  17184. // Set non-blocking mode for handshake
  17185. detail::set_nonblocking(sock, true);
  17186. if (bio) { BIO_set_nbio(bio, 1); }
  17187. auto cleanup = detail::scope_exit([&]() {
  17188. // Restore blocking mode after handshake
  17189. if (bio) { BIO_set_nbio(bio, 0); }
  17190. detail::set_nonblocking(sock, false);
  17191. });
  17192. auto deadline = detail::deadline_after(timeout_sec, timeout_usec);
  17193. auto res = 0;
  17194. while ((res = SSL_connect(ssl)) != 1) {
  17195. auto ssl_err = SSL_get_error(ssl, res);
  17196. switch (ssl_err) {
  17197. case SSL_ERROR_WANT_READ:
  17198. if (detail::select_until(sock, POLLIN, deadline) > 0) { continue; }
  17199. break;
  17200. case SSL_ERROR_WANT_WRITE:
  17201. if (detail::select_until(sock, POLLOUT, deadline) > 0) { continue; }
  17202. break;
  17203. default: break;
  17204. }
  17205. if (err) {
  17206. err->code = impl::map_ssl_error(ssl_err, err->sys_errno);
  17207. err->backend_code = ERR_get_error();
  17208. }
  17209. return false;
  17210. }
  17211. if (err) { err->code = ErrorCode::Success; }
  17212. return true;
  17213. }
  17214. inline bool accept_nonblocking(session_t session, socket_t sock,
  17215. time_t timeout_sec, time_t timeout_usec,
  17216. TlsError *err) {
  17217. if (!session) {
  17218. if (err) { err->code = ErrorCode::Fatal; }
  17219. return false;
  17220. }
  17221. auto ssl = static_cast<SSL *>(session);
  17222. auto bio = SSL_get_rbio(ssl);
  17223. // Set non-blocking mode for handshake
  17224. detail::set_nonblocking(sock, true);
  17225. if (bio) { BIO_set_nbio(bio, 1); }
  17226. auto cleanup = detail::scope_exit([&]() {
  17227. // Restore blocking mode after handshake
  17228. if (bio) { BIO_set_nbio(bio, 0); }
  17229. detail::set_nonblocking(sock, false);
  17230. });
  17231. auto deadline = detail::deadline_after(timeout_sec, timeout_usec);
  17232. auto res = 0;
  17233. while ((res = SSL_accept(ssl)) != 1) {
  17234. auto ssl_err = SSL_get_error(ssl, res);
  17235. switch (ssl_err) {
  17236. case SSL_ERROR_WANT_READ:
  17237. if (detail::select_until(sock, POLLIN, deadline) > 0) { continue; }
  17238. break;
  17239. case SSL_ERROR_WANT_WRITE:
  17240. if (detail::select_until(sock, POLLOUT, deadline) > 0) { continue; }
  17241. break;
  17242. default: break;
  17243. }
  17244. if (err) {
  17245. err->code = impl::map_ssl_error(ssl_err, err->sys_errno);
  17246. err->backend_code = ERR_get_error();
  17247. }
  17248. return false;
  17249. }
  17250. if (err) { err->code = ErrorCode::Success; }
  17251. return true;
  17252. }
  17253. inline ssize_t read(session_t session, void *buf, size_t len, TlsError &err) {
  17254. if (!session || !buf) {
  17255. err.code = ErrorCode::Fatal;
  17256. return -1;
  17257. }
  17258. auto ssl = static_cast<SSL *>(session);
  17259. constexpr auto max_len =
  17260. static_cast<size_t>((std::numeric_limits<int>::max)());
  17261. if (len > max_len) { len = max_len; }
  17262. auto ret = SSL_read(ssl, buf, static_cast<int>(len));
  17263. if (ret > 0) {
  17264. err.code = ErrorCode::Success;
  17265. return ret;
  17266. }
  17267. auto ssl_err = SSL_get_error(ssl, ret);
  17268. err.code = impl::map_ssl_error(ssl_err, err.sys_errno);
  17269. if (err.code == ErrorCode::PeerClosed) {
  17270. return 0;
  17271. } // Gracefully handle the peer closed state.
  17272. if (err.code == ErrorCode::Fatal) { err.backend_code = ERR_get_error(); }
  17273. return -1;
  17274. }
  17275. inline ssize_t write(session_t session, const void *buf, size_t len,
  17276. TlsError &err) {
  17277. if (!session || !buf) {
  17278. err.code = ErrorCode::Fatal;
  17279. return -1;
  17280. }
  17281. auto ssl = static_cast<SSL *>(session);
  17282. auto ret = SSL_write(ssl, buf, static_cast<int>(len));
  17283. if (ret > 0) {
  17284. err.code = ErrorCode::Success;
  17285. return ret;
  17286. }
  17287. auto ssl_err = SSL_get_error(ssl, ret);
  17288. err.code = impl::map_ssl_error(ssl_err, err.sys_errno);
  17289. if (err.code == ErrorCode::Fatal) { err.backend_code = ERR_get_error(); }
  17290. return -1;
  17291. }
  17292. inline int pending(const_session_t session) {
  17293. if (!session) return 0;
  17294. return SSL_pending(static_cast<SSL *>(const_cast<void *>(session)));
  17295. }
  17296. inline void shutdown(session_t session, bool graceful) {
  17297. if (!session) return;
  17298. auto ssl = static_cast<SSL *>(session);
  17299. if (graceful) {
  17300. // Send close_notify without waiting for the peer's. The connection is
  17301. // closed right after this, so a unidirectional shutdown is enough, and an
  17302. // idle peer that never answers would otherwise hold this thread until the
  17303. // read timeout. The other backends do not wait either.
  17304. SSL_shutdown(ssl);
  17305. }
  17306. }
  17307. inline bool is_peer_closed(session_t session, socket_t sock) {
  17308. if (!session) return true;
  17309. // Temporarily set socket to non-blocking to avoid blocking on SSL_peek
  17310. detail::set_nonblocking(sock, true);
  17311. auto se = detail::scope_exit([&]() { detail::set_nonblocking(sock, false); });
  17312. auto ssl = static_cast<SSL *>(session);
  17313. char buf;
  17314. auto ret = SSL_peek(ssl, &buf, 1);
  17315. if (ret > 0) return false;
  17316. auto err = SSL_get_error(ssl, ret);
  17317. return err == SSL_ERROR_ZERO_RETURN;
  17318. }
  17319. inline cert_t get_peer_cert(const_session_t session) {
  17320. if (!session) return nullptr;
  17321. return static_cast<cert_t>(SSL_get1_peer_certificate(
  17322. static_cast<SSL *>(const_cast<void *>(session))));
  17323. }
  17324. inline size_t get_peer_certs(const_session_t session,
  17325. std::vector<cert_t> &certs) {
  17326. certs.clear();
  17327. if (!session) { return 0; }
  17328. auto ssl = static_cast<const SSL *>(session);
  17329. // On the server side, the chain leaves out the peer's own certificate
  17330. if (SSL_is_server(ssl)) {
  17331. if (auto leaf = get_peer_cert(session)) { certs.push_back(leaf); }
  17332. }
  17333. if (auto sk = SSL_get_peer_cert_chain(ssl)) {
  17334. auto count = sk_X509_num(sk);
  17335. for (decltype(count) i = 0; i < count; i++) {
  17336. auto x509 = sk_X509_value(sk, i);
  17337. X509_up_ref(x509);
  17338. certs.push_back(static_cast<cert_t>(x509));
  17339. }
  17340. }
  17341. return certs.size();
  17342. }
  17343. inline void free_cert(cert_t cert) {
  17344. if (cert) { X509_free(static_cast<X509 *>(cert)); }
  17345. }
  17346. inline bool verify_hostname(cert_t cert, const char *hostname) {
  17347. if (!cert || !hostname) return false;
  17348. auto x509 = static_cast<X509 *>(cert);
  17349. // Use X509_check_ip_asc for IP addresses, X509_check_host for DNS names
  17350. if (detail::is_ip_address(hostname)) {
  17351. return X509_check_ip_asc(x509, hostname, 0) == 1;
  17352. }
  17353. return X509_check_host(x509, hostname, strlen(hostname), 0, nullptr) == 1;
  17354. }
  17355. inline uint64_t hostname_mismatch_code() {
  17356. return static_cast<uint64_t>(X509_V_ERR_HOSTNAME_MISMATCH);
  17357. }
  17358. inline long get_verify_result(const_session_t session) {
  17359. if (!session) return X509_V_ERR_UNSPECIFIED;
  17360. return SSL_get_verify_result(static_cast<SSL *>(const_cast<void *>(session)));
  17361. }
  17362. inline std::string get_cert_subject_cn(cert_t cert) {
  17363. if (!cert) return "";
  17364. auto x509 = static_cast<X509 *>(cert);
  17365. auto subject_name = X509_get_subject_name(x509);
  17366. if (!subject_name) return "";
  17367. // X509_NAME_get_text_by_NID is deprecated since OpenSSL 4.0
  17368. auto idx = X509_NAME_get_index_by_NID(subject_name, NID_commonName, -1);
  17369. if (idx < 0) return "";
  17370. auto entry = X509_NAME_get_entry(subject_name, idx);
  17371. if (!entry) return "";
  17372. auto data = X509_NAME_ENTRY_get_data(entry);
  17373. if (!data) return "";
  17374. return std::string(
  17375. reinterpret_cast<const char *>(ASN1_STRING_get0_data(data)),
  17376. static_cast<size_t>(ASN1_STRING_length(data)));
  17377. }
  17378. inline std::string get_cert_issuer_name(cert_t cert) {
  17379. if (!cert) return "";
  17380. auto x509 = static_cast<X509 *>(cert);
  17381. auto issuer_name = X509_get_issuer_name(x509);
  17382. if (!issuer_name) return "";
  17383. char buf[256];
  17384. X509_NAME_oneline(issuer_name, buf, sizeof(buf));
  17385. return std::string(buf);
  17386. }
  17387. inline bool get_cert_sans(cert_t cert, std::vector<SanEntry> &sans) {
  17388. sans.clear();
  17389. if (!cert) return false;
  17390. auto x509 = static_cast<X509 *>(cert);
  17391. auto names = static_cast<GENERAL_NAMES *>(
  17392. X509_get_ext_d2i(x509, NID_subject_alt_name, nullptr, nullptr));
  17393. if (!names) return true; // No SANs is valid
  17394. auto count = sk_GENERAL_NAME_num(names);
  17395. for (decltype(count) i = 0; i < count; i++) {
  17396. auto gen = sk_GENERAL_NAME_value(names, i);
  17397. if (!gen) continue;
  17398. SanEntry entry;
  17399. switch (gen->type) {
  17400. case GEN_DNS:
  17401. entry.type = SanType::DNS;
  17402. if (gen->d.dNSName) {
  17403. entry.value = std::string(
  17404. reinterpret_cast<const char *>(
  17405. ASN1_STRING_get0_data(gen->d.dNSName)),
  17406. static_cast<size_t>(ASN1_STRING_length(gen->d.dNSName)));
  17407. }
  17408. break;
  17409. case GEN_IPADD:
  17410. entry.type = SanType::IP;
  17411. if (gen->d.iPAddress) {
  17412. auto data = ASN1_STRING_get0_data(gen->d.iPAddress);
  17413. auto len = ASN1_STRING_length(gen->d.iPAddress);
  17414. if (len == 4) {
  17415. // IPv4
  17416. char buf[INET_ADDRSTRLEN];
  17417. inet_ntop(AF_INET, data, buf, sizeof(buf));
  17418. entry.value = buf;
  17419. } else if (len == 16) {
  17420. // IPv6
  17421. char buf[INET6_ADDRSTRLEN];
  17422. inet_ntop(AF_INET6, data, buf, sizeof(buf));
  17423. entry.value = buf;
  17424. }
  17425. }
  17426. break;
  17427. case GEN_EMAIL:
  17428. entry.type = SanType::EMAIL;
  17429. if (gen->d.rfc822Name) {
  17430. entry.value = std::string(
  17431. reinterpret_cast<const char *>(
  17432. ASN1_STRING_get0_data(gen->d.rfc822Name)),
  17433. static_cast<size_t>(ASN1_STRING_length(gen->d.rfc822Name)));
  17434. }
  17435. break;
  17436. case GEN_URI:
  17437. entry.type = SanType::URI;
  17438. if (gen->d.uniformResourceIdentifier) {
  17439. entry.value = std::string(
  17440. reinterpret_cast<const char *>(
  17441. ASN1_STRING_get0_data(gen->d.uniformResourceIdentifier)),
  17442. static_cast<size_t>(
  17443. ASN1_STRING_length(gen->d.uniformResourceIdentifier)));
  17444. }
  17445. break;
  17446. default: entry.type = SanType::OTHER; break;
  17447. }
  17448. if (!entry.value.empty()) { sans.push_back(std::move(entry)); }
  17449. }
  17450. GENERAL_NAMES_free(names);
  17451. return true;
  17452. }
  17453. inline bool get_cert_validity(cert_t cert, time_t &not_before,
  17454. time_t &not_after) {
  17455. if (!cert) return false;
  17456. auto x509 = static_cast<X509 *>(cert);
  17457. auto nb = X509_get0_notBefore(x509);
  17458. auto na = X509_get0_notAfter(x509);
  17459. if (!nb || !na) return false;
  17460. ASN1_TIME *epoch = ASN1_TIME_new();
  17461. if (!epoch) return false;
  17462. auto se = detail::scope_exit([&] { ASN1_TIME_free(epoch); });
  17463. if (!ASN1_TIME_set(epoch, 0)) return false;
  17464. int pday, psec;
  17465. if (!ASN1_TIME_diff(&pday, &psec, epoch, nb)) return false;
  17466. not_before = 86400 * (time_t)pday + psec;
  17467. if (!ASN1_TIME_diff(&pday, &psec, epoch, na)) return false;
  17468. not_after = 86400 * (time_t)pday + psec;
  17469. return true;
  17470. }
  17471. inline std::string get_cert_serial(cert_t cert) {
  17472. if (!cert) return "";
  17473. auto x509 = static_cast<X509 *>(cert);
  17474. auto serial = X509_get_serialNumber(x509);
  17475. if (!serial) return "";
  17476. auto bn = ASN1_INTEGER_to_BN(serial, nullptr);
  17477. if (!bn) return "";
  17478. auto hex = BN_bn2hex(bn);
  17479. BN_free(bn);
  17480. if (!hex) return "";
  17481. std::string result(hex);
  17482. OPENSSL_free(hex);
  17483. return result;
  17484. }
  17485. inline bool get_cert_der(cert_t cert, std::vector<unsigned char> &der) {
  17486. if (!cert) return false;
  17487. auto x509 = static_cast<X509 *>(cert);
  17488. auto len = i2d_X509(x509, nullptr);
  17489. if (len < 0) return false;
  17490. der.resize(static_cast<size_t>(len));
  17491. auto p = der.data();
  17492. i2d_X509(x509, &p);
  17493. return true;
  17494. }
  17495. inline const char *get_sni(const_session_t session) {
  17496. if (!session) return nullptr;
  17497. auto ssl = static_cast<SSL *>(const_cast<void *>(session));
  17498. return SSL_get_servername(ssl, TLSEXT_NAMETYPE_host_name);
  17499. }
  17500. inline uint64_t peek_error() { return ERR_peek_last_error(); }
  17501. inline uint64_t get_error() { return ERR_get_error(); }
  17502. inline std::string error_string(uint64_t code) {
  17503. char buf[256];
  17504. ERR_error_string_n(static_cast<decltype(ERR_get_error())>(code), buf,
  17505. sizeof(buf));
  17506. return std::string(buf);
  17507. }
  17508. inline ca_store_t create_ca_store(const char *pem, size_t len) {
  17509. auto mem = BIO_new_mem_buf(pem, static_cast<int>(len));
  17510. if (!mem) { return nullptr; }
  17511. auto mem_guard = detail::scope_exit([&] { BIO_free_all(mem); });
  17512. auto inf = PEM_X509_INFO_read_bio(mem, nullptr, nullptr, nullptr);
  17513. if (!inf) { return nullptr; }
  17514. auto store = X509_STORE_new();
  17515. if (store) {
  17516. auto count = sk_X509_INFO_num(inf);
  17517. for (decltype(count) i = 0; i < count; i++) {
  17518. auto itmp = sk_X509_INFO_value(inf, i);
  17519. if (!itmp) { continue; }
  17520. if (itmp->x509) { X509_STORE_add_cert(store, itmp->x509); }
  17521. if (itmp->crl) { X509_STORE_add_crl(store, itmp->crl); }
  17522. }
  17523. }
  17524. sk_X509_INFO_pop_free(inf, X509_INFO_free);
  17525. return static_cast<ca_store_t>(store);
  17526. }
  17527. inline void free_ca_store(ca_store_t store) {
  17528. if (store) { X509_STORE_free(static_cast<X509_STORE *>(store)); }
  17529. }
  17530. inline bool set_ca_store(ctx_t ctx, ca_store_t store) {
  17531. if (!ctx || !store) { return false; }
  17532. auto ssl_ctx = static_cast<SSL_CTX *>(ctx);
  17533. auto x509_store = static_cast<X509_STORE *>(store);
  17534. // Check if same store is already set
  17535. if (SSL_CTX_get_cert_store(ssl_ctx) == x509_store) { return true; }
  17536. // SSL_CTX_set_cert_store takes ownership and frees the old store
  17537. SSL_CTX_set_cert_store(ssl_ctx, x509_store);
  17538. return true;
  17539. }
  17540. inline size_t get_ca_certs(ctx_t ctx, std::vector<cert_t> &certs) {
  17541. certs.clear();
  17542. if (!ctx) { return 0; }
  17543. auto ssl_ctx = static_cast<SSL_CTX *>(ctx);
  17544. auto store = SSL_CTX_get_cert_store(ssl_ctx);
  17545. if (!store) { return 0; }
  17546. auto objs = impl::get_store_objects(store);
  17547. if (!objs) { return 0; }
  17548. auto se = detail::scope_exit([&] { impl::release_store_objects(objs); });
  17549. auto count = sk_X509_OBJECT_num(objs);
  17550. for (decltype(count) i = 0; i < count; i++) {
  17551. auto obj = sk_X509_OBJECT_value(objs, i);
  17552. if (!obj) { continue; }
  17553. if (X509_OBJECT_get_type(obj) == X509_LU_X509) {
  17554. auto x509 = X509_OBJECT_get0_X509(obj);
  17555. if (x509) {
  17556. // Increment reference count so caller can free it
  17557. X509_up_ref(x509);
  17558. certs.push_back(static_cast<cert_t>(x509));
  17559. }
  17560. }
  17561. }
  17562. return certs.size();
  17563. }
  17564. inline std::vector<std::string> get_ca_names(ctx_t ctx) {
  17565. std::vector<std::string> names;
  17566. if (!ctx) { return names; }
  17567. auto ssl_ctx = static_cast<SSL_CTX *>(ctx);
  17568. auto store = SSL_CTX_get_cert_store(ssl_ctx);
  17569. if (!store) { return names; }
  17570. auto objs = impl::get_store_objects(store);
  17571. if (!objs) { return names; }
  17572. auto se = detail::scope_exit([&] { impl::release_store_objects(objs); });
  17573. auto count = sk_X509_OBJECT_num(objs);
  17574. for (decltype(count) i = 0; i < count; i++) {
  17575. auto obj = sk_X509_OBJECT_value(objs, i);
  17576. if (!obj) { continue; }
  17577. if (X509_OBJECT_get_type(obj) == X509_LU_X509) {
  17578. auto x509 = X509_OBJECT_get0_X509(obj);
  17579. if (x509) {
  17580. auto subject = X509_get_subject_name(x509);
  17581. if (subject) {
  17582. char buf[512];
  17583. X509_NAME_oneline(subject, buf, sizeof(buf));
  17584. names.push_back(buf);
  17585. }
  17586. }
  17587. }
  17588. }
  17589. return names;
  17590. }
  17591. inline bool update_server_cert(ctx_t ctx, const char *cert_pem,
  17592. const char *key_pem, const char *password) {
  17593. if (!ctx || !cert_pem || !key_pem) { return false; }
  17594. auto ssl_ctx = static_cast<SSL_CTX *>(ctx);
  17595. // Load certificate from PEM
  17596. auto cert_bio = BIO_new_mem_buf(cert_pem, -1);
  17597. if (!cert_bio) { return false; }
  17598. auto cert = PEM_read_bio_X509(cert_bio, nullptr, nullptr, nullptr);
  17599. BIO_free(cert_bio);
  17600. if (!cert) { return false; }
  17601. // Load private key from PEM
  17602. auto key_bio = BIO_new_mem_buf(key_pem, -1);
  17603. if (!key_bio) {
  17604. X509_free(cert);
  17605. return false;
  17606. }
  17607. auto key = PEM_read_bio_PrivateKey(key_bio, nullptr, nullptr,
  17608. password ? const_cast<char *>(password)
  17609. : nullptr);
  17610. BIO_free(key_bio);
  17611. if (!key) {
  17612. X509_free(cert);
  17613. return false;
  17614. }
  17615. // Update certificate and key
  17616. auto ret = SSL_CTX_use_certificate(ssl_ctx, cert) == 1 &&
  17617. SSL_CTX_use_PrivateKey(ssl_ctx, key) == 1;
  17618. X509_free(cert);
  17619. EVP_PKEY_free(key);
  17620. return ret;
  17621. }
  17622. inline bool update_server_client_ca(ctx_t ctx, const char *ca_pem) {
  17623. if (!ctx || !ca_pem) { return false; }
  17624. auto ssl_ctx = static_cast<SSL_CTX *>(ctx);
  17625. // Create new X509_STORE from PEM
  17626. auto store = create_ca_store(ca_pem, strlen(ca_pem));
  17627. if (!store) { return false; }
  17628. // A resumed session is not verified again, so the ticket keys from before
  17629. // go, or a client verified under the old CAs could go on resuming.
  17630. #if defined(OPENSSL_IS_BORINGSSL) || defined(LIBRESSL_VERSION_NUMBER)
  17631. unsigned char ticket_keys[48];
  17632. #else
  17633. unsigned char ticket_keys[80];
  17634. #endif
  17635. if (RAND_bytes(ticket_keys, sizeof(ticket_keys)) != 1 ||
  17636. SSL_CTX_set_tlsext_ticket_keys(ssl_ctx, ticket_keys,
  17637. sizeof(ticket_keys)) != 1) {
  17638. free_ca_store(store);
  17639. return false;
  17640. }
  17641. // SSL_CTX_set_cert_store takes ownership
  17642. SSL_CTX_set_cert_store(ssl_ctx, static_cast<X509_STORE *>(store));
  17643. // Set client CA list for client certificate request
  17644. auto ca_list = impl::create_client_ca_list_from_pem(ca_pem);
  17645. if (ca_list) {
  17646. // SSL_CTX_set_client_CA_list takes ownership of ca_list
  17647. SSL_CTX_set_client_CA_list(ssl_ctx, ca_list);
  17648. }
  17649. // The cached sessions go for the same reason.
  17650. #if OPENSSL_VERSION_NUMBER >= 0x30400000L
  17651. SSL_CTX_flush_sessions_ex(ssl_ctx, (std::numeric_limits<time_t>::max)());
  17652. #else
  17653. SSL_CTX_flush_sessions(ssl_ctx, (std::numeric_limits<long>::max)());
  17654. #endif
  17655. return true;
  17656. }
  17657. inline bool set_verify_callback(ctx_t ctx, VerifyCallback callback) {
  17658. if (!ctx) { return false; }
  17659. auto ssl_ctx = static_cast<SSL_CTX *>(ctx);
  17660. auto index = impl::verify_callback_index();
  17661. if (index < 0) { return false; }
  17662. std::shared_ptr<VerifyCallback> *stored = nullptr;
  17663. if (callback) {
  17664. stored = new std::shared_ptr<VerifyCallback>(
  17665. std::make_shared<VerifyCallback>(std::move(callback)));
  17666. }
  17667. std::shared_ptr<VerifyCallback> *previous = nullptr;
  17668. {
  17669. std::lock_guard<std::mutex> guard(impl::verify_callback_mutex());
  17670. previous = static_cast<std::shared_ptr<VerifyCallback> *>(
  17671. SSL_CTX_get_ex_data(ssl_ctx, index));
  17672. if (SSL_CTX_set_ex_data(ssl_ctx, index, stored) != 1) {
  17673. delete stored;
  17674. return false;
  17675. }
  17676. }
  17677. // A handshake running the previous callback keeps it until it returns.
  17678. delete previous;
  17679. // A resumed handshake shows no certificate to run the callback on.
  17680. if (stored) {
  17681. SSL_CTX_set_options(ssl_ctx, SSL_OP_NO_TICKET);
  17682. SSL_CTX_set_session_cache_mode(ssl_ctx, SSL_SESS_CACHE_OFF);
  17683. #if !defined(OPENSSL_IS_BORINGSSL) && !defined(LIBRESSL_VERSION_NUMBER)
  17684. // TLS 1.3 tickets, which SSL_OP_NO_TICKET leaves on
  17685. SSL_CTX_set_num_tickets(ssl_ctx, 0);
  17686. #endif
  17687. }
  17688. // Keep requiring the peer's certificate if set_verify_client() asked for it
  17689. auto require =
  17690. (SSL_CTX_get_verify_mode(ssl_ctx) & SSL_VERIFY_FAIL_IF_NO_PEER_CERT) != 0;
  17691. impl::apply_verify_mode(ssl_ctx, require);
  17692. return true;
  17693. }
  17694. inline long get_verify_error(const_session_t session) {
  17695. if (!session) { return -1; }
  17696. auto ssl = static_cast<SSL *>(const_cast<void *>(session));
  17697. return SSL_get_verify_result(ssl);
  17698. }
  17699. inline std::string verify_error_string(long error_code) {
  17700. if (error_code == X509_V_OK) { return ""; }
  17701. const char *str = X509_verify_cert_error_string(static_cast<int>(error_code));
  17702. return str ? str : "unknown error";
  17703. }
  17704. } // namespace tls
  17705. #endif // CPPHTTPLIB_OPENSSL_SUPPORT
  17706. /*
  17707. * Group 9: TLS abstraction layer - Mbed TLS backend
  17708. */
  17709. /*
  17710. * Mbed TLS Backend Implementation
  17711. */
  17712. #ifdef CPPHTTPLIB_MBEDTLS_SUPPORT
  17713. namespace tls {
  17714. namespace impl {
  17715. // Mbed TLS session wrapper
  17716. struct MbedTlsSession {
  17717. mbedtls_ssl_context ssl;
  17718. socket_t sock = INVALID_SOCKET;
  17719. std::string hostname; // For client: set via set_sni
  17720. std::string sni_hostname; // For server: received from client via SNI callback
  17721. // Mbed TLS has no SSL_peek() equivalent, so is_peer_closed() must probe with
  17722. // a real 1-byte mbedtls_ssl_read(). If that probe lands on application data
  17723. // (e.g. a response that arrived while this side was still in its post-write
  17724. // check), the byte is pushed back here and served by the next read().
  17725. unsigned char peeked_byte = 0;
  17726. bool has_peeked_byte = false;
  17727. // Set by set_sni() when the caller disabled hostname verification, so the
  17728. // verify callback can clear the CN/SAN mismatch flag while still enforcing
  17729. // the rest of the chain (Mbed TLS ties SNI and identity checking together;
  17730. // OpenSSL and wolfSSL keep them independent).
  17731. bool suppress_hostname_mismatch = false;
  17732. // Copied from the owning MbedTlsContext at creation, so a handshake only
  17733. // ever runs the callback of its own context.
  17734. VerifyCallback verify_callback;
  17735. bool is_server = false;
  17736. MbedTlsSession() { mbedtls_ssl_init(&ssl); }
  17737. ~MbedTlsSession() { mbedtls_ssl_free(&ssl); }
  17738. MbedTlsSession(const MbedTlsSession &) = delete;
  17739. MbedTlsSession &operator=(const MbedTlsSession &) = delete;
  17740. };
  17741. // Thread-local error code accessor for Mbed TLS (since it doesn't have an error
  17742. // queue)
  17743. inline int &mbedtls_last_error() {
  17744. static thread_local int err = 0;
  17745. return err;
  17746. }
  17747. // Helper to map Mbed TLS error to ErrorCode
  17748. inline ErrorCode map_mbedtls_error(int ret, int &out_errno,
  17749. uint32_t verify_flags) {
  17750. if (ret == 0) { return ErrorCode::Success; }
  17751. if (ret == MBEDTLS_ERR_SSL_WANT_READ) { return ErrorCode::WantRead; }
  17752. if (ret == MBEDTLS_ERR_SSL_WANT_WRITE) { return ErrorCode::WantWrite; }
  17753. if (ret == MBEDTLS_ERR_SSL_PEER_CLOSE_NOTIFY) {
  17754. return ErrorCode::PeerClosed;
  17755. }
  17756. if (ret == MBEDTLS_ERR_NET_CONN_RESET || ret == MBEDTLS_ERR_NET_SEND_FAILED ||
  17757. ret == MBEDTLS_ERR_NET_RECV_FAILED) {
  17758. out_errno = errno;
  17759. return ErrorCode::SyscallError;
  17760. }
  17761. if (ret == MBEDTLS_ERR_X509_CERT_VERIFY_FAILED) {
  17762. // Unlike OpenSSL/wolfSSL, Mbed TLS folds the CN/SAN identity check into
  17763. // the handshake's chain verification (see set_sni()); a mismatch there
  17764. // is reported the same way as any other verify_flags bit. Report it as
  17765. // HostnameMismatch, matching the other backends and the post-handshake
  17766. // identity check below, but only when naming is the sole problem -
  17767. // if the chain itself is also untrusted/expired/etc., that takes
  17768. // priority over the naming detail.
  17769. if (verify_flags == static_cast<uint32_t>(hostname_mismatch_code())) {
  17770. return ErrorCode::HostnameMismatch;
  17771. }
  17772. return ErrorCode::CertVerifyFailed;
  17773. }
  17774. return ErrorCode::Fatal;
  17775. }
  17776. // Populates a TlsError from a failed (non-zero) mbedtls_ssl_handshake()
  17777. // return value, including the verify-flags-dependent HostnameMismatch
  17778. // mapping; shared by connect() and connect_nonblocking() so the
  17779. // backend_code policy for that mapping only lives in one place.
  17780. inline void fill_mbedtls_tls_error(TlsError &err, mbedtls_ssl_context &ssl,
  17781. int ret) {
  17782. auto verify_flags = mbedtls_ssl_get_verify_result(&ssl);
  17783. err.code = map_mbedtls_error(ret, err.sys_errno, verify_flags);
  17784. err.backend_code = err.code == ErrorCode::HostnameMismatch
  17785. ? static_cast<uint64_t>(verify_flags)
  17786. : static_cast<uint64_t>(-ret);
  17787. }
  17788. // A TLS 1.3 NewSessionTicket (signaled by default on Mbed TLS 4.x) is a
  17789. // non-fatal notification delivered between records, not an error and not
  17790. // application data, so I/O calls that see it should just be retried. Kept in
  17791. // one helper so the retry loops keep an intact "do { } while (...)" instead of
  17792. // splitting the closing brace across an #if.
  17793. inline bool mbedtls_is_session_ticket(int ret) {
  17794. #if defined(MBEDTLS_ERR_SSL_RECEIVED_NEW_SESSION_TICKET)
  17795. return ret == MBEDTLS_ERR_SSL_RECEIVED_NEW_SESSION_TICKET;
  17796. #else
  17797. (void)ret;
  17798. return false;
  17799. #endif
  17800. }
  17801. // BIO-like send callback for Mbed TLS
  17802. inline int mbedtls_net_send_cb(void *ctx, const unsigned char *buf,
  17803. size_t len) {
  17804. auto sock = *static_cast<socket_t *>(ctx);
  17805. #ifdef _WIN32
  17806. auto ret =
  17807. send(sock, reinterpret_cast<const char *>(buf), static_cast<int>(len), 0);
  17808. if (ret == SOCKET_ERROR) {
  17809. int err = WSAGetLastError();
  17810. if (err == WSAEWOULDBLOCK) { return MBEDTLS_ERR_SSL_WANT_WRITE; }
  17811. return MBEDTLS_ERR_NET_SEND_FAILED;
  17812. }
  17813. #else
  17814. auto ret = send(sock, buf, len, 0);
  17815. if (ret < 0) {
  17816. if (errno == EAGAIN || errno == EWOULDBLOCK) {
  17817. return MBEDTLS_ERR_SSL_WANT_WRITE;
  17818. }
  17819. return MBEDTLS_ERR_NET_SEND_FAILED;
  17820. }
  17821. #endif
  17822. return static_cast<int>(ret);
  17823. }
  17824. // BIO-like recv callback for Mbed TLS
  17825. inline int mbedtls_net_recv_cb(void *ctx, unsigned char *buf, size_t len) {
  17826. auto sock = *static_cast<socket_t *>(ctx);
  17827. #ifdef _WIN32
  17828. auto ret =
  17829. recv(sock, reinterpret_cast<char *>(buf), static_cast<int>(len), 0);
  17830. if (ret == SOCKET_ERROR) {
  17831. int err = WSAGetLastError();
  17832. if (err == WSAEWOULDBLOCK) { return MBEDTLS_ERR_SSL_WANT_READ; }
  17833. return MBEDTLS_ERR_NET_RECV_FAILED;
  17834. }
  17835. #else
  17836. auto ret = recv(sock, buf, len, 0);
  17837. if (ret < 0) {
  17838. if (errno == EAGAIN || errno == EWOULDBLOCK) {
  17839. return MBEDTLS_ERR_SSL_WANT_READ;
  17840. }
  17841. return MBEDTLS_ERR_NET_RECV_FAILED;
  17842. }
  17843. #endif
  17844. if (ret == 0) { return MBEDTLS_ERR_SSL_PEER_CLOSE_NOTIFY; }
  17845. return static_cast<int>(ret);
  17846. }
  17847. // MbedTlsContext constructor/destructor implementations
  17848. inline MbedTlsContext::MbedTlsContext() {
  17849. mbedtls_ssl_config_init(&conf);
  17850. #ifndef CPPHTTPLIB_MBEDTLS_V4
  17851. mbedtls_entropy_init(&entropy);
  17852. mbedtls_ctr_drbg_init(&ctr_drbg);
  17853. #endif
  17854. mbedtls_x509_crt_init(&ca_chain);
  17855. mbedtls_x509_crt_init(&own_cert);
  17856. mbedtls_pk_init(&own_key);
  17857. }
  17858. inline MbedTlsContext::~MbedTlsContext() {
  17859. mbedtls_pk_free(&own_key);
  17860. mbedtls_x509_crt_free(&own_cert);
  17861. mbedtls_x509_crt_free(&ca_chain);
  17862. #ifndef CPPHTTPLIB_MBEDTLS_V4
  17863. mbedtls_ctr_drbg_free(&ctr_drbg);
  17864. mbedtls_entropy_free(&entropy);
  17865. #endif
  17866. mbedtls_ssl_config_free(&conf);
  17867. }
  17868. // Thread-local storage for SNI captured during handshake
  17869. // This is needed because the SNI callback doesn't have a way to pass
  17870. // session-specific data before the session is fully set up
  17871. inline std::string &mbedpending_sni() {
  17872. static thread_local std::string sni;
  17873. return sni;
  17874. }
  17875. // SNI callback for Mbed TLS server to capture client's SNI hostname
  17876. inline int mbedtls_sni_callback(void *p_ctx, mbedtls_ssl_context *ssl,
  17877. const unsigned char *name, size_t name_len) {
  17878. (void)p_ctx;
  17879. (void)ssl;
  17880. // Store SNI name in thread-local storage
  17881. // It will be retrieved and stored in the session after handshake
  17882. if (name && name_len > 0) {
  17883. mbedpending_sni().assign(reinterpret_cast<const char *>(name), name_len);
  17884. } else {
  17885. mbedpending_sni().clear();
  17886. }
  17887. return 0; // Accept any SNI
  17888. }
  17889. inline void mbedtls_clear_cn_mismatch(uint32_t *flags) {
  17890. *flags &= ~static_cast<uint32_t>(hostname_mismatch_code());
  17891. }
  17892. // MbedTLS verify callback wrapper
  17893. inline int mbedtls_verify_callback(void *data, mbedtls_x509_crt *crt,
  17894. int cert_depth, uint32_t *flags) {
  17895. // data points to the MbedTlsSession
  17896. auto *session = static_cast<MbedTlsSession *>(data);
  17897. // set_sni() disabled hostname verification for this session: ignore the
  17898. // CN/SAN mismatch flag, as the OpenSSL/wolfSSL backends do. The final
  17899. // pass/fail decision still comes from the remaining flags (and, below, from
  17900. // the user's own verify callback).
  17901. if (session->suppress_hostname_mismatch) { mbedtls_clear_cn_mismatch(flags); }
  17902. const auto &callback = session->verify_callback;
  17903. if (!callback) { return 0; } // Continue with default verification
  17904. // Build context
  17905. VerifyContext verify_ctx;
  17906. verify_ctx.session = static_cast<session_t>(session);
  17907. verify_ctx.cert = static_cast<cert_t>(crt);
  17908. verify_ctx.depth = cert_depth;
  17909. verify_ctx.preverify_ok = (*flags == 0);
  17910. verify_ctx.error_code = static_cast<long>(*flags);
  17911. // Convert Mbed TLS flags to error string
  17912. static thread_local char error_buf[256];
  17913. if (*flags != 0) {
  17914. mbedtls_x509_crt_verify_info(error_buf, sizeof(error_buf), "", *flags);
  17915. verify_ctx.error_string = error_buf;
  17916. } else {
  17917. verify_ctx.error_string = nullptr;
  17918. }
  17919. bool accepted = run_verify_callback(callback, verify_ctx);
  17920. if (accepted) {
  17921. // Overrides the built-in verification only on a server, as on OpenSSL and
  17922. // wolfSSL, whose clients check the verify result after the handshake
  17923. if (session->is_server) { *flags = 0; }
  17924. return 0;
  17925. }
  17926. return MBEDTLS_ERR_X509_CERT_VERIFY_FAILED;
  17927. }
  17928. // Sets the authentication mode from whether the peer's certificate is required
  17929. // and whether a verify callback is set. OPTIONAL lets the callback run even if
  17930. // verification is not required (matching OpenSSL's SSL_VERIFY_PEER).
  17931. inline void apply_verify_mode(MbedTlsContext &mctx) {
  17932. auto mode = MBEDTLS_SSL_VERIFY_NONE;
  17933. if (mctx.verify_client) {
  17934. mode = MBEDTLS_SSL_VERIFY_REQUIRED;
  17935. } else if (mctx.verify_callback) {
  17936. mode = MBEDTLS_SSL_VERIFY_OPTIONAL;
  17937. }
  17938. mbedtls_ssl_conf_authmode(&mctx.conf, mode);
  17939. }
  17940. } // namespace impl
  17941. inline ctx_t create_client_context() {
  17942. auto ctx = new (std::nothrow) impl::MbedTlsContext();
  17943. if (!ctx) { return nullptr; }
  17944. ctx->is_server = false;
  17945. #ifdef CPPHTTPLIB_MBEDTLS_V4
  17946. // Mbed TLS 4.x draws randomness from PSA Crypto; just ensure it is ready.
  17947. if (!detail::ensure_mbedtls_psa_crypto()) {
  17948. delete ctx;
  17949. return nullptr;
  17950. }
  17951. int ret;
  17952. #else
  17953. // Seed the random number generator
  17954. const char *pers = "httplib_client";
  17955. int ret = mbedtls_ctr_drbg_seed(
  17956. &ctx->ctr_drbg, mbedtls_entropy_func, &ctx->entropy,
  17957. reinterpret_cast<const unsigned char *>(pers), strlen(pers));
  17958. if (ret != 0) {
  17959. impl::mbedtls_last_error() = ret;
  17960. delete ctx;
  17961. return nullptr;
  17962. }
  17963. #endif
  17964. // Set up SSL config for client
  17965. ret = mbedtls_ssl_config_defaults(&ctx->conf, MBEDTLS_SSL_IS_CLIENT,
  17966. MBEDTLS_SSL_TRANSPORT_STREAM,
  17967. MBEDTLS_SSL_PRESET_DEFAULT);
  17968. if (ret != 0) {
  17969. impl::mbedtls_last_error() = ret;
  17970. delete ctx;
  17971. return nullptr;
  17972. }
  17973. #ifndef CPPHTTPLIB_MBEDTLS_V4
  17974. // Set random number generator (Mbed TLS 4.x uses the PSA RNG implicitly)
  17975. mbedtls_ssl_conf_rng(&ctx->conf, mbedtls_ctr_drbg_random, &ctx->ctr_drbg);
  17976. #endif
  17977. // Default: verify peer certificate
  17978. ctx->verify_client = true;
  17979. impl::apply_verify_mode(*ctx);
  17980. // Set minimum TLS version to 1.2
  17981. #ifdef CPPHTTPLIB_MBEDTLS_V3
  17982. mbedtls_ssl_conf_min_tls_version(&ctx->conf, MBEDTLS_SSL_VERSION_TLS1_2);
  17983. #else
  17984. mbedtls_ssl_conf_min_version(&ctx->conf, MBEDTLS_SSL_MAJOR_VERSION_3,
  17985. MBEDTLS_SSL_MINOR_VERSION_3);
  17986. #endif
  17987. return static_cast<ctx_t>(ctx);
  17988. }
  17989. inline ctx_t create_server_context() {
  17990. auto ctx = new (std::nothrow) impl::MbedTlsContext();
  17991. if (!ctx) { return nullptr; }
  17992. ctx->is_server = true;
  17993. #ifdef CPPHTTPLIB_MBEDTLS_V4
  17994. // Mbed TLS 4.x draws randomness from PSA Crypto; just ensure it is ready.
  17995. if (!detail::ensure_mbedtls_psa_crypto()) {
  17996. delete ctx;
  17997. return nullptr;
  17998. }
  17999. int ret;
  18000. #else
  18001. // Seed the random number generator
  18002. const char *pers = "httplib_server";
  18003. int ret = mbedtls_ctr_drbg_seed(
  18004. &ctx->ctr_drbg, mbedtls_entropy_func, &ctx->entropy,
  18005. reinterpret_cast<const unsigned char *>(pers), strlen(pers));
  18006. if (ret != 0) {
  18007. impl::mbedtls_last_error() = ret;
  18008. delete ctx;
  18009. return nullptr;
  18010. }
  18011. #endif
  18012. // Set up SSL config for server
  18013. ret = mbedtls_ssl_config_defaults(&ctx->conf, MBEDTLS_SSL_IS_SERVER,
  18014. MBEDTLS_SSL_TRANSPORT_STREAM,
  18015. MBEDTLS_SSL_PRESET_DEFAULT);
  18016. if (ret != 0) {
  18017. impl::mbedtls_last_error() = ret;
  18018. delete ctx;
  18019. return nullptr;
  18020. }
  18021. #ifndef CPPHTTPLIB_MBEDTLS_V4
  18022. // Set random number generator (Mbed TLS 4.x uses the PSA RNG implicitly)
  18023. mbedtls_ssl_conf_rng(&ctx->conf, mbedtls_ctr_drbg_random, &ctx->ctr_drbg);
  18024. #endif
  18025. // Default: don't verify client
  18026. impl::apply_verify_mode(*ctx);
  18027. // Set minimum TLS version to 1.2
  18028. #ifdef CPPHTTPLIB_MBEDTLS_V3
  18029. mbedtls_ssl_conf_min_tls_version(&ctx->conf, MBEDTLS_SSL_VERSION_TLS1_2);
  18030. #else
  18031. mbedtls_ssl_conf_min_version(&ctx->conf, MBEDTLS_SSL_MAJOR_VERSION_3,
  18032. MBEDTLS_SSL_MINOR_VERSION_3);
  18033. #endif
  18034. // Set SNI callback to capture client's SNI hostname
  18035. mbedtls_ssl_conf_sni(&ctx->conf, impl::mbedtls_sni_callback, nullptr);
  18036. return static_cast<ctx_t>(ctx);
  18037. }
  18038. inline void free_context(ctx_t ctx) {
  18039. if (ctx) { delete static_cast<impl::MbedTlsContext *>(ctx); }
  18040. }
  18041. inline bool set_min_version(ctx_t ctx, Version version) {
  18042. if (!ctx) { return false; }
  18043. auto mctx = static_cast<impl::MbedTlsContext *>(ctx);
  18044. #ifdef CPPHTTPLIB_MBEDTLS_V3
  18045. // Mbed TLS 3.x uses mbedtls_ssl_protocol_version enum
  18046. mbedtls_ssl_protocol_version min_ver = MBEDTLS_SSL_VERSION_TLS1_2;
  18047. if (version >= Version::TLS1_3) {
  18048. #if defined(MBEDTLS_SSL_PROTO_TLS1_3)
  18049. min_ver = MBEDTLS_SSL_VERSION_TLS1_3;
  18050. #endif
  18051. }
  18052. mbedtls_ssl_conf_min_tls_version(&mctx->conf, min_ver);
  18053. #else
  18054. // Mbed TLS 2.x uses major/minor version numbers
  18055. int major = MBEDTLS_SSL_MAJOR_VERSION_3;
  18056. int minor = MBEDTLS_SSL_MINOR_VERSION_3; // TLS 1.2
  18057. if (version >= Version::TLS1_3) {
  18058. #if defined(MBEDTLS_SSL_PROTO_TLS1_3)
  18059. minor = MBEDTLS_SSL_MINOR_VERSION_4; // TLS 1.3
  18060. #else
  18061. minor = MBEDTLS_SSL_MINOR_VERSION_3; // Fall back to TLS 1.2
  18062. #endif
  18063. }
  18064. mbedtls_ssl_conf_min_version(&mctx->conf, major, minor);
  18065. #endif
  18066. return true;
  18067. }
  18068. inline bool load_ca_pem(ctx_t ctx, const char *pem, size_t len) {
  18069. if (!ctx || !pem) { return false; }
  18070. auto mctx = static_cast<impl::MbedTlsContext *>(ctx);
  18071. // mbedtls_x509_crt_parse expects null-terminated string for PEM
  18072. // Add null terminator if not present
  18073. std::string pem_str(pem, len);
  18074. int ret = mbedtls_x509_crt_parse(
  18075. &mctx->ca_chain, reinterpret_cast<const unsigned char *>(pem_str.c_str()),
  18076. pem_str.size() + 1);
  18077. if (ret != 0) {
  18078. impl::mbedtls_last_error() = ret;
  18079. return false;
  18080. }
  18081. mbedtls_ssl_conf_ca_chain(&mctx->conf, &mctx->ca_chain, nullptr);
  18082. return true;
  18083. }
  18084. inline bool load_ca_file(ctx_t ctx, const char *file_path) {
  18085. if (!ctx || !file_path) { return false; }
  18086. auto mctx = static_cast<impl::MbedTlsContext *>(ctx);
  18087. int ret = mbedtls_x509_crt_parse_file(&mctx->ca_chain, file_path);
  18088. if (ret != 0) {
  18089. impl::mbedtls_last_error() = ret;
  18090. return false;
  18091. }
  18092. mbedtls_ssl_conf_ca_chain(&mctx->conf, &mctx->ca_chain, nullptr);
  18093. return true;
  18094. }
  18095. inline bool load_ca_dir(ctx_t ctx, const char *dir_path) {
  18096. if (!ctx || !dir_path) { return false; }
  18097. auto mctx = static_cast<impl::MbedTlsContext *>(ctx);
  18098. int ret = mbedtls_x509_crt_parse_path(&mctx->ca_chain, dir_path);
  18099. if (ret < 0) { // Returns number of certs on success, negative on error
  18100. impl::mbedtls_last_error() = ret;
  18101. return false;
  18102. }
  18103. mbedtls_ssl_conf_ca_chain(&mctx->conf, &mctx->ca_chain, nullptr);
  18104. return true;
  18105. }
  18106. inline bool load_system_certs(ctx_t ctx) {
  18107. if (!ctx) { return false; }
  18108. auto mctx = static_cast<impl::MbedTlsContext *>(ctx);
  18109. bool loaded = false;
  18110. #ifdef _WIN32
  18111. loaded = impl::enumerate_windows_system_certs(
  18112. [&](const unsigned char *data, size_t len) {
  18113. return mbedtls_x509_crt_parse_der(&mctx->ca_chain, data, len) == 0;
  18114. });
  18115. #elif defined(__APPLE__) && defined(CPPHTTPLIB_USE_CERTS_FROM_MACOSX_KEYCHAIN)
  18116. loaded = impl::enumerate_macos_keychain_certs(
  18117. [&](const unsigned char *data, size_t len) {
  18118. return mbedtls_x509_crt_parse_der(&mctx->ca_chain, data, len) == 0;
  18119. });
  18120. #else
  18121. for (auto path = impl::system_ca_paths(); *path; ++path) {
  18122. if (mbedtls_x509_crt_parse_file(&mctx->ca_chain, *path) >= 0) {
  18123. loaded = true;
  18124. break;
  18125. }
  18126. }
  18127. if (!loaded) {
  18128. for (auto dir = impl::system_ca_dirs(); *dir; ++dir) {
  18129. if (mbedtls_x509_crt_parse_path(&mctx->ca_chain, *dir) >= 0) {
  18130. loaded = true;
  18131. break;
  18132. }
  18133. }
  18134. }
  18135. #endif
  18136. if (loaded) {
  18137. mbedtls_ssl_conf_ca_chain(&mctx->conf, &mctx->ca_chain, nullptr);
  18138. }
  18139. return loaded;
  18140. }
  18141. inline bool set_client_cert_pem(ctx_t ctx, const char *cert, const char *key,
  18142. const char *password) {
  18143. if (!ctx || !cert || !key) { return false; }
  18144. auto mctx = static_cast<impl::MbedTlsContext *>(ctx);
  18145. // Parse certificate
  18146. std::string cert_str(cert);
  18147. int ret = mbedtls_x509_crt_parse(
  18148. &mctx->own_cert,
  18149. reinterpret_cast<const unsigned char *>(cert_str.c_str()),
  18150. cert_str.size() + 1);
  18151. if (ret != 0) {
  18152. impl::mbedtls_last_error() = ret;
  18153. return false;
  18154. }
  18155. // Parse private key
  18156. std::string key_str(key);
  18157. const unsigned char *pwd =
  18158. password ? reinterpret_cast<const unsigned char *>(password) : nullptr;
  18159. size_t pwd_len = password ? strlen(password) : 0;
  18160. #if defined(CPPHTTPLIB_MBEDTLS_V3) && !defined(CPPHTTPLIB_MBEDTLS_V4)
  18161. ret = mbedtls_pk_parse_key(
  18162. &mctx->own_key, reinterpret_cast<const unsigned char *>(key_str.c_str()),
  18163. key_str.size() + 1, pwd, pwd_len, mbedtls_ctr_drbg_random,
  18164. &mctx->ctr_drbg);
  18165. #else
  18166. ret = mbedtls_pk_parse_key(
  18167. &mctx->own_key, reinterpret_cast<const unsigned char *>(key_str.c_str()),
  18168. key_str.size() + 1, pwd, pwd_len);
  18169. #endif
  18170. if (ret != 0) {
  18171. impl::mbedtls_last_error() = ret;
  18172. return false;
  18173. }
  18174. // Verify that the certificate and private key match.
  18175. // Mbed TLS 4.x: mbedtls_pk_check_pair() reports a spurious mismatch for
  18176. // PSA-backed keys, so skip it and let the handshake surface a real mismatch.
  18177. #ifndef CPPHTTPLIB_MBEDTLS_V4
  18178. #ifdef CPPHTTPLIB_MBEDTLS_V3
  18179. ret = mbedtls_pk_check_pair(&mctx->own_cert.pk, &mctx->own_key,
  18180. mbedtls_ctr_drbg_random, &mctx->ctr_drbg);
  18181. #else
  18182. ret = mbedtls_pk_check_pair(&mctx->own_cert.pk, &mctx->own_key);
  18183. #endif
  18184. if (ret != 0) {
  18185. impl::mbedtls_last_error() = ret;
  18186. return false;
  18187. }
  18188. #endif
  18189. ret = mbedtls_ssl_conf_own_cert(&mctx->conf, &mctx->own_cert, &mctx->own_key);
  18190. if (ret != 0) {
  18191. impl::mbedtls_last_error() = ret;
  18192. return false;
  18193. }
  18194. return true;
  18195. }
  18196. inline bool set_client_cert_file(ctx_t ctx, const char *cert_path,
  18197. const char *key_path, const char *password) {
  18198. if (!ctx || !cert_path || !key_path) { return false; }
  18199. auto mctx = static_cast<impl::MbedTlsContext *>(ctx);
  18200. // Parse certificate file
  18201. int ret = mbedtls_x509_crt_parse_file(&mctx->own_cert, cert_path);
  18202. if (ret != 0) {
  18203. impl::mbedtls_last_error() = ret;
  18204. return false;
  18205. }
  18206. // Parse private key file
  18207. #if defined(CPPHTTPLIB_MBEDTLS_V3) && !defined(CPPHTTPLIB_MBEDTLS_V4)
  18208. ret = mbedtls_pk_parse_keyfile(&mctx->own_key, key_path, password,
  18209. mbedtls_ctr_drbg_random, &mctx->ctr_drbg);
  18210. #else
  18211. ret = mbedtls_pk_parse_keyfile(&mctx->own_key, key_path, password);
  18212. #endif
  18213. if (ret != 0) {
  18214. impl::mbedtls_last_error() = ret;
  18215. return false;
  18216. }
  18217. // Verify that the certificate and private key match.
  18218. // Mbed TLS 4.x: see set_client_cert() — skip the spurious check_pair.
  18219. #ifndef CPPHTTPLIB_MBEDTLS_V4
  18220. #ifdef CPPHTTPLIB_MBEDTLS_V3
  18221. ret = mbedtls_pk_check_pair(&mctx->own_cert.pk, &mctx->own_key,
  18222. mbedtls_ctr_drbg_random, &mctx->ctr_drbg);
  18223. #else
  18224. ret = mbedtls_pk_check_pair(&mctx->own_cert.pk, &mctx->own_key);
  18225. #endif
  18226. if (ret != 0) {
  18227. impl::mbedtls_last_error() = ret;
  18228. return false;
  18229. }
  18230. #endif
  18231. ret = mbedtls_ssl_conf_own_cert(&mctx->conf, &mctx->own_cert, &mctx->own_key);
  18232. if (ret != 0) {
  18233. impl::mbedtls_last_error() = ret;
  18234. return false;
  18235. }
  18236. return true;
  18237. }
  18238. inline void set_verify_client(ctx_t ctx, bool require) {
  18239. if (!ctx) { return; }
  18240. auto mctx = static_cast<impl::MbedTlsContext *>(ctx);
  18241. mctx->verify_client = require;
  18242. impl::apply_verify_mode(*mctx);
  18243. }
  18244. inline session_t create_session(ctx_t ctx, socket_t sock) {
  18245. if (!ctx || sock == INVALID_SOCKET) { return nullptr; }
  18246. auto mctx = static_cast<impl::MbedTlsContext *>(ctx);
  18247. auto session = new (std::nothrow) impl::MbedTlsSession();
  18248. if (!session) { return nullptr; }
  18249. session->sock = sock;
  18250. int ret = mbedtls_ssl_setup(&session->ssl, &mctx->conf);
  18251. if (ret != 0) {
  18252. impl::mbedtls_last_error() = ret;
  18253. delete session;
  18254. return nullptr;
  18255. }
  18256. // Explicitly opt out of in-handshake hostname verification by default;
  18257. // since Mbed TLS 3.6.4 a client handshake with certificate verification
  18258. // fails outright when no hostname was set. set_sni() installs the real
  18259. // hostname for DNS hosts; for IP hosts (where SNI must not be set) the
  18260. // caller verifies the certificate identity post-handshake via
  18261. // verify_hostname().
  18262. mbedtls_ssl_set_hostname(&session->ssl, nullptr);
  18263. // Set BIO callbacks
  18264. mbedtls_ssl_set_bio(&session->ssl, &session->sock, impl::mbedtls_net_send_cb,
  18265. impl::mbedtls_net_recv_cb, nullptr);
  18266. // Installed always, as it also masks the hostname mismatch that set_sni()
  18267. // may ask for. The session runs its own copy of the user's callback, which
  18268. // set_verify_callback() cannot replace under a handshake.
  18269. session->verify_callback = mctx->verify_callback;
  18270. session->is_server = mctx->is_server;
  18271. mbedtls_ssl_set_verify(&session->ssl, impl::mbedtls_verify_callback, session);
  18272. return static_cast<session_t>(session);
  18273. }
  18274. inline void free_session(session_t session) {
  18275. if (session) { delete static_cast<impl::MbedTlsSession *>(session); }
  18276. }
  18277. inline bool set_sni(session_t session, const char *hostname,
  18278. bool verify_hostname) {
  18279. if (!session || !hostname) { return false; }
  18280. auto msession = static_cast<impl::MbedTlsSession *>(session);
  18281. // mbedtls_ssl_set_hostname() both sends the SNI extension and binds the
  18282. // handshake-time CN/SAN check to `hostname`; the two can't be requested
  18283. // independently, so a disabled hostname check is handled below by masking
  18284. // the resulting mismatch flag instead of skipping this call.
  18285. int ret = mbedtls_ssl_set_hostname(&msession->ssl, hostname);
  18286. if (ret != 0) {
  18287. impl::mbedtls_last_error() = ret;
  18288. return false;
  18289. }
  18290. msession->hostname = hostname;
  18291. if (!verify_hostname) { msession->suppress_hostname_mismatch = true; }
  18292. return true;
  18293. }
  18294. inline TlsError connect(session_t session) {
  18295. TlsError err;
  18296. if (!session) {
  18297. err.code = ErrorCode::Fatal;
  18298. return err;
  18299. }
  18300. auto msession = static_cast<impl::MbedTlsSession *>(session);
  18301. int ret;
  18302. do {
  18303. ret = mbedtls_ssl_handshake(&msession->ssl);
  18304. } while (impl::mbedtls_is_session_ticket(ret));
  18305. if (ret == 0) {
  18306. err.code = ErrorCode::Success;
  18307. } else {
  18308. impl::fill_mbedtls_tls_error(err, msession->ssl, ret);
  18309. impl::mbedtls_last_error() = ret;
  18310. }
  18311. return err;
  18312. }
  18313. inline TlsError accept(session_t session) {
  18314. // Same as connect for Mbed TLS - handshake works for both client and server
  18315. auto result = connect(session);
  18316. // After successful handshake, capture SNI from thread-local storage
  18317. if (result.code == ErrorCode::Success && session) {
  18318. auto msession = static_cast<impl::MbedTlsSession *>(session);
  18319. msession->sni_hostname = std::move(impl::mbedpending_sni());
  18320. impl::mbedpending_sni().clear();
  18321. }
  18322. return result;
  18323. }
  18324. inline bool connect_nonblocking(session_t session, socket_t sock,
  18325. time_t timeout_sec, time_t timeout_usec,
  18326. TlsError *err) {
  18327. if (!session) {
  18328. if (err) { err->code = ErrorCode::Fatal; }
  18329. return false;
  18330. }
  18331. auto msession = static_cast<impl::MbedTlsSession *>(session);
  18332. // Set socket to non-blocking mode
  18333. detail::set_nonblocking(sock, true);
  18334. auto cleanup =
  18335. detail::scope_exit([&]() { detail::set_nonblocking(sock, false); });
  18336. auto deadline = detail::deadline_after(timeout_sec, timeout_usec);
  18337. int ret;
  18338. while ((ret = mbedtls_ssl_handshake(&msession->ssl)) != 0) {
  18339. // Non-fatal TLS 1.3 ticket; retry immediately.
  18340. if (impl::mbedtls_is_session_ticket(ret)) { continue; }
  18341. if (ret == MBEDTLS_ERR_SSL_WANT_READ) {
  18342. if (detail::select_until(sock, POLLIN, deadline) > 0) { continue; }
  18343. } else if (ret == MBEDTLS_ERR_SSL_WANT_WRITE) {
  18344. if (detail::select_until(sock, POLLOUT, deadline) > 0) { continue; }
  18345. }
  18346. // TlsError or timeout
  18347. if (err) { impl::fill_mbedtls_tls_error(*err, msession->ssl, ret); }
  18348. impl::mbedtls_last_error() = ret;
  18349. return false;
  18350. }
  18351. if (err) { err->code = ErrorCode::Success; }
  18352. return true;
  18353. }
  18354. inline bool accept_nonblocking(session_t session, socket_t sock,
  18355. time_t timeout_sec, time_t timeout_usec,
  18356. TlsError *err) {
  18357. // Same implementation as connect for Mbed TLS
  18358. bool result =
  18359. connect_nonblocking(session, sock, timeout_sec, timeout_usec, err);
  18360. // After successful handshake, capture SNI from thread-local storage
  18361. if (result && session) {
  18362. auto msession = static_cast<impl::MbedTlsSession *>(session);
  18363. msession->sni_hostname = std::move(impl::mbedpending_sni());
  18364. impl::mbedpending_sni().clear();
  18365. }
  18366. return result;
  18367. }
  18368. inline ssize_t read(session_t session, void *buf, size_t len, TlsError &err) {
  18369. if (!session || !buf) {
  18370. err.code = ErrorCode::Fatal;
  18371. return -1;
  18372. }
  18373. auto msession = static_cast<impl::MbedTlsSession *>(session);
  18374. // Serve a byte consumed by the is_peer_closed() probe before reading more.
  18375. if (msession->has_peeked_byte) {
  18376. if (len == 0) { return 0; }
  18377. auto p = static_cast<unsigned char *>(buf);
  18378. p[0] = msession->peeked_byte;
  18379. msession->has_peeked_byte = false;
  18380. size_t n = 1;
  18381. // Top up with any already-decrypted bytes without risking a block.
  18382. if (len > 1 && mbedtls_ssl_get_bytes_avail(&msession->ssl) > 0) {
  18383. int extra = mbedtls_ssl_read(&msession->ssl, p + 1, len - 1);
  18384. if (extra > 0) { n += static_cast<size_t>(extra); }
  18385. }
  18386. err.code = ErrorCode::Success;
  18387. return static_cast<ssize_t>(n);
  18388. }
  18389. int ret;
  18390. do {
  18391. ret = mbedtls_ssl_read(&msession->ssl, static_cast<unsigned char *>(buf),
  18392. len);
  18393. } while (impl::mbedtls_is_session_ticket(ret));
  18394. if (ret > 0) {
  18395. err.code = ErrorCode::Success;
  18396. return static_cast<ssize_t>(ret);
  18397. }
  18398. if (ret == 0) {
  18399. err.code = ErrorCode::PeerClosed;
  18400. return 0;
  18401. }
  18402. err.code = impl::map_mbedtls_error(ret, err.sys_errno, 0);
  18403. err.backend_code = static_cast<uint64_t>(-ret);
  18404. impl::mbedtls_last_error() = ret;
  18405. // mbedTLS signals a clean close_notify via a negative error code rather
  18406. // than 0; surface it as a clean EOF the way OpenSSL/wolfSSL do.
  18407. if (err.code == ErrorCode::PeerClosed) { return 0; }
  18408. return -1;
  18409. }
  18410. inline ssize_t write(session_t session, const void *buf, size_t len,
  18411. TlsError &err) {
  18412. if (!session || !buf) {
  18413. err.code = ErrorCode::Fatal;
  18414. return -1;
  18415. }
  18416. auto msession = static_cast<impl::MbedTlsSession *>(session);
  18417. int ret;
  18418. do {
  18419. ret = mbedtls_ssl_write(&msession->ssl,
  18420. static_cast<const unsigned char *>(buf), len);
  18421. } while (impl::mbedtls_is_session_ticket(ret));
  18422. if (ret > 0) {
  18423. err.code = ErrorCode::Success;
  18424. return static_cast<ssize_t>(ret);
  18425. }
  18426. if (ret == 0) {
  18427. err.code = ErrorCode::PeerClosed;
  18428. return 0;
  18429. }
  18430. err.code = impl::map_mbedtls_error(ret, err.sys_errno, 0);
  18431. err.backend_code = static_cast<uint64_t>(-ret);
  18432. impl::mbedtls_last_error() = ret;
  18433. return -1;
  18434. }
  18435. inline int pending(const_session_t session) {
  18436. if (!session) { return 0; }
  18437. auto msession =
  18438. static_cast<impl::MbedTlsSession *>(const_cast<void *>(session));
  18439. return static_cast<int>(mbedtls_ssl_get_bytes_avail(&msession->ssl)) +
  18440. (msession->has_peeked_byte ? 1 : 0);
  18441. }
  18442. inline void shutdown(session_t session, bool graceful) {
  18443. if (!session) { return; }
  18444. auto msession = static_cast<impl::MbedTlsSession *>(session);
  18445. if (graceful) {
  18446. // Try to send close_notify, but don't block forever
  18447. int ret;
  18448. int attempts = 0;
  18449. while ((ret = mbedtls_ssl_close_notify(&msession->ssl)) != 0 &&
  18450. attempts < 3) {
  18451. if (ret != MBEDTLS_ERR_SSL_WANT_READ &&
  18452. ret != MBEDTLS_ERR_SSL_WANT_WRITE) {
  18453. break;
  18454. }
  18455. attempts++;
  18456. }
  18457. }
  18458. }
  18459. inline bool is_peer_closed(session_t session, socket_t sock) {
  18460. if (!session || sock == INVALID_SOCKET) { return true; }
  18461. auto msession = static_cast<impl::MbedTlsSession *>(session);
  18462. // Check if there's already decrypted or pushed-back data available.
  18463. // If so, the connection is definitely alive.
  18464. if (msession->has_peeked_byte ||
  18465. mbedtls_ssl_get_bytes_avail(&msession->ssl) > 0) {
  18466. return false;
  18467. }
  18468. // Set socket to non-blocking to avoid blocking on read
  18469. detail::set_nonblocking(sock, true);
  18470. auto cleanup =
  18471. detail::scope_exit([&]() { detail::set_nonblocking(sock, false); });
  18472. // Probe with a 1-byte read (Mbed TLS has no peek API). If the probe lands
  18473. // on application data — e.g. a response that already arrived — push the
  18474. // byte back so the next read() delivers it instead of losing it.
  18475. unsigned char buf;
  18476. int ret;
  18477. do {
  18478. ret = mbedtls_ssl_read(&msession->ssl, &buf, 1);
  18479. } while (impl::mbedtls_is_session_ticket(ret));
  18480. // If we got data or WANT_READ (would block), connection is alive
  18481. if (ret > 0) {
  18482. msession->peeked_byte = buf;
  18483. msession->has_peeked_byte = true;
  18484. return false;
  18485. }
  18486. if (ret == MBEDTLS_ERR_SSL_WANT_READ) { return false; }
  18487. // If we get a peer close notify or a connection reset, the peer is closed
  18488. return ret == MBEDTLS_ERR_SSL_PEER_CLOSE_NOTIFY ||
  18489. ret == MBEDTLS_ERR_NET_CONN_RESET || ret == 0;
  18490. }
  18491. inline cert_t get_peer_cert(const_session_t session) {
  18492. if (!session) { return nullptr; }
  18493. auto msession =
  18494. static_cast<impl::MbedTlsSession *>(const_cast<void *>(session));
  18495. // Mbed TLS returns a pointer to the internal peer cert chain.
  18496. // WARNING: This pointer is only valid while the session is active.
  18497. // Do not use the certificate after calling free_session().
  18498. const mbedtls_x509_crt *cert = mbedtls_ssl_get_peer_cert(&msession->ssl);
  18499. return const_cast<mbedtls_x509_crt *>(cert);
  18500. }
  18501. inline size_t get_peer_certs(const_session_t session,
  18502. std::vector<cert_t> &certs) {
  18503. certs.clear();
  18504. // Mbed TLS parses the whole received chain into a list headed by the peer
  18505. // certificate, owned by the session like get_peer_cert()'s result
  18506. for (auto crt = static_cast<mbedtls_x509_crt *>(get_peer_cert(session));
  18507. crt && crt->raw.len > 0; crt = crt->next) {
  18508. certs.push_back(static_cast<cert_t>(crt));
  18509. }
  18510. return certs.size();
  18511. }
  18512. inline void free_cert(cert_t cert) {
  18513. // Mbed TLS: every cert_t handed out points into a session's or a context's
  18514. // chain, so there is nothing to free. Callers still call this for the other
  18515. // backends.
  18516. (void)cert;
  18517. }
  18518. inline bool verify_hostname(cert_t cert, const char *hostname) {
  18519. if (!cert || !hostname) { return false; }
  18520. auto mcert = static_cast<const mbedtls_x509_crt *>(cert);
  18521. std::string host_str(hostname);
  18522. // Check if hostname is an IP address (IPv4 or IPv6)
  18523. unsigned char ip_bytes[16];
  18524. auto ip_len = impl::parse_ip_address(host_str, ip_bytes);
  18525. auto is_ip = ip_len > 0;
  18526. // Check Subject Alternative Names (SAN). Mbed TLS keeps the GeneralName type
  18527. // in buf.tag and the raw value in buf.p / buf.len.
  18528. auto has_dns_san = false;
  18529. for (auto san = &mcert->subject_alt_names; san; san = san->next) {
  18530. if (!san->buf.p || san->buf.len == 0) { continue; }
  18531. const unsigned char *p = san->buf.p;
  18532. size_t len = san->buf.len;
  18533. auto san_type = san->buf.tag & MBEDTLS_ASN1_TAG_VALUE_MASK;
  18534. if (is_ip) {
  18535. // For an IP host, only a matching iPAddress SAN of the same family
  18536. // (4 bytes for IPv4, 16 bytes for IPv6) may authenticate it.
  18537. if (san_type == MBEDTLS_X509_SAN_IP_ADDRESS && len == ip_len &&
  18538. memcmp(p, ip_bytes, ip_len) == 0) {
  18539. return true;
  18540. }
  18541. } else if (san_type == MBEDTLS_X509_SAN_DNS_NAME) {
  18542. has_dns_san = true;
  18543. std::string san_name(reinterpret_cast<const char *>(p), len);
  18544. if (detail::match_hostname(san_name, host_str)) { return true; }
  18545. }
  18546. }
  18547. // Fallback: the Common Names (CN) in the subject, as X509_check_host does it:
  18548. // never for an IP host, which only an iPAddress SAN names, and never next to
  18549. // a DNS SAN (RFC 6125 6.4.4).
  18550. if (is_ip || has_dns_san) { return false; }
  18551. for (auto name = &mcert->subject; name; name = name->next) {
  18552. if (MBEDTLS_OID_CMP(MBEDTLS_OID_AT_CN, &name->oid) == 0) {
  18553. std::string cn(reinterpret_cast<const char *>(name->val.p),
  18554. name->val.len);
  18555. if (detail::match_hostname(cn, host_str)) { return true; }
  18556. }
  18557. }
  18558. return false;
  18559. }
  18560. inline uint64_t hostname_mismatch_code() {
  18561. return static_cast<uint64_t>(MBEDTLS_X509_BADCERT_CN_MISMATCH);
  18562. }
  18563. inline long get_verify_result(const_session_t session) {
  18564. if (!session) { return -1; }
  18565. auto msession =
  18566. static_cast<impl::MbedTlsSession *>(const_cast<void *>(session));
  18567. uint32_t flags = mbedtls_ssl_get_verify_result(&msession->ssl);
  18568. // Return 0 (X509_V_OK equivalent) if verification passed
  18569. return flags == 0 ? 0 : static_cast<long>(flags);
  18570. }
  18571. inline std::string get_cert_subject_cn(cert_t cert) {
  18572. if (!cert) return "";
  18573. auto x509 = static_cast<mbedtls_x509_crt *>(cert);
  18574. // Find the CN in the subject
  18575. const mbedtls_x509_name *name = &x509->subject;
  18576. while (name != nullptr) {
  18577. if (MBEDTLS_OID_CMP(MBEDTLS_OID_AT_CN, &name->oid) == 0) {
  18578. return std::string(reinterpret_cast<const char *>(name->val.p),
  18579. name->val.len);
  18580. }
  18581. name = name->next;
  18582. }
  18583. return "";
  18584. }
  18585. inline std::string get_cert_issuer_name(cert_t cert) {
  18586. if (!cert) return "";
  18587. auto x509 = static_cast<mbedtls_x509_crt *>(cert);
  18588. // Build a human-readable issuer name string
  18589. char buf[512];
  18590. int ret = mbedtls_x509_dn_gets(buf, sizeof(buf), &x509->issuer);
  18591. if (ret < 0) return "";
  18592. return std::string(buf);
  18593. }
  18594. inline bool get_cert_sans(cert_t cert, std::vector<SanEntry> &sans) {
  18595. sans.clear();
  18596. if (!cert) return false;
  18597. auto x509 = static_cast<mbedtls_x509_crt *>(cert);
  18598. // Parse the Subject Alternative Name extension
  18599. const mbedtls_x509_sequence *cur = &x509->subject_alt_names;
  18600. while (cur != nullptr) {
  18601. if (cur->buf.len > 0) {
  18602. const unsigned char *p = cur->buf.p;
  18603. size_t value_len = cur->buf.len;
  18604. SanEntry entry;
  18605. switch (cur->buf.tag & MBEDTLS_ASN1_TAG_VALUE_MASK) {
  18606. case MBEDTLS_X509_SAN_DNS_NAME:
  18607. entry.type = SanType::DNS;
  18608. entry.value = std::string(reinterpret_cast<const char *>(p), value_len);
  18609. break;
  18610. case MBEDTLS_X509_SAN_IP_ADDRESS:
  18611. entry.type = SanType::IP;
  18612. if (value_len == 4) {
  18613. // IPv4
  18614. char buf[16];
  18615. snprintf(buf, sizeof(buf), "%d.%d.%d.%d", p[0], p[1], p[2], p[3]);
  18616. entry.value = buf;
  18617. } else if (value_len == 16) {
  18618. // IPv6
  18619. char buf[64];
  18620. snprintf(buf, sizeof(buf),
  18621. "%02x%02x:%02x%02x:%02x%02x:%02x%02x:"
  18622. "%02x%02x:%02x%02x:%02x%02x:%02x%02x",
  18623. p[0], p[1], p[2], p[3], p[4], p[5], p[6], p[7], p[8], p[9],
  18624. p[10], p[11], p[12], p[13], p[14], p[15]);
  18625. entry.value = buf;
  18626. }
  18627. break;
  18628. case MBEDTLS_X509_SAN_RFC822_NAME:
  18629. entry.type = SanType::EMAIL;
  18630. entry.value = std::string(reinterpret_cast<const char *>(p), value_len);
  18631. break;
  18632. case MBEDTLS_X509_SAN_UNIFORM_RESOURCE_IDENTIFIER:
  18633. entry.type = SanType::URI;
  18634. entry.value = std::string(reinterpret_cast<const char *>(p), value_len);
  18635. break;
  18636. default: entry.type = SanType::OTHER; break;
  18637. }
  18638. if (!entry.value.empty()) { sans.push_back(std::move(entry)); }
  18639. }
  18640. cur = cur->next;
  18641. }
  18642. return true;
  18643. }
  18644. inline bool get_cert_validity(cert_t cert, time_t &not_before,
  18645. time_t &not_after) {
  18646. if (!cert) return false;
  18647. auto x509 = static_cast<mbedtls_x509_crt *>(cert);
  18648. // Convert mbedtls_x509_time to time_t
  18649. auto to_time_t = [](const mbedtls_x509_time &t) -> time_t {
  18650. struct tm tm_time = {};
  18651. tm_time.tm_year = t.year - 1900;
  18652. tm_time.tm_mon = t.mon - 1;
  18653. tm_time.tm_mday = t.day;
  18654. tm_time.tm_hour = t.hour;
  18655. tm_time.tm_min = t.min;
  18656. tm_time.tm_sec = t.sec;
  18657. #ifdef _WIN32
  18658. return _mkgmtime(&tm_time);
  18659. #else
  18660. return timegm(&tm_time);
  18661. #endif
  18662. };
  18663. not_before = to_time_t(x509->valid_from);
  18664. not_after = to_time_t(x509->valid_to);
  18665. return true;
  18666. }
  18667. inline std::string get_cert_serial(cert_t cert) {
  18668. if (!cert) return "";
  18669. auto x509 = static_cast<mbedtls_x509_crt *>(cert);
  18670. // Convert serial number to hex string
  18671. std::string result;
  18672. result.reserve(x509->serial.len * 2);
  18673. for (size_t i = 0; i < x509->serial.len; i++) {
  18674. char hex[3];
  18675. snprintf(hex, sizeof(hex), "%02X", x509->serial.p[i]);
  18676. result += hex;
  18677. }
  18678. return result;
  18679. }
  18680. inline bool get_cert_der(cert_t cert, std::vector<unsigned char> &der) {
  18681. if (!cert) return false;
  18682. auto crt = static_cast<mbedtls_x509_crt *>(cert);
  18683. if (!crt->raw.p || crt->raw.len == 0) return false;
  18684. der.assign(crt->raw.p, crt->raw.p + crt->raw.len);
  18685. return true;
  18686. }
  18687. inline const char *get_sni(const_session_t session) {
  18688. if (!session) return nullptr;
  18689. auto msession = static_cast<const impl::MbedTlsSession *>(session);
  18690. // For server: return SNI received from client during handshake
  18691. if (!msession->sni_hostname.empty()) {
  18692. return msession->sni_hostname.c_str();
  18693. }
  18694. // For client: return the hostname set via set_sni
  18695. if (!msession->hostname.empty()) { return msession->hostname.c_str(); }
  18696. return nullptr;
  18697. }
  18698. inline uint64_t peek_error() {
  18699. // Mbed TLS doesn't have an error queue, return the last error
  18700. return static_cast<uint64_t>(-impl::mbedtls_last_error());
  18701. }
  18702. inline uint64_t get_error() {
  18703. // Mbed TLS doesn't have an error queue, return and clear the last error
  18704. uint64_t err = static_cast<uint64_t>(-impl::mbedtls_last_error());
  18705. impl::mbedtls_last_error() = 0;
  18706. return err;
  18707. }
  18708. inline std::string error_string(uint64_t code) {
  18709. char buf[256];
  18710. mbedtls_strerror(-static_cast<int>(code), buf, sizeof(buf));
  18711. return std::string(buf);
  18712. }
  18713. inline ca_store_t create_ca_store(const char *pem, size_t len) {
  18714. auto *ca_chain = new (std::nothrow) mbedtls_x509_crt;
  18715. if (!ca_chain) { return nullptr; }
  18716. mbedtls_x509_crt_init(ca_chain);
  18717. // mbedtls_x509_crt_parse expects null-terminated PEM
  18718. int ret = mbedtls_x509_crt_parse(ca_chain,
  18719. reinterpret_cast<const unsigned char *>(pem),
  18720. len + 1); // +1 for null terminator
  18721. if (ret != 0) {
  18722. // Try without +1 in case PEM is already null-terminated
  18723. ret = mbedtls_x509_crt_parse(
  18724. ca_chain, reinterpret_cast<const unsigned char *>(pem), len);
  18725. if (ret != 0) {
  18726. mbedtls_x509_crt_free(ca_chain);
  18727. delete ca_chain;
  18728. return nullptr;
  18729. }
  18730. }
  18731. return static_cast<ca_store_t>(ca_chain);
  18732. }
  18733. inline void free_ca_store(ca_store_t store) {
  18734. if (store) {
  18735. auto *ca_chain = static_cast<mbedtls_x509_crt *>(store);
  18736. mbedtls_x509_crt_free(ca_chain);
  18737. delete ca_chain;
  18738. }
  18739. }
  18740. inline bool set_ca_store(ctx_t ctx, ca_store_t store) {
  18741. if (!ctx || !store) { return false; }
  18742. auto *mbed_ctx = static_cast<impl::MbedTlsContext *>(ctx);
  18743. auto *ca_chain = static_cast<mbedtls_x509_crt *>(store);
  18744. // Free existing CA chain
  18745. mbedtls_x509_crt_free(&mbed_ctx->ca_chain);
  18746. mbedtls_x509_crt_init(&mbed_ctx->ca_chain);
  18747. // Copy the CA chain (deep copy)
  18748. // Parse from the raw data of the source cert
  18749. mbedtls_x509_crt *src = ca_chain;
  18750. while (src != nullptr) {
  18751. int ret = mbedtls_x509_crt_parse_der(&mbed_ctx->ca_chain, src->raw.p,
  18752. src->raw.len);
  18753. if (ret != 0) {
  18754. free_ca_store(store);
  18755. return false;
  18756. }
  18757. src = src->next;
  18758. }
  18759. // This function takes ownership of the store; the chain was deep-copied
  18760. // above, so release the source
  18761. free_ca_store(store);
  18762. // Update the SSL config to use the new CA chain
  18763. mbedtls_ssl_conf_ca_chain(&mbed_ctx->conf, &mbed_ctx->ca_chain, nullptr);
  18764. return true;
  18765. }
  18766. inline size_t get_ca_certs(ctx_t ctx, std::vector<cert_t> &certs) {
  18767. certs.clear();
  18768. if (!ctx) { return 0; }
  18769. auto *mbed_ctx = static_cast<impl::MbedTlsContext *>(ctx);
  18770. // Owned by the context; see free_cert()
  18771. for (auto cert = &mbed_ctx->ca_chain; cert && cert->raw.len > 0;
  18772. cert = cert->next) {
  18773. certs.push_back(static_cast<cert_t>(cert));
  18774. }
  18775. return certs.size();
  18776. }
  18777. inline std::vector<std::string> get_ca_names(ctx_t ctx) {
  18778. std::vector<std::string> names;
  18779. if (!ctx) { return names; }
  18780. auto *mbed_ctx = static_cast<impl::MbedTlsContext *>(ctx);
  18781. // Iterate through the CA chain
  18782. mbedtls_x509_crt *cert = &mbed_ctx->ca_chain;
  18783. while (cert != nullptr && cert->raw.len > 0) {
  18784. char buf[512];
  18785. int ret = mbedtls_x509_dn_gets(buf, sizeof(buf), &cert->subject);
  18786. if (ret > 0) { names.push_back(buf); }
  18787. cert = cert->next;
  18788. }
  18789. return names;
  18790. }
  18791. inline bool update_server_cert(ctx_t ctx, const char *cert_pem,
  18792. const char *key_pem, const char *password) {
  18793. if (!ctx || !cert_pem || !key_pem) { return false; }
  18794. auto *mbed_ctx = static_cast<impl::MbedTlsContext *>(ctx);
  18795. // Parse into new objects first, so that a bad pair leaves the old one in
  18796. // place, and swap them in after; the old ones are freed on the way out.
  18797. mbedtls_x509_crt cert;
  18798. mbedtls_pk_context key;
  18799. mbedtls_x509_crt_init(&cert);
  18800. mbedtls_pk_init(&key);
  18801. auto se = detail::scope_exit([&] {
  18802. mbedtls_x509_crt_free(&cert);
  18803. mbedtls_pk_free(&key);
  18804. });
  18805. // Parse certificate PEM
  18806. int ret = mbedtls_x509_crt_parse(
  18807. &cert, reinterpret_cast<const unsigned char *>(cert_pem),
  18808. strlen(cert_pem) + 1);
  18809. if (ret != 0) {
  18810. impl::mbedtls_last_error() = ret;
  18811. return false;
  18812. }
  18813. // Parse private key PEM
  18814. #if defined(CPPHTTPLIB_MBEDTLS_V3) && !defined(CPPHTTPLIB_MBEDTLS_V4)
  18815. ret = mbedtls_pk_parse_key(
  18816. &key, reinterpret_cast<const unsigned char *>(key_pem),
  18817. strlen(key_pem) + 1,
  18818. password ? reinterpret_cast<const unsigned char *>(password) : nullptr,
  18819. password ? strlen(password) : 0, mbedtls_ctr_drbg_random,
  18820. &mbed_ctx->ctr_drbg);
  18821. #else
  18822. ret = mbedtls_pk_parse_key(
  18823. &key, reinterpret_cast<const unsigned char *>(key_pem),
  18824. strlen(key_pem) + 1,
  18825. password ? reinterpret_cast<const unsigned char *>(password) : nullptr,
  18826. password ? strlen(password) : 0);
  18827. #endif
  18828. if (ret != 0) {
  18829. impl::mbedtls_last_error() = ret;
  18830. return false;
  18831. }
  18832. std::swap(mbed_ctx->own_cert, cert);
  18833. std::swap(mbed_ctx->own_key, key);
  18834. // Configure SSL to use the new certificate and key
  18835. ret = mbedtls_ssl_conf_own_cert(&mbed_ctx->conf, &mbed_ctx->own_cert,
  18836. &mbed_ctx->own_key);
  18837. if (ret != 0) {
  18838. impl::mbedtls_last_error() = ret;
  18839. return false;
  18840. }
  18841. return true;
  18842. }
  18843. inline bool update_server_client_ca(ctx_t ctx, const char *ca_pem) {
  18844. if (!ctx || !ca_pem) { return false; }
  18845. auto *mbed_ctx = static_cast<impl::MbedTlsContext *>(ctx);
  18846. // Parse into a new chain first, so that a bad one leaves the old in place
  18847. mbedtls_x509_crt chain;
  18848. mbedtls_x509_crt_init(&chain);
  18849. auto se = detail::scope_exit([&] { mbedtls_x509_crt_free(&chain); });
  18850. // Parse CA PEM
  18851. int ret = mbedtls_x509_crt_parse(
  18852. &chain, reinterpret_cast<const unsigned char *>(ca_pem),
  18853. strlen(ca_pem) + 1);
  18854. if (ret != 0) {
  18855. impl::mbedtls_last_error() = ret;
  18856. return false;
  18857. }
  18858. std::swap(mbed_ctx->ca_chain, chain);
  18859. // Update SSL config to use new CA chain
  18860. mbedtls_ssl_conf_ca_chain(&mbed_ctx->conf, &mbed_ctx->ca_chain, nullptr);
  18861. return true;
  18862. }
  18863. inline bool set_verify_callback(ctx_t ctx, VerifyCallback callback) {
  18864. if (!ctx) { return false; }
  18865. auto *mbed_ctx = static_cast<impl::MbedTlsContext *>(ctx);
  18866. // create_session() hands each session its own copy to run.
  18867. mbed_ctx->verify_callback = std::move(callback);
  18868. impl::apply_verify_mode(*mbed_ctx);
  18869. return true;
  18870. }
  18871. inline long get_verify_error(const_session_t session) {
  18872. if (!session) { return -1; }
  18873. auto *msession =
  18874. static_cast<impl::MbedTlsSession *>(const_cast<void *>(session));
  18875. return static_cast<long>(mbedtls_ssl_get_verify_result(&msession->ssl));
  18876. }
  18877. inline std::string verify_error_string(long error_code) {
  18878. if (error_code == 0) { return ""; }
  18879. char buf[256];
  18880. mbedtls_x509_crt_verify_info(buf, sizeof(buf), "",
  18881. static_cast<uint32_t>(error_code));
  18882. // Remove trailing newline if present
  18883. std::string result(buf);
  18884. while (!result.empty() && (result.back() == '\n' || result.back() == ' ')) {
  18885. result.pop_back();
  18886. }
  18887. return result;
  18888. }
  18889. } // namespace tls
  18890. #endif // CPPHTTPLIB_MBEDTLS_SUPPORT
  18891. /*
  18892. * Group 10: TLS abstraction layer - wolfSSL backend
  18893. */
  18894. /*
  18895. * wolfSSL Backend Implementation
  18896. */
  18897. #ifdef CPPHTTPLIB_WOLFSSL_SUPPORT
  18898. namespace tls {
  18899. namespace impl {
  18900. // wolfSSL session wrapper
  18901. struct WolfSSLSession {
  18902. WOLFSSL *ssl = nullptr;
  18903. socket_t sock = INVALID_SOCKET;
  18904. std::string hostname; // For client: set via set_sni
  18905. std::string sni_hostname; // For server: received from client via SNI callback
  18906. WolfSSLSession() = default;
  18907. ~WolfSSLSession() {
  18908. if (ssl) { wolfSSL_free(ssl); }
  18909. }
  18910. WolfSSLSession(const WolfSSLSession &) = delete;
  18911. WolfSSLSession &operator=(const WolfSSLSession &) = delete;
  18912. };
  18913. // Thread-local error code accessor for wolfSSL
  18914. inline uint64_t &wolfssl_last_error() {
  18915. static thread_local uint64_t err = 0;
  18916. return err;
  18917. }
  18918. // Helper to map wolfSSL error to ErrorCode.
  18919. // ssl_error is the value from wolfSSL_get_error().
  18920. // raw_ret is the raw return value from the wolfSSL call (for low-level error).
  18921. inline ErrorCode map_wolfssl_error(WOLFSSL *ssl, int ssl_error,
  18922. int &out_errno) {
  18923. switch (ssl_error) {
  18924. case SSL_ERROR_NONE: return ErrorCode::Success;
  18925. case SSL_ERROR_WANT_READ: return ErrorCode::WantRead;
  18926. case SSL_ERROR_WANT_WRITE: return ErrorCode::WantWrite;
  18927. case SSL_ERROR_ZERO_RETURN: return ErrorCode::PeerClosed;
  18928. case SSL_ERROR_SYSCALL: out_errno = errno; return ErrorCode::SyscallError;
  18929. default:
  18930. if (ssl) {
  18931. // wolfSSL stores the low-level error code as a negative value.
  18932. // DOMAIN_NAME_MISMATCH (-322) indicates hostname verification failure.
  18933. int low_err = ssl_error; // wolfSSL_get_error returns the low-level code
  18934. if (low_err == DOMAIN_NAME_MISMATCH) {
  18935. return ErrorCode::HostnameMismatch;
  18936. }
  18937. // Check verify result to distinguish cert verification from generic SSL
  18938. // errors.
  18939. long vr = wolfSSL_get_verify_result(ssl);
  18940. if (vr != 0) { return ErrorCode::CertVerifyFailed; }
  18941. }
  18942. return ErrorCode::Fatal;
  18943. }
  18944. }
  18945. // WolfSSLContext constructor/destructor implementations
  18946. inline WolfSSLContext::WolfSSLContext() { wolfSSL_Init(); }
  18947. inline WolfSSLContext::~WolfSSLContext() {
  18948. if (ctx) { wolfSSL_CTX_free(ctx); }
  18949. }
  18950. // Thread-local storage for SNI captured during handshake
  18951. inline std::string &wolfssl_pending_sni() {
  18952. static thread_local std::string sni;
  18953. return sni;
  18954. }
  18955. // SNI callback for wolfSSL server to capture client's SNI hostname
  18956. inline int wolfssl_sni_callback(WOLFSSL *ssl, int *ret, void *exArg) {
  18957. (void)ret;
  18958. (void)exArg;
  18959. void *name_data = nullptr;
  18960. unsigned short name_len =
  18961. wolfSSL_SNI_GetRequest(ssl, WOLFSSL_SNI_HOST_NAME, &name_data);
  18962. if (name_data && name_len > 0) {
  18963. wolfssl_pending_sni().assign(static_cast<const char *>(name_data),
  18964. name_len);
  18965. } else {
  18966. wolfssl_pending_sni().clear();
  18967. }
  18968. return 0; // Continue regardless
  18969. }
  18970. // The WOLFSSL_CTX points back to its WolfSSLContext, so a handshake only ever
  18971. // runs the verify callback of its own context.
  18972. inline int context_ex_data_index() {
  18973. static const auto index =
  18974. wolfSSL_CTX_get_ex_new_index(0, nullptr, nullptr, nullptr, nullptr);
  18975. return index;
  18976. }
  18977. // Each WOLFSSL points back to its WolfSSLSession, the session_t that every
  18978. // other tls:: function takes.
  18979. inline int session_ex_data_index() {
  18980. static const auto index =
  18981. wolfSSL_get_ex_new_index(0, nullptr, nullptr, nullptr, nullptr);
  18982. return index;
  18983. }
  18984. // A resumed session skips the client's certificate, so a server that checks
  18985. // one would let in a certificate checked against another server's CA, as
  18986. // wolfSSL shares its session cache between contexts, or against a CA since
  18987. // replaced by update_server_client_ca().
  18988. inline void disable_server_resumption(WolfSSLContext *wctx) {
  18989. if (!wctx->is_server) { return; }
  18990. wolfSSL_CTX_set_session_cache_mode(wctx->ctx, WOLFSSL_SESS_CACHE_OFF);
  18991. #ifdef HAVE_SESSION_TICKET
  18992. wolfSSL_CTX_NoTicketTLSv12(wctx->ctx);
  18993. #endif
  18994. }
  18995. // wolfSSL verify callback wrapper
  18996. inline int wolfssl_verify_callback(int preverify_ok,
  18997. WOLFSSL_X509_STORE_CTX *x509_ctx) {
  18998. // Get the WOLFSSL object from the X509_STORE_CTX
  18999. WOLFSSL *ssl = static_cast<WOLFSSL *>(wolfSSL_X509_STORE_CTX_get_ex_data(
  19000. x509_ctx, wolfSSL_get_ex_data_X509_STORE_CTX_idx()));
  19001. if (!ssl) { return preverify_ok; }
  19002. auto wctx = static_cast<WolfSSLContext *>(wolfSSL_CTX_get_ex_data(
  19003. wolfSSL_get_SSL_CTX(ssl), context_ex_data_index()));
  19004. if (!wctx) { return preverify_ok; }
  19005. std::shared_ptr<VerifyCallback> callback;
  19006. {
  19007. std::lock_guard<std::mutex> guard(verify_callback_mutex());
  19008. callback = wctx->verify_callback;
  19009. }
  19010. if (!callback) { return preverify_ok; }
  19011. WOLFSSL_X509 *cert = wolfSSL_X509_STORE_CTX_get_current_cert(x509_ctx);
  19012. int depth = wolfSSL_X509_STORE_CTX_get_error_depth(x509_ctx);
  19013. int err = wolfSSL_X509_STORE_CTX_get_error(x509_ctx);
  19014. VerifyContext verify_ctx;
  19015. verify_ctx.session = wolfSSL_get_ex_data(ssl, session_ex_data_index());
  19016. verify_ctx.cert = static_cast<cert_t>(cert);
  19017. verify_ctx.depth = depth;
  19018. verify_ctx.preverify_ok = (preverify_ok != 0);
  19019. verify_ctx.error_code = static_cast<long>(err);
  19020. if (err != 0) {
  19021. verify_ctx.error_string = wolfSSL_X509_verify_cert_error_string(err);
  19022. } else {
  19023. verify_ctx.error_string = nullptr;
  19024. }
  19025. bool accepted = run_verify_callback(*callback, verify_ctx);
  19026. return accepted ? 1 : 0;
  19027. }
  19028. // Sets the verify mode from whether the peer's certificate is required and
  19029. // whether a verify callback is set.
  19030. inline void apply_verify_mode(WolfSSLContext &wctx) {
  19031. auto has_callback = static_cast<bool>(wctx.verify_callback);
  19032. if (wctx.verify_client || has_callback) { disable_server_resumption(&wctx); }
  19033. auto mode = wctx.verify_client
  19034. ? (SSL_VERIFY_PEER | SSL_VERIFY_FAIL_IF_NO_PEER_CERT)
  19035. : (has_callback ? SSL_VERIFY_PEER : SSL_VERIFY_NONE);
  19036. wolfSSL_CTX_set_verify(wctx.ctx, mode,
  19037. has_callback ? wolfssl_verify_callback : nullptr);
  19038. }
  19039. inline void set_wolfssl_password_cb(WOLFSSL_CTX *ctx, const char *password) {
  19040. wolfSSL_CTX_set_default_passwd_cb_userdata(ctx, const_cast<char *>(password));
  19041. wolfSSL_CTX_set_default_passwd_cb(
  19042. ctx, [](char *buf, int size, int /*rwflag*/, void *userdata) -> int {
  19043. auto *pwd = static_cast<const char *>(userdata);
  19044. if (!pwd) return 0;
  19045. auto len = static_cast<int>(strlen(pwd));
  19046. if (len > size) len = size;
  19047. memcpy(buf, pwd, static_cast<size_t>(len));
  19048. return len;
  19049. });
  19050. }
  19051. } // namespace impl
  19052. inline ctx_t create_client_context() {
  19053. auto ctx = new (std::nothrow) impl::WolfSSLContext();
  19054. if (!ctx) { return nullptr; }
  19055. ctx->is_server = false;
  19056. WOLFSSL_METHOD *method = wolfTLSv1_2_client_method();
  19057. if (!method) {
  19058. delete ctx;
  19059. return nullptr;
  19060. }
  19061. ctx->ctx = wolfSSL_CTX_new(method);
  19062. if (!ctx->ctx ||
  19063. wolfSSL_CTX_set_ex_data(ctx->ctx, impl::context_ex_data_index(), ctx) !=
  19064. WOLFSSL_SUCCESS) {
  19065. delete ctx;
  19066. return nullptr;
  19067. }
  19068. // Default: verify peer certificate
  19069. ctx->verify_client = true;
  19070. impl::apply_verify_mode(*ctx);
  19071. return static_cast<ctx_t>(ctx);
  19072. }
  19073. inline ctx_t create_server_context() {
  19074. auto ctx = new (std::nothrow) impl::WolfSSLContext();
  19075. if (!ctx) { return nullptr; }
  19076. ctx->is_server = true;
  19077. WOLFSSL_METHOD *method = wolfTLSv1_2_server_method();
  19078. if (!method) {
  19079. delete ctx;
  19080. return nullptr;
  19081. }
  19082. ctx->ctx = wolfSSL_CTX_new(method);
  19083. if (!ctx->ctx ||
  19084. wolfSSL_CTX_set_ex_data(ctx->ctx, impl::context_ex_data_index(), ctx) !=
  19085. WOLFSSL_SUCCESS) {
  19086. delete ctx;
  19087. return nullptr;
  19088. }
  19089. // Default: don't verify client
  19090. impl::apply_verify_mode(*ctx);
  19091. // Enable SNI on server
  19092. wolfSSL_CTX_SNI_SetOptions(ctx->ctx, WOLFSSL_SNI_HOST_NAME,
  19093. WOLFSSL_SNI_CONTINUE_ON_MISMATCH);
  19094. wolfSSL_CTX_set_servername_callback(ctx->ctx, impl::wolfssl_sni_callback);
  19095. return static_cast<ctx_t>(ctx);
  19096. }
  19097. inline void free_context(ctx_t ctx) {
  19098. if (ctx) { delete static_cast<impl::WolfSSLContext *>(ctx); }
  19099. }
  19100. inline bool set_min_version(ctx_t ctx, Version version) {
  19101. if (!ctx) { return false; }
  19102. auto wctx = static_cast<impl::WolfSSLContext *>(ctx);
  19103. int min_ver = WOLFSSL_TLSV1_2;
  19104. if (version >= Version::TLS1_3) { min_ver = WOLFSSL_TLSV1_3; }
  19105. return wolfSSL_CTX_SetMinVersion(wctx->ctx, min_ver) == WOLFSSL_SUCCESS;
  19106. }
  19107. inline bool load_ca_pem(ctx_t ctx, const char *pem, size_t len) {
  19108. if (!ctx || !pem) { return false; }
  19109. auto wctx = static_cast<impl::WolfSSLContext *>(ctx);
  19110. int ret = wolfSSL_CTX_load_verify_buffer(
  19111. wctx->ctx, reinterpret_cast<const unsigned char *>(pem),
  19112. static_cast<long>(len), SSL_FILETYPE_PEM);
  19113. if (ret != SSL_SUCCESS) {
  19114. impl::wolfssl_last_error() =
  19115. static_cast<uint64_t>(wolfSSL_ERR_peek_last_error());
  19116. return false;
  19117. }
  19118. wctx->ca_pem_data_.append(pem, len);
  19119. return true;
  19120. }
  19121. inline bool load_ca_file(ctx_t ctx, const char *file_path) {
  19122. if (!ctx || !file_path) { return false; }
  19123. auto wctx = static_cast<impl::WolfSSLContext *>(ctx);
  19124. int ret = wolfSSL_CTX_load_verify_locations(wctx->ctx, file_path, nullptr);
  19125. if (ret != SSL_SUCCESS) {
  19126. impl::wolfssl_last_error() =
  19127. static_cast<uint64_t>(wolfSSL_ERR_peek_last_error());
  19128. return false;
  19129. }
  19130. return true;
  19131. }
  19132. inline bool load_ca_dir(ctx_t ctx, const char *dir_path) {
  19133. if (!ctx || !dir_path) { return false; }
  19134. auto wctx = static_cast<impl::WolfSSLContext *>(ctx);
  19135. int ret = wolfSSL_CTX_load_verify_locations(wctx->ctx, nullptr, dir_path);
  19136. // wolfSSL may fail if the directory doesn't contain properly hashed certs.
  19137. // Unlike OpenSSL which lazily loads certs from directories, wolfSSL scans
  19138. // immediately. Return true even on failure since the CA file may have
  19139. // already been loaded, matching OpenSSL's lenient behavior.
  19140. (void)ret;
  19141. return true;
  19142. }
  19143. inline bool load_system_certs(ctx_t ctx) {
  19144. if (!ctx) { return false; }
  19145. auto wctx = static_cast<impl::WolfSSLContext *>(ctx);
  19146. bool loaded = false;
  19147. #ifdef _WIN32
  19148. loaded = impl::enumerate_windows_system_certs(
  19149. [&](const unsigned char *data, size_t len) {
  19150. return wolfSSL_CTX_load_verify_buffer(wctx->ctx, data,
  19151. static_cast<long>(len),
  19152. SSL_FILETYPE_ASN1) == SSL_SUCCESS;
  19153. });
  19154. #elif defined(__APPLE__) && defined(CPPHTTPLIB_USE_CERTS_FROM_MACOSX_KEYCHAIN)
  19155. loaded = impl::enumerate_macos_keychain_certs(
  19156. [&](const unsigned char *data, size_t len) {
  19157. return wolfSSL_CTX_load_verify_buffer(wctx->ctx, data,
  19158. static_cast<long>(len),
  19159. SSL_FILETYPE_ASN1) == SSL_SUCCESS;
  19160. });
  19161. #else
  19162. for (auto path = impl::system_ca_paths(); *path; ++path) {
  19163. if (wolfSSL_CTX_load_verify_locations(wctx->ctx, *path, nullptr) ==
  19164. SSL_SUCCESS) {
  19165. loaded = true;
  19166. break;
  19167. }
  19168. }
  19169. if (!loaded) {
  19170. for (auto dir = impl::system_ca_dirs(); *dir; ++dir) {
  19171. if (wolfSSL_CTX_load_verify_locations(wctx->ctx, nullptr, *dir) ==
  19172. SSL_SUCCESS) {
  19173. loaded = true;
  19174. break;
  19175. }
  19176. }
  19177. }
  19178. #endif
  19179. return loaded;
  19180. }
  19181. inline bool set_client_cert_pem(ctx_t ctx, const char *cert, const char *key,
  19182. const char *password) {
  19183. if (!ctx || !cert || !key) { return false; }
  19184. auto wctx = static_cast<impl::WolfSSLContext *>(ctx);
  19185. // Load certificate
  19186. int ret = wolfSSL_CTX_use_certificate_buffer(
  19187. wctx->ctx, reinterpret_cast<const unsigned char *>(cert),
  19188. static_cast<long>(strlen(cert)), SSL_FILETYPE_PEM);
  19189. if (ret != SSL_SUCCESS) {
  19190. impl::wolfssl_last_error() =
  19191. static_cast<uint64_t>(wolfSSL_ERR_peek_last_error());
  19192. return false;
  19193. }
  19194. // Set password callback if password is provided
  19195. if (password) { impl::set_wolfssl_password_cb(wctx->ctx, password); }
  19196. // Load private key
  19197. ret = wolfSSL_CTX_use_PrivateKey_buffer(
  19198. wctx->ctx, reinterpret_cast<const unsigned char *>(key),
  19199. static_cast<long>(strlen(key)), SSL_FILETYPE_PEM);
  19200. if (ret != SSL_SUCCESS) {
  19201. impl::wolfssl_last_error() =
  19202. static_cast<uint64_t>(wolfSSL_ERR_peek_last_error());
  19203. return false;
  19204. }
  19205. // Verify that the certificate and private key match
  19206. return wolfSSL_CTX_check_private_key(wctx->ctx) == SSL_SUCCESS;
  19207. }
  19208. inline bool set_client_cert_file(ctx_t ctx, const char *cert_path,
  19209. const char *key_path, const char *password) {
  19210. if (!ctx || !cert_path || !key_path) { return false; }
  19211. auto wctx = static_cast<impl::WolfSSLContext *>(ctx);
  19212. // Load certificate file
  19213. int ret =
  19214. wolfSSL_CTX_use_certificate_file(wctx->ctx, cert_path, SSL_FILETYPE_PEM);
  19215. if (ret != SSL_SUCCESS) {
  19216. impl::wolfssl_last_error() =
  19217. static_cast<uint64_t>(wolfSSL_ERR_peek_last_error());
  19218. return false;
  19219. }
  19220. // Set password callback if password is provided
  19221. if (password) { impl::set_wolfssl_password_cb(wctx->ctx, password); }
  19222. // Load private key file
  19223. ret = wolfSSL_CTX_use_PrivateKey_file(wctx->ctx, key_path, SSL_FILETYPE_PEM);
  19224. if (ret != SSL_SUCCESS) {
  19225. impl::wolfssl_last_error() =
  19226. static_cast<uint64_t>(wolfSSL_ERR_peek_last_error());
  19227. return false;
  19228. }
  19229. // Verify that the certificate and private key match
  19230. return wolfSSL_CTX_check_private_key(wctx->ctx) == SSL_SUCCESS;
  19231. }
  19232. inline void set_verify_client(ctx_t ctx, bool require) {
  19233. if (!ctx) { return; }
  19234. auto wctx = static_cast<impl::WolfSSLContext *>(ctx);
  19235. wctx->verify_client = require;
  19236. impl::apply_verify_mode(*wctx);
  19237. }
  19238. inline session_t create_session(ctx_t ctx, socket_t sock) {
  19239. if (!ctx || sock == INVALID_SOCKET) { return nullptr; }
  19240. auto wctx = static_cast<impl::WolfSSLContext *>(ctx);
  19241. auto session = new (std::nothrow) impl::WolfSSLSession();
  19242. if (!session) { return nullptr; }
  19243. session->sock = sock;
  19244. session->ssl = wolfSSL_new(wctx->ctx);
  19245. if (!session->ssl) {
  19246. impl::wolfssl_last_error() =
  19247. static_cast<uint64_t>(wolfSSL_ERR_peek_last_error());
  19248. delete session;
  19249. return nullptr;
  19250. }
  19251. if (wolfSSL_set_ex_data(session->ssl, impl::session_ex_data_index(),
  19252. session) != WOLFSSL_SUCCESS) {
  19253. delete session;
  19254. return nullptr;
  19255. }
  19256. wolfSSL_set_fd(session->ssl, static_cast<int>(sock));
  19257. return static_cast<session_t>(session);
  19258. }
  19259. inline void free_session(session_t session) {
  19260. if (session) { delete static_cast<impl::WolfSSLSession *>(session); }
  19261. }
  19262. inline bool set_sni(session_t session, const char *hostname,
  19263. bool verify_hostname) {
  19264. if (!session || !hostname) { return false; }
  19265. auto wsession = static_cast<impl::WolfSSLSession *>(session);
  19266. int ret = wolfSSL_UseSNI(wsession->ssl, WOLFSSL_SNI_HOST_NAME, hostname,
  19267. static_cast<word16>(strlen(hostname)));
  19268. if (ret != WOLFSSL_SUCCESS) {
  19269. impl::wolfssl_last_error() =
  19270. static_cast<uint64_t>(wolfSSL_ERR_peek_last_error());
  19271. return false;
  19272. }
  19273. // wolfSSL_check_domain_name binds identity checking to the handshake,
  19274. // separately from the SNI extension sent above; skip it when hostname
  19275. // verification is disabled so only the chain is checked, matching OpenSSL.
  19276. if (verify_hostname) { wolfSSL_check_domain_name(wsession->ssl, hostname); }
  19277. wsession->hostname = hostname;
  19278. return true;
  19279. }
  19280. inline TlsError connect(session_t session) {
  19281. TlsError err;
  19282. if (!session) {
  19283. err.code = ErrorCode::Fatal;
  19284. return err;
  19285. }
  19286. auto wsession = static_cast<impl::WolfSSLSession *>(session);
  19287. int ret = wolfSSL_connect(wsession->ssl);
  19288. if (ret == SSL_SUCCESS) {
  19289. err.code = ErrorCode::Success;
  19290. } else {
  19291. int ssl_error = wolfSSL_get_error(wsession->ssl, ret);
  19292. err.code = impl::map_wolfssl_error(wsession->ssl, ssl_error, err.sys_errno);
  19293. err.backend_code = static_cast<uint64_t>(ssl_error);
  19294. impl::wolfssl_last_error() = err.backend_code;
  19295. }
  19296. return err;
  19297. }
  19298. inline TlsError accept(session_t session) {
  19299. TlsError err;
  19300. if (!session) {
  19301. err.code = ErrorCode::Fatal;
  19302. return err;
  19303. }
  19304. auto wsession = static_cast<impl::WolfSSLSession *>(session);
  19305. int ret = wolfSSL_accept(wsession->ssl);
  19306. if (ret == SSL_SUCCESS) {
  19307. err.code = ErrorCode::Success;
  19308. // Capture SNI from thread-local storage after successful handshake
  19309. wsession->sni_hostname = std::move(impl::wolfssl_pending_sni());
  19310. impl::wolfssl_pending_sni().clear();
  19311. } else {
  19312. int ssl_error = wolfSSL_get_error(wsession->ssl, ret);
  19313. err.code = impl::map_wolfssl_error(wsession->ssl, ssl_error, err.sys_errno);
  19314. err.backend_code = static_cast<uint64_t>(ssl_error);
  19315. impl::wolfssl_last_error() = err.backend_code;
  19316. }
  19317. return err;
  19318. }
  19319. inline bool connect_nonblocking(session_t session, socket_t sock,
  19320. time_t timeout_sec, time_t timeout_usec,
  19321. TlsError *err) {
  19322. if (!session) {
  19323. if (err) { err->code = ErrorCode::Fatal; }
  19324. return false;
  19325. }
  19326. auto wsession = static_cast<impl::WolfSSLSession *>(session);
  19327. // Set socket to non-blocking mode
  19328. detail::set_nonblocking(sock, true);
  19329. auto cleanup =
  19330. detail::scope_exit([&]() { detail::set_nonblocking(sock, false); });
  19331. auto deadline = detail::deadline_after(timeout_sec, timeout_usec);
  19332. int ret;
  19333. while ((ret = wolfSSL_connect(wsession->ssl)) != SSL_SUCCESS) {
  19334. int ssl_error = wolfSSL_get_error(wsession->ssl, ret);
  19335. if (ssl_error == SSL_ERROR_WANT_READ) {
  19336. if (detail::select_until(sock, POLLIN, deadline) > 0) { continue; }
  19337. } else if (ssl_error == SSL_ERROR_WANT_WRITE) {
  19338. if (detail::select_until(sock, POLLOUT, deadline) > 0) { continue; }
  19339. }
  19340. // Error or timeout
  19341. if (err) {
  19342. err->code =
  19343. impl::map_wolfssl_error(wsession->ssl, ssl_error, err->sys_errno);
  19344. err->backend_code = static_cast<uint64_t>(ssl_error);
  19345. }
  19346. impl::wolfssl_last_error() = static_cast<uint64_t>(ssl_error);
  19347. return false;
  19348. }
  19349. if (err) { err->code = ErrorCode::Success; }
  19350. return true;
  19351. }
  19352. inline bool accept_nonblocking(session_t session, socket_t sock,
  19353. time_t timeout_sec, time_t timeout_usec,
  19354. TlsError *err) {
  19355. if (!session) {
  19356. if (err) { err->code = ErrorCode::Fatal; }
  19357. return false;
  19358. }
  19359. auto wsession = static_cast<impl::WolfSSLSession *>(session);
  19360. // Set socket to non-blocking mode
  19361. detail::set_nonblocking(sock, true);
  19362. auto cleanup =
  19363. detail::scope_exit([&]() { detail::set_nonblocking(sock, false); });
  19364. auto deadline = detail::deadline_after(timeout_sec, timeout_usec);
  19365. int ret;
  19366. while ((ret = wolfSSL_accept(wsession->ssl)) != SSL_SUCCESS) {
  19367. int ssl_error = wolfSSL_get_error(wsession->ssl, ret);
  19368. if (ssl_error == SSL_ERROR_WANT_READ) {
  19369. if (detail::select_until(sock, POLLIN, deadline) > 0) { continue; }
  19370. } else if (ssl_error == SSL_ERROR_WANT_WRITE) {
  19371. if (detail::select_until(sock, POLLOUT, deadline) > 0) { continue; }
  19372. }
  19373. // Error or timeout
  19374. if (err) {
  19375. err->code =
  19376. impl::map_wolfssl_error(wsession->ssl, ssl_error, err->sys_errno);
  19377. err->backend_code = static_cast<uint64_t>(ssl_error);
  19378. }
  19379. impl::wolfssl_last_error() = static_cast<uint64_t>(ssl_error);
  19380. return false;
  19381. }
  19382. if (err) { err->code = ErrorCode::Success; }
  19383. // Capture SNI from thread-local storage after successful handshake
  19384. wsession->sni_hostname = std::move(impl::wolfssl_pending_sni());
  19385. impl::wolfssl_pending_sni().clear();
  19386. return true;
  19387. }
  19388. inline ssize_t read(session_t session, void *buf, size_t len, TlsError &err) {
  19389. if (!session || !buf) {
  19390. err.code = ErrorCode::Fatal;
  19391. return -1;
  19392. }
  19393. auto wsession = static_cast<impl::WolfSSLSession *>(session);
  19394. int ret = wolfSSL_read(wsession->ssl, buf, static_cast<int>(len));
  19395. if (ret > 0) {
  19396. err.code = ErrorCode::Success;
  19397. return static_cast<ssize_t>(ret);
  19398. }
  19399. if (ret == 0) {
  19400. err.code = ErrorCode::PeerClosed;
  19401. return 0;
  19402. }
  19403. int ssl_error = wolfSSL_get_error(wsession->ssl, ret);
  19404. err.code = impl::map_wolfssl_error(wsession->ssl, ssl_error, err.sys_errno);
  19405. err.backend_code = static_cast<uint64_t>(ssl_error);
  19406. impl::wolfssl_last_error() = err.backend_code;
  19407. return -1;
  19408. }
  19409. inline ssize_t write(session_t session, const void *buf, size_t len,
  19410. TlsError &err) {
  19411. if (!session || !buf) {
  19412. err.code = ErrorCode::Fatal;
  19413. return -1;
  19414. }
  19415. auto wsession = static_cast<impl::WolfSSLSession *>(session);
  19416. int ret = wolfSSL_write(wsession->ssl, buf, static_cast<int>(len));
  19417. if (ret > 0) {
  19418. err.code = ErrorCode::Success;
  19419. return static_cast<ssize_t>(ret);
  19420. }
  19421. // wolfSSL_write returns 0 when the peer has sent a close_notify.
  19422. // Treat this as an error (return -1) so callers don't spin in a
  19423. // write loop adding zero to the offset.
  19424. if (ret == 0) {
  19425. err.code = ErrorCode::PeerClosed;
  19426. return -1;
  19427. }
  19428. int ssl_error = wolfSSL_get_error(wsession->ssl, ret);
  19429. err.code = impl::map_wolfssl_error(wsession->ssl, ssl_error, err.sys_errno);
  19430. err.backend_code = static_cast<uint64_t>(ssl_error);
  19431. impl::wolfssl_last_error() = err.backend_code;
  19432. return -1;
  19433. }
  19434. inline int pending(const_session_t session) {
  19435. if (!session) { return 0; }
  19436. auto wsession =
  19437. static_cast<impl::WolfSSLSession *>(const_cast<void *>(session));
  19438. return wolfSSL_pending(wsession->ssl);
  19439. }
  19440. inline void shutdown(session_t session, bool graceful) {
  19441. if (!session) { return; }
  19442. auto wsession = static_cast<impl::WolfSSLSession *>(session);
  19443. if (graceful) {
  19444. int ret;
  19445. int attempts = 0;
  19446. while ((ret = wolfSSL_shutdown(wsession->ssl)) != SSL_SUCCESS &&
  19447. attempts < 3) {
  19448. int ssl_error = wolfSSL_get_error(wsession->ssl, ret);
  19449. if (ssl_error != SSL_ERROR_WANT_READ &&
  19450. ssl_error != SSL_ERROR_WANT_WRITE) {
  19451. break;
  19452. }
  19453. attempts++;
  19454. }
  19455. } else {
  19456. wolfSSL_shutdown(wsession->ssl);
  19457. }
  19458. }
  19459. inline bool is_peer_closed(session_t session, socket_t sock) {
  19460. if (!session || sock == INVALID_SOCKET) { return true; }
  19461. auto wsession = static_cast<impl::WolfSSLSession *>(session);
  19462. // Check if there's already decrypted data available
  19463. if (wolfSSL_pending(wsession->ssl) > 0) { return false; }
  19464. // Set socket to non-blocking to avoid blocking on read
  19465. detail::set_nonblocking(sock, true);
  19466. auto cleanup =
  19467. detail::scope_exit([&]() { detail::set_nonblocking(sock, false); });
  19468. // Peek 1 byte to check connection status without consuming data
  19469. unsigned char buf;
  19470. int ret = wolfSSL_peek(wsession->ssl, &buf, 1);
  19471. // If we got data or WANT_READ (would block), connection is alive
  19472. if (ret > 0) { return false; }
  19473. int ssl_error = wolfSSL_get_error(wsession->ssl, ret);
  19474. if (ssl_error == SSL_ERROR_WANT_READ) { return false; }
  19475. return ssl_error == SSL_ERROR_ZERO_RETURN || ssl_error == SSL_ERROR_SYSCALL ||
  19476. ret == 0;
  19477. }
  19478. inline cert_t get_peer_cert(const_session_t session) {
  19479. if (!session) { return nullptr; }
  19480. auto wsession =
  19481. static_cast<impl::WolfSSLSession *>(const_cast<void *>(session));
  19482. WOLFSSL_X509 *cert = wolfSSL_get_peer_certificate(wsession->ssl);
  19483. return static_cast<cert_t>(cert);
  19484. }
  19485. inline size_t get_peer_certs(const_session_t session,
  19486. std::vector<cert_t> &certs) {
  19487. certs.clear();
  19488. if (!session) { return 0; }
  19489. // wolfSSL keeps the received chain only when built with SESSION_CERTS
  19490. #ifdef SESSION_CERTS
  19491. auto wsession =
  19492. static_cast<impl::WolfSSLSession *>(const_cast<void *>(session));
  19493. auto chain = wolfSSL_get_peer_chain(wsession->ssl);
  19494. auto count = chain ? wolfSSL_get_chain_count(chain) : 0;
  19495. for (int i = 0; i < count; i++) {
  19496. auto x509 = wolfSSL_get_chain_X509(chain, i);
  19497. if (x509) { certs.push_back(static_cast<cert_t>(x509)); }
  19498. }
  19499. #endif
  19500. return certs.size();
  19501. }
  19502. inline void free_cert(cert_t cert) {
  19503. if (cert) { wolfSSL_X509_free(static_cast<WOLFSSL_X509 *>(cert)); }
  19504. }
  19505. inline bool verify_hostname(cert_t cert, const char *hostname) {
  19506. if (!cert || !hostname) { return false; }
  19507. auto x509 = static_cast<WOLFSSL_X509 *>(cert);
  19508. std::string host_str(hostname);
  19509. // Check if hostname is an IP address (IPv4 or IPv6)
  19510. unsigned char ip_bytes[16];
  19511. auto ip_len = impl::parse_ip_address(host_str, ip_bytes);
  19512. auto is_ip = ip_len > 0;
  19513. // Check Subject Alternative Names
  19514. auto has_dns_san = false;
  19515. auto *san_names = static_cast<WOLF_STACK_OF(WOLFSSL_GENERAL_NAME) *>(
  19516. wolfSSL_X509_get_ext_d2i(x509, NID_subject_alt_name, nullptr, nullptr));
  19517. if (san_names) {
  19518. int san_count = wolfSSL_sk_num(san_names);
  19519. for (int i = 0; i < san_count; i++) {
  19520. auto *names =
  19521. static_cast<WOLFSSL_GENERAL_NAME *>(wolfSSL_sk_value(san_names, i));
  19522. if (!names) continue;
  19523. if (!is_ip && names->type == WOLFSSL_GEN_DNS) {
  19524. // DNS name
  19525. has_dns_san = true;
  19526. unsigned char *dns_name = nullptr;
  19527. int dns_len = wolfSSL_ASN1_STRING_to_UTF8(&dns_name, names->d.dNSName);
  19528. if (dns_name && dns_len > 0) {
  19529. std::string san_name(reinterpret_cast<char *>(dns_name),
  19530. static_cast<size_t>(dns_len));
  19531. XFREE(dns_name, nullptr, DYNAMIC_TYPE_OPENSSL);
  19532. if (detail::match_hostname(san_name, host_str)) {
  19533. wolfSSL_sk_free(san_names);
  19534. return true;
  19535. }
  19536. }
  19537. } else if (is_ip && names->type == WOLFSSL_GEN_IPADD) {
  19538. // IP address: only an iPAddress SAN of the same family (4 bytes for
  19539. // IPv4, 16 bytes for IPv6) may authenticate the host.
  19540. unsigned char *ip_data = wolfSSL_ASN1_STRING_data(names->d.iPAddress);
  19541. auto san_ip_len = wolfSSL_ASN1_STRING_length(names->d.iPAddress);
  19542. if (ip_data && san_ip_len == static_cast<int>(ip_len) &&
  19543. memcmp(ip_data, ip_bytes, ip_len) == 0) {
  19544. wolfSSL_sk_free(san_names);
  19545. return true;
  19546. }
  19547. }
  19548. }
  19549. wolfSSL_sk_free(san_names);
  19550. }
  19551. // Fallback: the Common Name (CN) in the subject, as X509_check_host does it:
  19552. // never for an IP host, which only an iPAddress SAN names, and never next to
  19553. // a DNS SAN (RFC 6125 6.4.4).
  19554. if (is_ip || has_dns_san) { return false; }
  19555. auto cn = get_cert_subject_cn(cert);
  19556. return !cn.empty() && detail::match_hostname(cn, host_str);
  19557. }
  19558. inline uint64_t hostname_mismatch_code() {
  19559. return static_cast<uint64_t>(DOMAIN_NAME_MISMATCH);
  19560. }
  19561. inline long get_verify_result(const_session_t session) {
  19562. if (!session) { return -1; }
  19563. auto wsession =
  19564. static_cast<impl::WolfSSLSession *>(const_cast<void *>(session));
  19565. long result = wolfSSL_get_verify_result(wsession->ssl);
  19566. return result;
  19567. }
  19568. inline std::string get_cert_subject_cn(cert_t cert) {
  19569. if (!cert) return "";
  19570. auto x509 = static_cast<WOLFSSL_X509 *>(cert);
  19571. WOLFSSL_X509_NAME *subject = wolfSSL_X509_get_subject_name(x509);
  19572. if (!subject) return "";
  19573. char cn[256] = {};
  19574. int cn_len = wolfSSL_X509_NAME_get_text_by_NID(subject, NID_commonName, cn,
  19575. sizeof(cn));
  19576. if (cn_len <= 0) return "";
  19577. return std::string(cn, static_cast<size_t>(cn_len));
  19578. }
  19579. inline std::string get_cert_issuer_name(cert_t cert) {
  19580. if (!cert) return "";
  19581. auto x509 = static_cast<WOLFSSL_X509 *>(cert);
  19582. WOLFSSL_X509_NAME *issuer = wolfSSL_X509_get_issuer_name(x509);
  19583. if (!issuer) return "";
  19584. char *name_str = wolfSSL_X509_NAME_oneline(issuer, nullptr, 0);
  19585. if (!name_str) return "";
  19586. std::string result(name_str);
  19587. XFREE(name_str, nullptr, DYNAMIC_TYPE_OPENSSL);
  19588. return result;
  19589. }
  19590. inline bool get_cert_sans(cert_t cert, std::vector<SanEntry> &sans) {
  19591. sans.clear();
  19592. if (!cert) return false;
  19593. auto x509 = static_cast<WOLFSSL_X509 *>(cert);
  19594. auto *san_names = static_cast<WOLF_STACK_OF(WOLFSSL_GENERAL_NAME) *>(
  19595. wolfSSL_X509_get_ext_d2i(x509, NID_subject_alt_name, nullptr, nullptr));
  19596. if (!san_names) return true; // No SANs is not an error
  19597. int count = wolfSSL_sk_num(san_names);
  19598. for (int i = 0; i < count; i++) {
  19599. auto *name =
  19600. static_cast<WOLFSSL_GENERAL_NAME *>(wolfSSL_sk_value(san_names, i));
  19601. if (!name) continue;
  19602. SanEntry entry;
  19603. switch (name->type) {
  19604. case WOLFSSL_GEN_DNS: {
  19605. entry.type = SanType::DNS;
  19606. unsigned char *dns_name = nullptr;
  19607. int dns_len = wolfSSL_ASN1_STRING_to_UTF8(&dns_name, name->d.dNSName);
  19608. if (dns_name && dns_len > 0) {
  19609. entry.value = std::string(reinterpret_cast<char *>(dns_name),
  19610. static_cast<size_t>(dns_len));
  19611. XFREE(dns_name, nullptr, DYNAMIC_TYPE_OPENSSL);
  19612. }
  19613. break;
  19614. }
  19615. case WOLFSSL_GEN_IPADD: {
  19616. entry.type = SanType::IP;
  19617. unsigned char *ip_data = wolfSSL_ASN1_STRING_data(name->d.iPAddress);
  19618. int ip_len = wolfSSL_ASN1_STRING_length(name->d.iPAddress);
  19619. if (ip_data && ip_len == 4) {
  19620. char buf[16];
  19621. snprintf(buf, sizeof(buf), "%d.%d.%d.%d", ip_data[0], ip_data[1],
  19622. ip_data[2], ip_data[3]);
  19623. entry.value = buf;
  19624. } else if (ip_data && ip_len == 16) {
  19625. char buf[64];
  19626. snprintf(buf, sizeof(buf),
  19627. "%02x%02x:%02x%02x:%02x%02x:%02x%02x:"
  19628. "%02x%02x:%02x%02x:%02x%02x:%02x%02x",
  19629. ip_data[0], ip_data[1], ip_data[2], ip_data[3], ip_data[4],
  19630. ip_data[5], ip_data[6], ip_data[7], ip_data[8], ip_data[9],
  19631. ip_data[10], ip_data[11], ip_data[12], ip_data[13],
  19632. ip_data[14], ip_data[15]);
  19633. entry.value = buf;
  19634. }
  19635. break;
  19636. }
  19637. case WOLFSSL_GEN_EMAIL:
  19638. entry.type = SanType::EMAIL;
  19639. {
  19640. unsigned char *email = nullptr;
  19641. int email_len = wolfSSL_ASN1_STRING_to_UTF8(&email, name->d.rfc822Name);
  19642. if (email && email_len > 0) {
  19643. entry.value = std::string(reinterpret_cast<char *>(email),
  19644. static_cast<size_t>(email_len));
  19645. XFREE(email, nullptr, DYNAMIC_TYPE_OPENSSL);
  19646. }
  19647. }
  19648. break;
  19649. case WOLFSSL_GEN_URI:
  19650. entry.type = SanType::URI;
  19651. {
  19652. unsigned char *uri = nullptr;
  19653. int uri_len = wolfSSL_ASN1_STRING_to_UTF8(
  19654. &uri, name->d.uniformResourceIdentifier);
  19655. if (uri && uri_len > 0) {
  19656. entry.value = std::string(reinterpret_cast<char *>(uri),
  19657. static_cast<size_t>(uri_len));
  19658. XFREE(uri, nullptr, DYNAMIC_TYPE_OPENSSL);
  19659. }
  19660. }
  19661. break;
  19662. default: entry.type = SanType::OTHER; break;
  19663. }
  19664. if (!entry.value.empty()) { sans.push_back(std::move(entry)); }
  19665. }
  19666. wolfSSL_sk_free(san_names);
  19667. return true;
  19668. }
  19669. inline bool get_cert_validity(cert_t cert, time_t &not_before,
  19670. time_t &not_after) {
  19671. if (!cert) return false;
  19672. auto x509 = static_cast<WOLFSSL_X509 *>(cert);
  19673. const WOLFSSL_ASN1_TIME *nb = wolfSSL_X509_get_notBefore(x509);
  19674. const WOLFSSL_ASN1_TIME *na = wolfSSL_X509_get_notAfter(x509);
  19675. if (!nb || !na) return false;
  19676. // wolfSSL_ASN1_TIME_to_tm is available
  19677. struct tm tm_nb = {}, tm_na = {};
  19678. if (wolfSSL_ASN1_TIME_to_tm(nb, &tm_nb) != WOLFSSL_SUCCESS) return false;
  19679. if (wolfSSL_ASN1_TIME_to_tm(na, &tm_na) != WOLFSSL_SUCCESS) return false;
  19680. #ifdef _WIN32
  19681. not_before = _mkgmtime(&tm_nb);
  19682. not_after = _mkgmtime(&tm_na);
  19683. #else
  19684. not_before = timegm(&tm_nb);
  19685. not_after = timegm(&tm_na);
  19686. #endif
  19687. return true;
  19688. }
  19689. inline std::string get_cert_serial(cert_t cert) {
  19690. if (!cert) return "";
  19691. auto x509 = static_cast<WOLFSSL_X509 *>(cert);
  19692. WOLFSSL_ASN1_INTEGER *serial_asn1 = wolfSSL_X509_get_serialNumber(x509);
  19693. if (!serial_asn1) return "";
  19694. // Get the serial number data
  19695. int len = serial_asn1->length;
  19696. unsigned char *data = serial_asn1->data;
  19697. if (!data || len <= 0) return "";
  19698. std::string result;
  19699. result.reserve(static_cast<size_t>(len) * 2);
  19700. for (int i = 0; i < len; i++) {
  19701. char hex[3];
  19702. snprintf(hex, sizeof(hex), "%02X", data[i]);
  19703. result += hex;
  19704. }
  19705. return result;
  19706. }
  19707. inline bool get_cert_der(cert_t cert, std::vector<unsigned char> &der) {
  19708. if (!cert) return false;
  19709. auto x509 = static_cast<WOLFSSL_X509 *>(cert);
  19710. int der_len = 0;
  19711. const unsigned char *der_data = wolfSSL_X509_get_der(x509, &der_len);
  19712. if (!der_data || der_len <= 0) return false;
  19713. der.assign(der_data, der_data + der_len);
  19714. return true;
  19715. }
  19716. inline const char *get_sni(const_session_t session) {
  19717. if (!session) return nullptr;
  19718. auto wsession = static_cast<const impl::WolfSSLSession *>(session);
  19719. // For server: return SNI received from client during handshake
  19720. if (!wsession->sni_hostname.empty()) {
  19721. return wsession->sni_hostname.c_str();
  19722. }
  19723. // For client: return the hostname set via set_sni
  19724. if (!wsession->hostname.empty()) { return wsession->hostname.c_str(); }
  19725. return nullptr;
  19726. }
  19727. inline uint64_t peek_error() {
  19728. return static_cast<uint64_t>(wolfSSL_ERR_peek_last_error());
  19729. }
  19730. inline uint64_t get_error() {
  19731. uint64_t err = impl::wolfssl_last_error();
  19732. impl::wolfssl_last_error() = 0;
  19733. return err;
  19734. }
  19735. inline std::string error_string(uint64_t code) {
  19736. char buf[256];
  19737. wolfSSL_ERR_error_string(static_cast<unsigned long>(code), buf);
  19738. return std::string(buf);
  19739. }
  19740. inline ca_store_t create_ca_store(const char *pem, size_t len) {
  19741. if (!pem || len == 0) { return nullptr; }
  19742. // Validate by attempting to load into a temporary ctx
  19743. WOLFSSL_CTX *tmp_ctx = wolfSSL_CTX_new(wolfTLSv1_2_client_method());
  19744. if (!tmp_ctx) { return nullptr; }
  19745. int ret = wolfSSL_CTX_load_verify_buffer(
  19746. tmp_ctx, reinterpret_cast<const unsigned char *>(pem),
  19747. static_cast<long>(len), SSL_FILETYPE_PEM);
  19748. wolfSSL_CTX_free(tmp_ctx);
  19749. if (ret != SSL_SUCCESS) { return nullptr; }
  19750. return static_cast<ca_store_t>(
  19751. new impl::WolfSSLCAStore{std::string(pem, len)});
  19752. }
  19753. inline void free_ca_store(ca_store_t store) {
  19754. delete static_cast<impl::WolfSSLCAStore *>(store);
  19755. }
  19756. inline bool set_ca_store(ctx_t ctx, ca_store_t store) {
  19757. if (!ctx || !store) { return false; }
  19758. auto *wctx = static_cast<impl::WolfSSLContext *>(ctx);
  19759. auto *ca = static_cast<impl::WolfSSLCAStore *>(store);
  19760. int ret = wolfSSL_CTX_load_verify_buffer(
  19761. wctx->ctx, reinterpret_cast<const unsigned char *>(ca->pem_data.data()),
  19762. static_cast<long>(ca->pem_data.size()), SSL_FILETYPE_PEM);
  19763. if (ret == SSL_SUCCESS) { wctx->ca_pem_data_ += ca->pem_data; }
  19764. // This function takes ownership of the store; the PEM data was copied into
  19765. // the context, so release the source
  19766. free_ca_store(store);
  19767. return ret == SSL_SUCCESS;
  19768. }
  19769. inline size_t get_ca_certs(ctx_t ctx, std::vector<cert_t> &certs) {
  19770. certs.clear();
  19771. if (!ctx) { return 0; }
  19772. auto *wctx = static_cast<impl::WolfSSLContext *>(ctx);
  19773. if (wctx->ca_pem_data_.empty()) { return 0; }
  19774. const std::string &pem = wctx->ca_pem_data_;
  19775. const std::string begin_marker = "-----BEGIN CERTIFICATE-----";
  19776. const std::string end_marker = "-----END CERTIFICATE-----";
  19777. size_t pos = 0;
  19778. while ((pos = pem.find(begin_marker, pos)) != std::string::npos) {
  19779. size_t end_pos = pem.find(end_marker, pos);
  19780. if (end_pos == std::string::npos) { break; }
  19781. end_pos += end_marker.size();
  19782. std::string cert_pem = pem.substr(pos, end_pos - pos);
  19783. WOLFSSL_X509 *x509 = wolfSSL_X509_load_certificate_buffer(
  19784. reinterpret_cast<const unsigned char *>(cert_pem.data()),
  19785. static_cast<int>(cert_pem.size()), WOLFSSL_FILETYPE_PEM);
  19786. if (x509) { certs.push_back(static_cast<cert_t>(x509)); }
  19787. pos = end_pos;
  19788. }
  19789. return certs.size();
  19790. }
  19791. inline std::vector<std::string> get_ca_names(ctx_t ctx) {
  19792. std::vector<std::string> names;
  19793. if (!ctx) { return names; }
  19794. auto *wctx = static_cast<impl::WolfSSLContext *>(ctx);
  19795. if (wctx->ca_pem_data_.empty()) { return names; }
  19796. const std::string &pem = wctx->ca_pem_data_;
  19797. const std::string begin_marker = "-----BEGIN CERTIFICATE-----";
  19798. const std::string end_marker = "-----END CERTIFICATE-----";
  19799. size_t pos = 0;
  19800. while ((pos = pem.find(begin_marker, pos)) != std::string::npos) {
  19801. size_t end_pos = pem.find(end_marker, pos);
  19802. if (end_pos == std::string::npos) { break; }
  19803. end_pos += end_marker.size();
  19804. std::string cert_pem = pem.substr(pos, end_pos - pos);
  19805. WOLFSSL_X509 *x509 = wolfSSL_X509_load_certificate_buffer(
  19806. reinterpret_cast<const unsigned char *>(cert_pem.data()),
  19807. static_cast<int>(cert_pem.size()), WOLFSSL_FILETYPE_PEM);
  19808. if (x509) {
  19809. WOLFSSL_X509_NAME *subject = wolfSSL_X509_get_subject_name(x509);
  19810. if (subject) {
  19811. char *name_str = wolfSSL_X509_NAME_oneline(subject, nullptr, 0);
  19812. if (name_str) {
  19813. names.push_back(name_str);
  19814. XFREE(name_str, nullptr, DYNAMIC_TYPE_OPENSSL);
  19815. }
  19816. }
  19817. wolfSSL_X509_free(x509);
  19818. }
  19819. pos = end_pos;
  19820. }
  19821. return names;
  19822. }
  19823. inline bool update_server_cert(ctx_t ctx, const char *cert_pem,
  19824. const char *key_pem, const char *password) {
  19825. if (!ctx || !cert_pem || !key_pem) { return false; }
  19826. // Try the pair on a scratch context first, so that a bad one leaves the
  19827. // server's certificate and key as they were
  19828. auto tmp = create_server_context();
  19829. if (!tmp) { return false; }
  19830. auto se = detail::scope_exit([&] { free_context(tmp); });
  19831. if (!set_client_cert_pem(tmp, cert_pem, key_pem, password)) { return false; }
  19832. return set_client_cert_pem(ctx, cert_pem, key_pem, password);
  19833. }
  19834. inline bool update_server_client_ca(ctx_t ctx, const char *ca_pem) {
  19835. if (!ctx || !ca_pem) { return false; }
  19836. auto *wctx = static_cast<impl::WolfSSLContext *>(ctx);
  19837. // Replace the CAs rather than add to them, as the other backends do, once
  19838. // the new ones are known to load
  19839. auto store = create_ca_store(ca_pem, strlen(ca_pem));
  19840. if (!store) { return false; }
  19841. free_ca_store(store);
  19842. wolfSSL_CTX_UnloadCAs(wctx->ctx);
  19843. wctx->ca_pem_data_.clear();
  19844. return load_ca_pem(ctx, ca_pem, strlen(ca_pem));
  19845. }
  19846. inline bool set_verify_callback(ctx_t ctx, VerifyCallback callback) {
  19847. if (!ctx) { return false; }
  19848. auto *wctx = static_cast<impl::WolfSSLContext *>(ctx);
  19849. auto stored = callback ? std::make_shared<VerifyCallback>(std::move(callback))
  19850. : nullptr;
  19851. {
  19852. std::lock_guard<std::mutex> guard(impl::verify_callback_mutex());
  19853. // A handshake running the previous callback keeps it until it returns.
  19854. wctx->verify_callback.swap(stored);
  19855. }
  19856. impl::apply_verify_mode(*wctx);
  19857. return true;
  19858. }
  19859. inline long get_verify_error(const_session_t session) {
  19860. if (!session) { return -1; }
  19861. auto *wsession =
  19862. static_cast<impl::WolfSSLSession *>(const_cast<void *>(session));
  19863. return wolfSSL_get_verify_result(wsession->ssl);
  19864. }
  19865. inline std::string verify_error_string(long error_code) {
  19866. if (error_code == 0) { return ""; }
  19867. const char *str =
  19868. wolfSSL_X509_verify_cert_error_string(static_cast<int>(error_code));
  19869. return str ? std::string(str) : std::string();
  19870. }
  19871. } // namespace tls
  19872. #endif // CPPHTTPLIB_WOLFSSL_SUPPORT
  19873. // WebSocket implementation
  19874. namespace ws {
  19875. inline bool WebSocket::send_frame(Opcode op, const char *data, size_t len,
  19876. bool fin) {
  19877. std::lock_guard<std::mutex> lock(write_mutex_);
  19878. if (closed_) { return false; }
  19879. return detail::write_websocket_frame(strm_, op, data, len, fin, !is_server_);
  19880. }
  19881. inline ReadResult WebSocket::read(std::string &msg) {
  19882. // Answers a control frame; any other opcode here is a protocol error.
  19883. // Returns false when the connection is done.
  19884. auto handle_control = [&](Opcode op, const std::string &payload) -> bool {
  19885. switch (op) {
  19886. case Opcode::Ping: {
  19887. std::lock_guard<std::mutex> lock(write_mutex_);
  19888. detail::write_websocket_frame(strm_, Opcode::Pong, payload.data(),
  19889. payload.size(), true, !is_server_);
  19890. return true;
  19891. }
  19892. case Opcode::Pong: {
  19893. std::lock_guard<std::mutex> lock(ping_mutex_);
  19894. unacked_pings_ = 0;
  19895. return true;
  19896. }
  19897. case Opcode::Close: {
  19898. // RFC 6455 §5.5.1: a Close is echoed back, unless its payload is
  19899. // malformed, which is answered with a protocol error instead.
  19900. if (closed_.exchange(true)) { return false; }
  19901. auto reply = payload;
  19902. if (!impl::is_valid_close_payload(payload)) {
  19903. auto code = static_cast<uint16_t>(CloseStatus::ProtocolError);
  19904. reply = {static_cast<char>(code >> 8), static_cast<char>(code & 0xff)};
  19905. }
  19906. std::lock_guard<std::mutex> lock(write_mutex_);
  19907. detail::write_websocket_frame(strm_, Opcode::Close, reply.data(),
  19908. reply.size(), true, !is_server_);
  19909. return false;
  19910. }
  19911. default: closed_ = true; return false;
  19912. }
  19913. };
  19914. std::unique_lock<std::mutex> read_lock(read_mutex_);
  19915. while (!closed_) {
  19916. Opcode opcode;
  19917. std::string payload;
  19918. bool fin;
  19919. impl::FrameRead r =
  19920. impl::read_websocket_frame(strm_, opcode, payload, fin, is_server_,
  19921. CPPHTTPLIB_WEBSOCKET_MAX_PAYLOAD_LENGTH);
  19922. // A timeout landed on a frame boundary: the connection is untouched and
  19923. // still usable, so hand control back without closing it. That is only
  19924. // useful to a caller who asked for the timeout; the compile-time default
  19925. // is a backstop against a peer gone quiet, and elapsing it closes the
  19926. // connection so a plain `while (ws.read(msg))` loop ends.
  19927. if (r == impl::FrameRead::Timeout && read_timeout_set_) { return Timeout; }
  19928. if (r != impl::FrameRead::Ok) {
  19929. closed_ = true;
  19930. return Fail;
  19931. }
  19932. switch (opcode) {
  19933. case Opcode::Text:
  19934. case Opcode::Binary: {
  19935. auto result = opcode == Opcode::Text ? Text : Binary;
  19936. msg = std::move(payload);
  19937. // Handle fragmentation
  19938. if (!fin) {
  19939. while (true) {
  19940. Opcode cont_opcode;
  19941. std::string cont_payload;
  19942. bool cont_fin;
  19943. // Only what is left of the limit, but room for a control frame,
  19944. // which may come between the fragments.
  19945. auto max_len =
  19946. CPPHTTPLIB_WEBSOCKET_MAX_PAYLOAD_LENGTH == 0
  19947. ? size_t(0)
  19948. : (std::max)(size_t(125),
  19949. CPPHTTPLIB_WEBSOCKET_MAX_PAYLOAD_LENGTH -
  19950. msg.size());
  19951. // A timeout is not reportable here: half of a fragmented message is
  19952. // already in `msg` and read() has no way to resume it, so it is a
  19953. // failure like any other. Timeouts are only ever seen on a message
  19954. // boundary.
  19955. if (impl::read_websocket_frame(strm_, cont_opcode, cont_payload,
  19956. cont_fin, is_server_,
  19957. max_len) != impl::FrameRead::Ok) {
  19958. closed_ = true;
  19959. return Fail;
  19960. }
  19961. // RFC 6455 5.4: the fragments are continuation frames, with only
  19962. // control frames between them.
  19963. if (cont_opcode != Opcode::Continuation) {
  19964. if (handle_control(cont_opcode, cont_payload)) { continue; }
  19965. return Fail;
  19966. }
  19967. msg += cont_payload;
  19968. if (CPPHTTPLIB_WEBSOCKET_MAX_PAYLOAD_LENGTH > 0 &&
  19969. msg.size() > CPPHTTPLIB_WEBSOCKET_MAX_PAYLOAD_LENGTH) {
  19970. closed_ = true;
  19971. return Fail;
  19972. }
  19973. if (cont_fin) { break; }
  19974. }
  19975. }
  19976. // RFC 6455 Section 5.6: text frames must contain valid UTF-8
  19977. if (result == Text && !impl::is_valid_utf8(msg)) {
  19978. // close() takes the read lock to wait for the peer's Close reply, so
  19979. // it must not run while this thread still holds it.
  19980. read_lock.unlock();
  19981. close(CloseStatus::InvalidPayload, "invalid UTF-8");
  19982. return Fail;
  19983. }
  19984. return result;
  19985. }
  19986. default:
  19987. if (handle_control(opcode, payload)) { continue; }
  19988. return Fail;
  19989. }
  19990. }
  19991. return Fail;
  19992. }
  19993. inline bool WebSocket::send(const std::string &data) {
  19994. return send_frame(Opcode::Text, data.data(), data.size());
  19995. }
  19996. inline bool WebSocket::send(const char *data, size_t len) {
  19997. return send_frame(Opcode::Binary, data, len);
  19998. }
  19999. inline void WebSocket::close(CloseStatus status, const std::string &reason) {
  20000. if (closed_.exchange(true)) { return; }
  20001. ping_cv_.notify_all();
  20002. std::string payload;
  20003. auto code = static_cast<uint16_t>(status);
  20004. payload.push_back(static_cast<char>((code >> 8) & 0xFF));
  20005. payload.push_back(static_cast<char>(code & 0xFF));
  20006. // RFC 6455 Section 5.5: control frame payload must not exceed 125 bytes
  20007. // Close frame has 2-byte status code, so reason is limited to 123 bytes,
  20008. // cut back to a whole UTF-8 character
  20009. auto short_reason = reason.substr(0, 123);
  20010. while (!short_reason.empty() && !impl::is_valid_utf8(short_reason)) {
  20011. short_reason.pop_back();
  20012. }
  20013. payload += short_reason;
  20014. // A code that may not be sent, such as NoStatus, goes without a payload
  20015. if (!impl::is_valid_close_payload(payload)) { payload.clear(); }
  20016. {
  20017. std::lock_guard<std::mutex> lock(write_mutex_);
  20018. detail::write_websocket_frame(strm_, Opcode::Close, payload.data(),
  20019. payload.size(), true, !is_server_);
  20020. }
  20021. // RFC 6455 Section 7.1.1: after sending a Close frame, wait for the peer's
  20022. // Close response before closing the TCP connection.
  20023. //
  20024. // Wait only when no other thread is parsing frames. When one is, it is the
  20025. // thread positioned to see the peer's reply, and reading here would take
  20026. // bytes out of the message it is assembling. Bailing out also leaves the
  20027. // stream, including its read timeout, entirely to that thread.
  20028. std::unique_lock<std::mutex> read_lock(read_mutex_, std::try_to_lock);
  20029. if (!read_lock.owns_lock()) { return; }
  20030. // Use a short timeout to avoid hanging if the peer doesn't respond.
  20031. strm_.set_read_timeout(CPPHTTPLIB_WEBSOCKET_CLOSE_TIMEOUT_SECOND, 0);
  20032. Opcode op;
  20033. std::string resp;
  20034. bool fin;
  20035. while (impl::read_websocket_frame(strm_, op, resp, fin, is_server_, 125) ==
  20036. impl::FrameRead::Ok) {
  20037. if (op == Opcode::Close) { break; }
  20038. }
  20039. }
  20040. inline WebSocket::~WebSocket() {
  20041. {
  20042. std::lock_guard<std::mutex> lock(ping_mutex_);
  20043. closed_ = true;
  20044. }
  20045. ping_cv_.notify_all();
  20046. if (ping_thread_.joinable()) { ping_thread_.join(); }
  20047. }
  20048. inline void WebSocket::start_heartbeat() {
  20049. if (ping_interval_sec_ <= 0) { return; }
  20050. ping_thread_ = std::thread([this]() {
  20051. std::unique_lock<std::mutex> lock(ping_mutex_);
  20052. // The predicate keeps a spurious wakeup from sending a ping early
  20053. while (!ping_cv_.wait_for(lock, std::chrono::seconds(ping_interval_sec_),
  20054. [this]() { return closed_.load(); })) {
  20055. // If the peer has failed to respond to the previous pings, give up.
  20056. // RFC 6455 does not define a pong-timeout mechanism; this is an
  20057. // opt-in liveness check controlled by max_missed_pongs_.
  20058. if (max_missed_pongs_ > 0 && unacked_pings_ >= max_missed_pongs_) {
  20059. lock.unlock();
  20060. close(CloseStatus::GoingAway, "pong timeout");
  20061. // Wake a read() blocked on the unresponsive peer. Only the read side
  20062. // is shut down: a TLS backend answers the EOF with an alert, and
  20063. // writing it to a socket closed for writing raises SIGPIPE.
  20064. #ifdef _WIN32
  20065. shutdown(strm_.socket(), SD_RECEIVE);
  20066. #else
  20067. shutdown(strm_.socket(), SHUT_RD);
  20068. #endif
  20069. return;
  20070. }
  20071. lock.unlock();
  20072. if (!send_frame(Opcode::Ping, nullptr, 0)) {
  20073. lock.lock();
  20074. closed_ = true;
  20075. break;
  20076. }
  20077. lock.lock();
  20078. unacked_pings_++;
  20079. }
  20080. });
  20081. }
  20082. inline const Request &WebSocket::request() const { return req_; }
  20083. inline bool WebSocket::is_open() const { return !closed_; }
  20084. inline void WebSocket::set_read_timeout(time_t sec, time_t usec) {
  20085. // 0 waits forever here, as it does for SO_RCVTIMEO. The stream waits with
  20086. // poll(), where 0 would instead mean "return immediately", so hand it the
  20087. // negative poll uses for an unbounded wait.
  20088. if (sec == 0 && usec == 0) { sec = -1; }
  20089. strm_.set_read_timeout(sec, usec);
  20090. read_timeout_set_ = true;
  20091. }
  20092. // WebSocketClient implementation
  20093. inline WebSocketClient::WebSocketClient(
  20094. const std::string &scheme_host_port_path, const Headers &headers)
  20095. : headers_(headers) {
  20096. detail::UrlComponents uc;
  20097. if (detail::parse_url(scheme_host_port_path, uc) && !uc.scheme.empty() &&
  20098. !uc.host.empty() && !uc.path.empty()) {
  20099. auto &scheme = uc.scheme;
  20100. #ifdef CPPHTTPLIB_SSL_ENABLED
  20101. if (scheme != "ws" && scheme != "wss") {
  20102. #else
  20103. if (scheme != "ws") {
  20104. #endif
  20105. #ifndef CPPHTTPLIB_NO_EXCEPTIONS
  20106. std::string msg = "'" + scheme + "' scheme is not supported.";
  20107. throw std::invalid_argument(msg);
  20108. #endif
  20109. return;
  20110. }
  20111. auto is_ssl = scheme == "wss";
  20112. host_ = std::move(uc.host);
  20113. port_ = is_ssl ? 443 : 80;
  20114. if (!uc.port.empty() && !detail::parse_port(uc.port, port_)) { return; }
  20115. path_ = std::move(uc.path);
  20116. if (!uc.query.empty()) { path_ += uc.query; }
  20117. #ifdef CPPHTTPLIB_SSL_ENABLED
  20118. is_ssl_ = is_ssl;
  20119. if (is_ssl_) {
  20120. // The context lives as long as the client so that CA configuration
  20121. // survives reconnects; sessions are created per connection.
  20122. tls_ctx_ = tls::create_client_context();
  20123. if (!tls_ctx_) { return; }
  20124. }
  20125. #else
  20126. if (is_ssl) { return; }
  20127. #endif
  20128. is_valid_ = true;
  20129. }
  20130. }
  20131. #ifdef CPPHTTPLIB_SSL_ENABLED
  20132. inline WebSocketClient::WebSocketClient(
  20133. const std::string &scheme_host_port_path, const PemMemory &pem,
  20134. const Headers &headers)
  20135. : WebSocketClient(scheme_host_port_path, headers) {
  20136. // For ws:// URLs the client certificate is silently ignored, consistent
  20137. // with the TLS-only setters such as set_ca_cert_path().
  20138. if (is_valid_ && is_ssl_ && pem.cert_pem && pem.key_pem) {
  20139. std::string cert_buf, key_buf;
  20140. if (!tls::set_client_cert_pem(
  20141. tls_ctx_,
  20142. detail::pem_c_str(pem.cert_pem, pem.cert_pem_len, cert_buf),
  20143. detail::pem_c_str(pem.key_pem, pem.key_pem_len, key_buf),
  20144. pem.private_key_password)) {
  20145. tls::free_context(tls_ctx_);
  20146. tls_ctx_ = nullptr;
  20147. is_valid_ = false;
  20148. }
  20149. }
  20150. }
  20151. #endif
  20152. inline WebSocketClient::~WebSocketClient() {
  20153. shutdown_and_close();
  20154. #ifdef CPPHTTPLIB_SSL_ENABLED
  20155. if (tls_ctx_) {
  20156. tls::free_context(tls_ctx_);
  20157. tls_ctx_ = nullptr;
  20158. }
  20159. #endif
  20160. }
  20161. inline bool WebSocketClient::is_valid() const { return is_valid_; }
  20162. inline void WebSocketClient::shutdown_and_close() {
  20163. // Send the close frame while the TLS session is still alive: ws_ holds an
  20164. // SSLSocketStream that keeps a raw pointer to tls_session_, so the session
  20165. // must outlive ws_->close() and ws_.reset() to avoid a use-after-free.
  20166. if (ws_ && ws_->is_open()) { ws_->close(); }
  20167. ws_.reset();
  20168. #ifdef CPPHTTPLIB_SSL_ENABLED
  20169. if (is_ssl_) {
  20170. if (tls_session_) {
  20171. tls::shutdown(tls_session_, true);
  20172. tls::free_session(tls_session_);
  20173. tls_session_ = nullptr;
  20174. }
  20175. }
  20176. #endif
  20177. if (sock_ != INVALID_SOCKET) {
  20178. detail::shutdown_socket(sock_);
  20179. detail::close_socket(sock_);
  20180. sock_ = INVALID_SOCKET;
  20181. }
  20182. }
  20183. // The handshakes belong to establishing the connection, so an unset read
  20184. // timeout leaves them bounded by the connection timeout instead of forever.
  20185. inline std::pair<time_t, time_t> WebSocketClient::handshake_timeout() const {
  20186. if (read_timeout_sec_ == 0 && read_timeout_usec_ == 0) {
  20187. return {connection_timeout_sec_, connection_timeout_usec_};
  20188. }
  20189. return {read_timeout_sec_, read_timeout_usec_};
  20190. }
  20191. inline bool WebSocketClient::create_stream(std::unique_ptr<Stream> &strm,
  20192. Error &error, int &ssl_error,
  20193. uint64_t &ssl_backend_error) {
  20194. // A read timeout of 0 means "wait forever", the way SO_RCVTIMEO reads it.
  20195. // The streams wait with poll(), where 0 instead means "return immediately",
  20196. // so they are given the negative poll uses for an unbounded wait.
  20197. auto unbounded = read_timeout_sec_ == 0 && read_timeout_usec_ == 0;
  20198. time_t strm_read_sec = unbounded ? -1 : read_timeout_sec_;
  20199. time_t strm_read_usec = unbounded ? 0 : read_timeout_usec_;
  20200. #ifdef CPPHTTPLIB_SSL_ENABLED
  20201. if (is_ssl_) {
  20202. // A plain flag rather than SSLClient::load_certs()'s call_once: connect()
  20203. // is not safe to call concurrently on one client to begin with, since
  20204. // nothing else here is guarded either.
  20205. if (server_certificate_verification_ && !certs_loaded_) {
  20206. uint64_t backend_error = 0;
  20207. detail::load_client_ca_config(tls_ctx_, ca_cert_file_path_,
  20208. ca_cert_dir_path_, custom_ca_loaded_,
  20209. system_ca_mode_, backend_error);
  20210. certs_loaded_ = true;
  20211. }
  20212. detail::ClientTlsSessionOptions options;
  20213. options.server_hostname_verification = server_hostname_verification_;
  20214. options.session_verifier = session_verifier_;
  20215. auto timeout = handshake_timeout();
  20216. detail::ClientTlsSessionError tls_error;
  20217. if (!detail::setup_client_tls_session(host_, tls_ctx_, tls_session_, sock_,
  20218. server_certificate_verification_,
  20219. timeout.first, timeout.second,
  20220. &tls_error, options)) {
  20221. error = tls_error.error;
  20222. ssl_error = tls_error.ssl_error;
  20223. ssl_backend_error = tls_error.backend_error;
  20224. return false;
  20225. }
  20226. strm = std::unique_ptr<Stream>(new detail::WebSocketSSLStream(
  20227. sock_, tls_session_, strm_read_sec, strm_read_usec, write_timeout_sec_,
  20228. write_timeout_usec_));
  20229. return true;
  20230. }
  20231. #else
  20232. (void)error;
  20233. (void)ssl_error;
  20234. (void)ssl_backend_error;
  20235. #endif
  20236. strm = std::unique_ptr<Stream>(
  20237. new detail::SocketStream(sock_, strm_read_sec, strm_read_usec,
  20238. write_timeout_sec_, write_timeout_usec_));
  20239. return true;
  20240. }
  20241. inline void WebSocketClient::prepare_default_headers(Request &req) {
  20242. #ifdef CPPHTTPLIB_SSL_ENABLED
  20243. auto is_ssl = is_ssl_;
  20244. #else
  20245. auto is_ssl = false;
  20246. #endif
  20247. if (!req.has_header("Host")) {
  20248. req.headers.emplace("Host", detail::make_default_host_header_value(
  20249. host_, port_, is_ssl, address_family_));
  20250. }
  20251. detail::add_default_user_agent_header(req);
  20252. }
  20253. inline Result WebSocketClient::connect() {
  20254. if (!is_valid_) { return Result{Error::Connection, -1, Headers{}}; }
  20255. shutdown_and_close();
  20256. auto error = Error::Success;
  20257. if (!create_and_connect_socket(error)) {
  20258. return Result{error, -1, Headers{}};
  20259. }
  20260. if (is_proxy_enabled()) {
  20261. Response proxy_res;
  20262. if (!connect_with_proxy(proxy_res, error)) {
  20263. shutdown_and_close();
  20264. return Result{error, proxy_res.status, std::move(proxy_res.headers)};
  20265. }
  20266. }
  20267. std::unique_ptr<Stream> strm;
  20268. auto stream_error = Error::SSLConnection;
  20269. int ssl_error = 0;
  20270. uint64_t ssl_backend_error = 0;
  20271. if (!create_stream(strm, stream_error, ssl_error, ssl_backend_error)) {
  20272. shutdown_and_close();
  20273. #ifdef CPPHTTPLIB_SSL_ENABLED
  20274. return Result{stream_error, -1, Headers{}, ssl_error, ssl_backend_error};
  20275. #else
  20276. return Result{stream_error, -1, Headers{}};
  20277. #endif
  20278. }
  20279. Request req;
  20280. req.method = "GET";
  20281. req.path = path_;
  20282. req.headers = headers_;
  20283. prepare_default_headers(req);
  20284. detail::WebSocketUpgradeResponse upgrade;
  20285. if (!detail::perform_websocket_handshake(*strm, req, upgrade)) {
  20286. shutdown_and_close();
  20287. return Result{upgrade.error, upgrade.status, std::move(upgrade.headers)};
  20288. }
  20289. subprotocol_ = std::move(upgrade.selected_subprotocol);
  20290. ws_ = std::unique_ptr<WebSocket>(new WebSocket(std::move(strm), req, false,
  20291. websocket_ping_interval_sec_,
  20292. websocket_max_missed_pongs_));
  20293. // The stream was created with the timeout already; tell the WebSocket
  20294. // whether it came from the caller, so read() knows to report it as Timeout.
  20295. ws_->read_timeout_set_ = read_timeout_set_;
  20296. return Result{Error::Success, upgrade.status, std::move(upgrade.headers)};
  20297. }
  20298. inline ReadResult WebSocketClient::read(std::string &msg) {
  20299. if (!ws_) { return Fail; }
  20300. return ws_->read(msg);
  20301. }
  20302. inline bool WebSocketClient::send(const std::string &data) {
  20303. if (!ws_) { return false; }
  20304. return ws_->send(data);
  20305. }
  20306. inline bool WebSocketClient::send(const char *data, size_t len) {
  20307. if (!ws_) { return false; }
  20308. return ws_->send(data, len);
  20309. }
  20310. inline void WebSocketClient::close(CloseStatus status,
  20311. const std::string &reason) {
  20312. if (ws_) { ws_->close(status, reason); }
  20313. }
  20314. inline bool WebSocketClient::is_open() const { return ws_ && ws_->is_open(); }
  20315. inline const std::string &WebSocketClient::subprotocol() const {
  20316. return subprotocol_;
  20317. }
  20318. inline void WebSocketClient::set_read_timeout(time_t sec, time_t usec) {
  20319. read_timeout_sec_ = sec;
  20320. read_timeout_usec_ = usec;
  20321. read_timeout_set_ = true;
  20322. // The members above only seed the next connect(); read() consults the
  20323. // stream, so an already-open connection has to be told directly.
  20324. if (ws_) { ws_->set_read_timeout(sec, usec); }
  20325. }
  20326. inline void WebSocketClient::set_write_timeout(time_t sec, time_t usec) {
  20327. write_timeout_sec_ = sec;
  20328. write_timeout_usec_ = usec;
  20329. }
  20330. inline void WebSocketClient::set_websocket_ping_interval(time_t sec) {
  20331. websocket_ping_interval_sec_ = sec;
  20332. }
  20333. inline void WebSocketClient::set_websocket_max_missed_pongs(int count) {
  20334. websocket_max_missed_pongs_ = count;
  20335. }
  20336. inline void WebSocketClient::set_tcp_nodelay(bool on) { tcp_nodelay_ = on; }
  20337. inline void WebSocketClient::set_address_family(int family) {
  20338. address_family_ = family;
  20339. }
  20340. inline void WebSocketClient::set_ipv6_v6only(bool on) { ipv6_v6only_ = on; }
  20341. inline void WebSocketClient::set_socket_options(SocketOptions socket_options) {
  20342. socket_options_ = std::move(socket_options);
  20343. }
  20344. inline void WebSocketClient::set_connection_timeout(time_t sec, time_t usec) {
  20345. connection_timeout_sec_ = sec;
  20346. connection_timeout_usec_ = usec;
  20347. }
  20348. inline void WebSocketClient::set_interface(const std::string &intf) {
  20349. interface_ = intf;
  20350. }
  20351. inline void WebSocketClient::set_hostname_addr_map(
  20352. std::map<std::string, std::string> addr_map) {
  20353. addr_map_ = std::move(addr_map);
  20354. }
  20355. inline bool WebSocketClient::is_proxy_enabled() const {
  20356. if (proxy_host_.empty() || proxy_port_ == -1) { return false; }
  20357. if (no_proxy_entries_.empty()) { return true; }
  20358. return !detail::host_matches_no_proxy(detail::normalize_target(host_),
  20359. no_proxy_entries_);
  20360. }
  20361. inline bool WebSocketClient::create_and_connect_socket(Error &error) {
  20362. std::string connect_host;
  20363. std::string ip;
  20364. auto port = port_;
  20365. if (is_proxy_enabled()) {
  20366. connect_host = proxy_host_;
  20367. port = proxy_port_;
  20368. } else {
  20369. detail::apply_addr_map(addr_map_, host_, connect_host, ip);
  20370. }
  20371. sock_ = detail::create_client_socket(
  20372. connect_host, ip, port, address_family_, tcp_nodelay_, ipv6_v6only_,
  20373. socket_options_, connection_timeout_sec_, connection_timeout_usec_,
  20374. read_timeout_sec_, read_timeout_usec_, write_timeout_sec_,
  20375. write_timeout_usec_, interface_, error);
  20376. if (sock_ != INVALID_SOCKET) { return true; }
  20377. if (error == Error::Success) { error = Error::Connection; }
  20378. return false;
  20379. }
  20380. inline bool WebSocketClient::send_proxy_connect(Request &req,
  20381. Response &proxy_res,
  20382. Error &error) {
  20383. auto timeout = handshake_timeout();
  20384. detail::SocketStream strm(sock_, timeout.first, timeout.second,
  20385. write_timeout_sec_, write_timeout_usec_);
  20386. if (!detail::write_request_head(strm, req, error)) { return false; }
  20387. if (!detail::read_response_head(strm, proxy_res.status, proxy_res.headers)) {
  20388. error = Error::Read;
  20389. return false;
  20390. }
  20391. return true;
  20392. }
  20393. // RFC 6455 4.1: ws:// is tunnelled with CONNECT as well, since a proxy need not
  20394. // forward an Upgrade request.
  20395. inline bool WebSocketClient::connect_with_proxy(Response &proxy_res,
  20396. Error &error) {
  20397. Request req;
  20398. req.method = "CONNECT";
  20399. req.path = detail::make_host_and_port_string_always_port(host_, port_);
  20400. req.headers.emplace("Host", req.path);
  20401. detail::add_default_user_agent_header(req);
  20402. detail::add_authorization_header(req, proxy_basic_auth_username_,
  20403. proxy_basic_auth_password_,
  20404. proxy_bearer_token_auth_token_, true);
  20405. if (!send_proxy_connect(req, proxy_res, error)) { return false; }
  20406. #ifdef CPPHTTPLIB_SSL_ENABLED
  20407. // A Digest challenge gets one retry on a fresh connection, like SSLClient.
  20408. std::map<std::string, std::string> auth;
  20409. if (proxy_res.status == StatusCode::ProxyAuthenticationRequired_407 &&
  20410. !proxy_digest_auth_username_.empty() &&
  20411. !proxy_digest_auth_password_.empty() &&
  20412. detail::parse_www_authenticate(proxy_res, auth, true)) {
  20413. proxy_res = Response();
  20414. shutdown_and_close();
  20415. if (!create_and_connect_socket(error)) { return false; }
  20416. req.headers.erase("Proxy-Authorization");
  20417. req.headers.insert(detail::make_digest_authentication_header(
  20418. req, req.path, auth, 1, detail::random_string(10),
  20419. proxy_digest_auth_username_, proxy_digest_auth_password_, true));
  20420. if (!send_proxy_connect(req, proxy_res, error)) { return false; }
  20421. }
  20422. #endif
  20423. if (proxy_res.status != StatusCode::OK_200) {
  20424. error = Error::ProxyConnection;
  20425. return false;
  20426. }
  20427. return true;
  20428. }
  20429. inline void WebSocketClient::set_proxy(const std::string &host, int port) {
  20430. proxy_host_ = host;
  20431. proxy_port_ = port;
  20432. }
  20433. inline void WebSocketClient::set_proxy_basic_auth(const std::string &username,
  20434. const std::string &password) {
  20435. proxy_basic_auth_username_ = username;
  20436. proxy_basic_auth_password_ = password;
  20437. }
  20438. inline void
  20439. WebSocketClient::set_proxy_bearer_token_auth(const std::string &token) {
  20440. proxy_bearer_token_auth_token_ = token;
  20441. }
  20442. inline void
  20443. WebSocketClient::set_no_proxy(const std::vector<std::string> &patterns) {
  20444. no_proxy_entries_ = detail::parse_no_proxy_entries(patterns);
  20445. }
  20446. #ifdef CPPHTTPLIB_SSL_ENABLED
  20447. inline void
  20448. WebSocketClient::set_ca_cert_path(const std::string &ca_cert_file_path,
  20449. const std::string &ca_cert_dir_path) {
  20450. ca_cert_file_path_ = ca_cert_file_path;
  20451. ca_cert_dir_path_ = ca_cert_dir_path;
  20452. }
  20453. inline void
  20454. WebSocketClient::set_server_certificate_verifier(tls::VerifyCallback verifier) {
  20455. if (tls_ctx_) { tls::set_verify_callback(tls_ctx_, std::move(verifier)); }
  20456. }
  20457. inline void WebSocketClient::set_session_verifier(
  20458. std::function<SSLVerifierResponse(tls::session_t)> verifier) {
  20459. session_verifier_ = std::move(verifier);
  20460. }
  20461. inline void WebSocketClient::set_ca_cert_store(tls::ca_store_t store) {
  20462. if (store && tls_ctx_) {
  20463. // set_ca_store takes ownership of store
  20464. tls::set_ca_store(tls_ctx_, store);
  20465. custom_ca_loaded_ = true;
  20466. } else if (store) {
  20467. tls::free_ca_store(store);
  20468. }
  20469. }
  20470. inline void WebSocketClient::load_ca_cert_store(const char *ca_cert,
  20471. std::size_t size) {
  20472. if (tls_ctx_ && ca_cert && size > 0) {
  20473. tls::load_ca_pem(tls_ctx_, ca_cert, size);
  20474. custom_ca_loaded_ = true;
  20475. }
  20476. }
  20477. inline void
  20478. WebSocketClient::enable_server_certificate_verification(bool enabled) {
  20479. server_certificate_verification_ = enabled;
  20480. }
  20481. inline void WebSocketClient::enable_server_hostname_verification(bool enabled) {
  20482. server_hostname_verification_ = enabled;
  20483. }
  20484. inline void WebSocketClient::enable_system_ca(bool enabled) {
  20485. system_ca_mode_ = enabled ? SystemCAMode::Enabled : SystemCAMode::Disabled;
  20486. }
  20487. inline void
  20488. WebSocketClient::set_proxy_digest_auth(const std::string &username,
  20489. const std::string &password) {
  20490. proxy_digest_auth_username_ = username;
  20491. proxy_digest_auth_password_ = password;
  20492. }
  20493. #endif // CPPHTTPLIB_SSL_ENABLED
  20494. } // namespace ws
  20495. // ----------------------------------------------------------------------------
  20496. } // namespace httplib
  20497. #endif // CPPHTTPLIB_HTTPLIB_H