httplib.h 790 KB

12345678910111213141516171819202122232425262728293031323334353637383940414243444546474849505152535455565758596061626364656667686970717273747576777879808182838485868788899091929394959697989910010110210310410510610710810911011111211311411511611711811912012112212312412512612712812913013113213313413513613713813914014114214314414514614714814915015115215315415515615715815916016116216316416516616716816917017117217317417517617717817918018118218318418518618718818919019119219319419519619719819920020120220320420520620720820921021121221321421521621721821922022122222322422522622722822923023123223323423523623723823924024124224324424524624724824925025125225325425525625725825926026126226326426526626726826927027127227327427527627727827928028128228328428528628728828929029129229329429529629729829930030130230330430530630730830931031131231331431531631731831932032132232332432532632732832933033133233333433533633733833934034134234334434534634734834935035135235335435535635735835936036136236336436536636736836937037137237337437537637737837938038138238338438538638738838939039139239339439539639739839940040140240340440540640740840941041141241341441541641741841942042142242342442542642742842943043143243343443543643743843944044144244344444544644744844945045145245345445545645745845946046146246346446546646746846947047147247347447547647747847948048148248348448548648748848949049149249349449549649749849950050150250350450550650750850951051151251351451551651751851952052152252352452552652752852953053153253353453553653753853954054154254354454554654754854955055155255355455555655755855956056156256356456556656756856957057157257357457557657757857958058158258358458558658758858959059159259359459559659759859960060160260360460560660760860961061161261361461561661761861962062162262362462562662762862963063163263363463563663763863964064164264364464564664764864965065165265365465565665765865966066166266366466566666766866967067167267367467567667767867968068168268368468568668768868969069169269369469569669769869970070170270370470570670770870971071171271371471571671771871972072172272372472572672772872973073173273373473573673773873974074174274374474574674774874975075175275375475575675775875976076176276376476576676776876977077177277377477577677777877978078178278378478578678778878979079179279379479579679779879980080180280380480580680780880981081181281381481581681781881982082182282382482582682782882983083183283383483583683783883984084184284384484584684784884985085185285385485585685785885986086186286386486586686786886987087187287387487587687787887988088188288388488588688788888989089189289389489589689789889990090190290390490590690790890991091191291391491591691791891992092192292392492592692792892993093193293393493593693793893994094194294394494594694794894995095195295395495595695795895996096196296396496596696796896997097197297397497597697797897998098198298398498598698798898999099199299399499599699799899910001001100210031004100510061007100810091010101110121013101410151016101710181019102010211022102310241025102610271028102910301031103210331034103510361037103810391040104110421043104410451046104710481049105010511052105310541055105610571058105910601061106210631064106510661067106810691070107110721073107410751076107710781079108010811082108310841085108610871088108910901091109210931094109510961097109810991100110111021103110411051106110711081109111011111112111311141115111611171118111911201121112211231124112511261127112811291130113111321133113411351136113711381139114011411142114311441145114611471148114911501151115211531154115511561157115811591160116111621163116411651166116711681169117011711172117311741175117611771178117911801181118211831184118511861187118811891190119111921193119411951196119711981199120012011202120312041205120612071208120912101211121212131214121512161217121812191220122112221223122412251226122712281229123012311232123312341235123612371238123912401241124212431244124512461247124812491250125112521253125412551256125712581259126012611262126312641265126612671268126912701271127212731274127512761277127812791280128112821283128412851286128712881289129012911292129312941295129612971298129913001301130213031304130513061307130813091310131113121313131413151316131713181319132013211322132313241325132613271328132913301331133213331334133513361337133813391340134113421343134413451346134713481349135013511352135313541355135613571358135913601361136213631364136513661367136813691370137113721373137413751376137713781379138013811382138313841385138613871388138913901391139213931394139513961397139813991400140114021403140414051406140714081409141014111412141314141415141614171418141914201421142214231424142514261427142814291430143114321433143414351436143714381439144014411442144314441445144614471448144914501451145214531454145514561457145814591460146114621463146414651466146714681469147014711472147314741475147614771478147914801481148214831484148514861487148814891490149114921493149414951496149714981499150015011502150315041505150615071508150915101511151215131514151515161517151815191520152115221523152415251526152715281529153015311532153315341535153615371538153915401541154215431544154515461547154815491550155115521553155415551556155715581559156015611562156315641565156615671568156915701571157215731574157515761577157815791580158115821583158415851586158715881589159015911592159315941595159615971598159916001601160216031604160516061607160816091610161116121613161416151616161716181619162016211622162316241625162616271628162916301631163216331634163516361637163816391640164116421643164416451646164716481649165016511652165316541655165616571658165916601661166216631664166516661667166816691670167116721673167416751676167716781679168016811682168316841685168616871688168916901691169216931694169516961697169816991700170117021703170417051706170717081709171017111712171317141715171617171718171917201721172217231724172517261727172817291730173117321733173417351736173717381739174017411742174317441745174617471748174917501751175217531754175517561757175817591760176117621763176417651766176717681769177017711772177317741775177617771778177917801781178217831784178517861787178817891790179117921793179417951796179717981799180018011802180318041805180618071808180918101811181218131814181518161817181818191820182118221823182418251826182718281829183018311832183318341835183618371838183918401841184218431844184518461847184818491850185118521853185418551856185718581859186018611862186318641865186618671868186918701871187218731874187518761877187818791880188118821883188418851886188718881889189018911892189318941895189618971898189919001901190219031904190519061907190819091910191119121913191419151916191719181919192019211922192319241925192619271928192919301931193219331934193519361937193819391940194119421943194419451946194719481949195019511952195319541955195619571958195919601961196219631964196519661967196819691970197119721973197419751976197719781979198019811982198319841985198619871988198919901991199219931994199519961997199819992000200120022003200420052006200720082009201020112012201320142015201620172018201920202021202220232024202520262027202820292030203120322033203420352036203720382039204020412042204320442045204620472048204920502051205220532054205520562057205820592060206120622063206420652066206720682069207020712072207320742075207620772078207920802081208220832084208520862087208820892090209120922093209420952096209720982099210021012102210321042105210621072108210921102111211221132114211521162117211821192120212121222123212421252126212721282129213021312132213321342135213621372138213921402141214221432144214521462147214821492150215121522153215421552156215721582159216021612162216321642165216621672168216921702171217221732174217521762177217821792180218121822183218421852186218721882189219021912192219321942195219621972198219922002201220222032204220522062207220822092210221122122213221422152216221722182219222022212222222322242225222622272228222922302231223222332234223522362237223822392240224122422243224422452246224722482249225022512252225322542255225622572258225922602261226222632264226522662267226822692270227122722273227422752276227722782279228022812282228322842285228622872288228922902291229222932294229522962297229822992300230123022303230423052306230723082309231023112312231323142315231623172318231923202321232223232324232523262327232823292330233123322333233423352336233723382339234023412342234323442345234623472348234923502351235223532354235523562357235823592360236123622363236423652366236723682369237023712372237323742375237623772378237923802381238223832384238523862387238823892390239123922393239423952396239723982399240024012402240324042405240624072408240924102411241224132414241524162417241824192420242124222423242424252426242724282429243024312432243324342435243624372438243924402441244224432444244524462447244824492450245124522453245424552456245724582459246024612462246324642465246624672468246924702471247224732474247524762477247824792480248124822483248424852486248724882489249024912492249324942495249624972498249925002501250225032504250525062507250825092510251125122513251425152516251725182519252025212522252325242525252625272528252925302531253225332534253525362537253825392540254125422543254425452546254725482549255025512552255325542555255625572558255925602561256225632564256525662567256825692570257125722573257425752576257725782579258025812582258325842585258625872588258925902591259225932594259525962597259825992600260126022603260426052606260726082609261026112612261326142615261626172618261926202621262226232624262526262627262826292630263126322633263426352636263726382639264026412642264326442645264626472648264926502651265226532654265526562657265826592660266126622663266426652666266726682669267026712672267326742675267626772678267926802681268226832684268526862687268826892690269126922693269426952696269726982699270027012702270327042705270627072708270927102711271227132714271527162717271827192720272127222723272427252726272727282729273027312732273327342735273627372738273927402741274227432744274527462747274827492750275127522753275427552756275727582759276027612762276327642765276627672768276927702771277227732774277527762777277827792780278127822783278427852786278727882789279027912792279327942795279627972798279928002801280228032804280528062807280828092810281128122813281428152816281728182819282028212822282328242825282628272828282928302831283228332834283528362837283828392840284128422843284428452846284728482849285028512852285328542855285628572858285928602861286228632864286528662867286828692870287128722873287428752876287728782879288028812882288328842885288628872888288928902891289228932894289528962897289828992900290129022903290429052906290729082909291029112912291329142915291629172918291929202921292229232924292529262927292829292930293129322933293429352936293729382939294029412942294329442945294629472948294929502951295229532954295529562957295829592960296129622963296429652966296729682969297029712972297329742975297629772978297929802981298229832984298529862987298829892990299129922993299429952996299729982999300030013002300330043005300630073008300930103011301230133014301530163017301830193020302130223023302430253026302730283029303030313032303330343035303630373038303930403041304230433044304530463047304830493050305130523053305430553056305730583059306030613062306330643065306630673068306930703071307230733074307530763077307830793080308130823083308430853086308730883089309030913092309330943095309630973098309931003101310231033104310531063107310831093110311131123113311431153116311731183119312031213122312331243125312631273128312931303131313231333134313531363137313831393140314131423143314431453146314731483149315031513152315331543155315631573158315931603161316231633164316531663167316831693170317131723173317431753176317731783179318031813182318331843185318631873188318931903191319231933194319531963197319831993200320132023203320432053206320732083209321032113212321332143215321632173218321932203221322232233224322532263227322832293230323132323233323432353236323732383239324032413242324332443245324632473248324932503251325232533254325532563257325832593260326132623263326432653266326732683269327032713272327332743275327632773278327932803281328232833284328532863287328832893290329132923293329432953296329732983299330033013302330333043305330633073308330933103311331233133314331533163317331833193320332133223323332433253326332733283329333033313332333333343335333633373338333933403341334233433344334533463347334833493350335133523353335433553356335733583359336033613362336333643365336633673368336933703371337233733374337533763377337833793380338133823383338433853386338733883389339033913392339333943395339633973398339934003401340234033404340534063407340834093410341134123413341434153416341734183419342034213422342334243425342634273428342934303431343234333434343534363437343834393440344134423443344434453446344734483449345034513452345334543455345634573458345934603461346234633464346534663467346834693470347134723473347434753476347734783479348034813482348334843485348634873488348934903491349234933494349534963497349834993500350135023503350435053506350735083509351035113512351335143515351635173518351935203521352235233524352535263527352835293530353135323533353435353536353735383539354035413542354335443545354635473548354935503551355235533554355535563557355835593560356135623563356435653566356735683569357035713572357335743575357635773578357935803581358235833584358535863587358835893590359135923593359435953596359735983599360036013602360336043605360636073608360936103611361236133614361536163617361836193620362136223623362436253626362736283629363036313632363336343635363636373638363936403641364236433644364536463647364836493650365136523653365436553656365736583659366036613662366336643665366636673668366936703671367236733674367536763677367836793680368136823683368436853686368736883689369036913692369336943695369636973698369937003701370237033704370537063707370837093710371137123713371437153716371737183719372037213722372337243725372637273728372937303731373237333734373537363737373837393740374137423743374437453746374737483749375037513752375337543755375637573758375937603761376237633764376537663767376837693770377137723773377437753776377737783779378037813782378337843785378637873788378937903791379237933794379537963797379837993800380138023803380438053806380738083809381038113812381338143815381638173818381938203821382238233824382538263827382838293830383138323833383438353836383738383839384038413842384338443845384638473848384938503851385238533854385538563857385838593860386138623863386438653866386738683869387038713872387338743875387638773878387938803881388238833884388538863887388838893890389138923893389438953896389738983899390039013902390339043905390639073908390939103911391239133914391539163917391839193920392139223923392439253926392739283929393039313932393339343935393639373938393939403941394239433944394539463947394839493950395139523953395439553956395739583959396039613962396339643965396639673968396939703971397239733974397539763977397839793980398139823983398439853986398739883989399039913992399339943995399639973998399940004001400240034004400540064007400840094010401140124013401440154016401740184019402040214022402340244025402640274028402940304031403240334034403540364037403840394040404140424043404440454046404740484049405040514052405340544055405640574058405940604061406240634064406540664067406840694070407140724073407440754076407740784079408040814082408340844085408640874088408940904091409240934094409540964097409840994100410141024103410441054106410741084109411041114112411341144115411641174118411941204121412241234124412541264127412841294130413141324133413441354136413741384139414041414142414341444145414641474148414941504151415241534154415541564157415841594160416141624163416441654166416741684169417041714172417341744175417641774178417941804181418241834184418541864187418841894190419141924193419441954196419741984199420042014202420342044205420642074208420942104211421242134214421542164217421842194220422142224223422442254226422742284229423042314232423342344235423642374238423942404241424242434244424542464247424842494250425142524253425442554256425742584259426042614262426342644265426642674268426942704271427242734274427542764277427842794280428142824283428442854286428742884289429042914292429342944295429642974298429943004301430243034304430543064307430843094310431143124313431443154316431743184319432043214322432343244325432643274328432943304331433243334334433543364337433843394340434143424343434443454346434743484349435043514352435343544355435643574358435943604361436243634364436543664367436843694370437143724373437443754376437743784379438043814382438343844385438643874388438943904391439243934394439543964397439843994400440144024403440444054406440744084409441044114412441344144415441644174418441944204421442244234424442544264427442844294430443144324433443444354436443744384439444044414442444344444445444644474448444944504451445244534454445544564457445844594460446144624463446444654466446744684469447044714472447344744475447644774478447944804481448244834484448544864487448844894490449144924493449444954496449744984499450045014502450345044505450645074508450945104511451245134514451545164517451845194520452145224523452445254526452745284529453045314532453345344535453645374538453945404541454245434544454545464547454845494550455145524553455445554556455745584559456045614562456345644565456645674568456945704571457245734574457545764577457845794580458145824583458445854586458745884589459045914592459345944595459645974598459946004601460246034604460546064607460846094610461146124613461446154616461746184619462046214622462346244625462646274628462946304631463246334634463546364637463846394640464146424643464446454646464746484649465046514652465346544655465646574658465946604661466246634664466546664667466846694670467146724673467446754676467746784679468046814682468346844685468646874688468946904691469246934694469546964697469846994700470147024703470447054706470747084709471047114712471347144715471647174718471947204721472247234724472547264727472847294730473147324733473447354736473747384739474047414742474347444745474647474748474947504751475247534754475547564757475847594760476147624763476447654766476747684769477047714772477347744775477647774778477947804781478247834784478547864787478847894790479147924793479447954796479747984799480048014802480348044805480648074808480948104811481248134814481548164817481848194820482148224823482448254826482748284829483048314832483348344835483648374838483948404841484248434844484548464847484848494850485148524853485448554856485748584859486048614862486348644865486648674868486948704871487248734874487548764877487848794880488148824883488448854886488748884889489048914892489348944895489648974898489949004901490249034904490549064907490849094910491149124913491449154916491749184919492049214922492349244925492649274928492949304931493249334934493549364937493849394940494149424943494449454946494749484949495049514952495349544955495649574958495949604961496249634964496549664967496849694970497149724973497449754976497749784979498049814982498349844985498649874988498949904991499249934994499549964997499849995000500150025003500450055006500750085009501050115012501350145015501650175018501950205021502250235024502550265027502850295030503150325033503450355036503750385039504050415042504350445045504650475048504950505051505250535054505550565057505850595060506150625063506450655066506750685069507050715072507350745075507650775078507950805081508250835084508550865087508850895090509150925093509450955096509750985099510051015102510351045105510651075108510951105111511251135114511551165117511851195120512151225123512451255126512751285129513051315132513351345135513651375138513951405141514251435144514551465147514851495150515151525153515451555156515751585159516051615162516351645165516651675168516951705171517251735174517551765177517851795180518151825183518451855186518751885189519051915192519351945195519651975198519952005201520252035204520552065207520852095210521152125213521452155216521752185219522052215222522352245225522652275228522952305231523252335234523552365237523852395240524152425243524452455246524752485249525052515252525352545255525652575258525952605261526252635264526552665267526852695270527152725273527452755276527752785279528052815282528352845285528652875288528952905291529252935294529552965297529852995300530153025303530453055306530753085309531053115312531353145315531653175318531953205321532253235324532553265327532853295330533153325333533453355336533753385339534053415342534353445345534653475348534953505351535253535354535553565357535853595360536153625363536453655366536753685369537053715372537353745375537653775378537953805381538253835384538553865387538853895390539153925393539453955396539753985399540054015402540354045405540654075408540954105411541254135414541554165417541854195420542154225423542454255426542754285429543054315432543354345435543654375438543954405441544254435444544554465447544854495450545154525453545454555456545754585459546054615462546354645465546654675468546954705471547254735474547554765477547854795480548154825483548454855486548754885489549054915492549354945495549654975498549955005501550255035504550555065507550855095510551155125513551455155516551755185519552055215522552355245525552655275528552955305531553255335534553555365537553855395540554155425543554455455546554755485549555055515552555355545555555655575558555955605561556255635564556555665567556855695570557155725573557455755576557755785579558055815582558355845585558655875588558955905591559255935594559555965597559855995600560156025603560456055606560756085609561056115612561356145615561656175618561956205621562256235624562556265627562856295630563156325633563456355636563756385639564056415642564356445645564656475648564956505651565256535654565556565657565856595660566156625663566456655666566756685669567056715672567356745675567656775678567956805681568256835684568556865687568856895690569156925693569456955696569756985699570057015702570357045705570657075708570957105711571257135714571557165717571857195720572157225723572457255726572757285729573057315732573357345735573657375738573957405741574257435744574557465747574857495750575157525753575457555756575757585759576057615762576357645765576657675768576957705771577257735774577557765777577857795780578157825783578457855786578757885789579057915792579357945795579657975798579958005801580258035804580558065807580858095810581158125813581458155816581758185819582058215822582358245825582658275828582958305831583258335834583558365837583858395840584158425843584458455846584758485849585058515852585358545855585658575858585958605861586258635864586558665867586858695870587158725873587458755876587758785879588058815882588358845885588658875888588958905891589258935894589558965897589858995900590159025903590459055906590759085909591059115912591359145915591659175918591959205921592259235924592559265927592859295930593159325933593459355936593759385939594059415942594359445945594659475948594959505951595259535954595559565957595859595960596159625963596459655966596759685969597059715972597359745975597659775978597959805981598259835984598559865987598859895990599159925993599459955996599759985999600060016002600360046005600660076008600960106011601260136014601560166017601860196020602160226023602460256026602760286029603060316032603360346035603660376038603960406041604260436044604560466047604860496050605160526053605460556056605760586059606060616062606360646065606660676068606960706071607260736074607560766077607860796080608160826083608460856086608760886089609060916092609360946095609660976098609961006101610261036104610561066107610861096110611161126113611461156116611761186119612061216122612361246125612661276128612961306131613261336134613561366137613861396140614161426143614461456146614761486149615061516152615361546155615661576158615961606161616261636164616561666167616861696170617161726173617461756176617761786179618061816182618361846185618661876188618961906191619261936194619561966197619861996200620162026203620462056206620762086209621062116212621362146215621662176218621962206221622262236224622562266227622862296230623162326233623462356236623762386239624062416242624362446245624662476248624962506251625262536254625562566257625862596260626162626263626462656266626762686269627062716272627362746275627662776278627962806281628262836284628562866287628862896290629162926293629462956296629762986299630063016302630363046305630663076308630963106311631263136314631563166317631863196320632163226323632463256326632763286329633063316332633363346335633663376338633963406341634263436344634563466347634863496350635163526353635463556356635763586359636063616362636363646365636663676368636963706371637263736374637563766377637863796380638163826383638463856386638763886389639063916392639363946395639663976398639964006401640264036404640564066407640864096410641164126413641464156416641764186419642064216422642364246425642664276428642964306431643264336434643564366437643864396440644164426443644464456446644764486449645064516452645364546455645664576458645964606461646264636464646564666467646864696470647164726473647464756476647764786479648064816482648364846485648664876488648964906491649264936494649564966497649864996500650165026503650465056506650765086509651065116512651365146515651665176518651965206521652265236524652565266527652865296530653165326533653465356536653765386539654065416542654365446545654665476548654965506551655265536554655565566557655865596560656165626563656465656566656765686569657065716572657365746575657665776578657965806581658265836584658565866587658865896590659165926593659465956596659765986599660066016602660366046605660666076608660966106611661266136614661566166617661866196620662166226623662466256626662766286629663066316632663366346635663666376638663966406641664266436644664566466647664866496650665166526653665466556656665766586659666066616662666366646665666666676668666966706671667266736674667566766677667866796680668166826683668466856686668766886689669066916692669366946695669666976698669967006701670267036704670567066707670867096710671167126713671467156716671767186719672067216722672367246725672667276728672967306731673267336734673567366737673867396740674167426743674467456746674767486749675067516752675367546755675667576758675967606761676267636764676567666767676867696770677167726773677467756776677767786779678067816782678367846785678667876788678967906791679267936794679567966797679867996800680168026803680468056806680768086809681068116812681368146815681668176818681968206821682268236824682568266827682868296830683168326833683468356836683768386839684068416842684368446845684668476848684968506851685268536854685568566857685868596860686168626863686468656866686768686869687068716872687368746875687668776878687968806881688268836884688568866887688868896890689168926893689468956896689768986899690069016902690369046905690669076908690969106911691269136914691569166917691869196920692169226923692469256926692769286929693069316932693369346935693669376938693969406941694269436944694569466947694869496950695169526953695469556956695769586959696069616962696369646965696669676968696969706971697269736974697569766977697869796980698169826983698469856986698769886989699069916992699369946995699669976998699970007001700270037004700570067007700870097010701170127013701470157016701770187019702070217022702370247025702670277028702970307031703270337034703570367037703870397040704170427043704470457046704770487049705070517052705370547055705670577058705970607061706270637064706570667067706870697070707170727073707470757076707770787079708070817082708370847085708670877088708970907091709270937094709570967097709870997100710171027103710471057106710771087109711071117112711371147115711671177118711971207121712271237124712571267127712871297130713171327133713471357136713771387139714071417142714371447145714671477148714971507151715271537154715571567157715871597160716171627163716471657166716771687169717071717172717371747175717671777178717971807181718271837184718571867187718871897190719171927193719471957196719771987199720072017202720372047205720672077208720972107211721272137214721572167217721872197220722172227223722472257226722772287229723072317232723372347235723672377238723972407241724272437244724572467247724872497250725172527253725472557256725772587259726072617262726372647265726672677268726972707271727272737274727572767277727872797280728172827283728472857286728772887289729072917292729372947295729672977298729973007301730273037304730573067307730873097310731173127313731473157316731773187319732073217322732373247325732673277328732973307331733273337334733573367337733873397340734173427343734473457346734773487349735073517352735373547355735673577358735973607361736273637364736573667367736873697370737173727373737473757376737773787379738073817382738373847385738673877388738973907391739273937394739573967397739873997400740174027403740474057406740774087409741074117412741374147415741674177418741974207421742274237424742574267427742874297430743174327433743474357436743774387439744074417442744374447445744674477448744974507451745274537454745574567457745874597460746174627463746474657466746774687469747074717472747374747475747674777478747974807481748274837484748574867487748874897490749174927493749474957496749774987499750075017502750375047505750675077508750975107511751275137514751575167517751875197520752175227523752475257526752775287529753075317532753375347535753675377538753975407541754275437544754575467547754875497550755175527553755475557556755775587559756075617562756375647565756675677568756975707571757275737574757575767577757875797580758175827583758475857586758775887589759075917592759375947595759675977598759976007601760276037604760576067607760876097610761176127613761476157616761776187619762076217622762376247625762676277628762976307631763276337634763576367637763876397640764176427643764476457646764776487649765076517652765376547655765676577658765976607661766276637664766576667667766876697670767176727673767476757676767776787679768076817682768376847685768676877688768976907691769276937694769576967697769876997700770177027703770477057706770777087709771077117712771377147715771677177718771977207721772277237724772577267727772877297730773177327733773477357736773777387739774077417742774377447745774677477748774977507751775277537754775577567757775877597760776177627763776477657766776777687769777077717772777377747775777677777778777977807781778277837784778577867787778877897790779177927793779477957796779777987799780078017802780378047805780678077808780978107811781278137814781578167817781878197820782178227823782478257826782778287829783078317832783378347835783678377838783978407841784278437844784578467847784878497850785178527853785478557856785778587859786078617862786378647865786678677868786978707871787278737874787578767877787878797880788178827883788478857886788778887889789078917892789378947895789678977898789979007901790279037904790579067907790879097910791179127913791479157916791779187919792079217922792379247925792679277928792979307931793279337934793579367937793879397940794179427943794479457946794779487949795079517952795379547955795679577958795979607961796279637964796579667967796879697970797179727973797479757976797779787979798079817982798379847985798679877988798979907991799279937994799579967997799879998000800180028003800480058006800780088009801080118012801380148015801680178018801980208021802280238024802580268027802880298030803180328033803480358036803780388039804080418042804380448045804680478048804980508051805280538054805580568057805880598060806180628063806480658066806780688069807080718072807380748075807680778078807980808081808280838084808580868087808880898090809180928093809480958096809780988099810081018102810381048105810681078108810981108111811281138114811581168117811881198120812181228123812481258126812781288129813081318132813381348135813681378138813981408141814281438144814581468147814881498150815181528153815481558156815781588159816081618162816381648165816681678168816981708171817281738174817581768177817881798180818181828183818481858186818781888189819081918192819381948195819681978198819982008201820282038204820582068207820882098210821182128213821482158216821782188219822082218222822382248225822682278228822982308231823282338234823582368237823882398240824182428243824482458246824782488249825082518252825382548255825682578258825982608261826282638264826582668267826882698270827182728273827482758276827782788279828082818282828382848285828682878288828982908291829282938294829582968297829882998300830183028303830483058306830783088309831083118312831383148315831683178318831983208321832283238324832583268327832883298330833183328333833483358336833783388339834083418342834383448345834683478348834983508351835283538354835583568357835883598360836183628363836483658366836783688369837083718372837383748375837683778378837983808381838283838384838583868387838883898390839183928393839483958396839783988399840084018402840384048405840684078408840984108411841284138414841584168417841884198420842184228423842484258426842784288429843084318432843384348435843684378438843984408441844284438444844584468447844884498450845184528453845484558456845784588459846084618462846384648465846684678468846984708471847284738474847584768477847884798480848184828483848484858486848784888489849084918492849384948495849684978498849985008501850285038504850585068507850885098510851185128513851485158516851785188519852085218522852385248525852685278528852985308531853285338534853585368537853885398540854185428543854485458546854785488549855085518552855385548555855685578558855985608561856285638564856585668567856885698570857185728573857485758576857785788579858085818582858385848585858685878588858985908591859285938594859585968597859885998600860186028603860486058606860786088609861086118612861386148615861686178618861986208621862286238624862586268627862886298630863186328633863486358636863786388639864086418642864386448645864686478648864986508651865286538654865586568657865886598660866186628663866486658666866786688669867086718672867386748675867686778678867986808681868286838684868586868687868886898690869186928693869486958696869786988699870087018702870387048705870687078708870987108711871287138714871587168717871887198720872187228723872487258726872787288729873087318732873387348735873687378738873987408741874287438744874587468747874887498750875187528753875487558756875787588759876087618762876387648765876687678768876987708771877287738774877587768777877887798780878187828783878487858786878787888789879087918792879387948795879687978798879988008801880288038804880588068807880888098810881188128813881488158816881788188819882088218822882388248825882688278828882988308831883288338834883588368837883888398840884188428843884488458846884788488849885088518852885388548855885688578858885988608861886288638864886588668867886888698870887188728873887488758876887788788879888088818882888388848885888688878888888988908891889288938894889588968897889888998900890189028903890489058906890789088909891089118912891389148915891689178918891989208921892289238924892589268927892889298930893189328933893489358936893789388939894089418942894389448945894689478948894989508951895289538954895589568957895889598960896189628963896489658966896789688969897089718972897389748975897689778978897989808981898289838984898589868987898889898990899189928993899489958996899789988999900090019002900390049005900690079008900990109011901290139014901590169017901890199020902190229023902490259026902790289029903090319032903390349035903690379038903990409041904290439044904590469047904890499050905190529053905490559056905790589059906090619062906390649065906690679068906990709071907290739074907590769077907890799080908190829083908490859086908790889089909090919092909390949095909690979098909991009101910291039104910591069107910891099110911191129113911491159116911791189119912091219122912391249125912691279128912991309131913291339134913591369137913891399140914191429143914491459146914791489149915091519152915391549155915691579158915991609161916291639164916591669167916891699170917191729173917491759176917791789179918091819182918391849185918691879188918991909191919291939194919591969197919891999200920192029203920492059206920792089209921092119212921392149215921692179218921992209221922292239224922592269227922892299230923192329233923492359236923792389239924092419242924392449245924692479248924992509251925292539254925592569257925892599260926192629263926492659266926792689269927092719272927392749275927692779278927992809281928292839284928592869287928892899290929192929293929492959296929792989299930093019302930393049305930693079308930993109311931293139314931593169317931893199320932193229323932493259326932793289329933093319332933393349335933693379338933993409341934293439344934593469347934893499350935193529353935493559356935793589359936093619362936393649365936693679368936993709371937293739374937593769377937893799380938193829383938493859386938793889389939093919392939393949395939693979398939994009401940294039404940594069407940894099410941194129413941494159416941794189419942094219422942394249425942694279428942994309431943294339434943594369437943894399440944194429443944494459446944794489449945094519452945394549455945694579458945994609461946294639464946594669467946894699470947194729473947494759476947794789479948094819482948394849485948694879488948994909491949294939494949594969497949894999500950195029503950495059506950795089509951095119512951395149515951695179518951995209521952295239524952595269527952895299530953195329533953495359536953795389539954095419542954395449545954695479548954995509551955295539554955595569557955895599560956195629563956495659566956795689569957095719572957395749575957695779578957995809581958295839584958595869587958895899590959195929593959495959596959795989599960096019602960396049605960696079608960996109611961296139614961596169617961896199620962196229623962496259626962796289629963096319632963396349635963696379638963996409641964296439644964596469647964896499650965196529653965496559656965796589659966096619662966396649665966696679668966996709671967296739674967596769677967896799680968196829683968496859686968796889689969096919692969396949695969696979698969997009701970297039704970597069707970897099710971197129713971497159716971797189719972097219722972397249725972697279728972997309731973297339734973597369737973897399740974197429743974497459746974797489749975097519752975397549755975697579758975997609761976297639764976597669767976897699770977197729773977497759776977797789779978097819782978397849785978697879788978997909791979297939794979597969797979897999800980198029803980498059806980798089809981098119812981398149815981698179818981998209821982298239824982598269827982898299830983198329833983498359836983798389839984098419842984398449845984698479848984998509851985298539854985598569857985898599860986198629863986498659866986798689869987098719872987398749875987698779878987998809881988298839884988598869887988898899890989198929893989498959896989798989899990099019902990399049905990699079908990999109911991299139914991599169917991899199920992199229923992499259926992799289929993099319932993399349935993699379938993999409941994299439944994599469947994899499950995199529953995499559956995799589959996099619962996399649965996699679968996999709971997299739974997599769977997899799980998199829983998499859986998799889989999099919992999399949995999699979998999910000100011000210003100041000510006100071000810009100101001110012100131001410015100161001710018100191002010021100221002310024100251002610027100281002910030100311003210033100341003510036100371003810039100401004110042100431004410045100461004710048100491005010051100521005310054100551005610057100581005910060100611006210063100641006510066100671006810069100701007110072100731007410075100761007710078100791008010081100821008310084100851008610087100881008910090100911009210093100941009510096100971009810099101001010110102101031010410105101061010710108101091011010111101121011310114101151011610117101181011910120101211012210123101241012510126101271012810129101301013110132101331013410135101361013710138101391014010141101421014310144101451014610147101481014910150101511015210153101541015510156101571015810159101601016110162101631016410165101661016710168101691017010171101721017310174101751017610177101781017910180101811018210183101841018510186101871018810189101901019110192101931019410195101961019710198101991020010201102021020310204102051020610207102081020910210102111021210213102141021510216102171021810219102201022110222102231022410225102261022710228102291023010231102321023310234102351023610237102381023910240102411024210243102441024510246102471024810249102501025110252102531025410255102561025710258102591026010261102621026310264102651026610267102681026910270102711027210273102741027510276102771027810279102801028110282102831028410285102861028710288102891029010291102921029310294102951029610297102981029910300103011030210303103041030510306103071030810309103101031110312103131031410315103161031710318103191032010321103221032310324103251032610327103281032910330103311033210333103341033510336103371033810339103401034110342103431034410345103461034710348103491035010351103521035310354103551035610357103581035910360103611036210363103641036510366103671036810369103701037110372103731037410375103761037710378103791038010381103821038310384103851038610387103881038910390103911039210393103941039510396103971039810399104001040110402104031040410405104061040710408104091041010411104121041310414104151041610417104181041910420104211042210423104241042510426104271042810429104301043110432104331043410435104361043710438104391044010441104421044310444104451044610447104481044910450104511045210453104541045510456104571045810459104601046110462104631046410465104661046710468104691047010471104721047310474104751047610477104781047910480104811048210483104841048510486104871048810489104901049110492104931049410495104961049710498104991050010501105021050310504105051050610507105081050910510105111051210513105141051510516105171051810519105201052110522105231052410525105261052710528105291053010531105321053310534105351053610537105381053910540105411054210543105441054510546105471054810549105501055110552105531055410555105561055710558105591056010561105621056310564105651056610567105681056910570105711057210573105741057510576105771057810579105801058110582105831058410585105861058710588105891059010591105921059310594105951059610597105981059910600106011060210603106041060510606106071060810609106101061110612106131061410615106161061710618106191062010621106221062310624106251062610627106281062910630106311063210633106341063510636106371063810639106401064110642106431064410645106461064710648106491065010651106521065310654106551065610657106581065910660106611066210663106641066510666106671066810669106701067110672106731067410675106761067710678106791068010681106821068310684106851068610687106881068910690106911069210693106941069510696106971069810699107001070110702107031070410705107061070710708107091071010711107121071310714107151071610717107181071910720107211072210723107241072510726107271072810729107301073110732107331073410735107361073710738107391074010741107421074310744107451074610747107481074910750107511075210753107541075510756107571075810759107601076110762107631076410765107661076710768107691077010771107721077310774107751077610777107781077910780107811078210783107841078510786107871078810789107901079110792107931079410795107961079710798107991080010801108021080310804108051080610807108081080910810108111081210813108141081510816108171081810819108201082110822108231082410825108261082710828108291083010831108321083310834108351083610837108381083910840108411084210843108441084510846108471084810849108501085110852108531085410855108561085710858108591086010861108621086310864108651086610867108681086910870108711087210873108741087510876108771087810879108801088110882108831088410885108861088710888108891089010891108921089310894108951089610897108981089910900109011090210903109041090510906109071090810909109101091110912109131091410915109161091710918109191092010921109221092310924109251092610927109281092910930109311093210933109341093510936109371093810939109401094110942109431094410945109461094710948109491095010951109521095310954109551095610957109581095910960109611096210963109641096510966109671096810969109701097110972109731097410975109761097710978109791098010981109821098310984109851098610987109881098910990109911099210993109941099510996109971099810999110001100111002110031100411005110061100711008110091101011011110121101311014110151101611017110181101911020110211102211023110241102511026110271102811029110301103111032110331103411035110361103711038110391104011041110421104311044110451104611047110481104911050110511105211053110541105511056110571105811059110601106111062110631106411065110661106711068110691107011071110721107311074110751107611077110781107911080110811108211083110841108511086110871108811089110901109111092110931109411095110961109711098110991110011101111021110311104111051110611107111081110911110111111111211113111141111511116111171111811119111201112111122111231112411125111261112711128111291113011131111321113311134111351113611137111381113911140111411114211143111441114511146111471114811149111501115111152111531115411155111561115711158111591116011161111621116311164111651116611167111681116911170111711117211173111741117511176111771117811179111801118111182111831118411185111861118711188111891119011191111921119311194111951119611197111981119911200112011120211203112041120511206112071120811209112101121111212112131121411215112161121711218112191122011221112221122311224112251122611227112281122911230112311123211233112341123511236112371123811239112401124111242112431124411245112461124711248112491125011251112521125311254112551125611257112581125911260112611126211263112641126511266112671126811269112701127111272112731127411275112761127711278112791128011281112821128311284112851128611287112881128911290112911129211293112941129511296112971129811299113001130111302113031130411305113061130711308113091131011311113121131311314113151131611317113181131911320113211132211323113241132511326113271132811329113301133111332113331133411335113361133711338113391134011341113421134311344113451134611347113481134911350113511135211353113541135511356113571135811359113601136111362113631136411365113661136711368113691137011371113721137311374113751137611377113781137911380113811138211383113841138511386113871138811389113901139111392113931139411395113961139711398113991140011401114021140311404114051140611407114081140911410114111141211413114141141511416114171141811419114201142111422114231142411425114261142711428114291143011431114321143311434114351143611437114381143911440114411144211443114441144511446114471144811449114501145111452114531145411455114561145711458114591146011461114621146311464114651146611467114681146911470114711147211473114741147511476114771147811479114801148111482114831148411485114861148711488114891149011491114921149311494114951149611497114981149911500115011150211503115041150511506115071150811509115101151111512115131151411515115161151711518115191152011521115221152311524115251152611527115281152911530115311153211533115341153511536115371153811539115401154111542115431154411545115461154711548115491155011551115521155311554115551155611557115581155911560115611156211563115641156511566115671156811569115701157111572115731157411575115761157711578115791158011581115821158311584115851158611587115881158911590115911159211593115941159511596115971159811599116001160111602116031160411605116061160711608116091161011611116121161311614116151161611617116181161911620116211162211623116241162511626116271162811629116301163111632116331163411635116361163711638116391164011641116421164311644116451164611647116481164911650116511165211653116541165511656116571165811659116601166111662116631166411665116661166711668116691167011671116721167311674116751167611677116781167911680116811168211683116841168511686116871168811689116901169111692116931169411695116961169711698116991170011701117021170311704117051170611707117081170911710117111171211713117141171511716117171171811719117201172111722117231172411725117261172711728117291173011731117321173311734117351173611737117381173911740117411174211743117441174511746117471174811749117501175111752117531175411755117561175711758117591176011761117621176311764117651176611767117681176911770117711177211773117741177511776117771177811779117801178111782117831178411785117861178711788117891179011791117921179311794117951179611797117981179911800118011180211803118041180511806118071180811809118101181111812118131181411815118161181711818118191182011821118221182311824118251182611827118281182911830118311183211833118341183511836118371183811839118401184111842118431184411845118461184711848118491185011851118521185311854118551185611857118581185911860118611186211863118641186511866118671186811869118701187111872118731187411875118761187711878118791188011881118821188311884118851188611887118881188911890118911189211893118941189511896118971189811899119001190111902119031190411905119061190711908119091191011911119121191311914119151191611917119181191911920119211192211923119241192511926119271192811929119301193111932119331193411935119361193711938119391194011941119421194311944119451194611947119481194911950119511195211953119541195511956119571195811959119601196111962119631196411965119661196711968119691197011971119721197311974119751197611977119781197911980119811198211983119841198511986119871198811989119901199111992119931199411995119961199711998119991200012001120021200312004120051200612007120081200912010120111201212013120141201512016120171201812019120201202112022120231202412025120261202712028120291203012031120321203312034120351203612037120381203912040120411204212043120441204512046120471204812049120501205112052120531205412055120561205712058120591206012061120621206312064120651206612067120681206912070120711207212073120741207512076120771207812079120801208112082120831208412085120861208712088120891209012091120921209312094120951209612097120981209912100121011210212103121041210512106121071210812109121101211112112121131211412115121161211712118121191212012121121221212312124121251212612127121281212912130121311213212133121341213512136121371213812139121401214112142121431214412145121461214712148121491215012151121521215312154121551215612157121581215912160121611216212163121641216512166121671216812169121701217112172121731217412175121761217712178121791218012181121821218312184121851218612187121881218912190121911219212193121941219512196121971219812199122001220112202122031220412205122061220712208122091221012211122121221312214122151221612217122181221912220122211222212223122241222512226122271222812229122301223112232122331223412235122361223712238122391224012241122421224312244122451224612247122481224912250122511225212253122541225512256122571225812259122601226112262122631226412265122661226712268122691227012271122721227312274122751227612277122781227912280122811228212283122841228512286122871228812289122901229112292122931229412295122961229712298122991230012301123021230312304123051230612307123081230912310123111231212313123141231512316123171231812319123201232112322123231232412325123261232712328123291233012331123321233312334123351233612337123381233912340123411234212343123441234512346123471234812349123501235112352123531235412355123561235712358123591236012361123621236312364123651236612367123681236912370123711237212373123741237512376123771237812379123801238112382123831238412385123861238712388123891239012391123921239312394123951239612397123981239912400124011240212403124041240512406124071240812409124101241112412124131241412415124161241712418124191242012421124221242312424124251242612427124281242912430124311243212433124341243512436124371243812439124401244112442124431244412445124461244712448124491245012451124521245312454124551245612457124581245912460124611246212463124641246512466124671246812469124701247112472124731247412475124761247712478124791248012481124821248312484124851248612487124881248912490124911249212493124941249512496124971249812499125001250112502125031250412505125061250712508125091251012511125121251312514125151251612517125181251912520125211252212523125241252512526125271252812529125301253112532125331253412535125361253712538125391254012541125421254312544125451254612547125481254912550125511255212553125541255512556125571255812559125601256112562125631256412565125661256712568125691257012571125721257312574125751257612577125781257912580125811258212583125841258512586125871258812589125901259112592125931259412595125961259712598125991260012601126021260312604126051260612607126081260912610126111261212613126141261512616126171261812619126201262112622126231262412625126261262712628126291263012631126321263312634126351263612637126381263912640126411264212643126441264512646126471264812649126501265112652126531265412655126561265712658126591266012661126621266312664126651266612667126681266912670126711267212673126741267512676126771267812679126801268112682126831268412685126861268712688126891269012691126921269312694126951269612697126981269912700127011270212703127041270512706127071270812709127101271112712127131271412715127161271712718127191272012721127221272312724127251272612727127281272912730127311273212733127341273512736127371273812739127401274112742127431274412745127461274712748127491275012751127521275312754127551275612757127581275912760127611276212763127641276512766127671276812769127701277112772127731277412775127761277712778127791278012781127821278312784127851278612787127881278912790127911279212793127941279512796127971279812799128001280112802128031280412805128061280712808128091281012811128121281312814128151281612817128181281912820128211282212823128241282512826128271282812829128301283112832128331283412835128361283712838128391284012841128421284312844128451284612847128481284912850128511285212853128541285512856128571285812859128601286112862128631286412865128661286712868128691287012871128721287312874128751287612877128781287912880128811288212883128841288512886128871288812889128901289112892128931289412895128961289712898128991290012901129021290312904129051290612907129081290912910129111291212913129141291512916129171291812919129201292112922129231292412925129261292712928129291293012931129321293312934129351293612937129381293912940129411294212943129441294512946129471294812949129501295112952129531295412955129561295712958129591296012961129621296312964129651296612967129681296912970129711297212973129741297512976129771297812979129801298112982129831298412985129861298712988129891299012991129921299312994129951299612997129981299913000130011300213003130041300513006130071300813009130101301113012130131301413015130161301713018130191302013021130221302313024130251302613027130281302913030130311303213033130341303513036130371303813039130401304113042130431304413045130461304713048130491305013051130521305313054130551305613057130581305913060130611306213063130641306513066130671306813069130701307113072130731307413075130761307713078130791308013081130821308313084130851308613087130881308913090130911309213093130941309513096130971309813099131001310113102131031310413105131061310713108131091311013111131121311313114131151311613117131181311913120131211312213123131241312513126131271312813129131301313113132131331313413135131361313713138131391314013141131421314313144131451314613147131481314913150131511315213153131541315513156131571315813159131601316113162131631316413165131661316713168131691317013171131721317313174131751317613177131781317913180131811318213183131841318513186131871318813189131901319113192131931319413195131961319713198131991320013201132021320313204132051320613207132081320913210132111321213213132141321513216132171321813219132201322113222132231322413225132261322713228132291323013231132321323313234132351323613237132381323913240132411324213243132441324513246132471324813249132501325113252132531325413255132561325713258132591326013261132621326313264132651326613267132681326913270132711327213273132741327513276132771327813279132801328113282132831328413285132861328713288132891329013291132921329313294132951329613297132981329913300133011330213303133041330513306133071330813309133101331113312133131331413315133161331713318133191332013321133221332313324133251332613327133281332913330133311333213333133341333513336133371333813339133401334113342133431334413345133461334713348133491335013351133521335313354133551335613357133581335913360133611336213363133641336513366133671336813369133701337113372133731337413375133761337713378133791338013381133821338313384133851338613387133881338913390133911339213393133941339513396133971339813399134001340113402134031340413405134061340713408134091341013411134121341313414134151341613417134181341913420134211342213423134241342513426134271342813429134301343113432134331343413435134361343713438134391344013441134421344313444134451344613447134481344913450134511345213453134541345513456134571345813459134601346113462134631346413465134661346713468134691347013471134721347313474134751347613477134781347913480134811348213483134841348513486134871348813489134901349113492134931349413495134961349713498134991350013501135021350313504135051350613507135081350913510135111351213513135141351513516135171351813519135201352113522135231352413525135261352713528135291353013531135321353313534135351353613537135381353913540135411354213543135441354513546135471354813549135501355113552135531355413555135561355713558135591356013561135621356313564135651356613567135681356913570135711357213573135741357513576135771357813579135801358113582135831358413585135861358713588135891359013591135921359313594135951359613597135981359913600136011360213603136041360513606136071360813609136101361113612136131361413615136161361713618136191362013621136221362313624136251362613627136281362913630136311363213633136341363513636136371363813639136401364113642136431364413645136461364713648136491365013651136521365313654136551365613657136581365913660136611366213663136641366513666136671366813669136701367113672136731367413675136761367713678136791368013681136821368313684136851368613687136881368913690136911369213693136941369513696136971369813699137001370113702137031370413705137061370713708137091371013711137121371313714137151371613717137181371913720137211372213723137241372513726137271372813729137301373113732137331373413735137361373713738137391374013741137421374313744137451374613747137481374913750137511375213753137541375513756137571375813759137601376113762137631376413765137661376713768137691377013771137721377313774137751377613777137781377913780137811378213783137841378513786137871378813789137901379113792137931379413795137961379713798137991380013801138021380313804138051380613807138081380913810138111381213813138141381513816138171381813819138201382113822138231382413825138261382713828138291383013831138321383313834138351383613837138381383913840138411384213843138441384513846138471384813849138501385113852138531385413855138561385713858138591386013861138621386313864138651386613867138681386913870138711387213873138741387513876138771387813879138801388113882138831388413885138861388713888138891389013891138921389313894138951389613897138981389913900139011390213903139041390513906139071390813909139101391113912139131391413915139161391713918139191392013921139221392313924139251392613927139281392913930139311393213933139341393513936139371393813939139401394113942139431394413945139461394713948139491395013951139521395313954139551395613957139581395913960139611396213963139641396513966139671396813969139701397113972139731397413975139761397713978139791398013981139821398313984139851398613987139881398913990139911399213993139941399513996139971399813999140001400114002140031400414005140061400714008140091401014011140121401314014140151401614017140181401914020140211402214023140241402514026140271402814029140301403114032140331403414035140361403714038140391404014041140421404314044140451404614047140481404914050140511405214053140541405514056140571405814059140601406114062140631406414065140661406714068140691407014071140721407314074140751407614077140781407914080140811408214083140841408514086140871408814089140901409114092140931409414095140961409714098140991410014101141021410314104141051410614107141081410914110141111411214113141141411514116141171411814119141201412114122141231412414125141261412714128141291413014131141321413314134141351413614137141381413914140141411414214143141441414514146141471414814149141501415114152141531415414155141561415714158141591416014161141621416314164141651416614167141681416914170141711417214173141741417514176141771417814179141801418114182141831418414185141861418714188141891419014191141921419314194141951419614197141981419914200142011420214203142041420514206142071420814209142101421114212142131421414215142161421714218142191422014221142221422314224142251422614227142281422914230142311423214233142341423514236142371423814239142401424114242142431424414245142461424714248142491425014251142521425314254142551425614257142581425914260142611426214263142641426514266142671426814269142701427114272142731427414275142761427714278142791428014281142821428314284142851428614287142881428914290142911429214293142941429514296142971429814299143001430114302143031430414305143061430714308143091431014311143121431314314143151431614317143181431914320143211432214323143241432514326143271432814329143301433114332143331433414335143361433714338143391434014341143421434314344143451434614347143481434914350143511435214353143541435514356143571435814359143601436114362143631436414365143661436714368143691437014371143721437314374143751437614377143781437914380143811438214383143841438514386143871438814389143901439114392143931439414395143961439714398143991440014401144021440314404144051440614407144081440914410144111441214413144141441514416144171441814419144201442114422144231442414425144261442714428144291443014431144321443314434144351443614437144381443914440144411444214443144441444514446144471444814449144501445114452144531445414455144561445714458144591446014461144621446314464144651446614467144681446914470144711447214473144741447514476144771447814479144801448114482144831448414485144861448714488144891449014491144921449314494144951449614497144981449914500145011450214503145041450514506145071450814509145101451114512145131451414515145161451714518145191452014521145221452314524145251452614527145281452914530145311453214533145341453514536145371453814539145401454114542145431454414545145461454714548145491455014551145521455314554145551455614557145581455914560145611456214563145641456514566145671456814569145701457114572145731457414575145761457714578145791458014581145821458314584145851458614587145881458914590145911459214593145941459514596145971459814599146001460114602146031460414605146061460714608146091461014611146121461314614146151461614617146181461914620146211462214623146241462514626146271462814629146301463114632146331463414635146361463714638146391464014641146421464314644146451464614647146481464914650146511465214653146541465514656146571465814659146601466114662146631466414665146661466714668146691467014671146721467314674146751467614677146781467914680146811468214683146841468514686146871468814689146901469114692146931469414695146961469714698146991470014701147021470314704147051470614707147081470914710147111471214713147141471514716147171471814719147201472114722147231472414725147261472714728147291473014731147321473314734147351473614737147381473914740147411474214743147441474514746147471474814749147501475114752147531475414755147561475714758147591476014761147621476314764147651476614767147681476914770147711477214773147741477514776147771477814779147801478114782147831478414785147861478714788147891479014791147921479314794147951479614797147981479914800148011480214803148041480514806148071480814809148101481114812148131481414815148161481714818148191482014821148221482314824148251482614827148281482914830148311483214833148341483514836148371483814839148401484114842148431484414845148461484714848148491485014851148521485314854148551485614857148581485914860148611486214863148641486514866148671486814869148701487114872148731487414875148761487714878148791488014881148821488314884148851488614887148881488914890148911489214893148941489514896148971489814899149001490114902149031490414905149061490714908149091491014911149121491314914149151491614917149181491914920149211492214923149241492514926149271492814929149301493114932149331493414935149361493714938149391494014941149421494314944149451494614947149481494914950149511495214953149541495514956149571495814959149601496114962149631496414965149661496714968149691497014971149721497314974149751497614977149781497914980149811498214983149841498514986149871498814989149901499114992149931499414995149961499714998149991500015001150021500315004150051500615007150081500915010150111501215013150141501515016150171501815019150201502115022150231502415025150261502715028150291503015031150321503315034150351503615037150381503915040150411504215043150441504515046150471504815049150501505115052150531505415055150561505715058150591506015061150621506315064150651506615067150681506915070150711507215073150741507515076150771507815079150801508115082150831508415085150861508715088150891509015091150921509315094150951509615097150981509915100151011510215103151041510515106151071510815109151101511115112151131511415115151161511715118151191512015121151221512315124151251512615127151281512915130151311513215133151341513515136151371513815139151401514115142151431514415145151461514715148151491515015151151521515315154151551515615157151581515915160151611516215163151641516515166151671516815169151701517115172151731517415175151761517715178151791518015181151821518315184151851518615187151881518915190151911519215193151941519515196151971519815199152001520115202152031520415205152061520715208152091521015211152121521315214152151521615217152181521915220152211522215223152241522515226152271522815229152301523115232152331523415235152361523715238152391524015241152421524315244152451524615247152481524915250152511525215253152541525515256152571525815259152601526115262152631526415265152661526715268152691527015271152721527315274152751527615277152781527915280152811528215283152841528515286152871528815289152901529115292152931529415295152961529715298152991530015301153021530315304153051530615307153081530915310153111531215313153141531515316153171531815319153201532115322153231532415325153261532715328153291533015331153321533315334153351533615337153381533915340153411534215343153441534515346153471534815349153501535115352153531535415355153561535715358153591536015361153621536315364153651536615367153681536915370153711537215373153741537515376153771537815379153801538115382153831538415385153861538715388153891539015391153921539315394153951539615397153981539915400154011540215403154041540515406154071540815409154101541115412154131541415415154161541715418154191542015421154221542315424154251542615427154281542915430154311543215433154341543515436154371543815439154401544115442154431544415445154461544715448154491545015451154521545315454154551545615457154581545915460154611546215463154641546515466154671546815469154701547115472154731547415475154761547715478154791548015481154821548315484154851548615487154881548915490154911549215493154941549515496154971549815499155001550115502155031550415505155061550715508155091551015511155121551315514155151551615517155181551915520155211552215523155241552515526155271552815529155301553115532155331553415535155361553715538155391554015541155421554315544155451554615547155481554915550155511555215553155541555515556155571555815559155601556115562155631556415565155661556715568155691557015571155721557315574155751557615577155781557915580155811558215583155841558515586155871558815589155901559115592155931559415595155961559715598155991560015601156021560315604156051560615607156081560915610156111561215613156141561515616156171561815619156201562115622156231562415625156261562715628156291563015631156321563315634156351563615637156381563915640156411564215643156441564515646156471564815649156501565115652156531565415655156561565715658156591566015661156621566315664156651566615667156681566915670156711567215673156741567515676156771567815679156801568115682156831568415685156861568715688156891569015691156921569315694156951569615697156981569915700157011570215703157041570515706157071570815709157101571115712157131571415715157161571715718157191572015721157221572315724157251572615727157281572915730157311573215733157341573515736157371573815739157401574115742157431574415745157461574715748157491575015751157521575315754157551575615757157581575915760157611576215763157641576515766157671576815769157701577115772157731577415775157761577715778157791578015781157821578315784157851578615787157881578915790157911579215793157941579515796157971579815799158001580115802158031580415805158061580715808158091581015811158121581315814158151581615817158181581915820158211582215823158241582515826158271582815829158301583115832158331583415835158361583715838158391584015841158421584315844158451584615847158481584915850158511585215853158541585515856158571585815859158601586115862158631586415865158661586715868158691587015871158721587315874158751587615877158781587915880158811588215883158841588515886158871588815889158901589115892158931589415895158961589715898158991590015901159021590315904159051590615907159081590915910159111591215913159141591515916159171591815919159201592115922159231592415925159261592715928159291593015931159321593315934159351593615937159381593915940159411594215943159441594515946159471594815949159501595115952159531595415955159561595715958159591596015961159621596315964159651596615967159681596915970159711597215973159741597515976159771597815979159801598115982159831598415985159861598715988159891599015991159921599315994159951599615997159981599916000160011600216003160041600516006160071600816009160101601116012160131601416015160161601716018160191602016021160221602316024160251602616027160281602916030160311603216033160341603516036160371603816039160401604116042160431604416045160461604716048160491605016051160521605316054160551605616057160581605916060160611606216063160641606516066160671606816069160701607116072160731607416075160761607716078160791608016081160821608316084160851608616087160881608916090160911609216093160941609516096160971609816099161001610116102161031610416105161061610716108161091611016111161121611316114161151611616117161181611916120161211612216123161241612516126161271612816129161301613116132161331613416135161361613716138161391614016141161421614316144161451614616147161481614916150161511615216153161541615516156161571615816159161601616116162161631616416165161661616716168161691617016171161721617316174161751617616177161781617916180161811618216183161841618516186161871618816189161901619116192161931619416195161961619716198161991620016201162021620316204162051620616207162081620916210162111621216213162141621516216162171621816219162201622116222162231622416225162261622716228162291623016231162321623316234162351623616237162381623916240162411624216243162441624516246162471624816249162501625116252162531625416255162561625716258162591626016261162621626316264162651626616267162681626916270162711627216273162741627516276162771627816279162801628116282162831628416285162861628716288162891629016291162921629316294162951629616297162981629916300163011630216303163041630516306163071630816309163101631116312163131631416315163161631716318163191632016321163221632316324163251632616327163281632916330163311633216333163341633516336163371633816339163401634116342163431634416345163461634716348163491635016351163521635316354163551635616357163581635916360163611636216363163641636516366163671636816369163701637116372163731637416375163761637716378163791638016381163821638316384163851638616387163881638916390163911639216393163941639516396163971639816399164001640116402164031640416405164061640716408164091641016411164121641316414164151641616417164181641916420164211642216423164241642516426164271642816429164301643116432164331643416435164361643716438164391644016441164421644316444164451644616447164481644916450164511645216453164541645516456164571645816459164601646116462164631646416465164661646716468164691647016471164721647316474164751647616477164781647916480164811648216483164841648516486164871648816489164901649116492164931649416495164961649716498164991650016501165021650316504165051650616507165081650916510165111651216513165141651516516165171651816519165201652116522165231652416525165261652716528165291653016531165321653316534165351653616537165381653916540165411654216543165441654516546165471654816549165501655116552165531655416555165561655716558165591656016561165621656316564165651656616567165681656916570165711657216573165741657516576165771657816579165801658116582165831658416585165861658716588165891659016591165921659316594165951659616597165981659916600166011660216603166041660516606166071660816609166101661116612166131661416615166161661716618166191662016621166221662316624166251662616627166281662916630166311663216633166341663516636166371663816639166401664116642166431664416645166461664716648166491665016651166521665316654166551665616657166581665916660166611666216663166641666516666166671666816669166701667116672166731667416675166761667716678166791668016681166821668316684166851668616687166881668916690166911669216693166941669516696166971669816699167001670116702167031670416705167061670716708167091671016711167121671316714167151671616717167181671916720167211672216723167241672516726167271672816729167301673116732167331673416735167361673716738167391674016741167421674316744167451674616747167481674916750167511675216753167541675516756167571675816759167601676116762167631676416765167661676716768167691677016771167721677316774167751677616777167781677916780167811678216783167841678516786167871678816789167901679116792167931679416795167961679716798167991680016801168021680316804168051680616807168081680916810168111681216813168141681516816168171681816819168201682116822168231682416825168261682716828168291683016831168321683316834168351683616837168381683916840168411684216843168441684516846168471684816849168501685116852168531685416855168561685716858168591686016861168621686316864168651686616867168681686916870168711687216873168741687516876168771687816879168801688116882168831688416885168861688716888168891689016891168921689316894168951689616897168981689916900169011690216903169041690516906169071690816909169101691116912169131691416915169161691716918169191692016921169221692316924169251692616927169281692916930169311693216933169341693516936169371693816939169401694116942169431694416945169461694716948169491695016951169521695316954169551695616957169581695916960169611696216963169641696516966169671696816969169701697116972169731697416975169761697716978169791698016981169821698316984169851698616987169881698916990169911699216993169941699516996169971699816999170001700117002170031700417005170061700717008170091701017011170121701317014170151701617017170181701917020170211702217023170241702517026170271702817029170301703117032170331703417035170361703717038170391704017041170421704317044170451704617047170481704917050170511705217053170541705517056170571705817059170601706117062170631706417065170661706717068170691707017071170721707317074170751707617077170781707917080170811708217083170841708517086170871708817089170901709117092170931709417095170961709717098170991710017101171021710317104171051710617107171081710917110171111711217113171141711517116171171711817119171201712117122171231712417125171261712717128171291713017131171321713317134171351713617137171381713917140171411714217143171441714517146171471714817149171501715117152171531715417155171561715717158171591716017161171621716317164171651716617167171681716917170171711717217173171741717517176171771717817179171801718117182171831718417185171861718717188171891719017191171921719317194171951719617197171981719917200172011720217203172041720517206172071720817209172101721117212172131721417215172161721717218172191722017221172221722317224172251722617227172281722917230172311723217233172341723517236172371723817239172401724117242172431724417245172461724717248172491725017251172521725317254172551725617257172581725917260172611726217263172641726517266172671726817269172701727117272172731727417275172761727717278172791728017281172821728317284172851728617287172881728917290172911729217293172941729517296172971729817299173001730117302173031730417305173061730717308173091731017311173121731317314173151731617317173181731917320173211732217323173241732517326173271732817329173301733117332173331733417335173361733717338173391734017341173421734317344173451734617347173481734917350173511735217353173541735517356173571735817359173601736117362173631736417365173661736717368173691737017371173721737317374173751737617377173781737917380173811738217383173841738517386173871738817389173901739117392173931739417395173961739717398173991740017401174021740317404174051740617407174081740917410174111741217413174141741517416174171741817419174201742117422174231742417425174261742717428174291743017431174321743317434174351743617437174381743917440174411744217443174441744517446174471744817449174501745117452174531745417455174561745717458174591746017461174621746317464174651746617467174681746917470174711747217473174741747517476174771747817479174801748117482174831748417485174861748717488174891749017491174921749317494174951749617497174981749917500175011750217503175041750517506175071750817509175101751117512175131751417515175161751717518175191752017521175221752317524175251752617527175281752917530175311753217533175341753517536175371753817539175401754117542175431754417545175461754717548175491755017551175521755317554175551755617557175581755917560175611756217563175641756517566175671756817569175701757117572175731757417575175761757717578175791758017581175821758317584175851758617587175881758917590175911759217593175941759517596175971759817599176001760117602176031760417605176061760717608176091761017611176121761317614176151761617617176181761917620176211762217623176241762517626176271762817629176301763117632176331763417635176361763717638176391764017641176421764317644176451764617647176481764917650176511765217653176541765517656176571765817659176601766117662176631766417665176661766717668176691767017671176721767317674176751767617677176781767917680176811768217683176841768517686176871768817689176901769117692176931769417695176961769717698176991770017701177021770317704177051770617707177081770917710177111771217713177141771517716177171771817719177201772117722177231772417725177261772717728177291773017731177321773317734177351773617737177381773917740177411774217743177441774517746177471774817749177501775117752177531775417755177561775717758177591776017761177621776317764177651776617767177681776917770177711777217773177741777517776177771777817779177801778117782177831778417785177861778717788177891779017791177921779317794177951779617797177981779917800178011780217803178041780517806178071780817809178101781117812178131781417815178161781717818178191782017821178221782317824178251782617827178281782917830178311783217833178341783517836178371783817839178401784117842178431784417845178461784717848178491785017851178521785317854178551785617857178581785917860178611786217863178641786517866178671786817869178701787117872178731787417875178761787717878178791788017881178821788317884178851788617887178881788917890178911789217893178941789517896178971789817899179001790117902179031790417905179061790717908179091791017911179121791317914179151791617917179181791917920179211792217923179241792517926179271792817929179301793117932179331793417935179361793717938179391794017941179421794317944179451794617947179481794917950179511795217953179541795517956179571795817959179601796117962179631796417965179661796717968179691797017971179721797317974179751797617977179781797917980179811798217983179841798517986179871798817989179901799117992179931799417995179961799717998179991800018001180021800318004180051800618007180081800918010180111801218013180141801518016180171801818019180201802118022180231802418025180261802718028180291803018031180321803318034180351803618037180381803918040180411804218043180441804518046180471804818049180501805118052180531805418055180561805718058180591806018061180621806318064180651806618067180681806918070180711807218073180741807518076180771807818079180801808118082180831808418085180861808718088180891809018091180921809318094180951809618097180981809918100181011810218103181041810518106181071810818109181101811118112181131811418115181161811718118181191812018121181221812318124181251812618127181281812918130181311813218133181341813518136181371813818139181401814118142181431814418145181461814718148181491815018151181521815318154181551815618157181581815918160181611816218163181641816518166181671816818169181701817118172181731817418175181761817718178181791818018181181821818318184181851818618187181881818918190181911819218193181941819518196181971819818199182001820118202182031820418205182061820718208182091821018211182121821318214182151821618217182181821918220182211822218223182241822518226182271822818229182301823118232182331823418235182361823718238182391824018241182421824318244182451824618247182481824918250182511825218253182541825518256182571825818259182601826118262182631826418265182661826718268182691827018271182721827318274182751827618277182781827918280182811828218283182841828518286182871828818289182901829118292182931829418295182961829718298182991830018301183021830318304183051830618307183081830918310183111831218313183141831518316183171831818319183201832118322183231832418325183261832718328183291833018331183321833318334183351833618337183381833918340183411834218343183441834518346183471834818349183501835118352183531835418355183561835718358183591836018361183621836318364183651836618367183681836918370183711837218373183741837518376183771837818379183801838118382183831838418385183861838718388183891839018391183921839318394183951839618397183981839918400184011840218403184041840518406184071840818409184101841118412184131841418415184161841718418184191842018421184221842318424184251842618427184281842918430184311843218433184341843518436184371843818439184401844118442184431844418445184461844718448184491845018451184521845318454184551845618457184581845918460184611846218463184641846518466184671846818469184701847118472184731847418475184761847718478184791848018481184821848318484184851848618487184881848918490184911849218493184941849518496184971849818499185001850118502185031850418505185061850718508185091851018511185121851318514185151851618517185181851918520185211852218523185241852518526185271852818529185301853118532185331853418535185361853718538185391854018541185421854318544185451854618547185481854918550185511855218553185541855518556185571855818559185601856118562185631856418565185661856718568185691857018571185721857318574185751857618577185781857918580185811858218583185841858518586185871858818589185901859118592185931859418595185961859718598185991860018601186021860318604186051860618607186081860918610186111861218613186141861518616186171861818619186201862118622186231862418625186261862718628186291863018631186321863318634186351863618637186381863918640186411864218643186441864518646186471864818649186501865118652186531865418655186561865718658186591866018661186621866318664186651866618667186681866918670186711867218673186741867518676186771867818679186801868118682186831868418685186861868718688186891869018691186921869318694186951869618697186981869918700187011870218703187041870518706187071870818709187101871118712187131871418715187161871718718187191872018721187221872318724187251872618727187281872918730187311873218733187341873518736187371873818739187401874118742187431874418745187461874718748187491875018751187521875318754187551875618757187581875918760187611876218763187641876518766187671876818769187701877118772187731877418775187761877718778187791878018781187821878318784187851878618787187881878918790187911879218793187941879518796187971879818799188001880118802188031880418805188061880718808188091881018811188121881318814188151881618817188181881918820188211882218823188241882518826188271882818829188301883118832188331883418835188361883718838188391884018841188421884318844188451884618847188481884918850188511885218853188541885518856188571885818859188601886118862188631886418865188661886718868188691887018871188721887318874188751887618877188781887918880188811888218883188841888518886188871888818889188901889118892188931889418895188961889718898188991890018901189021890318904189051890618907189081890918910189111891218913189141891518916189171891818919189201892118922189231892418925189261892718928189291893018931189321893318934189351893618937189381893918940189411894218943189441894518946189471894818949189501895118952189531895418955189561895718958189591896018961189621896318964189651896618967189681896918970189711897218973189741897518976189771897818979189801898118982189831898418985189861898718988189891899018991189921899318994189951899618997189981899919000190011900219003190041900519006190071900819009190101901119012190131901419015190161901719018190191902019021190221902319024190251902619027190281902919030190311903219033190341903519036190371903819039190401904119042190431904419045190461904719048190491905019051190521905319054190551905619057190581905919060190611906219063190641906519066190671906819069190701907119072190731907419075190761907719078190791908019081190821908319084190851908619087190881908919090190911909219093190941909519096190971909819099191001910119102191031910419105191061910719108191091911019111191121911319114191151911619117191181911919120191211912219123191241912519126191271912819129191301913119132191331913419135191361913719138191391914019141191421914319144191451914619147191481914919150191511915219153191541915519156191571915819159191601916119162191631916419165191661916719168191691917019171191721917319174191751917619177191781917919180191811918219183191841918519186191871918819189191901919119192191931919419195191961919719198191991920019201192021920319204192051920619207192081920919210192111921219213192141921519216192171921819219192201922119222192231922419225192261922719228192291923019231192321923319234192351923619237192381923919240192411924219243192441924519246192471924819249192501925119252192531925419255192561925719258192591926019261192621926319264192651926619267192681926919270192711927219273192741927519276192771927819279192801928119282192831928419285192861928719288192891929019291192921929319294192951929619297192981929919300193011930219303193041930519306193071930819309193101931119312193131931419315193161931719318193191932019321193221932319324193251932619327193281932919330193311933219333193341933519336193371933819339193401934119342193431934419345193461934719348193491935019351193521935319354193551935619357193581935919360193611936219363193641936519366193671936819369193701937119372193731937419375193761937719378193791938019381193821938319384193851938619387193881938919390193911939219393193941939519396193971939819399194001940119402194031940419405194061940719408194091941019411194121941319414194151941619417194181941919420194211942219423194241942519426194271942819429194301943119432194331943419435194361943719438194391944019441194421944319444194451944619447194481944919450194511945219453194541945519456194571945819459194601946119462194631946419465194661946719468194691947019471194721947319474194751947619477194781947919480194811948219483194841948519486194871948819489194901949119492194931949419495194961949719498194991950019501195021950319504195051950619507195081950919510195111951219513195141951519516195171951819519195201952119522195231952419525195261952719528195291953019531195321953319534195351953619537195381953919540195411954219543195441954519546195471954819549195501955119552195531955419555195561955719558195591956019561195621956319564195651956619567195681956919570195711957219573195741957519576195771957819579195801958119582195831958419585195861958719588195891959019591195921959319594195951959619597195981959919600196011960219603196041960519606196071960819609196101961119612196131961419615196161961719618196191962019621196221962319624196251962619627196281962919630196311963219633196341963519636196371963819639196401964119642196431964419645196461964719648196491965019651196521965319654196551965619657196581965919660196611966219663196641966519666196671966819669196701967119672196731967419675196761967719678196791968019681196821968319684196851968619687196881968919690196911969219693196941969519696196971969819699197001970119702197031970419705197061970719708197091971019711197121971319714197151971619717197181971919720197211972219723197241972519726197271972819729197301973119732197331973419735197361973719738197391974019741197421974319744197451974619747197481974919750197511975219753197541975519756197571975819759197601976119762197631976419765197661976719768197691977019771197721977319774197751977619777197781977919780197811978219783197841978519786197871978819789197901979119792197931979419795197961979719798197991980019801198021980319804198051980619807198081980919810198111981219813198141981519816198171981819819198201982119822198231982419825198261982719828198291983019831198321983319834198351983619837198381983919840198411984219843198441984519846198471984819849198501985119852198531985419855198561985719858198591986019861198621986319864198651986619867198681986919870198711987219873198741987519876198771987819879198801988119882198831988419885198861988719888198891989019891198921989319894198951989619897198981989919900199011990219903199041990519906199071990819909199101991119912199131991419915199161991719918199191992019921199221992319924199251992619927199281992919930199311993219933199341993519936199371993819939199401994119942199431994419945199461994719948199491995019951199521995319954199551995619957199581995919960199611996219963199641996519966199671996819969199701997119972199731997419975199761997719978199791998019981199821998319984199851998619987199881998919990199911999219993199941999519996199971999819999200002000120002200032000420005200062000720008200092001020011200122001320014200152001620017200182001920020200212002220023200242002520026200272002820029200302003120032200332003420035200362003720038200392004020041200422004320044200452004620047200482004920050200512005220053200542005520056200572005820059200602006120062200632006420065200662006720068200692007020071200722007320074200752007620077200782007920080200812008220083200842008520086200872008820089200902009120092200932009420095200962009720098200992010020101201022010320104201052010620107201082010920110201112011220113201142011520116201172011820119201202012120122201232012420125201262012720128201292013020131201322013320134201352013620137201382013920140201412014220143201442014520146201472014820149201502015120152201532015420155201562015720158201592016020161201622016320164201652016620167201682016920170201712017220173201742017520176201772017820179201802018120182201832018420185201862018720188201892019020191201922019320194201952019620197201982019920200202012020220203202042020520206202072020820209202102021120212202132021420215202162021720218202192022020221202222022320224202252022620227202282022920230202312023220233202342023520236202372023820239202402024120242202432024420245202462024720248202492025020251202522025320254202552025620257202582025920260202612026220263202642026520266202672026820269202702027120272202732027420275202762027720278202792028020281202822028320284202852028620287202882028920290202912029220293202942029520296202972029820299203002030120302203032030420305203062030720308203092031020311203122031320314203152031620317203182031920320203212032220323203242032520326203272032820329203302033120332203332033420335203362033720338203392034020341203422034320344203452034620347203482034920350203512035220353203542035520356203572035820359203602036120362203632036420365203662036720368203692037020371203722037320374203752037620377203782037920380203812038220383203842038520386203872038820389203902039120392203932039420395203962039720398203992040020401204022040320404204052040620407204082040920410204112041220413204142041520416204172041820419204202042120422204232042420425204262042720428204292043020431204322043320434204352043620437204382043920440204412044220443204442044520446204472044820449204502045120452204532045420455204562045720458204592046020461204622046320464204652046620467204682046920470204712047220473204742047520476204772047820479204802048120482204832048420485204862048720488204892049020491204922049320494204952049620497204982049920500205012050220503205042050520506205072050820509205102051120512205132051420515205162051720518205192052020521205222052320524205252052620527205282052920530205312053220533205342053520536205372053820539205402054120542205432054420545205462054720548205492055020551205522055320554205552055620557205582055920560205612056220563205642056520566205672056820569205702057120572205732057420575205762057720578205792058020581205822058320584205852058620587205882058920590205912059220593205942059520596205972059820599206002060120602206032060420605206062060720608206092061020611206122061320614206152061620617206182061920620206212062220623206242062520626206272062820629206302063120632206332063420635206362063720638206392064020641206422064320644206452064620647206482064920650206512065220653206542065520656206572065820659206602066120662206632066420665206662066720668206692067020671206722067320674206752067620677206782067920680206812068220683206842068520686206872068820689206902069120692206932069420695206962069720698206992070020701207022070320704207052070620707207082070920710207112071220713207142071520716207172071820719207202072120722207232072420725207262072720728207292073020731207322073320734207352073620737207382073920740207412074220743207442074520746207472074820749207502075120752207532075420755207562075720758207592076020761207622076320764207652076620767207682076920770207712077220773207742077520776207772077820779207802078120782207832078420785207862078720788207892079020791207922079320794207952079620797207982079920800208012080220803208042080520806208072080820809208102081120812208132081420815208162081720818208192082020821208222082320824208252082620827208282082920830208312083220833208342083520836208372083820839208402084120842208432084420845208462084720848208492085020851208522085320854208552085620857208582085920860208612086220863208642086520866208672086820869208702087120872208732087420875208762087720878208792088020881208822088320884208852088620887208882088920890208912089220893208942089520896208972089820899209002090120902209032090420905209062090720908209092091020911209122091320914209152091620917209182091920920209212092220923209242092520926209272092820929209302093120932209332093420935209362093720938209392094020941209422094320944209452094620947209482094920950209512095220953209542095520956209572095820959209602096120962209632096420965209662096720968209692097020971209722097320974209752097620977209782097920980209812098220983209842098520986209872098820989209902099120992209932099420995209962099720998209992100021001210022100321004210052100621007210082100921010210112101221013210142101521016210172101821019210202102121022210232102421025210262102721028210292103021031210322103321034210352103621037210382103921040210412104221043210442104521046210472104821049210502105121052210532105421055210562105721058210592106021061210622106321064210652106621067210682106921070210712107221073210742107521076210772107821079210802108121082210832108421085210862108721088210892109021091210922109321094210952109621097210982109921100211012110221103211042110521106211072110821109211102111121112211132111421115211162111721118211192112021121211222112321124211252112621127211282112921130211312113221133211342113521136211372113821139211402114121142211432114421145211462114721148211492115021151211522115321154211552115621157211582115921160211612116221163211642116521166211672116821169211702117121172211732117421175211762117721178211792118021181211822118321184211852118621187211882118921190211912119221193211942119521196211972119821199212002120121202212032120421205212062120721208212092121021211212122121321214212152121621217212182121921220212212122221223212242122521226212272122821229212302123121232212332123421235212362123721238212392124021241212422124321244212452124621247212482124921250212512125221253212542125521256212572125821259212602126121262212632126421265212662126721268212692127021271212722127321274212752127621277212782127921280212812128221283212842128521286212872128821289212902129121292212932129421295212962129721298212992130021301213022130321304213052130621307213082130921310213112131221313213142131521316213172131821319213202132121322213232132421325213262132721328213292133021331213322133321334213352133621337213382133921340213412134221343213442134521346213472134821349213502135121352213532135421355213562135721358213592136021361213622136321364213652136621367213682136921370213712137221373213742137521376213772137821379213802138121382213832138421385213862138721388213892139021391213922139321394213952139621397213982139921400214012140221403214042140521406214072140821409214102141121412214132141421415214162141721418214192142021421214222142321424214252142621427214282142921430214312143221433214342143521436214372143821439214402144121442214432144421445214462144721448214492145021451214522145321454214552145621457214582145921460214612146221463214642146521466214672146821469214702147121472214732147421475214762147721478214792148021481214822148321484214852148621487214882148921490214912149221493214942149521496214972149821499215002150121502215032150421505215062150721508215092151021511215122151321514215152151621517215182151921520215212152221523215242152521526215272152821529215302153121532215332153421535215362153721538215392154021541215422154321544215452154621547215482154921550215512155221553215542155521556215572155821559215602156121562215632156421565215662156721568215692157021571215722157321574215752157621577215782157921580215812158221583215842158521586215872158821589215902159121592215932159421595215962159721598215992160021601216022160321604216052160621607216082160921610216112161221613216142161521616216172161821619216202162121622216232162421625216262162721628216292163021631216322163321634216352163621637216382163921640216412164221643216442164521646216472164821649216502165121652216532165421655216562165721658216592166021661216622166321664216652166621667216682166921670216712167221673216742167521676216772167821679216802168121682216832168421685216862168721688216892169021691216922169321694216952169621697216982169921700217012170221703217042170521706217072170821709217102171121712217132171421715217162171721718217192172021721217222172321724217252172621727217282172921730217312173221733217342173521736217372173821739217402174121742217432174421745217462174721748217492175021751217522175321754217552175621757217582175921760217612176221763217642176521766217672176821769217702177121772217732177421775217762177721778217792178021781217822178321784217852178621787217882178921790217912179221793217942179521796217972179821799218002180121802218032180421805218062180721808218092181021811218122181321814218152181621817218182181921820218212182221823218242182521826218272182821829218302183121832218332183421835218362183721838218392184021841218422184321844218452184621847218482184921850218512185221853218542185521856218572185821859218602186121862218632186421865218662186721868218692187021871218722187321874218752187621877218782187921880218812188221883218842188521886218872188821889218902189121892218932189421895218962189721898218992190021901219022190321904219052190621907219082190921910219112191221913219142191521916219172191821919219202192121922219232192421925219262192721928219292193021931219322193321934219352193621937219382193921940219412194221943219442194521946219472194821949219502195121952219532195421955219562195721958219592196021961219622196321964219652196621967219682196921970219712197221973219742197521976219772197821979219802198121982219832198421985219862198721988219892199021991219922199321994219952199621997219982199922000220012200222003220042200522006220072200822009220102201122012220132201422015220162201722018220192202022021220222202322024220252202622027220282202922030220312203222033220342203522036220372203822039220402204122042220432204422045220462204722048220492205022051220522205322054220552205622057220582205922060220612206222063220642206522066220672206822069220702207122072220732207422075220762207722078220792208022081220822208322084220852208622087220882208922090220912209222093220942209522096220972209822099221002210122102221032210422105221062210722108221092211022111221122211322114221152211622117221182211922120221212212222123221242212522126221272212822129221302213122132221332213422135221362213722138221392214022141221422214322144221452214622147221482214922150221512215222153221542215522156221572215822159221602216122162221632216422165221662216722168221692217022171221722217322174221752217622177221782217922180221812218222183221842218522186221872218822189221902219122192221932219422195221962219722198221992220022201222022220322204222052220622207222082220922210222112221222213222142221522216222172221822219222202222122222222232222422225222262222722228222292223022231222322223322234222352223622237222382223922240222412224222243222442224522246222472224822249222502225122252222532225422255222562225722258222592226022261222622226322264222652226622267222682226922270222712227222273222742227522276222772227822279222802228122282222832228422285222862228722288222892229022291222922229322294222952229622297222982229922300223012230222303223042230522306223072230822309223102231122312223132231422315223162231722318223192232022321223222232322324223252232622327223282232922330223312233222333223342233522336223372233822339223402234122342223432234422345223462234722348223492235022351223522235322354223552235622357223582235922360223612236222363223642236522366223672236822369223702237122372223732237422375223762237722378223792238022381223822238322384223852238622387223882238922390223912239222393223942239522396223972239822399224002240122402224032240422405224062240722408224092241022411224122241322414224152241622417224182241922420224212242222423224242242522426224272242822429224302243122432224332243422435224362243722438224392244022441224422244322444224452244622447224482244922450224512245222453224542245522456224572245822459224602246122462224632246422465224662246722468224692247022471224722247322474224752247622477224782247922480224812248222483224842248522486224872248822489224902249122492224932249422495224962249722498224992250022501225022250322504225052250622507225082250922510225112251222513225142251522516225172251822519225202252122522225232252422525225262252722528225292253022531225322253322534225352253622537225382253922540225412254222543225442254522546225472254822549225502255122552225532255422555225562255722558225592256022561225622256322564225652256622567225682256922570225712257222573225742257522576225772257822579225802258122582225832258422585225862258722588225892259022591225922259322594225952259622597225982259922600226012260222603226042260522606226072260822609226102261122612226132261422615226162261722618226192262022621226222262322624226252262622627226282262922630226312263222633226342263522636226372263822639226402264122642226432264422645226462264722648226492265022651226522265322654226552265622657226582265922660226612266222663226642266522666226672266822669226702267122672226732267422675226762267722678226792268022681226822268322684226852268622687226882268922690226912269222693226942269522696226972269822699227002270122702227032270422705227062270722708227092271022711227122271322714227152271622717227182271922720227212272222723227242272522726227272272822729227302273122732227332273422735227362273722738227392274022741227422274322744227452274622747227482274922750227512275222753227542275522756227572275822759227602276122762227632276422765227662276722768227692277022771227722277322774227752277622777227782277922780227812278222783227842278522786227872278822789227902279122792227932279422795227962279722798227992280022801228022280322804228052280622807228082280922810228112281222813228142281522816228172281822819228202282122822228232282422825228262282722828228292283022831228322283322834228352283622837228382283922840228412284222843228442284522846228472284822849228502285122852228532285422855228562285722858228592286022861228622286322864228652286622867228682286922870228712287222873228742287522876228772287822879228802288122882228832288422885228862288722888228892289022891228922289322894228952289622897228982289922900229012290222903229042290522906229072290822909229102291122912229132291422915229162291722918229192292022921229222292322924229252292622927229282292922930229312293222933229342293522936229372293822939229402294122942229432294422945229462294722948229492295022951229522295322954229552295622957229582295922960229612296222963229642296522966229672296822969229702297122972229732297422975229762297722978229792298022981229822298322984229852298622987229882298922990229912299222993229942299522996229972299822999230002300123002230032300423005230062300723008230092301023011230122301323014230152301623017230182301923020230212302223023230242302523026230272302823029230302303123032230332303423035230362303723038230392304023041230422304323044230452304623047230482304923050230512305223053230542305523056230572305823059230602306123062230632306423065230662306723068230692307023071230722307323074230752307623077230782307923080230812308223083230842308523086230872308823089230902309123092230932309423095230962309723098230992310023101231022310323104231052310623107231082310923110231112311223113231142311523116231172311823119231202312123122231232312423125231262312723128231292313023131231322313323134231352313623137231382313923140231412314223143231442314523146231472314823149231502315123152231532315423155231562315723158
  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.58.0"
  10. #define CPPHTTPLIB_VERSION_NUM "0x003a00"
  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. /*
  18. * Configuration
  19. */
  20. #ifndef CPPHTTPLIB_KEEPALIVE_TIMEOUT_SECOND
  21. #define CPPHTTPLIB_KEEPALIVE_TIMEOUT_SECOND 5
  22. #endif
  23. #ifndef CPPHTTPLIB_KEEPALIVE_TIMEOUT_CHECK_INTERVAL_USECOND
  24. #define CPPHTTPLIB_KEEPALIVE_TIMEOUT_CHECK_INTERVAL_USECOND 10000
  25. #endif
  26. #ifndef CPPHTTPLIB_KEEPALIVE_MAX_COUNT
  27. #define CPPHTTPLIB_KEEPALIVE_MAX_COUNT 100
  28. #endif
  29. #ifndef CPPHTTPLIB_CONNECTION_TIMEOUT_SECOND
  30. #define CPPHTTPLIB_CONNECTION_TIMEOUT_SECOND 300
  31. #endif
  32. #ifndef CPPHTTPLIB_CONNECTION_TIMEOUT_USECOND
  33. #define CPPHTTPLIB_CONNECTION_TIMEOUT_USECOND 0
  34. #endif
  35. #ifndef CPPHTTPLIB_SERVER_READ_TIMEOUT_SECOND
  36. #define CPPHTTPLIB_SERVER_READ_TIMEOUT_SECOND 5
  37. #endif
  38. #ifndef CPPHTTPLIB_SERVER_READ_TIMEOUT_USECOND
  39. #define CPPHTTPLIB_SERVER_READ_TIMEOUT_USECOND 0
  40. #endif
  41. #ifndef CPPHTTPLIB_SERVER_WRITE_TIMEOUT_SECOND
  42. #define CPPHTTPLIB_SERVER_WRITE_TIMEOUT_SECOND 5
  43. #endif
  44. #ifndef CPPHTTPLIB_SERVER_WRITE_TIMEOUT_USECOND
  45. #define CPPHTTPLIB_SERVER_WRITE_TIMEOUT_USECOND 0
  46. #endif
  47. #ifndef CPPHTTPLIB_CLIENT_READ_TIMEOUT_SECOND
  48. #define CPPHTTPLIB_CLIENT_READ_TIMEOUT_SECOND 300
  49. #endif
  50. #ifndef CPPHTTPLIB_CLIENT_READ_TIMEOUT_USECOND
  51. #define CPPHTTPLIB_CLIENT_READ_TIMEOUT_USECOND 0
  52. #endif
  53. #ifndef CPPHTTPLIB_CLIENT_WRITE_TIMEOUT_SECOND
  54. #define CPPHTTPLIB_CLIENT_WRITE_TIMEOUT_SECOND 5
  55. #endif
  56. #ifndef CPPHTTPLIB_CLIENT_WRITE_TIMEOUT_USECOND
  57. #define CPPHTTPLIB_CLIENT_WRITE_TIMEOUT_USECOND 0
  58. #endif
  59. #ifndef CPPHTTPLIB_CLIENT_MAX_TIMEOUT_MSECOND
  60. #define CPPHTTPLIB_CLIENT_MAX_TIMEOUT_MSECOND 0
  61. #endif
  62. #ifndef CPPHTTPLIB_EXPECT_100_THRESHOLD
  63. #define CPPHTTPLIB_EXPECT_100_THRESHOLD 1024
  64. #endif
  65. #ifndef CPPHTTPLIB_EXPECT_100_TIMEOUT_MSECOND
  66. #define CPPHTTPLIB_EXPECT_100_TIMEOUT_MSECOND 1000
  67. #endif
  68. #ifndef CPPHTTPLIB_WAIT_EARLY_SERVER_RESPONSE_THRESHOLD
  69. #define CPPHTTPLIB_WAIT_EARLY_SERVER_RESPONSE_THRESHOLD (1024 * 1024)
  70. #endif
  71. #ifndef CPPHTTPLIB_WAIT_EARLY_SERVER_RESPONSE_TIMEOUT_MSECOND
  72. #define CPPHTTPLIB_WAIT_EARLY_SERVER_RESPONSE_TIMEOUT_MSECOND 50
  73. #endif
  74. #ifndef CPPHTTPLIB_IDLE_INTERVAL_SECOND
  75. #define CPPHTTPLIB_IDLE_INTERVAL_SECOND 0
  76. #endif
  77. #ifndef CPPHTTPLIB_IDLE_INTERVAL_USECOND
  78. #ifdef _WIN32
  79. #define CPPHTTPLIB_IDLE_INTERVAL_USECOND 1000
  80. #else
  81. #define CPPHTTPLIB_IDLE_INTERVAL_USECOND 0
  82. #endif
  83. #endif
  84. #ifndef CPPHTTPLIB_REQUEST_URI_MAX_LENGTH
  85. #define CPPHTTPLIB_REQUEST_URI_MAX_LENGTH 8192
  86. #endif
  87. #ifndef CPPHTTPLIB_HEADER_MAX_LENGTH
  88. #define CPPHTTPLIB_HEADER_MAX_LENGTH 8192
  89. #endif
  90. #ifndef CPPHTTPLIB_HEADER_MAX_COUNT
  91. #define CPPHTTPLIB_HEADER_MAX_COUNT 100
  92. #endif
  93. #ifndef CPPHTTPLIB_REDIRECT_MAX_COUNT
  94. #define CPPHTTPLIB_REDIRECT_MAX_COUNT 20
  95. #endif
  96. #ifndef CPPHTTPLIB_MULTIPART_FORM_DATA_FILE_MAX_COUNT
  97. #define CPPHTTPLIB_MULTIPART_FORM_DATA_FILE_MAX_COUNT 1024
  98. #endif
  99. #ifndef CPPHTTPLIB_PAYLOAD_MAX_LENGTH
  100. #define CPPHTTPLIB_PAYLOAD_MAX_LENGTH (100 * 1024 * 1024) // 100MB
  101. #endif
  102. #ifndef CPPHTTPLIB_FORM_URL_ENCODED_PAYLOAD_MAX_LENGTH
  103. #define CPPHTTPLIB_FORM_URL_ENCODED_PAYLOAD_MAX_LENGTH 8192
  104. #endif
  105. #ifndef CPPHTTPLIB_STATIC_FILE_COMPRESSION_MIN_LENGTH
  106. // 1400 rather than a round number: a body that already fits in one 1500-byte
  107. // MTU gains nothing from being made smaller.
  108. #define CPPHTTPLIB_STATIC_FILE_COMPRESSION_MIN_LENGTH 1400
  109. #endif
  110. #ifndef CPPHTTPLIB_STATIC_FILE_COMPRESSION_MAX_LENGTH
  111. #define CPPHTTPLIB_STATIC_FILE_COMPRESSION_MAX_LENGTH (4 * 1024 * 1024) // 4MB
  112. #endif
  113. #ifndef CPPHTTPLIB_RANGE_MAX_COUNT
  114. #define CPPHTTPLIB_RANGE_MAX_COUNT 1024
  115. #endif
  116. // std::regex_match's backtracking implementation (most acutely on libstdc++)
  117. // recurses roughly once per matched character for quantified patterns such
  118. // as "(.*)", so a long enough path can exhaust the calling thread's stack; on
  119. // a default ~8MB thread stack that has been observed to take on the order of
  120. // a couple thousand characters for a simple pattern. 256 leaves a wide safety
  121. // margin below that (well under the 8192-byte request URI limit) while still
  122. // fitting any realistic route segment; raise it if a route legitimately needs
  123. // longer paths. Regex routes are never applied to paths longer than this.
  124. #ifndef CPPHTTPLIB_REGEX_ROUTE_PATH_MAX_LENGTH
  125. #define CPPHTTPLIB_REGEX_ROUTE_PATH_MAX_LENGTH 256
  126. #endif
  127. #ifndef CPPHTTPLIB_TCP_NODELAY
  128. #define CPPHTTPLIB_TCP_NODELAY false
  129. #endif
  130. #ifndef CPPHTTPLIB_IPV6_V6ONLY
  131. #define CPPHTTPLIB_IPV6_V6ONLY false
  132. #endif
  133. #ifndef CPPHTTPLIB_RECV_BUFSIZ
  134. #define CPPHTTPLIB_RECV_BUFSIZ size_t(16384u)
  135. #endif
  136. #ifndef CPPHTTPLIB_SEND_BUFSIZ
  137. #define CPPHTTPLIB_SEND_BUFSIZ size_t(16384u)
  138. #endif
  139. #ifndef CPPHTTPLIB_COMPRESSION_BUFSIZ
  140. #define CPPHTTPLIB_COMPRESSION_BUFSIZ size_t(16384u)
  141. #endif
  142. #ifndef CPPHTTPLIB_THREAD_POOL_COUNT
  143. #define CPPHTTPLIB_THREAD_POOL_COUNT \
  144. ((std::max)(8u, std::thread::hardware_concurrency() > 0 \
  145. ? std::thread::hardware_concurrency() - 1 \
  146. : 0))
  147. #endif
  148. #ifndef CPPHTTPLIB_THREAD_POOL_MAX_COUNT
  149. #define CPPHTTPLIB_THREAD_POOL_MAX_COUNT (CPPHTTPLIB_THREAD_POOL_COUNT * 4)
  150. #endif
  151. #ifndef CPPHTTPLIB_THREAD_POOL_IDLE_TIMEOUT
  152. #define CPPHTTPLIB_THREAD_POOL_IDLE_TIMEOUT 3 // seconds
  153. #endif
  154. #ifndef CPPHTTPLIB_RECV_FLAGS
  155. #define CPPHTTPLIB_RECV_FLAGS 0
  156. #endif
  157. #ifndef CPPHTTPLIB_SEND_FLAGS
  158. #define CPPHTTPLIB_SEND_FLAGS 0
  159. #endif
  160. #ifndef CPPHTTPLIB_LISTEN_BACKLOG
  161. #define CPPHTTPLIB_LISTEN_BACKLOG 128
  162. #endif
  163. #ifndef CPPHTTPLIB_MAX_LINE_LENGTH
  164. #define CPPHTTPLIB_MAX_LINE_LENGTH 32768
  165. #endif
  166. #ifndef CPPHTTPLIB_WEBSOCKET_MAX_PAYLOAD_LENGTH
  167. #define CPPHTTPLIB_WEBSOCKET_MAX_PAYLOAD_LENGTH 16777216
  168. #endif
  169. // One macro used to set the read timeout for both sides. They want different
  170. // defaults: a client's read timeout is the caller's own tool (it waits forever
  171. // until asked not to), while a server keeps a ceiling that reclaims a worker
  172. // from a peer that has gone quiet. The old name still works and sets both.
  173. #ifdef CPPHTTPLIB_WEBSOCKET_READ_TIMEOUT_SECOND
  174. #pragma message( \
  175. "CPPHTTPLIB_WEBSOCKET_READ_TIMEOUT_SECOND is deprecated; define " \
  176. "CPPHTTPLIB_WEBSOCKET_CLIENT_READ_TIMEOUT_SECOND and/or " \
  177. "CPPHTTPLIB_WEBSOCKET_SERVER_READ_TIMEOUT_SECOND instead")
  178. #ifndef CPPHTTPLIB_WEBSOCKET_CLIENT_READ_TIMEOUT_SECOND
  179. #define CPPHTTPLIB_WEBSOCKET_CLIENT_READ_TIMEOUT_SECOND \
  180. CPPHTTPLIB_WEBSOCKET_READ_TIMEOUT_SECOND
  181. #endif
  182. #ifndef CPPHTTPLIB_WEBSOCKET_SERVER_READ_TIMEOUT_SECOND
  183. #define CPPHTTPLIB_WEBSOCKET_SERVER_READ_TIMEOUT_SECOND \
  184. CPPHTTPLIB_WEBSOCKET_READ_TIMEOUT_SECOND
  185. #endif
  186. #endif
  187. // 0 waits forever. A read timeout is how a caller gets control back to send on
  188. // the same connection; it is not a liveness check (that is ping/pong). Only a
  189. // timeout set at runtime through set_read_timeout() is reported as
  190. // ws::Timeout; when one of these compile-time defaults elapses, read() returns
  191. // ws::Fail and closes the connection.
  192. #ifndef CPPHTTPLIB_WEBSOCKET_CLIENT_READ_TIMEOUT_SECOND
  193. #define CPPHTTPLIB_WEBSOCKET_CLIENT_READ_TIMEOUT_SECOND 0
  194. #endif
  195. #ifndef CPPHTTPLIB_WEBSOCKET_SERVER_READ_TIMEOUT_SECOND
  196. #define CPPHTTPLIB_WEBSOCKET_SERVER_READ_TIMEOUT_SECOND 300
  197. #endif
  198. #ifndef CPPHTTPLIB_WEBSOCKET_CLOSE_TIMEOUT_SECOND
  199. #define CPPHTTPLIB_WEBSOCKET_CLOSE_TIMEOUT_SECOND 5
  200. #endif
  201. #ifndef CPPHTTPLIB_WEBSOCKET_PING_INTERVAL_SECOND
  202. #define CPPHTTPLIB_WEBSOCKET_PING_INTERVAL_SECOND 30
  203. #endif
  204. #ifndef CPPHTTPLIB_WEBSOCKET_MAX_MISSED_PONGS
  205. #define CPPHTTPLIB_WEBSOCKET_MAX_MISSED_PONGS 0
  206. #endif
  207. /*
  208. * Headers
  209. */
  210. #ifdef _WIN32
  211. #ifndef _CRT_SECURE_NO_WARNINGS
  212. #define _CRT_SECURE_NO_WARNINGS
  213. #endif //_CRT_SECURE_NO_WARNINGS
  214. #ifndef _CRT_NONSTDC_NO_DEPRECATE
  215. #define _CRT_NONSTDC_NO_DEPRECATE
  216. #endif //_CRT_NONSTDC_NO_DEPRECATE
  217. #if defined(_MSC_VER)
  218. #if _MSC_VER < 1900
  219. #error Sorry, Visual Studio versions prior to 2015 are not supported
  220. #endif
  221. #pragma comment(lib, "ws2_32.lib")
  222. #ifndef _SSIZE_T_DEFINED
  223. using ssize_t = __int64;
  224. #define _SSIZE_T_DEFINED
  225. #endif
  226. #endif // _MSC_VER
  227. #ifndef S_ISREG
  228. #define S_ISREG(m) (((m) & S_IFREG) == S_IFREG)
  229. #endif // S_ISREG
  230. #ifndef S_ISDIR
  231. #define S_ISDIR(m) (((m) & S_IFDIR) == S_IFDIR)
  232. #endif // S_ISDIR
  233. #ifndef NOMINMAX
  234. #define NOMINMAX
  235. #endif // NOMINMAX
  236. #include <io.h>
  237. #include <winsock2.h>
  238. #include <ws2tcpip.h>
  239. #if defined(__has_include)
  240. #if __has_include(<afunix.h>)
  241. // afunix.h uses types declared in winsock2.h, so has to be included after it.
  242. #include <afunix.h>
  243. #define CPPHTTPLIB_HAVE_AFUNIX_H 1
  244. #endif
  245. #endif
  246. #ifndef WSA_FLAG_NO_HANDLE_INHERIT
  247. #define WSA_FLAG_NO_HANDLE_INHERIT 0x80
  248. #endif
  249. using nfds_t = unsigned long;
  250. using socket_t = SOCKET;
  251. using socklen_t = int;
  252. #else // not _WIN32
  253. #include <arpa/inet.h>
  254. #if !defined(_AIX) && !defined(__MVS__)
  255. #include <ifaddrs.h>
  256. #endif
  257. #ifdef __MVS__
  258. #include <strings.h>
  259. #ifndef NI_MAXHOST
  260. #define NI_MAXHOST 1025
  261. #endif
  262. #endif
  263. #include <net/if.h>
  264. #include <netdb.h>
  265. #include <netinet/in.h>
  266. #ifdef __linux__
  267. #include <resolv.h>
  268. #undef _res // Undefine _res macro to avoid conflicts with user code (#2278)
  269. #endif
  270. #include <csignal>
  271. #include <netinet/tcp.h>
  272. #include <poll.h>
  273. #include <pthread.h>
  274. #include <sys/mman.h>
  275. #include <sys/socket.h>
  276. #include <sys/un.h>
  277. #include <unistd.h>
  278. using socket_t = int;
  279. #ifndef INVALID_SOCKET
  280. #define INVALID_SOCKET (-1)
  281. #endif
  282. #endif //_WIN32
  283. #if defined(__APPLE__)
  284. #include <TargetConditionals.h>
  285. #endif
  286. #include <algorithm>
  287. #include <array>
  288. #include <atomic>
  289. #include <cassert>
  290. #include <chrono>
  291. #include <climits>
  292. #include <condition_variable>
  293. #include <cstdlib>
  294. #include <cstring>
  295. #include <errno.h>
  296. #include <exception>
  297. #include <fcntl.h>
  298. #include <fstream>
  299. #include <functional>
  300. #include <iomanip>
  301. #include <iostream>
  302. #include <iterator>
  303. #include <list>
  304. #include <map>
  305. #include <memory>
  306. #include <mutex>
  307. #include <random>
  308. #include <regex>
  309. #include <set>
  310. #include <sstream>
  311. #include <string>
  312. #include <sys/stat.h>
  313. #include <system_error>
  314. #include <thread>
  315. #include <type_traits>
  316. #include <unordered_map>
  317. #include <unordered_set>
  318. #include <utility>
  319. #include <vector>
  320. // On macOS with a TLS backend, enable Keychain root certificates by default
  321. // unless the user explicitly opts out. Not enabled on iOS/tvOS/watchOS since
  322. // the SecTrustSettings APIs used to enumerate anchor certificates are macOS
  323. // only; on those platforms the user must provide a CA bundle explicitly.
  324. #if defined(__APPLE__) && defined(__clang__) && \
  325. !defined(CPPHTTPLIB_DISABLE_MACOSX_AUTOMATIC_ROOT_CERTIFICATES) && \
  326. (defined(CPPHTTPLIB_OPENSSL_SUPPORT) || \
  327. defined(CPPHTTPLIB_MBEDTLS_SUPPORT) || \
  328. defined(CPPHTTPLIB_WOLFSSL_SUPPORT))
  329. #if TARGET_OS_OSX
  330. #ifndef CPPHTTPLIB_USE_CERTS_FROM_MACOSX_KEYCHAIN
  331. #define CPPHTTPLIB_USE_CERTS_FROM_MACOSX_KEYCHAIN
  332. #endif
  333. #endif
  334. #endif
  335. #if defined(CPPHTTPLIB_USE_CERTS_FROM_MACOSX_KEYCHAIN) && \
  336. defined(__APPLE__) && !TARGET_OS_OSX
  337. #error \
  338. "CPPHTTPLIB_USE_CERTS_FROM_MACOSX_KEYCHAIN is only supported on macOS. On iOS/tvOS/watchOS, supply a CA bundle via set_ca_cert_path()."
  339. #endif
  340. // On Windows, enable Schannel certificate verification by default
  341. // unless the user explicitly opts out.
  342. #if defined(_WIN32) && \
  343. !defined(CPPHTTPLIB_DISABLE_WINDOWS_AUTOMATIC_ROOT_CERTIFICATES_UPDATE)
  344. #define CPPHTTPLIB_WINDOWS_AUTOMATIC_ROOT_CERTIFICATES_UPDATE
  345. #endif
  346. #if defined(CPPHTTPLIB_USE_NON_BLOCKING_GETADDRINFO) || \
  347. defined(CPPHTTPLIB_USE_CERTS_FROM_MACOSX_KEYCHAIN)
  348. #if TARGET_OS_MAC && defined(__clang__)
  349. #include <CFNetwork/CFHost.h>
  350. #include <CoreFoundation/CoreFoundation.h>
  351. #endif
  352. #endif
  353. #ifdef CPPHTTPLIB_OPENSSL_SUPPORT
  354. #ifdef _WIN32
  355. #include <wincrypt.h>
  356. // these are defined in wincrypt.h and it breaks compilation if BoringSSL is
  357. // used
  358. #undef X509_NAME
  359. #undef X509_CERT_PAIR
  360. #undef X509_EXTENSIONS
  361. #undef PKCS7_SIGNER_INFO
  362. #ifdef _MSC_VER
  363. #pragma comment(lib, "crypt32.lib")
  364. #endif
  365. #endif // _WIN32
  366. #ifdef CPPHTTPLIB_USE_CERTS_FROM_MACOSX_KEYCHAIN
  367. #if TARGET_OS_OSX
  368. #include <Security/Security.h>
  369. #endif
  370. #endif
  371. #include <openssl/err.h>
  372. #include <openssl/evp.h>
  373. #include <openssl/ssl.h>
  374. #include <openssl/x509v3.h>
  375. #if defined(_WIN32) && defined(OPENSSL_USE_APPLINK)
  376. #include <openssl/applink.c>
  377. #endif
  378. #include <iostream>
  379. #include <sstream>
  380. #if defined(OPENSSL_IS_BORINGSSL) || defined(LIBRESSL_VERSION_NUMBER)
  381. #if OPENSSL_VERSION_NUMBER < 0x1010107f
  382. #error Please use OpenSSL or a current version of BoringSSL
  383. #endif
  384. #define SSL_get1_peer_certificate SSL_get_peer_certificate
  385. #elif OPENSSL_VERSION_NUMBER < 0x30000000L
  386. #error Sorry, OpenSSL versions prior to 3.0.0 are not supported
  387. #endif
  388. #endif // CPPHTTPLIB_OPENSSL_SUPPORT
  389. #ifdef CPPHTTPLIB_MBEDTLS_SUPPORT
  390. // version.h defines MBEDTLS_VERSION_MAJOR (on 2.x/3.x/4.x alike); it is pulled
  391. // in with this first include group so the version gating below can use it.
  392. #include <mbedtls/error.h>
  393. #include <mbedtls/net_sockets.h>
  394. #include <mbedtls/oid.h>
  395. #include <mbedtls/pk.h>
  396. #include <mbedtls/ssl.h>
  397. #include <mbedtls/version.h>
  398. #include <mbedtls/x509_crt.h>
  399. #if MBEDTLS_VERSION_MAJOR >= 4
  400. // Mbed TLS 4.x moved hashing/RNG to PSA Crypto and removed these headers.
  401. #include <psa/crypto.h>
  402. #else
  403. #include <mbedtls/ctr_drbg.h>
  404. #include <mbedtls/entropy.h>
  405. #include <mbedtls/md5.h>
  406. #include <mbedtls/sha1.h>
  407. #include <mbedtls/sha256.h>
  408. #include <mbedtls/sha512.h>
  409. #endif
  410. #ifdef _WIN32
  411. #include <wincrypt.h>
  412. #ifdef _MSC_VER
  413. #pragma comment(lib, "crypt32.lib")
  414. #endif
  415. #endif // _WIN32
  416. #ifdef CPPHTTPLIB_USE_CERTS_FROM_MACOSX_KEYCHAIN
  417. #if TARGET_OS_OSX
  418. #include <Security/Security.h>
  419. #endif
  420. #endif
  421. // Mbed TLS version API compatibility. Note: V4 implies V3 (both defined on
  422. // 4.x), so version-specific 3.x-only code must check V3 && !V4.
  423. #if MBEDTLS_VERSION_MAJOR >= 4
  424. #define CPPHTTPLIB_MBEDTLS_V4
  425. #endif
  426. #if MBEDTLS_VERSION_MAJOR >= 3
  427. #define CPPHTTPLIB_MBEDTLS_V3
  428. #endif
  429. #endif // CPPHTTPLIB_MBEDTLS_SUPPORT
  430. #ifdef CPPHTTPLIB_WOLFSSL_SUPPORT
  431. #include <wolfssl/options.h>
  432. #include <wolfssl/openssl/x509v3.h>
  433. // Fallback definitions for older wolfSSL versions (e.g., 5.6.6)
  434. #ifndef WOLFSSL_GEN_EMAIL
  435. #define WOLFSSL_GEN_EMAIL 1
  436. #endif
  437. #ifndef WOLFSSL_GEN_DNS
  438. #define WOLFSSL_GEN_DNS 2
  439. #endif
  440. #ifndef WOLFSSL_GEN_URI
  441. #define WOLFSSL_GEN_URI 6
  442. #endif
  443. #ifndef WOLFSSL_GEN_IPADD
  444. #define WOLFSSL_GEN_IPADD 7
  445. #endif
  446. #include <wolfssl/ssl.h>
  447. #include <wolfssl/wolfcrypt/hash.h>
  448. #include <wolfssl/wolfcrypt/md5.h>
  449. #include <wolfssl/wolfcrypt/sha256.h>
  450. #include <wolfssl/wolfcrypt/sha512.h>
  451. #ifdef _WIN32
  452. #include <wincrypt.h>
  453. #ifdef _MSC_VER
  454. #pragma comment(lib, "crypt32.lib")
  455. #endif
  456. #endif // _WIN32
  457. #ifdef CPPHTTPLIB_USE_CERTS_FROM_MACOSX_KEYCHAIN
  458. #if TARGET_OS_OSX
  459. #include <Security/Security.h>
  460. #endif
  461. #endif
  462. #endif // CPPHTTPLIB_WOLFSSL_SUPPORT
  463. // Define CPPHTTPLIB_SSL_ENABLED if any SSL backend is available
  464. #if defined(CPPHTTPLIB_OPENSSL_SUPPORT) || \
  465. defined(CPPHTTPLIB_MBEDTLS_SUPPORT) || defined(CPPHTTPLIB_WOLFSSL_SUPPORT)
  466. #define CPPHTTPLIB_SSL_ENABLED
  467. #endif
  468. #ifdef CPPHTTPLIB_ZLIB_SUPPORT
  469. #include <zlib.h>
  470. #endif
  471. #ifdef CPPHTTPLIB_BROTLI_SUPPORT
  472. #include <brotli/decode.h>
  473. #include <brotli/encode.h>
  474. #endif
  475. #ifdef CPPHTTPLIB_ZSTD_SUPPORT
  476. #include <zstd.h>
  477. #endif
  478. /*
  479. * Declaration
  480. */
  481. namespace httplib {
  482. namespace ws {
  483. class WebSocket;
  484. } // namespace ws
  485. namespace detail {
  486. /*
  487. * Backport std::make_unique from C++14.
  488. *
  489. * NOTE: This code came up with the following stackoverflow post:
  490. * https://stackoverflow.com/questions/10149840/c-arrays-and-make-unique
  491. *
  492. */
  493. template <class T, class... Args>
  494. typename std::enable_if<!std::is_array<T>::value, std::unique_ptr<T>>::type
  495. make_unique(Args &&...args) {
  496. return std::unique_ptr<T>(new T(std::forward<Args>(args)...));
  497. }
  498. template <class T>
  499. typename std::enable_if<std::is_array<T>::value, std::unique_ptr<T>>::type
  500. make_unique(std::size_t n) {
  501. typedef typename std::remove_extent<T>::type RT;
  502. return std::unique_ptr<T>(new RT[n]);
  503. }
  504. // Locale-independent ASCII character classification. The <cctype>
  505. // counterparts (std::isalnum, std::isdigit, ...) consult the global C locale,
  506. // so e.g. std::isalnum(0xC5) can return true once an embedder calls
  507. // setlocale(). HTTP grammars are defined over ASCII, so raw bytes must be
  508. // classified without regard to the locale.
  509. inline bool is_ascii_digit(char c) { return '0' <= c && c <= '9'; }
  510. inline bool is_ascii_alpha(char c) {
  511. return ('a' <= c && c <= 'z') || ('A' <= c && c <= 'Z');
  512. }
  513. inline bool is_ascii_alnum(char c) {
  514. return is_ascii_digit(c) || is_ascii_alpha(c);
  515. }
  516. namespace case_ignore {
  517. inline unsigned char to_lower(int c) {
  518. const static unsigned char table[256] = {
  519. 0, 1, 2, 3, 4, 5, 6, 7, 8, 9, 10, 11, 12, 13, 14,
  520. 15, 16, 17, 18, 19, 20, 21, 22, 23, 24, 25, 26, 27, 28, 29,
  521. 30, 31, 32, 33, 34, 35, 36, 37, 38, 39, 40, 41, 42, 43, 44,
  522. 45, 46, 47, 48, 49, 50, 51, 52, 53, 54, 55, 56, 57, 58, 59,
  523. 60, 61, 62, 63, 64, 97, 98, 99, 100, 101, 102, 103, 104, 105, 106,
  524. 107, 108, 109, 110, 111, 112, 113, 114, 115, 116, 117, 118, 119, 120, 121,
  525. 122, 91, 92, 93, 94, 95, 96, 97, 98, 99, 100, 101, 102, 103, 104,
  526. 105, 106, 107, 108, 109, 110, 111, 112, 113, 114, 115, 116, 117, 118, 119,
  527. 120, 121, 122, 123, 124, 125, 126, 127, 128, 129, 130, 131, 132, 133, 134,
  528. 135, 136, 137, 138, 139, 140, 141, 142, 143, 144, 145, 146, 147, 148, 149,
  529. 150, 151, 152, 153, 154, 155, 156, 157, 158, 159, 160, 161, 162, 163, 164,
  530. 165, 166, 167, 168, 169, 170, 171, 172, 173, 174, 175, 176, 177, 178, 179,
  531. 180, 181, 182, 183, 184, 185, 186, 187, 188, 189, 190, 191, 224, 225, 226,
  532. 227, 228, 229, 230, 231, 232, 233, 234, 235, 236, 237, 238, 239, 240, 241,
  533. 242, 243, 244, 245, 246, 215, 248, 249, 250, 251, 252, 253, 254, 223, 224,
  534. 225, 226, 227, 228, 229, 230, 231, 232, 233, 234, 235, 236, 237, 238, 239,
  535. 240, 241, 242, 243, 244, 245, 246, 247, 248, 249, 250, 251, 252, 253, 254,
  536. 255,
  537. };
  538. return table[(unsigned char)(char)c];
  539. }
  540. inline std::string to_lower(const std::string &s) {
  541. std::string result = s;
  542. std::transform(
  543. result.begin(), result.end(), result.begin(),
  544. [](unsigned char c) { return static_cast<char>(to_lower(c)); });
  545. return result;
  546. }
  547. inline bool equal(const std::string &a, const std::string &b) {
  548. return a.size() == b.size() &&
  549. std::equal(a.begin(), a.end(), b.begin(), [](char ca, char cb) {
  550. return to_lower(ca) == to_lower(cb);
  551. });
  552. }
  553. struct equal_to {
  554. bool operator()(const std::string &a, const std::string &b) const {
  555. return equal(a, b);
  556. }
  557. };
  558. struct hash {
  559. size_t operator()(const std::string &key) const {
  560. return hash_core(key.data(), key.size(), 0);
  561. }
  562. size_t hash_core(const char *s, size_t l, size_t h) const {
  563. return (l == 0) ? h
  564. : hash_core(s + 1, l - 1,
  565. // Unsets the 6 high bits of h, therefore no
  566. // overflow happens
  567. (((std::numeric_limits<size_t>::max)() >> 6) &
  568. h * 33) ^
  569. static_cast<unsigned char>(to_lower(*s)));
  570. }
  571. };
  572. template <typename T>
  573. using unordered_set = std::unordered_set<T, detail::case_ignore::hash,
  574. detail::case_ignore::equal_to>;
  575. } // namespace case_ignore
  576. // This is based on
  577. // "http://www.open-std.org/jtc1/sc22/wg21/docs/papers/2014/n4189".
  578. struct scope_exit {
  579. explicit scope_exit(std::function<void(void)> &&f)
  580. : exit_function(std::move(f)), execute_on_destruction{true} {}
  581. scope_exit(scope_exit &&rhs) noexcept
  582. : exit_function(std::move(rhs.exit_function)),
  583. execute_on_destruction{rhs.execute_on_destruction} {
  584. rhs.release();
  585. }
  586. ~scope_exit() {
  587. if (execute_on_destruction) { this->exit_function(); }
  588. }
  589. void release() { this->execute_on_destruction = false; }
  590. private:
  591. scope_exit(const scope_exit &) = delete;
  592. void operator=(const scope_exit &) = delete;
  593. scope_exit &operator=(scope_exit &&) = delete;
  594. std::function<void(void)> exit_function;
  595. bool execute_on_destruction;
  596. };
  597. // Simple from_chars implementation for integer and double types (C++17
  598. // substitute)
  599. template <typename T> struct from_chars_result {
  600. const char *ptr;
  601. std::errc ec;
  602. };
  603. template <typename T>
  604. inline from_chars_result<T> from_chars(const char *first, const char *last,
  605. T &value, int base = 10) {
  606. value = 0;
  607. const char *p = first;
  608. bool negative = false;
  609. if (p != last && *p == '-') {
  610. negative = true;
  611. ++p;
  612. }
  613. if (p == last) { return {first, std::errc::invalid_argument}; }
  614. T result = 0;
  615. for (; p != last; ++p) {
  616. char c = *p;
  617. int digit = -1;
  618. if (is_ascii_digit(c)) {
  619. digit = c - '0';
  620. } else if ('a' <= c && c <= 'z') {
  621. digit = c - 'a' + 10;
  622. } else if ('A' <= c && c <= 'Z') {
  623. digit = c - 'A' + 10;
  624. } else {
  625. break;
  626. }
  627. if (digit < 0 || digit >= base) { break; }
  628. if (result > ((std::numeric_limits<T>::max)() - digit) / base) {
  629. return {p, std::errc::result_out_of_range};
  630. }
  631. result = result * base + digit;
  632. }
  633. if (p == first || (negative && p == first + 1)) {
  634. return {first, std::errc::invalid_argument};
  635. }
  636. value = negative ? T(0) - result : result;
  637. return {p, std::errc{}};
  638. }
  639. // from_chars for double (hand-written, locale-independent)
  640. //
  641. // The only double consumed by this library is the HTTP quality value, whose
  642. // grammar is (RFC 9110 12.4.2):
  643. // qvalue = ( "0" [ "." 0*3DIGIT ] ) / ( "1" [ "." 0*3("0") ] )
  644. // i.e. a non-negative decimal with no sign, exponent, "inf"/"nan", or wide
  645. // magnitude. So this parser recognizes exactly 1*DIGIT [ "." *DIGIT ] with
  646. // '.' always the decimal separator (std::strtod would instead read it from the
  647. // global C locale, mis-parsing q-values once an embedder calls
  648. // setlocale(LC_ALL, "") into a comma-decimal locale). The caller range-checks
  649. // the result to [0, 1], so inputs outside that range need not be distinguished
  650. // here. Allocation-free, single pass, and free of the overflow/rounding edge
  651. // cases that exponent and wide-range handling would introduce.
  652. inline from_chars_result<double> from_chars(const char *first, const char *last,
  653. double &value) {
  654. value = 0.0;
  655. const char *p = first;
  656. // Each 1eN is exactly representable, so a single final division by the
  657. // matching entry yields a correctly-rounded result.
  658. static const double powers_of_ten[] = {
  659. 1e0, 1e1, 1e2, 1e3, 1e4, 1e5, 1e6, 1e7, 1e8, 1e9,
  660. 1e10, 1e11, 1e12, 1e13, 1e14, 1e15, 1e16, 1e17, 1e18};
  661. const int max_frac_digits =
  662. static_cast<int>(sizeof(powers_of_ten) / sizeof(powers_of_ten[0])) - 1;
  663. // Accumulate digits into a 64-bit integer and remember how many were
  664. // fractional. Two independent caps keep this bounded and safe:
  665. // * accumulation saturates before mantissa could overflow uint64_t, and
  666. // * frac_digits is capped at max_frac_digits so it is always a valid index
  667. // into powers_of_ten (without this an input like "0.000...0" would never
  668. // grow mantissa, so the saturation cap alone would not bound it).
  669. // Both caps only drop digits far beyond the precision a q-value needs; any
  670. // value they would change is well outside [0, 1] and rejected by the caller.
  671. uint64_t mantissa = 0;
  672. int frac_digits = 0;
  673. bool seen_digit = false;
  674. const uint64_t limit = ((std::numeric_limits<uint64_t>::max)() - 9) / 10;
  675. auto accumulate = [&](char c) {
  676. if (mantissa <= limit) {
  677. mantissa = mantissa * 10 + static_cast<uint64_t>(c - '0');
  678. return true;
  679. }
  680. return false;
  681. };
  682. for (; p != last && is_ascii_digit(*p); ++p) {
  683. seen_digit = true;
  684. accumulate(*p);
  685. }
  686. if (p != last && *p == '.') {
  687. ++p;
  688. for (; p != last && is_ascii_digit(*p); ++p) {
  689. seen_digit = true;
  690. if (frac_digits < max_frac_digits && accumulate(*p)) { ++frac_digits; }
  691. }
  692. }
  693. if (!seen_digit) { return {first, std::errc::invalid_argument}; }
  694. value = static_cast<double>(mantissa) / powers_of_ten[frac_digits];
  695. return {p, std::errc{}};
  696. }
  697. inline bool parse_port(const char *s, size_t len, int &port) {
  698. int val = 0;
  699. auto r = from_chars(s, s + len, val);
  700. if (r.ec != std::errc{} || val < 1 || val > 65535) { return false; }
  701. port = val;
  702. return true;
  703. }
  704. inline bool parse_port(const std::string &s, int &port) {
  705. return parse_port(s.data(), s.size(), port);
  706. }
  707. struct UrlComponents {
  708. std::string scheme;
  709. std::string host;
  710. std::string port;
  711. std::string path;
  712. std::string query;
  713. };
  714. inline bool parse_url(const std::string &url, UrlComponents &uc) {
  715. uc = {};
  716. size_t pos = 0;
  717. auto sep = url.find("://");
  718. if (sep != std::string::npos) {
  719. uc.scheme = url.substr(0, sep);
  720. // Scheme must be [a-z]+ only
  721. if (uc.scheme.empty()) { return false; }
  722. for (auto c : uc.scheme) {
  723. if (c < 'a' || c > 'z') { return false; }
  724. }
  725. pos = sep + 3;
  726. } else if (url.compare(0, 2, "//") == 0) {
  727. pos = 2;
  728. }
  729. auto has_authority_prefix = pos > 0;
  730. auto has_authority = has_authority_prefix || (!url.empty() && url[0] != '/' &&
  731. url[0] != '?' && url[0] != '#');
  732. if (has_authority) {
  733. if (pos < url.size() && url[pos] == '[') {
  734. auto close = url.find(']', pos);
  735. if (close == std::string::npos) { return false; }
  736. uc.host = url.substr(pos + 1, close - pos - 1);
  737. // IPv6 host must be [a-fA-F0-9:]+ only
  738. if (uc.host.empty()) { return false; }
  739. for (auto c : uc.host) {
  740. if (!(is_ascii_digit(c) || (c >= 'a' && c <= 'f') ||
  741. (c >= 'A' && c <= 'F') || c == ':')) {
  742. return false;
  743. }
  744. }
  745. pos = close + 1;
  746. // The IPv6 literal is the whole host, so ']' must be followed by a port,
  747. // path, query or fragment delimiter (or the end of input). Otherwise the
  748. // trailing bytes would be folded into the path while the connection
  749. // still targets the bracketed address.
  750. if (pos < url.size()) {
  751. auto c = url[pos];
  752. if (c != ':' && c != '/' && c != '?' && c != '#') { return false; }
  753. }
  754. } else {
  755. auto end = url.find_first_of(":/?#", pos);
  756. if (end == std::string::npos) { end = url.size(); }
  757. uc.host = url.substr(pos, end - pos);
  758. pos = end;
  759. }
  760. if (pos < url.size() && url[pos] == ':') {
  761. ++pos;
  762. auto end = url.find_first_of("/?#", pos);
  763. if (end == std::string::npos) { end = url.size(); }
  764. uc.port = url.substr(pos, end - pos);
  765. pos = end;
  766. }
  767. // Without :// or //, the entire input must be consumed as host[:port].
  768. // If there is leftover (path, query, etc.), this is not a valid
  769. // host[:port] string — clear and reparse as a plain path.
  770. if (!has_authority_prefix && pos < url.size()) {
  771. uc.host.clear();
  772. uc.port.clear();
  773. pos = 0;
  774. }
  775. }
  776. if (pos < url.size() && url[pos] != '?' && url[pos] != '#') {
  777. auto end = url.find_first_of("?#", pos);
  778. if (end == std::string::npos) { end = url.size(); }
  779. uc.path = url.substr(pos, end - pos);
  780. pos = end;
  781. }
  782. if (pos < url.size() && url[pos] == '?') {
  783. auto end = url.find('#', pos);
  784. if (end == std::string::npos) { end = url.size(); }
  785. uc.query = url.substr(pos, end - pos);
  786. }
  787. return true;
  788. }
  789. // Resolves a relative-path or query-only Location value against the path of
  790. // the request being redirected (RFC 3986 section 5.2). Absolute URIs and
  791. // references starting with '/' are returned unchanged.
  792. inline std::string resolve_relative_location(const std::string &location,
  793. const std::string &base) {
  794. if (location.empty() || location[0] == '/') { return location; }
  795. // A ':' in the first segment means the value has a scheme.
  796. if (location.find(':') < location.find_first_of("/?#")) { return location; }
  797. if (location[0] == '#') { return base.substr(0, base.find('#')) + location; }
  798. auto base_path = base.substr(0, base.find_first_of("?#"));
  799. if (location[0] == '?') { return base_path + location; }
  800. if (base_path.empty() || base_path[0] != '/') { base_path = "/"; }
  801. auto merged = base_path.substr(0, base_path.rfind('/') + 1) + location;
  802. // Remove "." and ".." segments from the merged path.
  803. auto path_end = (std::min)(merged.find_first_of("?#"), merged.size());
  804. std::string path;
  805. size_t i = 0;
  806. while (i < path_end) {
  807. auto next = (std::min)(merged.find('/', i + 1), path_end);
  808. auto segment = merged.substr(i + 1, next - i - 1);
  809. auto is_last = next == path_end;
  810. if (segment == "." || segment == "..") {
  811. if (segment == "..") {
  812. path.erase((std::min)(path.rfind('/'), path.size()));
  813. }
  814. if (is_last) { path += '/'; }
  815. } else {
  816. path += '/';
  817. path += segment;
  818. }
  819. i = next;
  820. }
  821. if (path.empty()) { path = "/"; }
  822. return path + merged.substr(path_end);
  823. }
  824. } // namespace detail
  825. enum class SSLVerifierResponse {
  826. // no decision has been made, use the built-in certificate verifier
  827. NoDecisionMade,
  828. // connection certificate is verified and accepted
  829. CertificateAccepted,
  830. // connection certificate was processed but is rejected
  831. CertificateRejected
  832. };
  833. // System CA loading policy for SSL clients. Auto (the default) loads system
  834. // CA certs only when no custom CA is configured; enable_system_ca() switches
  835. // to an explicit policy.
  836. enum class SystemCAMode { Auto, Enabled, Disabled };
  837. enum StatusCode {
  838. // Information responses
  839. Continue_100 = 100,
  840. SwitchingProtocol_101 = 101,
  841. Processing_102 = 102,
  842. EarlyHints_103 = 103,
  843. // Successful responses
  844. OK_200 = 200,
  845. Created_201 = 201,
  846. Accepted_202 = 202,
  847. NonAuthoritativeInformation_203 = 203,
  848. NoContent_204 = 204,
  849. ResetContent_205 = 205,
  850. PartialContent_206 = 206,
  851. MultiStatus_207 = 207,
  852. AlreadyReported_208 = 208,
  853. IMUsed_226 = 226,
  854. // Redirection messages
  855. MultipleChoices_300 = 300,
  856. MovedPermanently_301 = 301,
  857. Found_302 = 302,
  858. SeeOther_303 = 303,
  859. NotModified_304 = 304,
  860. UseProxy_305 = 305,
  861. unused_306 = 306,
  862. TemporaryRedirect_307 = 307,
  863. PermanentRedirect_308 = 308,
  864. // Client error responses
  865. BadRequest_400 = 400,
  866. Unauthorized_401 = 401,
  867. PaymentRequired_402 = 402,
  868. Forbidden_403 = 403,
  869. NotFound_404 = 404,
  870. MethodNotAllowed_405 = 405,
  871. NotAcceptable_406 = 406,
  872. ProxyAuthenticationRequired_407 = 407,
  873. RequestTimeout_408 = 408,
  874. Conflict_409 = 409,
  875. Gone_410 = 410,
  876. LengthRequired_411 = 411,
  877. PreconditionFailed_412 = 412,
  878. PayloadTooLarge_413 = 413,
  879. UriTooLong_414 = 414,
  880. UnsupportedMediaType_415 = 415,
  881. RangeNotSatisfiable_416 = 416,
  882. ExpectationFailed_417 = 417,
  883. ImATeapot_418 = 418,
  884. MisdirectedRequest_421 = 421,
  885. UnprocessableContent_422 = 422,
  886. Locked_423 = 423,
  887. FailedDependency_424 = 424,
  888. TooEarly_425 = 425,
  889. UpgradeRequired_426 = 426,
  890. PreconditionRequired_428 = 428,
  891. TooManyRequests_429 = 429,
  892. RequestHeaderFieldsTooLarge_431 = 431,
  893. UnavailableForLegalReasons_451 = 451,
  894. // Server error responses
  895. InternalServerError_500 = 500,
  896. NotImplemented_501 = 501,
  897. BadGateway_502 = 502,
  898. ServiceUnavailable_503 = 503,
  899. GatewayTimeout_504 = 504,
  900. HttpVersionNotSupported_505 = 505,
  901. VariantAlsoNegotiates_506 = 506,
  902. InsufficientStorage_507 = 507,
  903. LoopDetected_508 = 508,
  904. NotExtended_510 = 510,
  905. NetworkAuthenticationRequired_511 = 511,
  906. };
  907. namespace detail {
  908. // A multimap that keeps its entries in the order they were inserted.
  909. //
  910. // HTTP needs that order in two places. RFC 9110 5.3 makes the order of header
  911. // fields sharing a field name significant and forbids a proxy from reordering
  912. // them, and a query string's parameters are meaningful in the order the caller
  913. // wrote them. Neither standard container expresses it: std::unordered_multimap
  914. // gives no ordering guarantee at all for equivalent keys (libstdc++ yields
  915. // reverse insertion order, libc++ insertion order), and std::multimap sorts by
  916. // key, which would drop control data such as Host behind whatever else the
  917. // message carries and alphabetise a query string.
  918. //
  919. // Entries are therefore kept in a flat vector, in order. Lookup is a linear
  920. // scan, which beats hashing for the handful of entries a message carries
  921. // (headers are capped at CPPHTTPLIB_HEADER_MAX_COUNT).
  922. //
  923. // KeyEqual compares keys; it is what makes Headers case-insensitive and
  924. // Params, whose parameter names are case-sensitive, not.
  925. template <typename Mapped, typename KeyEqual> class insertion_ordered_multimap {
  926. public:
  927. using key_type = std::string;
  928. using mapped_type = Mapped;
  929. using value_type = std::pair<std::string, Mapped>;
  930. using size_type = std::size_t;
  931. using difference_type = std::ptrdiff_t;
  932. using reference = value_type &;
  933. using const_reference = const value_type &;
  934. private:
  935. static size_type npos() { return static_cast<size_type>(-1); }
  936. static bool keys_equal(const std::string &a, const std::string &b) {
  937. return KeyEqual()(a, b);
  938. }
  939. // Iterating yields every entry in insertion order, but equal_range() and
  940. // find() have to walk only the entries sharing one key, which are not
  941. // adjacent. Both are the same iterator type: key_idx_ selects between the
  942. // two traversals, and since equality compares only the position, an iterator
  943. // restricted to one key still compares equal to end().
  944. template <typename V> class iterator_t {
  945. public:
  946. using iterator_category = std::bidirectional_iterator_tag;
  947. using value_type = insertion_ordered_multimap::value_type;
  948. using difference_type = insertion_ordered_multimap::difference_type;
  949. using pointer = V *;
  950. using reference = V &;
  951. iterator_t() : data_(nullptr), idx_(0), size_(0), key_idx_(npos()) {}
  952. template <typename U,
  953. typename std::enable_if<std::is_convertible<U *, V *>::value,
  954. int>::type = 0>
  955. iterator_t(const iterator_t<U> &rhs)
  956. : data_(rhs.data_), idx_(rhs.idx_), size_(rhs.size_),
  957. key_idx_(rhs.key_idx_) {}
  958. reference operator*() const { return data_[idx_]; }
  959. pointer operator->() const { return data_ + idx_; }
  960. iterator_t &operator++() {
  961. // Saturating, so that advancing past the last entry of a key (which
  962. // get_multimap_value() does when asked for an out-of-range id) stays at
  963. // end() instead of running off the container.
  964. if (idx_ >= size_) { return *this; }
  965. ++idx_;
  966. if (key_idx_ != npos()) {
  967. while (idx_ < size_ && !matches(idx_)) {
  968. ++idx_;
  969. }
  970. }
  971. return *this;
  972. }
  973. iterator_t operator++(int) {
  974. auto tmp = *this;
  975. ++*this;
  976. return tmp;
  977. }
  978. iterator_t &operator--() {
  979. if (idx_ == 0) { return *this; }
  980. --idx_;
  981. if (key_idx_ != npos()) {
  982. while (idx_ > 0 && !matches(idx_)) {
  983. --idx_;
  984. }
  985. }
  986. return *this;
  987. }
  988. iterator_t operator--(int) {
  989. auto tmp = *this;
  990. --*this;
  991. return tmp;
  992. }
  993. template <typename U> bool operator==(const iterator_t<U> &rhs) const {
  994. return idx_ == rhs.idx_;
  995. }
  996. template <typename U> bool operator!=(const iterator_t<U> &rhs) const {
  997. return idx_ != rhs.idx_;
  998. }
  999. private:
  1000. friend class insertion_ordered_multimap;
  1001. template <typename> friend class iterator_t;
  1002. iterator_t(V *data, size_type idx, size_type size, size_type key_idx)
  1003. : data_(data), idx_(idx), size_(size), key_idx_(key_idx) {}
  1004. bool matches(size_type i) const {
  1005. return keys_equal(data_[i].first, data_[key_idx_].first);
  1006. }
  1007. V *data_;
  1008. size_type idx_;
  1009. size_type size_;
  1010. size_type key_idx_;
  1011. };
  1012. public:
  1013. using iterator = iterator_t<value_type>;
  1014. using const_iterator = iterator_t<const value_type>;
  1015. insertion_ordered_multimap() = default;
  1016. insertion_ordered_multimap(std::initializer_list<value_type> il)
  1017. : entries_(il) {}
  1018. template <typename InputIt>
  1019. insertion_ordered_multimap(InputIt first, InputIt last)
  1020. : entries_(first, last) {}
  1021. iterator begin() { return make_iter(0, npos()); }
  1022. iterator end() { return make_iter(entries_.size(), npos()); }
  1023. const_iterator begin() const { return make_citer(0, npos()); }
  1024. const_iterator end() const { return make_citer(entries_.size(), npos()); }
  1025. const_iterator cbegin() const { return begin(); }
  1026. const_iterator cend() const { return end(); }
  1027. bool empty() const { return entries_.empty(); }
  1028. size_type size() const { return entries_.size(); }
  1029. void clear() { entries_.clear(); }
  1030. void swap(insertion_ordered_multimap &rhs) { entries_.swap(rhs.entries_); }
  1031. iterator insert(const value_type &val) {
  1032. entries_.push_back(val);
  1033. return make_iter(entries_.size() - 1, npos());
  1034. }
  1035. iterator insert(value_type &&val) {
  1036. entries_.push_back(std::move(val));
  1037. return make_iter(entries_.size() - 1, npos());
  1038. }
  1039. template <typename... Args> iterator emplace(Args &&...args) {
  1040. entries_.emplace_back(std::forward<Args>(args)...);
  1041. return make_iter(entries_.size() - 1, npos());
  1042. }
  1043. // For entries that have to lead the message, such as the Host header field
  1044. // (RFC 9110 5.3 recommends sending control data first).
  1045. template <typename... Args> iterator emplace_front(Args &&...args) {
  1046. entries_.emplace(entries_.begin(), std::forward<Args>(args)...);
  1047. return make_iter(0, npos());
  1048. }
  1049. iterator find(const std::string &key) {
  1050. auto i = index_of(key);
  1051. return i == npos() ? end() : make_iter(i, i);
  1052. }
  1053. const_iterator find(const std::string &key) const {
  1054. auto i = index_of(key);
  1055. return i == npos() ? end() : make_citer(i, i);
  1056. }
  1057. size_type count(const std::string &key) const {
  1058. size_type n = 0;
  1059. for (const auto &entry : entries_) {
  1060. if (keys_equal(entry.first, key)) { n++; }
  1061. }
  1062. return n;
  1063. }
  1064. std::pair<iterator, iterator> equal_range(const std::string &key) {
  1065. auto i = index_of(key);
  1066. return i == npos() ? std::make_pair(end(), end())
  1067. : std::make_pair(make_iter(i, i), end());
  1068. }
  1069. std::pair<const_iterator, const_iterator>
  1070. equal_range(const std::string &key) const {
  1071. auto i = index_of(key);
  1072. return i == npos() ? std::make_pair(end(), end())
  1073. : std::make_pair(make_citer(i, i), end());
  1074. }
  1075. size_type erase(const std::string &key) {
  1076. auto before = entries_.size();
  1077. entries_.erase(std::remove_if(entries_.begin(), entries_.end(),
  1078. [&](const value_type &entry) {
  1079. return keys_equal(entry.first, key);
  1080. }),
  1081. entries_.end());
  1082. return before - entries_.size();
  1083. }
  1084. iterator erase(const_iterator pos) {
  1085. entries_.erase(entries_.begin() + static_cast<difference_type>(pos.idx_));
  1086. return make_iter(pos.idx_, npos());
  1087. }
  1088. // Erases what iterating [first, last) would actually visit, so erasing an
  1089. // equal_range() removes only the entries with that key, not everything
  1090. // positioned between them.
  1091. iterator erase(const_iterator first, const_iterator last) {
  1092. auto from = first.idx_;
  1093. auto to = last.idx_;
  1094. if (from >= to) { return make_iter(from, npos()); }
  1095. auto begin_it = entries_.begin();
  1096. auto from_it = begin_it + static_cast<difference_type>(from);
  1097. auto to_it = begin_it + static_cast<difference_type>(to);
  1098. if (first.key_idx_ == npos()) {
  1099. entries_.erase(from_it, to_it);
  1100. } else {
  1101. auto key = entries_[first.key_idx_].first;
  1102. auto keep = from_it;
  1103. for (auto it = from_it; it != to_it; ++it) {
  1104. if (!keys_equal(it->first, key)) {
  1105. if (keep != it) { *keep = std::move(*it); }
  1106. ++keep;
  1107. }
  1108. }
  1109. if (keep != to_it) {
  1110. keep = std::move(to_it, entries_.end(), keep);
  1111. } else {
  1112. keep = entries_.end();
  1113. }
  1114. entries_.erase(keep, entries_.end());
  1115. }
  1116. return make_iter(from, npos());
  1117. }
  1118. friend bool operator==(const insertion_ordered_multimap &lhs,
  1119. const insertion_ordered_multimap &rhs) {
  1120. return lhs.entries_ == rhs.entries_;
  1121. }
  1122. friend bool operator!=(const insertion_ordered_multimap &lhs,
  1123. const insertion_ordered_multimap &rhs) {
  1124. return !(lhs == rhs);
  1125. }
  1126. private:
  1127. size_type index_of(const std::string &key) const {
  1128. for (size_type i = 0; i < entries_.size(); i++) {
  1129. if (keys_equal(entries_[i].first, key)) { return i; }
  1130. }
  1131. return npos();
  1132. }
  1133. iterator make_iter(size_type idx, size_type key_idx) {
  1134. return iterator(entries_.data(), idx, entries_.size(), key_idx);
  1135. }
  1136. const_iterator make_citer(size_type idx, size_type key_idx) const {
  1137. return const_iterator(entries_.data(), idx, entries_.size(), key_idx);
  1138. }
  1139. std::vector<value_type> entries_;
  1140. };
  1141. } // namespace detail
  1142. using Headers =
  1143. detail::insertion_ordered_multimap<std::string,
  1144. detail::case_ignore::equal_to>;
  1145. // Query parameter names are case-sensitive, unlike header field names.
  1146. using Params =
  1147. detail::insertion_ordered_multimap<std::string, std::equal_to<std::string>>;
  1148. using Match = std::smatch;
  1149. using DownloadProgress = std::function<bool(size_t current, size_t total)>;
  1150. using UploadProgress = std::function<bool(size_t current, size_t total)>;
  1151. /*
  1152. * detail: type-erased storage used by UserData.
  1153. * ABI-stable regardless of C++ standard — always uses this custom
  1154. * implementation instead of std::any.
  1155. */
  1156. namespace detail {
  1157. using any_type_id = const void *;
  1158. template <typename T> any_type_id any_typeid() noexcept {
  1159. static const char id = 0;
  1160. return &id;
  1161. }
  1162. struct any_storage {
  1163. virtual ~any_storage() = default;
  1164. virtual std::unique_ptr<any_storage> clone() const = 0;
  1165. virtual any_type_id type_id() const noexcept = 0;
  1166. };
  1167. template <typename T> struct any_value final : any_storage {
  1168. T value;
  1169. template <typename U> explicit any_value(U &&v) : value(std::forward<U>(v)) {}
  1170. std::unique_ptr<any_storage> clone() const override {
  1171. return std::unique_ptr<any_storage>(new any_value<T>(value));
  1172. }
  1173. any_type_id type_id() const noexcept override { return any_typeid<T>(); }
  1174. };
  1175. } // namespace detail
  1176. class UserData {
  1177. public:
  1178. UserData() = default;
  1179. UserData(UserData &&) noexcept = default;
  1180. UserData &operator=(UserData &&) noexcept = default;
  1181. UserData(const UserData &o) {
  1182. for (const auto &e : o.entries_) {
  1183. if (e.second) { entries_[e.first] = e.second->clone(); }
  1184. }
  1185. }
  1186. UserData &operator=(const UserData &o) {
  1187. if (this != &o) {
  1188. entries_.clear();
  1189. for (const auto &e : o.entries_) {
  1190. if (e.second) { entries_[e.first] = e.second->clone(); }
  1191. }
  1192. }
  1193. return *this;
  1194. }
  1195. template <typename T> void set(const std::string &key, T &&value) {
  1196. using D = typename std::decay<T>::type;
  1197. entries_[key].reset(new detail::any_value<D>(std::forward<T>(value)));
  1198. }
  1199. template <typename T> T *get(const std::string &key) noexcept {
  1200. auto it = entries_.find(key);
  1201. if (it == entries_.end() || !it->second) { return nullptr; }
  1202. if (it->second->type_id() != detail::any_typeid<T>()) { return nullptr; }
  1203. return &static_cast<detail::any_value<T> *>(it->second.get())->value;
  1204. }
  1205. template <typename T> const T *get(const std::string &key) const noexcept {
  1206. auto it = entries_.find(key);
  1207. if (it == entries_.end() || !it->second) { return nullptr; }
  1208. if (it->second->type_id() != detail::any_typeid<T>()) { return nullptr; }
  1209. return &static_cast<const detail::any_value<T> *>(it->second.get())->value;
  1210. }
  1211. bool has(const std::string &key) const noexcept {
  1212. return entries_.find(key) != entries_.end();
  1213. }
  1214. void erase(const std::string &key) { entries_.erase(key); }
  1215. void clear() noexcept { entries_.clear(); }
  1216. private:
  1217. std::unordered_map<std::string, std::unique_ptr<detail::any_storage>>
  1218. entries_;
  1219. };
  1220. struct Response;
  1221. using ResponseHandler = std::function<bool(const Response &response)>;
  1222. struct FormData {
  1223. std::string name;
  1224. std::string content;
  1225. std::string filename;
  1226. std::string content_type;
  1227. Headers headers;
  1228. };
  1229. struct FormField {
  1230. std::string name;
  1231. std::string content;
  1232. Headers headers;
  1233. };
  1234. // RFC 7578 5.2: a form processor "SHOULD send back results in order" and
  1235. // "Intermediaries MUST NOT reorder the results", so a handler walking these
  1236. // should see the parts as they were sent. A std::multimap sorts by field name
  1237. // and loses that. Field names are case-sensitive, hence std::equal_to rather
  1238. // than the case-insensitive predicate Headers uses.
  1239. using FormFields =
  1240. detail::insertion_ordered_multimap<FormField, std::equal_to<std::string>>;
  1241. using FormFiles =
  1242. detail::insertion_ordered_multimap<FormData, std::equal_to<std::string>>;
  1243. struct MultipartFormData {
  1244. FormFields fields; // Text fields from multipart
  1245. FormFiles files; // Files from multipart
  1246. // Text field access
  1247. std::string get_field(const std::string &key, size_t id = 0) const;
  1248. std::vector<std::string> get_fields(const std::string &key) const;
  1249. bool has_field(const std::string &key) const;
  1250. size_t get_field_count(const std::string &key) const;
  1251. // File access
  1252. FormData get_file(const std::string &key, size_t id = 0) const;
  1253. std::vector<FormData> get_files(const std::string &key) const;
  1254. bool has_file(const std::string &key) const;
  1255. size_t get_file_count(const std::string &key) const;
  1256. };
  1257. struct UploadFormData {
  1258. std::string name;
  1259. std::string content;
  1260. std::string filename;
  1261. std::string content_type;
  1262. };
  1263. using UploadFormDataItems = std::vector<UploadFormData>;
  1264. class DataSink {
  1265. public:
  1266. DataSink() : os(&sb_), sb_(*this) {}
  1267. DataSink(const DataSink &) = delete;
  1268. DataSink &operator=(const DataSink &) = delete;
  1269. DataSink(DataSink &&) = delete;
  1270. DataSink &operator=(DataSink &&) = delete;
  1271. std::function<bool(const char *data, size_t data_len)> write;
  1272. // Only `write` is mandatory. The rest are defaulted so that a provider
  1273. // calling one on a writer that does not set it gets sensible behaviour
  1274. // rather than std::bad_function_call thrown from a worker thread. Capturing
  1275. // `this` is safe: DataSink is neither copyable nor movable.
  1276. std::function<bool()> is_writable = []() { return true; };
  1277. std::function<void()> done = []() {};
  1278. std::function<void(const Headers &trailer)> done_with_trailer =
  1279. [this](const Headers & /*trailer*/) { done(); };
  1280. std::ostream os;
  1281. private:
  1282. class data_sink_streambuf final : public std::streambuf {
  1283. public:
  1284. explicit data_sink_streambuf(DataSink &sink) : sink_(sink) {}
  1285. protected:
  1286. std::streamsize xsputn(const char *s, std::streamsize n) override {
  1287. if (sink_.write(s, static_cast<size_t>(n))) { return n; }
  1288. return 0;
  1289. }
  1290. private:
  1291. DataSink &sink_;
  1292. };
  1293. data_sink_streambuf sb_;
  1294. };
  1295. using ContentProvider =
  1296. std::function<bool(size_t offset, size_t length, DataSink &sink)>;
  1297. using ContentProviderWithoutLength =
  1298. std::function<bool(size_t offset, DataSink &sink)>;
  1299. using ContentProviderResourceReleaser = std::function<void(bool success)>;
  1300. struct FormDataProvider {
  1301. std::string name;
  1302. ContentProviderWithoutLength provider;
  1303. std::string filename;
  1304. std::string content_type;
  1305. };
  1306. using FormDataProviderItems = std::vector<FormDataProvider>;
  1307. inline FormDataProvider
  1308. make_file_provider(const std::string &name, const std::string &filepath,
  1309. const std::string &filename = std::string(),
  1310. const std::string &content_type = std::string()) {
  1311. FormDataProvider fdp;
  1312. fdp.name = name;
  1313. fdp.filename = filename.empty() ? filepath : filename;
  1314. fdp.content_type = content_type;
  1315. fdp.provider = [filepath](size_t offset, DataSink &sink) -> bool {
  1316. std::ifstream f(filepath, std::ios::binary);
  1317. if (!f) { return false; }
  1318. if (offset > 0) {
  1319. f.seekg(static_cast<std::streamoff>(offset));
  1320. if (!f.good()) {
  1321. sink.done();
  1322. return true;
  1323. }
  1324. }
  1325. char buf[8192];
  1326. f.read(buf, sizeof(buf));
  1327. auto n = static_cast<size_t>(f.gcount());
  1328. if (n > 0) { return sink.write(buf, n); }
  1329. sink.done(); // EOF
  1330. return true;
  1331. };
  1332. return fdp;
  1333. }
  1334. inline std::pair<size_t, ContentProvider>
  1335. make_file_body(const std::string &filepath) {
  1336. size_t size = 0;
  1337. {
  1338. std::ifstream f(filepath, std::ios::binary | std::ios::ate);
  1339. if (!f) { return {0, ContentProvider{}}; }
  1340. size = static_cast<size_t>(f.tellg());
  1341. }
  1342. ContentProvider provider = [filepath](size_t offset, size_t length,
  1343. DataSink &sink) -> bool {
  1344. std::ifstream f(filepath, std::ios::binary);
  1345. if (!f) { return false; }
  1346. f.seekg(static_cast<std::streamoff>(offset));
  1347. if (!f.good()) { return false; }
  1348. char buf[8192];
  1349. while (length > 0) {
  1350. auto to_read = (std::min)(sizeof(buf), length);
  1351. f.read(buf, static_cast<std::streamsize>(to_read));
  1352. auto n = static_cast<size_t>(f.gcount());
  1353. // The file is shorter than the size make_file_body() measured, which the
  1354. // caller has already committed to as Content-Length. The body cannot be
  1355. // completed, so fail as every other error here does.
  1356. if (n == 0) { return false; }
  1357. if (!sink.write(buf, n)) { return false; }
  1358. length -= n;
  1359. }
  1360. return true;
  1361. };
  1362. return {size, std::move(provider)};
  1363. }
  1364. using ContentReceiverWithProgress = std::function<bool(
  1365. const char *data, size_t data_length, size_t offset, size_t total_length)>;
  1366. using ContentReceiver =
  1367. std::function<bool(const char *data, size_t data_length)>;
  1368. using FormDataHeader = std::function<bool(const FormData &file)>;
  1369. class ContentReader {
  1370. public:
  1371. using Reader = std::function<bool(ContentReceiver receiver)>;
  1372. using FormDataReader =
  1373. std::function<bool(FormDataHeader header, ContentReceiver receiver)>;
  1374. ContentReader(Reader reader, FormDataReader multipart_reader)
  1375. : reader_(std::move(reader)),
  1376. formdata_reader_(std::move(multipart_reader)) {}
  1377. bool operator()(FormDataHeader header, ContentReceiver receiver) const {
  1378. return formdata_reader_(std::move(header), std::move(receiver));
  1379. }
  1380. bool operator()(ContentReceiver receiver) const {
  1381. return reader_(std::move(receiver));
  1382. }
  1383. Reader reader_;
  1384. FormDataReader formdata_reader_;
  1385. };
  1386. using Range = std::pair<ssize_t, ssize_t>;
  1387. using Ranges = std::vector<Range>;
  1388. #ifdef CPPHTTPLIB_SSL_ENABLED
  1389. // TLS abstraction layer - public type definitions and API
  1390. namespace tls {
  1391. // Opaque handles (defined as void* for abstraction)
  1392. using ctx_t = void *;
  1393. using session_t = void *;
  1394. using const_session_t = const void *; // For read-only session access
  1395. using cert_t = void *;
  1396. using ca_store_t = void *;
  1397. // TLS versions
  1398. enum class Version {
  1399. TLS1_2 = 0x0303,
  1400. TLS1_3 = 0x0304,
  1401. };
  1402. // Subject Alternative Names (SAN) entry types
  1403. enum class SanType { DNS, IP, EMAIL, URI, OTHER };
  1404. // SAN entry structure
  1405. struct SanEntry {
  1406. SanType type;
  1407. std::string value;
  1408. };
  1409. // Verification context for certificate verification callback
  1410. struct VerifyContext {
  1411. session_t session; // TLS session handle
  1412. cert_t cert; // Current certificate being verified
  1413. int depth; // Certificate chain depth (0 = leaf)
  1414. bool preverify_ok; // OpenSSL/Mbed TLS pre-verification result
  1415. long error_code; // Backend-specific error code (0 = no error)
  1416. const char *error_string; // Human-readable error description
  1417. // Certificate introspection methods
  1418. std::string subject_cn() const;
  1419. std::string issuer_name() const;
  1420. bool check_hostname(const char *hostname) const;
  1421. std::vector<SanEntry> sans() const;
  1422. bool validity(time_t &not_before, time_t &not_after) const;
  1423. std::string serial() const;
  1424. };
  1425. using VerifyCallback = std::function<bool(const VerifyContext &ctx)>;
  1426. // TlsError codes for TLS operations (backend-independent)
  1427. enum class ErrorCode : int {
  1428. Success = 0,
  1429. WantRead, // Non-blocking: need to wait for read
  1430. WantWrite, // Non-blocking: need to wait for write
  1431. PeerClosed, // Peer closed the connection
  1432. Fatal, // Unrecoverable error
  1433. SyscallError, // System call error (check sys_errno)
  1434. CertVerifyFailed, // Certificate verification failed
  1435. HostnameMismatch, // Hostname verification failed
  1436. };
  1437. // TLS error information
  1438. struct TlsError {
  1439. ErrorCode code = ErrorCode::Fatal;
  1440. uint64_t backend_code = 0; // OpenSSL: ERR_get_error(), mbedTLS: return value
  1441. int sys_errno = 0; // errno when SyscallError
  1442. // Convert verification error code to human-readable string
  1443. static std::string verify_error_to_string(long error_code);
  1444. };
  1445. // RAII wrapper for peer certificate
  1446. class PeerCert {
  1447. public:
  1448. PeerCert();
  1449. PeerCert(PeerCert &&other) noexcept;
  1450. PeerCert &operator=(PeerCert &&other) noexcept;
  1451. ~PeerCert();
  1452. PeerCert(const PeerCert &) = delete;
  1453. PeerCert &operator=(const PeerCert &) = delete;
  1454. explicit operator bool() const;
  1455. std::string subject_cn() const;
  1456. std::string issuer_name() const;
  1457. bool check_hostname(const char *hostname) const;
  1458. std::vector<SanEntry> sans() const;
  1459. bool validity(time_t &not_before, time_t &not_after) const;
  1460. std::string serial() const;
  1461. private:
  1462. explicit PeerCert(cert_t cert);
  1463. cert_t cert_ = nullptr;
  1464. friend PeerCert get_peer_cert_from_session(const_session_t session);
  1465. };
  1466. // Callback for TLS context setup (used by SSLServer constructor)
  1467. using ContextSetupCallback = std::function<bool(ctx_t ctx)>;
  1468. } // namespace tls
  1469. #endif
  1470. struct Request {
  1471. std::string method;
  1472. std::string path;
  1473. std::string matched_route;
  1474. Params params;
  1475. Headers headers;
  1476. Headers trailers;
  1477. std::string body;
  1478. std::string remote_addr;
  1479. int remote_port = -1;
  1480. std::string local_addr;
  1481. int local_port = -1;
  1482. // for server
  1483. std::string version;
  1484. std::string target;
  1485. MultipartFormData form;
  1486. Ranges ranges;
  1487. Match matches;
  1488. std::unordered_map<std::string, std::string> path_params;
  1489. std::function<bool()> is_connection_closed = []() { return true; };
  1490. // for client
  1491. std::vector<std::string> accept_content_types;
  1492. ResponseHandler response_handler;
  1493. ContentReceiverWithProgress content_receiver;
  1494. DownloadProgress download_progress;
  1495. UploadProgress upload_progress;
  1496. bool has_header(const std::string &key) const;
  1497. std::string get_header_value(const std::string &key, const char *def = "",
  1498. size_t id = 0) const;
  1499. size_t get_header_value_u64(const std::string &key, size_t def = 0,
  1500. size_t id = 0) const;
  1501. size_t get_header_value_count(const std::string &key) const;
  1502. void set_header(const std::string &key, const std::string &val);
  1503. bool has_trailer(const std::string &key) const;
  1504. std::string get_trailer_value(const std::string &key, size_t id = 0) const;
  1505. size_t get_trailer_value_count(const std::string &key) const;
  1506. bool has_param(const std::string &key) const;
  1507. std::string get_param_value(const std::string &key, size_t id = 0) const;
  1508. std::vector<std::string> get_param_values(const std::string &key) const;
  1509. size_t get_param_value_count(const std::string &key) const;
  1510. bool is_multipart_form_data() const;
  1511. // private members...
  1512. bool body_consumed_ = false;
  1513. bool expect_100_continue_pending_ = false;
  1514. size_t redirect_count_ = CPPHTTPLIB_REDIRECT_MAX_COUNT;
  1515. size_t content_length_ = 0;
  1516. ContentProvider content_provider_;
  1517. bool is_chunked_content_provider_ = false;
  1518. size_t authorization_count_ = 0;
  1519. std::chrono::time_point<std::chrono::steady_clock> start_time_ =
  1520. (std::chrono::steady_clock::time_point::min)();
  1521. #ifdef CPPHTTPLIB_SSL_ENABLED
  1522. tls::const_session_t ssl = nullptr;
  1523. tls::PeerCert peer_cert() const;
  1524. std::string sni() const;
  1525. #endif
  1526. };
  1527. namespace detail {
  1528. // Declared up here, away from the rest of the compression helpers, because
  1529. // `Response` stores one.
  1530. enum class EncodingType { None = 0, Gzip, Brotli, Zstd };
  1531. } // namespace detail
  1532. struct Response {
  1533. std::string version;
  1534. int status = -1;
  1535. std::string reason;
  1536. Headers headers;
  1537. Headers trailers;
  1538. std::string body;
  1539. std::string location; // Redirect location
  1540. // User-defined context — set by pre-routing/pre-request handlers and read
  1541. // by route handlers to pass arbitrary data (e.g. decoded auth tokens).
  1542. UserData user_data;
  1543. bool has_header(const std::string &key) const;
  1544. std::string get_header_value(const std::string &key, const char *def = "",
  1545. size_t id = 0) const;
  1546. size_t get_header_value_u64(const std::string &key, size_t def = 0,
  1547. size_t id = 0) const;
  1548. size_t get_header_value_count(const std::string &key) const;
  1549. void set_header(const std::string &key, const std::string &val);
  1550. bool has_trailer(const std::string &key) const;
  1551. std::string get_trailer_value(const std::string &key, size_t id = 0) const;
  1552. size_t get_trailer_value_count(const std::string &key) const;
  1553. void set_redirect(const std::string &url, int status = StatusCode::Found_302);
  1554. void set_content(const char *s, size_t n, const std::string &content_type);
  1555. void set_content(const std::string &s, const std::string &content_type);
  1556. void set_content(std::string &&s, const std::string &content_type);
  1557. void set_content_provider(
  1558. size_t length, const std::string &content_type, ContentProvider provider,
  1559. ContentProviderResourceReleaser resource_releaser = nullptr);
  1560. void set_content_provider(
  1561. const std::string &content_type, ContentProviderWithoutLength provider,
  1562. ContentProviderResourceReleaser resource_releaser = nullptr);
  1563. void set_chunked_content_provider(
  1564. const std::string &content_type, ContentProviderWithoutLength provider,
  1565. ContentProviderResourceReleaser resource_releaser = nullptr);
  1566. void set_file_content(const std::string &path,
  1567. const std::string &content_type);
  1568. void set_file_content(const std::string &path);
  1569. Response() = default;
  1570. Response(const Response &) = default;
  1571. Response &operator=(const Response &) = default;
  1572. Response(Response &&) = default;
  1573. Response &operator=(Response &&) = default;
  1574. ~Response() {
  1575. if (content_provider_resource_releaser_) {
  1576. content_provider_resource_releaser_(content_provider_success_);
  1577. }
  1578. }
  1579. // private members...
  1580. size_t content_length_ = 0;
  1581. ContentProvider content_provider_;
  1582. ContentProviderResourceReleaser content_provider_resource_releaser_;
  1583. bool is_chunked_content_provider_ = false;
  1584. bool is_file_content_provider_ = false;
  1585. bool content_provider_success_ = false;
  1586. std::string file_content_path_;
  1587. std::string file_content_content_type_;
  1588. // Content coding chosen for the response body, decided once so that the
  1589. // headers and the body cannot disagree: where the file is opened for a
  1590. // file-backed content provider (keeping the ETag honest), and in
  1591. // `apply_ranges()` for a chunked content provider. `EncodingType::None`
  1592. // for every other kind of response.
  1593. detail::EncodingType content_coding_ = detail::EncodingType::None;
  1594. };
  1595. enum class Error {
  1596. Success = 0,
  1597. Unknown,
  1598. Connection,
  1599. BindIPAddress,
  1600. Read,
  1601. Write,
  1602. ExceedRedirectCount,
  1603. Canceled,
  1604. SSLConnection,
  1605. SSLLoadingCerts,
  1606. SSLServerVerification,
  1607. SSLServerHostnameVerification,
  1608. UnsupportedMultipartBoundaryChars,
  1609. Compression,
  1610. ConnectionTimeout,
  1611. ProxyConnection,
  1612. ConnectionClosed,
  1613. Timeout,
  1614. ResourceExhaustion,
  1615. TooManyFormDataFiles,
  1616. ExceedMaxPayloadSize,
  1617. ExceedUriMaxLength,
  1618. ExceedMaxSocketDescriptorCount,
  1619. InvalidRequestLine,
  1620. InvalidHTTPMethod,
  1621. InvalidHTTPVersion,
  1622. InvalidHeaders,
  1623. MultipartParsing,
  1624. OpenFile,
  1625. Listen,
  1626. GetSockName,
  1627. UnsupportedAddressFamily,
  1628. HTTPParsing,
  1629. InvalidRangeHeader,
  1630. UnsupportedContentEncoding,
  1631. WebSocketHandshake,
  1632. UserCallbackException,
  1633. // For internal use only
  1634. SSLPeerCouldBeClosed_,
  1635. };
  1636. std::string to_string(Error error);
  1637. std::ostream &operator<<(std::ostream &os, const Error &obj);
  1638. class Stream {
  1639. public:
  1640. virtual ~Stream() = default;
  1641. virtual bool is_readable() const = 0;
  1642. virtual bool wait_readable() const = 0;
  1643. virtual bool wait_writable() const = 0;
  1644. virtual bool is_peer_alive() const { return wait_writable(); }
  1645. virtual ssize_t read(char *ptr, size_t size) = 0;
  1646. virtual ssize_t write(const char *ptr, size_t size) = 0;
  1647. virtual void get_remote_ip_and_port(std::string &ip, int &port) const = 0;
  1648. virtual void get_local_ip_and_port(std::string &ip, int &port) const = 0;
  1649. virtual socket_t socket() const = 0;
  1650. virtual time_t duration() const = 0;
  1651. virtual void set_read_timeout(time_t sec, time_t usec = 0) {
  1652. (void)sec;
  1653. (void)usec;
  1654. }
  1655. // Bytes already pulled off the socket and sitting in this stream's own
  1656. // buffer. Exposing them lets a line reader scan for a terminator in one
  1657. // pass instead of asking for a byte at a time. A stream that does no
  1658. // buffering of its own reports none, and readers fall back to read().
  1659. virtual const char *buffered_data(size_t &size) const {
  1660. size = 0;
  1661. return nullptr;
  1662. }
  1663. // Discards `size` bytes previously returned by buffered_data().
  1664. virtual void consume_buffered(size_t size) { (void)size; }
  1665. ssize_t write(const char *ptr);
  1666. ssize_t write(const std::string &s);
  1667. Error get_error() const { return error_; }
  1668. protected:
  1669. Error error_ = Error::Success;
  1670. };
  1671. class TaskQueue {
  1672. public:
  1673. TaskQueue() = default;
  1674. virtual ~TaskQueue() = default;
  1675. virtual bool enqueue(std::function<void()> fn) = 0;
  1676. virtual void shutdown() = 0;
  1677. virtual void on_idle() {}
  1678. };
  1679. class ThreadPool final : public TaskQueue {
  1680. public:
  1681. explicit ThreadPool(
  1682. size_t n, size_t max_n = 0, size_t mqr = 0,
  1683. time_t idle_timeout_sec = CPPHTTPLIB_THREAD_POOL_IDLE_TIMEOUT);
  1684. ThreadPool(const ThreadPool &) = delete;
  1685. ~ThreadPool() override = default;
  1686. bool enqueue(std::function<void()> fn) override;
  1687. void shutdown() override;
  1688. private:
  1689. void worker(bool is_dynamic);
  1690. void move_to_finished(std::thread::id id);
  1691. void cleanup_finished_threads();
  1692. size_t base_thread_count_;
  1693. size_t max_thread_count_;
  1694. size_t max_queued_requests_;
  1695. time_t idle_timeout_sec_;
  1696. size_t idle_thread_count_;
  1697. bool shutdown_;
  1698. std::list<std::function<void()>> jobs_;
  1699. std::vector<std::thread> threads_; // base threads
  1700. std::list<std::thread> dynamic_threads_; // dynamic threads
  1701. std::vector<std::thread>
  1702. finished_threads_; // exited dynamic threads awaiting join
  1703. std::condition_variable cond_;
  1704. std::mutex mutex_;
  1705. };
  1706. using Logger = std::function<void(const Request &, const Response &)>;
  1707. // Forward declaration for Error type
  1708. enum class Error;
  1709. using ErrorLogger = std::function<void(const Error &, const Request *)>;
  1710. using SocketOptions = std::function<void(socket_t sock)>;
  1711. void default_socket_options(socket_t sock);
  1712. bool set_socket_opt(socket_t sock, int level, int optname, int optval);
  1713. const char *status_message(int status);
  1714. std::string to_string(Error error);
  1715. std::ostream &operator<<(std::ostream &os, const Error &obj);
  1716. std::string get_bearer_token_auth(const Request &req);
  1717. namespace detail {
  1718. class MatcherBase {
  1719. public:
  1720. MatcherBase(std::string pattern) : pattern_(std::move(pattern)) {}
  1721. virtual ~MatcherBase() = default;
  1722. const std::string &pattern() const { return pattern_; }
  1723. // Match request path and populate its matches and
  1724. virtual bool match(Request &request) const = 0;
  1725. private:
  1726. std::string pattern_;
  1727. };
  1728. /**
  1729. * Captures parameters in request path and stores them in Request::path_params
  1730. *
  1731. * Capture name is a substring of a pattern from : to /.
  1732. * The rest of the pattern is matched against the request path directly
  1733. * Parameters are captured starting from the next character after
  1734. * the end of the last matched static pattern fragment until the next /.
  1735. *
  1736. * Example pattern:
  1737. * "/path/fragments/:capture/more/fragments/:second_capture"
  1738. * Static fragments:
  1739. * "/path/fragments/", "more/fragments/"
  1740. *
  1741. * Given the following request path:
  1742. * "/path/fragments/:1/more/fragments/:2"
  1743. * the resulting capture will be
  1744. * {{"capture", "1"}, {"second_capture", "2"}}
  1745. */
  1746. class PathParamsMatcher final : public MatcherBase {
  1747. public:
  1748. PathParamsMatcher(const std::string &pattern);
  1749. bool match(Request &request) const override;
  1750. private:
  1751. // Treat segment separators as the end of path parameter capture
  1752. // Does not need to handle query parameters as they are parsed before path
  1753. // matching
  1754. static constexpr char separator = '/';
  1755. // Contains static path fragments to match against, excluding the '/' after
  1756. // path params
  1757. // Fragments are separated by path params
  1758. std::vector<std::string> static_fragments_;
  1759. // Stores the names of the path parameters to be used as keys in the
  1760. // Request::path_params map
  1761. std::vector<std::string> param_names_;
  1762. };
  1763. /**
  1764. * Performs std::regex_match on request path
  1765. * and stores the result in Request::matches
  1766. *
  1767. * Note that regex match is performed directly on the whole request.
  1768. * This means that wildcard patterns may match multiple path segments with /:
  1769. * "/begin/(.*)/end" will match both "/begin/middle/end" and "/begin/1/2/end".
  1770. */
  1771. class RegexMatcher final : public MatcherBase {
  1772. public:
  1773. RegexMatcher(const std::string &pattern)
  1774. : MatcherBase(pattern), regex_(pattern) {}
  1775. bool match(Request &request) const override;
  1776. private:
  1777. std::regex regex_;
  1778. };
  1779. int close_socket(socket_t sock) noexcept;
  1780. bool is_accept_resource_error();
  1781. bool is_accept_transient_error();
  1782. ssize_t write_headers(Stream &strm, const Headers &headers);
  1783. bool set_socket_opt_time(socket_t sock, int level, int optname, time_t sec,
  1784. time_t usec);
  1785. size_t get_multipart_content_length(const UploadFormDataItems &items,
  1786. const std::string &boundary);
  1787. ContentProvider
  1788. make_multipart_content_provider(const UploadFormDataItems &items,
  1789. const std::string &boundary);
  1790. } // namespace detail
  1791. bool is_valid_multipart_boundary(const std::string &boundary);
  1792. // Serializer for multipart/form-data request bodies. The boundary is owned
  1793. // by the writer so that per-part framing and the final terminator always
  1794. // agree. Field names and filenames are escaped following the WHATWG HTML
  1795. // standard ('"' -> %22, CR -> %0D, LF -> %0A); CR and LF are also escaped
  1796. // in content types.
  1797. class MultipartFormDataWriter {
  1798. public:
  1799. MultipartFormDataWriter();
  1800. // precondition: is_valid_multipart_boundary(boundary)
  1801. explicit MultipartFormDataWriter(std::string boundary);
  1802. const std::string &boundary() const;
  1803. std::string content_type() const;
  1804. // In-memory items -> whole body (known length)
  1805. std::string serialize(const UploadFormDataItems &items) const;
  1806. size_t content_length(const UploadFormDataItems &items) const;
  1807. // Per-part framing for streaming via a content provider
  1808. std::string item_begin(const UploadFormData &item) const;
  1809. static std::string item_end();
  1810. std::string finish() const;
  1811. private:
  1812. std::string boundary_;
  1813. };
  1814. class Server {
  1815. public:
  1816. using Handler = std::function<void(const Request &, Response &)>;
  1817. using ExceptionHandler =
  1818. std::function<void(const Request &, Response &, std::exception_ptr ep)>;
  1819. enum class HandlerResponse {
  1820. Handled,
  1821. Unhandled,
  1822. };
  1823. using HandlerWithResponse =
  1824. std::function<HandlerResponse(const Request &, Response &)>;
  1825. using HandlerWithContentReader = std::function<void(
  1826. const Request &, Response &, const ContentReader &content_reader)>;
  1827. using Expect100ContinueHandler =
  1828. std::function<int(const Request &, Response &)>;
  1829. using StartHandler = std::function<void()>;
  1830. using WebSocketHandler =
  1831. std::function<void(const Request &, ws::WebSocket &)>;
  1832. using SubProtocolSelector =
  1833. std::function<std::string(const std::vector<std::string> &protocols)>;
  1834. Server();
  1835. virtual ~Server();
  1836. virtual bool is_valid() const;
  1837. Server &Get(const std::string &pattern, Handler handler);
  1838. Server &Post(const std::string &pattern, Handler handler);
  1839. Server &Post(const std::string &pattern, HandlerWithContentReader handler);
  1840. Server &Put(const std::string &pattern, Handler handler);
  1841. Server &Put(const std::string &pattern, HandlerWithContentReader handler);
  1842. Server &Patch(const std::string &pattern, Handler handler);
  1843. Server &Patch(const std::string &pattern, HandlerWithContentReader handler);
  1844. Server &Delete(const std::string &pattern, Handler handler);
  1845. Server &Delete(const std::string &pattern, HandlerWithContentReader handler);
  1846. Server &Options(const std::string &pattern, Handler handler);
  1847. // Register a handler for an HTTP method outside the built-in set (e.g. the
  1848. // WebDAV methods from RFC 4918). Registering a method here is what makes the
  1849. // server accept it; an unregistered method is still rejected with 400.
  1850. // `method` must be a valid HTTP method token and must not be one of the
  1851. // built-in methods, which have their own registration functions above. A
  1852. // rejected registration makes is_valid() return false, so listen() fails.
  1853. Server &CustomRoute(const std::string &method, const std::string &pattern,
  1854. Handler handler);
  1855. Server &CustomRoute(const std::string &method, const std::string &pattern,
  1856. HandlerWithContentReader handler);
  1857. Server &WebSocket(const std::string &pattern, WebSocketHandler handler);
  1858. Server &WebSocket(const std::string &pattern, WebSocketHandler handler,
  1859. SubProtocolSelector sub_protocol_selector);
  1860. bool set_base_dir(const std::string &dir,
  1861. const std::string &mount_point = std::string());
  1862. bool set_mount_point(const std::string &mount_point, const std::string &dir,
  1863. Headers headers = Headers());
  1864. bool remove_mount_point(const std::string &mount_point);
  1865. Server &set_file_extension_and_mimetype_mapping(const std::string &ext,
  1866. const std::string &mime);
  1867. Server &set_default_file_mimetype(const std::string &mime);
  1868. Server &set_file_request_handler(Handler handler);
  1869. template <class ErrorHandlerFunc>
  1870. Server &set_error_handler(ErrorHandlerFunc &&handler) {
  1871. return set_error_handler_core(
  1872. std::forward<ErrorHandlerFunc>(handler),
  1873. std::is_convertible<ErrorHandlerFunc, HandlerWithResponse>{});
  1874. }
  1875. Server &set_exception_handler(ExceptionHandler handler);
  1876. Server &set_pre_routing_handler(HandlerWithResponse handler);
  1877. Server &set_post_routing_handler(Handler handler);
  1878. Server &set_pre_request_handler(HandlerWithResponse handler);
  1879. Server &set_expect_100_continue_handler(Expect100ContinueHandler handler);
  1880. Server &set_start_handler(StartHandler handler);
  1881. Server &set_logger(Logger logger);
  1882. Server &set_pre_compression_logger(Logger logger);
  1883. Server &set_error_logger(ErrorLogger error_logger);
  1884. Server &set_address_family(int family);
  1885. Server &set_tcp_nodelay(bool on);
  1886. Server &set_ipv6_v6only(bool on);
  1887. Server &set_socket_options(SocketOptions socket_options);
  1888. Server &set_default_headers(Headers headers);
  1889. Server &
  1890. set_header_writer(std::function<ssize_t(Stream &, Headers &)> const &writer);
  1891. Server &set_trusted_proxies(const std::vector<std::string> &proxies);
  1892. Server &set_keep_alive_max_count(size_t count);
  1893. Server &set_keep_alive_timeout(time_t sec);
  1894. template <class Rep, class Period>
  1895. Server &
  1896. set_keep_alive_timeout(const std::chrono::duration<Rep, Period> &duration);
  1897. Server &set_read_timeout(time_t sec, time_t usec = 0);
  1898. template <class Rep, class Period>
  1899. Server &set_read_timeout(const std::chrono::duration<Rep, Period> &duration);
  1900. Server &set_write_timeout(time_t sec, time_t usec = 0);
  1901. template <class Rep, class Period>
  1902. Server &set_write_timeout(const std::chrono::duration<Rep, Period> &duration);
  1903. Server &set_idle_interval(time_t sec, time_t usec = 0);
  1904. template <class Rep, class Period>
  1905. Server &set_idle_interval(const std::chrono::duration<Rep, Period> &duration);
  1906. Server &set_payload_max_length(size_t length);
  1907. Server &set_static_file_compression(bool on);
  1908. Server &set_static_file_compression_min_length(size_t length);
  1909. Server &set_static_file_compression_max_length(size_t length);
  1910. Server &set_websocket_ping_interval(time_t sec);
  1911. template <class Rep, class Period>
  1912. Server &set_websocket_ping_interval(
  1913. const std::chrono::duration<Rep, Period> &duration);
  1914. Server &set_websocket_max_missed_pongs(int count);
  1915. bool bind_to_port(const std::string &host, int port, int socket_flags = 0);
  1916. int bind_to_any_port(const std::string &host, int socket_flags = 0);
  1917. bool listen_after_bind();
  1918. bool listen(const std::string &host, int port, int socket_flags = 0);
  1919. bool is_running() const;
  1920. void wait_until_ready() const;
  1921. void stop() noexcept;
  1922. void decommission();
  1923. std::function<TaskQueue *(void)> new_task_queue;
  1924. protected:
  1925. bool process_request(Stream &strm, const std::string &remote_addr,
  1926. int remote_port, const std::string &local_addr,
  1927. int local_port, bool close_connection,
  1928. bool &connection_closed,
  1929. const std::function<void(Request &)> &setup_request,
  1930. bool *websocket_upgraded = nullptr);
  1931. // Runs the per-connection serving loop and stops an exception thrown by a
  1932. // user callback from escaping the worker thread.
  1933. //
  1934. // process_request() wraps only routing() in a try/catch. Content providers,
  1935. // the post-routing, error, logging and expect-100 handlers and WebSocket
  1936. // handlers all run outside it, and the task queue calls the job without a
  1937. // catch, so an exception from any of those would terminate the process.
  1938. //
  1939. // No 500 is possible here: by the time a content provider runs, the status
  1940. // line and headers are already on the wire. Report it through the error
  1941. // logger and drop the connection, which is what the peer observes either
  1942. // way. Other connections are unaffected.
  1943. template <typename Serve> bool serve_guarded(Serve &&serve) const {
  1944. #ifdef CPPHTTPLIB_NO_EXCEPTIONS
  1945. return serve();
  1946. #else
  1947. try {
  1948. return serve();
  1949. } catch (...) {
  1950. // The error logger is a user callback too, so it must not be able to
  1951. // throw the guard back open.
  1952. try {
  1953. output_error_log(Error::UserCallbackException, nullptr);
  1954. } catch (...) {}
  1955. return false;
  1956. }
  1957. #endif
  1958. }
  1959. std::atomic<socket_t> svr_sock_{INVALID_SOCKET};
  1960. std::vector<std::string> trusted_proxies_;
  1961. size_t keep_alive_max_count_ = CPPHTTPLIB_KEEPALIVE_MAX_COUNT;
  1962. time_t keep_alive_timeout_sec_ = CPPHTTPLIB_KEEPALIVE_TIMEOUT_SECOND;
  1963. time_t read_timeout_sec_ = CPPHTTPLIB_SERVER_READ_TIMEOUT_SECOND;
  1964. time_t read_timeout_usec_ = CPPHTTPLIB_SERVER_READ_TIMEOUT_USECOND;
  1965. time_t write_timeout_sec_ = CPPHTTPLIB_SERVER_WRITE_TIMEOUT_SECOND;
  1966. time_t write_timeout_usec_ = CPPHTTPLIB_SERVER_WRITE_TIMEOUT_USECOND;
  1967. time_t idle_interval_sec_ = CPPHTTPLIB_IDLE_INTERVAL_SECOND;
  1968. time_t idle_interval_usec_ = CPPHTTPLIB_IDLE_INTERVAL_USECOND;
  1969. size_t payload_max_length_ = CPPHTTPLIB_PAYLOAD_MAX_LENGTH;
  1970. bool static_file_compression_ = false;
  1971. size_t static_file_compression_min_length_ =
  1972. CPPHTTPLIB_STATIC_FILE_COMPRESSION_MIN_LENGTH;
  1973. size_t static_file_compression_max_length_ =
  1974. CPPHTTPLIB_STATIC_FILE_COMPRESSION_MAX_LENGTH;
  1975. time_t websocket_ping_interval_sec_ =
  1976. CPPHTTPLIB_WEBSOCKET_PING_INTERVAL_SECOND;
  1977. int websocket_max_missed_pongs_ = CPPHTTPLIB_WEBSOCKET_MAX_MISSED_PONGS;
  1978. private:
  1979. using Handlers =
  1980. std::vector<std::pair<std::unique_ptr<detail::MatcherBase>, Handler>>;
  1981. using HandlersForContentReader =
  1982. std::vector<std::pair<std::unique_ptr<detail::MatcherBase>,
  1983. HandlerWithContentReader>>;
  1984. // Both handler tables for one custom method live in a single entry, so that
  1985. // routing() needs only one map lookup per request to reach either of them.
  1986. struct CustomHandlerEntry {
  1987. Handlers handlers;
  1988. HandlersForContentReader handlers_for_content_reader;
  1989. };
  1990. using CustomHandlers = std::map<std::string, CustomHandlerEntry>;
  1991. static std::unique_ptr<detail::MatcherBase>
  1992. make_matcher(const std::string &pattern);
  1993. static const std::set<std::string> &builtin_methods();
  1994. CustomHandlerEntry *custom_entry_for_registration(const std::string &method);
  1995. const CustomHandlerEntry *find_custom_entry(const std::string &method) const;
  1996. template <typename H>
  1997. Server &add_handler(
  1998. std::vector<std::pair<std::unique_ptr<detail::MatcherBase>, H>> &handlers,
  1999. const std::string &pattern, H handler) {
  2000. handlers.emplace_back(make_matcher(pattern), std::move(handler));
  2001. return *this;
  2002. }
  2003. Server &set_error_handler_core(HandlerWithResponse handler, std::true_type);
  2004. Server &set_error_handler_core(Handler handler, std::false_type);
  2005. socket_t create_server_socket(const std::string &host, int port,
  2006. int socket_flags,
  2007. SocketOptions socket_options) const;
  2008. int bind_internal(const std::string &host, int port, int socket_flags);
  2009. bool listen_internal();
  2010. bool routing(Request &req, Response &res, Stream &strm);
  2011. bool handle_file_request(Request &req, Response &res);
  2012. bool check_if_not_modified(const Request &req, Response &res,
  2013. const std::string &etag, time_t mtime) const;
  2014. bool check_if_range(Request &req, const std::string &etag,
  2015. time_t mtime) const;
  2016. bool dispatch_request(Request &req, Response &res, const Handlers &handlers,
  2017. Stream &strm);
  2018. bool dispatch_request_for_content_reader(
  2019. Request &req, Response &res, ContentReader content_reader,
  2020. const HandlersForContentReader &handlers) const;
  2021. bool parse_request_line(const char *s, Request &req) const;
  2022. detail::EncodingType static_file_encoding(const Request &req,
  2023. const Response &res,
  2024. const std::string &content_type,
  2025. size_t length) const;
  2026. bool apply_static_file_compression(const Request &req, Response &res) const;
  2027. void apply_ranges(const Request &req, Response &res,
  2028. std::string &content_type, std::string &boundary) const;
  2029. bool write_response(Stream &strm, bool close_connection, Request &req,
  2030. Response &res);
  2031. bool write_response_with_content(Stream &strm, bool close_connection,
  2032. const Request &req, Response &res);
  2033. bool write_response_core(Stream &strm, bool close_connection,
  2034. const Request &req, Response &res,
  2035. bool need_apply_ranges);
  2036. bool write_content_with_provider(Stream &strm, const Request &req,
  2037. Response &res, const std::string &boundary,
  2038. const std::string &content_type);
  2039. bool read_content(Stream &strm, Request &req, Response &res);
  2040. bool read_content_with_content_receiver(Stream &strm, Request &req,
  2041. Response &res,
  2042. ContentReceiver receiver,
  2043. FormDataHeader multipart_header,
  2044. ContentReceiver multipart_receiver);
  2045. bool read_content_core(Stream &strm, Request &req, Response &res,
  2046. ContentReceiver receiver,
  2047. FormDataHeader multipart_header,
  2048. ContentReceiver multipart_receiver) const;
  2049. virtual bool process_and_close_socket(socket_t sock);
  2050. void output_log(const Request &req, const Response &res) const;
  2051. void output_pre_compression_log(const Request &req,
  2052. const Response &res) const;
  2053. void output_error_log(const Error &err, const Request *req) const;
  2054. std::atomic<bool> is_running_{false};
  2055. std::atomic<bool> is_decommissioned{false};
  2056. // Set when CustomRoute() refuses a registration. Written before listen(),
  2057. // read by is_valid() on the same thread, so it needs no synchronization.
  2058. bool has_invalid_registration_ = false;
  2059. struct MountPointEntry {
  2060. std::string mount_point;
  2061. std::string base_dir;
  2062. std::string resolved_base_dir;
  2063. Headers headers;
  2064. };
  2065. std::vector<MountPointEntry> base_dirs_;
  2066. std::map<std::string, std::string> file_extension_and_mimetype_map_;
  2067. std::string default_file_mimetype_ = "application/octet-stream";
  2068. Handler file_request_handler_;
  2069. Handlers get_handlers_;
  2070. Handlers post_handlers_;
  2071. HandlersForContentReader post_handlers_for_content_reader_;
  2072. Handlers put_handlers_;
  2073. HandlersForContentReader put_handlers_for_content_reader_;
  2074. Handlers patch_handlers_;
  2075. HandlersForContentReader patch_handlers_for_content_reader_;
  2076. Handlers delete_handlers_;
  2077. HandlersForContentReader delete_handlers_for_content_reader_;
  2078. Handlers options_handlers_;
  2079. CustomHandlers custom_handlers_;
  2080. struct WebSocketHandlerEntry {
  2081. std::unique_ptr<detail::MatcherBase> matcher;
  2082. WebSocketHandler handler;
  2083. SubProtocolSelector sub_protocol_selector;
  2084. };
  2085. using WebSocketHandlers = std::vector<WebSocketHandlerEntry>;
  2086. WebSocketHandlers websocket_handlers_;
  2087. HandlerWithResponse error_handler_;
  2088. ExceptionHandler exception_handler_;
  2089. HandlerWithResponse pre_routing_handler_;
  2090. Handler post_routing_handler_;
  2091. HandlerWithResponse pre_request_handler_;
  2092. Expect100ContinueHandler expect_100_continue_handler_;
  2093. StartHandler start_handler_;
  2094. mutable std::mutex logger_mutex_;
  2095. Logger logger_;
  2096. Logger pre_compression_logger_;
  2097. ErrorLogger error_logger_;
  2098. int address_family_ = AF_UNSPEC;
  2099. bool tcp_nodelay_ = CPPHTTPLIB_TCP_NODELAY;
  2100. bool ipv6_v6only_ = CPPHTTPLIB_IPV6_V6ONLY;
  2101. SocketOptions socket_options_ = default_socket_options;
  2102. Headers default_headers_;
  2103. std::function<ssize_t(Stream &, Headers &)> header_writer_ =
  2104. detail::write_headers;
  2105. };
  2106. class Result {
  2107. public:
  2108. Result() = default;
  2109. Result(std::unique_ptr<Response> &&res, Error err,
  2110. Headers &&request_headers = Headers{})
  2111. : res_(std::move(res)), err_(err),
  2112. request_headers_(std::move(request_headers)) {}
  2113. // Response
  2114. operator bool() const { return res_ != nullptr; }
  2115. bool operator==(std::nullptr_t) const { return res_ == nullptr; }
  2116. bool operator!=(std::nullptr_t) const { return res_ != nullptr; }
  2117. const Response &value() const { return *res_; }
  2118. Response &value() { return *res_; }
  2119. const Response &operator*() const { return *res_; }
  2120. Response &operator*() { return *res_; }
  2121. const Response *operator->() const { return res_.get(); }
  2122. Response *operator->() { return res_.get(); }
  2123. // Error
  2124. Error error() const { return err_; }
  2125. // Request Headers
  2126. bool has_request_header(const std::string &key) const;
  2127. std::string get_request_header_value(const std::string &key,
  2128. const char *def = "",
  2129. size_t id = 0) const;
  2130. size_t get_request_header_value_u64(const std::string &key, size_t def = 0,
  2131. size_t id = 0) const;
  2132. size_t get_request_header_value_count(const std::string &key) const;
  2133. private:
  2134. std::unique_ptr<Response> res_;
  2135. Error err_ = Error::Unknown;
  2136. Headers request_headers_;
  2137. #ifdef CPPHTTPLIB_SSL_ENABLED
  2138. public:
  2139. Result(std::unique_ptr<Response> &&res, Error err, Headers &&request_headers,
  2140. int ssl_error)
  2141. : res_(std::move(res)), err_(err),
  2142. request_headers_(std::move(request_headers)), ssl_error_(ssl_error) {}
  2143. Result(std::unique_ptr<Response> &&res, Error err, Headers &&request_headers,
  2144. int ssl_error, uint64_t ssl_backend_error)
  2145. : res_(std::move(res)), err_(err),
  2146. request_headers_(std::move(request_headers)), ssl_error_(ssl_error),
  2147. ssl_backend_error_(ssl_backend_error) {}
  2148. int ssl_error() const { return ssl_error_; }
  2149. uint64_t ssl_backend_error() const { return ssl_backend_error_; }
  2150. private:
  2151. int ssl_error_ = 0;
  2152. uint64_t ssl_backend_error_ = 0;
  2153. #endif
  2154. };
  2155. struct ClientConnection {
  2156. socket_t sock = INVALID_SOCKET;
  2157. bool is_open() const { return sock != INVALID_SOCKET; }
  2158. ClientConnection() = default;
  2159. ~ClientConnection();
  2160. ClientConnection(const ClientConnection &) = delete;
  2161. ClientConnection &operator=(const ClientConnection &) = delete;
  2162. ClientConnection(ClientConnection &&other) noexcept
  2163. : sock(other.sock)
  2164. #ifdef CPPHTTPLIB_SSL_ENABLED
  2165. ,
  2166. session(other.session)
  2167. #endif
  2168. {
  2169. other.sock = INVALID_SOCKET;
  2170. #ifdef CPPHTTPLIB_SSL_ENABLED
  2171. other.session = nullptr;
  2172. #endif
  2173. }
  2174. ClientConnection &operator=(ClientConnection &&other) noexcept {
  2175. if (this != &other) {
  2176. sock = other.sock;
  2177. other.sock = INVALID_SOCKET;
  2178. #ifdef CPPHTTPLIB_SSL_ENABLED
  2179. session = other.session;
  2180. other.session = nullptr;
  2181. #endif
  2182. }
  2183. return *this;
  2184. }
  2185. #ifdef CPPHTTPLIB_SSL_ENABLED
  2186. tls::session_t session = nullptr;
  2187. #endif
  2188. };
  2189. namespace detail {
  2190. struct ChunkedDecoder;
  2191. struct BodyReader {
  2192. Stream *stream = nullptr;
  2193. bool has_content_length = false;
  2194. size_t content_length = 0;
  2195. size_t payload_max_length = CPPHTTPLIB_PAYLOAD_MAX_LENGTH;
  2196. size_t bytes_read = 0;
  2197. bool chunked = false;
  2198. bool eof = false;
  2199. std::unique_ptr<ChunkedDecoder> chunked_decoder;
  2200. Error last_error = Error::Success;
  2201. ssize_t read(char *buf, size_t len);
  2202. bool has_error() const { return last_error != Error::Success; }
  2203. };
  2204. inline ssize_t read_body_content(Stream *stream, BodyReader &br, char *buf,
  2205. size_t len) {
  2206. (void)stream;
  2207. return br.read(buf, len);
  2208. }
  2209. class decompressor;
  2210. enum class NoProxyKind {
  2211. Wildcard, // "*"
  2212. HostnameSuffix, // "example.com" or ".example.com"
  2213. IPv4Cidr, // "10.0.0.0/8" (or single IP, treated as /32)
  2214. IPv6Cidr, // "fe80::/10" (or single IP, treated as /128)
  2215. };
  2216. // Unified 16-byte buffer holding either a v4 (first 4 bytes) or v6 address.
  2217. // Lets one CIDR matcher cover both families.
  2218. using IPBytes = std::array<uint8_t, 16>;
  2219. struct NoProxyEntry {
  2220. NoProxyKind kind = NoProxyKind::Wildcard;
  2221. std::string hostname_pattern; // lowercased, leading/trailing dot stripped
  2222. IPBytes net{};
  2223. int prefix_bits = 0;
  2224. };
  2225. struct NormalizedTarget {
  2226. std::string hostname; // lowercase; brackets and trailing dot removed
  2227. bool is_ipv4 = false;
  2228. bool is_ipv6 = false;
  2229. IPBytes ip{};
  2230. };
  2231. } // namespace detail
  2232. class ClientImpl {
  2233. public:
  2234. explicit ClientImpl(const std::string &host);
  2235. explicit ClientImpl(const std::string &host, int port);
  2236. explicit ClientImpl(const std::string &host, int port,
  2237. const std::string &client_cert_path,
  2238. const std::string &client_key_path);
  2239. virtual ~ClientImpl();
  2240. virtual bool is_valid() const;
  2241. struct StreamHandle {
  2242. std::unique_ptr<Response> response;
  2243. Error error = Error::Success;
  2244. StreamHandle() = default;
  2245. StreamHandle(const StreamHandle &) = delete;
  2246. StreamHandle &operator=(const StreamHandle &) = delete;
  2247. StreamHandle(StreamHandle &&) = default;
  2248. StreamHandle &operator=(StreamHandle &&) = default;
  2249. ~StreamHandle() = default;
  2250. bool is_valid() const {
  2251. return response != nullptr && error == Error::Success;
  2252. }
  2253. ssize_t read(char *buf, size_t len);
  2254. void parse_trailers_if_needed();
  2255. Error get_read_error() const { return body_reader_.last_error; }
  2256. bool has_read_error() const { return body_reader_.has_error(); }
  2257. bool trailers_parsed_ = false;
  2258. private:
  2259. friend class ClientImpl;
  2260. ssize_t read_with_decompression(char *buf, size_t len);
  2261. std::unique_ptr<ClientConnection> connection_;
  2262. std::unique_ptr<Stream> socket_stream_;
  2263. Stream *stream_ = nullptr;
  2264. detail::BodyReader body_reader_;
  2265. std::unique_ptr<detail::decompressor> decompressor_;
  2266. std::string decompress_buffer_;
  2267. size_t decompress_offset_ = 0;
  2268. size_t decompressed_bytes_read_ = 0;
  2269. };
  2270. // clang-format off
  2271. Result Get(const std::string &path, DownloadProgress progress = nullptr);
  2272. Result Get(const std::string &path, ContentReceiver content_receiver, DownloadProgress progress = nullptr);
  2273. Result Get(const std::string &path, ResponseHandler response_handler, ContentReceiver content_receiver, DownloadProgress progress = nullptr);
  2274. Result Get(const std::string &path, const Headers &headers, DownloadProgress progress = nullptr);
  2275. Result Get(const std::string &path, const Headers &headers, ContentReceiver content_receiver, DownloadProgress progress = nullptr);
  2276. Result Get(const std::string &path, const Headers &headers, ResponseHandler response_handler, ContentReceiver content_receiver, DownloadProgress progress = nullptr);
  2277. Result Get(const std::string &path, const Params &params, DownloadProgress progress = nullptr);
  2278. Result Get(const std::string &path, const Params &params, const Headers &headers, DownloadProgress progress = nullptr);
  2279. Result Get(const std::string &path, const Params &params, const Headers &headers, ContentReceiver content_receiver, DownloadProgress progress = nullptr);
  2280. Result Get(const std::string &path, const Params &params, const Headers &headers, ResponseHandler response_handler, ContentReceiver content_receiver, DownloadProgress progress = nullptr);
  2281. Result Head(const std::string &path);
  2282. Result Head(const std::string &path, const Headers &headers);
  2283. Result Post(const std::string &path);
  2284. Result Post(const std::string &path, const char *body, size_t content_length, const std::string &content_type, UploadProgress progress = nullptr);
  2285. Result Post(const std::string &path, const std::string &body, const std::string &content_type, UploadProgress progress = nullptr);
  2286. Result Post(const std::string &path, size_t content_length, ContentProvider content_provider, const std::string &content_type, UploadProgress progress = nullptr);
  2287. Result Post(const std::string &path, size_t content_length, ContentProvider content_provider, const std::string &content_type, ContentReceiver content_receiver, UploadProgress progress = nullptr);
  2288. Result Post(const std::string &path, ContentProviderWithoutLength content_provider, const std::string &content_type, UploadProgress progress = nullptr);
  2289. Result Post(const std::string &path, ContentProviderWithoutLength content_provider, const std::string &content_type, ContentReceiver content_receiver, UploadProgress progress = nullptr);
  2290. Result Post(const std::string &path, const Params &params);
  2291. Result Post(const std::string &path, const UploadFormDataItems &items, UploadProgress progress = nullptr);
  2292. Result Post(const std::string &path, const Headers &headers);
  2293. Result Post(const std::string &path, const Headers &headers, const char *body, size_t content_length, const std::string &content_type, UploadProgress progress = nullptr);
  2294. Result Post(const std::string &path, const Headers &headers, const std::string &body, const std::string &content_type, UploadProgress progress = nullptr);
  2295. Result Post(const std::string &path, const Headers &headers, size_t content_length, ContentProvider content_provider, const std::string &content_type, UploadProgress progress = nullptr);
  2296. 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);
  2297. Result Post(const std::string &path, const Headers &headers, ContentProviderWithoutLength content_provider, const std::string &content_type, UploadProgress progress = nullptr);
  2298. Result Post(const std::string &path, const Headers &headers, ContentProviderWithoutLength content_provider, const std::string &content_type, ContentReceiver content_receiver, DownloadProgress progress = nullptr);
  2299. Result Post(const std::string &path, const Headers &headers, const Params &params);
  2300. Result Post(const std::string &path, const Headers &headers, const UploadFormDataItems &items, UploadProgress progress = nullptr);
  2301. Result Post(const std::string &path, const Headers &headers, const UploadFormDataItems &items, const std::string &boundary, UploadProgress progress = nullptr);
  2302. Result Post(const std::string &path, const Headers &headers, const UploadFormDataItems &items, const FormDataProviderItems &provider_items, UploadProgress progress = nullptr);
  2303. Result Post(const std::string &path, const Headers &headers, const std::string &body, const std::string &content_type, ContentReceiver content_receiver, DownloadProgress progress = nullptr);
  2304. Result Put(const std::string &path);
  2305. Result Put(const std::string &path, const char *body, size_t content_length, const std::string &content_type, UploadProgress progress = nullptr);
  2306. Result Put(const std::string &path, const std::string &body, const std::string &content_type, UploadProgress progress = nullptr);
  2307. Result Put(const std::string &path, size_t content_length, ContentProvider content_provider, const std::string &content_type, UploadProgress progress = nullptr);
  2308. Result Put(const std::string &path, size_t content_length, ContentProvider content_provider, const std::string &content_type, ContentReceiver content_receiver, UploadProgress progress = nullptr);
  2309. Result Put(const std::string &path, ContentProviderWithoutLength content_provider, const std::string &content_type, UploadProgress progress = nullptr);
  2310. Result Put(const std::string &path, ContentProviderWithoutLength content_provider, const std::string &content_type, ContentReceiver content_receiver, UploadProgress progress = nullptr);
  2311. Result Put(const std::string &path, const Params &params);
  2312. Result Put(const std::string &path, const UploadFormDataItems &items, UploadProgress progress = nullptr);
  2313. Result Put(const std::string &path, const Headers &headers);
  2314. Result Put(const std::string &path, const Headers &headers, const char *body, size_t content_length, const std::string &content_type, UploadProgress progress = nullptr);
  2315. Result Put(const std::string &path, const Headers &headers, const std::string &body, const std::string &content_type, UploadProgress progress = nullptr);
  2316. Result Put(const std::string &path, const Headers &headers, size_t content_length, ContentProvider content_provider, const std::string &content_type, UploadProgress progress = nullptr);
  2317. 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);
  2318. Result Put(const std::string &path, const Headers &headers, ContentProviderWithoutLength content_provider, const std::string &content_type, UploadProgress progress = nullptr);
  2319. Result Put(const std::string &path, const Headers &headers, ContentProviderWithoutLength content_provider, const std::string &content_type, ContentReceiver content_receiver, UploadProgress progress = nullptr);
  2320. Result Put(const std::string &path, const Headers &headers, const Params &params);
  2321. Result Put(const std::string &path, const Headers &headers, const UploadFormDataItems &items, UploadProgress progress = nullptr);
  2322. Result Put(const std::string &path, const Headers &headers, const UploadFormDataItems &items, const std::string &boundary, UploadProgress progress = nullptr);
  2323. Result Put(const std::string &path, const Headers &headers, const UploadFormDataItems &items, const FormDataProviderItems &provider_items, UploadProgress progress = nullptr);
  2324. Result Put(const std::string &path, const Headers &headers, const std::string &body, const std::string &content_type, ContentReceiver content_receiver, DownloadProgress progress = nullptr);
  2325. Result Patch(const std::string &path);
  2326. Result Patch(const std::string &path, const char *body, size_t content_length, const std::string &content_type, UploadProgress progress = nullptr);
  2327. Result Patch(const std::string &path, const std::string &body, const std::string &content_type, UploadProgress progress = nullptr);
  2328. Result Patch(const std::string &path, size_t content_length, ContentProvider content_provider, const std::string &content_type, UploadProgress progress = nullptr);
  2329. Result Patch(const std::string &path, size_t content_length, ContentProvider content_provider, const std::string &content_type, ContentReceiver content_receiver, UploadProgress progress = nullptr);
  2330. Result Patch(const std::string &path, ContentProviderWithoutLength content_provider, const std::string &content_type, UploadProgress progress = nullptr);
  2331. Result Patch(const std::string &path, ContentProviderWithoutLength content_provider, const std::string &content_type, ContentReceiver content_receiver, UploadProgress progress = nullptr);
  2332. Result Patch(const std::string &path, const Params &params);
  2333. Result Patch(const std::string &path, const UploadFormDataItems &items, UploadProgress progress = nullptr);
  2334. Result Patch(const std::string &path, const Headers &headers, UploadProgress progress = nullptr);
  2335. Result Patch(const std::string &path, const Headers &headers, const char *body, size_t content_length, const std::string &content_type, UploadProgress progress = nullptr);
  2336. Result Patch(const std::string &path, const Headers &headers, const std::string &body, const std::string &content_type, UploadProgress progress = nullptr);
  2337. Result Patch(const std::string &path, const Headers &headers, size_t content_length, ContentProvider content_provider, const std::string &content_type, UploadProgress progress = nullptr);
  2338. 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);
  2339. Result Patch(const std::string &path, const Headers &headers, ContentProviderWithoutLength content_provider, const std::string &content_type, UploadProgress progress = nullptr);
  2340. Result Patch(const std::string &path, const Headers &headers, ContentProviderWithoutLength content_provider, const std::string &content_type, ContentReceiver content_receiver, UploadProgress progress = nullptr);
  2341. Result Patch(const std::string &path, const Headers &headers, const Params &params);
  2342. Result Patch(const std::string &path, const Headers &headers, const UploadFormDataItems &items, UploadProgress progress = nullptr);
  2343. Result Patch(const std::string &path, const Headers &headers, const UploadFormDataItems &items, const std::string &boundary, UploadProgress progress = nullptr);
  2344. Result Patch(const std::string &path, const Headers &headers, const UploadFormDataItems &items, const FormDataProviderItems &provider_items, UploadProgress progress = nullptr);
  2345. Result Patch(const std::string &path, const Headers &headers, const std::string &body, const std::string &content_type, ContentReceiver content_receiver, DownloadProgress progress = nullptr);
  2346. Result Delete(const std::string &path, DownloadProgress progress = nullptr);
  2347. Result Delete(const std::string &path, const char *body, size_t content_length, const std::string &content_type, DownloadProgress progress = nullptr);
  2348. Result Delete(const std::string &path, const std::string &body, const std::string &content_type, DownloadProgress progress = nullptr);
  2349. Result Delete(const std::string &path, const Params &params, DownloadProgress progress = nullptr);
  2350. Result Delete(const std::string &path, const Headers &headers, DownloadProgress progress = nullptr);
  2351. Result Delete(const std::string &path, const Headers &headers, const char *body, size_t content_length, const std::string &content_type, DownloadProgress progress = nullptr);
  2352. Result Delete(const std::string &path, const Headers &headers, const std::string &body, const std::string &content_type, DownloadProgress progress = nullptr);
  2353. Result Delete(const std::string &path, const Headers &headers, const Params &params, DownloadProgress progress = nullptr);
  2354. Result Options(const std::string &path);
  2355. Result Options(const std::string &path, const Headers &headers);
  2356. // clang-format on
  2357. // Streaming API: Open a stream for reading response body incrementally
  2358. // Socket ownership is transferred to StreamHandle for true streaming
  2359. // Supports all HTTP methods (GET, POST, PUT, PATCH, DELETE, etc.)
  2360. StreamHandle open_stream(const std::string &method, const std::string &path,
  2361. const Params &params = {},
  2362. const Headers &headers = {},
  2363. const std::string &body = {},
  2364. const std::string &content_type = {});
  2365. bool send(Request &req, Response &res, Error &error);
  2366. Result send(const Request &req);
  2367. void stop();
  2368. std::string host() const;
  2369. int port() const;
  2370. size_t is_socket_open() const;
  2371. socket_t socket() const;
  2372. void set_hostname_addr_map(std::map<std::string, std::string> addr_map);
  2373. void set_default_headers(Headers headers);
  2374. void
  2375. set_header_writer(std::function<ssize_t(Stream &, Headers &)> const &writer);
  2376. void set_address_family(int family);
  2377. void set_tcp_nodelay(bool on);
  2378. void set_ipv6_v6only(bool on);
  2379. void set_socket_options(SocketOptions socket_options);
  2380. void set_connection_timeout(time_t sec, time_t usec = 0);
  2381. template <class Rep, class Period>
  2382. void
  2383. set_connection_timeout(const std::chrono::duration<Rep, Period> &duration);
  2384. void set_read_timeout(time_t sec, time_t usec = 0);
  2385. template <class Rep, class Period>
  2386. void set_read_timeout(const std::chrono::duration<Rep, Period> &duration);
  2387. void set_write_timeout(time_t sec, time_t usec = 0);
  2388. template <class Rep, class Period>
  2389. void set_write_timeout(const std::chrono::duration<Rep, Period> &duration);
  2390. void set_max_timeout(time_t msec);
  2391. template <class Rep, class Period>
  2392. void set_max_timeout(const std::chrono::duration<Rep, Period> &duration);
  2393. void set_basic_auth(const std::string &username, const std::string &password);
  2394. void set_bearer_token_auth(const std::string &token);
  2395. void set_keep_alive(bool on);
  2396. void set_follow_location(bool on);
  2397. void set_path_encode(bool on);
  2398. void set_compress(bool on);
  2399. void set_decompress(bool on);
  2400. void set_payload_max_length(size_t length);
  2401. void set_interface(const std::string &intf);
  2402. void set_proxy(const std::string &host, int port);
  2403. void set_proxy_basic_auth(const std::string &username,
  2404. const std::string &password);
  2405. void set_proxy_bearer_token_auth(const std::string &token);
  2406. void set_no_proxy(const std::vector<std::string> &patterns);
  2407. void set_logger(Logger logger);
  2408. void set_error_logger(ErrorLogger error_logger);
  2409. protected:
  2410. struct Socket {
  2411. socket_t sock = INVALID_SOCKET;
  2412. // For Mbed TLS compatibility: start_time for request timeout tracking
  2413. std::chrono::time_point<std::chrono::steady_clock> start_time_;
  2414. bool is_open() const { return sock != INVALID_SOCKET; }
  2415. #ifdef CPPHTTPLIB_SSL_ENABLED
  2416. tls::session_t ssl = nullptr;
  2417. #endif
  2418. };
  2419. virtual bool create_and_connect_socket(Socket &socket, Error &error);
  2420. virtual bool ensure_socket_connection(Socket &socket, Error &error);
  2421. virtual bool setup_proxy_connection(
  2422. Socket &socket,
  2423. std::chrono::time_point<std::chrono::steady_clock> start_time,
  2424. Response &res, bool &success, Error &error);
  2425. bool is_proxy_enabled_for_host(const std::string &host) const;
  2426. // All of:
  2427. // shutdown_ssl
  2428. // shutdown_socket
  2429. // close_socket
  2430. // disconnect
  2431. // should ONLY be called when socket_mutex_ is locked, and only when
  2432. // no other thread is using the socket.
  2433. virtual void shutdown_ssl(Socket &socket, bool shutdown_gracefully);
  2434. void shutdown_socket(Socket &socket) const;
  2435. void close_socket(Socket &socket);
  2436. void disconnect(bool gracefully);
  2437. bool process_request(Stream &strm, Request &req, Response &res,
  2438. bool close_connection, Error &error);
  2439. bool write_content_with_provider(Stream &strm, const Request &req,
  2440. Error &error) const;
  2441. void copy_settings(const ClientImpl &rhs);
  2442. void output_log(const Request &req, const Response &res) const;
  2443. void output_error_log(const Error &err, const Request *req) const;
  2444. // Socket endpoint information
  2445. const std::string host_;
  2446. const int port_;
  2447. // Current open socket
  2448. Socket socket_;
  2449. mutable std::mutex socket_mutex_;
  2450. std::recursive_mutex request_mutex_;
  2451. // These are all protected under socket_mutex
  2452. size_t socket_requests_in_flight_ = 0;
  2453. std::thread::id socket_requests_are_from_thread_ = std::thread::id();
  2454. bool socket_should_be_closed_when_request_is_done_ = false;
  2455. // Hostname to connection target map. The value is an IP literal or another
  2456. // hostname; only the connection target changes, never the identity.
  2457. std::map<std::string, std::string> addr_map_;
  2458. // Default headers
  2459. Headers default_headers_;
  2460. // Header writer
  2461. std::function<ssize_t(Stream &, Headers &)> header_writer_ =
  2462. detail::write_headers;
  2463. // Settings
  2464. std::string client_cert_path_;
  2465. std::string client_key_path_;
  2466. time_t connection_timeout_sec_ = CPPHTTPLIB_CONNECTION_TIMEOUT_SECOND;
  2467. time_t connection_timeout_usec_ = CPPHTTPLIB_CONNECTION_TIMEOUT_USECOND;
  2468. time_t read_timeout_sec_ = CPPHTTPLIB_CLIENT_READ_TIMEOUT_SECOND;
  2469. time_t read_timeout_usec_ = CPPHTTPLIB_CLIENT_READ_TIMEOUT_USECOND;
  2470. time_t write_timeout_sec_ = CPPHTTPLIB_CLIENT_WRITE_TIMEOUT_SECOND;
  2471. time_t write_timeout_usec_ = CPPHTTPLIB_CLIENT_WRITE_TIMEOUT_USECOND;
  2472. time_t max_timeout_msec_ = CPPHTTPLIB_CLIENT_MAX_TIMEOUT_MSECOND;
  2473. std::string basic_auth_username_;
  2474. std::string basic_auth_password_;
  2475. std::string bearer_token_auth_token_;
  2476. bool keep_alive_ = false;
  2477. bool follow_location_ = false;
  2478. bool path_encode_ = true;
  2479. int address_family_ = AF_UNSPEC;
  2480. bool tcp_nodelay_ = CPPHTTPLIB_TCP_NODELAY;
  2481. bool ipv6_v6only_ = CPPHTTPLIB_IPV6_V6ONLY;
  2482. SocketOptions socket_options_ = nullptr;
  2483. bool compress_ = false;
  2484. bool decompress_ = true;
  2485. size_t payload_max_length_ = CPPHTTPLIB_PAYLOAD_MAX_LENGTH;
  2486. bool has_payload_max_length_ = false;
  2487. std::string interface_;
  2488. std::string proxy_host_;
  2489. int proxy_port_ = -1;
  2490. std::string proxy_basic_auth_username_;
  2491. std::string proxy_basic_auth_password_;
  2492. std::string proxy_bearer_token_auth_token_;
  2493. std::vector<detail::NoProxyEntry> no_proxy_entries_;
  2494. mutable detail::NormalizedTarget host_normalized_;
  2495. mutable bool host_normalized_valid_ = false;
  2496. mutable std::mutex logger_mutex_;
  2497. Logger logger_;
  2498. ErrorLogger error_logger_;
  2499. private:
  2500. bool send_(Request &req, Response &res, Error &error);
  2501. Result send_(Request &&req);
  2502. socket_t create_client_socket(Error &error) const;
  2503. bool read_response_line(Stream &strm, const Request &req, Response &res,
  2504. bool skip_100_continue = true) const;
  2505. bool write_request(Stream &strm, Request &req, bool close_connection,
  2506. Error &error, bool skip_body, bool &rejected_locally);
  2507. bool write_request_body(Stream &strm, Request &req, Error &error);
  2508. void prepare_default_headers(Request &r, bool for_stream,
  2509. const std::string &ct);
  2510. bool redirect(Request &req, Response &res, Error &error);
  2511. bool create_redirect_client(const std::string &scheme,
  2512. const std::string &host, int port, Request &req,
  2513. Response &res, const std::string &path,
  2514. const std::string &location, Error &error);
  2515. template <typename ClientType> void setup_redirect_client(ClientType &client);
  2516. bool handle_request(Stream &strm, Request &req, Response &res,
  2517. bool close_connection, Error &error);
  2518. std::unique_ptr<Response> send_with_content_provider_and_receiver(
  2519. Request &req, const char *body, size_t content_length,
  2520. ContentProvider content_provider,
  2521. ContentProviderWithoutLength content_provider_without_length,
  2522. const std::string &content_type, ContentReceiver content_receiver,
  2523. Error &error);
  2524. Result send_with_content_provider_and_receiver(
  2525. const std::string &method, const std::string &path,
  2526. const Headers &headers, const char *body, size_t content_length,
  2527. ContentProvider content_provider,
  2528. ContentProviderWithoutLength content_provider_without_length,
  2529. const std::string &content_type, ContentReceiver content_receiver,
  2530. UploadProgress progress);
  2531. ContentProviderWithoutLength get_multipart_content_provider(
  2532. const std::string &boundary, const UploadFormDataItems &items,
  2533. const FormDataProviderItems &provider_items) const;
  2534. virtual bool
  2535. process_socket(const Socket &socket,
  2536. std::chrono::time_point<std::chrono::steady_clock> start_time,
  2537. std::function<bool(Stream &strm)> callback);
  2538. virtual bool is_ssl() const;
  2539. void transfer_socket_ownership_to_handle(StreamHandle &handle);
  2540. #ifdef CPPHTTPLIB_SSL_ENABLED
  2541. public:
  2542. void set_digest_auth(const std::string &username,
  2543. const std::string &password);
  2544. void set_proxy_digest_auth(const std::string &username,
  2545. const std::string &password);
  2546. void set_ca_cert_path(const std::string &ca_cert_file_path,
  2547. const std::string &ca_cert_dir_path = std::string());
  2548. void enable_server_certificate_verification(bool enabled);
  2549. void enable_server_hostname_verification(bool enabled);
  2550. void enable_system_ca(bool enabled);
  2551. protected:
  2552. std::string digest_auth_username_;
  2553. std::string digest_auth_password_;
  2554. std::string proxy_digest_auth_username_;
  2555. std::string proxy_digest_auth_password_;
  2556. std::string ca_cert_file_path_;
  2557. std::string ca_cert_dir_path_;
  2558. bool server_certificate_verification_ = true;
  2559. bool server_hostname_verification_ = true;
  2560. SystemCAMode system_ca_mode_ = SystemCAMode::Auto;
  2561. std::string ca_cert_pem_; // Store CA cert PEM for redirect transfer
  2562. int last_ssl_error_ = 0;
  2563. uint64_t last_backend_error_ = 0;
  2564. #endif
  2565. };
  2566. class Client {
  2567. public:
  2568. // Universal interface
  2569. explicit Client(const std::string &scheme_host_port);
  2570. explicit Client(const std::string &scheme_host_port,
  2571. const std::string &client_cert_path,
  2572. const std::string &client_key_path);
  2573. // HTTP only interface
  2574. explicit Client(const std::string &host, int port);
  2575. explicit Client(const std::string &host, int port,
  2576. const std::string &client_cert_path,
  2577. const std::string &client_key_path);
  2578. Client(Client &&) = default;
  2579. Client &operator=(Client &&) = default;
  2580. ~Client();
  2581. bool is_valid() const;
  2582. // clang-format off
  2583. Result Get(const std::string &path, DownloadProgress progress = nullptr);
  2584. Result Get(const std::string &path, ContentReceiver content_receiver, DownloadProgress progress = nullptr);
  2585. Result Get(const std::string &path, ResponseHandler response_handler, ContentReceiver content_receiver, DownloadProgress progress = nullptr);
  2586. Result Get(const std::string &path, const Headers &headers, DownloadProgress progress = nullptr);
  2587. Result Get(const std::string &path, const Headers &headers, ContentReceiver content_receiver, DownloadProgress progress = nullptr);
  2588. Result Get(const std::string &path, const Headers &headers, ResponseHandler response_handler, ContentReceiver content_receiver, DownloadProgress progress = nullptr);
  2589. Result Get(const std::string &path, const Params &params, DownloadProgress progress = nullptr);
  2590. Result Get(const std::string &path, const Params &params, const Headers &headers, DownloadProgress progress = nullptr);
  2591. Result Get(const std::string &path, const Params &params, const Headers &headers, ContentReceiver content_receiver, DownloadProgress progress = nullptr);
  2592. Result Get(const std::string &path, const Params &params, const Headers &headers, ResponseHandler response_handler, ContentReceiver content_receiver, DownloadProgress progress = nullptr);
  2593. Result Head(const std::string &path);
  2594. Result Head(const std::string &path, const Headers &headers);
  2595. Result Post(const std::string &path);
  2596. Result Post(const std::string &path, const char *body, size_t content_length, const std::string &content_type, UploadProgress progress = nullptr);
  2597. Result Post(const std::string &path, const std::string &body, const std::string &content_type, UploadProgress progress = nullptr);
  2598. Result Post(const std::string &path, size_t content_length, ContentProvider content_provider, const std::string &content_type, UploadProgress progress = nullptr);
  2599. Result Post(const std::string &path, size_t content_length, ContentProvider content_provider, const std::string &content_type, ContentReceiver content_receiver, UploadProgress progress = nullptr);
  2600. Result Post(const std::string &path, ContentProviderWithoutLength content_provider, const std::string &content_type, UploadProgress progress = nullptr);
  2601. Result Post(const std::string &path, ContentProviderWithoutLength content_provider, const std::string &content_type, ContentReceiver content_receiver, UploadProgress progress = nullptr);
  2602. Result Post(const std::string &path, const Params &params);
  2603. Result Post(const std::string &path, const UploadFormDataItems &items, UploadProgress progress = nullptr);
  2604. Result Post(const std::string &path, const Headers &headers);
  2605. Result Post(const std::string &path, const Headers &headers, const char *body, size_t content_length, const std::string &content_type, UploadProgress progress = nullptr);
  2606. Result Post(const std::string &path, const Headers &headers, const std::string &body, const std::string &content_type, UploadProgress progress = nullptr);
  2607. Result Post(const std::string &path, const Headers &headers, size_t content_length, ContentProvider content_provider, const std::string &content_type, UploadProgress progress = nullptr);
  2608. 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);
  2609. Result Post(const std::string &path, const Headers &headers, ContentProviderWithoutLength content_provider, const std::string &content_type, UploadProgress progress = nullptr);
  2610. Result Post(const std::string &path, const Headers &headers, ContentProviderWithoutLength content_provider, const std::string &content_type, ContentReceiver content_receiver, DownloadProgress progress = nullptr);
  2611. Result Post(const std::string &path, const Headers &headers, const Params &params);
  2612. Result Post(const std::string &path, const Headers &headers, const UploadFormDataItems &items, UploadProgress progress = nullptr);
  2613. Result Post(const std::string &path, const Headers &headers, const UploadFormDataItems &items, const std::string &boundary, UploadProgress progress = nullptr);
  2614. Result Post(const std::string &path, const Headers &headers, const UploadFormDataItems &items, const FormDataProviderItems &provider_items, UploadProgress progress = nullptr);
  2615. Result Post(const std::string &path, const Headers &headers, const std::string &body, const std::string &content_type, ContentReceiver content_receiver, DownloadProgress progress = nullptr);
  2616. Result Put(const std::string &path);
  2617. Result Put(const std::string &path, const char *body, size_t content_length, const std::string &content_type, UploadProgress progress = nullptr);
  2618. Result Put(const std::string &path, const std::string &body, const std::string &content_type, UploadProgress progress = nullptr);
  2619. Result Put(const std::string &path, size_t content_length, ContentProvider content_provider, const std::string &content_type, UploadProgress progress = nullptr);
  2620. Result Put(const std::string &path, size_t content_length, ContentProvider content_provider, const std::string &content_type, ContentReceiver content_receiver, UploadProgress progress = nullptr);
  2621. Result Put(const std::string &path, ContentProviderWithoutLength content_provider, const std::string &content_type, UploadProgress progress = nullptr);
  2622. Result Put(const std::string &path, ContentProviderWithoutLength content_provider, const std::string &content_type, ContentReceiver content_receiver, UploadProgress progress = nullptr);
  2623. Result Put(const std::string &path, const Params &params);
  2624. Result Put(const std::string &path, const UploadFormDataItems &items, UploadProgress progress = nullptr);
  2625. Result Put(const std::string &path, const Headers &headers);
  2626. Result Put(const std::string &path, const Headers &headers, const char *body, size_t content_length, const std::string &content_type, UploadProgress progress = nullptr);
  2627. Result Put(const std::string &path, const Headers &headers, const std::string &body, const std::string &content_type, UploadProgress progress = nullptr);
  2628. Result Put(const std::string &path, const Headers &headers, size_t content_length, ContentProvider content_provider, const std::string &content_type, UploadProgress progress = nullptr);
  2629. 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);
  2630. Result Put(const std::string &path, const Headers &headers, ContentProviderWithoutLength content_provider, const std::string &content_type, UploadProgress progress = nullptr);
  2631. Result Put(const std::string &path, const Headers &headers, ContentProviderWithoutLength content_provider, const std::string &content_type, ContentReceiver content_receiver, UploadProgress progress = nullptr);
  2632. Result Put(const std::string &path, const Headers &headers, const Params &params);
  2633. Result Put(const std::string &path, const Headers &headers, const UploadFormDataItems &items, UploadProgress progress = nullptr);
  2634. Result Put(const std::string &path, const Headers &headers, const UploadFormDataItems &items, const std::string &boundary, UploadProgress progress = nullptr);
  2635. Result Put(const std::string &path, const Headers &headers, const UploadFormDataItems &items, const FormDataProviderItems &provider_items, UploadProgress progress = nullptr);
  2636. Result Put(const std::string &path, const Headers &headers, const std::string &body, const std::string &content_type, ContentReceiver content_receiver, DownloadProgress progress = nullptr);
  2637. Result Patch(const std::string &path);
  2638. Result Patch(const std::string &path, const char *body, size_t content_length, const std::string &content_type, UploadProgress progress = nullptr);
  2639. Result Patch(const std::string &path, const std::string &body, const std::string &content_type, UploadProgress progress = nullptr);
  2640. Result Patch(const std::string &path, size_t content_length, ContentProvider content_provider, const std::string &content_type, UploadProgress progress = nullptr);
  2641. Result Patch(const std::string &path, size_t content_length, ContentProvider content_provider, const std::string &content_type, ContentReceiver content_receiver, UploadProgress progress = nullptr);
  2642. Result Patch(const std::string &path, ContentProviderWithoutLength content_provider, const std::string &content_type, UploadProgress progress = nullptr);
  2643. Result Patch(const std::string &path, ContentProviderWithoutLength content_provider, const std::string &content_type, ContentReceiver content_receiver, UploadProgress progress = nullptr);
  2644. Result Patch(const std::string &path, const Params &params);
  2645. Result Patch(const std::string &path, const UploadFormDataItems &items, UploadProgress progress = nullptr);
  2646. Result Patch(const std::string &path, const Headers &headers);
  2647. Result Patch(const std::string &path, const Headers &headers, const char *body, size_t content_length, const std::string &content_type, UploadProgress progress = nullptr);
  2648. Result Patch(const std::string &path, const Headers &headers, const std::string &body, const std::string &content_type, UploadProgress progress = nullptr);
  2649. Result Patch(const std::string &path, const Headers &headers, size_t content_length, ContentProvider content_provider, const std::string &content_type, UploadProgress progress = nullptr);
  2650. 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);
  2651. Result Patch(const std::string &path, const Headers &headers, ContentProviderWithoutLength content_provider, const std::string &content_type, UploadProgress progress = nullptr);
  2652. Result Patch(const std::string &path, const Headers &headers, ContentProviderWithoutLength content_provider, const std::string &content_type, ContentReceiver content_receiver, UploadProgress progress = nullptr);
  2653. Result Patch(const std::string &path, const Headers &headers, const Params &params);
  2654. Result Patch(const std::string &path, const Headers &headers, const UploadFormDataItems &items, UploadProgress progress = nullptr);
  2655. Result Patch(const std::string &path, const Headers &headers, const UploadFormDataItems &items, const std::string &boundary, UploadProgress progress = nullptr);
  2656. Result Patch(const std::string &path, const Headers &headers, const UploadFormDataItems &items, const FormDataProviderItems &provider_items, UploadProgress progress = nullptr);
  2657. Result Patch(const std::string &path, const Headers &headers, const std::string &body, const std::string &content_type, ContentReceiver content_receiver, DownloadProgress progress = nullptr);
  2658. Result Delete(const std::string &path, DownloadProgress progress = nullptr);
  2659. Result Delete(const std::string &path, const char *body, size_t content_length, const std::string &content_type, DownloadProgress progress = nullptr);
  2660. Result Delete(const std::string &path, const std::string &body, const std::string &content_type, DownloadProgress progress = nullptr);
  2661. Result Delete(const std::string &path, const Params &params, DownloadProgress progress = nullptr);
  2662. Result Delete(const std::string &path, const Headers &headers, DownloadProgress progress = nullptr);
  2663. Result Delete(const std::string &path, const Headers &headers, const char *body, size_t content_length, const std::string &content_type, DownloadProgress progress = nullptr);
  2664. Result Delete(const std::string &path, const Headers &headers, const std::string &body, const std::string &content_type, DownloadProgress progress = nullptr);
  2665. Result Delete(const std::string &path, const Headers &headers, const Params &params, DownloadProgress progress = nullptr);
  2666. Result Options(const std::string &path);
  2667. Result Options(const std::string &path, const Headers &headers);
  2668. // clang-format on
  2669. // Streaming API: Open a stream for reading response body incrementally
  2670. // Socket ownership is transferred to StreamHandle for true streaming
  2671. // Supports all HTTP methods (GET, POST, PUT, PATCH, DELETE, etc.)
  2672. ClientImpl::StreamHandle open_stream(const std::string &method,
  2673. const std::string &path,
  2674. const Params &params = {},
  2675. const Headers &headers = {},
  2676. const std::string &body = {},
  2677. const std::string &content_type = {});
  2678. bool send(Request &req, Response &res, Error &error);
  2679. Result send(const Request &req);
  2680. void stop();
  2681. std::string host() const;
  2682. int port() const;
  2683. size_t is_socket_open() const;
  2684. socket_t socket() const;
  2685. void set_hostname_addr_map(std::map<std::string, std::string> addr_map);
  2686. void set_default_headers(Headers headers);
  2687. void
  2688. set_header_writer(std::function<ssize_t(Stream &, Headers &)> const &writer);
  2689. void set_address_family(int family);
  2690. void set_tcp_nodelay(bool on);
  2691. void set_socket_options(SocketOptions socket_options);
  2692. void set_connection_timeout(time_t sec, time_t usec = 0);
  2693. template <class Rep, class Period>
  2694. void
  2695. set_connection_timeout(const std::chrono::duration<Rep, Period> &duration);
  2696. void set_read_timeout(time_t sec, time_t usec = 0);
  2697. template <class Rep, class Period>
  2698. void set_read_timeout(const std::chrono::duration<Rep, Period> &duration);
  2699. void set_write_timeout(time_t sec, time_t usec = 0);
  2700. template <class Rep, class Period>
  2701. void set_write_timeout(const std::chrono::duration<Rep, Period> &duration);
  2702. void set_max_timeout(time_t msec);
  2703. template <class Rep, class Period>
  2704. void set_max_timeout(const std::chrono::duration<Rep, Period> &duration);
  2705. void set_basic_auth(const std::string &username, const std::string &password);
  2706. void set_bearer_token_auth(const std::string &token);
  2707. void set_keep_alive(bool on);
  2708. void set_follow_location(bool on);
  2709. void set_path_encode(bool on);
  2710. void set_compress(bool on);
  2711. void set_decompress(bool on);
  2712. void set_payload_max_length(size_t length);
  2713. void set_interface(const std::string &intf);
  2714. void set_proxy(const std::string &host, int port);
  2715. void set_proxy_basic_auth(const std::string &username,
  2716. const std::string &password);
  2717. void set_proxy_bearer_token_auth(const std::string &token);
  2718. void set_no_proxy(const std::vector<std::string> &patterns);
  2719. void set_logger(Logger logger);
  2720. void set_error_logger(ErrorLogger error_logger);
  2721. private:
  2722. std::unique_ptr<ClientImpl> cli_;
  2723. #ifdef CPPHTTPLIB_SSL_ENABLED
  2724. public:
  2725. void set_digest_auth(const std::string &username,
  2726. const std::string &password);
  2727. void set_proxy_digest_auth(const std::string &username,
  2728. const std::string &password);
  2729. void enable_server_certificate_verification(bool enabled);
  2730. void enable_server_hostname_verification(bool enabled);
  2731. void enable_system_ca(bool enabled);
  2732. void set_ca_cert_path(const std::string &ca_cert_file_path,
  2733. const std::string &ca_cert_dir_path = std::string());
  2734. void set_ca_cert_store(tls::ca_store_t ca_cert_store);
  2735. void load_ca_cert_store(const char *ca_cert, std::size_t size);
  2736. void set_server_certificate_verifier(tls::VerifyCallback verifier);
  2737. void set_session_verifier(
  2738. std::function<SSLVerifierResponse(tls::session_t)> verifier);
  2739. tls::ctx_t tls_context() const;
  2740. #ifdef CPPHTTPLIB_WINDOWS_AUTOMATIC_ROOT_CERTIFICATES_UPDATE
  2741. void enable_windows_certificate_verification(bool enabled);
  2742. #endif
  2743. private:
  2744. bool is_ssl_ = false;
  2745. #endif
  2746. };
  2747. #ifdef CPPHTTPLIB_SSL_ENABLED
  2748. class SSLServer : public Server {
  2749. public:
  2750. SSLServer(const char *cert_path, const char *private_key_path,
  2751. const char *client_ca_cert_file_path = nullptr,
  2752. const char *client_ca_cert_dir_path = nullptr,
  2753. const char *private_key_password = nullptr);
  2754. struct PemMemory {
  2755. const char *cert_pem;
  2756. size_t cert_pem_len;
  2757. const char *key_pem;
  2758. size_t key_pem_len;
  2759. const char *client_ca_pem;
  2760. size_t client_ca_pem_len;
  2761. const char *private_key_password;
  2762. };
  2763. explicit SSLServer(const PemMemory &pem);
  2764. // The callback receives the ctx_t handle which can be cast to the
  2765. // appropriate backend type (SSL_CTX* for OpenSSL,
  2766. // tls::impl::MbedTlsContext* for Mbed TLS)
  2767. explicit SSLServer(const tls::ContextSetupCallback &setup_callback);
  2768. ~SSLServer() override;
  2769. bool is_valid() const override;
  2770. bool update_certs_pem(const char *cert_pem, const char *key_pem,
  2771. const char *client_ca_pem = nullptr,
  2772. const char *password = nullptr);
  2773. tls::ctx_t tls_context() const { return ctx_; }
  2774. int ssl_last_error() const { return last_ssl_error_; }
  2775. private:
  2776. bool process_and_close_socket(socket_t sock) override;
  2777. tls::ctx_t ctx_ = nullptr;
  2778. std::mutex ctx_mutex_;
  2779. int last_ssl_error_ = 0;
  2780. };
  2781. class SSLClient final : public ClientImpl {
  2782. public:
  2783. explicit SSLClient(const std::string &host);
  2784. explicit SSLClient(const std::string &host, int port);
  2785. explicit SSLClient(const std::string &host, int port,
  2786. const std::string &client_cert_path,
  2787. const std::string &client_key_path,
  2788. const std::string &private_key_password = std::string());
  2789. struct PemMemory {
  2790. const char *cert_pem;
  2791. size_t cert_pem_len;
  2792. const char *key_pem;
  2793. size_t key_pem_len;
  2794. const char *private_key_password;
  2795. };
  2796. explicit SSLClient(const std::string &host, int port, const PemMemory &pem);
  2797. ~SSLClient() override;
  2798. bool is_valid() const override;
  2799. void set_ca_cert_store(tls::ca_store_t ca_cert_store);
  2800. void load_ca_cert_store(const char *ca_cert, std::size_t size);
  2801. void set_server_certificate_verifier(tls::VerifyCallback verifier);
  2802. // Post-handshake session verifier (backend-independent)
  2803. void set_session_verifier(
  2804. std::function<SSLVerifierResponse(tls::session_t)> verifier);
  2805. tls::ctx_t tls_context() const { return ctx_; }
  2806. #ifdef CPPHTTPLIB_WINDOWS_AUTOMATIC_ROOT_CERTIFICATES_UPDATE
  2807. void enable_windows_certificate_verification(bool enabled);
  2808. #endif
  2809. private:
  2810. bool create_and_connect_socket(Socket &socket, Error &error) override;
  2811. bool ensure_socket_connection(Socket &socket, Error &error) override;
  2812. void shutdown_ssl(Socket &socket, bool shutdown_gracefully) override;
  2813. void shutdown_ssl_impl(Socket &socket, bool shutdown_gracefully);
  2814. bool
  2815. process_socket(const Socket &socket,
  2816. std::chrono::time_point<std::chrono::steady_clock> start_time,
  2817. std::function<bool(Stream &strm)> callback) override;
  2818. bool is_ssl() const override;
  2819. bool setup_proxy_connection(
  2820. Socket &socket,
  2821. std::chrono::time_point<std::chrono::steady_clock> start_time,
  2822. Response &res, bool &success, Error &error) override;
  2823. bool connect_with_proxy(
  2824. Socket &sock,
  2825. std::chrono::time_point<std::chrono::steady_clock> start_time,
  2826. Response &res, bool &success, Error &error);
  2827. bool initialize_ssl(Socket &socket, Error &error);
  2828. void init_ctx();
  2829. void reset_ctx_on_error();
  2830. bool load_certs();
  2831. tls::ctx_t ctx_ = nullptr;
  2832. std::mutex ctx_mutex_;
  2833. std::once_flag initialize_cert_;
  2834. // Tracks whether a custom CA store was applied via set_ca_cert_store(),
  2835. // since the store handle itself is owned by ctx_ and leaves no other trace.
  2836. // Used to keep custom CA configuration exclusive with system CA loading.
  2837. bool ca_cert_store_set_ = false;
  2838. std::function<SSLVerifierResponse(tls::session_t)> session_verifier_;
  2839. #ifdef CPPHTTPLIB_WINDOWS_AUTOMATIC_ROOT_CERTIFICATES_UPDATE
  2840. bool enable_windows_cert_verification_ = true;
  2841. // Like ca_cert_store_set_, tracks what ctx_ cannot report back: whether
  2842. // set_server_certificate_verifier() installed a verifier.
  2843. bool server_certificate_verifier_set_ = false;
  2844. #endif
  2845. friend class ClientImpl;
  2846. };
  2847. #endif // CPPHTTPLIB_SSL_ENABLED
  2848. namespace detail {
  2849. template <typename T, typename U>
  2850. inline void duration_to_sec_and_usec(const T &duration, U callback) {
  2851. auto sec = std::chrono::duration_cast<std::chrono::seconds>(duration).count();
  2852. auto usec = std::chrono::duration_cast<std::chrono::microseconds>(
  2853. duration - std::chrono::seconds(sec))
  2854. .count();
  2855. callback(static_cast<time_t>(sec), static_cast<time_t>(usec));
  2856. }
  2857. template <size_t N> inline constexpr size_t str_len(const char (&)[N]) {
  2858. return N - 1;
  2859. }
  2860. inline bool is_numeric(const std::string &str) {
  2861. return !str.empty() && std::all_of(str.cbegin(), str.cend(), is_ascii_digit);
  2862. }
  2863. inline size_t get_header_value_u64(const Headers &headers,
  2864. const std::string &key, size_t def,
  2865. size_t id, bool &is_invalid_value) {
  2866. is_invalid_value = false;
  2867. auto rng = headers.equal_range(key);
  2868. auto it = rng.first;
  2869. std::advance(it, static_cast<ssize_t>(id));
  2870. if (it != rng.second) {
  2871. if (is_numeric(it->second)) {
  2872. // Parse at size_t width so an out-of-range Content-Length is reported
  2873. // rather than silently saturated/truncated (a value above 2^32 would
  2874. // otherwise wrap to a small framing length on 32-bit builds). Flag it
  2875. // and return SIZE_MAX so the existing oversized-value guards reject it.
  2876. size_t val = 0;
  2877. const auto &s = it->second;
  2878. auto r = from_chars(s.data(), s.data() + s.size(), val);
  2879. if (r.ec == std::errc::result_out_of_range) {
  2880. is_invalid_value = true;
  2881. return (std::numeric_limits<size_t>::max)();
  2882. }
  2883. return val;
  2884. } else {
  2885. is_invalid_value = true;
  2886. }
  2887. }
  2888. return def;
  2889. }
  2890. inline size_t get_header_value_u64(const Headers &headers,
  2891. const std::string &key, size_t def,
  2892. size_t id) {
  2893. auto dummy = false;
  2894. return get_header_value_u64(headers, key, def, id, dummy);
  2895. }
  2896. } // namespace detail
  2897. template <class Rep, class Period>
  2898. inline Server &
  2899. Server::set_read_timeout(const std::chrono::duration<Rep, Period> &duration) {
  2900. detail::duration_to_sec_and_usec(
  2901. duration, [&](time_t sec, time_t usec) { set_read_timeout(sec, usec); });
  2902. return *this;
  2903. }
  2904. template <class Rep, class Period>
  2905. inline Server &
  2906. Server::set_write_timeout(const std::chrono::duration<Rep, Period> &duration) {
  2907. detail::duration_to_sec_and_usec(
  2908. duration, [&](time_t sec, time_t usec) { set_write_timeout(sec, usec); });
  2909. return *this;
  2910. }
  2911. template <class Rep, class Period>
  2912. inline Server &
  2913. Server::set_idle_interval(const std::chrono::duration<Rep, Period> &duration) {
  2914. detail::duration_to_sec_and_usec(
  2915. duration, [&](time_t sec, time_t usec) { set_idle_interval(sec, usec); });
  2916. return *this;
  2917. }
  2918. template <class Rep, class Period>
  2919. inline void ClientImpl::set_connection_timeout(
  2920. const std::chrono::duration<Rep, Period> &duration) {
  2921. detail::duration_to_sec_and_usec(duration, [&](time_t sec, time_t usec) {
  2922. set_connection_timeout(sec, usec);
  2923. });
  2924. }
  2925. template <class Rep, class Period>
  2926. inline void ClientImpl::set_read_timeout(
  2927. const std::chrono::duration<Rep, Period> &duration) {
  2928. detail::duration_to_sec_and_usec(
  2929. duration, [&](time_t sec, time_t usec) { set_read_timeout(sec, usec); });
  2930. }
  2931. template <class Rep, class Period>
  2932. inline void ClientImpl::set_write_timeout(
  2933. const std::chrono::duration<Rep, Period> &duration) {
  2934. detail::duration_to_sec_and_usec(
  2935. duration, [&](time_t sec, time_t usec) { set_write_timeout(sec, usec); });
  2936. }
  2937. template <class Rep, class Period>
  2938. inline void ClientImpl::set_max_timeout(
  2939. const std::chrono::duration<Rep, Period> &duration) {
  2940. auto msec =
  2941. std::chrono::duration_cast<std::chrono::milliseconds>(duration).count();
  2942. set_max_timeout(msec);
  2943. }
  2944. template <class Rep, class Period>
  2945. inline void Client::set_connection_timeout(
  2946. const std::chrono::duration<Rep, Period> &duration) {
  2947. cli_->set_connection_timeout(duration);
  2948. }
  2949. template <class Rep, class Period>
  2950. inline void
  2951. Client::set_read_timeout(const std::chrono::duration<Rep, Period> &duration) {
  2952. cli_->set_read_timeout(duration);
  2953. }
  2954. template <class Rep, class Period>
  2955. inline void
  2956. Client::set_write_timeout(const std::chrono::duration<Rep, Period> &duration) {
  2957. cli_->set_write_timeout(duration);
  2958. }
  2959. inline void Client::set_max_timeout(time_t msec) {
  2960. cli_->set_max_timeout(msec);
  2961. }
  2962. template <class Rep, class Period>
  2963. inline void
  2964. Client::set_max_timeout(const std::chrono::duration<Rep, Period> &duration) {
  2965. cli_->set_max_timeout(duration);
  2966. }
  2967. /*
  2968. * Forward declarations and types that will be part of the .h file if split into
  2969. * .h + .cc.
  2970. */
  2971. std::string hosted_at(const std::string &hostname);
  2972. void hosted_at(const std::string &hostname, std::vector<std::string> &addrs);
  2973. // JavaScript-style URL encoding/decoding functions
  2974. std::string encode_uri_component(const std::string &value);
  2975. std::string encode_uri(const std::string &value);
  2976. std::string decode_uri_component(const std::string &value);
  2977. std::string decode_uri(const std::string &value);
  2978. // RFC 3986 compliant URL component encoding/decoding functions
  2979. std::string encode_path_component(const std::string &component);
  2980. std::string decode_path_component(const std::string &component);
  2981. std::string encode_query_component(const std::string &component,
  2982. bool space_as_plus = true);
  2983. std::string decode_query_component(const std::string &component,
  2984. bool plus_as_space = true);
  2985. std::string sanitize_filename(const std::string &filename);
  2986. std::string append_query_params(const std::string &path, const Params &params);
  2987. std::pair<std::string, std::string> make_range_header(const Ranges &ranges);
  2988. std::pair<std::string, std::string>
  2989. make_basic_authentication_header(const std::string &username,
  2990. const std::string &password,
  2991. bool is_proxy = false);
  2992. namespace detail {
  2993. #if defined(_WIN32)
  2994. inline std::wstring u8string_to_wstring(const char *s) {
  2995. if (!s) { return std::wstring(); }
  2996. auto len = static_cast<int>(strlen(s));
  2997. if (!len) { return std::wstring(); }
  2998. auto wlen = ::MultiByteToWideChar(CP_UTF8, 0, s, len, nullptr, 0);
  2999. if (!wlen) { return std::wstring(); }
  3000. std::wstring ws;
  3001. ws.resize(wlen);
  3002. wlen = ::MultiByteToWideChar(
  3003. CP_UTF8, 0, s, len,
  3004. const_cast<LPWSTR>(reinterpret_cast<LPCWSTR>(ws.data())), wlen);
  3005. if (wlen != static_cast<int>(ws.size())) { ws.clear(); }
  3006. return ws;
  3007. }
  3008. #endif
  3009. struct FileStat {
  3010. FileStat(const std::string &path);
  3011. bool is_file() const;
  3012. bool is_dir() const;
  3013. time_t mtime() const;
  3014. size_t size() const;
  3015. private:
  3016. #if defined(_WIN32)
  3017. struct _stat st_;
  3018. #else
  3019. struct stat st_;
  3020. #endif
  3021. int ret_ = -1;
  3022. };
  3023. std::string make_host_and_port_string(const std::string &host, int port,
  3024. bool is_ssl);
  3025. template <typename T>
  3026. bool check_and_write_headers(Stream &strm, Headers &headers, T header_writer,
  3027. Error &error);
  3028. std::string trim_copy(const std::string &s);
  3029. void divide(
  3030. const char *data, std::size_t size, char d,
  3031. std::function<void(const char *, std::size_t, const char *, std::size_t)>
  3032. fn);
  3033. void divide(
  3034. const std::string &str, char d,
  3035. std::function<void(const char *, std::size_t, const char *, std::size_t)>
  3036. fn);
  3037. void split(const char *b, const char *e, char d,
  3038. std::function<void(const char *, const char *)> fn);
  3039. void split(const char *b, const char *e, char d, size_t m,
  3040. std::function<void(const char *, const char *)> fn);
  3041. bool split_find(const char *b, const char *e, char d,
  3042. std::function<bool(const char *, const char *)> fn);
  3043. bool has_header_token(const Headers &headers, const std::string &key,
  3044. const std::string &token);
  3045. std::string websocket_accept_key(const std::string &client_key);
  3046. bool is_websocket_upgrade(const Request &req);
  3047. bool process_client_socket(
  3048. socket_t sock, time_t read_timeout_sec, time_t read_timeout_usec,
  3049. time_t write_timeout_sec, time_t write_timeout_usec,
  3050. time_t max_timeout_msec,
  3051. std::chrono::time_point<std::chrono::steady_clock> start_time,
  3052. std::function<bool(Stream &)> callback);
  3053. socket_t create_client_socket(const std::string &host, const std::string &ip,
  3054. int port, int address_family, bool tcp_nodelay,
  3055. bool ipv6_v6only, SocketOptions socket_options,
  3056. time_t connection_timeout_sec,
  3057. time_t connection_timeout_usec,
  3058. time_t read_timeout_sec, time_t read_timeout_usec,
  3059. time_t write_timeout_sec,
  3060. time_t write_timeout_usec,
  3061. const std::string &intf, Error &error);
  3062. const char *get_header_value(const Headers &headers, const std::string &key,
  3063. const char *def, size_t id);
  3064. std::string get_combined_header_value(const Headers &headers,
  3065. const std::string &key);
  3066. std::string params_to_query_str(const Params &params);
  3067. void parse_query_text(const char *data, std::size_t size, Params &params);
  3068. void parse_query_text(const std::string &s, Params &params);
  3069. bool parse_multipart_boundary(const std::string &content_type,
  3070. std::string &boundary);
  3071. bool parse_range_header(const std::string &s, Ranges &ranges);
  3072. bool parse_accept_header(const std::string &s,
  3073. std::vector<std::string> &content_types);
  3074. void parse_disposition_params(const std::string &s, Params &params);
  3075. ssize_t send_socket(socket_t sock, const void *ptr, size_t size, int flags);
  3076. ssize_t read_socket(socket_t sock, void *ptr, size_t size, int flags);
  3077. EncodingType encoding_type(const Request &req, const std::string &content_type);
  3078. EncodingType encoding_type(const Request &req, const Response &res,
  3079. const std::string &content_type);
  3080. EncodingType encoding_type(const Request &req, const Response &res);
  3081. class BufferStream final : public Stream {
  3082. public:
  3083. BufferStream() = default;
  3084. ~BufferStream() override = default;
  3085. bool is_readable() const override;
  3086. bool wait_readable() const override;
  3087. bool wait_writable() const override;
  3088. ssize_t read(char *ptr, size_t size) override;
  3089. ssize_t write(const char *ptr, size_t size) override;
  3090. void get_remote_ip_and_port(std::string &ip, int &port) const override;
  3091. void get_local_ip_and_port(std::string &ip, int &port) const override;
  3092. socket_t socket() const override;
  3093. time_t duration() const override;
  3094. const std::string &get_buffer() const;
  3095. private:
  3096. std::string buffer;
  3097. size_t position = 0;
  3098. };
  3099. class compressor {
  3100. public:
  3101. virtual ~compressor() = default;
  3102. typedef std::function<bool(const char *data, size_t data_len)> Callback;
  3103. virtual bool compress(const char *data, size_t data_length, bool last,
  3104. Callback callback) = 0;
  3105. };
  3106. class decompressor {
  3107. public:
  3108. virtual ~decompressor() = default;
  3109. virtual bool is_valid() const = 0;
  3110. typedef std::function<bool(const char *data, size_t data_len)> Callback;
  3111. virtual bool decompress(const char *data, size_t data_length,
  3112. Callback callback) = 0;
  3113. };
  3114. class nocompressor final : public compressor {
  3115. public:
  3116. ~nocompressor() override = default;
  3117. bool compress(const char *data, size_t data_length, bool /*last*/,
  3118. Callback callback) override;
  3119. };
  3120. #ifdef CPPHTTPLIB_ZLIB_SUPPORT
  3121. class gzip_compressor final : public compressor {
  3122. public:
  3123. gzip_compressor();
  3124. ~gzip_compressor() override;
  3125. bool compress(const char *data, size_t data_length, bool last,
  3126. Callback callback) override;
  3127. private:
  3128. bool is_valid_ = false;
  3129. z_stream strm_;
  3130. };
  3131. class gzip_decompressor final : public decompressor {
  3132. public:
  3133. gzip_decompressor();
  3134. ~gzip_decompressor() override;
  3135. bool is_valid() const override;
  3136. bool decompress(const char *data, size_t data_length,
  3137. Callback callback) override;
  3138. private:
  3139. bool is_valid_ = false;
  3140. z_stream strm_;
  3141. };
  3142. #endif
  3143. #ifdef CPPHTTPLIB_BROTLI_SUPPORT
  3144. class brotli_compressor final : public compressor {
  3145. public:
  3146. brotli_compressor();
  3147. ~brotli_compressor();
  3148. bool compress(const char *data, size_t data_length, bool last,
  3149. Callback callback) override;
  3150. private:
  3151. BrotliEncoderState *state_ = nullptr;
  3152. };
  3153. class brotli_decompressor final : public decompressor {
  3154. public:
  3155. brotli_decompressor();
  3156. ~brotli_decompressor();
  3157. bool is_valid() const override;
  3158. bool decompress(const char *data, size_t data_length,
  3159. Callback callback) override;
  3160. private:
  3161. BrotliDecoderResult decoder_r;
  3162. BrotliDecoderState *decoder_s = nullptr;
  3163. };
  3164. #endif
  3165. #ifdef CPPHTTPLIB_ZSTD_SUPPORT
  3166. class zstd_compressor : public compressor {
  3167. public:
  3168. zstd_compressor();
  3169. ~zstd_compressor();
  3170. bool compress(const char *data, size_t data_length, bool last,
  3171. Callback callback) override;
  3172. private:
  3173. ZSTD_CCtx *ctx_ = nullptr;
  3174. };
  3175. class zstd_decompressor : public decompressor {
  3176. public:
  3177. zstd_decompressor();
  3178. ~zstd_decompressor();
  3179. bool is_valid() const override;
  3180. bool decompress(const char *data, size_t data_length,
  3181. Callback callback) override;
  3182. private:
  3183. ZSTD_DCtx *ctx_ = nullptr;
  3184. };
  3185. #endif
  3186. // NOTE: until the read size reaches `fixed_buffer_size`, use `fixed_buffer`
  3187. // to store data. The call can set memory on stack for performance.
  3188. class stream_line_reader {
  3189. public:
  3190. stream_line_reader(Stream &strm, char *fixed_buffer,
  3191. size_t fixed_buffer_size);
  3192. const char *ptr() const;
  3193. size_t size() const;
  3194. bool end_with_crlf() const;
  3195. bool getline();
  3196. private:
  3197. void append(char c);
  3198. void append(const char *data, size_t size);
  3199. Stream &strm_;
  3200. char *fixed_buffer_;
  3201. const size_t fixed_buffer_size_;
  3202. size_t fixed_buffer_used_size_ = 0;
  3203. std::string growable_buffer_;
  3204. };
  3205. bool parse_trailers(stream_line_reader &line_reader, Headers &dest,
  3206. const Headers &src_headers);
  3207. struct ChunkedDecoder {
  3208. Stream &strm;
  3209. size_t chunk_remaining = 0;
  3210. bool finished = false;
  3211. char line_buf[64];
  3212. size_t last_chunk_total = 0;
  3213. size_t last_chunk_offset = 0;
  3214. explicit ChunkedDecoder(Stream &s);
  3215. ssize_t read_payload(char *buf, size_t len, size_t &out_chunk_offset,
  3216. size_t &out_chunk_total);
  3217. bool parse_trailers_into(Headers &dest, const Headers &src_headers);
  3218. };
  3219. class mmap {
  3220. public:
  3221. mmap(const char *path);
  3222. ~mmap();
  3223. bool open(const char *path);
  3224. void close();
  3225. bool is_open() const;
  3226. size_t size() const;
  3227. const char *data() const;
  3228. private:
  3229. #if defined(_WIN32)
  3230. HANDLE hFile_ = NULL;
  3231. HANDLE hMapping_ = NULL;
  3232. #else
  3233. int fd_ = -1;
  3234. #endif
  3235. size_t size_ = 0;
  3236. void *addr_ = nullptr;
  3237. bool is_open_empty_file = false;
  3238. };
  3239. // NOTE: https://www.rfc-editor.org/rfc/rfc9110#section-5
  3240. namespace fields {
  3241. bool is_token_char(char c);
  3242. bool is_token(const std::string &s);
  3243. bool is_field_name(const std::string &s);
  3244. bool is_vchar(char c);
  3245. bool is_obs_text(char c);
  3246. bool is_field_vchar(char c);
  3247. bool is_field_content(const std::string &s);
  3248. bool is_field_value(const std::string &s);
  3249. bool is_field_valid(const std::string &name, const std::string &value);
  3250. bool is_request_target(const std::string &s);
  3251. } // namespace fields
  3252. } // namespace detail
  3253. /*
  3254. * TLS Abstraction Layer Declarations
  3255. */
  3256. #ifdef CPPHTTPLIB_SSL_ENABLED
  3257. // TLS abstraction layer - backend-specific type declarations
  3258. #ifdef CPPHTTPLIB_MBEDTLS_SUPPORT
  3259. namespace tls {
  3260. namespace impl {
  3261. // Mbed TLS context wrapper (holds config, entropy, DRBG, CA chain, own
  3262. // cert/key). This struct is accessible via tls::impl for use in SSL context
  3263. // setup callbacks (cast ctx_t to tls::impl::MbedTlsContext*).
  3264. struct MbedTlsContext {
  3265. mbedtls_ssl_config conf;
  3266. #ifndef CPPHTTPLIB_MBEDTLS_V4
  3267. // Mbed TLS 4.x uses PSA Crypto's internal RNG; no explicit entropy/DRBG.
  3268. mbedtls_entropy_context entropy;
  3269. mbedtls_ctr_drbg_context ctr_drbg;
  3270. #endif
  3271. mbedtls_x509_crt ca_chain;
  3272. mbedtls_x509_crt own_cert;
  3273. mbedtls_pk_context own_key;
  3274. bool is_server = false;
  3275. bool verify_client = false;
  3276. bool has_verify_callback = false;
  3277. MbedTlsContext();
  3278. ~MbedTlsContext();
  3279. MbedTlsContext(const MbedTlsContext &) = delete;
  3280. MbedTlsContext &operator=(const MbedTlsContext &) = delete;
  3281. };
  3282. } // namespace impl
  3283. } // namespace tls
  3284. #endif
  3285. #ifdef CPPHTTPLIB_WOLFSSL_SUPPORT
  3286. namespace tls {
  3287. namespace impl {
  3288. // wolfSSL context wrapper (holds WOLFSSL_CTX and related state).
  3289. // This struct is accessible via tls::impl for use in SSL context
  3290. // setup callbacks (cast ctx_t to tls::impl::WolfSSLContext*).
  3291. struct WolfSSLContext {
  3292. WOLFSSL_CTX *ctx = nullptr;
  3293. bool is_server = false;
  3294. bool verify_client = false;
  3295. bool has_verify_callback = false;
  3296. std::string ca_pem_data_; // accumulated PEM for get_ca_names/get_ca_certs
  3297. WolfSSLContext();
  3298. ~WolfSSLContext();
  3299. WolfSSLContext(const WolfSSLContext &) = delete;
  3300. WolfSSLContext &operator=(const WolfSSLContext &) = delete;
  3301. };
  3302. // CA store for wolfSSL: holds raw PEM bytes to allow reloading into any ctx
  3303. struct WolfSSLCAStore {
  3304. std::string pem_data;
  3305. };
  3306. } // namespace impl
  3307. } // namespace tls
  3308. #endif
  3309. #endif // CPPHTTPLIB_SSL_ENABLED
  3310. namespace stream {
  3311. class Result {
  3312. public:
  3313. Result();
  3314. explicit Result(ClientImpl::StreamHandle &&handle, size_t chunk_size = 8192);
  3315. Result(Result &&other) noexcept;
  3316. Result &operator=(Result &&other) noexcept;
  3317. Result(const Result &) = delete;
  3318. Result &operator=(const Result &) = delete;
  3319. // Response info
  3320. bool is_valid() const;
  3321. explicit operator bool() const;
  3322. int status() const;
  3323. const Headers &headers() const;
  3324. std::string get_header_value(const std::string &key,
  3325. const char *def = "") const;
  3326. bool has_header(const std::string &key) const;
  3327. Error error() const;
  3328. Error read_error() const;
  3329. bool has_read_error() const;
  3330. // Stream reading
  3331. bool next();
  3332. const char *data() const;
  3333. size_t size() const;
  3334. std::string read_all();
  3335. private:
  3336. ClientImpl::StreamHandle handle_;
  3337. std::string buffer_;
  3338. size_t current_size_ = 0;
  3339. size_t chunk_size_;
  3340. bool finished_ = false;
  3341. };
  3342. // GET
  3343. template <typename ClientType>
  3344. inline Result Get(ClientType &cli, const std::string &path,
  3345. size_t chunk_size = 8192) {
  3346. return Result{cli.open_stream("GET", path), chunk_size};
  3347. }
  3348. template <typename ClientType>
  3349. inline Result Get(ClientType &cli, const std::string &path,
  3350. const Headers &headers, size_t chunk_size = 8192) {
  3351. return Result{cli.open_stream("GET", path, {}, headers), chunk_size};
  3352. }
  3353. template <typename ClientType>
  3354. inline Result Get(ClientType &cli, const std::string &path,
  3355. const Params &params, size_t chunk_size = 8192) {
  3356. return Result{cli.open_stream("GET", path, params), chunk_size};
  3357. }
  3358. template <typename ClientType>
  3359. inline Result Get(ClientType &cli, const std::string &path,
  3360. const Params &params, const Headers &headers,
  3361. size_t chunk_size = 8192) {
  3362. return Result{cli.open_stream("GET", path, params, headers), chunk_size};
  3363. }
  3364. // POST
  3365. template <typename ClientType>
  3366. inline Result Post(ClientType &cli, const std::string &path,
  3367. const std::string &body, const std::string &content_type,
  3368. size_t chunk_size = 8192) {
  3369. return Result{cli.open_stream("POST", path, {}, {}, body, content_type),
  3370. chunk_size};
  3371. }
  3372. template <typename ClientType>
  3373. inline Result Post(ClientType &cli, const std::string &path,
  3374. const Headers &headers, const std::string &body,
  3375. const std::string &content_type, size_t chunk_size = 8192) {
  3376. return Result{cli.open_stream("POST", path, {}, headers, body, content_type),
  3377. chunk_size};
  3378. }
  3379. template <typename ClientType>
  3380. inline Result Post(ClientType &cli, const std::string &path,
  3381. const Params &params, const std::string &body,
  3382. const std::string &content_type, size_t chunk_size = 8192) {
  3383. return Result{cli.open_stream("POST", path, params, {}, body, content_type),
  3384. chunk_size};
  3385. }
  3386. template <typename ClientType>
  3387. inline Result Post(ClientType &cli, const std::string &path,
  3388. const Params &params, const Headers &headers,
  3389. const std::string &body, const std::string &content_type,
  3390. size_t chunk_size = 8192) {
  3391. return Result{
  3392. cli.open_stream("POST", path, params, headers, body, content_type),
  3393. chunk_size};
  3394. }
  3395. // PUT
  3396. template <typename ClientType>
  3397. inline Result Put(ClientType &cli, const std::string &path,
  3398. const std::string &body, const std::string &content_type,
  3399. size_t chunk_size = 8192) {
  3400. return Result{cli.open_stream("PUT", path, {}, {}, body, content_type),
  3401. chunk_size};
  3402. }
  3403. template <typename ClientType>
  3404. inline Result Put(ClientType &cli, const std::string &path,
  3405. const Headers &headers, const std::string &body,
  3406. const std::string &content_type, size_t chunk_size = 8192) {
  3407. return Result{cli.open_stream("PUT", path, {}, headers, body, content_type),
  3408. chunk_size};
  3409. }
  3410. template <typename ClientType>
  3411. inline Result Put(ClientType &cli, const std::string &path,
  3412. const Params &params, const std::string &body,
  3413. const std::string &content_type, size_t chunk_size = 8192) {
  3414. return Result{cli.open_stream("PUT", path, params, {}, body, content_type),
  3415. chunk_size};
  3416. }
  3417. template <typename ClientType>
  3418. inline Result Put(ClientType &cli, const std::string &path,
  3419. const Params &params, const Headers &headers,
  3420. const std::string &body, const std::string &content_type,
  3421. size_t chunk_size = 8192) {
  3422. return Result{
  3423. cli.open_stream("PUT", path, params, headers, body, content_type),
  3424. chunk_size};
  3425. }
  3426. // PATCH
  3427. template <typename ClientType>
  3428. inline Result Patch(ClientType &cli, const std::string &path,
  3429. const std::string &body, const std::string &content_type,
  3430. size_t chunk_size = 8192) {
  3431. return Result{cli.open_stream("PATCH", path, {}, {}, body, content_type),
  3432. chunk_size};
  3433. }
  3434. template <typename ClientType>
  3435. inline Result Patch(ClientType &cli, const std::string &path,
  3436. const Headers &headers, const std::string &body,
  3437. const std::string &content_type, size_t chunk_size = 8192) {
  3438. return Result{cli.open_stream("PATCH", path, {}, headers, body, content_type),
  3439. chunk_size};
  3440. }
  3441. template <typename ClientType>
  3442. inline Result Patch(ClientType &cli, const std::string &path,
  3443. const Params &params, const std::string &body,
  3444. const std::string &content_type, size_t chunk_size = 8192) {
  3445. return Result{cli.open_stream("PATCH", path, params, {}, body, content_type),
  3446. chunk_size};
  3447. }
  3448. template <typename ClientType>
  3449. inline Result Patch(ClientType &cli, const std::string &path,
  3450. const Params &params, const Headers &headers,
  3451. const std::string &body, const std::string &content_type,
  3452. size_t chunk_size = 8192) {
  3453. return Result{
  3454. cli.open_stream("PATCH", path, params, headers, body, content_type),
  3455. chunk_size};
  3456. }
  3457. // DELETE
  3458. template <typename ClientType>
  3459. inline Result Delete(ClientType &cli, const std::string &path,
  3460. size_t chunk_size = 8192) {
  3461. return Result{cli.open_stream("DELETE", path), chunk_size};
  3462. }
  3463. template <typename ClientType>
  3464. inline Result Delete(ClientType &cli, const std::string &path,
  3465. const Headers &headers, size_t chunk_size = 8192) {
  3466. return Result{cli.open_stream("DELETE", path, {}, headers), chunk_size};
  3467. }
  3468. template <typename ClientType>
  3469. inline Result Delete(ClientType &cli, const std::string &path,
  3470. const std::string &body, const std::string &content_type,
  3471. size_t chunk_size = 8192) {
  3472. return Result{cli.open_stream("DELETE", path, {}, {}, body, content_type),
  3473. chunk_size};
  3474. }
  3475. template <typename ClientType>
  3476. inline Result Delete(ClientType &cli, const std::string &path,
  3477. const Headers &headers, const std::string &body,
  3478. const std::string &content_type,
  3479. size_t chunk_size = 8192) {
  3480. return Result{
  3481. cli.open_stream("DELETE", path, {}, headers, body, content_type),
  3482. chunk_size};
  3483. }
  3484. template <typename ClientType>
  3485. inline Result Delete(ClientType &cli, const std::string &path,
  3486. const Params &params, size_t chunk_size = 8192) {
  3487. return Result{cli.open_stream("DELETE", path, params), chunk_size};
  3488. }
  3489. template <typename ClientType>
  3490. inline Result Delete(ClientType &cli, const std::string &path,
  3491. const Params &params, const Headers &headers,
  3492. size_t chunk_size = 8192) {
  3493. return Result{cli.open_stream("DELETE", path, params, headers), chunk_size};
  3494. }
  3495. template <typename ClientType>
  3496. inline Result Delete(ClientType &cli, const std::string &path,
  3497. const Params &params, const std::string &body,
  3498. const std::string &content_type,
  3499. size_t chunk_size = 8192) {
  3500. return Result{cli.open_stream("DELETE", path, params, {}, body, content_type),
  3501. chunk_size};
  3502. }
  3503. template <typename ClientType>
  3504. inline Result Delete(ClientType &cli, const std::string &path,
  3505. const Params &params, const Headers &headers,
  3506. const std::string &body, const std::string &content_type,
  3507. size_t chunk_size = 8192) {
  3508. return Result{
  3509. cli.open_stream("DELETE", path, params, headers, body, content_type),
  3510. chunk_size};
  3511. }
  3512. // HEAD
  3513. template <typename ClientType>
  3514. inline Result Head(ClientType &cli, const std::string &path,
  3515. size_t chunk_size = 8192) {
  3516. return Result{cli.open_stream("HEAD", path), chunk_size};
  3517. }
  3518. template <typename ClientType>
  3519. inline Result Head(ClientType &cli, const std::string &path,
  3520. const Headers &headers, size_t chunk_size = 8192) {
  3521. return Result{cli.open_stream("HEAD", path, {}, headers), chunk_size};
  3522. }
  3523. template <typename ClientType>
  3524. inline Result Head(ClientType &cli, const std::string &path,
  3525. const Params &params, size_t chunk_size = 8192) {
  3526. return Result{cli.open_stream("HEAD", path, params), chunk_size};
  3527. }
  3528. template <typename ClientType>
  3529. inline Result Head(ClientType &cli, const std::string &path,
  3530. const Params &params, const Headers &headers,
  3531. size_t chunk_size = 8192) {
  3532. return Result{cli.open_stream("HEAD", path, params, headers), chunk_size};
  3533. }
  3534. // OPTIONS
  3535. template <typename ClientType>
  3536. inline Result Options(ClientType &cli, const std::string &path,
  3537. size_t chunk_size = 8192) {
  3538. return Result{cli.open_stream("OPTIONS", path), chunk_size};
  3539. }
  3540. template <typename ClientType>
  3541. inline Result Options(ClientType &cli, const std::string &path,
  3542. const Headers &headers, size_t chunk_size = 8192) {
  3543. return Result{cli.open_stream("OPTIONS", path, {}, headers), chunk_size};
  3544. }
  3545. template <typename ClientType>
  3546. inline Result Options(ClientType &cli, const std::string &path,
  3547. const Params &params, size_t chunk_size = 8192) {
  3548. return Result{cli.open_stream("OPTIONS", path, params), chunk_size};
  3549. }
  3550. template <typename ClientType>
  3551. inline Result Options(ClientType &cli, const std::string &path,
  3552. const Params &params, const Headers &headers,
  3553. size_t chunk_size = 8192) {
  3554. return Result{cli.open_stream("OPTIONS", path, params, headers), chunk_size};
  3555. }
  3556. } // namespace stream
  3557. namespace sse {
  3558. struct SSEMessage {
  3559. std::string event; // Event type (default: "message")
  3560. std::string data; // Event payload
  3561. std::string id; // Event ID for Last-Event-ID header
  3562. SSEMessage();
  3563. void clear();
  3564. };
  3565. class SSEClient {
  3566. public:
  3567. using MessageHandler = std::function<void(const SSEMessage &)>;
  3568. using ErrorHandler = std::function<void(Error)>;
  3569. using OpenHandler = std::function<void()>;
  3570. SSEClient(Client &client, const std::string &path);
  3571. SSEClient(Client &client, const std::string &path, const Headers &headers);
  3572. ~SSEClient();
  3573. SSEClient(const SSEClient &) = delete;
  3574. SSEClient &operator=(const SSEClient &) = delete;
  3575. // Event handlers
  3576. SSEClient &on_message(MessageHandler handler);
  3577. SSEClient &on_event(const std::string &type, MessageHandler handler);
  3578. SSEClient &on_open(OpenHandler handler);
  3579. SSEClient &on_error(ErrorHandler handler);
  3580. SSEClient &set_reconnect_interval(int ms);
  3581. SSEClient &set_max_reconnect_attempts(int n);
  3582. // Update headers (thread-safe)
  3583. SSEClient &set_headers(const Headers &headers);
  3584. // State accessors
  3585. bool is_connected() const;
  3586. const std::string &last_event_id() const;
  3587. // Blocking start - runs event loop with auto-reconnect
  3588. void start();
  3589. // Non-blocking start - runs in background thread
  3590. void start_async();
  3591. // Stop the client (thread-safe)
  3592. void stop();
  3593. private:
  3594. bool parse_sse_line(const std::string &line, SSEMessage &msg, int &retry_ms);
  3595. void run_event_loop();
  3596. void dispatch_event(const SSEMessage &msg);
  3597. bool should_reconnect(int count) const;
  3598. void wait_for_reconnect();
  3599. // Client and path
  3600. Client &client_;
  3601. std::string path_;
  3602. Headers headers_;
  3603. mutable std::mutex headers_mutex_;
  3604. // Callbacks
  3605. MessageHandler on_message_;
  3606. std::map<std::string, MessageHandler> event_handlers_;
  3607. OpenHandler on_open_;
  3608. ErrorHandler on_error_;
  3609. // Configuration
  3610. int reconnect_interval_ms_ = 3000;
  3611. int max_reconnect_attempts_ = 0; // 0 = unlimited
  3612. // State
  3613. std::atomic<bool> running_{false};
  3614. std::atomic<bool> connected_{false};
  3615. std::string last_event_id_;
  3616. // Async support
  3617. std::thread async_thread_;
  3618. };
  3619. } // namespace sse
  3620. namespace ws {
  3621. enum class Opcode : uint8_t {
  3622. Continuation = 0x0,
  3623. Text = 0x1,
  3624. Binary = 0x2,
  3625. Close = 0x8,
  3626. Ping = 0x9,
  3627. Pong = 0xA,
  3628. };
  3629. enum class CloseStatus : uint16_t {
  3630. Normal = 1000,
  3631. GoingAway = 1001,
  3632. ProtocolError = 1002,
  3633. UnsupportedData = 1003,
  3634. NoStatus = 1005,
  3635. Abnormal = 1006,
  3636. InvalidPayload = 1007,
  3637. PolicyViolation = 1008,
  3638. MessageTooBig = 1009,
  3639. MandatoryExtension = 1010,
  3640. InternalError = 1011,
  3641. };
  3642. // Timeout is returned only when a read timeout was set and it elapsed before
  3643. // any byte of a frame arrived: nothing was consumed and the connection is
  3644. // still open, so the caller can send on it and read again. `msg` is left
  3645. // untouched, so a `while (ws.read(msg))` loop must not treat it as a message.
  3646. enum ReadResult : int { Fail = 0, Text = 1, Binary = 2, Timeout = 3 };
  3647. // Result of WebSocketClient::connect(). Truthy only when the WebSocket
  3648. // upgrade handshake fully succeeded. On failure error() identifies the
  3649. // failing layer; status()/headers() expose the server's upgrade response
  3650. // when one was received (status() is -1 otherwise).
  3651. class Result {
  3652. public:
  3653. Result() = default;
  3654. Result(Error err, int status, Headers &&headers)
  3655. : err_(err), status_(status), headers_(std::move(headers)) {}
  3656. explicit operator bool() const { return err_ == Error::Success; }
  3657. Error error() const { return err_; }
  3658. // Upgrade response info
  3659. int status() const { return status_; }
  3660. const Headers &headers() const { return headers_; }
  3661. std::string get_header_value(const std::string &key,
  3662. const char *def = "") const {
  3663. return detail::get_header_value(headers_, key, def, 0);
  3664. }
  3665. bool has_header(const std::string &key) const {
  3666. return headers_.find(key) != headers_.end();
  3667. }
  3668. #ifdef CPPHTTPLIB_SSL_ENABLED
  3669. Result(Error err, int status, Headers &&headers, int ssl_error,
  3670. uint64_t ssl_backend_error)
  3671. : err_(err), status_(status), headers_(std::move(headers)),
  3672. ssl_error_(ssl_error), ssl_backend_error_(ssl_backend_error) {}
  3673. int ssl_error() const { return ssl_error_; }
  3674. uint64_t ssl_backend_error() const { return ssl_backend_error_; }
  3675. #endif
  3676. private:
  3677. Error err_ = Error::Unknown; // a default-constructed Result is falsy
  3678. int status_ = -1;
  3679. Headers headers_;
  3680. #ifdef CPPHTTPLIB_SSL_ENABLED
  3681. int ssl_error_ = 0;
  3682. uint64_t ssl_backend_error_ = 0;
  3683. #endif
  3684. };
  3685. class WebSocket {
  3686. public:
  3687. WebSocket(const WebSocket &) = delete;
  3688. WebSocket &operator=(const WebSocket &) = delete;
  3689. ~WebSocket();
  3690. ReadResult read(std::string &msg);
  3691. bool send(const std::string &data);
  3692. bool send(const char *data, size_t len);
  3693. void close(CloseStatus status = CloseStatus::Normal,
  3694. const std::string &reason = "");
  3695. const Request &request() const;
  3696. bool is_open() const;
  3697. // Bound how long read() waits before returning Timeout. 0 waits forever.
  3698. // A server handler owns its connection's timeout this way; a client sets it
  3699. // through WebSocketClient. Safe to call while another thread is in read().
  3700. //
  3701. // Only a timeout set here is reported as Timeout. The compile-time default
  3702. // (CPPHTTPLIB_WEBSOCKET_SERVER_READ_TIMEOUT_SECOND) is a backstop rather
  3703. // than a request for control, so when it elapses read() returns Fail and
  3704. // closes the connection, and `while (ws.read(msg))` ends as it always has.
  3705. void set_read_timeout(time_t sec, time_t usec = 0);
  3706. template <class Rep, class Period>
  3707. void set_read_timeout(const std::chrono::duration<Rep, Period> &duration);
  3708. private:
  3709. friend class httplib::Server;
  3710. friend class WebSocketClient;
  3711. WebSocket(
  3712. Stream &strm, const Request &req, bool is_server,
  3713. time_t ping_interval_sec = CPPHTTPLIB_WEBSOCKET_PING_INTERVAL_SECOND,
  3714. int max_missed_pongs = CPPHTTPLIB_WEBSOCKET_MAX_MISSED_PONGS)
  3715. : strm_(strm), req_(req), is_server_(is_server),
  3716. ping_interval_sec_(ping_interval_sec),
  3717. max_missed_pongs_(max_missed_pongs) {
  3718. start_heartbeat();
  3719. }
  3720. WebSocket(
  3721. std::unique_ptr<Stream> &&owned_strm, const Request &req, bool is_server,
  3722. time_t ping_interval_sec = CPPHTTPLIB_WEBSOCKET_PING_INTERVAL_SECOND,
  3723. int max_missed_pongs = CPPHTTPLIB_WEBSOCKET_MAX_MISSED_PONGS)
  3724. : strm_(*owned_strm), owned_strm_(std::move(owned_strm)), req_(req),
  3725. is_server_(is_server), ping_interval_sec_(ping_interval_sec),
  3726. max_missed_pongs_(max_missed_pongs) {
  3727. start_heartbeat();
  3728. }
  3729. void start_heartbeat();
  3730. bool send_frame(Opcode op, const char *data, size_t len, bool fin = true);
  3731. Stream &strm_;
  3732. std::unique_ptr<Stream> owned_strm_;
  3733. Request req_;
  3734. bool is_server_;
  3735. time_t ping_interval_sec_;
  3736. int max_missed_pongs_;
  3737. int unacked_pings_ = 0;
  3738. std::atomic<bool> closed_{false};
  3739. // Set once the caller has bounded read() through set_read_timeout(). Until
  3740. // then the timeout in effect is the compile-time default, and elapsing it
  3741. // is a failure that closes the connection, not a Timeout.
  3742. std::atomic<bool> read_timeout_set_{false};
  3743. std::mutex write_mutex_;
  3744. // Owned by whichever thread is parsing frames off strm_. Only one thread
  3745. // may do so: read_websocket_frame() reads a payload until it has the whole
  3746. // declared length, so a second parser stealing bytes silently corrupts the
  3747. // message the first one is assembling.
  3748. std::mutex read_mutex_;
  3749. std::thread ping_thread_;
  3750. std::mutex ping_mutex_;
  3751. std::condition_variable ping_cv_;
  3752. };
  3753. class WebSocketClient {
  3754. public:
  3755. explicit WebSocketClient(const std::string &scheme_host_port_path,
  3756. const Headers &headers = {});
  3757. ~WebSocketClient();
  3758. WebSocketClient(const WebSocketClient &) = delete;
  3759. WebSocketClient &operator=(const WebSocketClient &) = delete;
  3760. bool is_valid() const;
  3761. Result connect();
  3762. ReadResult read(std::string &msg);
  3763. bool send(const std::string &data);
  3764. bool send(const char *data, size_t len);
  3765. void close(CloseStatus status = CloseStatus::Normal,
  3766. const std::string &reason = "");
  3767. bool is_open() const;
  3768. const std::string &subprotocol() const;
  3769. void set_read_timeout(time_t sec, time_t usec = 0);
  3770. template <class Rep, class Period>
  3771. void set_read_timeout(const std::chrono::duration<Rep, Period> &duration);
  3772. void set_write_timeout(time_t sec, time_t usec = 0);
  3773. template <class Rep, class Period>
  3774. void set_write_timeout(const std::chrono::duration<Rep, Period> &duration);
  3775. void set_websocket_ping_interval(time_t sec);
  3776. void set_websocket_max_missed_pongs(int count);
  3777. void set_tcp_nodelay(bool on);
  3778. void set_address_family(int family);
  3779. void set_ipv6_v6only(bool on);
  3780. void set_socket_options(SocketOptions socket_options);
  3781. void set_connection_timeout(time_t sec, time_t usec = 0);
  3782. template <class Rep, class Period>
  3783. void
  3784. set_connection_timeout(const std::chrono::duration<Rep, Period> &duration);
  3785. void set_interface(const std::string &intf);
  3786. void set_hostname_addr_map(std::map<std::string, std::string> addr_map);
  3787. #ifdef CPPHTTPLIB_SSL_ENABLED
  3788. struct PemMemory {
  3789. const char *cert_pem;
  3790. size_t cert_pem_len;
  3791. const char *key_pem;
  3792. size_t key_pem_len;
  3793. const char *private_key_password;
  3794. };
  3795. explicit WebSocketClient(const std::string &scheme_host_port_path,
  3796. const PemMemory &pem, const Headers &headers = {});
  3797. void set_ca_cert_path(const std::string &ca_cert_file_path,
  3798. const std::string &ca_cert_dir_path = std::string());
  3799. void set_ca_cert_store(tls::ca_store_t store);
  3800. void load_ca_cert_store(const char *ca_cert, std::size_t size);
  3801. void enable_server_certificate_verification(bool enabled);
  3802. void enable_server_hostname_verification(bool enabled);
  3803. void enable_system_ca(bool enabled);
  3804. #endif
  3805. private:
  3806. void shutdown_and_close();
  3807. bool create_stream(std::unique_ptr<Stream> &strm, Error &error,
  3808. int &ssl_error, uint64_t &ssl_backend_error);
  3809. void prepare_default_headers(Request &req);
  3810. std::string host_;
  3811. int port_;
  3812. std::string path_;
  3813. Headers headers_;
  3814. std::string subprotocol_;
  3815. bool is_valid_ = false;
  3816. socket_t sock_ = INVALID_SOCKET;
  3817. std::unique_ptr<WebSocket> ws_;
  3818. time_t read_timeout_sec_ = CPPHTTPLIB_WEBSOCKET_CLIENT_READ_TIMEOUT_SECOND;
  3819. time_t read_timeout_usec_ = 0;
  3820. bool read_timeout_set_ = false; // see WebSocket::read_timeout_set_
  3821. time_t write_timeout_sec_ = CPPHTTPLIB_CLIENT_WRITE_TIMEOUT_SECOND;
  3822. time_t write_timeout_usec_ = CPPHTTPLIB_CLIENT_WRITE_TIMEOUT_USECOND;
  3823. time_t websocket_ping_interval_sec_ =
  3824. CPPHTTPLIB_WEBSOCKET_PING_INTERVAL_SECOND;
  3825. int websocket_max_missed_pongs_ = CPPHTTPLIB_WEBSOCKET_MAX_MISSED_PONGS;
  3826. int address_family_ = AF_UNSPEC;
  3827. bool tcp_nodelay_ = CPPHTTPLIB_TCP_NODELAY;
  3828. bool ipv6_v6only_ = CPPHTTPLIB_IPV6_V6ONLY;
  3829. SocketOptions socket_options_ = nullptr;
  3830. time_t connection_timeout_sec_ = CPPHTTPLIB_CONNECTION_TIMEOUT_SECOND;
  3831. time_t connection_timeout_usec_ = CPPHTTPLIB_CONNECTION_TIMEOUT_USECOND;
  3832. std::string interface_;
  3833. // Hostname to connection target map. The value is an IP literal or another
  3834. // hostname; only the connection target changes, never the identity.
  3835. std::map<std::string, std::string> addr_map_;
  3836. #ifdef CPPHTTPLIB_SSL_ENABLED
  3837. bool is_ssl_ = false;
  3838. tls::ctx_t tls_ctx_ = nullptr;
  3839. tls::session_t tls_session_ = nullptr;
  3840. std::string ca_cert_file_path_;
  3841. std::string ca_cert_dir_path_;
  3842. bool custom_ca_loaded_ = false;
  3843. bool certs_loaded_ = false;
  3844. SystemCAMode system_ca_mode_ = SystemCAMode::Auto;
  3845. bool server_certificate_verification_ = true;
  3846. bool server_hostname_verification_ = true;
  3847. #endif
  3848. };
  3849. template <class Rep, class Period>
  3850. inline void WebSocket::set_read_timeout(
  3851. const std::chrono::duration<Rep, Period> &duration) {
  3852. detail::duration_to_sec_and_usec(
  3853. duration, [&](time_t sec, time_t usec) { set_read_timeout(sec, usec); });
  3854. }
  3855. template <class Rep, class Period>
  3856. inline void WebSocketClient::set_read_timeout(
  3857. const std::chrono::duration<Rep, Period> &duration) {
  3858. detail::duration_to_sec_and_usec(
  3859. duration, [&](time_t sec, time_t usec) { set_read_timeout(sec, usec); });
  3860. }
  3861. template <class Rep, class Period>
  3862. inline void WebSocketClient::set_write_timeout(
  3863. const std::chrono::duration<Rep, Period> &duration) {
  3864. detail::duration_to_sec_and_usec(
  3865. duration, [&](time_t sec, time_t usec) { set_write_timeout(sec, usec); });
  3866. }
  3867. template <class Rep, class Period>
  3868. inline void WebSocketClient::set_connection_timeout(
  3869. const std::chrono::duration<Rep, Period> &duration) {
  3870. detail::duration_to_sec_and_usec(duration, [&](time_t sec, time_t usec) {
  3871. set_connection_timeout(sec, usec);
  3872. });
  3873. }
  3874. namespace impl {
  3875. bool is_valid_utf8(const std::string &s);
  3876. // Three states, because a failure that consumed bytes and one that consumed
  3877. // none are not the same thing: the first has left the stream in the middle of
  3878. // a frame and the connection cannot be reused, the second can just be retried.
  3879. enum class FrameRead { Ok, Fail, Timeout };
  3880. FrameRead read_websocket_frame(Stream &strm, Opcode &opcode,
  3881. std::string &payload, bool &fin,
  3882. bool expect_masked, size_t max_len);
  3883. } // namespace impl
  3884. } // namespace ws
  3885. // ----------------------------------------------------------------------------
  3886. /*
  3887. * Implementation that will be part of the .cc file if split into .h + .cc.
  3888. */
  3889. namespace stream {
  3890. // stream::Result implementations
  3891. inline Result::Result() : chunk_size_(8192) {}
  3892. inline Result::Result(ClientImpl::StreamHandle &&handle, size_t chunk_size)
  3893. : handle_(std::move(handle)), chunk_size_(chunk_size) {}
  3894. inline Result::Result(Result &&other) noexcept
  3895. : handle_(std::move(other.handle_)), buffer_(std::move(other.buffer_)),
  3896. current_size_(other.current_size_), chunk_size_(other.chunk_size_),
  3897. finished_(other.finished_) {
  3898. other.current_size_ = 0;
  3899. other.finished_ = true;
  3900. }
  3901. inline Result &Result::operator=(Result &&other) noexcept {
  3902. if (this != &other) {
  3903. handle_ = std::move(other.handle_);
  3904. buffer_ = std::move(other.buffer_);
  3905. current_size_ = other.current_size_;
  3906. chunk_size_ = other.chunk_size_;
  3907. finished_ = other.finished_;
  3908. other.current_size_ = 0;
  3909. other.finished_ = true;
  3910. }
  3911. return *this;
  3912. }
  3913. inline bool Result::is_valid() const { return handle_.is_valid(); }
  3914. inline Result::operator bool() const { return is_valid(); }
  3915. inline int Result::status() const {
  3916. return handle_.response ? handle_.response->status : -1;
  3917. }
  3918. inline const Headers &Result::headers() const {
  3919. static const Headers empty_headers;
  3920. return handle_.response ? handle_.response->headers : empty_headers;
  3921. }
  3922. inline std::string Result::get_header_value(const std::string &key,
  3923. const char *def) const {
  3924. return handle_.response ? handle_.response->get_header_value(key, def) : def;
  3925. }
  3926. inline bool Result::has_header(const std::string &key) const {
  3927. return handle_.response ? handle_.response->has_header(key) : false;
  3928. }
  3929. inline Error Result::error() const { return handle_.error; }
  3930. inline Error Result::read_error() const { return handle_.get_read_error(); }
  3931. inline bool Result::has_read_error() const { return handle_.has_read_error(); }
  3932. inline bool Result::next() {
  3933. if (!handle_.is_valid() || finished_) { return false; }
  3934. if (buffer_.size() < chunk_size_) { buffer_.resize(chunk_size_); }
  3935. ssize_t n = handle_.read(&buffer_[0], chunk_size_);
  3936. if (n > 0) {
  3937. current_size_ = static_cast<size_t>(n);
  3938. return true;
  3939. }
  3940. current_size_ = 0;
  3941. finished_ = true;
  3942. return false;
  3943. }
  3944. inline const char *Result::data() const { return buffer_.data(); }
  3945. inline size_t Result::size() const { return current_size_; }
  3946. inline std::string Result::read_all() {
  3947. std::string result;
  3948. while (next()) {
  3949. result.append(data(), size());
  3950. }
  3951. return result;
  3952. }
  3953. } // namespace stream
  3954. namespace sse {
  3955. // SSEMessage implementations
  3956. inline SSEMessage::SSEMessage() : event("message") {}
  3957. inline void SSEMessage::clear() {
  3958. event = "message";
  3959. data.clear();
  3960. id.clear();
  3961. }
  3962. // SSEClient implementations
  3963. inline SSEClient::SSEClient(Client &client, const std::string &path)
  3964. : client_(client), path_(path) {}
  3965. inline SSEClient::SSEClient(Client &client, const std::string &path,
  3966. const Headers &headers)
  3967. : client_(client), path_(path), headers_(headers) {}
  3968. inline SSEClient::~SSEClient() { stop(); }
  3969. inline SSEClient &SSEClient::on_message(MessageHandler handler) {
  3970. on_message_ = std::move(handler);
  3971. return *this;
  3972. }
  3973. inline SSEClient &SSEClient::on_event(const std::string &type,
  3974. MessageHandler handler) {
  3975. event_handlers_[type] = std::move(handler);
  3976. return *this;
  3977. }
  3978. inline SSEClient &SSEClient::on_open(OpenHandler handler) {
  3979. on_open_ = std::move(handler);
  3980. return *this;
  3981. }
  3982. inline SSEClient &SSEClient::on_error(ErrorHandler handler) {
  3983. on_error_ = std::move(handler);
  3984. return *this;
  3985. }
  3986. inline SSEClient &SSEClient::set_reconnect_interval(int ms) {
  3987. reconnect_interval_ms_ = ms;
  3988. return *this;
  3989. }
  3990. inline SSEClient &SSEClient::set_max_reconnect_attempts(int n) {
  3991. max_reconnect_attempts_ = n;
  3992. return *this;
  3993. }
  3994. inline SSEClient &SSEClient::set_headers(const Headers &headers) {
  3995. std::lock_guard<std::mutex> lock(headers_mutex_);
  3996. headers_ = headers;
  3997. return *this;
  3998. }
  3999. inline bool SSEClient::is_connected() const { return connected_.load(); }
  4000. inline const std::string &SSEClient::last_event_id() const {
  4001. return last_event_id_;
  4002. }
  4003. inline void SSEClient::start() {
  4004. running_.store(true);
  4005. run_event_loop();
  4006. }
  4007. inline void SSEClient::start_async() {
  4008. running_.store(true);
  4009. async_thread_ = std::thread([this]() { run_event_loop(); });
  4010. }
  4011. inline void SSEClient::stop() {
  4012. running_.store(false);
  4013. client_.stop(); // Cancel any pending operations
  4014. if (async_thread_.joinable()) { async_thread_.join(); }
  4015. }
  4016. inline bool SSEClient::parse_sse_line(const std::string &line, SSEMessage &msg,
  4017. int &retry_ms) {
  4018. // Blank line signals end of event
  4019. if (line.empty() || line == "\r") { return true; }
  4020. // Lines starting with ':' are comments (ignored)
  4021. if (!line.empty() && line[0] == ':') { return false; }
  4022. // Find the colon separator
  4023. auto colon_pos = line.find(':');
  4024. if (colon_pos == std::string::npos) {
  4025. // Line with no colon is treated as field name with empty value
  4026. return false;
  4027. }
  4028. auto field = line.substr(0, colon_pos);
  4029. std::string value;
  4030. // Value starts after colon, skip optional single space
  4031. if (colon_pos + 1 < line.size()) {
  4032. auto value_start = colon_pos + 1;
  4033. if (line[value_start] == ' ') { value_start++; }
  4034. value = line.substr(value_start);
  4035. // Remove trailing \r if present
  4036. if (!value.empty() && value.back() == '\r') { value.pop_back(); }
  4037. }
  4038. // Handle known fields
  4039. if (field == "event") {
  4040. msg.event = value;
  4041. } else if (field == "data") {
  4042. // Multiple data lines are concatenated with newlines
  4043. if (!msg.data.empty()) { msg.data += "\n"; }
  4044. msg.data += value;
  4045. } else if (field == "id") {
  4046. // Empty id is valid (clears the last event ID)
  4047. msg.id = value;
  4048. } else if (field == "retry") {
  4049. // Parse retry interval in milliseconds
  4050. // Per the SSE spec, a value that is not all ASCII digits is ignored.
  4051. if (detail::is_numeric(value)) {
  4052. int v = 0;
  4053. auto res =
  4054. detail::from_chars(value.data(), value.data() + value.size(), v);
  4055. if (res.ec == std::errc{}) { retry_ms = v; }
  4056. }
  4057. }
  4058. // Unknown fields are ignored per SSE spec
  4059. return false;
  4060. }
  4061. inline void SSEClient::run_event_loop() {
  4062. auto reconnect_count = 0;
  4063. while (running_.load()) {
  4064. // Build headers, including Last-Event-ID if we have one
  4065. Headers request_headers;
  4066. {
  4067. std::lock_guard<std::mutex> lock(headers_mutex_);
  4068. request_headers = headers_;
  4069. }
  4070. if (!last_event_id_.empty()) {
  4071. request_headers.emplace("Last-Event-ID", last_event_id_);
  4072. }
  4073. // Open streaming connection
  4074. auto result = stream::Get(client_, path_, request_headers);
  4075. // Connection error handling
  4076. if (!result) {
  4077. connected_.store(false);
  4078. if (on_error_) { on_error_(result.error()); }
  4079. if (!should_reconnect(reconnect_count)) { break; }
  4080. wait_for_reconnect();
  4081. reconnect_count++;
  4082. continue;
  4083. }
  4084. if (result.status() != StatusCode::OK_200) {
  4085. connected_.store(false);
  4086. if (on_error_) { on_error_(Error::Connection); }
  4087. // For certain errors, don't reconnect.
  4088. // Note: 401 is intentionally absent so that handlers can refresh
  4089. // credentials via set_headers() and let the client reconnect.
  4090. if (result.status() == StatusCode::NoContent_204 ||
  4091. result.status() == StatusCode::NotFound_404 ||
  4092. result.status() == StatusCode::Forbidden_403) {
  4093. break;
  4094. }
  4095. if (!should_reconnect(reconnect_count)) { break; }
  4096. wait_for_reconnect();
  4097. reconnect_count++;
  4098. continue;
  4099. }
  4100. // Connection successful
  4101. connected_.store(true);
  4102. reconnect_count = 0;
  4103. if (on_open_) { on_open_(); }
  4104. // Event receiving loop
  4105. std::string buffer;
  4106. SSEMessage current_msg;
  4107. while (running_.load() && result.next()) {
  4108. buffer.append(result.data(), result.size());
  4109. // Process complete lines in the buffer
  4110. size_t line_start = 0;
  4111. size_t newline_pos;
  4112. while ((newline_pos = buffer.find('\n', line_start)) !=
  4113. std::string::npos) {
  4114. auto line = buffer.substr(line_start, newline_pos - line_start);
  4115. line_start = newline_pos + 1;
  4116. // Parse the line and check if event is complete
  4117. auto event_complete =
  4118. parse_sse_line(line, current_msg, reconnect_interval_ms_);
  4119. if (event_complete && !current_msg.data.empty()) {
  4120. // Update last_event_id for reconnection
  4121. if (!current_msg.id.empty()) { last_event_id_ = current_msg.id; }
  4122. // Dispatch event to appropriate handler
  4123. dispatch_event(current_msg);
  4124. current_msg.clear();
  4125. }
  4126. }
  4127. // Keep unprocessed data in buffer
  4128. buffer.erase(0, line_start);
  4129. }
  4130. // Connection ended
  4131. connected_.store(false);
  4132. if (!running_.load()) { break; }
  4133. // Check for read errors
  4134. if (result.has_read_error()) {
  4135. if (on_error_) { on_error_(result.read_error()); }
  4136. }
  4137. if (!should_reconnect(reconnect_count)) { break; }
  4138. wait_for_reconnect();
  4139. reconnect_count++;
  4140. }
  4141. connected_.store(false);
  4142. }
  4143. inline void SSEClient::dispatch_event(const SSEMessage &msg) {
  4144. // Check for specific event type handler first
  4145. auto it = event_handlers_.find(msg.event);
  4146. if (it != event_handlers_.end()) {
  4147. it->second(msg);
  4148. return;
  4149. }
  4150. // Fall back to generic message handler
  4151. if (on_message_) { on_message_(msg); }
  4152. }
  4153. inline bool SSEClient::should_reconnect(int count) const {
  4154. if (!running_.load()) { return false; }
  4155. if (max_reconnect_attempts_ == 0) { return true; } // unlimited
  4156. return count < max_reconnect_attempts_;
  4157. }
  4158. inline void SSEClient::wait_for_reconnect() {
  4159. // Use small increments to check running_ flag frequently.
  4160. // Always wait at least one increment, so that a zero interval (e.g.
  4161. // "retry: 0" from the server) cannot cause a busy reconnect loop.
  4162. const auto step_ms = 100;
  4163. auto interval_ms = (std::max)(reconnect_interval_ms_, step_ms);
  4164. auto waited = 0;
  4165. while (running_.load() && waited < interval_ms) {
  4166. std::this_thread::sleep_for(std::chrono::milliseconds(step_ms));
  4167. waited += step_ms;
  4168. }
  4169. }
  4170. } // namespace sse
  4171. #ifdef CPPHTTPLIB_SSL_ENABLED
  4172. /*
  4173. * TLS abstraction layer - internal function declarations
  4174. * These are implementation details and not part of the public API.
  4175. */
  4176. namespace tls {
  4177. // Client context
  4178. ctx_t create_client_context();
  4179. void free_context(ctx_t ctx);
  4180. bool set_min_version(ctx_t ctx, Version version);
  4181. bool load_ca_pem(ctx_t ctx, const char *pem, size_t len);
  4182. bool load_ca_file(ctx_t ctx, const char *file_path);
  4183. bool load_ca_dir(ctx_t ctx, const char *dir_path);
  4184. bool load_system_certs(ctx_t ctx);
  4185. bool set_client_cert_pem(ctx_t ctx, const char *cert, const char *key,
  4186. const char *password);
  4187. bool set_client_cert_file(ctx_t ctx, const char *cert_path,
  4188. const char *key_path, const char *password);
  4189. // Server context
  4190. ctx_t create_server_context();
  4191. bool set_server_cert_pem(ctx_t ctx, const char *cert, const char *key,
  4192. const char *password);
  4193. bool set_server_cert_file(ctx_t ctx, const char *cert_path,
  4194. const char *key_path, const char *password);
  4195. bool set_client_ca_file(ctx_t ctx, const char *ca_file, const char *ca_dir);
  4196. void set_verify_client(ctx_t ctx, bool require);
  4197. // Session management
  4198. session_t create_session(ctx_t ctx, socket_t sock);
  4199. void free_session(session_t session);
  4200. bool set_sni(session_t session, const char *hostname, bool verify_hostname);
  4201. // Handshake (non-blocking capable)
  4202. TlsError connect(session_t session);
  4203. TlsError accept(session_t session);
  4204. // Handshake with timeout (blocking until timeout)
  4205. bool connect_nonblocking(session_t session, socket_t sock, time_t timeout_sec,
  4206. time_t timeout_usec, TlsError *err);
  4207. bool accept_nonblocking(session_t session, socket_t sock, time_t timeout_sec,
  4208. time_t timeout_usec, TlsError *err);
  4209. // I/O (non-blocking capable)
  4210. ssize_t read(session_t session, void *buf, size_t len, TlsError &err);
  4211. ssize_t write(session_t session, const void *buf, size_t len, TlsError &err);
  4212. int pending(const_session_t session);
  4213. void shutdown(session_t session, bool graceful);
  4214. // Connection state
  4215. bool is_peer_closed(session_t session, socket_t sock);
  4216. // Certificate verification
  4217. cert_t get_peer_cert(const_session_t session);
  4218. // The certificates the peer sent, leaf first. Free each with free_cert(), and
  4219. // do not use them after free_session(), as with get_peer_cert().
  4220. size_t get_peer_certs(const_session_t session, std::vector<cert_t> &certs);
  4221. void free_cert(cert_t cert);
  4222. bool verify_hostname(cert_t cert, const char *hostname);
  4223. uint64_t hostname_mismatch_code();
  4224. long get_verify_result(const_session_t session);
  4225. // Certificate introspection
  4226. std::string get_cert_subject_cn(cert_t cert);
  4227. std::string get_cert_issuer_name(cert_t cert);
  4228. bool get_cert_sans(cert_t cert, std::vector<SanEntry> &sans);
  4229. bool get_cert_validity(cert_t cert, time_t &not_before, time_t &not_after);
  4230. std::string get_cert_serial(cert_t cert);
  4231. bool get_cert_der(cert_t cert, std::vector<unsigned char> &der);
  4232. const char *get_sni(const_session_t session);
  4233. // CA store management
  4234. ca_store_t create_ca_store(const char *pem, size_t len);
  4235. void free_ca_store(ca_store_t store);
  4236. bool set_ca_store(ctx_t ctx, ca_store_t store);
  4237. size_t get_ca_certs(ctx_t ctx, std::vector<cert_t> &certs);
  4238. std::vector<std::string> get_ca_names(ctx_t ctx);
  4239. // Dynamic certificate update (for servers)
  4240. bool update_server_cert(ctx_t ctx, const char *cert_pem, const char *key_pem,
  4241. const char *password);
  4242. bool update_server_client_ca(ctx_t ctx, const char *ca_pem);
  4243. // Certificate verification callback
  4244. bool set_verify_callback(ctx_t ctx, VerifyCallback callback);
  4245. long get_verify_error(const_session_t session);
  4246. std::string verify_error_string(long error_code);
  4247. // TlsError information
  4248. uint64_t peek_error();
  4249. uint64_t get_error();
  4250. std::string error_string(uint64_t code);
  4251. } // namespace tls
  4252. #endif // CPPHTTPLIB_SSL_ENABLED
  4253. /*
  4254. * Group 1: detail namespace - Non-SSL utilities
  4255. */
  4256. namespace detail {
  4257. inline bool set_socket_opt_impl(socket_t sock, int level, int optname,
  4258. const void *optval, socklen_t optlen) {
  4259. return setsockopt(sock, level, optname,
  4260. #ifdef _WIN32
  4261. reinterpret_cast<const char *>(optval),
  4262. #else
  4263. optval,
  4264. #endif
  4265. optlen) == 0;
  4266. }
  4267. inline bool set_socket_opt_time(socket_t sock, int level, int optname,
  4268. time_t sec, time_t usec) {
  4269. #ifdef _WIN32
  4270. auto timeout = static_cast<uint32_t>(sec * 1000 + usec / 1000);
  4271. #else
  4272. timeval timeout;
  4273. timeout.tv_sec = static_cast<long>(sec);
  4274. timeout.tv_usec = static_cast<decltype(timeout.tv_usec)>(usec);
  4275. #endif
  4276. return set_socket_opt_impl(sock, level, optname, &timeout, sizeof(timeout));
  4277. }
  4278. inline bool is_hex(char c, int &v) {
  4279. if (is_ascii_digit(c)) {
  4280. v = c - '0';
  4281. return true;
  4282. } else if ('A' <= c && c <= 'F') {
  4283. v = c - 'A' + 10;
  4284. return true;
  4285. } else if ('a' <= c && c <= 'f') {
  4286. v = c - 'a' + 10;
  4287. return true;
  4288. }
  4289. return false;
  4290. }
  4291. inline bool from_hex_to_i(const std::string &s, size_t i, size_t cnt,
  4292. int &val) {
  4293. if (i >= s.size()) { return false; }
  4294. val = 0;
  4295. for (; cnt; i++, cnt--) {
  4296. if (!s[i]) { return false; }
  4297. auto v = 0;
  4298. if (is_hex(s[i], v)) {
  4299. val = val * 16 + v;
  4300. } else {
  4301. return false;
  4302. }
  4303. }
  4304. return true;
  4305. }
  4306. inline std::string from_i_to_hex(size_t n) {
  4307. static const auto charset = "0123456789abcdef";
  4308. std::string ret;
  4309. do {
  4310. ret = charset[n & 15] + ret;
  4311. n >>= 4;
  4312. } while (n > 0);
  4313. return ret;
  4314. }
  4315. inline std::string compute_etag(const FileStat &fs,
  4316. const std::string &suffix = std::string()) {
  4317. if (!fs.is_file()) { return std::string(); }
  4318. // If mtime cannot be determined (negative value indicates an error
  4319. // or sentinel), do not generate an ETag. Returning a neutral / fixed
  4320. // value like 0 could collide with a real file that legitimately has
  4321. // mtime == 0 (epoch) and lead to misleading validators.
  4322. auto mtime_raw = fs.mtime();
  4323. if (mtime_raw < 0) { return std::string(); }
  4324. auto mtime = static_cast<size_t>(mtime_raw);
  4325. auto size = fs.size();
  4326. return std::string("W/\"") + from_i_to_hex(mtime) + "-" +
  4327. from_i_to_hex(size) + suffix + "\"";
  4328. }
  4329. // Format time_t as HTTP-date (RFC 9110 Section 5.6.7): "Sun, 06 Nov 1994
  4330. // 08:49:37 GMT" This implementation is defensive: it validates `mtime`, checks
  4331. // return values from `gmtime_r`/`gmtime_s`, and ensures `strftime` succeeds.
  4332. inline std::string file_mtime_to_http_date(time_t mtime) {
  4333. if (mtime < 0) { return std::string(); }
  4334. struct tm tm_buf;
  4335. #ifdef _WIN32
  4336. if (gmtime_s(&tm_buf, &mtime) != 0) { return std::string(); }
  4337. #else
  4338. if (gmtime_r(&mtime, &tm_buf) == nullptr) { return std::string(); }
  4339. #endif
  4340. char buf[64];
  4341. if (strftime(buf, sizeof(buf), "%a, %d %b %Y %H:%M:%S GMT", &tm_buf) == 0) {
  4342. return std::string();
  4343. }
  4344. return std::string(buf);
  4345. }
  4346. // Parse HTTP-date (RFC 9110 Section 5.6.7) to time_t. Returns -1 on failure.
  4347. inline time_t parse_http_date(const std::string &date_str) {
  4348. struct tm tm_buf;
  4349. // Create a classic locale object once for all parsing attempts
  4350. const std::locale classic_locale = std::locale::classic();
  4351. // Try to parse using std::get_time (C++11, cross-platform)
  4352. auto try_parse = [&](const char *fmt) -> bool {
  4353. std::istringstream ss(date_str);
  4354. ss.imbue(classic_locale);
  4355. memset(&tm_buf, 0, sizeof(tm_buf));
  4356. ss >> std::get_time(&tm_buf, fmt);
  4357. return !ss.fail();
  4358. };
  4359. // RFC 9110 preferred format (HTTP-date): "Sun, 06 Nov 1994 08:49:37 GMT"
  4360. if (!try_parse("%a, %d %b %Y %H:%M:%S")) {
  4361. // RFC 850 format: "Sunday, 06-Nov-94 08:49:37 GMT"
  4362. if (!try_parse("%A, %d-%b-%y %H:%M:%S")) {
  4363. // asctime format: "Sun Nov 6 08:49:37 1994"
  4364. if (!try_parse("%a %b %d %H:%M:%S %Y")) {
  4365. return static_cast<time_t>(-1);
  4366. }
  4367. }
  4368. }
  4369. #ifdef _WIN32
  4370. return _mkgmtime(&tm_buf);
  4371. #elif defined _AIX
  4372. return mktime(&tm_buf);
  4373. #else
  4374. return timegm(&tm_buf);
  4375. #endif
  4376. }
  4377. inline bool is_weak_etag(const std::string &s) {
  4378. // Check if the string is a weak ETag (starts with 'W/"')
  4379. return s.size() > 3 && s[0] == 'W' && s[1] == '/' && s[2] == '"';
  4380. }
  4381. inline bool is_strong_etag(const std::string &s) {
  4382. // Check if the string is a strong ETag (starts and ends with '"', at least 2
  4383. // chars)
  4384. return s.size() >= 2 && s[0] == '"' && s.back() == '"';
  4385. }
  4386. inline size_t to_utf8(int code, char *buff) {
  4387. if (code < 0x0080) {
  4388. buff[0] = static_cast<char>(code & 0x7F);
  4389. return 1;
  4390. } else if (code < 0x0800) {
  4391. buff[0] = static_cast<char>(0xC0 | ((code >> 6) & 0x1F));
  4392. buff[1] = static_cast<char>(0x80 | (code & 0x3F));
  4393. return 2;
  4394. } else if (code < 0xD800) {
  4395. buff[0] = static_cast<char>(0xE0 | ((code >> 12) & 0xF));
  4396. buff[1] = static_cast<char>(0x80 | ((code >> 6) & 0x3F));
  4397. buff[2] = static_cast<char>(0x80 | (code & 0x3F));
  4398. return 3;
  4399. } else if (code < 0xE000) { // D800 - DFFF is invalid...
  4400. return 0;
  4401. } else if (code < 0x10000) {
  4402. buff[0] = static_cast<char>(0xE0 | ((code >> 12) & 0xF));
  4403. buff[1] = static_cast<char>(0x80 | ((code >> 6) & 0x3F));
  4404. buff[2] = static_cast<char>(0x80 | (code & 0x3F));
  4405. return 3;
  4406. } else if (code < 0x110000) {
  4407. buff[0] = static_cast<char>(0xF0 | ((code >> 18) & 0x7));
  4408. buff[1] = static_cast<char>(0x80 | ((code >> 12) & 0x3F));
  4409. buff[2] = static_cast<char>(0x80 | ((code >> 6) & 0x3F));
  4410. buff[3] = static_cast<char>(0x80 | (code & 0x3F));
  4411. return 4;
  4412. }
  4413. // NOTREACHED
  4414. return 0;
  4415. }
  4416. } // namespace detail
  4417. namespace ws {
  4418. namespace impl {
  4419. inline bool is_valid_utf8(const std::string &s) {
  4420. size_t i = 0;
  4421. auto n = s.size();
  4422. while (i < n) {
  4423. auto c = static_cast<unsigned char>(s[i]);
  4424. size_t len;
  4425. uint32_t cp;
  4426. if (c < 0x80) {
  4427. i++;
  4428. continue;
  4429. } else if ((c & 0xE0) == 0xC0) {
  4430. len = 2;
  4431. cp = c & 0x1F;
  4432. } else if ((c & 0xF0) == 0xE0) {
  4433. len = 3;
  4434. cp = c & 0x0F;
  4435. } else if ((c & 0xF8) == 0xF0) {
  4436. len = 4;
  4437. cp = c & 0x07;
  4438. } else {
  4439. return false;
  4440. }
  4441. if (i + len > n) { return false; }
  4442. for (size_t j = 1; j < len; j++) {
  4443. auto b = static_cast<unsigned char>(s[i + j]);
  4444. if ((b & 0xC0) != 0x80) { return false; }
  4445. cp = (cp << 6) | (b & 0x3F);
  4446. }
  4447. // Overlong encoding check
  4448. if (len == 2 && cp < 0x80) { return false; }
  4449. if (len == 3 && cp < 0x800) { return false; }
  4450. if (len == 4 && cp < 0x10000) { return false; }
  4451. // Surrogate halves (U+D800..U+DFFF) and beyond U+10FFFF are invalid
  4452. if (cp >= 0xD800 && cp <= 0xDFFF) { return false; }
  4453. if (cp > 0x10FFFF) { return false; }
  4454. i += len;
  4455. }
  4456. return true;
  4457. }
  4458. } // namespace impl
  4459. } // namespace ws
  4460. namespace detail {
  4461. // NOTE: This code came up with the following stackoverflow post:
  4462. // https://stackoverflow.com/questions/180947/base64-decode-snippet-in-c
  4463. inline std::string base64_encode(const std::string &in) {
  4464. static const auto lookup =
  4465. "ABCDEFGHIJKLMNOPQRSTUVWXYZabcdefghijklmnopqrstuvwxyz0123456789+/";
  4466. std::string out;
  4467. out.reserve(in.size());
  4468. // Unsigned: the accumulator is never masked, so with a signed int the
  4469. // `val << 8` below overflows once enough bytes are folded in (undefined
  4470. // behaviour before C++20). Only the low bits are ever emitted, so the
  4471. // wrap-around of an unsigned accumulator does not affect the output.
  4472. uint32_t val = 0;
  4473. auto valb = -6;
  4474. for (auto c : in) {
  4475. val = (val << 8) + static_cast<uint8_t>(c);
  4476. valb += 8;
  4477. while (valb >= 0) {
  4478. out.push_back(lookup[(val >> valb) & 0x3F]);
  4479. valb -= 6;
  4480. }
  4481. }
  4482. if (valb > -6) { out.push_back(lookup[((val << 8) >> (valb + 8)) & 0x3F]); }
  4483. while (out.size() % 4) {
  4484. out.push_back('=');
  4485. }
  4486. return out;
  4487. }
  4488. inline std::string sha1(const std::string &input) {
  4489. // RFC 3174 SHA-1 implementation
  4490. auto left_rotate = [](uint32_t x, uint32_t n) -> uint32_t {
  4491. return (x << n) | (x >> (32 - n));
  4492. };
  4493. uint32_t h0 = 0x67452301;
  4494. uint32_t h1 = 0xEFCDAB89;
  4495. uint32_t h2 = 0x98BADCFE;
  4496. uint32_t h3 = 0x10325476;
  4497. uint32_t h4 = 0xC3D2E1F0;
  4498. // Pre-processing: adding padding bits
  4499. std::string msg = input;
  4500. uint64_t original_bit_len = static_cast<uint64_t>(msg.size()) * 8;
  4501. msg.push_back(static_cast<char>(0x80u));
  4502. while (msg.size() % 64 != 56) {
  4503. msg.push_back(0);
  4504. }
  4505. // Append original length in bits as 64-bit big-endian
  4506. for (int i = 56; i >= 0; i -= 8) {
  4507. msg.push_back(static_cast<char>((original_bit_len >> i) & 0xFF));
  4508. }
  4509. // Process each 512-bit chunk
  4510. for (size_t offset = 0; offset < msg.size(); offset += 64) {
  4511. uint32_t w[80];
  4512. for (size_t i = 0; i < 16; i++) {
  4513. w[i] =
  4514. (static_cast<uint32_t>(static_cast<uint8_t>(msg[offset + i * 4]))
  4515. << 24) |
  4516. (static_cast<uint32_t>(static_cast<uint8_t>(msg[offset + i * 4 + 1]))
  4517. << 16) |
  4518. (static_cast<uint32_t>(static_cast<uint8_t>(msg[offset + i * 4 + 2]))
  4519. << 8) |
  4520. (static_cast<uint32_t>(
  4521. static_cast<uint8_t>(msg[offset + i * 4 + 3])));
  4522. }
  4523. for (int i = 16; i < 80; i++) {
  4524. w[i] = left_rotate(w[i - 3] ^ w[i - 8] ^ w[i - 14] ^ w[i - 16], 1);
  4525. }
  4526. uint32_t a = h0, b = h1, c = h2, d = h3, e = h4;
  4527. for (int i = 0; i < 80; i++) {
  4528. uint32_t f, k;
  4529. if (i < 20) {
  4530. f = (b & c) | ((~b) & d);
  4531. k = 0x5A827999;
  4532. } else if (i < 40) {
  4533. f = b ^ c ^ d;
  4534. k = 0x6ED9EBA1;
  4535. } else if (i < 60) {
  4536. f = (b & c) | (b & d) | (c & d);
  4537. k = 0x8F1BBCDC;
  4538. } else {
  4539. f = b ^ c ^ d;
  4540. k = 0xCA62C1D6;
  4541. }
  4542. uint32_t temp = left_rotate(a, 5) + f + e + k + w[i];
  4543. e = d;
  4544. d = c;
  4545. c = left_rotate(b, 30);
  4546. b = a;
  4547. a = temp;
  4548. }
  4549. h0 += a;
  4550. h1 += b;
  4551. h2 += c;
  4552. h3 += d;
  4553. h4 += e;
  4554. }
  4555. // Produce the final hash as a 20-byte binary string
  4556. std::string hash(20, '\0');
  4557. for (size_t i = 0; i < 4; i++) {
  4558. hash[i] = static_cast<char>((h0 >> (24 - i * 8)) & 0xFF);
  4559. hash[4 + i] = static_cast<char>((h1 >> (24 - i * 8)) & 0xFF);
  4560. hash[8 + i] = static_cast<char>((h2 >> (24 - i * 8)) & 0xFF);
  4561. hash[12 + i] = static_cast<char>((h3 >> (24 - i * 8)) & 0xFF);
  4562. hash[16 + i] = static_cast<char>((h4 >> (24 - i * 8)) & 0xFF);
  4563. }
  4564. return hash;
  4565. }
  4566. inline std::string websocket_accept_key(const std::string &client_key) {
  4567. const std::string magic = "258EAFA5-E914-47DA-95CA-C5AB0DC85B11";
  4568. return base64_encode(sha1(client_key + magic));
  4569. }
  4570. inline bool is_websocket_upgrade(const Request &req) {
  4571. if (req.method != "GET") { return false; }
  4572. // Check Upgrade: websocket. RFC 9110 7.8 defines Upgrade as a comma-separated
  4573. // list of protocols and asks recipients to match each name
  4574. // case-insensitively, so look for the token rather than compare the whole
  4575. // field value.
  4576. if (!has_header_token(req.headers, "Upgrade", "websocket")) { return false; }
  4577. // Check Connection: Upgrade
  4578. if (!has_header_token(req.headers, "Connection", "upgrade")) { return false; }
  4579. // Check Sec-WebSocket-Key is a valid base64-encoded 16-byte value (24 chars)
  4580. // RFC 6455 Section 4.2.1
  4581. auto ws_key = req.get_header_value("Sec-WebSocket-Key");
  4582. if (ws_key.size() != 24 || ws_key[22] != '=' || ws_key[23] != '=') {
  4583. return false;
  4584. }
  4585. static const std::string b64chars =
  4586. "ABCDEFGHIJKLMNOPQRSTUVWXYZabcdefghijklmnopqrstuvwxyz0123456789+/";
  4587. for (size_t i = 0; i < 22; i++) {
  4588. if (b64chars.find(ws_key[i]) == std::string::npos) { return false; }
  4589. }
  4590. // Check Sec-WebSocket-Version: 13
  4591. auto version = req.get_header_value("Sec-WebSocket-Version");
  4592. if (version != "13") { return false; }
  4593. return true;
  4594. }
  4595. inline bool write_websocket_frame(Stream &strm, ws::Opcode opcode,
  4596. const char *data, size_t len, bool fin,
  4597. bool mask) {
  4598. // First byte: FIN + opcode
  4599. uint8_t header[2];
  4600. header[0] = static_cast<uint8_t>((fin ? 0x80 : 0x00) |
  4601. (static_cast<uint8_t>(opcode) & 0x0F));
  4602. // Second byte: MASK + payload length
  4603. if (len < 126) {
  4604. header[1] = static_cast<uint8_t>(len);
  4605. if (mask) { header[1] |= 0x80; }
  4606. if (strm.write(reinterpret_cast<char *>(header), 2) < 0) { return false; }
  4607. } else if (len <= 0xFFFF) {
  4608. header[1] = 126;
  4609. if (mask) { header[1] |= 0x80; }
  4610. if (strm.write(reinterpret_cast<char *>(header), 2) < 0) { return false; }
  4611. uint8_t ext[2];
  4612. ext[0] = static_cast<uint8_t>((len >> 8) & 0xFF);
  4613. ext[1] = static_cast<uint8_t>(len & 0xFF);
  4614. if (strm.write(reinterpret_cast<char *>(ext), 2) < 0) { return false; }
  4615. } else {
  4616. header[1] = 127;
  4617. if (mask) { header[1] |= 0x80; }
  4618. if (strm.write(reinterpret_cast<char *>(header), 2) < 0) { return false; }
  4619. uint8_t ext[8];
  4620. for (int i = 7; i >= 0; i--) {
  4621. ext[7 - i] =
  4622. static_cast<uint8_t>((static_cast<uint64_t>(len) >> (i * 8)) & 0xFF);
  4623. }
  4624. if (strm.write(reinterpret_cast<char *>(ext), 8) < 0) { return false; }
  4625. }
  4626. if (mask) {
  4627. // Generate random mask key
  4628. thread_local std::mt19937 rng(std::random_device{}());
  4629. uint8_t mask_key[4];
  4630. auto r = rng();
  4631. std::memcpy(mask_key, &r, 4);
  4632. if (strm.write(reinterpret_cast<char *>(mask_key), 4) < 0) { return false; }
  4633. // Write masked payload in chunks
  4634. const size_t chunk_size = 4096;
  4635. std::vector<char> buf((std::min)(len, chunk_size));
  4636. for (size_t offset = 0; offset < len; offset += chunk_size) {
  4637. size_t n = (std::min)(chunk_size, len - offset);
  4638. for (size_t i = 0; i < n; i++) {
  4639. buf[i] =
  4640. data[offset + i] ^ static_cast<char>(mask_key[(offset + i) % 4]);
  4641. }
  4642. if (strm.write(buf.data(), n) < 0) { return false; }
  4643. }
  4644. } else {
  4645. if (len > 0) {
  4646. if (strm.write(data, len) < 0) { return false; }
  4647. }
  4648. }
  4649. return true;
  4650. }
  4651. } // namespace detail
  4652. namespace ws {
  4653. namespace impl {
  4654. // Read exactly `size` bytes. Stream::read may return less than asked for -- it
  4655. // hands back whatever its buffer already holds -- so every multi-byte field has
  4656. // to loop. Reading a 2-byte header with a single read() fails whenever the
  4657. // header straddles the read buffer's boundary.
  4658. //
  4659. // Timeout is reported only when nothing at all was consumed. Once a byte has
  4660. // been taken the stream sits mid-field and cannot be resumed, so a timeout
  4661. // there is a failure like any other. (When read() fails it always records why,
  4662. // so the error belongs to this call and not to an earlier one.)
  4663. inline FrameRead read_exact(Stream &strm, void *buf, size_t size) {
  4664. auto p = static_cast<char *>(buf);
  4665. size_t total = 0;
  4666. while (total < size) {
  4667. auto n = strm.read(p + total, size - total);
  4668. if (n <= 0) {
  4669. auto timed_out = total == 0 && strm.get_error() == Error::Timeout;
  4670. return timed_out ? FrameRead::Timeout : FrameRead::Fail;
  4671. }
  4672. total += static_cast<size_t>(n);
  4673. }
  4674. return FrameRead::Ok;
  4675. }
  4676. inline FrameRead read_websocket_frame(Stream &strm, Opcode &opcode,
  4677. std::string &payload, bool &fin,
  4678. bool expect_masked, size_t max_len) {
  4679. // Read first 2 bytes. This is the only read that may report a timeout: it
  4680. // sits on a frame boundary, where nothing has been consumed yet.
  4681. uint8_t header[2];
  4682. FrameRead first = read_exact(strm, header, 2);
  4683. if (first != FrameRead::Ok) { return first; }
  4684. fin = (header[0] & 0x80) != 0;
  4685. // RSV1, RSV2, RSV3 must be 0 when no extension is negotiated
  4686. if (header[0] & 0x70) { return FrameRead::Fail; }
  4687. opcode = static_cast<Opcode>(header[0] & 0x0F);
  4688. bool masked = (header[1] & 0x80) != 0;
  4689. uint64_t payload_len = header[1] & 0x7F;
  4690. // RFC 6455 Section 5.5: control frames MUST NOT be fragmented and
  4691. // MUST have a payload length of 125 bytes or less
  4692. bool is_control = (static_cast<uint8_t>(opcode) & 0x08) != 0;
  4693. if (is_control) {
  4694. if (!fin) { return FrameRead::Fail; }
  4695. if (payload_len > 125) { return FrameRead::Fail; }
  4696. }
  4697. if (masked != expect_masked) { return FrameRead::Fail; }
  4698. // Extended payload length
  4699. if (payload_len == 126) {
  4700. uint8_t ext[2];
  4701. if (read_exact(strm, ext, 2) != FrameRead::Ok) { return FrameRead::Fail; }
  4702. payload_len = (static_cast<uint64_t>(ext[0]) << 8) | ext[1];
  4703. } else if (payload_len == 127) {
  4704. uint8_t ext[8];
  4705. if (read_exact(strm, ext, 8) != FrameRead::Ok) { return FrameRead::Fail; }
  4706. // RFC 6455 Section 5.2: the most significant bit MUST be 0
  4707. if (ext[0] & 0x80) { return FrameRead::Fail; }
  4708. payload_len = 0;
  4709. for (int i = 0; i < 8; i++) {
  4710. payload_len = (payload_len << 8) | ext[i];
  4711. }
  4712. }
  4713. if (payload_len > max_len) { return FrameRead::Fail; }
  4714. // Read mask key if present
  4715. uint8_t mask_key[4] = {0};
  4716. if (masked) {
  4717. if (read_exact(strm, mask_key, 4) != FrameRead::Ok) {
  4718. return FrameRead::Fail;
  4719. }
  4720. }
  4721. // Read payload
  4722. payload.resize(static_cast<size_t>(payload_len));
  4723. if (payload_len > 0 &&
  4724. read_exact(strm, &payload[0], static_cast<size_t>(payload_len)) !=
  4725. FrameRead::Ok) {
  4726. return FrameRead::Fail;
  4727. }
  4728. // Unmask if needed
  4729. if (masked) {
  4730. for (size_t i = 0; i < payload.size(); i++) {
  4731. payload[i] ^= static_cast<char>(mask_key[i % 4]);
  4732. }
  4733. }
  4734. return FrameRead::Ok;
  4735. }
  4736. } // namespace impl
  4737. } // namespace ws
  4738. namespace detail {
  4739. inline bool is_valid_path(const std::string &path) {
  4740. size_t level = 0;
  4741. size_t i = 0;
  4742. // Skip slash
  4743. while (i < path.size() && path[i] == '/') {
  4744. i++;
  4745. }
  4746. while (i < path.size()) {
  4747. // Read component
  4748. auto beg = i;
  4749. while (i < path.size() && path[i] != '/') {
  4750. if (path[i] == '\0') {
  4751. return false;
  4752. } else if (path[i] == '\\') {
  4753. return false;
  4754. }
  4755. i++;
  4756. }
  4757. auto len = i - beg;
  4758. assert(len > 0);
  4759. if (!path.compare(beg, len, ".")) {
  4760. ;
  4761. } else if (!path.compare(beg, len, "..")) {
  4762. if (level == 0) { return false; }
  4763. level--;
  4764. } else {
  4765. level++;
  4766. }
  4767. // Skip slash
  4768. while (i < path.size() && path[i] == '/') {
  4769. i++;
  4770. }
  4771. }
  4772. return true;
  4773. }
  4774. inline bool canonicalize_path(const char *path, std::string &resolved) {
  4775. #if defined(_WIN32)
  4776. char buf[_MAX_PATH];
  4777. if (_fullpath(buf, path, _MAX_PATH) == nullptr) { return false; }
  4778. resolved = buf;
  4779. #elif defined(PATH_MAX)
  4780. char buf[PATH_MAX];
  4781. if (realpath(path, buf) == nullptr) { return false; }
  4782. resolved = buf;
  4783. #else
  4784. auto buf = realpath(path, nullptr);
  4785. auto guard = scope_exit([&]() { std::free(buf); });
  4786. if (buf == nullptr) { return false; }
  4787. resolved = buf;
  4788. #endif
  4789. return true;
  4790. }
  4791. inline bool is_path_within_base(const std::string &resolved_path,
  4792. const std::string &resolved_base) {
  4793. #if defined(_WIN32)
  4794. return _strnicmp(resolved_path.c_str(), resolved_base.c_str(),
  4795. resolved_base.size()) == 0;
  4796. #else
  4797. return strncmp(resolved_path.c_str(), resolved_base.c_str(),
  4798. resolved_base.size()) == 0;
  4799. #endif
  4800. }
  4801. inline FileStat::FileStat(const std::string &path) {
  4802. #if defined(_WIN32)
  4803. auto wpath = u8string_to_wstring(path.c_str());
  4804. ret_ = _wstat(wpath.c_str(), &st_);
  4805. #else
  4806. ret_ = stat(path.c_str(), &st_);
  4807. #endif
  4808. }
  4809. inline bool FileStat::is_file() const {
  4810. return ret_ >= 0 && S_ISREG(st_.st_mode);
  4811. }
  4812. inline bool FileStat::is_dir() const {
  4813. return ret_ >= 0 && S_ISDIR(st_.st_mode);
  4814. }
  4815. inline time_t FileStat::mtime() const {
  4816. return ret_ >= 0 ? static_cast<time_t>(st_.st_mtime)
  4817. : static_cast<time_t>(-1);
  4818. }
  4819. inline size_t FileStat::size() const {
  4820. return ret_ >= 0 ? static_cast<size_t>(st_.st_size) : 0;
  4821. }
  4822. inline std::string encode_path(const std::string &s) {
  4823. std::string result;
  4824. result.reserve(s.size());
  4825. for (size_t i = 0; s[i]; i++) {
  4826. switch (s[i]) {
  4827. case ' ': result += "%20"; break;
  4828. case '+': result += "%2B"; break;
  4829. case '\'': result += "%27"; break;
  4830. case ',': result += "%2C"; break;
  4831. // case ':': result += "%3A"; break; // ok? probably...
  4832. case ';': result += "%3B"; break;
  4833. default:
  4834. auto c = static_cast<uint8_t>(s[i]);
  4835. // Control characters (incl. CR/LF) and non-ASCII bytes are not allowed
  4836. // in a request-target as-is.
  4837. if (c < 0x20 || c == 0x7f || c >= 0x80) {
  4838. result += '%';
  4839. char hex[4];
  4840. auto len = snprintf(hex, sizeof(hex) - 1, "%02X", c);
  4841. assert(len == 2);
  4842. result.append(hex, static_cast<size_t>(len));
  4843. } else {
  4844. result += s[i];
  4845. }
  4846. break;
  4847. }
  4848. }
  4849. return result;
  4850. }
  4851. inline std::string file_extension(const std::string &path) {
  4852. std::smatch m;
  4853. thread_local auto re = std::regex("\\.([a-zA-Z0-9]+)$");
  4854. if (std::regex_search(path, m, re)) { return m[1].str(); }
  4855. return std::string();
  4856. }
  4857. inline bool is_space_or_tab(char c) { return c == ' ' || c == '\t'; }
  4858. template <typename T>
  4859. inline bool parse_header(const char *beg, const char *end, T fn);
  4860. template <typename T>
  4861. inline bool parse_header(const char *beg, const char *end, T fn) {
  4862. // Skip trailing spaces and tabs.
  4863. while (beg < end && is_space_or_tab(end[-1])) {
  4864. end--;
  4865. }
  4866. auto p = beg;
  4867. while (p < end && *p != ':') {
  4868. p++;
  4869. }
  4870. auto name = std::string(beg, p);
  4871. if (!detail::fields::is_field_name(name)) { return false; }
  4872. if (p == end) { return false; }
  4873. auto key_end = p;
  4874. if (*p++ != ':') { return false; }
  4875. while (p < end && is_space_or_tab(*p)) {
  4876. p++;
  4877. }
  4878. if (p <= end) {
  4879. auto key_len = key_end - beg;
  4880. if (!key_len) { return false; }
  4881. auto key = std::string(beg, key_end);
  4882. auto val = std::string(p, end);
  4883. if (!detail::fields::is_field_value(val)) { return false; }
  4884. // RFC 9110 §5.5: header field values are opaque octets and MUST NOT be
  4885. // percent-decoded by the recipient. Applications that need to interpret a
  4886. // value as a URI component should call httplib::decode_uri_component()
  4887. // (or decode_path_component()) explicitly.
  4888. fn(key, val);
  4889. return true;
  4890. }
  4891. return false;
  4892. }
  4893. inline bool parse_trailers(stream_line_reader &line_reader, Headers &dest,
  4894. const Headers &src_headers) {
  4895. // NOTE: In RFC 9112, '7.1 Chunked Transfer Coding' mentions "The chunked
  4896. // transfer coding is complete when a chunk with a chunk-size of zero is
  4897. // received, possibly followed by a trailer section, and finally terminated by
  4898. // an empty line". https://www.rfc-editor.org/rfc/rfc9112.html#section-7.1
  4899. //
  4900. // In '7.1.3. Decoding Chunked', however, the pseudo-code in the section
  4901. // doesn't care for the existence of the final CRLF. In other words, it seems
  4902. // to be ok whether the final CRLF exists or not in the chunked data.
  4903. // https://www.rfc-editor.org/rfc/rfc9112.html#section-7.1.3
  4904. //
  4905. // According to the reference code in RFC 9112, cpp-httplib now allows
  4906. // chunked transfer coding data without the final CRLF.
  4907. // RFC 7230 Section 4.1.2 - Headers prohibited in trailers
  4908. thread_local case_ignore::unordered_set<std::string> prohibited_trailers = {
  4909. "transfer-encoding",
  4910. "content-length",
  4911. "host",
  4912. "authorization",
  4913. "www-authenticate",
  4914. "proxy-authenticate",
  4915. "proxy-authorization",
  4916. "cookie",
  4917. "set-cookie",
  4918. "cache-control",
  4919. "expect",
  4920. "max-forwards",
  4921. "pragma",
  4922. "range",
  4923. "te",
  4924. "age",
  4925. "expires",
  4926. "date",
  4927. "location",
  4928. "retry-after",
  4929. "vary",
  4930. "warning",
  4931. "content-encoding",
  4932. "content-type",
  4933. "content-range",
  4934. "trailer"};
  4935. case_ignore::unordered_set<std::string> declared_trailers;
  4936. auto trailer_header = get_combined_header_value(src_headers, "Trailer");
  4937. if (!trailer_header.empty()) {
  4938. // split() trims each token and skips empty ones, so the name arrives ready
  4939. // to look up.
  4940. split(trailer_header.data(), trailer_header.data() + trailer_header.size(),
  4941. ',', [&](const char *b, const char *e) {
  4942. // A legitimate message declares only a handful of trailers. Cap the
  4943. // set so a peer cannot grow it without bound: an oversized set only
  4944. // arises from an attempt to force many colliding names into
  4945. // quadratic lookups (case_ignore::hash is unkeyed).
  4946. if (declared_trailers.size() >= CPPHTTPLIB_HEADER_MAX_COUNT) {
  4947. return;
  4948. }
  4949. std::string key(b, e);
  4950. if (prohibited_trailers.find(key) == prohibited_trailers.end()) {
  4951. declared_trailers.insert(key);
  4952. }
  4953. });
  4954. }
  4955. size_t trailer_header_count = 0;
  4956. while (strcmp(line_reader.ptr(), "\r\n") != 0) {
  4957. if (line_reader.size() > CPPHTTPLIB_HEADER_MAX_LENGTH) { return false; }
  4958. // Count every received trailer field, not only the declared ones stored in
  4959. // dest, so undeclared fields cannot keep this loop running past the limit.
  4960. if (trailer_header_count >= CPPHTTPLIB_HEADER_MAX_COUNT) { return false; }
  4961. constexpr auto line_terminator_len = 2;
  4962. auto line_beg = line_reader.ptr();
  4963. auto line_end =
  4964. line_reader.ptr() + line_reader.size() - line_terminator_len;
  4965. if (!parse_header(line_beg, line_end,
  4966. [&](const std::string &key, const std::string &val) {
  4967. if (declared_trailers.find(key) !=
  4968. declared_trailers.end()) {
  4969. dest.emplace(key, val);
  4970. }
  4971. })) {
  4972. return false;
  4973. }
  4974. trailer_header_count++;
  4975. if (!line_reader.getline()) { return false; }
  4976. }
  4977. return true;
  4978. }
  4979. inline std::pair<size_t, size_t> trim(const char *b, const char *e, size_t left,
  4980. size_t right) {
  4981. while (b + left < e && is_space_or_tab(b[left])) {
  4982. left++;
  4983. }
  4984. while (right > 0 && is_space_or_tab(b[right - 1])) {
  4985. right--;
  4986. }
  4987. return std::make_pair(left, right);
  4988. }
  4989. inline std::string trim_copy(const std::string &s) {
  4990. auto r = trim(s.data(), s.data() + s.size(), 0, s.size());
  4991. return s.substr(r.first, r.second - r.first);
  4992. }
  4993. inline std::string trim_double_quotes_copy(const std::string &s) {
  4994. if (s.length() >= 2 && s.front() == '"' && s.back() == '"') {
  4995. return s.substr(1, s.size() - 2);
  4996. }
  4997. return s;
  4998. }
  4999. inline void
  5000. divide(const char *data, std::size_t size, char d,
  5001. std::function<void(const char *, std::size_t, const char *, std::size_t)>
  5002. fn) {
  5003. const auto it = std::find(data, data + size, d);
  5004. const auto found = static_cast<std::size_t>(it != data + size);
  5005. const auto lhs_data = data;
  5006. const auto lhs_size = static_cast<std::size_t>(it - data);
  5007. const auto rhs_data = it + found;
  5008. const auto rhs_size = size - lhs_size - found;
  5009. fn(lhs_data, lhs_size, rhs_data, rhs_size);
  5010. }
  5011. inline void
  5012. divide(const std::string &str, char d,
  5013. std::function<void(const char *, std::size_t, const char *, std::size_t)>
  5014. fn) {
  5015. divide(str.data(), str.size(), d, std::move(fn));
  5016. }
  5017. inline void split(const char *b, const char *e, char d,
  5018. std::function<void(const char *, const char *)> fn) {
  5019. return split(b, e, d, (std::numeric_limits<size_t>::max)(), std::move(fn));
  5020. }
  5021. inline void split(const char *b, const char *e, char d, size_t m,
  5022. std::function<void(const char *, const char *)> fn) {
  5023. size_t i = 0;
  5024. size_t beg = 0;
  5025. size_t count = 1;
  5026. while (e ? (b + i < e) : (b[i] != '\0')) {
  5027. if (b[i] == d && count < m) {
  5028. auto r = trim(b, e, beg, i);
  5029. if (r.first < r.second) { fn(&b[r.first], &b[r.second]); }
  5030. beg = i + 1;
  5031. count++;
  5032. }
  5033. i++;
  5034. }
  5035. if (i) {
  5036. auto r = trim(b, e, beg, i);
  5037. if (r.first < r.second) { fn(&b[r.first], &b[r.second]); }
  5038. }
  5039. }
  5040. // Same contract as split(), except that a delimiter inside a quoted-string is
  5041. // not a delimiter. RFC 9110 Section 5.6.6 lets a parameter value be a
  5042. // quoted-string, and ';' and '=' are legal characters inside one.
  5043. inline void split_unquoted(const char *b, const char *e, char d, size_t m,
  5044. std::function<void(const char *, const char *)> fn) {
  5045. size_t i = 0;
  5046. size_t beg = 0;
  5047. size_t count = 1;
  5048. auto in_quotes = false;
  5049. while (e ? (b + i < e) : (b[i] != '\0')) {
  5050. if (b[i] == '"') {
  5051. in_quotes = !in_quotes;
  5052. } else if (b[i] == d && !in_quotes && count < m) {
  5053. auto r = trim(b, e, beg, i);
  5054. if (r.first < r.second) { fn(&b[r.first], &b[r.second]); }
  5055. beg = i + 1;
  5056. count++;
  5057. }
  5058. i++;
  5059. }
  5060. if (i) {
  5061. auto r = trim(b, e, beg, i);
  5062. if (r.first < r.second) { fn(&b[r.first], &b[r.second]); }
  5063. }
  5064. }
  5065. inline void split_unquoted(const char *b, const char *e, char d,
  5066. std::function<void(const char *, const char *)> fn) {
  5067. return split_unquoted(b, e, d, (std::numeric_limits<size_t>::max)(),
  5068. std::move(fn));
  5069. }
  5070. // Divide a header parameter at its first '='. RFC 9110 Section 5.6.6 makes the
  5071. // key a token, so the first '=' is the separator even when the value is a
  5072. // quoted-string carrying more of them.
  5073. inline void divide_param_pair(const char *b, const char *e, std::string &key,
  5074. std::string &val) {
  5075. divide(
  5076. b, static_cast<std::size_t>(e - b), '=',
  5077. [&](const char *kb, std::size_t klen, const char *vb, std::size_t vlen) {
  5078. const auto kr = trim(kb, kb + klen, 0, klen);
  5079. key.assign(kb + kr.first, kb + kr.second);
  5080. const auto vr = trim(vb, vb + vlen, 0, vlen);
  5081. val.assign(vb + vr.first, vb + vr.second);
  5082. });
  5083. }
  5084. inline bool split_find(const char *b, const char *e, char d, size_t m,
  5085. std::function<bool(const char *, const char *)> fn) {
  5086. size_t i = 0;
  5087. size_t beg = 0;
  5088. size_t count = 1;
  5089. while (e ? (b + i < e) : (b[i] != '\0')) {
  5090. if (b[i] == d && count < m) {
  5091. auto r = trim(b, e, beg, i);
  5092. if (r.first < r.second) {
  5093. auto found = fn(&b[r.first], &b[r.second]);
  5094. if (found) { return true; }
  5095. }
  5096. beg = i + 1;
  5097. count++;
  5098. }
  5099. i++;
  5100. }
  5101. if (i) {
  5102. auto r = trim(b, e, beg, i);
  5103. if (r.first < r.second) {
  5104. auto found = fn(&b[r.first], &b[r.second]);
  5105. if (found) { return true; }
  5106. }
  5107. }
  5108. return false;
  5109. }
  5110. inline bool split_find(const char *b, const char *e, char d,
  5111. std::function<bool(const char *, const char *)> fn) {
  5112. return split_find(b, e, d, (std::numeric_limits<size_t>::max)(),
  5113. std::move(fn));
  5114. }
  5115. inline stream_line_reader::stream_line_reader(Stream &strm, char *fixed_buffer,
  5116. size_t fixed_buffer_size)
  5117. : strm_(strm), fixed_buffer_(fixed_buffer),
  5118. fixed_buffer_size_(fixed_buffer_size) {}
  5119. inline const char *stream_line_reader::ptr() const {
  5120. if (growable_buffer_.empty()) {
  5121. return fixed_buffer_;
  5122. } else {
  5123. return growable_buffer_.data();
  5124. }
  5125. }
  5126. inline size_t stream_line_reader::size() const {
  5127. if (growable_buffer_.empty()) {
  5128. return fixed_buffer_used_size_;
  5129. } else {
  5130. return growable_buffer_.size();
  5131. }
  5132. }
  5133. inline bool stream_line_reader::end_with_crlf() const {
  5134. auto end = ptr() + size();
  5135. return size() >= 2 && end[-2] == '\r' && end[-1] == '\n';
  5136. }
  5137. inline bool stream_line_reader::getline() {
  5138. fixed_buffer_used_size_ = 0;
  5139. growable_buffer_.clear();
  5140. #ifndef CPPHTTPLIB_ALLOW_LF_AS_LINE_TERMINATOR
  5141. char prev_byte = 0;
  5142. #endif
  5143. for (size_t i = 0;; i++) {
  5144. // Fast path: whatever the stream has already buffered can be scanned for
  5145. // the terminator in one pass. Asking for a byte at a time costs a virtual
  5146. // call, a bounds check and a one-byte copy per character of the request.
  5147. size_t buffered_size = 0;
  5148. if (auto buffered = strm_.buffered_data(buffered_size)) {
  5149. auto take = buffered_size;
  5150. auto terminated = false;
  5151. for (size_t at = 0; at < buffered_size;) {
  5152. auto nl = static_cast<const char *>(
  5153. memchr(buffered + at, '\n', buffered_size - at));
  5154. if (!nl) { break; }
  5155. auto pos = static_cast<size_t>(nl - buffered);
  5156. #ifdef CPPHTTPLIB_ALLOW_LF_AS_LINE_TERMINATOR
  5157. take = pos + 1;
  5158. terminated = true;
  5159. break;
  5160. #else
  5161. // A bare LF does not end the line; keep looking for CRLF. The CR may
  5162. // be the last byte of an earlier chunk, hence prev_byte.
  5163. if ((pos > 0 ? buffered[pos - 1] : prev_byte) == '\r') {
  5164. take = pos + 1;
  5165. terminated = true;
  5166. break;
  5167. }
  5168. at = pos + 1;
  5169. #endif
  5170. }
  5171. if (size() + take > CPPHTTPLIB_MAX_LINE_LENGTH) { return false; }
  5172. #ifndef CPPHTTPLIB_ALLOW_LF_AS_LINE_TERMINATOR
  5173. prev_byte = buffered[take - 1];
  5174. #endif
  5175. append(buffered, take);
  5176. strm_.consume_buffered(take);
  5177. i += take;
  5178. if (terminated) { return true; }
  5179. continue;
  5180. }
  5181. if (size() >= CPPHTTPLIB_MAX_LINE_LENGTH) {
  5182. // Treat exceptionally long lines as an error to
  5183. // prevent infinite loops/memory exhaustion
  5184. return false;
  5185. }
  5186. char byte;
  5187. auto n = strm_.read(&byte, 1);
  5188. if (n < 0) {
  5189. return false;
  5190. } else if (n == 0) {
  5191. if (i == 0) {
  5192. return false;
  5193. } else {
  5194. break;
  5195. }
  5196. }
  5197. append(byte);
  5198. #ifdef CPPHTTPLIB_ALLOW_LF_AS_LINE_TERMINATOR
  5199. if (byte == '\n') { break; }
  5200. #else
  5201. if (prev_byte == '\r' && byte == '\n') { break; }
  5202. prev_byte = byte;
  5203. #endif
  5204. }
  5205. return true;
  5206. }
  5207. inline void stream_line_reader::append(char c) { append(&c, 1); }
  5208. inline void stream_line_reader::append(const char *data, size_t size) {
  5209. // Once the line has outgrown the fixed buffer everything must keep going to
  5210. // the growable one, even if a later chunk would have fit. Without the
  5211. // emptiness check a short append after a long one would land in the fixed
  5212. // buffer, which ptr() and size() no longer look at, and be lost.
  5213. if (growable_buffer_.empty() &&
  5214. fixed_buffer_used_size_ + size < fixed_buffer_size_) {
  5215. memcpy(fixed_buffer_ + fixed_buffer_used_size_, data, size);
  5216. fixed_buffer_used_size_ += size;
  5217. fixed_buffer_[fixed_buffer_used_size_] = '\0';
  5218. } else {
  5219. // Unlike the per-character overload, this can be the very first append of
  5220. // the line, so the fixed buffer may hold nothing and carry no terminator
  5221. // yet. assign() takes an explicit length and does not need one.
  5222. if (growable_buffer_.empty()) {
  5223. growable_buffer_.assign(fixed_buffer_, fixed_buffer_used_size_);
  5224. }
  5225. growable_buffer_.append(data, size);
  5226. }
  5227. }
  5228. inline mmap::mmap(const char *path) { open(path); }
  5229. inline mmap::~mmap() { close(); }
  5230. inline bool mmap::open(const char *path) {
  5231. close();
  5232. #if defined(_WIN32)
  5233. auto wpath = u8string_to_wstring(path);
  5234. if (wpath.empty()) { return false; }
  5235. hFile_ =
  5236. ::CreateFile2(wpath.c_str(), GENERIC_READ,
  5237. FILE_SHARE_READ | FILE_SHARE_WRITE, OPEN_EXISTING, NULL);
  5238. if (hFile_ == INVALID_HANDLE_VALUE) { return false; }
  5239. LARGE_INTEGER size{};
  5240. if (!::GetFileSizeEx(hFile_, &size)) { return false; }
  5241. // If the following line doesn't compile due to QuadPart, update Windows SDK.
  5242. // See:
  5243. // https://github.com/yhirose/cpp-httplib/issues/1903#issuecomment-2316520721
  5244. if (static_cast<ULONGLONG>(size.QuadPart) >
  5245. (std::numeric_limits<decltype(size_)>::max)()) {
  5246. // `size_t` might be 32-bits, on 32-bits Windows.
  5247. return false;
  5248. }
  5249. size_ = static_cast<size_t>(size.QuadPart);
  5250. hMapping_ =
  5251. ::CreateFileMappingFromApp(hFile_, NULL, PAGE_READONLY, size_, NULL);
  5252. // Special treatment for an empty file...
  5253. if (hMapping_ == NULL && size_ == 0) {
  5254. close();
  5255. is_open_empty_file = true;
  5256. return true;
  5257. }
  5258. if (hMapping_ == NULL) {
  5259. close();
  5260. return false;
  5261. }
  5262. addr_ = ::MapViewOfFileFromApp(hMapping_, FILE_MAP_READ, 0, 0);
  5263. if (addr_ == nullptr) {
  5264. close();
  5265. return false;
  5266. }
  5267. #else
  5268. fd_ = ::open(path, O_RDONLY);
  5269. if (fd_ == -1) { return false; }
  5270. struct stat sb;
  5271. if (fstat(fd_, &sb) == -1) {
  5272. close();
  5273. return false;
  5274. }
  5275. size_ = static_cast<size_t>(sb.st_size);
  5276. addr_ = ::mmap(NULL, size_, PROT_READ, MAP_PRIVATE, fd_, 0);
  5277. // Special treatment for an empty file...
  5278. if (addr_ == MAP_FAILED && size_ == 0) {
  5279. close();
  5280. is_open_empty_file = true;
  5281. return false;
  5282. }
  5283. if (addr_ == MAP_FAILED) {
  5284. // Clear the sentinel before `close()`, since `is_open()` only checks
  5285. // `addr_` against nullptr and `munmap()` must not be called with it.
  5286. addr_ = nullptr;
  5287. close();
  5288. return false;
  5289. }
  5290. #endif
  5291. return true;
  5292. }
  5293. inline bool mmap::is_open() const {
  5294. return is_open_empty_file ? true : addr_ != nullptr;
  5295. }
  5296. inline size_t mmap::size() const { return size_; }
  5297. inline const char *mmap::data() const {
  5298. return is_open_empty_file ? "" : static_cast<const char *>(addr_);
  5299. }
  5300. inline void mmap::close() {
  5301. #if defined(_WIN32)
  5302. if (addr_) {
  5303. ::UnmapViewOfFile(addr_);
  5304. addr_ = nullptr;
  5305. }
  5306. if (hMapping_) {
  5307. ::CloseHandle(hMapping_);
  5308. hMapping_ = NULL;
  5309. }
  5310. if (hFile_ != INVALID_HANDLE_VALUE) {
  5311. ::CloseHandle(hFile_);
  5312. hFile_ = INVALID_HANDLE_VALUE;
  5313. }
  5314. is_open_empty_file = false;
  5315. #else
  5316. if (addr_ != nullptr) {
  5317. munmap(addr_, size_);
  5318. addr_ = nullptr;
  5319. }
  5320. if (fd_ != -1) {
  5321. ::close(fd_);
  5322. fd_ = -1;
  5323. }
  5324. #endif
  5325. size_ = 0;
  5326. }
  5327. inline int close_socket(socket_t sock) noexcept {
  5328. #ifdef _WIN32
  5329. return closesocket(sock);
  5330. #else
  5331. return close(sock);
  5332. #endif
  5333. }
  5334. template <typename T> inline ssize_t handle_EINTR(T fn) {
  5335. ssize_t res = 0;
  5336. while (true) {
  5337. res = fn();
  5338. if (res < 0 && errno == EINTR) {
  5339. std::this_thread::sleep_for(std::chrono::microseconds{1});
  5340. continue;
  5341. }
  5342. break;
  5343. }
  5344. return res;
  5345. }
  5346. inline ssize_t read_socket(socket_t sock, void *ptr, size_t size, int flags) {
  5347. return handle_EINTR([&]() {
  5348. return recv(sock,
  5349. #ifdef _WIN32
  5350. static_cast<char *>(ptr), static_cast<int>(size),
  5351. #else
  5352. ptr, size,
  5353. #endif
  5354. flags);
  5355. });
  5356. }
  5357. inline ssize_t send_socket(socket_t sock, const void *ptr, size_t size,
  5358. int flags) {
  5359. return handle_EINTR([&]() {
  5360. return send(sock,
  5361. #ifdef _WIN32
  5362. static_cast<const char *>(ptr), static_cast<int>(size),
  5363. #else
  5364. ptr, size,
  5365. #endif
  5366. flags);
  5367. });
  5368. }
  5369. inline int poll_wrapper(struct pollfd *fds, nfds_t nfds, int timeout) {
  5370. #ifdef _WIN32
  5371. return ::WSAPoll(fds, nfds, timeout);
  5372. #else
  5373. return ::poll(fds, nfds, timeout);
  5374. #endif
  5375. }
  5376. inline ssize_t select_impl(socket_t sock, short events, time_t sec,
  5377. time_t usec) {
  5378. struct pollfd pfd;
  5379. pfd.fd = sock;
  5380. pfd.events = events;
  5381. pfd.revents = 0;
  5382. // A negative timeout waits forever, poll's own convention. 0 keeps meaning
  5383. // "return immediately", which callers here rely on to probe a socket.
  5384. auto timeout = sec < 0 ? -1 : static_cast<int>(sec * 1000 + usec / 1000);
  5385. return handle_EINTR([&]() { return poll_wrapper(&pfd, 1, timeout); });
  5386. }
  5387. inline ssize_t select_read(socket_t sock, time_t sec, time_t usec) {
  5388. return select_impl(sock, POLLIN, sec, usec);
  5389. }
  5390. inline ssize_t select_write(socket_t sock, time_t sec, time_t usec) {
  5391. return select_impl(sock, POLLOUT, sec, usec);
  5392. }
  5393. inline Error wait_until_socket_is_ready(socket_t sock, time_t sec,
  5394. time_t usec) {
  5395. struct pollfd pfd_read;
  5396. pfd_read.fd = sock;
  5397. pfd_read.events = POLLIN | POLLOUT;
  5398. pfd_read.revents = 0;
  5399. auto timeout = static_cast<int>(sec * 1000 + usec / 1000);
  5400. auto poll_res =
  5401. handle_EINTR([&]() { return poll_wrapper(&pfd_read, 1, timeout); });
  5402. if (poll_res == 0) { return Error::ConnectionTimeout; }
  5403. if (poll_res > 0 && pfd_read.revents & (POLLIN | POLLOUT)) {
  5404. auto error = 0;
  5405. socklen_t len = sizeof(error);
  5406. auto res = getsockopt(sock, SOL_SOCKET, SO_ERROR,
  5407. reinterpret_cast<char *>(&error), &len);
  5408. auto successful = res >= 0 && !error;
  5409. return successful ? Error::Success : Error::Connection;
  5410. }
  5411. return Error::Connection;
  5412. }
  5413. inline bool is_socket_alive(socket_t sock) {
  5414. const auto val = detail::select_read(sock, 0, 0);
  5415. if (val == 0) {
  5416. return true;
  5417. } else if (val < 0 && errno == EBADF) {
  5418. return false;
  5419. }
  5420. char buf[1];
  5421. return detail::read_socket(sock, &buf[0], sizeof(buf), MSG_PEEK) > 0;
  5422. }
  5423. class SocketStream final : public Stream {
  5424. public:
  5425. SocketStream(socket_t sock, time_t read_timeout_sec, time_t read_timeout_usec,
  5426. time_t write_timeout_sec, time_t write_timeout_usec,
  5427. time_t max_timeout_msec = 0,
  5428. std::chrono::time_point<std::chrono::steady_clock> start_time =
  5429. (std::chrono::steady_clock::time_point::min)());
  5430. ~SocketStream() override;
  5431. bool is_readable() const override;
  5432. bool wait_readable() const override;
  5433. bool wait_writable() const override;
  5434. bool is_peer_alive() const override;
  5435. ssize_t read(char *ptr, size_t size) override;
  5436. ssize_t write(const char *ptr, size_t size) override;
  5437. void get_remote_ip_and_port(std::string &ip, int &port) const override;
  5438. void get_local_ip_and_port(std::string &ip, int &port) const override;
  5439. socket_t socket() const override;
  5440. time_t duration() const override;
  5441. void set_read_timeout(time_t sec, time_t usec = 0) override;
  5442. const char *buffered_data(size_t &size) const override;
  5443. void consume_buffered(size_t size) override;
  5444. // The caller has just seen this socket become readable. Lets the next read
  5445. // skip its own readiness wait, which would otherwise ask the kernel a
  5446. // question that was answered a moment ago. Consumed by that read.
  5447. void set_readable_hint() { readable_hint_ = true; }
  5448. private:
  5449. bool ensure_readable();
  5450. socket_t sock_;
  5451. // Atomic because ws::WebSocket::set_read_timeout() reaches this from another
  5452. // thread while a read is in flight -- that is the point of it, for a caller
  5453. // holding one connection and wanting control back to send on it.
  5454. std::atomic<time_t> read_timeout_sec_;
  5455. std::atomic<time_t> read_timeout_usec_;
  5456. time_t write_timeout_sec_;
  5457. time_t write_timeout_usec_;
  5458. time_t max_timeout_msec_;
  5459. const std::chrono::time_point<std::chrono::steady_clock> start_time_;
  5460. std::vector<char> read_buff_;
  5461. size_t read_buff_off_ = 0;
  5462. size_t read_buff_content_size_ = 0;
  5463. bool readable_hint_ = false;
  5464. static const size_t read_buff_size_ = 1024l * 4;
  5465. };
  5466. inline bool keep_alive(const std::atomic<socket_t> &svr_sock, socket_t sock,
  5467. time_t keep_alive_timeout_sec) {
  5468. using namespace std::chrono;
  5469. const auto interval_usec =
  5470. CPPHTTPLIB_KEEPALIVE_TIMEOUT_CHECK_INTERVAL_USECOND;
  5471. // Avoid expensive `steady_clock::now()` call for the first time
  5472. if (select_read(sock, 0, interval_usec) > 0) { return true; }
  5473. const auto start = steady_clock::now() - microseconds{interval_usec};
  5474. const auto timeout = seconds{keep_alive_timeout_sec};
  5475. while (true) {
  5476. if (svr_sock == INVALID_SOCKET) {
  5477. break; // Server socket is closed
  5478. }
  5479. auto val = select_read(sock, 0, interval_usec);
  5480. if (val < 0) {
  5481. break; // Ssocket error
  5482. } else if (val == 0) {
  5483. if (steady_clock::now() - start > timeout) {
  5484. break; // Timeout
  5485. }
  5486. } else {
  5487. return true; // Ready for read
  5488. }
  5489. }
  5490. return false;
  5491. }
  5492. template <typename T>
  5493. inline bool
  5494. process_server_socket_core(const std::atomic<socket_t> &svr_sock, socket_t sock,
  5495. size_t keep_alive_max_count,
  5496. time_t keep_alive_timeout_sec, T callback) {
  5497. assert(keep_alive_max_count > 0);
  5498. auto ret = false;
  5499. auto count = keep_alive_max_count;
  5500. while (count > 0 && keep_alive(svr_sock, sock, keep_alive_timeout_sec)) {
  5501. auto close_connection = count == 1;
  5502. auto connection_closed = false;
  5503. ret = callback(close_connection, connection_closed);
  5504. if (!ret || connection_closed) { break; }
  5505. count--;
  5506. }
  5507. return ret;
  5508. }
  5509. template <typename T>
  5510. inline bool
  5511. process_server_socket(const std::atomic<socket_t> &svr_sock, socket_t sock,
  5512. size_t keep_alive_max_count,
  5513. time_t keep_alive_timeout_sec, time_t read_timeout_sec,
  5514. time_t read_timeout_usec, time_t write_timeout_sec,
  5515. time_t write_timeout_usec, T callback) {
  5516. return process_server_socket_core(
  5517. svr_sock, sock, keep_alive_max_count, keep_alive_timeout_sec,
  5518. [&](bool close_connection, bool &connection_closed) {
  5519. SocketStream strm(sock, read_timeout_sec, read_timeout_usec,
  5520. write_timeout_sec, write_timeout_usec);
  5521. // process_server_socket_core() only gets here once keep_alive() has
  5522. // seen the socket go readable.
  5523. strm.set_readable_hint();
  5524. return callback(strm, close_connection, connection_closed);
  5525. });
  5526. }
  5527. inline bool process_client_socket(
  5528. socket_t sock, time_t read_timeout_sec, time_t read_timeout_usec,
  5529. time_t write_timeout_sec, time_t write_timeout_usec,
  5530. time_t max_timeout_msec,
  5531. std::chrono::time_point<std::chrono::steady_clock> start_time,
  5532. std::function<bool(Stream &)> callback) {
  5533. SocketStream strm(sock, read_timeout_sec, read_timeout_usec,
  5534. write_timeout_sec, write_timeout_usec, max_timeout_msec,
  5535. start_time);
  5536. return callback(strm);
  5537. }
  5538. inline int shutdown_socket(socket_t sock) noexcept {
  5539. #ifdef _WIN32
  5540. return shutdown(sock, SD_BOTH);
  5541. #else
  5542. return shutdown(sock, SHUT_RDWR);
  5543. #endif
  5544. }
  5545. // Half-closes the write side and drains any in-flight/queued bytes before
  5546. // the final shutdown+close. Closing with unread data in the receive queue
  5547. // (or bytes arriving after the receive side is closed) makes the stack send
  5548. // an abortive RST instead of a graceful FIN, which can make the peer see the
  5549. // response as a failed read even though it was fully written.
  5550. inline void drain_and_close_socket(socket_t sock) noexcept {
  5551. #ifdef _WIN32
  5552. shutdown(sock, SD_SEND);
  5553. #else
  5554. shutdown(sock, SHUT_WR);
  5555. #endif
  5556. char buf[CPPHTTPLIB_RECV_BUFSIZ];
  5557. size_t total = 0;
  5558. const auto deadline = std::chrono::steady_clock::now() +
  5559. std::chrono::milliseconds(100); // bound #1
  5560. while (total < size_t(1024u * 1024u)) { // bound #2
  5561. const auto remaining =
  5562. std::chrono::duration_cast<std::chrono::microseconds>(
  5563. deadline - std::chrono::steady_clock::now())
  5564. .count();
  5565. if (remaining <= 0) { break; }
  5566. if (select_read(sock, 0, static_cast<time_t>(remaining)) <= 0) { break; }
  5567. const auto n = read_socket(sock, buf, sizeof(buf), CPPHTTPLIB_RECV_FLAGS);
  5568. if (n <= 0) { break; }
  5569. total += static_cast<size_t>(n);
  5570. }
  5571. shutdown_socket(sock);
  5572. close_socket(sock);
  5573. }
  5574. inline std::string escape_abstract_namespace_unix_domain(const std::string &s) {
  5575. if (s.size() > 1 && s[0] == '\0') {
  5576. auto ret = s;
  5577. ret[0] = '@';
  5578. return ret;
  5579. }
  5580. return s;
  5581. }
  5582. inline std::string
  5583. unescape_abstract_namespace_unix_domain(const std::string &s) {
  5584. if (s.size() > 1 && s[0] == '@') {
  5585. auto ret = s;
  5586. ret[0] = '\0';
  5587. return ret;
  5588. }
  5589. return s;
  5590. }
  5591. inline int getaddrinfo_with_timeout(const char *node, const char *service,
  5592. const struct addrinfo *hints,
  5593. struct addrinfo **res, time_t timeout_sec) {
  5594. #ifdef CPPHTTPLIB_USE_NON_BLOCKING_GETADDRINFO
  5595. if (timeout_sec <= 0) {
  5596. // No timeout specified, use standard getaddrinfo
  5597. return getaddrinfo(node, service, hints, res);
  5598. }
  5599. #ifdef _WIN32
  5600. // Windows-specific implementation using GetAddrInfoEx with overlapped I/O
  5601. OVERLAPPED overlapped = {};
  5602. HANDLE event = CreateEventW(nullptr, TRUE, FALSE, nullptr);
  5603. if (!event) { return EAI_FAIL; }
  5604. overlapped.hEvent = event;
  5605. PADDRINFOEXW result_addrinfo = nullptr;
  5606. HANDLE cancel_handle = nullptr;
  5607. ADDRINFOEXW hints_ex = {};
  5608. if (hints) {
  5609. hints_ex.ai_flags = hints->ai_flags;
  5610. hints_ex.ai_family = hints->ai_family;
  5611. hints_ex.ai_socktype = hints->ai_socktype;
  5612. hints_ex.ai_protocol = hints->ai_protocol;
  5613. }
  5614. auto wnode = u8string_to_wstring(node);
  5615. auto wservice = u8string_to_wstring(service);
  5616. auto ret = ::GetAddrInfoExW(wnode.data(), wservice.data(), NS_DNS, nullptr,
  5617. hints ? &hints_ex : nullptr, &result_addrinfo,
  5618. nullptr, &overlapped, nullptr, &cancel_handle);
  5619. if (ret == WSA_IO_PENDING) {
  5620. auto wait_result =
  5621. ::WaitForSingleObject(event, static_cast<DWORD>(timeout_sec * 1000));
  5622. if (wait_result == WAIT_TIMEOUT) {
  5623. if (cancel_handle) { ::GetAddrInfoExCancel(&cancel_handle); }
  5624. ::CloseHandle(event);
  5625. return EAI_AGAIN;
  5626. }
  5627. DWORD bytes_returned;
  5628. if (!::GetOverlappedResult((HANDLE)INVALID_SOCKET, &overlapped,
  5629. &bytes_returned, FALSE)) {
  5630. ::CloseHandle(event);
  5631. return ::WSAGetLastError();
  5632. }
  5633. }
  5634. ::CloseHandle(event);
  5635. if (ret == NO_ERROR || ret == WSA_IO_PENDING) {
  5636. *res = reinterpret_cast<struct addrinfo *>(result_addrinfo);
  5637. return 0;
  5638. }
  5639. return ret;
  5640. #elif TARGET_OS_MAC && defined(__clang__)
  5641. if (!node) { return EAI_NONAME; }
  5642. // macOS implementation using CFHost API for asynchronous DNS resolution
  5643. CFStringRef hostname_ref = CFStringCreateWithCString(
  5644. kCFAllocatorDefault, node, kCFStringEncodingUTF8);
  5645. if (!hostname_ref) { return EAI_MEMORY; }
  5646. CFHostRef host_ref = CFHostCreateWithName(kCFAllocatorDefault, hostname_ref);
  5647. CFRelease(hostname_ref);
  5648. if (!host_ref) { return EAI_MEMORY; }
  5649. // Set up context for callback
  5650. struct CFHostContext {
  5651. bool completed = false;
  5652. bool success = false;
  5653. CFArrayRef addresses = nullptr;
  5654. std::mutex mutex;
  5655. std::condition_variable cv;
  5656. } context;
  5657. CFHostClientContext client_context;
  5658. memset(&client_context, 0, sizeof(client_context));
  5659. client_context.info = &context;
  5660. // Set callback
  5661. auto callback = [](CFHostRef theHost, CFHostInfoType /*typeInfo*/,
  5662. const CFStreamError *error, void *info) {
  5663. auto ctx = static_cast<CFHostContext *>(info);
  5664. std::lock_guard<std::mutex> lock(ctx->mutex);
  5665. if (error && error->error != 0) {
  5666. ctx->success = false;
  5667. } else {
  5668. Boolean hasBeenResolved;
  5669. ctx->addresses = CFHostGetAddressing(theHost, &hasBeenResolved);
  5670. if (ctx->addresses && hasBeenResolved) {
  5671. CFRetain(ctx->addresses);
  5672. ctx->success = true;
  5673. } else {
  5674. ctx->success = false;
  5675. }
  5676. }
  5677. ctx->completed = true;
  5678. ctx->cv.notify_one();
  5679. };
  5680. if (!CFHostSetClient(host_ref, callback, &client_context)) {
  5681. CFRelease(host_ref);
  5682. return EAI_SYSTEM;
  5683. }
  5684. // Schedule on run loop
  5685. CFRunLoopRef run_loop = CFRunLoopGetCurrent();
  5686. CFHostScheduleWithRunLoop(host_ref, run_loop, kCFRunLoopDefaultMode);
  5687. // Start resolution
  5688. CFStreamError stream_error;
  5689. if (!CFHostStartInfoResolution(host_ref, kCFHostAddresses, &stream_error)) {
  5690. CFHostUnscheduleFromRunLoop(host_ref, run_loop, kCFRunLoopDefaultMode);
  5691. CFRelease(host_ref);
  5692. return EAI_FAIL;
  5693. }
  5694. // Wait for completion with timeout
  5695. auto timeout_time =
  5696. std::chrono::steady_clock::now() + std::chrono::seconds(timeout_sec);
  5697. bool timed_out = false;
  5698. {
  5699. std::unique_lock<std::mutex> lock(context.mutex);
  5700. while (!context.completed) {
  5701. auto now = std::chrono::steady_clock::now();
  5702. if (now >= timeout_time) {
  5703. timed_out = true;
  5704. break;
  5705. }
  5706. // Run the runloop for a short time
  5707. lock.unlock();
  5708. CFRunLoopRunInMode(kCFRunLoopDefaultMode, 0.1, true);
  5709. lock.lock();
  5710. }
  5711. }
  5712. // Clean up
  5713. CFHostUnscheduleFromRunLoop(host_ref, run_loop, kCFRunLoopDefaultMode);
  5714. CFHostSetClient(host_ref, nullptr, nullptr);
  5715. if (timed_out || !context.completed) {
  5716. CFHostCancelInfoResolution(host_ref, kCFHostAddresses);
  5717. CFRelease(host_ref);
  5718. return EAI_AGAIN;
  5719. }
  5720. if (!context.success || !context.addresses) {
  5721. CFRelease(host_ref);
  5722. return EAI_NODATA;
  5723. }
  5724. // Convert CFArray to addrinfo
  5725. CFIndex count = CFArrayGetCount(context.addresses);
  5726. if (count == 0) {
  5727. CFRelease(context.addresses);
  5728. CFRelease(host_ref);
  5729. return EAI_NODATA;
  5730. }
  5731. struct addrinfo *result_addrinfo = nullptr;
  5732. struct addrinfo **current = &result_addrinfo;
  5733. for (CFIndex i = 0; i < count; i++) {
  5734. CFDataRef addr_data =
  5735. static_cast<CFDataRef>(CFArrayGetValueAtIndex(context.addresses, i));
  5736. if (!addr_data) continue;
  5737. const struct sockaddr *sockaddr_ptr =
  5738. reinterpret_cast<const struct sockaddr *>(CFDataGetBytePtr(addr_data));
  5739. socklen_t sockaddr_len = static_cast<socklen_t>(CFDataGetLength(addr_data));
  5740. // Allocate addrinfo structure
  5741. *current = static_cast<struct addrinfo *>(malloc(sizeof(struct addrinfo)));
  5742. if (!*current) {
  5743. freeaddrinfo(result_addrinfo);
  5744. CFRelease(context.addresses);
  5745. CFRelease(host_ref);
  5746. return EAI_MEMORY;
  5747. }
  5748. memset(*current, 0, sizeof(struct addrinfo));
  5749. // Set up addrinfo fields
  5750. (*current)->ai_family = sockaddr_ptr->sa_family;
  5751. (*current)->ai_socktype = hints ? hints->ai_socktype : SOCK_STREAM;
  5752. (*current)->ai_protocol = hints ? hints->ai_protocol : IPPROTO_TCP;
  5753. (*current)->ai_addrlen = sockaddr_len;
  5754. // Copy sockaddr
  5755. (*current)->ai_addr = static_cast<struct sockaddr *>(malloc(sockaddr_len));
  5756. if (!(*current)->ai_addr) {
  5757. freeaddrinfo(result_addrinfo);
  5758. CFRelease(context.addresses);
  5759. CFRelease(host_ref);
  5760. return EAI_MEMORY;
  5761. }
  5762. memcpy((*current)->ai_addr, sockaddr_ptr, sockaddr_len);
  5763. // Set port if service is specified
  5764. if (service && *service) {
  5765. int port = 0;
  5766. if (parse_port(service, strlen(service), port)) {
  5767. if (sockaddr_ptr->sa_family == AF_INET) {
  5768. reinterpret_cast<struct sockaddr_in *>((*current)->ai_addr)
  5769. ->sin_port = htons(static_cast<uint16_t>(port));
  5770. } else if (sockaddr_ptr->sa_family == AF_INET6) {
  5771. reinterpret_cast<struct sockaddr_in6 *>((*current)->ai_addr)
  5772. ->sin6_port = htons(static_cast<uint16_t>(port));
  5773. }
  5774. }
  5775. }
  5776. current = &((*current)->ai_next);
  5777. }
  5778. CFRelease(context.addresses);
  5779. CFRelease(host_ref);
  5780. *res = result_addrinfo;
  5781. return 0;
  5782. #elif defined(_GNU_SOURCE) && defined(__GLIBC__) && \
  5783. (__GLIBC__ > 2 || (__GLIBC__ == 2 && __GLIBC_MINOR__ >= 2))
  5784. // #2431: gai_cancel() is non-blocking and may return EAI_NOTCANCELED while
  5785. // the resolver worker still references the stack-local gaicb. The cancel
  5786. // path therefore waits (gai_suspend with no timeout) for the worker to
  5787. // actually finish before letting the stack frame go. The trade-off is that
  5788. // a wedged DNS server can hold this thread for the system resolver timeout
  5789. // (~30s by default) past the caller's connection timeout.
  5790. struct gaicb request{};
  5791. struct gaicb *requests[1] = {&request};
  5792. struct sigevent sevp{};
  5793. struct timespec timeout{timeout_sec, 0};
  5794. request.ar_name = node;
  5795. request.ar_service = service;
  5796. request.ar_request = hints;
  5797. sevp.sigev_notify = SIGEV_NONE;
  5798. int rc = getaddrinfo_a(GAI_NOWAIT, requests, 1, &sevp);
  5799. if (rc != 0) { return rc; }
  5800. auto cleanup = scope_exit([&] {
  5801. if (request.ar_result) { freeaddrinfo(request.ar_result); }
  5802. });
  5803. int wait_result = gai_suspend(requests, 1, &timeout);
  5804. if (wait_result == 0 || wait_result == EAI_ALLDONE) {
  5805. int gai_result = gai_error(&request);
  5806. if (gai_result == 0) {
  5807. *res = request.ar_result;
  5808. request.ar_result = nullptr;
  5809. return 0;
  5810. }
  5811. return gai_result;
  5812. }
  5813. gai_cancel(&request);
  5814. while (gai_error(&request) == EAI_INPROGRESS) {
  5815. gai_suspend(requests, 1, nullptr);
  5816. }
  5817. return wait_result;
  5818. #else
  5819. // Fallback implementation using thread-based timeout for other Unix systems.
  5820. struct GetAddrInfoState {
  5821. ~GetAddrInfoState() {
  5822. if (info) { freeaddrinfo(info); }
  5823. }
  5824. std::mutex mutex;
  5825. std::condition_variable result_cv;
  5826. bool completed = false;
  5827. int result = EAI_SYSTEM;
  5828. std::string node;
  5829. std::string service;
  5830. struct addrinfo hints;
  5831. struct addrinfo *info = nullptr;
  5832. };
  5833. // Allocate on the heap, so the resolver thread can keep using the data.
  5834. auto state = std::make_shared<GetAddrInfoState>();
  5835. if (node) { state->node = node; }
  5836. state->service = service;
  5837. state->hints = *hints;
  5838. std::thread resolve_thread([state]() {
  5839. auto thread_result =
  5840. getaddrinfo(state->node.c_str(), state->service.c_str(), &state->hints,
  5841. &state->info);
  5842. std::lock_guard<std::mutex> lock(state->mutex);
  5843. state->result = thread_result;
  5844. state->completed = true;
  5845. state->result_cv.notify_one();
  5846. });
  5847. // Wait for completion or timeout
  5848. std::unique_lock<std::mutex> lock(state->mutex);
  5849. auto finished =
  5850. state->result_cv.wait_for(lock, std::chrono::seconds(timeout_sec),
  5851. [&] { return state->completed; });
  5852. if (finished) {
  5853. // Operation completed within timeout
  5854. resolve_thread.join();
  5855. *res = state->info;
  5856. state->info = nullptr; // Pass ownership to caller
  5857. return state->result;
  5858. } else {
  5859. // Timeout occurred
  5860. resolve_thread.detach(); // Let the thread finish in background
  5861. return EAI_AGAIN; // Return timeout error
  5862. }
  5863. #endif
  5864. #else
  5865. (void)(timeout_sec); // Unused parameter for non-blocking getaddrinfo
  5866. return getaddrinfo(node, service, hints, res);
  5867. #endif
  5868. }
  5869. template <typename BindOrConnect>
  5870. socket_t create_socket(const std::string &host, const std::string &ip, int port,
  5871. int address_family, int socket_flags, bool tcp_nodelay,
  5872. bool ipv6_v6only, SocketOptions socket_options,
  5873. BindOrConnect bind_or_connect, time_t timeout_sec = 0) {
  5874. // Get address info
  5875. const char *node = nullptr;
  5876. struct addrinfo hints;
  5877. struct addrinfo *result;
  5878. memset(&hints, 0, sizeof(struct addrinfo));
  5879. hints.ai_socktype = SOCK_STREAM;
  5880. hints.ai_protocol = IPPROTO_IP;
  5881. if (!ip.empty()) {
  5882. node = ip.c_str();
  5883. // Ask getaddrinfo to convert IP in c-string to address
  5884. hints.ai_family = AF_UNSPEC;
  5885. hints.ai_flags = AI_NUMERICHOST;
  5886. } else {
  5887. if (!host.empty()) { node = host.c_str(); }
  5888. hints.ai_family = address_family;
  5889. hints.ai_flags = socket_flags;
  5890. }
  5891. #if !defined(_WIN32) || defined(CPPHTTPLIB_HAVE_AFUNIX_H)
  5892. if (hints.ai_family == AF_UNIX) {
  5893. const auto addrlen = host.length();
  5894. if (addrlen > sizeof(sockaddr_un::sun_path)) { return INVALID_SOCKET; }
  5895. #ifdef SOCK_CLOEXEC
  5896. auto sock = socket(hints.ai_family, hints.ai_socktype | SOCK_CLOEXEC,
  5897. hints.ai_protocol);
  5898. #else
  5899. auto sock = socket(hints.ai_family, hints.ai_socktype, hints.ai_protocol);
  5900. #endif
  5901. if (sock != INVALID_SOCKET) {
  5902. sockaddr_un addr{};
  5903. addr.sun_family = AF_UNIX;
  5904. auto unescaped_host = unescape_abstract_namespace_unix_domain(host);
  5905. std::copy(unescaped_host.begin(), unescaped_host.end(), addr.sun_path);
  5906. hints.ai_addr = reinterpret_cast<sockaddr *>(&addr);
  5907. hints.ai_addrlen = static_cast<socklen_t>(
  5908. sizeof(addr) - sizeof(addr.sun_path) + addrlen);
  5909. #ifndef SOCK_CLOEXEC
  5910. #ifndef _WIN32
  5911. fcntl(sock, F_SETFD, FD_CLOEXEC);
  5912. #endif
  5913. #endif
  5914. if (socket_options) { socket_options(sock); }
  5915. #ifdef _WIN32
  5916. // Setting SO_REUSEADDR seems not to work well with AF_UNIX on windows, so
  5917. // remove the option.
  5918. set_socket_opt(sock, SOL_SOCKET, SO_REUSEADDR, 0);
  5919. #endif
  5920. bool dummy;
  5921. if (!bind_or_connect(sock, hints, dummy)) {
  5922. close_socket(sock);
  5923. sock = INVALID_SOCKET;
  5924. }
  5925. }
  5926. return sock;
  5927. }
  5928. #endif
  5929. auto service = std::to_string(port);
  5930. if (getaddrinfo_with_timeout(node, service.c_str(), &hints, &result,
  5931. timeout_sec)) {
  5932. #if defined __linux__ && !defined __ANDROID__
  5933. res_init();
  5934. #endif
  5935. return INVALID_SOCKET;
  5936. }
  5937. auto se = detail::scope_exit([&] { freeaddrinfo(result); });
  5938. for (auto rp = result; rp; rp = rp->ai_next) {
  5939. // Create a socket
  5940. #ifdef _WIN32
  5941. auto sock =
  5942. WSASocketW(rp->ai_family, rp->ai_socktype, rp->ai_protocol, nullptr, 0,
  5943. WSA_FLAG_NO_HANDLE_INHERIT | WSA_FLAG_OVERLAPPED);
  5944. /**
  5945. * Since the WSA_FLAG_NO_HANDLE_INHERIT is only supported on Windows 7 SP1
  5946. * and above the socket creation fails on older Windows Systems.
  5947. *
  5948. * Let's try to create a socket the old way in this case.
  5949. *
  5950. * Reference:
  5951. * https://docs.microsoft.com/en-us/windows/win32/api/winsock2/nf-winsock2-wsasocketa
  5952. *
  5953. * WSA_FLAG_NO_HANDLE_INHERIT:
  5954. * This flag is supported on Windows 7 with SP1, Windows Server 2008 R2 with
  5955. * SP1, and later
  5956. *
  5957. */
  5958. if (sock == INVALID_SOCKET) {
  5959. sock = socket(rp->ai_family, rp->ai_socktype, rp->ai_protocol);
  5960. }
  5961. #else
  5962. #ifdef SOCK_CLOEXEC
  5963. auto sock =
  5964. socket(rp->ai_family, rp->ai_socktype | SOCK_CLOEXEC, rp->ai_protocol);
  5965. #else
  5966. auto sock = socket(rp->ai_family, rp->ai_socktype, rp->ai_protocol);
  5967. #endif
  5968. #endif
  5969. if (sock == INVALID_SOCKET) { continue; }
  5970. #if !defined _WIN32 && !defined SOCK_CLOEXEC
  5971. if (fcntl(sock, F_SETFD, FD_CLOEXEC) == -1) {
  5972. close_socket(sock);
  5973. continue;
  5974. }
  5975. #endif
  5976. if (tcp_nodelay) { set_socket_opt(sock, IPPROTO_TCP, TCP_NODELAY, 1); }
  5977. if (rp->ai_family == AF_INET6) {
  5978. set_socket_opt(sock, IPPROTO_IPV6, IPV6_V6ONLY, ipv6_v6only ? 1 : 0);
  5979. }
  5980. if (socket_options) { socket_options(sock); }
  5981. // bind or connect
  5982. auto quit = false;
  5983. if (bind_or_connect(sock, *rp, quit)) { return sock; }
  5984. close_socket(sock);
  5985. if (quit) { break; }
  5986. }
  5987. return INVALID_SOCKET;
  5988. }
  5989. inline void set_nonblocking(socket_t sock, bool nonblocking) {
  5990. #ifdef _WIN32
  5991. auto flags = nonblocking ? 1UL : 0UL;
  5992. ioctlsocket(sock, FIONBIO, &flags);
  5993. #else
  5994. auto flags = fcntl(sock, F_GETFL, 0);
  5995. fcntl(sock, F_SETFL,
  5996. nonblocking ? (flags | O_NONBLOCK) : (flags & (~O_NONBLOCK)));
  5997. #endif
  5998. }
  5999. inline bool is_connection_error() {
  6000. #ifdef _WIN32
  6001. return WSAGetLastError() != WSAEWOULDBLOCK;
  6002. #else
  6003. return errno != EINPROGRESS;
  6004. #endif
  6005. }
  6006. // accept() failed because the process or the network stack is temporarily out
  6007. // of resources. The listening socket is still usable, so back off briefly and
  6008. // try again.
  6009. inline bool is_accept_resource_error() {
  6010. #ifdef _WIN32
  6011. auto err = WSAGetLastError();
  6012. return err == WSAEMFILE || err == WSAENOBUFS;
  6013. #else
  6014. auto err = errno;
  6015. return err == EMFILE || err == ENFILE || err == ENOBUFS || err == ENOMEM;
  6016. #endif
  6017. }
  6018. // accept() failed for a reason that says nothing about the listening socket:
  6019. // the pending connection went away before it could be accepted, or the call
  6020. // was interrupted. Retry immediately. WSAAccept()'s own documentation omits
  6021. // WSAECONNRESET, but the accept() it wraps reports an aborted pending
  6022. // connection that way.
  6023. inline bool is_accept_transient_error() {
  6024. #ifdef _WIN32
  6025. auto err = WSAGetLastError();
  6026. return err == WSAEINTR || err == WSAEWOULDBLOCK || err == WSAECONNRESET ||
  6027. err == WSAECONNABORTED;
  6028. #else
  6029. auto err = errno;
  6030. return err == EINTR || err == EAGAIN || err == EWOULDBLOCK ||
  6031. err == ECONNABORTED;
  6032. #endif
  6033. }
  6034. inline bool bind_ip_address(socket_t sock, const std::string &host) {
  6035. struct addrinfo hints;
  6036. struct addrinfo *result;
  6037. memset(&hints, 0, sizeof(struct addrinfo));
  6038. hints.ai_family = AF_UNSPEC;
  6039. hints.ai_socktype = SOCK_STREAM;
  6040. hints.ai_protocol = 0;
  6041. if (getaddrinfo_with_timeout(host.c_str(), "0", &hints, &result, 0)) {
  6042. return false;
  6043. }
  6044. auto se = detail::scope_exit([&] { freeaddrinfo(result); });
  6045. auto ret = false;
  6046. for (auto rp = result; rp; rp = rp->ai_next) {
  6047. const auto &ai = *rp;
  6048. if (!::bind(sock, ai.ai_addr, static_cast<socklen_t>(ai.ai_addrlen))) {
  6049. ret = true;
  6050. break;
  6051. }
  6052. }
  6053. return ret;
  6054. }
  6055. #if !defined _WIN32 && !defined ANDROID && !defined _AIX && !defined __MVS__
  6056. #define USE_IF2IP
  6057. #endif
  6058. #ifdef USE_IF2IP
  6059. inline std::string if2ip(int address_family, const std::string &ifn) {
  6060. struct ifaddrs *ifap;
  6061. getifaddrs(&ifap);
  6062. auto se = detail::scope_exit([&] { freeifaddrs(ifap); });
  6063. std::string addr_candidate;
  6064. for (auto ifa = ifap; ifa; ifa = ifa->ifa_next) {
  6065. if (ifa->ifa_addr && ifn == ifa->ifa_name &&
  6066. (AF_UNSPEC == address_family ||
  6067. ifa->ifa_addr->sa_family == address_family)) {
  6068. if (ifa->ifa_addr->sa_family == AF_INET) {
  6069. auto sa = reinterpret_cast<struct sockaddr_in *>(ifa->ifa_addr);
  6070. char buf[INET_ADDRSTRLEN];
  6071. if (inet_ntop(AF_INET, &sa->sin_addr, buf, INET_ADDRSTRLEN)) {
  6072. return std::string(buf, INET_ADDRSTRLEN);
  6073. }
  6074. } else if (ifa->ifa_addr->sa_family == AF_INET6) {
  6075. auto sa = reinterpret_cast<struct sockaddr_in6 *>(ifa->ifa_addr);
  6076. if (!IN6_IS_ADDR_LINKLOCAL(&sa->sin6_addr)) {
  6077. char buf[INET6_ADDRSTRLEN] = {};
  6078. if (inet_ntop(AF_INET6, &sa->sin6_addr, buf, INET6_ADDRSTRLEN)) {
  6079. // equivalent to mac's IN6_IS_ADDR_UNIQUE_LOCAL
  6080. auto s6_addr_head = sa->sin6_addr.s6_addr[0];
  6081. if (s6_addr_head == 0xfc || s6_addr_head == 0xfd) {
  6082. addr_candidate = std::string(buf, INET6_ADDRSTRLEN);
  6083. } else {
  6084. return std::string(buf, INET6_ADDRSTRLEN);
  6085. }
  6086. }
  6087. }
  6088. }
  6089. }
  6090. }
  6091. return addr_candidate;
  6092. }
  6093. #endif
  6094. inline socket_t create_client_socket(
  6095. const std::string &host, const std::string &ip, int port,
  6096. int address_family, bool tcp_nodelay, bool ipv6_v6only,
  6097. SocketOptions socket_options, time_t connection_timeout_sec,
  6098. time_t connection_timeout_usec, time_t read_timeout_sec,
  6099. time_t read_timeout_usec, time_t write_timeout_sec,
  6100. time_t write_timeout_usec, const std::string &intf, Error &error) {
  6101. auto sock = create_socket(
  6102. host, ip, port, address_family, 0, tcp_nodelay, ipv6_v6only,
  6103. std::move(socket_options),
  6104. [&](socket_t sock2, struct addrinfo &ai, bool &quit) -> bool {
  6105. if (!intf.empty()) {
  6106. #ifdef USE_IF2IP
  6107. auto ip_from_if = if2ip(address_family, intf);
  6108. if (ip_from_if.empty()) { ip_from_if = intf; }
  6109. if (!bind_ip_address(sock2, ip_from_if)) {
  6110. error = Error::BindIPAddress;
  6111. return false;
  6112. }
  6113. #endif
  6114. }
  6115. set_nonblocking(sock2, true);
  6116. auto ret =
  6117. ::connect(sock2, ai.ai_addr, static_cast<socklen_t>(ai.ai_addrlen));
  6118. if (ret < 0) {
  6119. if (is_connection_error()) {
  6120. error = Error::Connection;
  6121. return false;
  6122. }
  6123. error = wait_until_socket_is_ready(sock2, connection_timeout_sec,
  6124. connection_timeout_usec);
  6125. if (error != Error::Success) {
  6126. if (error == Error::ConnectionTimeout) { quit = true; }
  6127. return false;
  6128. }
  6129. }
  6130. set_nonblocking(sock2, false);
  6131. set_socket_opt_time(sock2, SOL_SOCKET, SO_RCVTIMEO, read_timeout_sec,
  6132. read_timeout_usec);
  6133. set_socket_opt_time(sock2, SOL_SOCKET, SO_SNDTIMEO, write_timeout_sec,
  6134. write_timeout_usec);
  6135. error = Error::Success;
  6136. return true;
  6137. },
  6138. connection_timeout_sec); // Pass DNS timeout
  6139. if (sock != INVALID_SOCKET) {
  6140. error = Error::Success;
  6141. } else {
  6142. if (error == Error::Success) { error = Error::Connection; }
  6143. }
  6144. return sock;
  6145. }
  6146. inline bool get_ip_and_port(const struct sockaddr_storage &addr,
  6147. socklen_t addr_len, std::string &ip, int &port) {
  6148. if (addr.ss_family == AF_INET) {
  6149. port = ntohs(reinterpret_cast<const struct sockaddr_in *>(&addr)->sin_port);
  6150. } else if (addr.ss_family == AF_INET6) {
  6151. port =
  6152. ntohs(reinterpret_cast<const struct sockaddr_in6 *>(&addr)->sin6_port);
  6153. } else {
  6154. return false;
  6155. }
  6156. std::array<char, NI_MAXHOST> ipstr{};
  6157. if (getnameinfo(reinterpret_cast<const struct sockaddr *>(&addr), addr_len,
  6158. ipstr.data(), static_cast<socklen_t>(ipstr.size()), nullptr,
  6159. 0, NI_NUMERICHOST)) {
  6160. return false;
  6161. }
  6162. ip = ipstr.data();
  6163. return true;
  6164. }
  6165. inline void get_local_ip_and_port(socket_t sock, std::string &ip, int &port) {
  6166. struct sockaddr_storage addr;
  6167. socklen_t addr_len = sizeof(addr);
  6168. if (!getsockname(sock, reinterpret_cast<struct sockaddr *>(&addr),
  6169. &addr_len)) {
  6170. get_ip_and_port(addr, addr_len, ip, port);
  6171. }
  6172. }
  6173. inline void get_remote_ip_and_port(socket_t sock, std::string &ip, int &port) {
  6174. struct sockaddr_storage addr;
  6175. socklen_t addr_len = sizeof(addr);
  6176. if (!getpeername(sock, reinterpret_cast<struct sockaddr *>(&addr),
  6177. &addr_len)) {
  6178. #ifndef _WIN32
  6179. if (addr.ss_family == AF_UNIX) {
  6180. #if defined(__linux__)
  6181. struct ucred ucred;
  6182. socklen_t len = sizeof(ucred);
  6183. if (getsockopt(sock, SOL_SOCKET, SO_PEERCRED, &ucred, &len) == 0) {
  6184. port = ucred.pid;
  6185. }
  6186. #elif defined(SOL_LOCAL) && defined(SO_PEERPID)
  6187. pid_t pid;
  6188. socklen_t len = sizeof(pid);
  6189. if (getsockopt(sock, SOL_LOCAL, SO_PEERPID, &pid, &len) == 0) {
  6190. port = pid;
  6191. }
  6192. #endif
  6193. return;
  6194. }
  6195. #endif
  6196. get_ip_and_port(addr, addr_len, ip, port);
  6197. }
  6198. }
  6199. // Recursive form retained so operator""_t below can compute hashes for
  6200. // switch-case labels at compile time (C++11 constexpr forbids loops). Do not
  6201. // call from runtime paths with arbitrary-length inputs — use str2tag()
  6202. // instead, which is iterative and stack-safe.
  6203. inline constexpr unsigned int str2tag_core(const char *s, size_t l,
  6204. unsigned int h) {
  6205. return (l == 0)
  6206. ? h
  6207. : str2tag_core(
  6208. s + 1, l - 1,
  6209. // Unsets the 6 high bits of h, therefore no overflow happens
  6210. (((std::numeric_limits<unsigned int>::max)() >> 6) &
  6211. h * 33) ^
  6212. static_cast<unsigned char>(*s));
  6213. }
  6214. inline unsigned int str2tag(const std::string &s) {
  6215. // Iterative form of str2tag_core: the recursive constexpr version is kept
  6216. // for compile-time UDL evaluation of short string literals, but at runtime
  6217. // we may receive arbitrarily long inputs (e.g. fuzzed Content-Type) that
  6218. // would blow the stack with one frame per character.
  6219. unsigned int h = 0;
  6220. for (auto c : s) {
  6221. h = (((std::numeric_limits<unsigned int>::max)() >> 6) & h * 33) ^
  6222. static_cast<unsigned char>(c);
  6223. }
  6224. return h;
  6225. }
  6226. namespace udl {
  6227. inline constexpr unsigned int operator""_t(const char *s, size_t l) {
  6228. return str2tag_core(s, l, 0);
  6229. }
  6230. } // namespace udl
  6231. inline std::string
  6232. find_content_type(const std::string &path,
  6233. const std::map<std::string, std::string> &user_data,
  6234. const std::string &default_content_type) {
  6235. auto ext = file_extension(path);
  6236. auto it = user_data.find(ext);
  6237. if (it != user_data.end()) { return it->second; }
  6238. using udl::operator""_t;
  6239. switch (str2tag(ext)) {
  6240. default: return default_content_type;
  6241. case "css"_t: return "text/css";
  6242. case "csv"_t: return "text/csv";
  6243. case "htm"_t:
  6244. case "html"_t: return "text/html";
  6245. case "js"_t:
  6246. case "mjs"_t: return "text/javascript";
  6247. case "txt"_t: return "text/plain";
  6248. case "vtt"_t: return "text/vtt";
  6249. case "apng"_t: return "image/apng";
  6250. case "avif"_t: return "image/avif";
  6251. case "bmp"_t: return "image/bmp";
  6252. case "gif"_t: return "image/gif";
  6253. case "png"_t: return "image/png";
  6254. case "svg"_t: return "image/svg+xml";
  6255. case "webp"_t: return "image/webp";
  6256. case "ico"_t: return "image/x-icon";
  6257. case "tif"_t: return "image/tiff";
  6258. case "tiff"_t: return "image/tiff";
  6259. case "jpg"_t:
  6260. case "jpeg"_t: return "image/jpeg";
  6261. case "mp4"_t: return "video/mp4";
  6262. case "mpeg"_t: return "video/mpeg";
  6263. case "webm"_t: return "video/webm";
  6264. case "mp3"_t: return "audio/mp3";
  6265. case "mpga"_t: return "audio/mpeg";
  6266. case "weba"_t: return "audio/webm";
  6267. case "wav"_t: return "audio/wave";
  6268. case "otf"_t: return "font/otf";
  6269. case "ttf"_t: return "font/ttf";
  6270. case "woff"_t: return "font/woff";
  6271. case "woff2"_t: return "font/woff2";
  6272. case "7z"_t: return "application/x-7z-compressed";
  6273. case "atom"_t: return "application/atom+xml";
  6274. case "pdf"_t: return "application/pdf";
  6275. case "json"_t: return "application/json";
  6276. case "rss"_t: return "application/rss+xml";
  6277. case "tar"_t: return "application/x-tar";
  6278. case "xht"_t:
  6279. case "xhtml"_t: return "application/xhtml+xml";
  6280. case "xslt"_t: return "application/xslt+xml";
  6281. case "xml"_t: return "application/xml";
  6282. case "gz"_t: return "application/gzip";
  6283. case "zip"_t: return "application/zip";
  6284. case "wasm"_t: return "application/wasm";
  6285. }
  6286. }
  6287. inline std::string
  6288. extract_media_type(const std::string &content_type,
  6289. std::map<std::string, std::string> *params = nullptr) {
  6290. // Extract type/subtype from Content-Type value (RFC 2045)
  6291. // e.g. "application/json; charset=utf-8" -> "application/json"
  6292. auto media_type = content_type;
  6293. auto semicolon_pos = media_type.find(';');
  6294. if (semicolon_pos != std::string::npos) {
  6295. auto param_str = media_type.substr(semicolon_pos + 1);
  6296. media_type = media_type.substr(0, semicolon_pos);
  6297. if (params) {
  6298. // Parse parameters: key=value pairs separated by ';'
  6299. split_unquoted(param_str.data(), param_str.data() + param_str.size(), ';',
  6300. [&](const char *b, const char *e) {
  6301. std::string key;
  6302. std::string val;
  6303. divide_param_pair(b, e, key, val);
  6304. if (!key.empty()) {
  6305. params->emplace(trim_copy(key),
  6306. trim_double_quotes_copy(val));
  6307. }
  6308. });
  6309. }
  6310. }
  6311. // Trim whitespace from media type
  6312. return trim_copy(media_type);
  6313. }
  6314. inline bool can_compress_content_type(const std::string &content_type) {
  6315. using udl::operator""_t;
  6316. auto mime_type = extract_media_type(content_type);
  6317. auto tag = str2tag(mime_type);
  6318. switch (tag) {
  6319. case "image/svg+xml"_t:
  6320. case "application/javascript"_t:
  6321. case "application/x-javascript"_t:
  6322. case "application/json"_t:
  6323. case "application/ld+json"_t:
  6324. case "application/xml"_t:
  6325. case "application/xhtml+xml"_t:
  6326. case "application/rss+xml"_t:
  6327. case "application/atom+xml"_t:
  6328. case "application/xslt+xml"_t:
  6329. case "application/protobuf"_t: return true;
  6330. case "text/event-stream"_t: return false;
  6331. default: return !mime_type.rfind("text/", 0);
  6332. }
  6333. }
  6334. inline bool parse_quality(const char *b, const char *e, std::string &token,
  6335. double &quality) {
  6336. quality = 1.0;
  6337. token.clear();
  6338. // Split on first ';': left = token name, right = parameters
  6339. const char *params_b = nullptr;
  6340. std::size_t params_len = 0;
  6341. divide(
  6342. b, static_cast<std::size_t>(e - b), ';',
  6343. [&](const char *lb, std::size_t llen, const char *rb, std::size_t rlen) {
  6344. auto r = trim(lb, lb + llen, 0, llen);
  6345. if (r.first < r.second) { token.assign(lb + r.first, lb + r.second); }
  6346. params_b = rb;
  6347. params_len = rlen;
  6348. });
  6349. if (token.empty()) { return false; }
  6350. if (params_len == 0) { return true; }
  6351. // Scan parameters for q= (stops on first match)
  6352. bool invalid = false;
  6353. split_find(params_b, params_b + params_len, ';',
  6354. (std::numeric_limits<size_t>::max)(),
  6355. [&](const char *pb, const char *pe) -> bool {
  6356. // Match exactly "q=" or "Q=" (not "query=" etc.)
  6357. auto len = static_cast<size_t>(pe - pb);
  6358. if (len < 2) { return false; }
  6359. if ((pb[0] != 'q' && pb[0] != 'Q') || pb[1] != '=') {
  6360. return false;
  6361. }
  6362. // Trim the value portion
  6363. auto r = trim(pb, pe, 2, len);
  6364. if (r.first >= r.second) {
  6365. invalid = true;
  6366. return true;
  6367. }
  6368. double v = 0.0;
  6369. auto res = from_chars(pb + r.first, pb + r.second, v);
  6370. if (res.ec != std::errc{} || res.ptr != pb + r.second ||
  6371. v < 0.0 || v > 1.0) {
  6372. invalid = true;
  6373. return true;
  6374. }
  6375. quality = v;
  6376. return true;
  6377. });
  6378. return !invalid;
  6379. }
  6380. inline EncodingType encoding_type(const Request &req,
  6381. const std::string &content_type) {
  6382. if (!can_compress_content_type(content_type)) { return EncodingType::None; }
  6383. auto s = get_combined_header_value(req.headers, "Accept-Encoding");
  6384. if (s.empty()) { return EncodingType::None; }
  6385. // Single-pass: iterate tokens and track the best supported encoding.
  6386. // Server preference breaks ties (br > gzip > zstd).
  6387. EncodingType best = EncodingType::None;
  6388. double best_q = 0.0; // q=0 means "not acceptable"
  6389. // Server preference: Brotli > Gzip > Zstd (lower = more preferred)
  6390. auto priority = [](EncodingType t) -> int {
  6391. switch (t) {
  6392. case EncodingType::Brotli: return 0;
  6393. case EncodingType::Gzip: return 1;
  6394. case EncodingType::Zstd: return 2;
  6395. default: return 3;
  6396. }
  6397. };
  6398. std::string name;
  6399. split(s.data(), s.data() + s.size(), ',', [&](const char *b, const char *e) {
  6400. double quality = 1.0;
  6401. if (!parse_quality(b, e, name, quality)) { return; }
  6402. if (quality <= 0.0) { return; }
  6403. EncodingType type = EncodingType::None;
  6404. #ifdef CPPHTTPLIB_BROTLI_SUPPORT
  6405. if (case_ignore::equal(name, "br")) { type = EncodingType::Brotli; }
  6406. #endif
  6407. #ifdef CPPHTTPLIB_ZLIB_SUPPORT
  6408. if (type == EncodingType::None && case_ignore::equal(name, "gzip")) {
  6409. type = EncodingType::Gzip;
  6410. }
  6411. #endif
  6412. #ifdef CPPHTTPLIB_ZSTD_SUPPORT
  6413. if (type == EncodingType::None && case_ignore::equal(name, "zstd")) {
  6414. type = EncodingType::Zstd;
  6415. }
  6416. #endif
  6417. if (type == EncodingType::None) { return; }
  6418. // Higher q-value wins; for equal q, server preference breaks ties
  6419. if (quality > best_q ||
  6420. (quality == best_q && priority(type) < priority(best))) {
  6421. best_q = quality;
  6422. best = type;
  6423. }
  6424. });
  6425. return best;
  6426. }
  6427. // `content_type` is taken separately because a file-backed response has not
  6428. // been given one yet when its coding has to be decided.
  6429. inline EncodingType encoding_type(const Request &req, const Response &res,
  6430. const std::string &content_type) {
  6431. // The response already names a content coding of its own: a handler serving
  6432. // a body it encoded itself (pre-compressed static assets, say), or a mount
  6433. // point whose headers name the coding its files are stored in. Applying one
  6434. // on top of that would double-encode the body and append a second
  6435. // `Content-Encoding` field line.
  6436. if (res.has_header("Content-Encoding")) { return EncodingType::None; }
  6437. return encoding_type(req, content_type);
  6438. }
  6439. inline EncodingType encoding_type(const Request &req, const Response &res) {
  6440. return encoding_type(req, res, res.get_header_value("Content-Type"));
  6441. }
  6442. inline std::unique_ptr<compressor> make_compressor(EncodingType type) {
  6443. #ifdef CPPHTTPLIB_ZLIB_SUPPORT
  6444. if (type == EncodingType::Gzip) {
  6445. return detail::make_unique<gzip_compressor>();
  6446. }
  6447. #endif
  6448. #ifdef CPPHTTPLIB_BROTLI_SUPPORT
  6449. if (type == EncodingType::Brotli) {
  6450. return detail::make_unique<brotli_compressor>();
  6451. }
  6452. #endif
  6453. #ifdef CPPHTTPLIB_ZSTD_SUPPORT
  6454. if (type == EncodingType::Zstd) {
  6455. return detail::make_unique<zstd_compressor>();
  6456. }
  6457. #endif
  6458. (void)type;
  6459. return nullptr;
  6460. }
  6461. inline const char *encoding_name(EncodingType type) {
  6462. switch (type) {
  6463. case EncodingType::Gzip: return "gzip";
  6464. case EncodingType::Brotli: return "br";
  6465. case EncodingType::Zstd: return "zstd";
  6466. default: return "";
  6467. }
  6468. }
  6469. inline bool nocompressor::compress(const char *data, size_t data_length,
  6470. bool /*last*/, Callback callback) {
  6471. if (!data_length) { return true; }
  6472. return callback(data, data_length);
  6473. }
  6474. #ifdef CPPHTTPLIB_ZLIB_SUPPORT
  6475. inline gzip_compressor::gzip_compressor() {
  6476. std::memset(&strm_, 0, sizeof(strm_));
  6477. strm_.zalloc = Z_NULL;
  6478. strm_.zfree = Z_NULL;
  6479. strm_.opaque = Z_NULL;
  6480. is_valid_ = deflateInit2(&strm_, Z_DEFAULT_COMPRESSION, Z_DEFLATED, 31, 8,
  6481. Z_DEFAULT_STRATEGY) == Z_OK;
  6482. }
  6483. inline gzip_compressor::~gzip_compressor() { deflateEnd(&strm_); }
  6484. inline bool gzip_compressor::compress(const char *data, size_t data_length,
  6485. bool last, Callback callback) {
  6486. assert(is_valid_);
  6487. do {
  6488. constexpr size_t max_avail_in =
  6489. (std::numeric_limits<decltype(strm_.avail_in)>::max)();
  6490. strm_.avail_in = static_cast<decltype(strm_.avail_in)>(
  6491. (std::min)(data_length, max_avail_in));
  6492. strm_.next_in = const_cast<Bytef *>(reinterpret_cast<const Bytef *>(data));
  6493. data_length -= strm_.avail_in;
  6494. data += strm_.avail_in;
  6495. auto flush = (last && data_length == 0) ? Z_FINISH : Z_NO_FLUSH;
  6496. auto ret = Z_OK;
  6497. std::array<char, CPPHTTPLIB_COMPRESSION_BUFSIZ> buff{};
  6498. do {
  6499. strm_.avail_out = static_cast<uInt>(buff.size());
  6500. strm_.next_out = reinterpret_cast<Bytef *>(buff.data());
  6501. ret = deflate(&strm_, flush);
  6502. if (ret == Z_STREAM_ERROR) { return false; }
  6503. if (!callback(buff.data(), buff.size() - strm_.avail_out)) {
  6504. return false;
  6505. }
  6506. } while (strm_.avail_out == 0);
  6507. assert((flush == Z_FINISH && ret == Z_STREAM_END) ||
  6508. (flush == Z_NO_FLUSH && ret == Z_OK));
  6509. assert(strm_.avail_in == 0);
  6510. } while (data_length > 0);
  6511. return true;
  6512. }
  6513. inline gzip_decompressor::gzip_decompressor() {
  6514. std::memset(&strm_, 0, sizeof(strm_));
  6515. strm_.zalloc = Z_NULL;
  6516. strm_.zfree = Z_NULL;
  6517. strm_.opaque = Z_NULL;
  6518. // 15 is the value of wbits, which should be at the maximum possible value
  6519. // to ensure that any gzip stream can be decoded. The offset of 32 specifies
  6520. // that the stream type should be automatically detected either gzip or
  6521. // deflate.
  6522. is_valid_ = inflateInit2(&strm_, 32 + 15) == Z_OK;
  6523. }
  6524. inline gzip_decompressor::~gzip_decompressor() { inflateEnd(&strm_); }
  6525. inline bool gzip_decompressor::is_valid() const { return is_valid_; }
  6526. inline bool gzip_decompressor::decompress(const char *data, size_t data_length,
  6527. Callback callback) {
  6528. assert(is_valid_);
  6529. auto ret = Z_OK;
  6530. do {
  6531. constexpr size_t max_avail_in =
  6532. (std::numeric_limits<decltype(strm_.avail_in)>::max)();
  6533. strm_.avail_in = static_cast<decltype(strm_.avail_in)>(
  6534. (std::min)(data_length, max_avail_in));
  6535. strm_.next_in = const_cast<Bytef *>(reinterpret_cast<const Bytef *>(data));
  6536. data_length -= strm_.avail_in;
  6537. data += strm_.avail_in;
  6538. std::array<char, CPPHTTPLIB_COMPRESSION_BUFSIZ> buff{};
  6539. while (strm_.avail_in > 0 && ret == Z_OK) {
  6540. strm_.avail_out = static_cast<uInt>(buff.size());
  6541. strm_.next_out = reinterpret_cast<Bytef *>(buff.data());
  6542. ret = inflate(&strm_, Z_NO_FLUSH);
  6543. assert(ret != Z_STREAM_ERROR);
  6544. switch (ret) {
  6545. case Z_NEED_DICT:
  6546. case Z_DATA_ERROR:
  6547. case Z_MEM_ERROR: inflateEnd(&strm_); return false;
  6548. }
  6549. if (!callback(buff.data(), buff.size() - strm_.avail_out)) {
  6550. return false;
  6551. }
  6552. }
  6553. if (ret != Z_OK && ret != Z_STREAM_END) { return false; }
  6554. } while (data_length > 0);
  6555. return true;
  6556. }
  6557. #endif
  6558. #ifdef CPPHTTPLIB_BROTLI_SUPPORT
  6559. inline brotli_compressor::brotli_compressor() {
  6560. state_ = BrotliEncoderCreateInstance(nullptr, nullptr, nullptr);
  6561. }
  6562. inline brotli_compressor::~brotli_compressor() {
  6563. BrotliEncoderDestroyInstance(state_);
  6564. }
  6565. inline bool brotli_compressor::compress(const char *data, size_t data_length,
  6566. bool last, Callback callback) {
  6567. std::array<uint8_t, CPPHTTPLIB_COMPRESSION_BUFSIZ> buff{};
  6568. auto operation = last ? BROTLI_OPERATION_FINISH : BROTLI_OPERATION_PROCESS;
  6569. auto available_in = data_length;
  6570. auto next_in = reinterpret_cast<const uint8_t *>(data);
  6571. for (;;) {
  6572. if (last) {
  6573. if (BrotliEncoderIsFinished(state_)) { break; }
  6574. } else {
  6575. if (!available_in) { break; }
  6576. }
  6577. auto available_out = buff.size();
  6578. auto next_out = buff.data();
  6579. if (!BrotliEncoderCompressStream(state_, operation, &available_in, &next_in,
  6580. &available_out, &next_out, nullptr)) {
  6581. return false;
  6582. }
  6583. auto output_bytes = buff.size() - available_out;
  6584. if (output_bytes) {
  6585. callback(reinterpret_cast<const char *>(buff.data()), output_bytes);
  6586. }
  6587. }
  6588. return true;
  6589. }
  6590. inline brotli_decompressor::brotli_decompressor() {
  6591. decoder_s = BrotliDecoderCreateInstance(0, 0, 0);
  6592. decoder_r = decoder_s ? BROTLI_DECODER_RESULT_NEEDS_MORE_INPUT
  6593. : BROTLI_DECODER_RESULT_ERROR;
  6594. }
  6595. inline brotli_decompressor::~brotli_decompressor() {
  6596. if (decoder_s) { BrotliDecoderDestroyInstance(decoder_s); }
  6597. }
  6598. inline bool brotli_decompressor::is_valid() const { return decoder_s; }
  6599. inline bool brotli_decompressor::decompress(const char *data,
  6600. size_t data_length,
  6601. Callback callback) {
  6602. if (decoder_r == BROTLI_DECODER_RESULT_SUCCESS ||
  6603. decoder_r == BROTLI_DECODER_RESULT_ERROR) {
  6604. return 0;
  6605. }
  6606. auto next_in = reinterpret_cast<const uint8_t *>(data);
  6607. size_t avail_in = data_length;
  6608. size_t total_out;
  6609. decoder_r = BROTLI_DECODER_RESULT_NEEDS_MORE_OUTPUT;
  6610. std::array<char, CPPHTTPLIB_COMPRESSION_BUFSIZ> buff{};
  6611. while (decoder_r == BROTLI_DECODER_RESULT_NEEDS_MORE_OUTPUT) {
  6612. char *next_out = buff.data();
  6613. size_t avail_out = buff.size();
  6614. decoder_r = BrotliDecoderDecompressStream(
  6615. decoder_s, &avail_in, &next_in, &avail_out,
  6616. reinterpret_cast<uint8_t **>(&next_out), &total_out);
  6617. if (decoder_r == BROTLI_DECODER_RESULT_ERROR) { return false; }
  6618. if (!callback(buff.data(), buff.size() - avail_out)) { return false; }
  6619. }
  6620. return decoder_r == BROTLI_DECODER_RESULT_SUCCESS ||
  6621. decoder_r == BROTLI_DECODER_RESULT_NEEDS_MORE_INPUT;
  6622. }
  6623. #endif
  6624. #ifdef CPPHTTPLIB_ZSTD_SUPPORT
  6625. inline zstd_compressor::zstd_compressor() {
  6626. ctx_ = ZSTD_createCCtx();
  6627. ZSTD_CCtx_setParameter(ctx_, ZSTD_c_compressionLevel, ZSTD_fast);
  6628. }
  6629. inline zstd_compressor::~zstd_compressor() { ZSTD_freeCCtx(ctx_); }
  6630. inline bool zstd_compressor::compress(const char *data, size_t data_length,
  6631. bool last, Callback callback) {
  6632. std::array<char, CPPHTTPLIB_COMPRESSION_BUFSIZ> buff{};
  6633. ZSTD_EndDirective mode = last ? ZSTD_e_end : ZSTD_e_continue;
  6634. ZSTD_inBuffer input = {data, data_length, 0};
  6635. bool finished;
  6636. do {
  6637. ZSTD_outBuffer output = {buff.data(), CPPHTTPLIB_COMPRESSION_BUFSIZ, 0};
  6638. size_t const remaining = ZSTD_compressStream2(ctx_, &output, &input, mode);
  6639. if (ZSTD_isError(remaining)) { return false; }
  6640. if (!callback(buff.data(), output.pos)) { return false; }
  6641. finished = last ? (remaining == 0) : (input.pos == input.size);
  6642. } while (!finished);
  6643. return true;
  6644. }
  6645. inline zstd_decompressor::zstd_decompressor() { ctx_ = ZSTD_createDCtx(); }
  6646. inline zstd_decompressor::~zstd_decompressor() { ZSTD_freeDCtx(ctx_); }
  6647. inline bool zstd_decompressor::is_valid() const { return ctx_ != nullptr; }
  6648. inline bool zstd_decompressor::decompress(const char *data, size_t data_length,
  6649. Callback callback) {
  6650. std::array<char, CPPHTTPLIB_COMPRESSION_BUFSIZ> buff{};
  6651. ZSTD_inBuffer input = {data, data_length, 0};
  6652. while (input.pos < input.size) {
  6653. ZSTD_outBuffer output = {buff.data(), CPPHTTPLIB_COMPRESSION_BUFSIZ, 0};
  6654. size_t const remaining = ZSTD_decompressStream(ctx_, &output, &input);
  6655. if (ZSTD_isError(remaining)) { return false; }
  6656. if (!callback(buff.data(), output.pos)) { return false; }
  6657. }
  6658. return true;
  6659. }
  6660. #endif
  6661. // Content codings are case-insensitive (RFC 9110 8.4.1). Matching them
  6662. // case-sensitively would make a response labeled e.g. "GZIP" look like an
  6663. // unknown coding, and its payload would be handed back still compressed.
  6664. inline bool is_zlib_encoding(const std::string &encoding) {
  6665. return case_ignore::equal(encoding, "gzip") ||
  6666. case_ignore::equal(encoding, "deflate");
  6667. }
  6668. inline bool is_brotli_encoding(const std::string &encoding) {
  6669. return case_ignore::equal(encoding, "br");
  6670. }
  6671. inline bool is_zstd_encoding(const std::string &encoding) {
  6672. return case_ignore::equal(encoding, "zstd");
  6673. }
  6674. // Returns true if the content coding is one cpp-httplib is able to decompress
  6675. // when the corresponding support is compiled in.
  6676. inline bool is_known_content_encoding(const std::string &encoding) {
  6677. return is_zlib_encoding(encoding) || is_brotli_encoding(encoding) ||
  6678. is_zstd_encoding(encoding);
  6679. }
  6680. inline std::unique_ptr<decompressor>
  6681. create_decompressor(const std::string &encoding) {
  6682. std::unique_ptr<decompressor> decompressor;
  6683. if (is_zlib_encoding(encoding)) {
  6684. #ifdef CPPHTTPLIB_ZLIB_SUPPORT
  6685. decompressor = detail::make_unique<gzip_decompressor>();
  6686. #endif
  6687. } else if (is_brotli_encoding(encoding)) {
  6688. #ifdef CPPHTTPLIB_BROTLI_SUPPORT
  6689. decompressor = detail::make_unique<brotli_decompressor>();
  6690. #endif
  6691. } else if (is_zstd_encoding(encoding)) {
  6692. #ifdef CPPHTTPLIB_ZSTD_SUPPORT
  6693. decompressor = detail::make_unique<zstd_decompressor>();
  6694. #endif
  6695. }
  6696. return decompressor;
  6697. }
  6698. // Returns the best available compressor and its Content-Encoding name.
  6699. // Priority: Brotli > Gzip > Zstd (matches server-side preference).
  6700. inline std::pair<std::unique_ptr<compressor>, const char *>
  6701. create_compressor() {
  6702. #ifdef CPPHTTPLIB_BROTLI_SUPPORT
  6703. return {detail::make_unique<brotli_compressor>(), "br"};
  6704. #elif defined(CPPHTTPLIB_ZLIB_SUPPORT)
  6705. return {detail::make_unique<gzip_compressor>(), "gzip"};
  6706. #elif defined(CPPHTTPLIB_ZSTD_SUPPORT)
  6707. return {detail::make_unique<zstd_compressor>(), "zstd"};
  6708. #else
  6709. return {nullptr, nullptr};
  6710. #endif
  6711. }
  6712. inline bool is_prohibited_header_name(const std::string &name) {
  6713. using udl::operator""_t;
  6714. switch (str2tag(name)) {
  6715. case "REMOTE_ADDR"_t:
  6716. case "REMOTE_PORT"_t:
  6717. case "LOCAL_ADDR"_t:
  6718. case "LOCAL_PORT"_t: return true;
  6719. default: return false;
  6720. }
  6721. }
  6722. inline bool has_header(const Headers &headers, const std::string &key) {
  6723. if (is_prohibited_header_name(key)) { return false; }
  6724. return headers.find(key) != headers.end();
  6725. }
  6726. inline const char *get_header_value(const Headers &headers,
  6727. const std::string &key, const char *def,
  6728. size_t id) {
  6729. if (is_prohibited_header_name(key)) {
  6730. #ifndef CPPHTTPLIB_NO_EXCEPTIONS
  6731. std::string msg = "Prohibited header name '" + key + "' is specified.";
  6732. throw std::invalid_argument(msg);
  6733. #else
  6734. return "";
  6735. #endif
  6736. }
  6737. auto rng = headers.equal_range(key);
  6738. auto it = rng.first;
  6739. std::advance(it, static_cast<ssize_t>(id));
  6740. if (it != rng.second) { return it->second.c_str(); }
  6741. return def;
  6742. }
  6743. inline size_t get_header_value_count(const Headers &headers,
  6744. const std::string &key) {
  6745. return headers.count(key);
  6746. }
  6747. // RFC 9110 Section 5.2 and 5.3: a field that is defined as a comma-separated
  6748. // list may be sent as several field lines, and the combined field value is
  6749. // those values joined by commas in the order they were received. Callers that
  6750. // parse such a list must work on the combined value; reading only the first
  6751. // occurrence silently drops whatever the later field lines carry.
  6752. inline std::string get_combined_header_value(const Headers &headers,
  6753. const std::string &key) {
  6754. std::string combined;
  6755. auto rng = headers.equal_range(key);
  6756. for (auto it = rng.first; it != rng.second; ++it) {
  6757. // RFC 9110 Section 5.6.1.2: a recipient has to parse and ignore empty list
  6758. // elements, so an empty field line must not contribute a bare comma to the
  6759. // combined value.
  6760. if (it->second.empty()) { continue; }
  6761. if (!combined.empty()) { combined += ", "; }
  6762. combined += it->second;
  6763. }
  6764. return combined;
  6765. }
  6766. inline bool has_header_token(const Headers &headers, const std::string &key,
  6767. const std::string &token) {
  6768. // RFC 9110 7.6.1: a comma-separated token list field such as Connection may
  6769. // carry several tokens, and RFC 9110 5.3 lets that list be split across
  6770. // several lines. Match complete tokens rather than searching the raw value,
  6771. // so that a value such as "notupgrade" is not read as the token "upgrade".
  6772. auto rng = headers.equal_range(key);
  6773. for (auto it = rng.first; it != rng.second; ++it) {
  6774. const auto &value = it->second;
  6775. if (split_find(value.data(), value.data() + value.size(), ',',
  6776. [&](const char *b, const char *e) {
  6777. return case_ignore::equal(std::string(b, e), token);
  6778. })) {
  6779. return true;
  6780. }
  6781. }
  6782. return false;
  6783. }
  6784. template <typename Map>
  6785. inline typename Map::mapped_type
  6786. get_multimap_value(const Map &m, const std::string &key, size_t id) {
  6787. auto rng = m.equal_range(key);
  6788. auto it = rng.first;
  6789. std::advance(it, static_cast<ssize_t>(id));
  6790. if (it != rng.second) { return it->second; }
  6791. return typename Map::mapped_type();
  6792. }
  6793. inline void set_header(Headers &headers, const std::string &key,
  6794. const std::string &val) {
  6795. if (fields::is_field_valid(key, val)) { headers.emplace(key, val); }
  6796. }
  6797. inline bool read_headers(Stream &strm, Headers &headers) {
  6798. const auto bufsiz = 2048;
  6799. char buf[bufsiz];
  6800. stream_line_reader line_reader(strm, buf, bufsiz);
  6801. size_t header_count = 0;
  6802. for (;;) {
  6803. if (!line_reader.getline()) { return false; }
  6804. // Check if the line ends with CRLF.
  6805. auto line_terminator_len = 2;
  6806. if (line_reader.end_with_crlf()) {
  6807. // Blank line indicates end of headers.
  6808. if (line_reader.size() == 2) { break; }
  6809. } else {
  6810. #ifdef CPPHTTPLIB_ALLOW_LF_AS_LINE_TERMINATOR
  6811. // Blank line indicates end of headers.
  6812. if (line_reader.size() == 1) { break; }
  6813. line_terminator_len = 1;
  6814. #else
  6815. continue; // Skip invalid line.
  6816. #endif
  6817. }
  6818. if (line_reader.size() > CPPHTTPLIB_HEADER_MAX_LENGTH) { return false; }
  6819. // Check header count limit
  6820. if (header_count >= CPPHTTPLIB_HEADER_MAX_COUNT) { return false; }
  6821. // Exclude line terminator
  6822. auto end = line_reader.ptr() + line_reader.size() - line_terminator_len;
  6823. if (!parse_header(line_reader.ptr(), end,
  6824. [&](const std::string &key, const std::string &val) {
  6825. headers.emplace(key, val);
  6826. })) {
  6827. return false;
  6828. }
  6829. header_count++;
  6830. }
  6831. // RFC 9110 Section 8.6: Reject requests with multiple Content-Length
  6832. // headers that have different values to prevent request smuggling.
  6833. auto cl_range = headers.equal_range("Content-Length");
  6834. if (cl_range.first != cl_range.second) {
  6835. const auto &first_val = cl_range.first->second;
  6836. for (auto it = std::next(cl_range.first); it != cl_range.second; ++it) {
  6837. if (it->second != first_val) { return false; }
  6838. }
  6839. }
  6840. return true;
  6841. }
  6842. inline bool parse_status_line(const char *line, std::string &version,
  6843. int &status, std::string &reason) {
  6844. #ifdef CPPHTTPLIB_ALLOW_LF_AS_LINE_TERMINATOR
  6845. thread_local const std::regex re("(HTTP/1\\.[01]) (\\d{3})(?: (.*?))?\r?\n");
  6846. #else
  6847. thread_local const std::regex re("(HTTP/1\\.[01]) (\\d{3})(?: (.*?))?\r\n");
  6848. #endif
  6849. std::cmatch m;
  6850. if (!std::regex_match(line, m, re)) { return false; }
  6851. version = std::string(m[1]);
  6852. status = std::stoi(std::string(m[2]));
  6853. reason = std::string(m[3]);
  6854. return true;
  6855. }
  6856. // Everything WebSocketClient::connect() reports about the upgrade exchange.
  6857. // status stays -1 until a status line is parsed, mirroring stream::Result.
  6858. struct WebSocketUpgradeResponse {
  6859. Error error = Error::Success;
  6860. int status = -1;
  6861. Headers headers;
  6862. std::string selected_subprotocol;
  6863. };
  6864. inline bool read_websocket_upgrade_response(Stream &strm,
  6865. const std::string &expected_accept,
  6866. WebSocketUpgradeResponse &upgrade) {
  6867. // Read status line
  6868. const auto bufsiz = 2048;
  6869. char buf[bufsiz];
  6870. stream_line_reader line_reader(strm, buf, bufsiz);
  6871. if (!line_reader.getline()) {
  6872. upgrade.error = Error::Read;
  6873. return false;
  6874. }
  6875. std::string version;
  6876. std::string reason;
  6877. if (!parse_status_line(line_reader.ptr(), version, upgrade.status, reason)) {
  6878. upgrade.error = Error::WebSocketHandshake;
  6879. return false;
  6880. }
  6881. // Read the headers even for a rejection so the caller can see why the
  6882. // server refused the upgrade. A non-101 response may carry a body; it is
  6883. // deliberately left unread since the caller closes the socket right away.
  6884. if (!read_headers(strm, upgrade.headers)) {
  6885. upgrade.error = Error::Read;
  6886. return false;
  6887. }
  6888. const auto &headers = upgrade.headers;
  6889. if (upgrade.status != StatusCode::SwitchingProtocol_101) {
  6890. upgrade.error = Error::WebSocketHandshake;
  6891. return false;
  6892. }
  6893. // Verify Upgrade: websocket (a comma-separated list, matched per token)
  6894. if (!has_header_token(headers, "Upgrade", "websocket")) {
  6895. upgrade.error = Error::WebSocketHandshake;
  6896. return false;
  6897. }
  6898. // Verify Connection: Upgrade
  6899. if (!has_header_token(headers, "Connection", "upgrade")) {
  6900. upgrade.error = Error::WebSocketHandshake;
  6901. return false;
  6902. }
  6903. // Verify Sec-WebSocket-Accept header value
  6904. auto it = headers.find("Sec-WebSocket-Accept");
  6905. if (it == headers.end() || it->second != expected_accept) {
  6906. upgrade.error = Error::WebSocketHandshake;
  6907. return false;
  6908. }
  6909. // Extract negotiated subprotocol
  6910. auto proto_it = headers.find("Sec-WebSocket-Protocol");
  6911. if (proto_it != headers.end()) {
  6912. upgrade.selected_subprotocol = proto_it->second;
  6913. }
  6914. return true;
  6915. }
  6916. enum class ReadContentResult {
  6917. Success, // Successfully read the content
  6918. PayloadTooLarge, // The content exceeds the specified payload limit
  6919. Error // An error occurred while reading the content
  6920. };
  6921. inline ReadContentResult read_content_with_length(
  6922. Stream &strm, size_t len, DownloadProgress progress,
  6923. ContentReceiverWithProgress out,
  6924. size_t payload_max_length = (std::numeric_limits<size_t>::max)()) {
  6925. char buf[CPPHTTPLIB_RECV_BUFSIZ];
  6926. detail::BodyReader br;
  6927. br.stream = &strm;
  6928. br.has_content_length = true;
  6929. br.content_length = len;
  6930. br.payload_max_length = payload_max_length;
  6931. br.chunked = false;
  6932. br.bytes_read = 0;
  6933. br.last_error = Error::Success;
  6934. size_t r = 0;
  6935. while (r < len) {
  6936. auto read_len = static_cast<size_t>(len - r);
  6937. auto to_read = (std::min)(read_len, CPPHTTPLIB_RECV_BUFSIZ);
  6938. auto n = detail::read_body_content(&strm, br, buf, to_read);
  6939. if (n <= 0) {
  6940. // Check if it was a payload size error
  6941. if (br.last_error == Error::ExceedMaxPayloadSize) {
  6942. return ReadContentResult::PayloadTooLarge;
  6943. }
  6944. return ReadContentResult::Error;
  6945. }
  6946. if (!out(buf, static_cast<size_t>(n), r, len)) {
  6947. return ReadContentResult::Error;
  6948. }
  6949. r += static_cast<size_t>(n);
  6950. if (progress) {
  6951. if (!progress(r, len)) { return ReadContentResult::Error; }
  6952. }
  6953. }
  6954. return ReadContentResult::Success;
  6955. }
  6956. inline ReadContentResult
  6957. read_content_without_length(Stream &strm, size_t payload_max_length,
  6958. ContentReceiverWithProgress out) {
  6959. char buf[CPPHTTPLIB_RECV_BUFSIZ];
  6960. size_t r = 0;
  6961. for (;;) {
  6962. auto n = strm.read(buf, CPPHTTPLIB_RECV_BUFSIZ);
  6963. if (n == 0) { return ReadContentResult::Success; }
  6964. if (n < 0) { return ReadContentResult::Error; }
  6965. // Check if adding this data would exceed the payload limit
  6966. if (r > payload_max_length ||
  6967. payload_max_length - r < static_cast<size_t>(n)) {
  6968. return ReadContentResult::PayloadTooLarge;
  6969. }
  6970. if (!out(buf, static_cast<size_t>(n), r, 0)) {
  6971. return ReadContentResult::Error;
  6972. }
  6973. r += static_cast<size_t>(n);
  6974. }
  6975. return ReadContentResult::Success;
  6976. }
  6977. template <typename T>
  6978. inline ReadContentResult read_content_chunked(Stream &strm, T &x,
  6979. size_t payload_max_length,
  6980. ContentReceiverWithProgress out) {
  6981. detail::ChunkedDecoder dec(strm);
  6982. char buf[CPPHTTPLIB_RECV_BUFSIZ];
  6983. size_t total_len = 0;
  6984. for (;;) {
  6985. size_t chunk_offset = 0;
  6986. size_t chunk_total = 0;
  6987. auto n = dec.read_payload(buf, sizeof(buf), chunk_offset, chunk_total);
  6988. if (n < 0) { return ReadContentResult::Error; }
  6989. if (n == 0) {
  6990. if (!dec.parse_trailers_into(x.trailers, x.headers)) {
  6991. return ReadContentResult::Error;
  6992. }
  6993. return ReadContentResult::Success;
  6994. }
  6995. if (total_len > payload_max_length ||
  6996. payload_max_length - total_len < static_cast<size_t>(n)) {
  6997. return ReadContentResult::PayloadTooLarge;
  6998. }
  6999. if (!out(buf, static_cast<size_t>(n), chunk_offset, chunk_total)) {
  7000. return ReadContentResult::Error;
  7001. }
  7002. total_len += static_cast<size_t>(n);
  7003. }
  7004. }
  7005. inline bool is_chunked_transfer_encoding(const Headers &headers) {
  7006. // RFC 9112 6.1: a message is framed with the chunked coding when "chunked"
  7007. // is the final transfer coding. A single field value may list several
  7008. // codings ("gzip, chunked"), and RFC 9110 5.3 lets that list be split across
  7009. // several Transfer-Encoding lines, which combine into one comma-separated
  7010. // list in the order the lines were received. Headers preserves that order,
  7011. // so the final coding is the last token of the last line. Match it
  7012. // case-insensitively rather than comparing the whole value against
  7013. // "chunked".
  7014. //
  7015. // Security: reading a chunked message as unframed leaves its body in the
  7016. // socket, where a keep-alive connection parses it as a smuggled request.
  7017. // Server::process_request() answers 400 and closes when the final coding is
  7018. // not chunked, so a request whose framing cannot be determined never
  7019. // reaches the "no body" path.
  7020. auto rng = headers.equal_range("Transfer-Encoding");
  7021. if (rng.first == rng.second) { return false; }
  7022. // Cleared per line, so a trailing line carrying no coding at all leaves the
  7023. // combined list ending in nothing rather than inheriting the line before it.
  7024. std::string last_coding;
  7025. for (auto it = rng.first; it != rng.second; ++it) {
  7026. const auto &value = it->second;
  7027. last_coding.clear();
  7028. split(value.data(), value.data() + value.size(), ',',
  7029. [&](const char *b, const char *e) { last_coding.assign(b, e); });
  7030. }
  7031. return case_ignore::equal(last_coding, "chunked");
  7032. }
  7033. inline bool has_conflicting_content_length(const Headers &headers) {
  7034. // RFC 9112 §6.3: a message carrying both Transfer-Encoding and a non-zero
  7035. // Content-Length is framed ambiguously. The body readers here delimit it by
  7036. // the transfer coding and drop Content-Length, while an intermediary may do
  7037. // the reverse, so the two disagree on where the body ends and a reused
  7038. // connection is desynchronised (request/response smuggling). Content-Length:
  7039. // 0 is tolerated for compatibility with existing peers.
  7040. return has_header(headers, "Transfer-Encoding") &&
  7041. get_header_value_u64(headers, "Content-Length", 0, 0) > 0;
  7042. }
  7043. template <typename T, typename U>
  7044. bool prepare_content_receiver(T &x, int &status,
  7045. ContentReceiverWithProgress receiver,
  7046. bool decompress, size_t payload_max_length,
  7047. bool &exceed_payload_max_length, U callback) {
  7048. if (decompress) {
  7049. auto encoding = get_combined_header_value(x.headers, "Content-Encoding");
  7050. std::unique_ptr<decompressor> decompressor;
  7051. if (!encoding.empty()) {
  7052. // A coding we know about but were not built with is an error. An
  7053. // unrecognized coding (including "identity") is left alone and the
  7054. // payload is passed through as-is, since some servers misuse the header,
  7055. // e.g. by sending a character set such as "Content-Encoding: UTF-8".
  7056. decompressor = detail::create_decompressor(encoding);
  7057. if (!decompressor && detail::is_known_content_encoding(encoding)) {
  7058. status = StatusCode::UnsupportedMediaType_415;
  7059. return false;
  7060. }
  7061. }
  7062. if (decompressor) {
  7063. if (decompressor->is_valid()) {
  7064. size_t decompressed_size = 0;
  7065. ContentReceiverWithProgress out = [&](const char *buf, size_t n,
  7066. size_t off, size_t len) {
  7067. return decompressor->decompress(
  7068. buf, n, [&](const char *buf2, size_t n2) {
  7069. // Guard against zip-bomb: check
  7070. // decompressed size against limit.
  7071. if (payload_max_length > 0 &&
  7072. (decompressed_size >= payload_max_length ||
  7073. n2 > payload_max_length - decompressed_size)) {
  7074. exceed_payload_max_length = true;
  7075. return false;
  7076. }
  7077. decompressed_size += n2;
  7078. return receiver(buf2, n2, off, len);
  7079. });
  7080. };
  7081. return callback(std::move(out));
  7082. } else {
  7083. status = StatusCode::InternalServerError_500;
  7084. return false;
  7085. }
  7086. }
  7087. }
  7088. ContentReceiverWithProgress out = [&](const char *buf, size_t n, size_t off,
  7089. size_t len) {
  7090. return receiver(buf, n, off, len);
  7091. };
  7092. return callback(std::move(out));
  7093. }
  7094. template <typename T>
  7095. bool read_content(Stream &strm, T &x, size_t payload_max_length, int &status,
  7096. DownloadProgress progress,
  7097. ContentReceiverWithProgress receiver, bool decompress) {
  7098. bool exceed_payload_max_length = false;
  7099. return prepare_content_receiver(
  7100. x, status, std::move(receiver), decompress, payload_max_length,
  7101. exceed_payload_max_length, [&](const ContentReceiverWithProgress &out) {
  7102. auto ret = true;
  7103. // Note: exceed_payload_max_length may also be set by the decompressor
  7104. // wrapper in prepare_content_receiver when the decompressed payload
  7105. // size exceeds the limit.
  7106. if (is_chunked_transfer_encoding(x.headers)) {
  7107. auto result = read_content_chunked(strm, x, payload_max_length, out);
  7108. if (result == ReadContentResult::Success) {
  7109. ret = true;
  7110. } else if (result == ReadContentResult::PayloadTooLarge) {
  7111. exceed_payload_max_length = true;
  7112. ret = false;
  7113. } else {
  7114. ret = false;
  7115. }
  7116. } else if (!has_header(x.headers, "Content-Length")) {
  7117. auto result =
  7118. read_content_without_length(strm, payload_max_length, out);
  7119. if (result == ReadContentResult::Success) {
  7120. ret = true;
  7121. } else if (result == ReadContentResult::PayloadTooLarge) {
  7122. exceed_payload_max_length = true;
  7123. ret = false;
  7124. } else {
  7125. ret = false;
  7126. }
  7127. } else {
  7128. auto is_invalid_value = false;
  7129. auto len = get_header_value_u64(x.headers, "Content-Length",
  7130. (std::numeric_limits<size_t>::max)(),
  7131. 0, is_invalid_value);
  7132. if (is_invalid_value) {
  7133. ret = false;
  7134. } else if (len > 0) {
  7135. auto result = read_content_with_length(
  7136. strm, len, std::move(progress), out, payload_max_length);
  7137. ret = (result == ReadContentResult::Success);
  7138. if (result == ReadContentResult::PayloadTooLarge) {
  7139. exceed_payload_max_length = true;
  7140. }
  7141. }
  7142. }
  7143. if (!ret) {
  7144. status = exceed_payload_max_length ? StatusCode::PayloadTooLarge_413
  7145. : StatusCode::BadRequest_400;
  7146. }
  7147. return ret;
  7148. });
  7149. }
  7150. inline ssize_t write_request_line(Stream &strm, const std::string &method,
  7151. const std::string &path) {
  7152. // Neither the method nor the request target may carry CR/LF, SP or other
  7153. // control octets; otherwise a value smuggled into either splits the request
  7154. // line and injects headers or a whole request.
  7155. if (!fields::is_token(method)) { return -1; }
  7156. if (!fields::is_request_target(path)) { return -1; }
  7157. std::string s = method;
  7158. s += ' ';
  7159. s += path;
  7160. s += " HTTP/1.1\r\n";
  7161. return strm.write(s.data(), s.size());
  7162. }
  7163. inline ssize_t write_response_line(Stream &strm, int status) {
  7164. std::string s = "HTTP/1.1 ";
  7165. s += std::to_string(status);
  7166. s += ' ';
  7167. s += httplib::status_message(status);
  7168. s += "\r\n";
  7169. return strm.write(s.data(), s.size());
  7170. }
  7171. inline ssize_t write_headers(Stream &strm, const Headers &headers) {
  7172. ssize_t write_len = 0;
  7173. for (const auto &x : headers) {
  7174. // Skip fields with invalid names or values to prevent response splitting
  7175. // via CR/LF injection, matching set_header(). The client validates request
  7176. // headers up front in check_and_write_headers, but the server passes
  7177. // res.headers straight to this writer, and res.headers is a public field
  7178. // an application can populate directly with request-derived values.
  7179. if (!fields::is_field_valid(x.first, x.second)) { continue; }
  7180. std::string s;
  7181. s = x.first;
  7182. s += ": ";
  7183. s += x.second;
  7184. s += "\r\n";
  7185. auto len = strm.write(s.data(), s.size());
  7186. if (len < 0) { return len; }
  7187. write_len += len;
  7188. }
  7189. auto len = strm.write("\r\n");
  7190. if (len < 0) { return len; }
  7191. write_len += len;
  7192. return write_len;
  7193. }
  7194. inline bool write_data(Stream &strm, const char *d, size_t l) {
  7195. size_t offset = 0;
  7196. while (offset < l) {
  7197. auto length = strm.write(d + offset, l - offset);
  7198. if (length < 0) { return false; }
  7199. offset += static_cast<size_t>(length);
  7200. }
  7201. return true;
  7202. }
  7203. template <typename T>
  7204. inline bool write_content_with_progress(Stream &strm,
  7205. const ContentProvider &content_provider,
  7206. size_t offset, size_t length,
  7207. T is_shutting_down,
  7208. const UploadProgress &upload_progress,
  7209. Error &error) {
  7210. size_t end_offset = offset + length;
  7211. size_t start_offset = offset;
  7212. auto ok = true;
  7213. auto finished = false;
  7214. DataSink data_sink;
  7215. data_sink.write = [&](const char *d, size_t l) -> bool {
  7216. if (ok) {
  7217. if (write_data(strm, d, l)) {
  7218. offset += l;
  7219. if (upload_progress && length > 0) {
  7220. size_t current_written = offset - start_offset;
  7221. if (!upload_progress(current_written, length)) {
  7222. ok = false;
  7223. return false;
  7224. }
  7225. }
  7226. } else {
  7227. ok = false;
  7228. }
  7229. }
  7230. return ok;
  7231. };
  7232. data_sink.is_writable = [&]() -> bool { return strm.is_peer_alive(); };
  7233. // The body is framed by `length`, so a provider that reports itself done
  7234. // early has truncated it. Record that and let the short-body check below
  7235. // fail the write, rather than calling the provider again forever.
  7236. data_sink.done = [&]() { finished = true; };
  7237. while (offset < end_offset && !finished && !is_shutting_down()) {
  7238. auto last_offset = offset;
  7239. if (!strm.wait_writable() || !strm.is_peer_alive()) {
  7240. error = Error::Write;
  7241. return false;
  7242. } else if (!content_provider(offset, end_offset - offset, data_sink)) {
  7243. error = Error::Canceled;
  7244. return false;
  7245. } else if (!ok) {
  7246. error = Error::Write;
  7247. return false;
  7248. }
  7249. // A provider that reports success without writing anything and without
  7250. // reporting itself done gets handed the same offset and length again on
  7251. // the next pass, so it would spin here for as long as the peer stays
  7252. // connected. Treat making no progress as a short body, like done() early.
  7253. if (!finished && offset == last_offset) {
  7254. error = Error::Write;
  7255. return false;
  7256. }
  7257. }
  7258. if (offset < end_offset) { // done() called early, or is_shutting_down()
  7259. error = Error::Write;
  7260. return false;
  7261. }
  7262. error = Error::Success;
  7263. return true;
  7264. }
  7265. template <typename T>
  7266. inline bool write_content(Stream &strm, const ContentProvider &content_provider,
  7267. size_t offset, size_t length, T is_shutting_down,
  7268. Error &error) {
  7269. return write_content_with_progress<T>(strm, content_provider, offset, length,
  7270. is_shutting_down, nullptr, error);
  7271. }
  7272. template <typename T>
  7273. inline bool write_content(Stream &strm, const ContentProvider &content_provider,
  7274. size_t offset, size_t length,
  7275. const T &is_shutting_down) {
  7276. auto error = Error::Success;
  7277. return write_content(strm, content_provider, offset, length, is_shutting_down,
  7278. error);
  7279. }
  7280. template <typename T>
  7281. inline bool
  7282. write_content_without_length(Stream &strm,
  7283. const ContentProvider &content_provider,
  7284. const T &is_shutting_down) {
  7285. size_t offset = 0;
  7286. auto data_available = true;
  7287. auto ok = true;
  7288. DataSink data_sink;
  7289. data_sink.write = [&](const char *d, size_t l) -> bool {
  7290. if (ok) {
  7291. offset += l;
  7292. if (!write_data(strm, d, l)) { ok = false; }
  7293. }
  7294. return ok;
  7295. };
  7296. data_sink.is_writable = [&]() -> bool { return strm.is_peer_alive(); };
  7297. data_sink.done = [&](void) { data_available = false; };
  7298. while (data_available && !is_shutting_down()) {
  7299. if (!strm.wait_writable() || !strm.is_peer_alive()) {
  7300. return false;
  7301. } else if (!content_provider(offset, 0, data_sink)) {
  7302. return false;
  7303. } else if (!ok) {
  7304. return false;
  7305. }
  7306. }
  7307. return !data_available; // true only if done() was called, false if shutting
  7308. // down
  7309. }
  7310. // Runs a known-length content provider to completion and compresses what it
  7311. // writes into `out`. Nothing is buffered in identity form: a provider backed
  7312. // by an mmap hands the compressor a pointer straight into the mapping.
  7313. inline bool compress_content_provider(const ContentProvider &content_provider,
  7314. size_t length, compressor &cmp,
  7315. std::string &out) {
  7316. size_t offset = 0;
  7317. auto ok = true;
  7318. auto finished = false;
  7319. DataSink data_sink;
  7320. auto append = [&](const char *data, size_t data_len) {
  7321. out.append(data, data_len);
  7322. return true;
  7323. };
  7324. data_sink.write = [&](const char *d, size_t l) -> bool {
  7325. if (!ok) { return false; }
  7326. offset += l;
  7327. if (l > 0 && !cmp.compress(d, l, false, append)) { ok = false; }
  7328. return ok;
  7329. };
  7330. // The body is framed by `length`, so a provider that reports itself done
  7331. // early has truncated it; the short-body check below turns that into a
  7332. // failure rather than calling the provider again forever.
  7333. data_sink.done = [&]() { finished = true; };
  7334. while (offset < length && !finished) {
  7335. auto prev_offset = offset;
  7336. if (!content_provider(offset, length - offset, data_sink) || !ok) {
  7337. return false;
  7338. }
  7339. // No Stream to block on here, so a provider that keeps returning true
  7340. // without writing would spin. Treat a pass that made no progress as a
  7341. // failure.
  7342. if (offset == prev_offset) { return false; }
  7343. }
  7344. if (offset != length) { return false; }
  7345. return cmp.compress(nullptr, 0, true, append);
  7346. }
  7347. // Serves `m` as the response body. `set_content_provider()` clears the coding
  7348. // and the file flag, so recording them has to come after; keeping all of it
  7349. // here means a third file-serving path cannot get that order wrong.
  7350. inline void set_file_content_provider(Response &res,
  7351. const std::shared_ptr<mmap> &m,
  7352. const std::string &content_type,
  7353. EncodingType encoding) {
  7354. res.set_content_provider(
  7355. m->size(), content_type,
  7356. [m](size_t offset, size_t length, DataSink &sink) -> bool {
  7357. sink.write(m->data() + offset, length);
  7358. return true;
  7359. });
  7360. res.is_file_content_provider_ = true;
  7361. res.content_coding_ = encoding;
  7362. }
  7363. template <typename T, typename U>
  7364. inline bool
  7365. write_content_chunked(Stream &strm, const ContentProvider &content_provider,
  7366. const T &is_shutting_down, U &compressor, Error &error) {
  7367. size_t offset = 0;
  7368. auto data_available = true;
  7369. auto ok = true;
  7370. DataSink data_sink;
  7371. data_sink.write = [&](const char *d, size_t l) -> bool {
  7372. // Only done()/done_with_trailer() end a chunked body. A pass with nothing
  7373. // to hand over is ordinary (an empty buffer popped off a queue), and a
  7374. // zero-length chunk is the terminator, so it must not be emitted here.
  7375. if (ok && l > 0) {
  7376. offset += l;
  7377. std::string payload;
  7378. if (compressor.compress(d, l, false,
  7379. [&](const char *data, size_t data_len) {
  7380. payload.append(data, data_len);
  7381. return true;
  7382. })) {
  7383. if (!payload.empty()) {
  7384. // Emit chunked response header and footer for each chunk
  7385. auto chunk =
  7386. from_i_to_hex(payload.size()) + "\r\n" + payload + "\r\n";
  7387. if (!write_data(strm, chunk.data(), chunk.size())) { ok = false; }
  7388. }
  7389. } else {
  7390. ok = false;
  7391. }
  7392. }
  7393. return ok;
  7394. };
  7395. data_sink.is_writable = [&]() -> bool { return strm.is_peer_alive(); };
  7396. auto done_with_trailer = [&](const Headers *trailer) {
  7397. if (!ok) { return; }
  7398. data_available = false;
  7399. std::string payload;
  7400. if (!compressor.compress(nullptr, 0, true,
  7401. [&](const char *data, size_t data_len) {
  7402. payload.append(data, data_len);
  7403. return true;
  7404. })) {
  7405. ok = false;
  7406. return;
  7407. }
  7408. if (!payload.empty()) {
  7409. // Emit chunked response header and footer for each chunk
  7410. auto chunk = from_i_to_hex(payload.size()) + "\r\n" + payload + "\r\n";
  7411. if (!write_data(strm, chunk.data(), chunk.size())) {
  7412. ok = false;
  7413. return;
  7414. }
  7415. }
  7416. constexpr const char done_marker[] = "0\r\n";
  7417. if (!write_data(strm, done_marker, str_len(done_marker))) { ok = false; }
  7418. // Trailer
  7419. if (trailer) {
  7420. for (const auto &kv : *trailer) {
  7421. // Skip fields with invalid names or values to prevent response
  7422. // splitting via CR/LF injection, matching set_header().
  7423. if (!fields::is_field_valid(kv.first, kv.second)) { continue; }
  7424. std::string field_line = kv.first + ": " + kv.second + "\r\n";
  7425. if (!write_data(strm, field_line.data(), field_line.size())) {
  7426. ok = false;
  7427. }
  7428. }
  7429. }
  7430. constexpr const char crlf[] = "\r\n";
  7431. if (!write_data(strm, crlf, str_len(crlf))) { ok = false; }
  7432. };
  7433. data_sink.done = [&](void) { done_with_trailer(nullptr); };
  7434. data_sink.done_with_trailer = [&](const Headers &trailer) {
  7435. done_with_trailer(&trailer);
  7436. };
  7437. while (data_available && !is_shutting_down()) {
  7438. if (!strm.wait_writable() || !strm.is_peer_alive()) {
  7439. error = Error::Write;
  7440. return false;
  7441. } else if (!content_provider(offset, 0, data_sink)) {
  7442. error = Error::Canceled;
  7443. return false;
  7444. } else if (!ok) {
  7445. error = Error::Write;
  7446. return false;
  7447. }
  7448. }
  7449. if (data_available) { // exited due to is_shutting_down(), not done()
  7450. error = Error::Write;
  7451. return false;
  7452. }
  7453. error = Error::Success;
  7454. return true;
  7455. }
  7456. template <typename T, typename U>
  7457. inline bool write_content_chunked(Stream &strm,
  7458. const ContentProvider &content_provider,
  7459. const T &is_shutting_down, U &compressor) {
  7460. auto error = Error::Success;
  7461. return write_content_chunked(strm, content_provider, is_shutting_down,
  7462. compressor, error);
  7463. }
  7464. template <typename T>
  7465. inline bool redirect(T &cli, Request &req, Response &res,
  7466. const std::string &path, const std::string &location,
  7467. Error &error) {
  7468. Request new_req = req;
  7469. new_req.path = path;
  7470. new_req.redirect_count_ -= 1;
  7471. if (res.status == StatusCode::SeeOther_303 &&
  7472. (req.method != "GET" && req.method != "HEAD")) {
  7473. new_req.method = "GET";
  7474. new_req.body.clear();
  7475. new_req.headers.clear();
  7476. }
  7477. Response new_res;
  7478. auto ret = cli.send(new_req, new_res, error);
  7479. if (ret) {
  7480. req = std::move(new_req);
  7481. res = std::move(new_res);
  7482. if (res.location.empty()) { res.location = location; }
  7483. }
  7484. return ret;
  7485. }
  7486. inline std::string params_to_query_str(const Params &params) {
  7487. std::string query;
  7488. for (auto it = params.begin(); it != params.end(); ++it) {
  7489. if (it != params.begin()) { query += '&'; }
  7490. query += encode_query_component(it->first);
  7491. query += '=';
  7492. query += encode_query_component(it->second);
  7493. }
  7494. return query;
  7495. }
  7496. // Splits one "key=value" span of a query string at its first '='. A span with
  7497. // no '=' at all lands entirely in key, leaving val empty, which is how a bare
  7498. // "?flag" keeps its name.
  7499. inline void divide_query_pair(const char *b, const char *e, std::string &key,
  7500. std::string &val) {
  7501. divide(b, static_cast<std::size_t>(e - b), '=',
  7502. [&](const char *lhs_data, std::size_t lhs_size, const char *rhs_data,
  7503. std::size_t rhs_size) {
  7504. key.assign(lhs_data, lhs_size);
  7505. val.assign(rhs_data, rhs_size);
  7506. });
  7507. }
  7508. inline void parse_query_text(const char *data, std::size_t size,
  7509. Params &params) {
  7510. std::set<std::string> cache;
  7511. split(data, data + size, '&', [&](const char *b, const char *e) {
  7512. std::string kv(b, e);
  7513. if (cache.find(kv) != cache.end()) { return; }
  7514. cache.insert(std::move(kv));
  7515. std::string key;
  7516. std::string val;
  7517. divide_query_pair(b, e, key, val);
  7518. if (!key.empty()) {
  7519. params.emplace(decode_query_component(key), decode_query_component(val));
  7520. }
  7521. });
  7522. }
  7523. inline void parse_query_text(const std::string &s, Params &params) {
  7524. parse_query_text(s.data(), s.size(), params);
  7525. }
  7526. // Normalize a query string by decoding and re-encoding each key/value pair
  7527. // while preserving the original parameter order. This avoids double-encoding
  7528. // and ensures consistent encoding. It works on the raw string rather than
  7529. // parsing into Params and re-serializing, because that round trip cannot
  7530. // reproduce the input: params_to_query_str() always emits '=', so a bare
  7531. // "flag" would come back as "flag=", and parse_query_text() drops exactly
  7532. // duplicated pairs.
  7533. inline std::string normalize_query_string(const std::string &query) {
  7534. std::string result;
  7535. split(query.data(), query.data() + query.size(), '&',
  7536. [&](const char *b, const char *e) {
  7537. std::string key;
  7538. std::string val;
  7539. divide_query_pair(b, e, key, val);
  7540. if (!key.empty()) {
  7541. auto dec_key = decode_query_component(key);
  7542. auto dec_val = decode_query_component(val);
  7543. if (!result.empty()) { result += '&'; }
  7544. result += encode_query_component(dec_key);
  7545. if (!val.empty() || std::find(b, e, '=') != e) {
  7546. result += '=';
  7547. result += encode_query_component(dec_val);
  7548. }
  7549. }
  7550. });
  7551. return result;
  7552. }
  7553. // Build the request target that goes on the wire from a caller-supplied path.
  7554. // Shared by the buffered send path and the streaming API so that both put the
  7555. // same bytes in the request line for the same input.
  7556. inline std::string encode_request_target(const std::string &target,
  7557. bool path_encode) {
  7558. // `substr(0, npos)` yields the whole string, which is what the no-query
  7559. // case needs.
  7560. auto query_pos = target.find('?');
  7561. auto path_part = target.substr(0, query_pos);
  7562. std::string query_part;
  7563. if (query_pos != std::string::npos) {
  7564. query_part = target.substr(query_pos + 1);
  7565. }
  7566. auto result = path_encode ? encode_path(path_part) : std::move(path_part);
  7567. if (!query_part.empty()) {
  7568. // When path encoding is disabled the caller has supplied an already-encoded
  7569. // target and expects the exact bytes to be sent on the wire, so skip
  7570. // normalization for the query too. Normalizing would decode-then-re-encode
  7571. // it and corrupt pre-encoded binary payloads (e.g. turning `%20` into `+`,
  7572. // which a strict RFC 3986 server decodes back as `+`, not a space).
  7573. if (path_encode) {
  7574. auto normalized = normalize_query_string(query_part);
  7575. if (!normalized.empty()) {
  7576. result += '?';
  7577. result += normalized;
  7578. }
  7579. } else {
  7580. result += '?';
  7581. result += query_part;
  7582. }
  7583. }
  7584. return result;
  7585. }
  7586. inline bool parse_multipart_boundary(const std::string &content_type,
  7587. std::string &boundary) {
  7588. std::map<std::string, std::string> params;
  7589. extract_media_type(content_type, &params);
  7590. auto it = params.find("boundary");
  7591. if (it == params.end()) { return false; }
  7592. boundary = it->second;
  7593. // RFC 2046 5.1.1 caps a boundary at 70 characters. The parser scans the body
  7594. // for "--" + boundary, so a body crafted to repeat that delimiter's leading
  7595. // bytes costs a nearly full comparison at nearly every position: the
  7596. // boundary's length multiplies the worst-case cost of scanning a body.
  7597. return !boundary.empty() && boundary.size() <= 70;
  7598. }
  7599. inline void parse_disposition_params(const std::string &s, Params &params) {
  7600. std::set<std::string> cache;
  7601. split_unquoted(s.data(), s.data() + s.size(), ';',
  7602. [&](const char *b, const char *e) {
  7603. std::string kv(b, e);
  7604. if (cache.find(kv) != cache.end()) { return; }
  7605. cache.insert(kv);
  7606. std::string key;
  7607. std::string val;
  7608. divide_param_pair(b, e, key, val);
  7609. if (!key.empty()) {
  7610. params.emplace(trim_double_quotes_copy(key),
  7611. trim_double_quotes_copy(val));
  7612. }
  7613. });
  7614. }
  7615. #ifdef CPPHTTPLIB_NO_EXCEPTIONS
  7616. inline bool parse_range_header(const std::string &s, Ranges &ranges) {
  7617. #else
  7618. inline bool parse_range_header(const std::string &s, Ranges &ranges) try {
  7619. #endif
  7620. auto is_valid = [](const std::string &str) {
  7621. return std::all_of(str.cbegin(), str.cend(), is_ascii_digit);
  7622. };
  7623. if (s.size() > 7 && s.compare(0, 6, "bytes=") == 0) {
  7624. const auto pos = static_cast<size_t>(6);
  7625. const auto len = static_cast<size_t>(s.size() - 6);
  7626. auto all_valid_ranges = true;
  7627. split(&s[pos], &s[pos + len], ',', [&](const char *b, const char *e) {
  7628. if (!all_valid_ranges) { return; }
  7629. const auto it = std::find(b, e, '-');
  7630. if (it == e) {
  7631. all_valid_ranges = false;
  7632. return;
  7633. }
  7634. const auto lhs = std::string(b, it);
  7635. const auto rhs = std::string(it + 1, e);
  7636. if (!is_valid(lhs) || !is_valid(rhs)) {
  7637. all_valid_ranges = false;
  7638. return;
  7639. }
  7640. ssize_t first = -1;
  7641. if (!lhs.empty()) {
  7642. // Reject an overflowing first-byte-pos; treating it as absent (-1)
  7643. // would turn the range into a suffix range.
  7644. auto res =
  7645. detail::from_chars(lhs.data(), lhs.data() + lhs.size(), first);
  7646. if (res.ec != std::errc{}) {
  7647. all_valid_ranges = false;
  7648. return;
  7649. }
  7650. }
  7651. ssize_t last = -1;
  7652. if (!rhs.empty()) {
  7653. // An overflowing last-byte-pos is past any content length, so keeping
  7654. // -1 ("remainder", RFC 9110 14.1.2) is correct here.
  7655. ssize_t v;
  7656. auto res = detail::from_chars(rhs.data(), rhs.data() + rhs.size(), v);
  7657. if (res.ec == std::errc{}) { last = v; }
  7658. }
  7659. if ((first == -1 && last == -1) ||
  7660. (first != -1 && last != -1 && first > last)) {
  7661. all_valid_ranges = false;
  7662. return;
  7663. }
  7664. ranges.emplace_back(first, last);
  7665. });
  7666. return all_valid_ranges && !ranges.empty();
  7667. }
  7668. return false;
  7669. #ifdef CPPHTTPLIB_NO_EXCEPTIONS
  7670. }
  7671. #else
  7672. } catch (...) { return false; }
  7673. #endif
  7674. inline bool parse_accept_header(const std::string &s,
  7675. std::vector<std::string> &content_types) {
  7676. content_types.clear();
  7677. // Empty string is considered valid (no preference)
  7678. if (s.empty()) { return true; }
  7679. struct AcceptEntry {
  7680. std::string media_type;
  7681. double quality;
  7682. int order;
  7683. };
  7684. std::vector<AcceptEntry> entries;
  7685. int order = 0;
  7686. bool has_invalid_entry = false;
  7687. // Split by comma and parse each entry. RFC 9110 Section 5.6.1.2: a recipient
  7688. // has to parse and ignore empty list elements, so a leading, trailing or
  7689. // doubled comma must not turn a legal Accept value into 400 Bad Request.
  7690. // split() skips them, and the header length limit bounds how many a sender
  7691. // can send, so ignoring all of them cannot be used as a denial-of-service
  7692. // vector.
  7693. split(s.data(), s.data() + s.size(), ',', [&](const char *b, const char *e) {
  7694. std::string entry(b, e);
  7695. entry = trim_copy(entry);
  7696. AcceptEntry accept_entry;
  7697. accept_entry.order = order++;
  7698. if (!parse_quality(entry.data(), entry.data() + entry.size(),
  7699. accept_entry.media_type, accept_entry.quality)) {
  7700. has_invalid_entry = true;
  7701. return;
  7702. }
  7703. // Remove additional parameters from media type
  7704. accept_entry.media_type = extract_media_type(accept_entry.media_type);
  7705. // Basic validation of media type format
  7706. if (accept_entry.media_type.empty()) {
  7707. has_invalid_entry = true;
  7708. return;
  7709. }
  7710. // Check for basic media type format (should contain '/' or be '*')
  7711. if (accept_entry.media_type != "*" &&
  7712. accept_entry.media_type.find('/') == std::string::npos) {
  7713. has_invalid_entry = true;
  7714. return;
  7715. }
  7716. entries.push_back(std::move(accept_entry));
  7717. });
  7718. // Return false if any invalid entry was found
  7719. if (has_invalid_entry) { return false; }
  7720. // Sort by quality (descending), then by original order (ascending)
  7721. std::sort(entries.begin(), entries.end(),
  7722. [](const AcceptEntry &a, const AcceptEntry &b) {
  7723. if (a.quality != b.quality) {
  7724. return a.quality > b.quality; // Higher quality first
  7725. }
  7726. return a.order < b.order; // Earlier order first for same quality
  7727. });
  7728. // Extract sorted media types
  7729. content_types.reserve(entries.size());
  7730. for (auto &entry : entries) {
  7731. content_types.push_back(std::move(entry.media_type));
  7732. }
  7733. return true;
  7734. }
  7735. class FormDataParser {
  7736. public:
  7737. FormDataParser() = default;
  7738. void set_boundary(std::string &&boundary) {
  7739. boundary_ = std::move(boundary);
  7740. dash_boundary_crlf_ = dash_ + boundary_ + crlf_;
  7741. crlf_dash_boundary_ = crlf_ + dash_ + boundary_;
  7742. }
  7743. bool is_valid() const { return is_valid_; }
  7744. bool parse(const char *buf, size_t n, const FormDataHeader &header_callback,
  7745. const ContentReceiver &content_callback) {
  7746. // Once the close delimiter has been seen the rest of the body is epilogue
  7747. // to be discarded (RFC 2046). Drop it without buffering so a large epilogue
  7748. // spread across reads is not copied in only to be erased right away.
  7749. if (state_ == 5) { return true; }
  7750. buf_append(buf, n);
  7751. while (buf_size() > 0) {
  7752. switch (state_) {
  7753. case 0: { // Initial boundary
  7754. auto pos = buf_find(dash_boundary_crlf_);
  7755. if (pos == buf_size()) {
  7756. // Not found yet: keep only a possible partial boundary at the tail so
  7757. // that a body which never contains the boundary cannot grow the
  7758. // buffer (and get rescanned from the start) without bound.
  7759. auto keep = dash_boundary_crlf_.size() - 1;
  7760. if (buf_size() > keep) { buf_erase(buf_size() - keep); }
  7761. return true;
  7762. }
  7763. buf_erase(pos + dash_boundary_crlf_.size());
  7764. state_ = 1;
  7765. break;
  7766. }
  7767. case 1: { // New entry
  7768. clear_file_info();
  7769. state_ = 2;
  7770. break;
  7771. }
  7772. case 2: { // Headers
  7773. auto pos = buf_find(crlf_);
  7774. if (pos > CPPHTTPLIB_HEADER_MAX_LENGTH) { return false; }
  7775. while (pos < buf_size()) {
  7776. // Empty line
  7777. if (pos == 0) {
  7778. if (!header_callback(file_)) {
  7779. is_valid_ = false;
  7780. return false;
  7781. }
  7782. buf_erase(crlf_.size());
  7783. state_ = 3;
  7784. break;
  7785. }
  7786. // Check header count limit
  7787. if (header_count_ >= CPPHTTPLIB_HEADER_MAX_COUNT) {
  7788. is_valid_ = false;
  7789. return false;
  7790. }
  7791. header_count_++;
  7792. const auto header = buf_head(pos);
  7793. if (!parse_header(header.data(), header.data() + header.size(),
  7794. [&](const std::string &, const std::string &) {})) {
  7795. is_valid_ = false;
  7796. return false;
  7797. }
  7798. // Parse and emplace space trimmed headers into a map
  7799. if (!parse_header(
  7800. header.data(), header.data() + header.size(),
  7801. [&](const std::string &key, const std::string &val) {
  7802. file_.headers.emplace(key, val);
  7803. })) {
  7804. is_valid_ = false;
  7805. return false;
  7806. }
  7807. constexpr const char header_content_type[] = "Content-Type:";
  7808. if (start_with_case_ignore(header, header_content_type)) {
  7809. file_.content_type =
  7810. trim_copy(header.substr(str_len(header_content_type)));
  7811. } else {
  7812. std::string disposition_params;
  7813. if (parse_content_disposition(header, disposition_params)) {
  7814. Params params;
  7815. parse_disposition_params(disposition_params, params);
  7816. auto it = params.find("name");
  7817. if (it != params.end()) {
  7818. file_.name = it->second;
  7819. } else {
  7820. is_valid_ = false;
  7821. return false;
  7822. }
  7823. it = params.find("filename");
  7824. if (it != params.end()) { file_.filename = it->second; }
  7825. it = params.find("filename*");
  7826. if (it != params.end()) {
  7827. // RFC 5987: only UTF-8 encoding is allowed
  7828. const auto &val = it->second;
  7829. constexpr const char utf8_prefix[] = "UTF-8''";
  7830. constexpr size_t prefix_len = str_len(utf8_prefix);
  7831. if (val.size() > prefix_len &&
  7832. start_with_case_ignore(val, utf8_prefix)) {
  7833. file_.filename = decode_path_component(
  7834. val.substr(prefix_len)); // override...
  7835. } else {
  7836. is_valid_ = false;
  7837. return false;
  7838. }
  7839. }
  7840. }
  7841. }
  7842. buf_erase(pos + crlf_.size());
  7843. pos = buf_find(crlf_);
  7844. }
  7845. if (state_ != 3) { return true; }
  7846. break;
  7847. }
  7848. case 3: { // Body
  7849. if (crlf_dash_boundary_.size() > buf_size()) { return true; }
  7850. auto pos = buf_find(crlf_dash_boundary_);
  7851. if (pos < buf_size()) {
  7852. if (!content_callback(buf_data(), pos)) {
  7853. is_valid_ = false;
  7854. return false;
  7855. }
  7856. buf_erase(pos + crlf_dash_boundary_.size());
  7857. state_ = 4;
  7858. } else {
  7859. auto len = buf_size() - crlf_dash_boundary_.size();
  7860. if (len > 0) {
  7861. if (!content_callback(buf_data(), len)) {
  7862. is_valid_ = false;
  7863. return false;
  7864. }
  7865. buf_erase(len);
  7866. }
  7867. return true;
  7868. }
  7869. break;
  7870. }
  7871. case 4: { // Boundary
  7872. if (crlf_.size() > buf_size()) { return true; }
  7873. if (buf_start_with(crlf_)) {
  7874. buf_erase(crlf_.size());
  7875. state_ = 1;
  7876. } else if (buf_start_with(dash_)) {
  7877. buf_erase(dash_.size());
  7878. is_valid_ = true;
  7879. state_ = 5;
  7880. } else {
  7881. // Only CRLF (another part follows) and "--" (close-delimiter) are
  7882. // accepted after a boundary; RFC 2046 allows transport-padding in
  7883. // between, but this parser has never supported it. Either way the
  7884. // body is already destined to be rejected, so fail now instead of
  7885. // buffering the rest of it. Both are two bytes, so the check above
  7886. // already guarantees enough buffered data to decide.
  7887. is_valid_ = false;
  7888. return false;
  7889. }
  7890. break;
  7891. }
  7892. case 5: { // Epilogue
  7893. buf_erase(buf_size());
  7894. break;
  7895. }
  7896. }
  7897. }
  7898. return true;
  7899. }
  7900. private:
  7901. void clear_file_info() {
  7902. file_.name.clear();
  7903. file_.filename.clear();
  7904. file_.content_type.clear();
  7905. file_.headers.clear();
  7906. header_count_ = 0;
  7907. }
  7908. bool start_with_case_ignore(const std::string &a, const char *b,
  7909. size_t offset = 0) const {
  7910. const auto b_len = strlen(b);
  7911. if (a.size() < offset + b_len) { return false; }
  7912. for (size_t i = 0; i < b_len; i++) {
  7913. if (case_ignore::to_lower(a[offset + i]) != case_ignore::to_lower(b[i])) {
  7914. return false;
  7915. }
  7916. }
  7917. return true;
  7918. }
  7919. // Parses "Content-Disposition: form-data; <params>" without std::regex.
  7920. // Returns true if header matches, with the params portion in `params_out`.
  7921. bool parse_content_disposition(const std::string &header,
  7922. std::string &params_out) const {
  7923. constexpr const char prefix[] = "Content-Disposition:";
  7924. constexpr size_t prefix_len = str_len(prefix);
  7925. if (!start_with_case_ignore(header, prefix)) { return false; }
  7926. // Skip whitespace after "Content-Disposition:"
  7927. auto pos = prefix_len;
  7928. while (pos < header.size() && (header[pos] == ' ' || header[pos] == '\t')) {
  7929. pos++;
  7930. }
  7931. // Match "form-data;" (case-insensitive)
  7932. constexpr const char form_data[] = "form-data;";
  7933. constexpr size_t form_data_len = str_len(form_data);
  7934. if (!start_with_case_ignore(header, form_data, pos)) { return false; }
  7935. pos += form_data_len;
  7936. // Skip whitespace after "form-data;"
  7937. while (pos < header.size() && (header[pos] == ' ' || header[pos] == '\t')) {
  7938. pos++;
  7939. }
  7940. params_out = header.substr(pos);
  7941. return true;
  7942. }
  7943. const std::string dash_ = "--";
  7944. const std::string crlf_ = "\r\n";
  7945. std::string boundary_;
  7946. std::string dash_boundary_crlf_;
  7947. std::string crlf_dash_boundary_;
  7948. size_t state_ = 0;
  7949. bool is_valid_ = false;
  7950. FormData file_;
  7951. size_t header_count_ = 0;
  7952. // Buffer
  7953. bool start_with(const std::string &a, size_t spos, size_t epos,
  7954. const std::string &b) const {
  7955. if (epos - spos < b.size()) { return false; }
  7956. for (size_t i = 0; i < b.size(); i++) {
  7957. if (a[i + spos] != b[i]) { return false; }
  7958. }
  7959. return true;
  7960. }
  7961. size_t buf_size() const { return buf_epos_ - buf_spos_; }
  7962. const char *buf_data() const { return &buf_[buf_spos_]; }
  7963. std::string buf_head(size_t l) const { return buf_.substr(buf_spos_, l); }
  7964. bool buf_start_with(const std::string &s) const {
  7965. return start_with(buf_, buf_spos_, buf_epos_, s);
  7966. }
  7967. size_t buf_find(const std::string &s) const {
  7968. auto c = s.front();
  7969. size_t off = buf_spos_;
  7970. while (off < buf_epos_) {
  7971. auto pos = off;
  7972. while (true) {
  7973. if (pos == buf_epos_) { return buf_size(); }
  7974. if (buf_[pos] == c) { break; }
  7975. pos++;
  7976. }
  7977. auto remaining_size = buf_epos_ - pos;
  7978. if (s.size() > remaining_size) { return buf_size(); }
  7979. if (start_with(buf_, pos, buf_epos_, s)) { return pos - buf_spos_; }
  7980. off = pos + 1;
  7981. }
  7982. return buf_size();
  7983. }
  7984. void buf_append(const char *data, size_t n) {
  7985. auto remaining_size = buf_size();
  7986. if (remaining_size > 0 && buf_spos_ > 0) {
  7987. for (size_t i = 0; i < remaining_size; i++) {
  7988. buf_[i] = buf_[buf_spos_ + i];
  7989. }
  7990. }
  7991. buf_spos_ = 0;
  7992. buf_epos_ = remaining_size;
  7993. if (remaining_size + n > buf_.size()) { buf_.resize(remaining_size + n); }
  7994. for (size_t i = 0; i < n; i++) {
  7995. buf_[buf_epos_ + i] = data[i];
  7996. }
  7997. buf_epos_ += n;
  7998. }
  7999. void buf_erase(size_t size) { buf_spos_ += size; }
  8000. std::string buf_;
  8001. size_t buf_spos_ = 0;
  8002. size_t buf_epos_ = 0;
  8003. };
  8004. inline std::string random_string(size_t length) {
  8005. constexpr const char data[] =
  8006. "0123456789ABCDEFGHIJKLMNOPQRSTUVWXYZabcdefghijklmnopqrstuvwxyz";
  8007. thread_local auto engine([]() {
  8008. // std::random_device might actually be deterministic on some
  8009. // platforms, but due to lack of support in the c++ standard library,
  8010. // doing better requires either some ugly hacks or breaking portability.
  8011. std::random_device seed_gen;
  8012. // Request 128 bits of entropy for initialization
  8013. std::seed_seq seed_sequence{seed_gen(), seed_gen(), seed_gen(), seed_gen()};
  8014. return std::mt19937(seed_sequence);
  8015. }());
  8016. std::string result;
  8017. for (size_t i = 0; i < length; i++) {
  8018. result += data[engine() % (sizeof(data) - 1)];
  8019. }
  8020. return result;
  8021. }
  8022. inline std::string make_multipart_data_boundary() {
  8023. return "--cpp-httplib-multipart-data-" + detail::random_string(16);
  8024. }
  8025. inline bool is_multipart_boundary_chars_valid(const std::string &boundary) {
  8026. auto valid = true;
  8027. for (size_t i = 0; i < boundary.size(); i++) {
  8028. auto c = boundary[i];
  8029. if (!is_ascii_alnum(c) && c != '-' && c != '_') {
  8030. valid = false;
  8031. break;
  8032. }
  8033. }
  8034. return valid;
  8035. }
  8036. // Escape a multipart field name/filename following the WHATWG HTML standard
  8037. // ("escape a multipart form-data name"), which is what browsers send:
  8038. // '"' -> %22, CR -> %0D, LF -> %0A
  8039. // With escape_quote = false, only CR and LF are escaped; this is for header
  8040. // values outside a quoted-string (e.g. Content-Type), where '"' is legal.
  8041. inline std::string escape_multipart_field(const std::string &s,
  8042. bool escape_quote = true) {
  8043. std::string result;
  8044. result.reserve(s.size());
  8045. for (auto c : s) {
  8046. switch (c) {
  8047. case '"':
  8048. if (escape_quote) {
  8049. result += "%22";
  8050. } else {
  8051. result += c;
  8052. }
  8053. break;
  8054. case '\r': result += "%0D"; break;
  8055. case '\n': result += "%0A"; break;
  8056. default: result += c; break;
  8057. }
  8058. }
  8059. return result;
  8060. }
  8061. template <typename T>
  8062. inline std::string
  8063. serialize_multipart_formdata_item_begin(const T &item,
  8064. const std::string &boundary) {
  8065. std::string body = "--" + boundary + "\r\n";
  8066. body += "Content-Disposition: form-data; name=\"" +
  8067. escape_multipart_field(item.name) + "\"";
  8068. if (!item.filename.empty()) {
  8069. body += "; filename=\"" + escape_multipart_field(item.filename) + "\"";
  8070. }
  8071. body += "\r\n";
  8072. if (!item.content_type.empty()) {
  8073. body +=
  8074. "Content-Type: " + escape_multipart_field(item.content_type, false) +
  8075. "\r\n";
  8076. }
  8077. body += "\r\n";
  8078. return body;
  8079. }
  8080. inline std::string serialize_multipart_formdata_item_end() { return "\r\n"; }
  8081. inline std::string
  8082. serialize_multipart_formdata_finish(const std::string &boundary) {
  8083. return "--" + boundary + "--\r\n";
  8084. }
  8085. inline std::string
  8086. serialize_multipart_formdata_get_content_type(const std::string &boundary) {
  8087. return "multipart/form-data; boundary=" + boundary;
  8088. }
  8089. inline std::string
  8090. serialize_multipart_formdata(const UploadFormDataItems &items,
  8091. const std::string &boundary, bool finish = true) {
  8092. std::string body;
  8093. for (const auto &item : items) {
  8094. body += serialize_multipart_formdata_item_begin(item, boundary);
  8095. body += item.content + serialize_multipart_formdata_item_end();
  8096. }
  8097. if (finish) { body += serialize_multipart_formdata_finish(boundary); }
  8098. return body;
  8099. }
  8100. inline size_t get_multipart_content_length(const UploadFormDataItems &items,
  8101. const std::string &boundary) {
  8102. size_t total = 0;
  8103. for (const auto &item : items) {
  8104. total += serialize_multipart_formdata_item_begin(item, boundary).size();
  8105. total += item.content.size();
  8106. total += serialize_multipart_formdata_item_end().size();
  8107. }
  8108. total += serialize_multipart_formdata_finish(boundary).size();
  8109. return total;
  8110. }
  8111. struct MultipartSegment {
  8112. const char *data;
  8113. size_t size;
  8114. };
  8115. // NOTE: items must outlive the returned ContentProvider
  8116. // (safe for synchronous use inside Post/Put/Patch)
  8117. inline ContentProvider
  8118. make_multipart_content_provider(const UploadFormDataItems &items,
  8119. const std::string &boundary) {
  8120. // Own the per-item header strings and the finish string
  8121. std::vector<std::string> owned;
  8122. owned.reserve(items.size() + 1);
  8123. for (const auto &item : items)
  8124. owned.push_back(serialize_multipart_formdata_item_begin(item, boundary));
  8125. owned.push_back(serialize_multipart_formdata_finish(boundary));
  8126. // Flat segment list: [header, content, "\r\n"] * N + [finish]
  8127. std::vector<MultipartSegment> segs;
  8128. segs.reserve(items.size() * 3 + 1);
  8129. static const char crlf[] = "\r\n";
  8130. for (size_t i = 0; i < items.size(); i++) {
  8131. segs.push_back({owned[i].data(), owned[i].size()});
  8132. segs.push_back({items[i].content.data(), items[i].content.size()});
  8133. segs.push_back({crlf, 2});
  8134. }
  8135. segs.push_back({owned.back().data(), owned.back().size()});
  8136. struct MultipartState {
  8137. std::vector<std::string> owned;
  8138. std::vector<MultipartSegment> segs;
  8139. std::vector<char> buf = std::vector<char>(CPPHTTPLIB_SEND_BUFSIZ);
  8140. };
  8141. auto state = std::make_shared<MultipartState>();
  8142. state->owned = std::move(owned);
  8143. // `segs` holds raw pointers into owned strings; std::string move preserves
  8144. // the data pointer, so these pointers remain valid after the move above.
  8145. state->segs = std::move(segs);
  8146. return [state](size_t offset, size_t length, DataSink &sink) -> bool {
  8147. // Buffer multiple small segments into fewer, larger writes to avoid
  8148. // excessive TCP packets when there are many form data items (#2410)
  8149. auto &buf = state->buf;
  8150. auto buf_size = buf.size();
  8151. size_t buf_len = 0;
  8152. size_t remaining = length;
  8153. // Find the first segment containing 'offset'
  8154. size_t pos = 0;
  8155. size_t seg_idx = 0;
  8156. for (; seg_idx < state->segs.size(); seg_idx++) {
  8157. const auto &seg = state->segs[seg_idx];
  8158. if (seg.size > 0 && offset - pos < seg.size) { break; }
  8159. pos += seg.size;
  8160. }
  8161. size_t seg_offset = (seg_idx < state->segs.size()) ? offset - pos : 0;
  8162. for (; seg_idx < state->segs.size() && remaining > 0; seg_idx++) {
  8163. const auto &seg = state->segs[seg_idx];
  8164. size_t available = seg.size - seg_offset;
  8165. size_t to_copy = (std::min)(available, remaining);
  8166. const char *src = seg.data + seg_offset;
  8167. seg_offset = 0; // only the first segment has a non-zero offset
  8168. while (to_copy > 0) {
  8169. size_t space = buf_size - buf_len;
  8170. size_t chunk = (std::min)(to_copy, space);
  8171. std::memcpy(buf.data() + buf_len, src, chunk);
  8172. buf_len += chunk;
  8173. src += chunk;
  8174. to_copy -= chunk;
  8175. remaining -= chunk;
  8176. if (buf_len == buf_size) {
  8177. if (!sink.write(buf.data(), buf_len)) { return false; }
  8178. buf_len = 0;
  8179. }
  8180. }
  8181. }
  8182. if (buf_len > 0) { return sink.write(buf.data(), buf_len); }
  8183. return true;
  8184. };
  8185. }
  8186. inline void coalesce_ranges(Ranges &ranges, size_t content_length) {
  8187. if (ranges.size() <= 1) return;
  8188. // Sort ranges by start position
  8189. std::sort(ranges.begin(), ranges.end(),
  8190. [](const Range &a, const Range &b) { return a.first < b.first; });
  8191. Ranges coalesced;
  8192. coalesced.reserve(ranges.size());
  8193. for (auto &r : ranges) {
  8194. auto first_pos = r.first;
  8195. auto last_pos = r.second;
  8196. // Handle special cases like in range_error
  8197. if (first_pos == -1 && last_pos == -1) {
  8198. first_pos = 0;
  8199. last_pos = static_cast<ssize_t>(content_length);
  8200. }
  8201. if (first_pos == -1) {
  8202. first_pos = static_cast<ssize_t>(content_length) - last_pos;
  8203. last_pos = static_cast<ssize_t>(content_length) - 1;
  8204. }
  8205. if (last_pos == -1 || last_pos >= static_cast<ssize_t>(content_length)) {
  8206. last_pos = static_cast<ssize_t>(content_length) - 1;
  8207. }
  8208. // Skip invalid ranges
  8209. if (!(0 <= first_pos && first_pos <= last_pos &&
  8210. last_pos < static_cast<ssize_t>(content_length))) {
  8211. continue;
  8212. }
  8213. // Coalesce with previous range if overlapping or adjacent (but not
  8214. // identical)
  8215. if (!coalesced.empty()) {
  8216. auto &prev = coalesced.back();
  8217. // Check if current range overlaps or is adjacent to previous range
  8218. // but don't coalesce identical ranges (allow duplicates)
  8219. if (first_pos <= prev.second + 1 &&
  8220. !(first_pos == prev.first && last_pos == prev.second)) {
  8221. // Extend the previous range
  8222. prev.second = (std::max)(prev.second, last_pos);
  8223. continue;
  8224. }
  8225. }
  8226. // Add new range
  8227. coalesced.emplace_back(first_pos, last_pos);
  8228. }
  8229. ranges = std::move(coalesced);
  8230. }
  8231. inline bool range_error(Request &req, Response &res) {
  8232. if (!req.ranges.empty() && 200 <= res.status && res.status < 300) {
  8233. if (res.body.empty() && res.content_provider_ && res.content_length_ == 0) {
  8234. req.ranges.clear();
  8235. if (res.status == StatusCode::PartialContent_206) {
  8236. res.status = StatusCode::OK_200;
  8237. }
  8238. return false;
  8239. }
  8240. ssize_t content_len = static_cast<ssize_t>(
  8241. res.content_length_ ? res.content_length_ : res.body.size());
  8242. std::vector<std::pair<ssize_t, ssize_t>> processed_ranges;
  8243. size_t overwrapping_count = 0;
  8244. // NOTE: The following Range check is based on '14.2. Range' in RFC 9110
  8245. // 'HTTP Semantics' to avoid potential denial-of-service attacks.
  8246. // https://www.rfc-editor.org/rfc/rfc9110#section-14.2
  8247. // Too many ranges
  8248. if (req.ranges.size() > CPPHTTPLIB_RANGE_MAX_COUNT) { return true; }
  8249. for (auto &r : req.ranges) {
  8250. auto &first_pos = r.first;
  8251. auto &last_pos = r.second;
  8252. if (first_pos == -1 && last_pos == -1) {
  8253. first_pos = 0;
  8254. last_pos = content_len;
  8255. }
  8256. if (first_pos == -1) {
  8257. first_pos = content_len - last_pos;
  8258. last_pos = content_len - 1;
  8259. }
  8260. // NOTE: RFC-9110 '14.1.2. Byte Ranges':
  8261. // A client can limit the number of bytes requested without knowing the
  8262. // size of the selected representation. If the last-pos value is absent,
  8263. // or if the value is greater than or equal to the current length of the
  8264. // representation data, the byte range is interpreted as the remainder of
  8265. // the representation (i.e., the server replaces the value of last-pos
  8266. // with a value that is one less than the current length of the selected
  8267. // representation).
  8268. // https://www.rfc-editor.org/rfc/rfc9110.html#section-14.1.2-6
  8269. if (last_pos == -1 || last_pos >= content_len) {
  8270. last_pos = content_len - 1;
  8271. }
  8272. // Range must be within content length
  8273. if (!(0 <= first_pos && first_pos <= last_pos &&
  8274. last_pos <= content_len - 1)) {
  8275. return true;
  8276. }
  8277. // Request must not have more than two overlapping ranges
  8278. for (const auto &processed_range : processed_ranges) {
  8279. if (!(last_pos < processed_range.first ||
  8280. first_pos > processed_range.second)) {
  8281. overwrapping_count++;
  8282. if (overwrapping_count > 2) { return true; }
  8283. break; // Only count once per range
  8284. }
  8285. }
  8286. processed_ranges.emplace_back(first_pos, last_pos);
  8287. }
  8288. // After validation, coalesce overlapping ranges as per RFC 9110
  8289. coalesce_ranges(req.ranges, static_cast<size_t>(content_len));
  8290. }
  8291. return false;
  8292. }
  8293. inline std::pair<size_t, size_t>
  8294. get_range_offset_and_length(Range r, size_t content_length) {
  8295. assert(r.first != -1 && r.second != -1);
  8296. assert(0 <= r.first && r.first < static_cast<ssize_t>(content_length));
  8297. assert(r.first <= r.second &&
  8298. r.second < static_cast<ssize_t>(content_length));
  8299. (void)(content_length);
  8300. return std::make_pair(static_cast<size_t>(r.first),
  8301. static_cast<size_t>(r.second - r.first) + 1);
  8302. }
  8303. inline std::string make_content_range_header_field(
  8304. const std::pair<size_t, size_t> &offset_and_length, size_t content_length) {
  8305. auto st = offset_and_length.first;
  8306. auto ed = st + offset_and_length.second - 1;
  8307. std::string field = "bytes ";
  8308. field += std::to_string(st);
  8309. field += '-';
  8310. field += std::to_string(ed);
  8311. field += '/';
  8312. field += std::to_string(content_length);
  8313. return field;
  8314. }
  8315. template <typename SToken, typename CToken, typename Content>
  8316. bool process_multipart_ranges_data(const Request &req,
  8317. const std::string &boundary,
  8318. const std::string &content_type,
  8319. size_t content_length, SToken stoken,
  8320. CToken ctoken, Content content) {
  8321. for (size_t i = 0; i < req.ranges.size(); i++) {
  8322. ctoken("--");
  8323. stoken(boundary);
  8324. ctoken("\r\n");
  8325. if (!content_type.empty()) {
  8326. ctoken("Content-Type: ");
  8327. stoken(content_type);
  8328. ctoken("\r\n");
  8329. }
  8330. auto offset_and_length =
  8331. get_range_offset_and_length(req.ranges[i], content_length);
  8332. ctoken("Content-Range: ");
  8333. stoken(make_content_range_header_field(offset_and_length, content_length));
  8334. ctoken("\r\n");
  8335. ctoken("\r\n");
  8336. if (!content(offset_and_length.first, offset_and_length.second)) {
  8337. return false;
  8338. }
  8339. ctoken("\r\n");
  8340. }
  8341. ctoken("--");
  8342. stoken(boundary);
  8343. ctoken("--");
  8344. return true;
  8345. }
  8346. inline void make_multipart_ranges_data(const Request &req, Response &res,
  8347. const std::string &boundary,
  8348. const std::string &content_type,
  8349. size_t content_length,
  8350. std::string &data) {
  8351. process_multipart_ranges_data(
  8352. req, boundary, content_type, content_length,
  8353. [&](const std::string &token) { data += token; },
  8354. [&](const std::string &token) { data += token; },
  8355. [&](size_t offset, size_t length) {
  8356. assert(offset + length <= content_length);
  8357. data += res.body.substr(offset, length);
  8358. return true;
  8359. });
  8360. }
  8361. inline size_t get_multipart_ranges_data_length(const Request &req,
  8362. const std::string &boundary,
  8363. const std::string &content_type,
  8364. size_t content_length) {
  8365. size_t data_length = 0;
  8366. process_multipart_ranges_data(
  8367. req, boundary, content_type, content_length,
  8368. [&](const std::string &token) { data_length += token.size(); },
  8369. [&](const std::string &token) { data_length += token.size(); },
  8370. [&](size_t /*offset*/, size_t length) {
  8371. data_length += length;
  8372. return true;
  8373. });
  8374. return data_length;
  8375. }
  8376. template <typename T>
  8377. inline bool
  8378. write_multipart_ranges_data(Stream &strm, const Request &req, Response &res,
  8379. const std::string &boundary,
  8380. const std::string &content_type,
  8381. size_t content_length, const T &is_shutting_down) {
  8382. return process_multipart_ranges_data(
  8383. req, boundary, content_type, content_length,
  8384. [&](const std::string &token) { strm.write(token); },
  8385. [&](const std::string &token) { strm.write(token); },
  8386. [&](size_t offset, size_t length) {
  8387. return write_content(strm, res.content_provider_, offset, length,
  8388. is_shutting_down);
  8389. });
  8390. }
  8391. inline bool has_framed_body(const Request &req) {
  8392. return is_chunked_transfer_encoding(req.headers) ||
  8393. req.get_header_value_u64("Content-Length") > 0;
  8394. }
  8395. inline bool is_connection_persistent(const Request &req) {
  8396. if (has_header_token(req.headers, "Connection", "close")) { return false; }
  8397. if (req.version == "HTTP/1.0" &&
  8398. !has_header_token(req.headers, "Connection", "keep-alive")) {
  8399. return false;
  8400. }
  8401. return true;
  8402. }
  8403. inline bool expect_content(const Request &req) {
  8404. if (req.method == "POST" || req.method == "PUT" || req.method == "PATCH" ||
  8405. req.method == "DELETE") {
  8406. return true;
  8407. }
  8408. return has_framed_body(req);
  8409. }
  8410. #ifdef _WIN32
  8411. class WSInit {
  8412. public:
  8413. WSInit() {
  8414. WSADATA wsaData;
  8415. if (WSAStartup(0x0002, &wsaData) == 0) is_valid_ = true;
  8416. }
  8417. ~WSInit() {
  8418. if (is_valid_) WSACleanup();
  8419. }
  8420. bool is_valid_ = false;
  8421. };
  8422. static WSInit wsinit_;
  8423. #endif
  8424. // RFC 9110 Section 11.6.1 defines a challenge list as
  8425. // WWW-Authenticate = #challenge
  8426. // challenge = auth-scheme [ 1*SP ( token68 / [ #auth-param ] ) ]
  8427. // auth-param = token BWS "=" BWS ( token / quoted-string )
  8428. // so a server may offer several schemes, each with its own comma-separated
  8429. // auth-param list, in either order and either as separate field lines or
  8430. // packed into one. Splitting on every comma would break apart a challenge's
  8431. // own param list; splitting only on the first space would miss a Digest
  8432. // challenge that isn't first. Split on commas that aren't inside a
  8433. // quoted-string instead, then track which scheme each resulting segment
  8434. // belongs to: a segment whose text before "=" contains whitespace (or that
  8435. // has no "=" at all) starts a new challenge named by its leading token.
  8436. inline std::vector<std::string> split_challenge_segments(const std::string &s) {
  8437. std::vector<std::string> segments;
  8438. size_t start = 0;
  8439. auto in_quotes = false;
  8440. for (size_t i = 0; i < s.size(); i++) {
  8441. auto c = s[i];
  8442. if (in_quotes) {
  8443. if (c == '\\' && i + 1 < s.size()) {
  8444. i++;
  8445. } else if (c == '"') {
  8446. in_quotes = false;
  8447. }
  8448. } else if (c == '"') {
  8449. in_quotes = true;
  8450. } else if (c == ',') {
  8451. segments.push_back(s.substr(start, i - start));
  8452. start = i + 1;
  8453. }
  8454. }
  8455. segments.push_back(s.substr(start));
  8456. return segments;
  8457. }
  8458. inline std::string unescape_quoted_pairs(const std::string &s) {
  8459. std::string out;
  8460. out.reserve(s.size());
  8461. for (size_t i = 0; i < s.size(); i++) {
  8462. if (s[i] == '\\' && i + 1 < s.size()) {
  8463. out += s[++i];
  8464. } else {
  8465. out += s[i];
  8466. }
  8467. }
  8468. return out;
  8469. }
  8470. inline bool parse_www_authenticate(const Response &res,
  8471. std::map<std::string, std::string> &auth,
  8472. bool is_proxy) {
  8473. auto auth_key = is_proxy ? "Proxy-Authenticate" : "WWW-Authenticate";
  8474. auto combined = get_combined_header_value(res.headers, auth_key);
  8475. if (combined.empty()) { return false; }
  8476. auto found_digest = false;
  8477. auto in_digest_challenge = false;
  8478. for (const auto &raw_segment : split_challenge_segments(combined)) {
  8479. auto segment = trim_copy(raw_segment);
  8480. if (segment.empty()) { continue; }
  8481. auto eq_pos = segment.find('=');
  8482. // BWS is allowed on both sides of "=", so the text naming the key (or,
  8483. // for the first segment of a challenge, "<scheme> <key>") must be
  8484. // trimmed before its boundaries are inspected.
  8485. auto key_part = trim_copy(
  8486. eq_pos == std::string::npos ? segment : segment.substr(0, eq_pos));
  8487. auto space_pos = key_part.find_last_of(" \t");
  8488. if (space_pos != std::string::npos || eq_pos == std::string::npos) {
  8489. // "<scheme>[ <key>]" starts a new challenge.
  8490. auto scheme_end =
  8491. space_pos == std::string::npos ? key_part.size() : space_pos;
  8492. // RFC 7616 Section 3.7: a server may offer more than one Digest
  8493. // challenge (e.g. SHA-256 and MD5); keep only the first so a nonce
  8494. // from one challenge is never paired with another's algorithm.
  8495. in_digest_challenge =
  8496. !found_digest &&
  8497. case_ignore::equal(key_part.substr(0, scheme_end), "Digest");
  8498. if (in_digest_challenge) { found_digest = true; }
  8499. if (space_pos == std::string::npos) {
  8500. // Bare scheme (or a token68), no auth-param on this segment.
  8501. continue;
  8502. }
  8503. key_part = key_part.substr(space_pos + 1);
  8504. }
  8505. if (!in_digest_challenge) { continue; }
  8506. auto val = trim_copy(segment.substr(eq_pos + 1));
  8507. auto unquoted = trim_double_quotes_copy(val);
  8508. if (unquoted.size() != val.size()) {
  8509. unquoted = unescape_quoted_pairs(unquoted);
  8510. }
  8511. auth[std::move(key_part)] = std::move(unquoted);
  8512. }
  8513. // RFC 7616 Section 3.3 requires realm and nonce on every Digest challenge;
  8514. // make_digest_authentication_header() dereferences both unconditionally, so
  8515. // a challenge missing either can't produce a usable Authorization header.
  8516. // Treat it the same as no Digest challenge at all.
  8517. return found_digest && auth.find("realm") != auth.end() &&
  8518. auth.find("nonce") != auth.end();
  8519. }
  8520. class ContentProviderAdapter {
  8521. public:
  8522. explicit ContentProviderAdapter(
  8523. ContentProviderWithoutLength &&content_provider)
  8524. : content_provider_(std::move(content_provider)) {}
  8525. bool operator()(size_t offset, size_t, DataSink &sink) {
  8526. return content_provider_(offset, sink);
  8527. }
  8528. private:
  8529. ContentProviderWithoutLength content_provider_;
  8530. };
  8531. // NOTE: https://www.rfc-editor.org/rfc/rfc9110#section-5
  8532. namespace fields {
  8533. inline bool is_token_char(char c) {
  8534. return is_ascii_alnum(c) || c == '!' || c == '#' || c == '$' || c == '%' ||
  8535. c == '&' || c == '\'' || c == '*' || c == '+' || c == '-' ||
  8536. c == '.' || c == '^' || c == '_' || c == '`' || c == '|' || c == '~';
  8537. }
  8538. inline bool is_token(const std::string &s) {
  8539. if (s.empty()) { return false; }
  8540. for (auto c : s) {
  8541. if (!is_token_char(c)) { return false; }
  8542. }
  8543. return true;
  8544. }
  8545. inline bool is_field_name(const std::string &s) { return is_token(s); }
  8546. inline bool is_vchar(char c) { return c >= 33 && c <= 126; }
  8547. inline bool is_obs_text(char c) { return 128 <= static_cast<unsigned char>(c); }
  8548. inline bool is_field_vchar(char c) { return is_vchar(c) || is_obs_text(c); }
  8549. inline bool is_field_content(const std::string &s) {
  8550. if (s.empty()) { return true; }
  8551. if (s.size() == 1) {
  8552. return is_field_vchar(s[0]);
  8553. } else if (s.size() == 2) {
  8554. return is_field_vchar(s[0]) && is_field_vchar(s[1]);
  8555. } else {
  8556. size_t i = 0;
  8557. if (!is_field_vchar(s[i])) { return false; }
  8558. i++;
  8559. while (i < s.size() - 1) {
  8560. auto c = s[i++];
  8561. if (c == ' ' || c == '\t' || is_field_vchar(c)) {
  8562. } else {
  8563. return false;
  8564. }
  8565. }
  8566. return is_field_vchar(s[i]);
  8567. }
  8568. }
  8569. inline bool is_field_value(const std::string &s) { return is_field_content(s); }
  8570. inline bool is_field_valid(const std::string &name, const std::string &value) {
  8571. return is_field_name(name) && is_field_value(value);
  8572. }
  8573. // RFC 9112 §2.2/§3.2: the request-target has no SP, HTAB or other control
  8574. // characters (incl. bare CR). obs-text (raw UTF-8) is allowed.
  8575. inline bool is_request_target(const std::string &s) {
  8576. return std::all_of(s.begin(), s.end(), is_field_vchar);
  8577. }
  8578. } // namespace fields
  8579. inline bool perform_websocket_handshake(Stream &strm, Request &req,
  8580. WebSocketUpgradeResponse &upgrade) {
  8581. // Generate random Sec-WebSocket-Key
  8582. thread_local std::mt19937 rng(std::random_device{}());
  8583. std::string key_bytes(16, '\0');
  8584. for (size_t i = 0; i < 16; i += 4) {
  8585. auto r = rng();
  8586. std::memcpy(&key_bytes[i], &r, (std::min)(size_t(4), size_t(16 - i)));
  8587. }
  8588. auto client_key = base64_encode(key_bytes);
  8589. req.headers.erase("Upgrade");
  8590. req.headers.erase("Connection");
  8591. req.headers.erase("Sec-WebSocket-Key");
  8592. req.headers.erase("Sec-WebSocket-Version");
  8593. req.headers.emplace("Upgrade", "websocket");
  8594. req.headers.emplace("Connection", "Upgrade");
  8595. req.headers.emplace("Sec-WebSocket-Key", client_key);
  8596. req.headers.emplace("Sec-WebSocket-Version", "13");
  8597. // Build the request in memory first, like ClientImpl::write_request does.
  8598. // Writing straight to the socket would leak a request line onto the wire
  8599. // before check_and_write_headers gets a chance to reject an invalid header,
  8600. // and would emit one small write per header.
  8601. BufferStream bstrm;
  8602. if (write_request_line(bstrm, req.method, req.path) < 0) {
  8603. upgrade.error = Error::Write;
  8604. return false;
  8605. }
  8606. auto error = Error::Success;
  8607. if (!check_and_write_headers(bstrm, req.headers, write_headers, error)) {
  8608. upgrade.error = error;
  8609. return false;
  8610. }
  8611. const auto &data = bstrm.get_buffer();
  8612. if (!write_data(strm, data.data(), data.size())) {
  8613. upgrade.error = Error::Write;
  8614. return false;
  8615. }
  8616. // Verify 101 response and Sec-WebSocket-Accept header
  8617. auto expected_accept = websocket_accept_key(client_key);
  8618. return read_websocket_upgrade_response(strm, expected_accept, upgrade);
  8619. }
  8620. inline bool is_ip_address(const std::string &host) {
  8621. struct in_addr addr4;
  8622. struct in6_addr addr6;
  8623. return inet_pton(AF_INET, host.c_str(), &addr4) == 1 ||
  8624. inet_pton(AF_INET6, host.c_str(), &addr6) == 1;
  8625. }
  8626. // Resolve where a client should connect for `host`, honoring a user-supplied
  8627. // hostname-to-address map. `host` itself is never rewritten, so it keeps
  8628. // supplying the Host header and SNI; only the connection target changes.
  8629. //
  8630. // A mapped IP literal goes to `ip`, which keeps create_socket's AI_NUMERICHOST
  8631. // path. Anything else goes to `connect_host`, which create_socket resolves as
  8632. // a name, or uses as the socket path when the address family is AF_UNIX. An
  8633. // absent or empty mapping leaves `host` as the connection target; without the
  8634. // empty check the value would reach getaddrinfo as a null node and silently
  8635. // resolve to loopback.
  8636. inline void apply_addr_map(const std::map<std::string, std::string> &addr_map,
  8637. const std::string &host, std::string &connect_host,
  8638. std::string &ip) {
  8639. connect_host = host;
  8640. ip.clear();
  8641. auto it = addr_map.find(host);
  8642. if (it == addr_map.end() || it->second.empty()) { return; }
  8643. if (is_ip_address(it->second)) {
  8644. ip = it->second;
  8645. } else {
  8646. connect_host = it->second;
  8647. }
  8648. }
  8649. } // namespace detail
  8650. /*
  8651. * Group 2: detail namespace - SSL common utilities
  8652. */
  8653. #ifdef CPPHTTPLIB_SSL_ENABLED
  8654. namespace detail {
  8655. class SSLSocketStream final : public Stream {
  8656. public:
  8657. SSLSocketStream(
  8658. socket_t sock, tls::session_t session, time_t read_timeout_sec,
  8659. time_t read_timeout_usec, time_t write_timeout_sec,
  8660. time_t write_timeout_usec, time_t max_timeout_msec = 0,
  8661. std::chrono::time_point<std::chrono::steady_clock> start_time =
  8662. (std::chrono::steady_clock::time_point::min)());
  8663. ~SSLSocketStream() override;
  8664. bool is_readable() const override;
  8665. bool wait_readable() const override;
  8666. bool wait_writable() const override;
  8667. bool is_peer_alive() const override;
  8668. ssize_t read(char *ptr, size_t size) override;
  8669. ssize_t write(const char *ptr, size_t size) override;
  8670. void get_remote_ip_and_port(std::string &ip, int &port) const override;
  8671. void get_local_ip_and_port(std::string &ip, int &port) const override;
  8672. socket_t socket() const override;
  8673. time_t duration() const override;
  8674. void set_read_timeout(time_t sec, time_t usec = 0) override;
  8675. // See SocketStream::set_readable_hint().
  8676. void set_readable_hint() { readable_hint_ = true; }
  8677. private:
  8678. bool ensure_readable();
  8679. socket_t sock_;
  8680. tls::session_t session_;
  8681. time_t read_timeout_sec_;
  8682. time_t read_timeout_usec_;
  8683. time_t write_timeout_sec_;
  8684. time_t write_timeout_usec_;
  8685. time_t max_timeout_msec_;
  8686. const std::chrono::time_point<std::chrono::steady_clock> start_time_;
  8687. bool readable_hint_ = false;
  8688. };
  8689. // A TLS stream for WebSocket connections, where the receive path and the
  8690. // send path (application send() plus the heartbeat ping thread) run on
  8691. // different threads. A single TLS session must never be entered
  8692. // concurrently, so every call into the session is serialized by one mutex.
  8693. //
  8694. // Unlike SSLSocketStream, the socket is kept non-blocking for the stream's
  8695. // whole lifetime and each read()/write() performs a single non-blocking TLS
  8696. // call under the lock, then waits for readiness with select() outside the
  8697. // lock. The lock is therefore held only for CPU-bound work, so a reader
  8698. // blocked waiting for data never stalls a concurrent sender.
  8699. //
  8700. // This stream is used only for wss:// connections. Plain ws:// and ordinary
  8701. // HTTP/HTTPS keep using SocketStream/SSLSocketStream unchanged.
  8702. class WebSocketSSLStream final : public Stream {
  8703. public:
  8704. WebSocketSSLStream(socket_t sock, tls::session_t session,
  8705. time_t read_timeout_sec, time_t read_timeout_usec,
  8706. time_t write_timeout_sec, time_t write_timeout_usec);
  8707. ~WebSocketSSLStream() override;
  8708. bool is_readable() const override;
  8709. bool wait_readable() const override;
  8710. bool wait_writable() const override;
  8711. ssize_t read(char *ptr, size_t size) override;
  8712. ssize_t write(const char *ptr, size_t size) override;
  8713. void get_remote_ip_and_port(std::string &ip, int &port) const override;
  8714. void get_local_ip_and_port(std::string &ip, int &port) const override;
  8715. socket_t socket() const override;
  8716. time_t duration() const override;
  8717. void set_read_timeout(time_t sec, time_t usec = 0) override;
  8718. private:
  8719. mutable std::mutex session_mutex_;
  8720. socket_t sock_;
  8721. tls::session_t session_;
  8722. // WebSocket::close() shortens the read timeout from the closing thread
  8723. // while the receive thread is inside wait_readable(), so these two are read
  8724. // and written concurrently. The write timeouts are never mutated.
  8725. std::atomic<time_t> read_timeout_sec_;
  8726. std::atomic<time_t> read_timeout_usec_;
  8727. time_t write_timeout_sec_;
  8728. time_t write_timeout_usec_;
  8729. const std::chrono::time_point<std::chrono::steady_clock> start_time_;
  8730. };
  8731. #ifdef CPPHTTPLIB_OPENSSL_SUPPORT
  8732. inline std::string message_digest(const std::string &s, const EVP_MD *algo) {
  8733. auto context = std::unique_ptr<EVP_MD_CTX, decltype(&EVP_MD_CTX_free)>(
  8734. EVP_MD_CTX_new(), EVP_MD_CTX_free);
  8735. unsigned int hash_length = 0;
  8736. unsigned char hash[EVP_MAX_MD_SIZE];
  8737. EVP_DigestInit_ex(context.get(), algo, nullptr);
  8738. EVP_DigestUpdate(context.get(), s.c_str(), s.size());
  8739. EVP_DigestFinal_ex(context.get(), hash, &hash_length);
  8740. std::stringstream ss;
  8741. for (auto i = 0u; i < hash_length; ++i) {
  8742. ss << std::hex << std::setw(2) << std::setfill('0')
  8743. << static_cast<unsigned int>(hash[i]);
  8744. }
  8745. return ss.str();
  8746. }
  8747. inline std::string MD5(const std::string &s) {
  8748. return message_digest(s, EVP_md5());
  8749. }
  8750. inline std::string SHA_256(const std::string &s) {
  8751. return message_digest(s, EVP_sha256());
  8752. }
  8753. inline std::string SHA_512(const std::string &s) {
  8754. return message_digest(s, EVP_sha512());
  8755. }
  8756. #elif defined(CPPHTTPLIB_MBEDTLS_SUPPORT)
  8757. namespace {
  8758. template <size_t N>
  8759. inline std::string hash_to_hex(const unsigned char (&hash)[N]) {
  8760. std::stringstream ss;
  8761. for (size_t i = 0; i < N; ++i) {
  8762. ss << std::hex << std::setw(2) << std::setfill('0')
  8763. << static_cast<unsigned int>(hash[i]);
  8764. }
  8765. return ss.str();
  8766. }
  8767. } // namespace
  8768. #ifdef CPPHTTPLIB_MBEDTLS_V4
  8769. // Mbed TLS 4.x provides hashing (and TLS RNG) via PSA Crypto, which must be
  8770. // initialized once. PSA state is process-global; do not free it.
  8771. inline bool ensure_mbedtls_psa_crypto() {
  8772. static std::once_flag once;
  8773. static bool ok = false;
  8774. std::call_once(once, []() { ok = (psa_crypto_init() == PSA_SUCCESS); });
  8775. return ok;
  8776. }
  8777. inline bool psa_hash(psa_algorithm_t alg, const std::string &s,
  8778. unsigned char *out, size_t out_size) {
  8779. if (!ensure_mbedtls_psa_crypto()) { return false; }
  8780. size_t olen = 0;
  8781. return psa_hash_compute(alg, reinterpret_cast<const uint8_t *>(s.data()),
  8782. s.size(), out, out_size, &olen) == PSA_SUCCESS &&
  8783. olen == out_size;
  8784. }
  8785. #endif
  8786. inline std::string MD5(const std::string &s) {
  8787. unsigned char hash[16];
  8788. #ifdef CPPHTTPLIB_MBEDTLS_V4
  8789. if (!psa_hash(PSA_ALG_MD5, s, hash, sizeof(hash))) { return {}; }
  8790. #elif defined(CPPHTTPLIB_MBEDTLS_V3)
  8791. mbedtls_md5(reinterpret_cast<const unsigned char *>(s.c_str()), s.size(),
  8792. hash);
  8793. #else
  8794. mbedtls_md5_ret(reinterpret_cast<const unsigned char *>(s.c_str()), s.size(),
  8795. hash);
  8796. #endif
  8797. return hash_to_hex(hash);
  8798. }
  8799. inline std::string SHA_256(const std::string &s) {
  8800. unsigned char hash[32];
  8801. #ifdef CPPHTTPLIB_MBEDTLS_V4
  8802. if (!psa_hash(PSA_ALG_SHA_256, s, hash, sizeof(hash))) { return {}; }
  8803. #elif defined(CPPHTTPLIB_MBEDTLS_V3)
  8804. mbedtls_sha256(reinterpret_cast<const unsigned char *>(s.c_str()), s.size(),
  8805. hash, 0);
  8806. #else
  8807. mbedtls_sha256_ret(reinterpret_cast<const unsigned char *>(s.c_str()),
  8808. s.size(), hash, 0);
  8809. #endif
  8810. return hash_to_hex(hash);
  8811. }
  8812. inline std::string SHA_512(const std::string &s) {
  8813. unsigned char hash[64];
  8814. #ifdef CPPHTTPLIB_MBEDTLS_V4
  8815. if (!psa_hash(PSA_ALG_SHA_512, s, hash, sizeof(hash))) { return {}; }
  8816. #elif defined(CPPHTTPLIB_MBEDTLS_V3)
  8817. mbedtls_sha512(reinterpret_cast<const unsigned char *>(s.c_str()), s.size(),
  8818. hash, 0);
  8819. #else
  8820. mbedtls_sha512_ret(reinterpret_cast<const unsigned char *>(s.c_str()),
  8821. s.size(), hash, 0);
  8822. #endif
  8823. return hash_to_hex(hash);
  8824. }
  8825. #elif defined(CPPHTTPLIB_WOLFSSL_SUPPORT)
  8826. namespace {
  8827. template <size_t N>
  8828. inline std::string hash_to_hex(const unsigned char (&hash)[N]) {
  8829. std::stringstream ss;
  8830. for (size_t i = 0; i < N; ++i) {
  8831. ss << std::hex << std::setw(2) << std::setfill('0')
  8832. << static_cast<unsigned int>(hash[i]);
  8833. }
  8834. return ss.str();
  8835. }
  8836. } // namespace
  8837. inline std::string MD5(const std::string &s) {
  8838. unsigned char hash[WC_MD5_DIGEST_SIZE];
  8839. wc_Md5Hash(reinterpret_cast<const unsigned char *>(s.c_str()),
  8840. static_cast<word32>(s.size()), hash);
  8841. return hash_to_hex(hash);
  8842. }
  8843. inline std::string SHA_256(const std::string &s) {
  8844. unsigned char hash[WC_SHA256_DIGEST_SIZE];
  8845. wc_Sha256Hash(reinterpret_cast<const unsigned char *>(s.c_str()),
  8846. static_cast<word32>(s.size()), hash);
  8847. return hash_to_hex(hash);
  8848. }
  8849. inline std::string SHA_512(const std::string &s) {
  8850. unsigned char hash[WC_SHA512_DIGEST_SIZE];
  8851. wc_Sha512Hash(reinterpret_cast<const unsigned char *>(s.c_str()),
  8852. static_cast<word32>(s.size()), hash);
  8853. return hash_to_hex(hash);
  8854. }
  8855. #endif
  8856. template <typename T>
  8857. inline bool process_server_socket_ssl(
  8858. const std::atomic<socket_t> &svr_sock, tls::session_t session,
  8859. socket_t sock, size_t keep_alive_max_count, time_t keep_alive_timeout_sec,
  8860. time_t read_timeout_sec, time_t read_timeout_usec, time_t write_timeout_sec,
  8861. time_t write_timeout_usec, T callback) {
  8862. return process_server_socket_core(
  8863. svr_sock, sock, keep_alive_max_count, keep_alive_timeout_sec,
  8864. [&](bool close_connection, bool &connection_closed) {
  8865. SSLSocketStream strm(sock, session, read_timeout_sec, read_timeout_usec,
  8866. write_timeout_sec, write_timeout_usec);
  8867. // See the non-TLS path in process_server_socket().
  8868. strm.set_readable_hint();
  8869. return callback(strm, close_connection, connection_closed);
  8870. });
  8871. }
  8872. template <typename T>
  8873. inline bool process_client_socket_ssl(
  8874. tls::session_t session, socket_t sock, time_t read_timeout_sec,
  8875. time_t read_timeout_usec, time_t write_timeout_sec,
  8876. time_t write_timeout_usec, time_t max_timeout_msec,
  8877. std::chrono::time_point<std::chrono::steady_clock> start_time, T callback) {
  8878. SSLSocketStream strm(sock, session, read_timeout_sec, read_timeout_usec,
  8879. write_timeout_sec, write_timeout_usec, max_timeout_msec,
  8880. start_time);
  8881. return callback(strm);
  8882. }
  8883. inline std::pair<std::string, std::string> make_digest_authentication_header(
  8884. const Request &req, const std::map<std::string, std::string> &auth,
  8885. size_t cnonce_count, const std::string &cnonce, const std::string &username,
  8886. const std::string &password, bool is_proxy = false) {
  8887. std::string nc;
  8888. {
  8889. std::stringstream ss;
  8890. ss << std::setfill('0') << std::setw(8) << std::hex << cnonce_count;
  8891. nc = ss.str();
  8892. }
  8893. std::string qop;
  8894. if (auth.find("qop") != auth.end()) {
  8895. qop = auth.at("qop");
  8896. if (qop.find("auth-int") != std::string::npos) {
  8897. qop = "auth-int";
  8898. } else if (qop.find("auth") != std::string::npos) {
  8899. qop = "auth";
  8900. } else {
  8901. qop.clear();
  8902. }
  8903. }
  8904. std::string algo = "MD5";
  8905. if (auth.find("algorithm") != auth.end()) { algo = auth.at("algorithm"); }
  8906. std::string response;
  8907. {
  8908. auto H = algo == "SHA-256" ? detail::SHA_256
  8909. : algo == "SHA-512" ? detail::SHA_512
  8910. : detail::MD5;
  8911. auto A1 = username + ":" + auth.at("realm") + ":" + password;
  8912. auto A2 = req.method + ":" + req.path;
  8913. if (qop == "auth-int") { A2 += ":" + H(req.body); }
  8914. if (qop.empty()) {
  8915. response = H(H(A1) + ":" + auth.at("nonce") + ":" + H(A2));
  8916. } else {
  8917. response = H(H(A1) + ":" + auth.at("nonce") + ":" + nc + ":" + cnonce +
  8918. ":" + qop + ":" + H(A2));
  8919. }
  8920. }
  8921. auto opaque = (auth.find("opaque") != auth.end()) ? auth.at("opaque") : "";
  8922. auto field = "Digest username=\"" + username + "\", realm=\"" +
  8923. auth.at("realm") + "\", nonce=\"" + auth.at("nonce") +
  8924. "\", uri=\"" + req.path + "\", algorithm=" + algo +
  8925. (qop.empty() ? ", response=\""
  8926. : ", qop=" + qop + ", nc=" + nc + ", cnonce=\"" +
  8927. cnonce + "\", response=\"") +
  8928. response + "\"" +
  8929. (opaque.empty() ? "" : ", opaque=\"" + opaque + "\"");
  8930. auto key = is_proxy ? "Proxy-Authorization" : "Authorization";
  8931. return std::make_pair(key, field);
  8932. }
  8933. inline bool match_hostname(const std::string &pattern,
  8934. const std::string &hostname) {
  8935. // Exact match (case-insensitive)
  8936. if (detail::case_ignore::equal(hostname, pattern)) { return true; }
  8937. // Split both pattern and hostname into components by '.'
  8938. std::vector<std::string> pattern_components;
  8939. if (!pattern.empty()) {
  8940. split(pattern.data(), pattern.data() + pattern.size(), '.',
  8941. [&](const char *b, const char *e) {
  8942. pattern_components.emplace_back(b, e);
  8943. });
  8944. }
  8945. std::vector<std::string> host_components;
  8946. if (!hostname.empty()) {
  8947. split(hostname.data(), hostname.data() + hostname.size(), '.',
  8948. [&](const char *b, const char *e) {
  8949. host_components.emplace_back(b, e);
  8950. });
  8951. }
  8952. // Component count must match
  8953. if (host_components.size() != pattern_components.size()) { return false; }
  8954. // Compare each component with wildcard support
  8955. // Supports: "*" (full wildcard), "prefix*" (partial wildcard)
  8956. // https://bugs.launchpad.net/ubuntu/+source/firefox-3.0/+bug/376484
  8957. auto itr = pattern_components.begin();
  8958. for (const auto &h : host_components) {
  8959. auto &p = *itr;
  8960. if (!detail::case_ignore::equal(p, h) && p != "*") {
  8961. bool partial_match = false;
  8962. if (!p.empty() && p[p.size() - 1] == '*') {
  8963. const auto prefix_length = p.size() - 1;
  8964. if (prefix_length == 0) {
  8965. partial_match = true;
  8966. } else if (h.size() >= prefix_length) {
  8967. partial_match =
  8968. std::equal(p.begin(),
  8969. p.begin() + static_cast<std::string::difference_type>(
  8970. prefix_length),
  8971. h.begin(), [](const char ca, const char cb) {
  8972. return detail::case_ignore::to_lower(ca) ==
  8973. detail::case_ignore::to_lower(cb);
  8974. });
  8975. }
  8976. }
  8977. if (!partial_match) { return false; }
  8978. }
  8979. ++itr;
  8980. }
  8981. return true;
  8982. }
  8983. #ifdef _WIN32
  8984. // Verify certificate using Windows CertGetCertificateChain API.
  8985. // This provides real-time certificate validation with Windows Update
  8986. // integration, independent of the TLS backend.
  8987. inline bool verify_cert_with_windows_schannel(
  8988. const std::vector<unsigned char> &der_cert, const std::string &hostname,
  8989. bool verify_hostname, uint64_t &out_error, tls::const_session_t session) {
  8990. if (der_cert.empty()) { return false; }
  8991. out_error = 0;
  8992. // Create Windows certificate context from DER data
  8993. auto cert_context = CertCreateCertificateContext(
  8994. X509_ASN_ENCODING | PKCS_7_ASN_ENCODING, der_cert.data(),
  8995. static_cast<DWORD>(der_cert.size()));
  8996. if (!cert_context) {
  8997. out_error = GetLastError();
  8998. return false;
  8999. }
  9000. auto cert_guard =
  9001. scope_exit([&] { CertFreeCertificateContext(cert_context); });
  9002. // Give CryptoAPI the certificates the server sent. Without them it follows
  9003. // the leaf's AIA URL, which may lead to an issuer under an untrusted root.
  9004. std::vector<tls::cert_t> peer_certs;
  9005. tls::get_peer_certs(session, peer_certs);
  9006. auto store = CertOpenStore(CERT_STORE_PROV_MEMORY, 0, 0, 0, nullptr);
  9007. auto store_guard = scope_exit([&] {
  9008. for (auto cert : peer_certs) {
  9009. tls::free_cert(cert);
  9010. }
  9011. if (store) { CertCloseStore(store, 0); }
  9012. });
  9013. for (auto cert : peer_certs) {
  9014. std::vector<unsigned char> der;
  9015. if (store && tls::get_cert_der(cert, der)) {
  9016. CertAddEncodedCertificateToStore(store, X509_ASN_ENCODING, der.data(),
  9017. static_cast<DWORD>(der.size()),
  9018. CERT_STORE_ADD_USE_EXISTING, nullptr);
  9019. }
  9020. }
  9021. // Setup chain parameters
  9022. CERT_CHAIN_PARA chain_para = {};
  9023. chain_para.cbSize = sizeof(chain_para);
  9024. // Require the server authentication usage along the chain, which also
  9025. // rejects roots that Windows trusts only for other purposes.
  9026. LPSTR server_auth = const_cast<LPSTR>(szOID_PKIX_KP_SERVER_AUTH);
  9027. chain_para.RequestedUsage.dwType = USAGE_MATCH_TYPE_AND;
  9028. chain_para.RequestedUsage.Usage.cUsageIdentifier = 1;
  9029. chain_para.RequestedUsage.Usage.rgpszUsageIdentifier = &server_auth;
  9030. // Build certificate chain with revocation checking
  9031. PCCERT_CHAIN_CONTEXT chain_context = nullptr;
  9032. auto chain_result = CertGetCertificateChain(
  9033. nullptr, cert_context, nullptr, store, &chain_para,
  9034. CERT_CHAIN_CACHE_END_CERT | CERT_CHAIN_REVOCATION_CHECK_END_CERT |
  9035. CERT_CHAIN_REVOCATION_ACCUMULATIVE_TIMEOUT,
  9036. nullptr, &chain_context);
  9037. if (!chain_result || !chain_context) {
  9038. out_error = GetLastError();
  9039. return false;
  9040. }
  9041. auto chain_guard =
  9042. scope_exit([&] { CertFreeCertificateChain(chain_context); });
  9043. // Check if chain has errors
  9044. if (chain_context->TrustStatus.dwErrorStatus != CERT_TRUST_NO_ERROR) {
  9045. out_error = chain_context->TrustStatus.dwErrorStatus;
  9046. return false;
  9047. }
  9048. // Verify SSL policy
  9049. SSL_EXTRA_CERT_CHAIN_POLICY_PARA extra_policy_para = {};
  9050. extra_policy_para.cbSize = sizeof(extra_policy_para);
  9051. #ifdef AUTHTYPE_SERVER
  9052. extra_policy_para.dwAuthType = AUTHTYPE_SERVER;
  9053. #endif
  9054. std::wstring whost;
  9055. if (verify_hostname) {
  9056. whost = u8string_to_wstring(hostname.c_str());
  9057. extra_policy_para.pwszServerName = const_cast<wchar_t *>(whost.c_str());
  9058. }
  9059. CERT_CHAIN_POLICY_PARA policy_para = {};
  9060. policy_para.cbSize = sizeof(policy_para);
  9061. #ifdef CERT_CHAIN_POLICY_IGNORE_ALL_REV_UNKNOWN_FLAGS
  9062. policy_para.dwFlags = CERT_CHAIN_POLICY_IGNORE_ALL_REV_UNKNOWN_FLAGS;
  9063. #else
  9064. policy_para.dwFlags = 0;
  9065. #endif
  9066. policy_para.pvExtraPolicyPara = &extra_policy_para;
  9067. CERT_CHAIN_POLICY_STATUS policy_status = {};
  9068. policy_status.cbSize = sizeof(policy_status);
  9069. if (!CertVerifyCertificateChainPolicy(CERT_CHAIN_POLICY_SSL, chain_context,
  9070. &policy_para, &policy_status)) {
  9071. out_error = GetLastError();
  9072. return false;
  9073. }
  9074. if (policy_status.dwError != 0) {
  9075. out_error = policy_status.dwError;
  9076. return false;
  9077. }
  9078. return true;
  9079. }
  9080. #endif // _WIN32
  9081. // Loads CA file/dir configuration and applies the system CA policy to a
  9082. // client TLS context. PEM data and native stores are applied to the context
  9083. // directly at set time; has_custom_store reflects them for the Auto policy
  9084. // decision.
  9085. inline bool load_client_ca_config(tls::ctx_t ctx,
  9086. const std::string &ca_cert_file_path,
  9087. const std::string &ca_cert_dir_path,
  9088. bool has_custom_store, SystemCAMode mode,
  9089. uint64_t &backend_error) {
  9090. auto ret = true;
  9091. if (!ca_cert_file_path.empty()) {
  9092. if (!tls::load_ca_file(ctx, ca_cert_file_path.c_str())) {
  9093. backend_error = tls::get_error();
  9094. ret = false;
  9095. }
  9096. } else if (!ca_cert_dir_path.empty()) {
  9097. if (!tls::load_ca_dir(ctx, ca_cert_dir_path.c_str())) {
  9098. backend_error = tls::get_error();
  9099. ret = false;
  9100. }
  9101. }
  9102. auto has_custom_ca = !ca_cert_file_path.empty() ||
  9103. !ca_cert_dir_path.empty() || has_custom_store;
  9104. if (mode == SystemCAMode::Enabled ||
  9105. (mode == SystemCAMode::Auto && !has_custom_ca)) {
  9106. if (!tls::load_system_certs(ctx)) { backend_error = tls::get_error(); }
  9107. }
  9108. return ret;
  9109. }
  9110. // The parts of session setup that only SSLClient needs, plus the handful
  9111. // WebSocketClient also exposes; everything else takes the defaults, which is
  9112. // what keeps the two clients on one implementation.
  9113. struct ClientTlsSessionOptions {
  9114. // Both SSLClient and WebSocketClient expose this independently of
  9115. // certificate verification.
  9116. bool server_hostname_verification = true;
  9117. std::function<SSLVerifierResponse(tls::session_t)> session_verifier;
  9118. // When non-null, guards session creation against concurrent use of the
  9119. // context. A WebSocketClient is not safe to use from several threads to
  9120. // begin with, so it passes nothing.
  9121. std::mutex *ctx_mutex = nullptr;
  9122. #ifdef CPPHTTPLIB_WINDOWS_AUTOMATIC_ROOT_CERTIFICATES_UPDATE
  9123. // The caller decides whether Schannel has anything to say about this
  9124. // connection; see SSLClient::initialize_ssl().
  9125. bool windows_cert_verification = false;
  9126. // A server certificate verifier works on the backend's chain verification,
  9127. // so the backend keeps deciding and Schannel only adds its own check.
  9128. bool server_certificate_verifier_set = false;
  9129. #endif
  9130. };
  9131. // Filled in on failure for callers that report error details.
  9132. struct ClientTlsSessionError {
  9133. Error error = Error::Success;
  9134. int ssl_error = 0;
  9135. uint64_t backend_error = 0;
  9136. };
  9137. // Establishes a client TLS session on an already connected socket. On failure
  9138. // the session is left for the caller to free: SSLClient frees it right away,
  9139. // WebSocketClient keeps it in a member that shutdown_and_close() cleans up.
  9140. inline bool setup_client_tls_session(
  9141. const std::string &host, tls::ctx_t ctx, tls::session_t &session,
  9142. socket_t sock, bool server_certificate_verification, time_t timeout_sec,
  9143. time_t timeout_usec, ClientTlsSessionError *out_error = nullptr,
  9144. const ClientTlsSessionOptions &options = ClientTlsSessionOptions()) {
  9145. using namespace tls;
  9146. auto fail = [&](Error error, int ssl_error, uint64_t backend_error) {
  9147. if (out_error) {
  9148. out_error->error = error;
  9149. out_error->ssl_error = ssl_error;
  9150. out_error->backend_error = backend_error;
  9151. }
  9152. return false;
  9153. };
  9154. if (!ctx) {
  9155. session = nullptr;
  9156. return fail(Error::SSLConnection, 0, 0);
  9157. }
  9158. // With Windows verification on and no server certificate verifier set,
  9159. // Schannel is the only chain verifier. The backend's trust store is a
  9160. // snapshot of the Windows stores that lacks the roots Windows fetches on
  9161. // demand, so the backend's verdict is not used.
  9162. auto windows_verifies_chain = false;
  9163. #ifdef CPPHTTPLIB_WINDOWS_AUTOMATIC_ROOT_CERTIFICATES_UPDATE
  9164. windows_verifies_chain = options.windows_cert_verification &&
  9165. !options.server_certificate_verifier_set;
  9166. #endif
  9167. #if defined(CPPHTTPLIB_MBEDTLS_SUPPORT) || defined(CPPHTTPLIB_WOLFSSL_SUPPORT)
  9168. // Mbed TLS and wolfSSL need the verification mode set explicitly; OpenSSL
  9169. // uses SSL_VERIFY_NONE and does all verification post-handshake. Unless
  9170. // Schannel verifies the chain instead, chain verification happens during
  9171. // the handshake even for IP hosts; the certificate identity is verified
  9172. // post-handshake via verify_hostname().
  9173. set_verify_client(ctx,
  9174. server_certificate_verification && !windows_verifies_chain);
  9175. #endif
  9176. {
  9177. std::unique_lock<std::mutex> guard;
  9178. if (options.ctx_mutex) {
  9179. guard = std::unique_lock<std::mutex>(*options.ctx_mutex);
  9180. }
  9181. session = create_session(ctx, sock);
  9182. }
  9183. if (!session) { return fail(Error::SSLConnection, 0, get_error()); }
  9184. // RFC 6066: SNI must not be set for IP addresses; skip it for IP hosts, so
  9185. // their identity is checked post-handshake below instead. On Mbed TLS and
  9186. // wolfSSL, set_sni also drives handshake-time hostname verification, so
  9187. // options.server_hostname_verification is threaded through here.
  9188. if (!is_ip_address(host)) {
  9189. if (!set_sni(session, host.c_str(), options.server_hostname_verification)) {
  9190. return fail(Error::SSLConnection, 0, get_error());
  9191. }
  9192. }
  9193. TlsError tls_err;
  9194. if (!connect_nonblocking(session, sock, timeout_sec, timeout_usec,
  9195. &tls_err)) {
  9196. auto error = Error::SSLConnection;
  9197. if (tls_err.code == ErrorCode::CertVerifyFailed) {
  9198. error = Error::SSLServerVerification;
  9199. } else if (tls_err.code == ErrorCode::HostnameMismatch) {
  9200. error = Error::SSLServerHostnameVerification;
  9201. }
  9202. return fail(error, static_cast<int>(tls_err.code), tls_err.backend_code);
  9203. }
  9204. auto verification_status = SSLVerifierResponse::NoDecisionMade;
  9205. if (options.session_verifier) {
  9206. verification_status = options.session_verifier(session);
  9207. }
  9208. if (verification_status == SSLVerifierResponse::CertificateRejected) {
  9209. return fail(Error::SSLServerVerification, 0, get_error());
  9210. }
  9211. if (verification_status == SSLVerifierResponse::NoDecisionMade &&
  9212. server_certificate_verification) {
  9213. if (!windows_verifies_chain) {
  9214. auto verify_result = get_verify_result(session);
  9215. if (verify_result != 0) {
  9216. return fail(Error::SSLServerVerification, 0,
  9217. static_cast<uint64_t>(verify_result));
  9218. }
  9219. }
  9220. auto server_cert = get_peer_cert(session);
  9221. if (!server_cert) {
  9222. return fail(Error::SSLServerVerification, 0, get_error());
  9223. }
  9224. auto cert_guard = detail::scope_exit([&] { free_cert(server_cert); });
  9225. // Identity check against the peer certificate, post-handshake for all
  9226. // backends. For IP hosts this is the only identity verification, since no
  9227. // hostname is bound during the handshake.
  9228. if (options.server_hostname_verification) {
  9229. if (!verify_hostname(server_cert, host.c_str())) {
  9230. return fail(Error::SSLServerHostnameVerification, 0,
  9231. hostname_mismatch_code());
  9232. }
  9233. }
  9234. #ifdef CPPHTTPLIB_WINDOWS_AUTOMATIC_ROOT_CERTIFICATES_UPDATE
  9235. // Windows Schannel verification, which lets Windows fetch missing roots
  9236. // and intermediates on demand. It must not be skipped: unless a server
  9237. // certificate verifier is set, it is the only chain check.
  9238. if (options.windows_cert_verification) {
  9239. std::vector<unsigned char> der;
  9240. uint64_t wincrypt_error = 0;
  9241. if (!get_cert_der(server_cert, der) ||
  9242. !verify_cert_with_windows_schannel(
  9243. der, host, options.server_hostname_verification, wincrypt_error,
  9244. session)) {
  9245. return fail(Error::SSLServerVerification, 0, wincrypt_error);
  9246. }
  9247. }
  9248. #endif
  9249. }
  9250. return true;
  9251. }
  9252. } // namespace detail
  9253. #endif // CPPHTTPLIB_SSL_ENABLED
  9254. /*
  9255. * Group 3: httplib namespace - Non-SSL public API implementations
  9256. */
  9257. inline void default_socket_options(socket_t sock) {
  9258. set_socket_opt(sock, SOL_SOCKET,
  9259. #ifdef SO_REUSEPORT
  9260. SO_REUSEPORT,
  9261. #else
  9262. SO_REUSEADDR,
  9263. #endif
  9264. 1);
  9265. }
  9266. inline bool set_socket_opt(socket_t sock, int level, int optname, int optval) {
  9267. return detail::set_socket_opt_impl(sock, level, optname, &optval,
  9268. sizeof(optval));
  9269. }
  9270. inline std::string get_bearer_token_auth(const Request &req) {
  9271. // The auth scheme is case-insensitive (RFC 9110 11.1), and a value shorter
  9272. // than the prefix carries no token.
  9273. constexpr const char bearer_prefix[] = "Bearer ";
  9274. constexpr auto bearer_prefix_len = detail::str_len(bearer_prefix);
  9275. auto value = req.get_header_value("Authorization");
  9276. if (value.size() >= bearer_prefix_len &&
  9277. detail::case_ignore::equal(value.substr(0, bearer_prefix_len),
  9278. bearer_prefix)) {
  9279. return value.substr(bearer_prefix_len);
  9280. }
  9281. return "";
  9282. }
  9283. inline const char *status_message(int status) {
  9284. switch (status) {
  9285. case StatusCode::Continue_100: return "Continue";
  9286. case StatusCode::SwitchingProtocol_101: return "Switching Protocol";
  9287. case StatusCode::Processing_102: return "Processing";
  9288. case StatusCode::EarlyHints_103: return "Early Hints";
  9289. case StatusCode::OK_200: return "OK";
  9290. case StatusCode::Created_201: return "Created";
  9291. case StatusCode::Accepted_202: return "Accepted";
  9292. case StatusCode::NonAuthoritativeInformation_203:
  9293. return "Non-Authoritative Information";
  9294. case StatusCode::NoContent_204: return "No Content";
  9295. case StatusCode::ResetContent_205: return "Reset Content";
  9296. case StatusCode::PartialContent_206: return "Partial Content";
  9297. case StatusCode::MultiStatus_207: return "Multi-Status";
  9298. case StatusCode::AlreadyReported_208: return "Already Reported";
  9299. case StatusCode::IMUsed_226: return "IM Used";
  9300. case StatusCode::MultipleChoices_300: return "Multiple Choices";
  9301. case StatusCode::MovedPermanently_301: return "Moved Permanently";
  9302. case StatusCode::Found_302: return "Found";
  9303. case StatusCode::SeeOther_303: return "See Other";
  9304. case StatusCode::NotModified_304: return "Not Modified";
  9305. case StatusCode::UseProxy_305: return "Use Proxy";
  9306. case StatusCode::unused_306: return "unused";
  9307. case StatusCode::TemporaryRedirect_307: return "Temporary Redirect";
  9308. case StatusCode::PermanentRedirect_308: return "Permanent Redirect";
  9309. case StatusCode::BadRequest_400: return "Bad Request";
  9310. case StatusCode::Unauthorized_401: return "Unauthorized";
  9311. case StatusCode::PaymentRequired_402: return "Payment Required";
  9312. case StatusCode::Forbidden_403: return "Forbidden";
  9313. case StatusCode::NotFound_404: return "Not Found";
  9314. case StatusCode::MethodNotAllowed_405: return "Method Not Allowed";
  9315. case StatusCode::NotAcceptable_406: return "Not Acceptable";
  9316. case StatusCode::ProxyAuthenticationRequired_407:
  9317. return "Proxy Authentication Required";
  9318. case StatusCode::RequestTimeout_408: return "Request Timeout";
  9319. case StatusCode::Conflict_409: return "Conflict";
  9320. case StatusCode::Gone_410: return "Gone";
  9321. case StatusCode::LengthRequired_411: return "Length Required";
  9322. case StatusCode::PreconditionFailed_412: return "Precondition Failed";
  9323. case StatusCode::PayloadTooLarge_413: return "Payload Too Large";
  9324. case StatusCode::UriTooLong_414: return "URI Too Long";
  9325. case StatusCode::UnsupportedMediaType_415: return "Unsupported Media Type";
  9326. case StatusCode::RangeNotSatisfiable_416: return "Range Not Satisfiable";
  9327. case StatusCode::ExpectationFailed_417: return "Expectation Failed";
  9328. case StatusCode::ImATeapot_418: return "I'm a teapot";
  9329. case StatusCode::MisdirectedRequest_421: return "Misdirected Request";
  9330. case StatusCode::UnprocessableContent_422: return "Unprocessable Content";
  9331. case StatusCode::Locked_423: return "Locked";
  9332. case StatusCode::FailedDependency_424: return "Failed Dependency";
  9333. case StatusCode::TooEarly_425: return "Too Early";
  9334. case StatusCode::UpgradeRequired_426: return "Upgrade Required";
  9335. case StatusCode::PreconditionRequired_428: return "Precondition Required";
  9336. case StatusCode::TooManyRequests_429: return "Too Many Requests";
  9337. case StatusCode::RequestHeaderFieldsTooLarge_431:
  9338. return "Request Header Fields Too Large";
  9339. case StatusCode::UnavailableForLegalReasons_451:
  9340. return "Unavailable For Legal Reasons";
  9341. case StatusCode::NotImplemented_501: return "Not Implemented";
  9342. case StatusCode::BadGateway_502: return "Bad Gateway";
  9343. case StatusCode::ServiceUnavailable_503: return "Service Unavailable";
  9344. case StatusCode::GatewayTimeout_504: return "Gateway Timeout";
  9345. case StatusCode::HttpVersionNotSupported_505:
  9346. return "HTTP Version Not Supported";
  9347. case StatusCode::VariantAlsoNegotiates_506: return "Variant Also Negotiates";
  9348. case StatusCode::InsufficientStorage_507: return "Insufficient Storage";
  9349. case StatusCode::LoopDetected_508: return "Loop Detected";
  9350. case StatusCode::NotExtended_510: return "Not Extended";
  9351. case StatusCode::NetworkAuthenticationRequired_511:
  9352. return "Network Authentication Required";
  9353. default:
  9354. case StatusCode::InternalServerError_500: return "Internal Server Error";
  9355. }
  9356. }
  9357. inline std::string to_string(const Error error) {
  9358. switch (error) {
  9359. case Error::Success: return "Success (no error)";
  9360. case Error::Unknown: return "Unknown";
  9361. case Error::Connection: return "Could not establish connection";
  9362. case Error::BindIPAddress: return "Failed to bind IP address";
  9363. case Error::Read: return "Failed to read connection";
  9364. case Error::Write: return "Failed to write connection";
  9365. case Error::ExceedRedirectCount: return "Maximum redirect count exceeded";
  9366. case Error::Canceled: return "Connection handling canceled";
  9367. case Error::SSLConnection: return "SSL connection failed";
  9368. case Error::SSLLoadingCerts: return "SSL certificate loading failed";
  9369. case Error::SSLServerVerification: return "SSL server verification failed";
  9370. case Error::SSLServerHostnameVerification:
  9371. return "SSL server hostname verification failed";
  9372. case Error::UnsupportedMultipartBoundaryChars:
  9373. return "Unsupported HTTP multipart boundary characters";
  9374. case Error::Compression: return "Compression failed";
  9375. case Error::ConnectionTimeout: return "Connection timed out";
  9376. case Error::ProxyConnection: return "Proxy connection failed";
  9377. case Error::ConnectionClosed: return "Connection closed by server";
  9378. case Error::Timeout: return "Read timeout";
  9379. case Error::ResourceExhaustion: return "Resource exhaustion";
  9380. case Error::TooManyFormDataFiles: return "Too many form data files";
  9381. case Error::ExceedMaxPayloadSize: return "Exceeded maximum payload size";
  9382. case Error::ExceedUriMaxLength: return "Exceeded maximum URI length";
  9383. case Error::ExceedMaxSocketDescriptorCount:
  9384. return "Exceeded maximum socket descriptor count";
  9385. case Error::InvalidRequestLine: return "Invalid request line";
  9386. case Error::InvalidHTTPMethod: return "Invalid HTTP method";
  9387. case Error::InvalidHTTPVersion: return "Invalid HTTP version";
  9388. case Error::InvalidHeaders: return "Invalid headers";
  9389. case Error::MultipartParsing: return "Multipart parsing failed";
  9390. case Error::OpenFile: return "Failed to open file";
  9391. case Error::Listen: return "Failed to listen on socket";
  9392. case Error::GetSockName: return "Failed to get socket name";
  9393. case Error::UnsupportedAddressFamily: return "Unsupported address family";
  9394. case Error::HTTPParsing: return "HTTP parsing failed";
  9395. case Error::InvalidRangeHeader: return "Invalid Range header";
  9396. case Error::UnsupportedContentEncoding: return "Unsupported Content-Encoding";
  9397. case Error::WebSocketHandshake: return "WebSocket handshake failed";
  9398. case Error::UserCallbackException: return "User callback threw an exception";
  9399. default: break;
  9400. }
  9401. return "Invalid";
  9402. }
  9403. inline std::ostream &operator<<(std::ostream &os, const Error &obj) {
  9404. os << to_string(obj);
  9405. os << " (" << static_cast<std::underlying_type<Error>::type>(obj) << ')';
  9406. return os;
  9407. }
  9408. inline std::string hosted_at(const std::string &hostname) {
  9409. std::vector<std::string> addrs;
  9410. hosted_at(hostname, addrs);
  9411. if (addrs.empty()) { return std::string(); }
  9412. return addrs[0];
  9413. }
  9414. inline void hosted_at(const std::string &hostname,
  9415. std::vector<std::string> &addrs) {
  9416. struct addrinfo hints;
  9417. struct addrinfo *result;
  9418. memset(&hints, 0, sizeof(struct addrinfo));
  9419. hints.ai_family = AF_UNSPEC;
  9420. hints.ai_socktype = SOCK_STREAM;
  9421. hints.ai_protocol = 0;
  9422. if (detail::getaddrinfo_with_timeout(hostname.c_str(), nullptr, &hints,
  9423. &result, 0)) {
  9424. #if defined __linux__ && !defined __ANDROID__
  9425. res_init();
  9426. #endif
  9427. return;
  9428. }
  9429. auto se = detail::scope_exit([&] { freeaddrinfo(result); });
  9430. for (auto rp = result; rp; rp = rp->ai_next) {
  9431. const auto &addr =
  9432. *reinterpret_cast<struct sockaddr_storage *>(rp->ai_addr);
  9433. std::string ip;
  9434. auto dummy = -1;
  9435. if (detail::get_ip_and_port(addr, sizeof(struct sockaddr_storage), ip,
  9436. dummy)) {
  9437. addrs.emplace_back(std::move(ip));
  9438. }
  9439. }
  9440. }
  9441. inline std::string encode_uri_component(const std::string &value) {
  9442. std::ostringstream escaped;
  9443. escaped.fill('0');
  9444. escaped << std::hex;
  9445. for (auto c : value) {
  9446. if (detail::is_ascii_alnum(c) || c == '-' || c == '_' || c == '.' ||
  9447. c == '!' || c == '~' || c == '*' || c == '\'' || c == '(' || c == ')') {
  9448. escaped << c;
  9449. } else {
  9450. escaped << std::uppercase;
  9451. escaped << '%' << std::setw(2)
  9452. << static_cast<int>(static_cast<unsigned char>(c));
  9453. escaped << std::nouppercase;
  9454. }
  9455. }
  9456. return escaped.str();
  9457. }
  9458. inline std::string encode_uri(const std::string &value) {
  9459. std::ostringstream escaped;
  9460. escaped.fill('0');
  9461. escaped << std::hex;
  9462. for (auto c : value) {
  9463. if (detail::is_ascii_alnum(c) || c == '-' || c == '_' || c == '.' ||
  9464. c == '!' || c == '~' || c == '*' || c == '\'' || c == '(' || c == ')' ||
  9465. c == ';' || c == '/' || c == '?' || c == ':' || c == '@' || c == '&' ||
  9466. c == '=' || c == '+' || c == '$' || c == ',' || c == '#') {
  9467. escaped << c;
  9468. } else {
  9469. escaped << std::uppercase;
  9470. escaped << '%' << std::setw(2)
  9471. << static_cast<int>(static_cast<unsigned char>(c));
  9472. escaped << std::nouppercase;
  9473. }
  9474. }
  9475. return escaped.str();
  9476. }
  9477. inline std::string decode_uri_component(const std::string &value) {
  9478. std::string result;
  9479. for (size_t i = 0; i < value.size(); i++) {
  9480. if (value[i] == '%' && i + 2 < value.size()) {
  9481. auto val = 0;
  9482. if (detail::from_hex_to_i(value, i + 1, 2, val)) {
  9483. result += static_cast<char>(val);
  9484. i += 2;
  9485. } else {
  9486. result += value[i];
  9487. }
  9488. } else {
  9489. result += value[i];
  9490. }
  9491. }
  9492. return result;
  9493. }
  9494. inline std::string decode_uri(const std::string &value) {
  9495. std::string result;
  9496. for (size_t i = 0; i < value.size(); i++) {
  9497. if (value[i] == '%' && i + 2 < value.size()) {
  9498. auto val = 0;
  9499. if (detail::from_hex_to_i(value, i + 1, 2, val)) {
  9500. auto c = static_cast<char>(val);
  9501. // Keep escapes of the reserved characters that encode_uri leaves
  9502. // literal, so decode_uri is the inverse of encode_uri and an escaped
  9503. // delimiter is not promoted into a real one (as with JS decodeURI).
  9504. if (c == ';' || c == '/' || c == '?' || c == ':' || c == '@' ||
  9505. c == '&' || c == '=' || c == '+' || c == '$' || c == ',' ||
  9506. c == '#') {
  9507. result += value[i];
  9508. result += value[i + 1];
  9509. result += value[i + 2];
  9510. } else {
  9511. result += c;
  9512. }
  9513. i += 2;
  9514. } else {
  9515. result += value[i];
  9516. }
  9517. } else {
  9518. result += value[i];
  9519. }
  9520. }
  9521. return result;
  9522. }
  9523. inline std::string encode_path_component(const std::string &component) {
  9524. std::string result;
  9525. result.reserve(component.size() * 3);
  9526. for (size_t i = 0; i < component.size(); i++) {
  9527. auto c = static_cast<unsigned char>(component[i]);
  9528. // Unreserved characters per RFC 3986: ALPHA / DIGIT / "-" / "." / "_" / "~"
  9529. if (detail::is_ascii_alnum(static_cast<char>(c)) || c == '-' || c == '.' ||
  9530. c == '_' || c == '~') {
  9531. result += static_cast<char>(c);
  9532. }
  9533. // Path-safe sub-delimiters: "!" / "$" / "&" / "'" / "(" / ")" / "*" / "+" /
  9534. // "," / ";" / "="
  9535. else if (c == '!' || c == '$' || c == '&' || c == '\'' || c == '(' ||
  9536. c == ')' || c == '*' || c == '+' || c == ',' || c == ';' ||
  9537. c == '=') {
  9538. result += static_cast<char>(c);
  9539. }
  9540. // Colon is allowed in path segments except first segment
  9541. else if (c == ':') {
  9542. result += static_cast<char>(c);
  9543. }
  9544. // @ is allowed in path
  9545. else if (c == '@') {
  9546. result += static_cast<char>(c);
  9547. } else {
  9548. result += '%';
  9549. char hex[3];
  9550. snprintf(hex, sizeof(hex), "%02X", c);
  9551. result.append(hex, 2);
  9552. }
  9553. }
  9554. return result;
  9555. }
  9556. inline std::string decode_path_component(const std::string &component) {
  9557. std::string result;
  9558. result.reserve(component.size());
  9559. for (size_t i = 0; i < component.size(); i++) {
  9560. if (component[i] == '%' && i + 1 < component.size()) {
  9561. if (component[i + 1] == 'u') {
  9562. // Unicode %uXXXX encoding
  9563. auto val = 0;
  9564. if (detail::from_hex_to_i(component, i + 2, 4, val)) {
  9565. // 4 digits Unicode codes: val is 0x0000-0xFFFF (from 4 hex digits),
  9566. // so to_utf8 writes at most 3 bytes. buff[4] is safe.
  9567. char buff[4];
  9568. size_t len = detail::to_utf8(val, buff);
  9569. if (len > 0) { result.append(buff, len); }
  9570. i += 5; // 'u0000'
  9571. } else {
  9572. result += component[i];
  9573. }
  9574. } else {
  9575. // Standard %XX encoding
  9576. auto val = 0;
  9577. if (detail::from_hex_to_i(component, i + 1, 2, val)) {
  9578. // 2 digits hex codes
  9579. result += static_cast<char>(val);
  9580. i += 2; // 'XX'
  9581. } else {
  9582. result += component[i];
  9583. }
  9584. }
  9585. } else {
  9586. result += component[i];
  9587. }
  9588. }
  9589. return result;
  9590. }
  9591. inline std::string encode_query_component(const std::string &component,
  9592. bool space_as_plus) {
  9593. std::string result;
  9594. result.reserve(component.size() * 3);
  9595. for (size_t i = 0; i < component.size(); i++) {
  9596. auto c = static_cast<unsigned char>(component[i]);
  9597. // Unreserved characters per RFC 3986
  9598. if (detail::is_ascii_alnum(static_cast<char>(c)) || c == '-' || c == '.' ||
  9599. c == '_' || c == '~') {
  9600. result += static_cast<char>(c);
  9601. }
  9602. // Space handling
  9603. else if (c == ' ') {
  9604. if (space_as_plus) {
  9605. result += '+';
  9606. } else {
  9607. result += "%20";
  9608. }
  9609. }
  9610. // Plus sign handling
  9611. else if (c == '+') {
  9612. if (space_as_plus) {
  9613. result += "%2B";
  9614. } else {
  9615. result += static_cast<char>(c);
  9616. }
  9617. }
  9618. // Query-safe sub-delimiters (excluding & and = which are query delimiters)
  9619. else if (c == '!' || c == '$' || c == '\'' || c == '(' || c == ')' ||
  9620. c == '*' || c == ',' || c == ';') {
  9621. result += static_cast<char>(c);
  9622. }
  9623. // Colon and @ are allowed in query
  9624. else if (c == ':' || c == '@') {
  9625. result += static_cast<char>(c);
  9626. }
  9627. // Forward slash is allowed in query values
  9628. else if (c == '/') {
  9629. result += static_cast<char>(c);
  9630. }
  9631. // Question mark is allowed in query values (after first ?)
  9632. else if (c == '?') {
  9633. result += static_cast<char>(c);
  9634. } else {
  9635. result += '%';
  9636. char hex[3];
  9637. snprintf(hex, sizeof(hex), "%02X", c);
  9638. result.append(hex, 2);
  9639. }
  9640. }
  9641. return result;
  9642. }
  9643. inline std::string decode_query_component(const std::string &component,
  9644. bool plus_as_space) {
  9645. std::string result;
  9646. result.reserve(component.size());
  9647. for (size_t i = 0; i < component.size(); i++) {
  9648. if (component[i] == '%' && i + 2 < component.size()) {
  9649. auto val = 0;
  9650. if (detail::from_hex_to_i(component, i + 1, 2, val)) {
  9651. result += static_cast<char>(val);
  9652. i += 2;
  9653. } else {
  9654. result += component[i];
  9655. }
  9656. } else if (component[i] == '+' && plus_as_space) {
  9657. result += ' '; // + becomes space in form-urlencoded
  9658. } else {
  9659. result += component[i];
  9660. }
  9661. }
  9662. return result;
  9663. }
  9664. inline std::string sanitize_filename(const std::string &filename) {
  9665. // Extract basename: find the last path separator (/ or \)
  9666. auto pos = filename.find_last_of("/\\");
  9667. auto result =
  9668. (pos != std::string::npos) ? filename.substr(pos + 1) : filename;
  9669. // Strip null bytes
  9670. result.erase(std::remove(result.begin(), result.end(), '\0'), result.end());
  9671. // Trim whitespace
  9672. {
  9673. auto start = result.find_first_not_of(" \t");
  9674. auto end = result.find_last_not_of(" \t");
  9675. result = (start == std::string::npos)
  9676. ? ""
  9677. : result.substr(start, end - start + 1);
  9678. }
  9679. // Reject . and ..
  9680. if (result == "." || result == "..") { return ""; }
  9681. return result;
  9682. }
  9683. inline std::string append_query_params(const std::string &path,
  9684. const Params &params) {
  9685. std::string path_with_query = path;
  9686. thread_local const std::regex re("[^?]+\\?.*");
  9687. auto delm = std::regex_match(path, re) ? '&' : '?';
  9688. path_with_query += delm + detail::params_to_query_str(params);
  9689. return path_with_query;
  9690. }
  9691. // Header utilities
  9692. inline std::pair<std::string, std::string>
  9693. make_range_header(const Ranges &ranges) {
  9694. std::string field = "bytes=";
  9695. auto i = 0;
  9696. for (const auto &r : ranges) {
  9697. if (i != 0) { field += ", "; }
  9698. if (r.first != -1) { field += std::to_string(r.first); }
  9699. field += '-';
  9700. if (r.second != -1) { field += std::to_string(r.second); }
  9701. i++;
  9702. }
  9703. return std::make_pair("Range", std::move(field));
  9704. }
  9705. inline std::pair<std::string, std::string>
  9706. make_basic_authentication_header(const std::string &username,
  9707. const std::string &password, bool is_proxy) {
  9708. auto field = "Basic " + detail::base64_encode(username + ":" + password);
  9709. auto key = is_proxy ? "Proxy-Authorization" : "Authorization";
  9710. return std::make_pair(key, std::move(field));
  9711. }
  9712. inline std::pair<std::string, std::string>
  9713. make_bearer_token_authentication_header(const std::string &token,
  9714. bool is_proxy = false) {
  9715. auto field = "Bearer " + token;
  9716. auto key = is_proxy ? "Proxy-Authorization" : "Authorization";
  9717. return std::make_pair(key, std::move(field));
  9718. }
  9719. // Request implementation
  9720. inline size_t Request::get_header_value_u64(const std::string &key, size_t def,
  9721. size_t id) const {
  9722. return detail::get_header_value_u64(headers, key, def, id);
  9723. }
  9724. inline bool Request::has_header(const std::string &key) const {
  9725. return detail::has_header(headers, key);
  9726. }
  9727. inline std::string Request::get_header_value(const std::string &key,
  9728. const char *def, size_t id) const {
  9729. return detail::get_header_value(headers, key, def, id);
  9730. }
  9731. inline size_t Request::get_header_value_count(const std::string &key) const {
  9732. return detail::get_header_value_count(headers, key);
  9733. }
  9734. inline void Request::set_header(const std::string &key,
  9735. const std::string &val) {
  9736. detail::set_header(headers, key, val);
  9737. }
  9738. inline bool Request::has_trailer(const std::string &key) const {
  9739. return trailers.find(key) != trailers.end();
  9740. }
  9741. inline std::string Request::get_trailer_value(const std::string &key,
  9742. size_t id) const {
  9743. return detail::get_multimap_value(trailers, key, id);
  9744. }
  9745. inline size_t Request::get_trailer_value_count(const std::string &key) const {
  9746. return trailers.count(key);
  9747. }
  9748. inline bool Request::has_param(const std::string &key) const {
  9749. return params.find(key) != params.end();
  9750. }
  9751. inline std::string Request::get_param_value(const std::string &key,
  9752. size_t id) const {
  9753. return detail::get_multimap_value(params, key, id);
  9754. }
  9755. inline std::vector<std::string>
  9756. Request::get_param_values(const std::string &key) const {
  9757. auto rng = params.equal_range(key);
  9758. std::vector<std::string> values;
  9759. values.reserve(static_cast<size_t>(std::distance(rng.first, rng.second)));
  9760. for (auto it = rng.first; it != rng.second; ++it) {
  9761. values.push_back(it->second);
  9762. }
  9763. return values;
  9764. }
  9765. inline size_t Request::get_param_value_count(const std::string &key) const {
  9766. return params.count(key);
  9767. }
  9768. inline bool Request::is_multipart_form_data() const {
  9769. const auto &content_type = get_header_value("Content-Type");
  9770. return detail::extract_media_type(content_type) == "multipart/form-data";
  9771. }
  9772. // Multipart FormData implementation
  9773. inline std::string MultipartFormData::get_field(const std::string &key,
  9774. size_t id) const {
  9775. auto rng = fields.equal_range(key);
  9776. auto it = rng.first;
  9777. std::advance(it, static_cast<ssize_t>(id));
  9778. if (it != rng.second) { return it->second.content; }
  9779. return std::string();
  9780. }
  9781. inline std::vector<std::string>
  9782. MultipartFormData::get_fields(const std::string &key) const {
  9783. std::vector<std::string> values;
  9784. auto rng = fields.equal_range(key);
  9785. for (auto it = rng.first; it != rng.second; it++) {
  9786. values.push_back(it->second.content);
  9787. }
  9788. return values;
  9789. }
  9790. inline bool MultipartFormData::has_field(const std::string &key) const {
  9791. return fields.find(key) != fields.end();
  9792. }
  9793. inline size_t MultipartFormData::get_field_count(const std::string &key) const {
  9794. return fields.count(key);
  9795. }
  9796. inline FormData MultipartFormData::get_file(const std::string &key,
  9797. size_t id) const {
  9798. return detail::get_multimap_value(files, key, id);
  9799. }
  9800. inline std::vector<FormData>
  9801. MultipartFormData::get_files(const std::string &key) const {
  9802. std::vector<FormData> values;
  9803. auto rng = files.equal_range(key);
  9804. for (auto it = rng.first; it != rng.second; it++) {
  9805. values.push_back(it->second);
  9806. }
  9807. return values;
  9808. }
  9809. inline bool MultipartFormData::has_file(const std::string &key) const {
  9810. return files.find(key) != files.end();
  9811. }
  9812. inline size_t MultipartFormData::get_file_count(const std::string &key) const {
  9813. return files.count(key);
  9814. }
  9815. // Multipart FormData writer implementation
  9816. inline bool is_valid_multipart_boundary(const std::string &boundary) {
  9817. return detail::is_multipart_boundary_chars_valid(boundary);
  9818. }
  9819. inline MultipartFormDataWriter::MultipartFormDataWriter()
  9820. : boundary_(detail::make_multipart_data_boundary()) {}
  9821. inline MultipartFormDataWriter::MultipartFormDataWriter(std::string boundary)
  9822. : boundary_(std::move(boundary)) {}
  9823. inline const std::string &MultipartFormDataWriter::boundary() const {
  9824. return boundary_;
  9825. }
  9826. inline std::string MultipartFormDataWriter::content_type() const {
  9827. return detail::serialize_multipart_formdata_get_content_type(boundary_);
  9828. }
  9829. inline std::string
  9830. MultipartFormDataWriter::serialize(const UploadFormDataItems &items) const {
  9831. return detail::serialize_multipart_formdata(items, boundary_);
  9832. }
  9833. inline size_t MultipartFormDataWriter::content_length(
  9834. const UploadFormDataItems &items) const {
  9835. return detail::get_multipart_content_length(items, boundary_);
  9836. }
  9837. inline std::string
  9838. MultipartFormDataWriter::item_begin(const UploadFormData &item) const {
  9839. return detail::serialize_multipart_formdata_item_begin(item, boundary_);
  9840. }
  9841. inline std::string MultipartFormDataWriter::item_end() {
  9842. return detail::serialize_multipart_formdata_item_end();
  9843. }
  9844. inline std::string MultipartFormDataWriter::finish() const {
  9845. return detail::serialize_multipart_formdata_finish(boundary_);
  9846. }
  9847. // Response implementation
  9848. inline size_t Response::get_header_value_u64(const std::string &key, size_t def,
  9849. size_t id) const {
  9850. return detail::get_header_value_u64(headers, key, def, id);
  9851. }
  9852. inline bool Response::has_header(const std::string &key) const {
  9853. return headers.find(key) != headers.end();
  9854. }
  9855. inline std::string Response::get_header_value(const std::string &key,
  9856. const char *def,
  9857. size_t id) const {
  9858. return detail::get_header_value(headers, key, def, id);
  9859. }
  9860. inline size_t Response::get_header_value_count(const std::string &key) const {
  9861. return detail::get_header_value_count(headers, key);
  9862. }
  9863. inline void Response::set_header(const std::string &key,
  9864. const std::string &val) {
  9865. detail::set_header(headers, key, val);
  9866. }
  9867. inline bool Response::has_trailer(const std::string &key) const {
  9868. return trailers.find(key) != trailers.end();
  9869. }
  9870. inline std::string Response::get_trailer_value(const std::string &key,
  9871. size_t id) const {
  9872. return detail::get_multimap_value(trailers, key, id);
  9873. }
  9874. inline size_t Response::get_trailer_value_count(const std::string &key) const {
  9875. return trailers.count(key);
  9876. }
  9877. inline void Response::set_redirect(const std::string &url, int stat) {
  9878. if (detail::fields::is_field_value(url)) {
  9879. set_header("Location", url);
  9880. if (300 <= stat && stat < 400) {
  9881. this->status = stat;
  9882. } else {
  9883. this->status = StatusCode::Found_302;
  9884. }
  9885. }
  9886. }
  9887. inline void Response::set_content(const char *s, size_t n,
  9888. const std::string &content_type) {
  9889. body.assign(s, n);
  9890. auto rng = headers.equal_range("Content-Type");
  9891. headers.erase(rng.first, rng.second);
  9892. set_header("Content-Type", content_type);
  9893. content_coding_ = detail::EncodingType::None;
  9894. }
  9895. inline void Response::set_content(const std::string &s,
  9896. const std::string &content_type) {
  9897. set_content(s.data(), s.size(), content_type);
  9898. }
  9899. inline void Response::set_content(std::string &&s,
  9900. const std::string &content_type) {
  9901. body = std::move(s);
  9902. auto rng = headers.equal_range("Content-Type");
  9903. headers.erase(rng.first, rng.second);
  9904. set_header("Content-Type", content_type);
  9905. content_coding_ = detail::EncodingType::None;
  9906. }
  9907. inline void Response::set_content_provider(
  9908. size_t in_length, const std::string &content_type, ContentProvider provider,
  9909. ContentProviderResourceReleaser resource_releaser) {
  9910. set_header("Content-Type", content_type);
  9911. content_length_ = in_length;
  9912. if (in_length > 0) { content_provider_ = std::move(provider); }
  9913. content_provider_resource_releaser_ = std::move(resource_releaser);
  9914. is_chunked_content_provider_ = false;
  9915. is_file_content_provider_ = false;
  9916. content_coding_ = detail::EncodingType::None;
  9917. }
  9918. inline void Response::set_content_provider(
  9919. const std::string &content_type, ContentProviderWithoutLength provider,
  9920. ContentProviderResourceReleaser resource_releaser) {
  9921. set_header("Content-Type", content_type);
  9922. content_length_ = 0;
  9923. content_provider_ = detail::ContentProviderAdapter(std::move(provider));
  9924. content_provider_resource_releaser_ = std::move(resource_releaser);
  9925. is_chunked_content_provider_ = false;
  9926. is_file_content_provider_ = false;
  9927. content_coding_ = detail::EncodingType::None;
  9928. }
  9929. inline void Response::set_chunked_content_provider(
  9930. const std::string &content_type, ContentProviderWithoutLength provider,
  9931. ContentProviderResourceReleaser resource_releaser) {
  9932. set_header("Content-Type", content_type);
  9933. content_length_ = 0;
  9934. content_provider_ = detail::ContentProviderAdapter(std::move(provider));
  9935. content_provider_resource_releaser_ = std::move(resource_releaser);
  9936. is_chunked_content_provider_ = true;
  9937. is_file_content_provider_ = false;
  9938. content_coding_ = detail::EncodingType::None;
  9939. }
  9940. inline void Response::set_file_content(const std::string &path,
  9941. const std::string &content_type) {
  9942. file_content_path_ = path;
  9943. file_content_content_type_ = content_type;
  9944. }
  9945. inline void Response::set_file_content(const std::string &path) {
  9946. file_content_path_ = path;
  9947. }
  9948. // Result implementation
  9949. inline size_t Result::get_request_header_value_u64(const std::string &key,
  9950. size_t def,
  9951. size_t id) const {
  9952. return detail::get_header_value_u64(request_headers_, key, def, id);
  9953. }
  9954. inline bool Result::has_request_header(const std::string &key) const {
  9955. return request_headers_.find(key) != request_headers_.end();
  9956. }
  9957. inline std::string Result::get_request_header_value(const std::string &key,
  9958. const char *def,
  9959. size_t id) const {
  9960. return detail::get_header_value(request_headers_, key, def, id);
  9961. }
  9962. inline size_t
  9963. Result::get_request_header_value_count(const std::string &key) const {
  9964. return request_headers_.count(key);
  9965. }
  9966. // Stream implementation
  9967. inline ssize_t Stream::write(const char *ptr) {
  9968. return write(ptr, strlen(ptr));
  9969. }
  9970. inline ssize_t Stream::write(const std::string &s) {
  9971. return write(s.data(), s.size());
  9972. }
  9973. // BodyReader implementation
  9974. inline ssize_t detail::BodyReader::read(char *buf, size_t len) {
  9975. if (!stream) {
  9976. last_error = Error::Connection;
  9977. return -1;
  9978. }
  9979. if (eof) { return 0; }
  9980. if (!chunked) {
  9981. // Content-Length based reading
  9982. if (has_content_length && bytes_read >= content_length) {
  9983. eof = true;
  9984. return 0;
  9985. }
  9986. auto to_read = len;
  9987. if (has_content_length) {
  9988. auto remaining = content_length - bytes_read;
  9989. to_read = (std::min)(len, remaining);
  9990. }
  9991. auto n = stream->read(buf, to_read);
  9992. if (n < 0) {
  9993. last_error = stream->get_error();
  9994. if (last_error == Error::Success) { last_error = Error::Read; }
  9995. eof = true;
  9996. return n;
  9997. }
  9998. if (n == 0) {
  9999. // Unexpected EOF before content_length
  10000. last_error = stream->get_error();
  10001. if (last_error == Error::Success) { last_error = Error::Read; }
  10002. eof = true;
  10003. return 0;
  10004. }
  10005. bytes_read += static_cast<size_t>(n);
  10006. if (has_content_length && bytes_read >= content_length) { eof = true; }
  10007. if (payload_max_length > 0 && bytes_read > payload_max_length) {
  10008. last_error = Error::ExceedMaxPayloadSize;
  10009. eof = true;
  10010. return -1;
  10011. }
  10012. return n;
  10013. }
  10014. // Chunked transfer encoding: delegate to shared decoder instance.
  10015. if (!chunked_decoder) { chunked_decoder.reset(new ChunkedDecoder(*stream)); }
  10016. size_t chunk_offset = 0;
  10017. size_t chunk_total = 0;
  10018. auto n = chunked_decoder->read_payload(buf, len, chunk_offset, chunk_total);
  10019. if (n < 0) {
  10020. last_error = stream->get_error();
  10021. if (last_error == Error::Success) { last_error = Error::Read; }
  10022. eof = true;
  10023. return n;
  10024. }
  10025. if (n == 0) {
  10026. // Final chunk observed. Leave trailer parsing to the caller (StreamHandle).
  10027. eof = true;
  10028. return 0;
  10029. }
  10030. bytes_read += static_cast<size_t>(n);
  10031. if (payload_max_length > 0 && bytes_read > payload_max_length) {
  10032. last_error = Error::ExceedMaxPayloadSize;
  10033. eof = true;
  10034. return -1;
  10035. }
  10036. return n;
  10037. }
  10038. // ThreadPool implementation
  10039. inline ThreadPool::ThreadPool(size_t n, size_t max_n, size_t mqr,
  10040. time_t idle_timeout_sec)
  10041. : base_thread_count_(n), max_queued_requests_(mqr),
  10042. idle_timeout_sec_(idle_timeout_sec), idle_thread_count_(0),
  10043. shutdown_(false) {
  10044. #ifndef CPPHTTPLIB_NO_EXCEPTIONS
  10045. if (max_n != 0 && max_n < n) {
  10046. std::string msg = "max_threads must be >= base_threads";
  10047. throw std::invalid_argument(msg);
  10048. }
  10049. #endif
  10050. max_thread_count_ = max_n == 0 ? n : max_n;
  10051. threads_.reserve(base_thread_count_);
  10052. #ifndef CPPHTTPLIB_NO_EXCEPTIONS
  10053. try {
  10054. #endif
  10055. for (size_t i = 0; i < base_thread_count_; i++) {
  10056. threads_.emplace_back(std::thread([this]() { worker(false); }));
  10057. }
  10058. #ifndef CPPHTTPLIB_NO_EXCEPTIONS
  10059. } catch (...) {
  10060. // If thread creation fails partway (e.g., pthread_create returns EAGAIN),
  10061. // signal the workers we already spawned to exit and join them so the
  10062. // vector destructor does not see joinable threads (which would call
  10063. // std::terminate). Then rethrow so the caller learns of the failure.
  10064. {
  10065. std::unique_lock<std::mutex> lock(mutex_);
  10066. shutdown_ = true;
  10067. }
  10068. cond_.notify_all();
  10069. for (auto &t : threads_) {
  10070. if (t.joinable()) { t.join(); }
  10071. }
  10072. throw;
  10073. }
  10074. #endif
  10075. }
  10076. inline bool ThreadPool::enqueue(std::function<void()> fn) {
  10077. {
  10078. std::unique_lock<std::mutex> lock(mutex_);
  10079. if (shutdown_) { return false; }
  10080. if (max_queued_requests_ > 0 && jobs_.size() >= max_queued_requests_) {
  10081. return false;
  10082. }
  10083. jobs_.push_back(std::move(fn));
  10084. // Spawn a dynamic thread if no idle threads and under max
  10085. if (idle_thread_count_ == 0 &&
  10086. threads_.size() + dynamic_threads_.size() < max_thread_count_) {
  10087. cleanup_finished_threads();
  10088. dynamic_threads_.emplace_back(std::thread([this]() { worker(true); }));
  10089. }
  10090. }
  10091. cond_.notify_one();
  10092. return true;
  10093. }
  10094. inline void ThreadPool::shutdown() {
  10095. {
  10096. std::unique_lock<std::mutex> lock(mutex_);
  10097. shutdown_ = true;
  10098. }
  10099. cond_.notify_all();
  10100. for (auto &t : threads_) {
  10101. if (t.joinable()) { t.join(); }
  10102. }
  10103. // Move dynamic_threads_ to a local list under the lock to avoid racing
  10104. // with worker threads that call move_to_finished() concurrently.
  10105. std::list<std::thread> remaining_dynamic;
  10106. {
  10107. std::unique_lock<std::mutex> lock(mutex_);
  10108. remaining_dynamic = std::move(dynamic_threads_);
  10109. }
  10110. for (auto &t : remaining_dynamic) {
  10111. if (t.joinable()) { t.join(); }
  10112. }
  10113. std::unique_lock<std::mutex> lock(mutex_);
  10114. cleanup_finished_threads();
  10115. }
  10116. inline void ThreadPool::move_to_finished(std::thread::id id) {
  10117. // Must be called with mutex_ held
  10118. for (auto it = dynamic_threads_.begin(); it != dynamic_threads_.end(); ++it) {
  10119. if (it->get_id() == id) {
  10120. finished_threads_.push_back(std::move(*it));
  10121. dynamic_threads_.erase(it);
  10122. return;
  10123. }
  10124. }
  10125. }
  10126. inline void ThreadPool::cleanup_finished_threads() {
  10127. // Must be called with mutex_ held
  10128. for (auto &t : finished_threads_) {
  10129. if (t.joinable()) { t.join(); }
  10130. }
  10131. finished_threads_.clear();
  10132. }
  10133. inline void ThreadPool::worker(bool is_dynamic) {
  10134. for (;;) {
  10135. std::function<void()> fn;
  10136. {
  10137. std::unique_lock<std::mutex> lock(mutex_);
  10138. idle_thread_count_++;
  10139. if (is_dynamic) {
  10140. auto has_work =
  10141. cond_.wait_for(lock, std::chrono::seconds(idle_timeout_sec_),
  10142. [&] { return !jobs_.empty() || shutdown_; });
  10143. if (!has_work) {
  10144. // Timed out with no work - exit this dynamic thread
  10145. idle_thread_count_--;
  10146. move_to_finished(std::this_thread::get_id());
  10147. break;
  10148. }
  10149. } else {
  10150. cond_.wait(lock, [&] { return !jobs_.empty() || shutdown_; });
  10151. }
  10152. idle_thread_count_--;
  10153. if (shutdown_ && jobs_.empty()) { break; }
  10154. fn = std::move(jobs_.front());
  10155. jobs_.pop_front();
  10156. }
  10157. assert(true == static_cast<bool>(fn));
  10158. fn();
  10159. }
  10160. #if defined(CPPHTTPLIB_OPENSSL_SUPPORT) && !defined(OPENSSL_IS_BORINGSSL) && \
  10161. !defined(LIBRESSL_VERSION_NUMBER)
  10162. OPENSSL_thread_stop();
  10163. #endif
  10164. }
  10165. /*
  10166. * Group 1 (continued): detail namespace - Stream implementations
  10167. */
  10168. namespace detail {
  10169. inline void calc_actual_timeout(time_t max_timeout_msec, time_t duration_msec,
  10170. time_t timeout_sec, time_t timeout_usec,
  10171. time_t &actual_timeout_sec,
  10172. time_t &actual_timeout_usec) {
  10173. auto timeout_msec = (timeout_sec * 1000) + (timeout_usec / 1000);
  10174. auto actual_timeout_msec =
  10175. (std::min)(max_timeout_msec - duration_msec, timeout_msec);
  10176. if (actual_timeout_msec < 0) { actual_timeout_msec = 0; }
  10177. actual_timeout_sec = actual_timeout_msec / 1000;
  10178. actual_timeout_usec = (actual_timeout_msec % 1000) * 1000;
  10179. }
  10180. // Socket stream implementation
  10181. inline SocketStream::SocketStream(
  10182. socket_t sock, time_t read_timeout_sec, time_t read_timeout_usec,
  10183. time_t write_timeout_sec, time_t write_timeout_usec,
  10184. time_t max_timeout_msec,
  10185. std::chrono::time_point<std::chrono::steady_clock> start_time)
  10186. : sock_(sock), read_timeout_sec_(read_timeout_sec),
  10187. read_timeout_usec_(read_timeout_usec),
  10188. write_timeout_sec_(write_timeout_sec),
  10189. write_timeout_usec_(write_timeout_usec),
  10190. max_timeout_msec_(max_timeout_msec), start_time_(start_time),
  10191. read_buff_(read_buff_size_, 0) {}
  10192. inline SocketStream::~SocketStream() = default;
  10193. inline bool SocketStream::is_readable() const {
  10194. return read_buff_off_ < read_buff_content_size_;
  10195. }
  10196. inline bool SocketStream::wait_readable() const {
  10197. if (max_timeout_msec_ <= 0) {
  10198. return select_read(sock_, read_timeout_sec_, read_timeout_usec_) > 0;
  10199. }
  10200. time_t read_timeout_sec;
  10201. time_t read_timeout_usec;
  10202. calc_actual_timeout(max_timeout_msec_, duration(), read_timeout_sec_,
  10203. read_timeout_usec_, read_timeout_sec, read_timeout_usec);
  10204. return select_read(sock_, read_timeout_sec, read_timeout_usec) > 0;
  10205. }
  10206. inline bool SocketStream::wait_writable() const {
  10207. return select_write(sock_, write_timeout_sec_, write_timeout_usec_) > 0;
  10208. }
  10209. inline bool SocketStream::ensure_readable() {
  10210. if (readable_hint_) {
  10211. readable_hint_ = false;
  10212. return true;
  10213. }
  10214. return wait_readable();
  10215. }
  10216. inline const char *SocketStream::buffered_data(size_t &size) const {
  10217. size = read_buff_content_size_ - read_buff_off_;
  10218. return size ? read_buff_.data() + read_buff_off_ : nullptr;
  10219. }
  10220. inline void SocketStream::consume_buffered(size_t size) {
  10221. assert(size <= read_buff_content_size_ - read_buff_off_);
  10222. read_buff_off_ += size;
  10223. }
  10224. inline bool SocketStream::is_peer_alive() const {
  10225. return detail::is_socket_alive(sock_);
  10226. }
  10227. inline ssize_t SocketStream::read(char *ptr, size_t size) {
  10228. #ifdef _WIN32
  10229. size =
  10230. (std::min)(size, static_cast<size_t>((std::numeric_limits<int>::max)()));
  10231. #else
  10232. size = (std::min)(size,
  10233. static_cast<size_t>((std::numeric_limits<ssize_t>::max)()));
  10234. #endif
  10235. if (read_buff_off_ < read_buff_content_size_) {
  10236. auto remaining_size = read_buff_content_size_ - read_buff_off_;
  10237. if (size <= remaining_size) {
  10238. memcpy(ptr, read_buff_.data() + read_buff_off_, size);
  10239. read_buff_off_ += size;
  10240. return static_cast<ssize_t>(size);
  10241. } else {
  10242. memcpy(ptr, read_buff_.data() + read_buff_off_, remaining_size);
  10243. read_buff_off_ += remaining_size;
  10244. return static_cast<ssize_t>(remaining_size);
  10245. }
  10246. }
  10247. if (!ensure_readable()) {
  10248. error_ = Error::Timeout;
  10249. return -1;
  10250. }
  10251. read_buff_off_ = 0;
  10252. read_buff_content_size_ = 0;
  10253. if (size < read_buff_size_) {
  10254. auto n = read_socket(sock_, read_buff_.data(), read_buff_size_,
  10255. CPPHTTPLIB_RECV_FLAGS);
  10256. if (n <= 0) {
  10257. if (n == 0) {
  10258. error_ = Error::ConnectionClosed;
  10259. } else {
  10260. error_ = Error::Read;
  10261. }
  10262. return n;
  10263. } else if (n <= static_cast<ssize_t>(size)) {
  10264. memcpy(ptr, read_buff_.data(), static_cast<size_t>(n));
  10265. return n;
  10266. } else {
  10267. memcpy(ptr, read_buff_.data(), size);
  10268. read_buff_off_ = size;
  10269. read_buff_content_size_ = static_cast<size_t>(n);
  10270. return static_cast<ssize_t>(size);
  10271. }
  10272. } else {
  10273. auto n = read_socket(sock_, ptr, size, CPPHTTPLIB_RECV_FLAGS);
  10274. if (n <= 0) {
  10275. if (n == 0) {
  10276. error_ = Error::ConnectionClosed;
  10277. } else {
  10278. error_ = Error::Read;
  10279. }
  10280. }
  10281. return n;
  10282. }
  10283. }
  10284. inline ssize_t SocketStream::write(const char *ptr, size_t size) {
  10285. if (!wait_writable()) { return -1; }
  10286. #if defined(_WIN32) && !defined(_WIN64)
  10287. size =
  10288. (std::min)(size, static_cast<size_t>((std::numeric_limits<int>::max)()));
  10289. #endif
  10290. return send_socket(sock_, ptr, size, CPPHTTPLIB_SEND_FLAGS);
  10291. }
  10292. inline void SocketStream::get_remote_ip_and_port(std::string &ip,
  10293. int &port) const {
  10294. return detail::get_remote_ip_and_port(sock_, ip, port);
  10295. }
  10296. inline void SocketStream::get_local_ip_and_port(std::string &ip,
  10297. int &port) const {
  10298. return detail::get_local_ip_and_port(sock_, ip, port);
  10299. }
  10300. inline socket_t SocketStream::socket() const { return sock_; }
  10301. inline time_t SocketStream::duration() const {
  10302. return std::chrono::duration_cast<std::chrono::milliseconds>(
  10303. std::chrono::steady_clock::now() - start_time_)
  10304. .count();
  10305. }
  10306. inline void SocketStream::set_read_timeout(time_t sec, time_t usec) {
  10307. read_timeout_sec_ = sec;
  10308. read_timeout_usec_ = usec;
  10309. }
  10310. // Buffer stream implementation
  10311. inline bool BufferStream::is_readable() const { return true; }
  10312. inline bool BufferStream::wait_readable() const { return true; }
  10313. inline bool BufferStream::wait_writable() const { return true; }
  10314. inline ssize_t BufferStream::read(char *ptr, size_t size) {
  10315. #if defined(_MSC_VER) && _MSC_VER < 1910
  10316. auto len_read = buffer._Copy_s(ptr, size, size, position);
  10317. #else
  10318. auto len_read = buffer.copy(ptr, size, position);
  10319. #endif
  10320. position += static_cast<size_t>(len_read);
  10321. return static_cast<ssize_t>(len_read);
  10322. }
  10323. inline ssize_t BufferStream::write(const char *ptr, size_t size) {
  10324. buffer.append(ptr, size);
  10325. return static_cast<ssize_t>(size);
  10326. }
  10327. inline void BufferStream::get_remote_ip_and_port(std::string & /*ip*/,
  10328. int & /*port*/) const {}
  10329. inline void BufferStream::get_local_ip_and_port(std::string & /*ip*/,
  10330. int & /*port*/) const {}
  10331. inline socket_t BufferStream::socket() const { return 0; }
  10332. inline time_t BufferStream::duration() const { return 0; }
  10333. inline const std::string &BufferStream::get_buffer() const { return buffer; }
  10334. inline PathParamsMatcher::PathParamsMatcher(const std::string &pattern)
  10335. : MatcherBase(pattern) {
  10336. constexpr const char marker[] = "/:";
  10337. // One past the last ending position of a path param substring
  10338. std::size_t last_param_end = 0;
  10339. #ifndef CPPHTTPLIB_NO_EXCEPTIONS
  10340. // Needed to ensure that parameter names are unique during matcher
  10341. // construction
  10342. // If exceptions are disabled, only last duplicate path
  10343. // parameter will be set
  10344. std::unordered_set<std::string> param_name_set;
  10345. #endif
  10346. while (true) {
  10347. const auto marker_pos = pattern.find(
  10348. marker, last_param_end == 0 ? last_param_end : last_param_end - 1);
  10349. if (marker_pos == std::string::npos) { break; }
  10350. static_fragments_.push_back(
  10351. pattern.substr(last_param_end, marker_pos - last_param_end + 1));
  10352. const auto param_name_start = marker_pos + str_len(marker);
  10353. auto sep_pos = pattern.find(separator, param_name_start);
  10354. if (sep_pos == std::string::npos) { sep_pos = pattern.length(); }
  10355. auto param_name =
  10356. pattern.substr(param_name_start, sep_pos - param_name_start);
  10357. #ifndef CPPHTTPLIB_NO_EXCEPTIONS
  10358. if (param_name_set.find(param_name) != param_name_set.cend()) {
  10359. std::string msg = "Encountered path parameter '" + param_name +
  10360. "' multiple times in route pattern '" + pattern + "'.";
  10361. throw std::invalid_argument(msg);
  10362. }
  10363. #endif
  10364. param_names_.push_back(std::move(param_name));
  10365. last_param_end = sep_pos + 1;
  10366. }
  10367. if (last_param_end < pattern.length()) {
  10368. static_fragments_.push_back(pattern.substr(last_param_end));
  10369. }
  10370. }
  10371. inline bool PathParamsMatcher::match(Request &request) const {
  10372. request.matches = std::smatch();
  10373. request.path_params.clear();
  10374. // A pattern without parameters is just a literal path to compare against
  10375. if (param_names_.empty()) { return request.path == pattern(); }
  10376. request.path_params.reserve(param_names_.size());
  10377. // One past the position at which the path matched the pattern last time
  10378. std::size_t starting_pos = 0;
  10379. for (size_t i = 0; i < static_fragments_.size(); ++i) {
  10380. const auto &fragment = static_fragments_[i];
  10381. if (starting_pos + fragment.length() > request.path.length()) {
  10382. return false;
  10383. }
  10384. // Avoid unnecessary allocation by using strncmp instead of substr +
  10385. // comparison
  10386. if (std::strncmp(request.path.c_str() + starting_pos, fragment.c_str(),
  10387. fragment.length()) != 0) {
  10388. return false;
  10389. }
  10390. starting_pos += fragment.length();
  10391. // Should only happen when we have a static fragment after a param
  10392. // Example: '/users/:id/subscriptions'
  10393. // The 'subscriptions' fragment here does not have a corresponding param
  10394. if (i >= param_names_.size()) { continue; }
  10395. auto sep_pos = request.path.find(separator, starting_pos);
  10396. if (sep_pos == std::string::npos) { sep_pos = request.path.length(); }
  10397. const auto &param_name = param_names_[i];
  10398. request.path_params.emplace(
  10399. param_name, request.path.substr(starting_pos, sep_pos - starting_pos));
  10400. // Mark everything up to '/' as matched
  10401. starting_pos = sep_pos + 1;
  10402. }
  10403. // Returns false if the path is longer than the pattern
  10404. return starting_pos >= request.path.length();
  10405. }
  10406. inline bool RegexMatcher::match(Request &request) const {
  10407. request.path_params.clear();
  10408. // See CPPHTTPLIB_REGEX_ROUTE_PATH_MAX_LENGTH: an overlong path is treated as
  10409. // a non-match rather than risking a stack overflow in std::regex_match.
  10410. if (request.path.length() > CPPHTTPLIB_REGEX_ROUTE_PATH_MAX_LENGTH) {
  10411. return false;
  10412. }
  10413. return std::regex_match(request.path, request.matches, regex_);
  10414. }
  10415. // Enclose IPv6 address in brackets if needed
  10416. inline std::string prepare_host_string(const std::string &host) {
  10417. // Enclose IPv6 address in brackets (but not if already enclosed)
  10418. if (host.find(':') == std::string::npos ||
  10419. (!host.empty() && host[0] == '[')) {
  10420. // IPv4, hostname, or already bracketed IPv6
  10421. return host;
  10422. } else {
  10423. // IPv6 address without brackets
  10424. return "[" + host + "]";
  10425. }
  10426. }
  10427. inline std::string make_host_and_port_string(const std::string &host, int port,
  10428. bool is_ssl) {
  10429. auto result = prepare_host_string(host);
  10430. // Append port if not default
  10431. if ((!is_ssl && port == 80) || (is_ssl && port == 443)) {
  10432. ; // do nothing
  10433. } else {
  10434. result += ":" + std::to_string(port);
  10435. }
  10436. return result;
  10437. }
  10438. // Create "host:port" string always including port number (for CONNECT method)
  10439. inline std::string
  10440. make_host_and_port_string_always_port(const std::string &host, int port) {
  10441. return prepare_host_string(host) + ":" + std::to_string(port);
  10442. }
  10443. // Value for the Host header a client sends when the caller supplied none.
  10444. // Only the value: callers decide where in their header list it goes.
  10445. inline std::string make_default_host_header_value(const std::string &host,
  10446. int port, bool is_ssl,
  10447. int address_family) {
  10448. if (address_family == AF_UNIX) { return "localhost"; }
  10449. return make_host_and_port_string(host, port, is_ssl);
  10450. }
  10451. inline void add_default_user_agent_header(Request &req) {
  10452. #ifndef CPPHTTPLIB_NO_DEFAULT_USER_AGENT
  10453. if (!req.has_header("User-Agent")) {
  10454. req.set_header("User-Agent",
  10455. std::string("cpp-httplib/") + CPPHTTPLIB_VERSION);
  10456. }
  10457. #else
  10458. (void)req;
  10459. #endif
  10460. }
  10461. bool parse_no_proxy_entry(const std::string &token, NoProxyEntry &out);
  10462. NormalizedTarget normalize_target(const std::string &host);
  10463. bool ip_in_cidr(const IPBytes &ip, const IPBytes &net, int prefix_bits);
  10464. bool host_matches_no_proxy(const NormalizedTarget &target,
  10465. const std::vector<NoProxyEntry> &entries);
  10466. inline bool ip_in_cidr(const IPBytes &ip, const IPBytes &net, int prefix_bits) {
  10467. if (prefix_bits < 0 || prefix_bits > 128) { return false; }
  10468. if (prefix_bits == 0) { return true; }
  10469. int full_bytes = prefix_bits / 8;
  10470. int rem_bits = prefix_bits % 8;
  10471. if (full_bytes > 0 && std::memcmp(ip.data(), net.data(),
  10472. static_cast<size_t>(full_bytes)) != 0) {
  10473. return false;
  10474. }
  10475. if (rem_bits == 0) { return true; }
  10476. auto i = static_cast<size_t>(full_bytes);
  10477. auto mask = static_cast<uint8_t>(0xFFu << (8 - rem_bits));
  10478. return (ip[i] & mask) == (net[i] & mask);
  10479. }
  10480. inline bool parse_no_proxy_entry(const std::string &token, NoProxyEntry &out) {
  10481. if (token.empty()) { return false; }
  10482. if (token == "*") {
  10483. out.kind = NoProxyKind::Wildcard;
  10484. return true;
  10485. }
  10486. auto slash = token.find('/');
  10487. std::string addr_part =
  10488. (slash == std::string::npos) ? token : token.substr(0, slash);
  10489. std::string prefix_part =
  10490. (slash == std::string::npos) ? std::string() : token.substr(slash + 1);
  10491. // A bare slash or trailing-slash CIDR like "10.0.0.0/" is malformed;
  10492. // don't silently treat it as a /32 (or /128).
  10493. if (slash != std::string::npos && prefix_part.empty()) { return false; }
  10494. // Accept the bracketed IPv6 form ("[::1]", "[fe80::]/10") as well as the
  10495. // bare form. Brackets have no meaning for IPv4, so skip the IPv4 attempt
  10496. // when brackets are present.
  10497. bool bracketed = addr_part.size() >= 2 && addr_part.front() == '[' &&
  10498. addr_part.back() == ']';
  10499. if (bracketed) { addr_part = addr_part.substr(1, addr_part.size() - 2); }
  10500. if (!bracketed) {
  10501. struct in_addr v4;
  10502. if (inet_pton(AF_INET, addr_part.c_str(), &v4) == 1) {
  10503. int prefix = 32;
  10504. if (!prefix_part.empty()) {
  10505. auto r = from_chars(prefix_part.data(),
  10506. prefix_part.data() + prefix_part.size(), prefix);
  10507. if (r.ec != std::errc{} ||
  10508. r.ptr != prefix_part.data() + prefix_part.size()) {
  10509. return false;
  10510. }
  10511. if (prefix < 0 || prefix > 32) { return false; }
  10512. }
  10513. out.kind = NoProxyKind::IPv4Cidr;
  10514. std::memcpy(out.net.data(), &v4, sizeof(v4));
  10515. out.prefix_bits = prefix;
  10516. return true;
  10517. }
  10518. }
  10519. struct in6_addr v6;
  10520. if (inet_pton(AF_INET6, addr_part.c_str(), &v6) == 1) {
  10521. int prefix = 128;
  10522. if (!prefix_part.empty()) {
  10523. auto r = from_chars(prefix_part.data(),
  10524. prefix_part.data() + prefix_part.size(), prefix);
  10525. if (r.ec != std::errc{} ||
  10526. r.ptr != prefix_part.data() + prefix_part.size()) {
  10527. return false;
  10528. }
  10529. if (prefix < 0 || prefix > 128) { return false; }
  10530. }
  10531. out.kind = NoProxyKind::IPv6Cidr;
  10532. std::memcpy(out.net.data(), &v6, sizeof(v6));
  10533. out.prefix_bits = prefix;
  10534. return true;
  10535. }
  10536. // Bracketed entries can only be IPv6. If the IPv6 parse above failed,
  10537. // the entry is malformed — don't fall through to the hostname branch.
  10538. if (bracketed) { return false; }
  10539. // A '/' on a non-IP token means a CIDR prefix without an address. Reject.
  10540. if (slash != std::string::npos) { return false; }
  10541. // Port-specific entries (host:port) are not supported.
  10542. if (token.find(':') != std::string::npos) { return false; }
  10543. std::string hostname = case_ignore::to_lower(token);
  10544. while (!hostname.empty() && hostname.front() == '.') {
  10545. hostname.erase(hostname.begin());
  10546. }
  10547. while (!hostname.empty() && hostname.back() == '.') {
  10548. hostname.pop_back();
  10549. }
  10550. if (hostname.empty()) { return false; }
  10551. out.kind = NoProxyKind::HostnameSuffix;
  10552. out.hostname_pattern = std::move(hostname);
  10553. return true;
  10554. }
  10555. inline NormalizedTarget normalize_target(const std::string &host) {
  10556. NormalizedTarget t;
  10557. std::string h = host;
  10558. if (h.size() >= 2 && h.front() == '[' && h.back() == ']') {
  10559. h = h.substr(1, h.size() - 2);
  10560. }
  10561. // Strip a single trailing dot so "example.com." canonicalizes to
  10562. // "example.com".
  10563. if (!h.empty() && h.back() == '.') { h.pop_back(); }
  10564. t.hostname = case_ignore::to_lower(h);
  10565. if (!t.hostname.empty()) {
  10566. struct in_addr v4;
  10567. struct in6_addr v6;
  10568. if (inet_pton(AF_INET, t.hostname.c_str(), &v4) == 1) {
  10569. t.is_ipv4 = true;
  10570. std::memcpy(t.ip.data(), &v4, sizeof(v4));
  10571. } else if (inet_pton(AF_INET6, t.hostname.c_str(), &v6) == 1) {
  10572. t.is_ipv6 = true;
  10573. std::memcpy(t.ip.data(), &v6, sizeof(v6));
  10574. }
  10575. }
  10576. return t;
  10577. }
  10578. inline bool host_matches_no_proxy(const NormalizedTarget &target,
  10579. const std::vector<NoProxyEntry> &entries) {
  10580. if (target.hostname.empty()) { return false; }
  10581. for (const auto &e : entries) {
  10582. switch (e.kind) {
  10583. case NoProxyKind::Wildcard: return true;
  10584. case NoProxyKind::IPv4Cidr:
  10585. if (target.is_ipv4 && ip_in_cidr(target.ip, e.net, e.prefix_bits)) {
  10586. return true;
  10587. }
  10588. break;
  10589. case NoProxyKind::IPv6Cidr:
  10590. if (target.is_ipv6 && ip_in_cidr(target.ip, e.net, e.prefix_bits)) {
  10591. return true;
  10592. }
  10593. break;
  10594. case NoProxyKind::HostnameSuffix:
  10595. if (target.is_ipv4 || target.is_ipv6) { break; }
  10596. if (target.hostname == e.hostname_pattern) { return true; }
  10597. // Dot-boundary suffix match: prevents "evilexample.com" from matching
  10598. // an entry of "example.com".
  10599. if (target.hostname.size() > e.hostname_pattern.size() + 1) {
  10600. auto offset = target.hostname.size() - e.hostname_pattern.size();
  10601. if (target.hostname[offset - 1] == '.' &&
  10602. target.hostname.compare(offset, e.hostname_pattern.size(),
  10603. e.hostname_pattern) == 0) {
  10604. return true;
  10605. }
  10606. }
  10607. break;
  10608. }
  10609. }
  10610. return false;
  10611. }
  10612. template <typename T>
  10613. inline bool check_and_write_headers(Stream &strm, Headers &headers,
  10614. T header_writer, Error &error) {
  10615. for (const auto &h : headers) {
  10616. if (!detail::fields::is_field_valid(h.first, h.second)) {
  10617. error = Error::InvalidHeaders;
  10618. return false;
  10619. }
  10620. }
  10621. if (header_writer(strm, headers) <= 0) {
  10622. error = Error::Write;
  10623. return false;
  10624. }
  10625. return true;
  10626. }
  10627. } // namespace detail
  10628. /*
  10629. * Group 2 (continued): detail namespace - SSLSocketStream implementation
  10630. */
  10631. #ifdef CPPHTTPLIB_SSL_ENABLED
  10632. namespace detail {
  10633. // SSL socket stream implementation
  10634. inline SSLSocketStream::SSLSocketStream(
  10635. socket_t sock, tls::session_t session, time_t read_timeout_sec,
  10636. time_t read_timeout_usec, time_t write_timeout_sec,
  10637. time_t write_timeout_usec, time_t max_timeout_msec,
  10638. std::chrono::time_point<std::chrono::steady_clock> start_time)
  10639. : sock_(sock), session_(session), read_timeout_sec_(read_timeout_sec),
  10640. read_timeout_usec_(read_timeout_usec),
  10641. write_timeout_sec_(write_timeout_sec),
  10642. write_timeout_usec_(write_timeout_usec),
  10643. max_timeout_msec_(max_timeout_msec), start_time_(start_time) {
  10644. #ifdef CPPHTTPLIB_OPENSSL_SUPPORT
  10645. // Clear AUTO_RETRY for proper non-blocking I/O timeout handling
  10646. // Note: create_session() also clears this, but SSLClient currently
  10647. // uses ssl_new() which does not. Until full TLS API migration is complete,
  10648. // we need to ensure AUTO_RETRY is cleared here regardless of how the
  10649. // SSL session was created.
  10650. SSL_clear_mode(static_cast<SSL *>(session), SSL_MODE_AUTO_RETRY);
  10651. #endif
  10652. }
  10653. inline SSLSocketStream::~SSLSocketStream() = default;
  10654. inline bool SSLSocketStream::is_readable() const {
  10655. return tls::pending(session_) > 0;
  10656. }
  10657. inline bool SSLSocketStream::wait_readable() const {
  10658. if (max_timeout_msec_ <= 0) {
  10659. return select_read(sock_, read_timeout_sec_, read_timeout_usec_) > 0;
  10660. }
  10661. time_t read_timeout_sec;
  10662. time_t read_timeout_usec;
  10663. calc_actual_timeout(max_timeout_msec_, duration(), read_timeout_sec_,
  10664. read_timeout_usec_, read_timeout_sec, read_timeout_usec);
  10665. return select_read(sock_, read_timeout_sec, read_timeout_usec) > 0;
  10666. }
  10667. inline bool SSLSocketStream::wait_writable() const {
  10668. return select_write(sock_, write_timeout_sec_, write_timeout_usec_) > 0 &&
  10669. !tls::is_peer_closed(session_, sock_);
  10670. }
  10671. inline bool SSLSocketStream::ensure_readable() {
  10672. if (readable_hint_) {
  10673. readable_hint_ = false;
  10674. return true;
  10675. }
  10676. return wait_readable();
  10677. }
  10678. inline bool SSLSocketStream::is_peer_alive() const {
  10679. return !tls::is_peer_closed(session_, sock_);
  10680. }
  10681. inline ssize_t SSLSocketStream::read(char *ptr, size_t size) {
  10682. if (tls::pending(session_) > 0) {
  10683. tls::TlsError err;
  10684. auto ret = tls::read(session_, ptr, size, err);
  10685. if (ret == 0 || err.code == tls::ErrorCode::PeerClosed) {
  10686. error_ = Error::ConnectionClosed;
  10687. }
  10688. return ret;
  10689. } else if (ensure_readable()) {
  10690. tls::TlsError err;
  10691. auto ret = tls::read(session_, ptr, size, err);
  10692. if (ret < 0) {
  10693. auto n = 1000;
  10694. #ifdef _WIN32
  10695. while (--n >= 0 && (err.code == tls::ErrorCode::WantRead ||
  10696. (err.code == tls::ErrorCode::SyscallError &&
  10697. WSAGetLastError() == WSAETIMEDOUT))) {
  10698. #else
  10699. while (--n >= 0 && err.code == tls::ErrorCode::WantRead) {
  10700. #endif
  10701. if (tls::pending(session_) > 0) {
  10702. return tls::read(session_, ptr, size, err);
  10703. } else if (wait_readable()) {
  10704. std::this_thread::sleep_for(std::chrono::microseconds{10});
  10705. ret = tls::read(session_, ptr, size, err);
  10706. if (ret >= 0) { return ret; }
  10707. } else {
  10708. break;
  10709. }
  10710. }
  10711. assert(ret < 0);
  10712. } else if (ret == 0 || err.code == tls::ErrorCode::PeerClosed) {
  10713. error_ = Error::ConnectionClosed;
  10714. }
  10715. return ret;
  10716. } else {
  10717. error_ = Error::Timeout;
  10718. return -1;
  10719. }
  10720. }
  10721. inline ssize_t SSLSocketStream::write(const char *ptr, size_t size) {
  10722. if (wait_writable()) {
  10723. auto handle_size =
  10724. std::min<size_t>(size, (std::numeric_limits<int>::max)());
  10725. tls::TlsError err;
  10726. auto ret = tls::write(session_, ptr, handle_size, err);
  10727. if (ret < 0) {
  10728. auto n = 1000;
  10729. #ifdef _WIN32
  10730. while (--n >= 0 && (err.code == tls::ErrorCode::WantWrite ||
  10731. (err.code == tls::ErrorCode::SyscallError &&
  10732. WSAGetLastError() == WSAETIMEDOUT))) {
  10733. #else
  10734. while (--n >= 0 && err.code == tls::ErrorCode::WantWrite) {
  10735. #endif
  10736. if (wait_writable()) {
  10737. std::this_thread::sleep_for(std::chrono::microseconds{10});
  10738. ret = tls::write(session_, ptr, handle_size, err);
  10739. if (ret >= 0) { return ret; }
  10740. } else {
  10741. break;
  10742. }
  10743. }
  10744. assert(ret < 0);
  10745. }
  10746. return ret;
  10747. }
  10748. return -1;
  10749. }
  10750. inline void SSLSocketStream::get_remote_ip_and_port(std::string &ip,
  10751. int &port) const {
  10752. detail::get_remote_ip_and_port(sock_, ip, port);
  10753. }
  10754. inline void SSLSocketStream::get_local_ip_and_port(std::string &ip,
  10755. int &port) const {
  10756. detail::get_local_ip_and_port(sock_, ip, port);
  10757. }
  10758. inline socket_t SSLSocketStream::socket() const { return sock_; }
  10759. inline time_t SSLSocketStream::duration() const {
  10760. return std::chrono::duration_cast<std::chrono::milliseconds>(
  10761. std::chrono::steady_clock::now() - start_time_)
  10762. .count();
  10763. }
  10764. inline void SSLSocketStream::set_read_timeout(time_t sec, time_t usec) {
  10765. read_timeout_sec_ = sec;
  10766. read_timeout_usec_ = usec;
  10767. }
  10768. inline WebSocketSSLStream::WebSocketSSLStream(socket_t sock,
  10769. tls::session_t session,
  10770. time_t read_timeout_sec,
  10771. time_t read_timeout_usec,
  10772. time_t write_timeout_sec,
  10773. time_t write_timeout_usec)
  10774. : sock_(sock), session_(session), read_timeout_sec_(read_timeout_sec),
  10775. read_timeout_usec_(read_timeout_usec),
  10776. write_timeout_sec_(write_timeout_sec),
  10777. write_timeout_usec_(write_timeout_usec),
  10778. start_time_(std::chrono::steady_clock::now()) {
  10779. // The receive and send paths run on different threads, so each TLS call is
  10780. // driven in non-blocking mode and readiness is awaited with select()
  10781. // outside the session lock. Set the socket non-blocking once here; it is
  10782. // never flipped back, so no thread races on the flag.
  10783. detail::set_nonblocking(sock_, true);
  10784. #ifdef CPPHTTPLIB_OPENSSL_SUPPORT
  10785. SSL_clear_mode(static_cast<SSL *>(session_), SSL_MODE_AUTO_RETRY);
  10786. #endif
  10787. }
  10788. inline WebSocketSSLStream::~WebSocketSSLStream() = default;
  10789. inline bool WebSocketSSLStream::is_readable() const {
  10790. std::lock_guard<std::mutex> guard(session_mutex_);
  10791. return tls::pending(session_) > 0;
  10792. }
  10793. inline bool WebSocketSSLStream::wait_readable() const {
  10794. return select_read(sock_, read_timeout_sec_, read_timeout_usec_) > 0;
  10795. }
  10796. inline bool WebSocketSSLStream::wait_writable() const {
  10797. // Unlike SSLSocketStream, this deliberately does not call is_peer_closed():
  10798. // that probe toggles the socket's blocking flag, which would race with the
  10799. // concurrent reader on a permanently non-blocking socket.
  10800. return select_write(sock_, write_timeout_sec_, write_timeout_usec_) > 0;
  10801. }
  10802. inline ssize_t WebSocketSSLStream::read(char *ptr, size_t size) {
  10803. tls::TlsError err;
  10804. auto n = 1000;
  10805. while (--n >= 0) {
  10806. {
  10807. std::lock_guard<std::mutex> guard(session_mutex_);
  10808. auto ret = tls::read(session_, ptr, size, err);
  10809. if (ret > 0) { return ret; }
  10810. if (ret == 0 || err.code == tls::ErrorCode::PeerClosed) {
  10811. error_ = Error::ConnectionClosed;
  10812. return ret;
  10813. }
  10814. }
  10815. // ret < 0. On a non-blocking socket a TLS read can stop needing either
  10816. // direction: the send path shares this session, so output it left pending
  10817. // has to be flushed before more input can be decrypted. Anything else is
  10818. // a hard error.
  10819. auto needs_readable = err.code == tls::ErrorCode::WantRead;
  10820. #ifdef _WIN32
  10821. // On Windows a socket timeout surfaces as a syscall error, not WantRead.
  10822. needs_readable =
  10823. needs_readable || (err.code == tls::ErrorCode::SyscallError &&
  10824. WSAGetLastError() == WSAETIMEDOUT);
  10825. #endif
  10826. if (!needs_readable && err.code != tls::ErrorCode::WantWrite) {
  10827. error_ = Error::Read;
  10828. return -1;
  10829. }
  10830. if (!(needs_readable ? wait_readable() : wait_writable())) {
  10831. error_ = Error::Timeout;
  10832. return -1;
  10833. }
  10834. }
  10835. // Out of retries. Recording a reason matters: a caller that reads get_error()
  10836. // to tell a timeout from a close would otherwise see whatever the previous
  10837. // failure left behind (error_ is never cleared on success).
  10838. error_ = Error::Read;
  10839. return -1;
  10840. }
  10841. inline ssize_t WebSocketSSLStream::write(const char *ptr, size_t size) {
  10842. auto handle_size = std::min<size_t>(size, (std::numeric_limits<int>::max)());
  10843. tls::TlsError err;
  10844. auto n = 1000;
  10845. while (--n >= 0) {
  10846. {
  10847. std::lock_guard<std::mutex> guard(session_mutex_);
  10848. auto ret = tls::write(session_, ptr, handle_size, err);
  10849. if (ret >= 0) { return ret; }
  10850. }
  10851. // ret < 0. As in read(), either direction can be needed: a renegotiation
  10852. // or a post-handshake message must be consumed before the record goes
  10853. // out. Anything else is a hard error.
  10854. auto needs_writable = err.code == tls::ErrorCode::WantWrite;
  10855. #ifdef _WIN32
  10856. // On Windows a socket timeout surfaces as a syscall error, not WantWrite.
  10857. needs_writable =
  10858. needs_writable || (err.code == tls::ErrorCode::SyscallError &&
  10859. WSAGetLastError() == WSAETIMEDOUT);
  10860. #endif
  10861. if (!needs_writable && err.code != tls::ErrorCode::WantRead) { return -1; }
  10862. if (!(needs_writable ? wait_writable() : wait_readable())) { return -1; }
  10863. }
  10864. return -1;
  10865. }
  10866. inline void WebSocketSSLStream::get_remote_ip_and_port(std::string &ip,
  10867. int &port) const {
  10868. detail::get_remote_ip_and_port(sock_, ip, port);
  10869. }
  10870. inline void WebSocketSSLStream::get_local_ip_and_port(std::string &ip,
  10871. int &port) const {
  10872. detail::get_local_ip_and_port(sock_, ip, port);
  10873. }
  10874. inline socket_t WebSocketSSLStream::socket() const { return sock_; }
  10875. inline time_t WebSocketSSLStream::duration() const {
  10876. return std::chrono::duration_cast<std::chrono::milliseconds>(
  10877. std::chrono::steady_clock::now() - start_time_)
  10878. .count();
  10879. }
  10880. inline void WebSocketSSLStream::set_read_timeout(time_t sec, time_t usec) {
  10881. read_timeout_sec_ = sec;
  10882. read_timeout_usec_ = usec;
  10883. }
  10884. } // namespace detail
  10885. #endif // CPPHTTPLIB_SSL_ENABLED
  10886. /*
  10887. * Group 4: Server implementation
  10888. */
  10889. // HTTP server implementation
  10890. inline Server::Server()
  10891. : new_task_queue([] {
  10892. return new ThreadPool(CPPHTTPLIB_THREAD_POOL_COUNT,
  10893. CPPHTTPLIB_THREAD_POOL_MAX_COUNT);
  10894. }) {
  10895. #ifndef _WIN32
  10896. signal(SIGPIPE, SIG_IGN);
  10897. #endif
  10898. }
  10899. inline Server::~Server() = default;
  10900. inline std::unique_ptr<detail::MatcherBase>
  10901. Server::make_matcher(const std::string &pattern) {
  10902. // Path params take precedence, so "/users/:id/(.*)" keeps being matched as
  10903. // a path params pattern
  10904. if (pattern.find("/:") != std::string::npos) {
  10905. return detail::make_unique<detail::PathParamsMatcher>(pattern);
  10906. }
  10907. // A pattern with no regex metacharacter only has to be compared literally,
  10908. // which is what PathParamsMatcher already does when it captures no
  10909. // parameter, so std::regex is only worth building for the patterns that
  10910. // actually need it
  10911. if (pattern.find_first_of(".^$|()[]{}*+?\\") == std::string::npos) {
  10912. return detail::make_unique<detail::PathParamsMatcher>(pattern);
  10913. }
  10914. return detail::make_unique<detail::RegexMatcher>(pattern);
  10915. }
  10916. inline Server &Server::Get(const std::string &pattern, Handler handler) {
  10917. return add_handler(get_handlers_, pattern, std::move(handler));
  10918. }
  10919. inline Server &Server::Post(const std::string &pattern, Handler handler) {
  10920. return add_handler(post_handlers_, pattern, std::move(handler));
  10921. }
  10922. inline Server &Server::Post(const std::string &pattern,
  10923. HandlerWithContentReader handler) {
  10924. return add_handler(post_handlers_for_content_reader_, pattern,
  10925. std::move(handler));
  10926. }
  10927. inline Server &Server::Put(const std::string &pattern, Handler handler) {
  10928. return add_handler(put_handlers_, pattern, std::move(handler));
  10929. }
  10930. inline Server &Server::Put(const std::string &pattern,
  10931. HandlerWithContentReader handler) {
  10932. return add_handler(put_handlers_for_content_reader_, pattern,
  10933. std::move(handler));
  10934. }
  10935. inline Server &Server::Patch(const std::string &pattern, Handler handler) {
  10936. return add_handler(patch_handlers_, pattern, std::move(handler));
  10937. }
  10938. inline Server &Server::Patch(const std::string &pattern,
  10939. HandlerWithContentReader handler) {
  10940. return add_handler(patch_handlers_for_content_reader_, pattern,
  10941. std::move(handler));
  10942. }
  10943. inline Server &Server::Delete(const std::string &pattern, Handler handler) {
  10944. return add_handler(delete_handlers_, pattern, std::move(handler));
  10945. }
  10946. inline Server &Server::Delete(const std::string &pattern,
  10947. HandlerWithContentReader handler) {
  10948. return add_handler(delete_handlers_for_content_reader_, pattern,
  10949. std::move(handler));
  10950. }
  10951. inline Server &Server::Options(const std::string &pattern, Handler handler) {
  10952. return add_handler(options_handlers_, pattern, std::move(handler));
  10953. }
  10954. inline const std::set<std::string> &Server::builtin_methods() {
  10955. thread_local const std::set<std::string> methods{
  10956. "GET", "HEAD", "POST", "PUT", "DELETE",
  10957. "CONNECT", "OPTIONS", "TRACE", "PATCH", "PRI"};
  10958. return methods;
  10959. }
  10960. inline Server::CustomHandlerEntry *
  10961. Server::custom_entry_for_registration(const std::string &method) {
  10962. // Built-in methods are refused for two different reasons. GET, HEAD, POST,
  10963. // PUT, DELETE, OPTIONS and PATCH are dispatched by the if/else chain in
  10964. // routing() before the custom tables are consulted, so a route registered
  10965. // for one of them could never fire. CONNECT, TRACE and PRI have no branch
  10966. // there and would be reachable, but they carry protocol-level meaning
  10967. // (tunnel setup, request echo, the HTTP/2 connection preface) that this
  10968. // library does not route.
  10969. if (!detail::fields::is_token(method) || builtin_methods().count(method)) {
  10970. output_error_log(Error::InvalidHTTPMethod, nullptr);
  10971. has_invalid_registration_ = true;
  10972. return nullptr;
  10973. }
  10974. return &custom_handlers_[method];
  10975. }
  10976. inline Server &Server::CustomRoute(const std::string &method,
  10977. const std::string &pattern,
  10978. Handler handler) {
  10979. auto *entry = custom_entry_for_registration(method);
  10980. if (!entry) { return *this; }
  10981. return add_handler(entry->handlers, pattern, std::move(handler));
  10982. }
  10983. inline Server &Server::CustomRoute(const std::string &method,
  10984. const std::string &pattern,
  10985. HandlerWithContentReader handler) {
  10986. auto *entry = custom_entry_for_registration(method);
  10987. if (!entry) { return *this; }
  10988. return add_handler(entry->handlers_for_content_reader, pattern,
  10989. std::move(handler));
  10990. }
  10991. inline const Server::CustomHandlerEntry *
  10992. Server::find_custom_entry(const std::string &method) const {
  10993. // find() alone would be correct here. The empty() check is what keeps the
  10994. // per-request cost off servers that never call CustomRoute(), which is the
  10995. // overwhelmingly common case; keep it rather than walking into the tree.
  10996. if (custom_handlers_.empty()) { return nullptr; }
  10997. auto it = custom_handlers_.find(method);
  10998. return it == custom_handlers_.end() ? nullptr : &it->second;
  10999. }
  11000. inline Server &Server::WebSocket(const std::string &pattern,
  11001. WebSocketHandler handler) {
  11002. websocket_handlers_.push_back(
  11003. {make_matcher(pattern), std::move(handler), nullptr});
  11004. return *this;
  11005. }
  11006. inline Server &Server::WebSocket(const std::string &pattern,
  11007. WebSocketHandler handler,
  11008. SubProtocolSelector sub_protocol_selector) {
  11009. websocket_handlers_.push_back({make_matcher(pattern), std::move(handler),
  11010. std::move(sub_protocol_selector)});
  11011. return *this;
  11012. }
  11013. inline bool Server::set_base_dir(const std::string &dir,
  11014. const std::string &mount_point) {
  11015. return set_mount_point(mount_point, dir);
  11016. }
  11017. inline bool Server::set_mount_point(const std::string &mount_point,
  11018. const std::string &dir, Headers headers) {
  11019. detail::FileStat stat(dir);
  11020. if (stat.is_dir()) {
  11021. std::string mnt = !mount_point.empty() ? mount_point : "/";
  11022. if (!mnt.empty() && mnt[0] == '/') {
  11023. std::string resolved_base;
  11024. if (detail::canonicalize_path(dir.c_str(), resolved_base)) {
  11025. #if defined(_WIN32)
  11026. if (resolved_base.back() != '\\' && resolved_base.back() != '/') {
  11027. resolved_base += '\\';
  11028. }
  11029. #else
  11030. if (resolved_base.back() != '/') { resolved_base += '/'; }
  11031. #endif
  11032. }
  11033. base_dirs_.push_back(
  11034. {std::move(mnt), dir, std::move(resolved_base), std::move(headers)});
  11035. return true;
  11036. }
  11037. }
  11038. return false;
  11039. }
  11040. inline bool Server::remove_mount_point(const std::string &mount_point) {
  11041. for (auto it = base_dirs_.begin(); it != base_dirs_.end(); ++it) {
  11042. if (it->mount_point == mount_point) {
  11043. base_dirs_.erase(it);
  11044. return true;
  11045. }
  11046. }
  11047. return false;
  11048. }
  11049. inline Server &
  11050. Server::set_file_extension_and_mimetype_mapping(const std::string &ext,
  11051. const std::string &mime) {
  11052. file_extension_and_mimetype_map_[ext] = mime;
  11053. return *this;
  11054. }
  11055. inline Server &Server::set_default_file_mimetype(const std::string &mime) {
  11056. default_file_mimetype_ = mime;
  11057. return *this;
  11058. }
  11059. inline Server &Server::set_file_request_handler(Handler handler) {
  11060. file_request_handler_ = std::move(handler);
  11061. return *this;
  11062. }
  11063. inline Server &Server::set_error_handler_core(HandlerWithResponse handler,
  11064. std::true_type) {
  11065. error_handler_ = std::move(handler);
  11066. return *this;
  11067. }
  11068. inline Server &Server::set_error_handler_core(Handler handler,
  11069. std::false_type) {
  11070. error_handler_ = [handler](const Request &req, Response &res) {
  11071. handler(req, res);
  11072. return HandlerResponse::Handled;
  11073. };
  11074. return *this;
  11075. }
  11076. inline Server &Server::set_exception_handler(ExceptionHandler handler) {
  11077. exception_handler_ = std::move(handler);
  11078. return *this;
  11079. }
  11080. inline Server &Server::set_pre_routing_handler(HandlerWithResponse handler) {
  11081. pre_routing_handler_ = std::move(handler);
  11082. return *this;
  11083. }
  11084. inline Server &Server::set_post_routing_handler(Handler handler) {
  11085. post_routing_handler_ = std::move(handler);
  11086. return *this;
  11087. }
  11088. inline Server &Server::set_pre_request_handler(HandlerWithResponse handler) {
  11089. pre_request_handler_ = std::move(handler);
  11090. return *this;
  11091. }
  11092. inline Server &Server::set_logger(Logger logger) {
  11093. logger_ = std::move(logger);
  11094. return *this;
  11095. }
  11096. inline Server &Server::set_error_logger(ErrorLogger error_logger) {
  11097. error_logger_ = std::move(error_logger);
  11098. return *this;
  11099. }
  11100. inline Server &Server::set_pre_compression_logger(Logger logger) {
  11101. pre_compression_logger_ = std::move(logger);
  11102. return *this;
  11103. }
  11104. inline Server &
  11105. Server::set_expect_100_continue_handler(Expect100ContinueHandler handler) {
  11106. expect_100_continue_handler_ = std::move(handler);
  11107. return *this;
  11108. }
  11109. inline Server &Server::set_start_handler(StartHandler handler) {
  11110. start_handler_ = std::move(handler);
  11111. return *this;
  11112. }
  11113. inline Server &Server::set_address_family(int family) {
  11114. address_family_ = family;
  11115. return *this;
  11116. }
  11117. inline Server &Server::set_tcp_nodelay(bool on) {
  11118. tcp_nodelay_ = on;
  11119. return *this;
  11120. }
  11121. inline Server &Server::set_ipv6_v6only(bool on) {
  11122. ipv6_v6only_ = on;
  11123. return *this;
  11124. }
  11125. inline Server &Server::set_socket_options(SocketOptions socket_options) {
  11126. socket_options_ = std::move(socket_options);
  11127. return *this;
  11128. }
  11129. inline Server &Server::set_default_headers(Headers headers) {
  11130. default_headers_ = std::move(headers);
  11131. return *this;
  11132. }
  11133. inline Server &Server::set_header_writer(
  11134. std::function<ssize_t(Stream &, Headers &)> const &writer) {
  11135. header_writer_ = writer;
  11136. return *this;
  11137. }
  11138. inline Server &
  11139. Server::set_trusted_proxies(const std::vector<std::string> &proxies) {
  11140. trusted_proxies_ = proxies;
  11141. return *this;
  11142. }
  11143. inline Server &Server::set_keep_alive_max_count(size_t count) {
  11144. keep_alive_max_count_ = count;
  11145. return *this;
  11146. }
  11147. inline Server &Server::set_keep_alive_timeout(time_t sec) {
  11148. keep_alive_timeout_sec_ = sec;
  11149. return *this;
  11150. }
  11151. template <class Rep, class Period>
  11152. inline Server &Server::set_keep_alive_timeout(
  11153. const std::chrono::duration<Rep, Period> &duration) {
  11154. detail::duration_to_sec_and_usec(duration, [&](time_t sec, time_t /*usec*/) {
  11155. set_keep_alive_timeout(sec);
  11156. });
  11157. return *this;
  11158. }
  11159. inline Server &Server::set_read_timeout(time_t sec, time_t usec) {
  11160. read_timeout_sec_ = sec;
  11161. read_timeout_usec_ = usec;
  11162. return *this;
  11163. }
  11164. inline Server &Server::set_write_timeout(time_t sec, time_t usec) {
  11165. write_timeout_sec_ = sec;
  11166. write_timeout_usec_ = usec;
  11167. return *this;
  11168. }
  11169. inline Server &Server::set_idle_interval(time_t sec, time_t usec) {
  11170. idle_interval_sec_ = sec;
  11171. idle_interval_usec_ = usec;
  11172. return *this;
  11173. }
  11174. inline Server &Server::set_payload_max_length(size_t length) {
  11175. payload_max_length_ = length;
  11176. return *this;
  11177. }
  11178. inline Server &Server::set_static_file_compression(bool on) {
  11179. static_file_compression_ = on;
  11180. return *this;
  11181. }
  11182. inline Server &Server::set_static_file_compression_min_length(size_t length) {
  11183. static_file_compression_min_length_ = length;
  11184. return *this;
  11185. }
  11186. inline Server &Server::set_static_file_compression_max_length(size_t length) {
  11187. static_file_compression_max_length_ = length;
  11188. return *this;
  11189. }
  11190. inline Server &Server::set_websocket_max_missed_pongs(int count) {
  11191. websocket_max_missed_pongs_ = count;
  11192. return *this;
  11193. }
  11194. inline Server &Server::set_websocket_ping_interval(time_t sec) {
  11195. websocket_ping_interval_sec_ = sec;
  11196. return *this;
  11197. }
  11198. template <class Rep, class Period>
  11199. inline Server &Server::set_websocket_ping_interval(
  11200. const std::chrono::duration<Rep, Period> &duration) {
  11201. detail::duration_to_sec_and_usec(duration, [&](time_t sec, time_t /*usec*/) {
  11202. set_websocket_ping_interval(sec);
  11203. });
  11204. return *this;
  11205. }
  11206. inline bool Server::bind_to_port(const std::string &host, int port,
  11207. int socket_flags) {
  11208. auto ret = bind_internal(host, port, socket_flags);
  11209. if (ret == -1) { is_decommissioned = true; }
  11210. return ret >= 0;
  11211. }
  11212. inline int Server::bind_to_any_port(const std::string &host, int socket_flags) {
  11213. auto ret = bind_internal(host, 0, socket_flags);
  11214. if (ret == -1) { is_decommissioned = true; }
  11215. return ret;
  11216. }
  11217. inline bool Server::listen_after_bind() { return listen_internal(); }
  11218. inline bool Server::listen(const std::string &host, int port,
  11219. int socket_flags) {
  11220. return bind_to_port(host, port, socket_flags) && listen_internal();
  11221. }
  11222. inline bool Server::is_running() const { return is_running_; }
  11223. inline void Server::wait_until_ready() const {
  11224. while (!is_running_ && !is_decommissioned) {
  11225. std::this_thread::sleep_for(std::chrono::milliseconds{1});
  11226. }
  11227. }
  11228. inline void Server::stop() noexcept {
  11229. // Release the listening socket whether or not the accept loop is running:
  11230. // bind_to_port() without listen_after_bind() still owns the descriptor. The
  11231. // exchange is what makes this safe to call concurrently with the accept loop.
  11232. socket_t sock = svr_sock_.exchange(INVALID_SOCKET);
  11233. if (sock != INVALID_SOCKET) {
  11234. detail::shutdown_socket(sock);
  11235. detail::close_socket(sock);
  11236. }
  11237. is_decommissioned = false;
  11238. }
  11239. inline void Server::decommission() { is_decommissioned = true; }
  11240. inline bool Server::parse_request_line(const char *s, Request &req) const {
  11241. auto len = strlen(s);
  11242. if (len < 2 || s[len - 2] != '\r' || s[len - 1] != '\n') { return false; }
  11243. len -= 2;
  11244. {
  11245. size_t count = 0;
  11246. detail::split(s, s + len, ' ', [&](const char *b, const char *e) {
  11247. switch (count) {
  11248. case 0: req.method = std::string(b, e); break;
  11249. case 1: req.target = std::string(b, e); break;
  11250. case 2: req.version = std::string(b, e); break;
  11251. default: break;
  11252. }
  11253. count++;
  11254. });
  11255. if (count != 3) { return false; }
  11256. }
  11257. // A method outside the built-in set is accepted only when a handler has been
  11258. // registered for it with CustomRoute().
  11259. const auto &methods = builtin_methods();
  11260. if (methods.find(req.method) == methods.end() &&
  11261. !find_custom_entry(req.method)) {
  11262. output_error_log(Error::InvalidHTTPMethod, &req);
  11263. return false;
  11264. }
  11265. if (req.version != "HTTP/1.1" && req.version != "HTTP/1.0") {
  11266. output_error_log(Error::InvalidHTTPVersion, &req);
  11267. return false;
  11268. }
  11269. if (!detail::fields::is_request_target(req.target)) { return false; }
  11270. {
  11271. // Skip URL fragment
  11272. for (size_t i = 0; i < req.target.size(); i++) {
  11273. if (req.target[i] == '#') {
  11274. req.target.erase(i);
  11275. break;
  11276. }
  11277. }
  11278. detail::divide(req.target, '?',
  11279. [&](const char *lhs_data, std::size_t lhs_size,
  11280. const char *rhs_data, std::size_t rhs_size) {
  11281. req.path =
  11282. decode_path_component(std::string(lhs_data, lhs_size));
  11283. detail::parse_query_text(rhs_data, rhs_size, req.params);
  11284. });
  11285. }
  11286. return true;
  11287. }
  11288. inline bool Server::write_response(Stream &strm, bool close_connection,
  11289. Request &req, Response &res) {
  11290. // NOTE: `req.ranges` should be empty, otherwise it will be applied
  11291. // incorrectly to the error content.
  11292. req.ranges.clear();
  11293. return write_response_core(strm, close_connection, req, res, false);
  11294. }
  11295. inline bool Server::write_response_with_content(Stream &strm,
  11296. bool close_connection,
  11297. const Request &req,
  11298. Response &res) {
  11299. return write_response_core(strm, close_connection, req, res, true);
  11300. }
  11301. inline bool Server::write_response_core(Stream &strm, bool close_connection,
  11302. const Request &req, Response &res,
  11303. bool need_apply_ranges) {
  11304. assert(res.status != -1);
  11305. if (400 <= res.status && error_handler_ &&
  11306. error_handler_(req, res) == HandlerResponse::Handled) {
  11307. need_apply_ranges = true;
  11308. }
  11309. std::string content_type;
  11310. std::string boundary;
  11311. if (need_apply_ranges) { apply_ranges(req, res, content_type, boundary); }
  11312. // Prepare additional headers
  11313. if (close_connection ||
  11314. detail::has_header_token(req.headers, "Connection", "close") ||
  11315. 400 <= res.status || // Don't leave connections open after errors
  11316. // The client withholds the body until `100 Continue`, which was never
  11317. // sent, so whether and when the body follows is unknown.
  11318. (req.expect_100_continue_pending_ && detail::has_framed_body(req))) {
  11319. res.set_header("Connection", "close");
  11320. } else {
  11321. std::string s = "timeout=";
  11322. s += std::to_string(keep_alive_timeout_sec_);
  11323. s += ", max=";
  11324. s += std::to_string(keep_alive_max_count_);
  11325. res.set_header("Keep-Alive", s);
  11326. }
  11327. if ((!res.body.empty() || res.content_length_ > 0 || res.content_provider_) &&
  11328. !res.has_header("Content-Type")) {
  11329. res.set_header("Content-Type", "text/plain");
  11330. }
  11331. if (res.body.empty() && !res.content_length_ && !res.content_provider_ &&
  11332. !res.has_header("Content-Length")) {
  11333. res.set_header("Content-Length", "0");
  11334. }
  11335. if (req.method == "HEAD" && !res.has_header("Accept-Ranges")) {
  11336. res.set_header("Accept-Ranges", "bytes");
  11337. }
  11338. if (post_routing_handler_) { post_routing_handler_(req, res); }
  11339. // Response line and headers
  11340. detail::BufferStream bstrm;
  11341. if (!detail::write_response_line(bstrm, res.status)) { return false; }
  11342. if (header_writer_(bstrm, res.headers) <= 0) { return false; }
  11343. // Combine a small body with the headers so the whole response leaves in a
  11344. // single write. A large body is written on its own instead: a copy of it
  11345. // costs more than the extra write saves.
  11346. auto send_body = req.method != "HEAD";
  11347. auto body_is_separate = false;
  11348. auto provider_done = false;
  11349. if (send_body && !res.body.empty() && !res.content_provider_) {
  11350. if (res.body.size() < CPPHTTPLIB_SEND_BUFSIZ) {
  11351. bstrm.write(res.body.data(), res.body.size());
  11352. } else {
  11353. body_is_separate = true;
  11354. }
  11355. } else if (send_body && res.content_provider_ &&
  11356. res.is_file_content_provider_ &&
  11357. res.content_length_ < CPPHTTPLIB_SEND_BUFSIZ) {
  11358. // A small file is read into the same buffer. Other providers may produce
  11359. // their data over time, so they are never held back.
  11360. if (!write_content_with_provider(bstrm, req, res, boundary, content_type)) {
  11361. return false;
  11362. }
  11363. provider_done = true;
  11364. }
  11365. // Log before writing to avoid race condition with client-side code that
  11366. // accesses logger-captured data immediately after receiving the response.
  11367. output_log(req, res);
  11368. // Flush buffer
  11369. auto &data = bstrm.get_buffer();
  11370. if (!detail::write_data(strm, data.data(), data.size())) { return false; }
  11371. if (body_is_separate) {
  11372. return detail::write_data(strm, res.body.data(), res.body.size());
  11373. }
  11374. // Streaming body
  11375. if (send_body && res.content_provider_) {
  11376. if (!provider_done &&
  11377. !write_content_with_provider(strm, req, res, boundary, content_type)) {
  11378. return false;
  11379. }
  11380. res.content_provider_success_ = true;
  11381. }
  11382. return true;
  11383. }
  11384. inline bool
  11385. Server::write_content_with_provider(Stream &strm, const Request &req,
  11386. Response &res, const std::string &boundary,
  11387. const std::string &content_type) {
  11388. auto is_shutting_down = [this]() {
  11389. return this->svr_sock_ == INVALID_SOCKET;
  11390. };
  11391. if (res.content_length_ > 0) {
  11392. // Only a 206 response is served as a partial representation, matching the
  11393. // condition `apply_ranges()` used to decide the Content-Length and the
  11394. // multipart boundary. Since `detail::range_error()` validates `req.ranges`
  11395. // only for a 2xx status, slicing under any other status would write a body
  11396. // that disagrees with the header already sent, from an unchecked offset.
  11397. auto is_partial =
  11398. !req.ranges.empty() && res.status == StatusCode::PartialContent_206;
  11399. if (!is_partial) {
  11400. return detail::write_content(strm, res.content_provider_, 0,
  11401. res.content_length_, is_shutting_down);
  11402. } else if (req.ranges.size() == 1) {
  11403. auto offset_and_length = detail::get_range_offset_and_length(
  11404. req.ranges[0], res.content_length_);
  11405. return detail::write_content(strm, res.content_provider_,
  11406. offset_and_length.first,
  11407. offset_and_length.second, is_shutting_down);
  11408. } else {
  11409. return detail::write_multipart_ranges_data(
  11410. strm, req, res, boundary, content_type, res.content_length_,
  11411. is_shutting_down);
  11412. }
  11413. } else {
  11414. if (res.is_chunked_content_provider_) {
  11415. // Use the coding `apply_ranges()` chose when it wrote the headers;
  11416. // re-negotiating here would disagree with them, e.g. once a handler's
  11417. // own Content-Encoding header suppresses the negotiation.
  11418. auto compressor = detail::make_compressor(res.content_coding_);
  11419. if (!compressor) {
  11420. compressor = detail::make_unique<detail::nocompressor>();
  11421. }
  11422. return detail::write_content_chunked(strm, res.content_provider_,
  11423. is_shutting_down, *compressor);
  11424. } else {
  11425. return detail::write_content_without_length(strm, res.content_provider_,
  11426. is_shutting_down);
  11427. }
  11428. }
  11429. }
  11430. inline bool Server::read_content(Stream &strm, Request &req, Response &res) {
  11431. FormFields::iterator cur_field;
  11432. FormFiles::iterator cur_file;
  11433. auto is_text_field = false;
  11434. size_t count = 0;
  11435. if (read_content_core(
  11436. strm, req, res,
  11437. // Regular
  11438. [&](const char *buf, size_t n) {
  11439. // Prevent arithmetic overflow when checking sizes.
  11440. // Avoid computing (req.body.size() + n) directly because
  11441. // adding two unsigned `size_t` values can wrap around and
  11442. // produce a small result instead of indicating overflow.
  11443. // Instead, check using subtraction: ensure `n` does not
  11444. // exceed the remaining capacity `max_size() - size()`.
  11445. if (req.body.size() >= req.body.max_size() ||
  11446. n > req.body.max_size() - req.body.size()) {
  11447. return false;
  11448. }
  11449. // Limit decompressed body size to payload_max_length_ to protect
  11450. // against "zip bomb" attacks where a small compressed payload
  11451. // decompresses to a massive size.
  11452. if (payload_max_length_ > 0 &&
  11453. (req.body.size() >= payload_max_length_ ||
  11454. n > payload_max_length_ - req.body.size())) {
  11455. return false;
  11456. }
  11457. req.body.append(buf, n);
  11458. return true;
  11459. },
  11460. // Multipart FormData
  11461. [&](const FormData &file) {
  11462. if (count++ == CPPHTTPLIB_MULTIPART_FORM_DATA_FILE_MAX_COUNT) {
  11463. output_error_log(Error::TooManyFormDataFiles, &req);
  11464. return false;
  11465. }
  11466. if (file.filename.empty()) {
  11467. cur_field = req.form.fields.emplace(
  11468. file.name, FormField{file.name, file.content, file.headers});
  11469. is_text_field = true;
  11470. } else {
  11471. cur_file = req.form.files.emplace(file.name, file);
  11472. is_text_field = false;
  11473. }
  11474. return true;
  11475. },
  11476. [&](const char *buf, size_t n) {
  11477. if (is_text_field) {
  11478. auto &content = cur_field->second.content;
  11479. if (content.size() + n > content.max_size()) { return false; }
  11480. content.append(buf, n);
  11481. } else {
  11482. auto &content = cur_file->second.content;
  11483. if (content.size() + n > content.max_size()) { return false; }
  11484. content.append(buf, n);
  11485. }
  11486. return true;
  11487. })) {
  11488. const auto &content_type = req.get_header_value("Content-Type");
  11489. if (detail::extract_media_type(content_type) ==
  11490. "application/x-www-form-urlencoded") {
  11491. if (req.body.size() > CPPHTTPLIB_FORM_URL_ENCODED_PAYLOAD_MAX_LENGTH) {
  11492. res.status = StatusCode::PayloadTooLarge_413; // NOTE: should be 414?
  11493. output_error_log(Error::ExceedMaxPayloadSize, &req);
  11494. return false;
  11495. }
  11496. detail::parse_query_text(req.body, req.params);
  11497. }
  11498. return true;
  11499. }
  11500. return false;
  11501. }
  11502. inline bool Server::read_content_with_content_receiver(
  11503. Stream &strm, Request &req, Response &res, ContentReceiver receiver,
  11504. FormDataHeader multipart_header, ContentReceiver multipart_receiver) {
  11505. return read_content_core(strm, req, res, std::move(receiver),
  11506. std::move(multipart_header),
  11507. std::move(multipart_receiver));
  11508. }
  11509. inline bool Server::read_content_core(
  11510. Stream &strm, Request &req, Response &res, ContentReceiver receiver,
  11511. FormDataHeader multipart_header, ContentReceiver multipart_receiver) const {
  11512. detail::FormDataParser multipart_form_data_parser;
  11513. ContentReceiverWithProgress out;
  11514. if (req.is_multipart_form_data()) {
  11515. const auto &content_type = req.get_header_value("Content-Type");
  11516. std::string boundary;
  11517. if (!detail::parse_multipart_boundary(content_type, boundary)) {
  11518. res.status = StatusCode::BadRequest_400;
  11519. output_error_log(Error::MultipartParsing, &req);
  11520. return false;
  11521. }
  11522. multipart_form_data_parser.set_boundary(std::move(boundary));
  11523. out = [&](const char *buf, size_t n, size_t /*off*/, size_t /*len*/) {
  11524. return multipart_form_data_parser.parse(buf, n, multipart_header,
  11525. multipart_receiver);
  11526. };
  11527. } else {
  11528. out = [receiver](const char *buf, size_t n, size_t /*off*/,
  11529. size_t /*len*/) { return receiver(buf, n); };
  11530. }
  11531. // RFC 9112 §6: no Transfer-Encoding and no Content-Length means no body.
  11532. // For non-SSL builds we still scan non-persistent connections for stray
  11533. // body bytes so the payload limit is enforced (413). On keep-alive,
  11534. // pending bytes may be the next request (issue #2450), so skip.
  11535. #if !defined(CPPHTTPLIB_SSL_ENABLED)
  11536. if (!req.has_header("Content-Length") &&
  11537. !detail::is_chunked_transfer_encoding(req.headers)) {
  11538. if (!detail::is_connection_persistent(req) && payload_max_length_ > 0 &&
  11539. payload_max_length_ < (std::numeric_limits<size_t>::max)()) {
  11540. auto has_data = strm.is_readable();
  11541. if (!has_data) {
  11542. auto s = strm.socket();
  11543. if (s != INVALID_SOCKET) {
  11544. has_data = detail::select_read(s, 0, 0) > 0;
  11545. }
  11546. }
  11547. if (has_data) {
  11548. // Route through the same decompressing reader used by the
  11549. // length-framed and chunked paths below, so payload_max_length_ is
  11550. // enforced on the decompressed size here too instead of only on the
  11551. // compressed wire bytes.
  11552. return detail::read_content(strm, req, payload_max_length_, res.status,
  11553. nullptr, out, true);
  11554. }
  11555. }
  11556. return true;
  11557. }
  11558. #else
  11559. if (!req.has_header("Content-Length") &&
  11560. !detail::is_chunked_transfer_encoding(req.headers)) {
  11561. return true;
  11562. }
  11563. #endif
  11564. // The client is waiting for this before it sends the body.
  11565. if (req.expect_100_continue_pending_) {
  11566. req.expect_100_continue_pending_ = false;
  11567. detail::write_response_line(strm, StatusCode::Continue_100);
  11568. strm.write("\r\n");
  11569. }
  11570. if (!detail::read_content(strm, req, payload_max_length_, res.status, nullptr,
  11571. out, true)) {
  11572. return false;
  11573. }
  11574. req.body_consumed_ = true;
  11575. if (req.is_multipart_form_data()) {
  11576. if (!multipart_form_data_parser.is_valid()) {
  11577. res.status = StatusCode::BadRequest_400;
  11578. output_error_log(Error::MultipartParsing, &req);
  11579. return false;
  11580. }
  11581. }
  11582. return true;
  11583. }
  11584. inline bool Server::handle_file_request(Request &req, Response &res) {
  11585. for (const auto &entry : base_dirs_) {
  11586. // Prefix match, on a path segment boundary. A mount point of "/mount"
  11587. // covers "/mount" and "/mount/...", but must not swallow "/mountdir/...".
  11588. // One that already ends in '/' (the root mount among them) carries its own
  11589. // boundary; set_mount_point() guarantees the mount point is not empty.
  11590. if (!req.path.compare(0, entry.mount_point.size(), entry.mount_point) &&
  11591. (entry.mount_point.back() == '/' ||
  11592. req.path.size() == entry.mount_point.size() ||
  11593. req.path[entry.mount_point.size()] == '/')) {
  11594. std::string sub_path = "/" + req.path.substr(entry.mount_point.size());
  11595. if (detail::is_valid_path(sub_path)) {
  11596. auto path = entry.base_dir + sub_path;
  11597. if (path.back() == '/') { path += "index.html"; }
  11598. // Defense-in-depth: is_valid_path blocks ".." traversal in the URL,
  11599. // but symlinks/junctions can still escape the base directory.
  11600. if (!entry.resolved_base_dir.empty()) {
  11601. std::string resolved_path;
  11602. if (detail::canonicalize_path(path.c_str(), resolved_path) &&
  11603. !detail::is_path_within_base(resolved_path,
  11604. entry.resolved_base_dir)) {
  11605. res.status = StatusCode::Forbidden_403;
  11606. return true;
  11607. }
  11608. }
  11609. detail::FileStat stat(path);
  11610. if (stat.is_dir()) {
  11611. res.set_redirect(sub_path + "/", StatusCode::MovedPermanently_301);
  11612. return true;
  11613. }
  11614. if (stat.is_file()) {
  11615. for (const auto &kv : entry.headers) {
  11616. res.set_header(kv.first, kv.second);
  11617. }
  11618. auto content_type_of = [&]() {
  11619. return detail::find_content_type(
  11620. path, file_extension_and_mimetype_map_, default_file_mimetype_);
  11621. };
  11622. // Only the ETag needs the content type this early, and only to name
  11623. // the coding. Deciding it here would otherwise put a regex in front
  11624. // of the 304 below, which serving a file never used to pay for.
  11625. std::string content_type;
  11626. auto encoding = detail::EncodingType::None;
  11627. if (static_file_compression_) {
  11628. content_type = content_type_of();
  11629. encoding =
  11630. static_file_encoding(req, res, content_type, stat.size());
  11631. }
  11632. // The ETag names the representation actually sent, so a client that
  11633. // cached the compressed form revalidates against the compressed ETag
  11634. // and still gets a 304, while one that took identity keeps the plain
  11635. // ETag.
  11636. auto etag = detail::compute_etag(
  11637. stat, encoding == detail::EncodingType::None
  11638. ? std::string()
  11639. : std::string("-") + detail::encoding_name(encoding));
  11640. if (!etag.empty()) { res.set_header("ETag", etag); }
  11641. auto mtime = stat.mtime();
  11642. auto last_modified = detail::file_mtime_to_http_date(mtime);
  11643. if (!last_modified.empty()) {
  11644. res.set_header("Last-Modified", last_modified);
  11645. }
  11646. if (check_if_not_modified(req, res, etag, mtime)) { return true; }
  11647. check_if_range(req, etag, mtime);
  11648. auto mm = std::make_shared<detail::mmap>(path.c_str());
  11649. if (!mm->is_open()) {
  11650. output_error_log(Error::OpenFile, &req);
  11651. return false;
  11652. }
  11653. if (!static_file_compression_) { content_type = content_type_of(); }
  11654. detail::set_file_content_provider(res, mm, content_type, encoding);
  11655. if (req.method != "HEAD" && file_request_handler_) {
  11656. file_request_handler_(req, res);
  11657. }
  11658. return true;
  11659. } else {
  11660. output_error_log(Error::OpenFile, &req);
  11661. }
  11662. }
  11663. }
  11664. }
  11665. return false;
  11666. }
  11667. inline bool Server::check_if_not_modified(const Request &req, Response &res,
  11668. const std::string &etag,
  11669. time_t mtime) const {
  11670. // Handle conditional GET:
  11671. // 1. If-None-Match takes precedence (RFC 9110 Section 13.1.2)
  11672. // 2. If-Modified-Since is checked only when If-None-Match is absent
  11673. if (req.has_header("If-None-Match")) {
  11674. if (!etag.empty()) {
  11675. auto val =
  11676. detail::get_combined_header_value(req.headers, "If-None-Match");
  11677. // NOTE: We use exact string matching here. This works correctly
  11678. // because our server always generates weak ETags (W/"..."), and
  11679. // clients typically send back the same ETag they received.
  11680. // RFC 9110 Section 8.8.3.2 allows weak comparison for
  11681. // If-None-Match, where W/"x" and "x" would match, but this
  11682. // simplified implementation requires exact matches.
  11683. auto ret = detail::split_find(val.data(), val.data() + val.size(), ',',
  11684. [&](const char *b, const char *e) {
  11685. auto seg_len = static_cast<size_t>(e - b);
  11686. return (seg_len == 1 && *b == '*') ||
  11687. (seg_len == etag.size() &&
  11688. std::equal(b, e, etag.begin()));
  11689. });
  11690. if (ret) {
  11691. res.status = StatusCode::NotModified_304;
  11692. return true;
  11693. }
  11694. }
  11695. } else if (req.has_header("If-Modified-Since")) {
  11696. auto val = req.get_header_value("If-Modified-Since");
  11697. auto t = detail::parse_http_date(val);
  11698. if (t != static_cast<time_t>(-1) && mtime <= t) {
  11699. res.status = StatusCode::NotModified_304;
  11700. return true;
  11701. }
  11702. }
  11703. return false;
  11704. }
  11705. inline bool Server::check_if_range(Request &req, const std::string &etag,
  11706. time_t mtime) const {
  11707. // Handle If-Range for partial content requests (RFC 9110
  11708. // Section 13.1.5). If-Range is only evaluated when Range header is
  11709. // present. If the validator matches, serve partial content; otherwise
  11710. // serve full content.
  11711. if (!req.ranges.empty() && req.has_header("If-Range")) {
  11712. auto val = req.get_header_value("If-Range");
  11713. auto is_valid_range = [&]() {
  11714. if (detail::is_strong_etag(val)) {
  11715. // RFC 9110 Section 13.1.5: If-Range requires strong ETag
  11716. // comparison.
  11717. return (!etag.empty() && val == etag);
  11718. } else if (detail::is_weak_etag(val)) {
  11719. // Weak ETags are not valid for If-Range (RFC 9110 Section 13.1.5)
  11720. return false;
  11721. } else {
  11722. // HTTP-date comparison
  11723. auto t = detail::parse_http_date(val);
  11724. return (t != static_cast<time_t>(-1) && mtime <= t);
  11725. }
  11726. };
  11727. if (!is_valid_range()) {
  11728. // Validator doesn't match: ignore Range and serve full content
  11729. req.ranges.clear();
  11730. return false;
  11731. }
  11732. }
  11733. return true;
  11734. }
  11735. inline socket_t
  11736. Server::create_server_socket(const std::string &host, int port,
  11737. int socket_flags,
  11738. SocketOptions socket_options) const {
  11739. return detail::create_socket(
  11740. host, std::string(), port, address_family_, socket_flags, tcp_nodelay_,
  11741. ipv6_v6only_, std::move(socket_options),
  11742. [&](socket_t sock, struct addrinfo &ai, bool & /*quit*/) -> bool {
  11743. if (::bind(sock, ai.ai_addr, static_cast<socklen_t>(ai.ai_addrlen))) {
  11744. output_error_log(Error::BindIPAddress, nullptr);
  11745. return false;
  11746. }
  11747. if (::listen(sock, CPPHTTPLIB_LISTEN_BACKLOG)) {
  11748. output_error_log(Error::Listen, nullptr);
  11749. return false;
  11750. }
  11751. return true;
  11752. });
  11753. }
  11754. inline int Server::bind_internal(const std::string &host, int port,
  11755. int socket_flags) {
  11756. if (is_decommissioned) { return -1; }
  11757. if (!is_valid()) { return -1; }
  11758. svr_sock_ = create_server_socket(host, port, socket_flags, socket_options_);
  11759. if (svr_sock_ == INVALID_SOCKET) { return -1; }
  11760. if (port == 0) {
  11761. struct sockaddr_storage addr;
  11762. socklen_t addr_len = sizeof(addr);
  11763. if (getsockname(svr_sock_, reinterpret_cast<struct sockaddr *>(&addr),
  11764. &addr_len) == -1) {
  11765. output_error_log(Error::GetSockName, nullptr);
  11766. return -1;
  11767. }
  11768. if (addr.ss_family == AF_INET) {
  11769. return ntohs(reinterpret_cast<struct sockaddr_in *>(&addr)->sin_port);
  11770. } else if (addr.ss_family == AF_INET6) {
  11771. return ntohs(reinterpret_cast<struct sockaddr_in6 *>(&addr)->sin6_port);
  11772. } else {
  11773. output_error_log(Error::UnsupportedAddressFamily, nullptr);
  11774. return -1;
  11775. }
  11776. } else {
  11777. return port;
  11778. }
  11779. }
  11780. inline bool Server::listen_internal() {
  11781. // A stop() between bind and listen leaves nothing to accept on. Report
  11782. // failure instead of returning success without ever serving, and mark the
  11783. // server decommissioned the way any failed listen does so that a concurrent
  11784. // wait_until_ready() wakes up instead of spinning forever.
  11785. if (is_decommissioned || svr_sock_ == INVALID_SOCKET) {
  11786. is_decommissioned = true;
  11787. return false;
  11788. }
  11789. auto ret = true;
  11790. is_running_ = true;
  11791. auto se = detail::scope_exit([&]() { is_running_ = false; });
  11792. if (start_handler_) { start_handler_(); }
  11793. {
  11794. std::unique_ptr<TaskQueue> task_queue(new_task_queue());
  11795. while (svr_sock_ != INVALID_SOCKET) {
  11796. #ifndef _WIN32
  11797. if (idle_interval_sec_ > 0 || idle_interval_usec_ > 0) {
  11798. #endif
  11799. auto val = detail::select_read(svr_sock_, idle_interval_sec_,
  11800. idle_interval_usec_);
  11801. if (val == 0) { // Timeout
  11802. task_queue->on_idle();
  11803. continue;
  11804. }
  11805. #ifndef _WIN32
  11806. }
  11807. #endif
  11808. #if defined _WIN32
  11809. // sockets connected via WASAccept inherit flags NO_HANDLE_INHERIT,
  11810. // OVERLAPPED
  11811. socket_t sock = WSAAccept(svr_sock_, nullptr, nullptr, nullptr, 0);
  11812. #elif defined SOCK_CLOEXEC
  11813. socket_t sock = accept4(svr_sock_, nullptr, nullptr, SOCK_CLOEXEC);
  11814. #else
  11815. socket_t sock = accept(svr_sock_, nullptr, nullptr);
  11816. #endif
  11817. if (sock == INVALID_SOCKET) {
  11818. // NOTE: Winsock reports failures through WSAGetLastError() and never
  11819. // touches the CRT errno, so the two have to be asked platform by
  11820. // platform rather than by testing errno here.
  11821. if (detail::is_accept_resource_error()) {
  11822. // The per-process descriptor limit or the network stack's buffer
  11823. // space has been reached. Try to accept new connections after a
  11824. // short sleep.
  11825. std::this_thread::sleep_for(std::chrono::microseconds{1});
  11826. continue;
  11827. } else if (detail::is_accept_transient_error()) {
  11828. continue;
  11829. }
  11830. // Take the descriptor out of svr_sock_ before closing it: a later
  11831. // stop() would otherwise shutdown()/close() a value the OS may have
  11832. // reused, and keep_alive() watches svr_sock_ to notice the server is
  11833. // gone. The exchange also settles the race with a concurrent stop(),
  11834. // since whichever side takes the descriptor closes it exactly once.
  11835. auto listen_sock = svr_sock_.exchange(INVALID_SOCKET);
  11836. if (listen_sock != INVALID_SOCKET) {
  11837. detail::close_socket(listen_sock);
  11838. ret = false;
  11839. output_error_log(Error::Connection, nullptr);
  11840. } else {
  11841. ; // The server socket was closed by user.
  11842. }
  11843. break;
  11844. }
  11845. detail::set_socket_opt_time(sock, SOL_SOCKET, SO_RCVTIMEO,
  11846. read_timeout_sec_, read_timeout_usec_);
  11847. detail::set_socket_opt_time(sock, SOL_SOCKET, SO_SNDTIMEO,
  11848. write_timeout_sec_, write_timeout_usec_);
  11849. if (tcp_nodelay_) { set_socket_opt(sock, IPPROTO_TCP, TCP_NODELAY, 1); }
  11850. if (!task_queue->enqueue(
  11851. [this, sock]() { process_and_close_socket(sock); })) {
  11852. output_error_log(Error::ResourceExhaustion, nullptr);
  11853. detail::shutdown_socket(sock);
  11854. detail::close_socket(sock);
  11855. }
  11856. }
  11857. task_queue->shutdown();
  11858. }
  11859. is_decommissioned = !ret;
  11860. return ret;
  11861. }
  11862. inline bool Server::routing(Request &req, Response &res, Stream &strm) {
  11863. if (pre_routing_handler_ &&
  11864. pre_routing_handler_(req, res) == HandlerResponse::Handled) {
  11865. return true;
  11866. }
  11867. // File handler
  11868. if ((req.method == "GET" || req.method == "HEAD") &&
  11869. handle_file_request(req, res)) {
  11870. return true;
  11871. }
  11872. const auto *custom = find_custom_entry(req.method);
  11873. // The second clause mirrors what expect_content() does unconditionally for
  11874. // POST/PUT/PATCH/DELETE: a content reader route fires even when the request
  11875. // carries no body. Without it a body-less PROPFIND (RFC 4918 treats one as
  11876. // `allprop`) would skip its handler and fall through to 404.
  11877. if (detail::expect_content(req) ||
  11878. (custom && !custom->handlers_for_content_reader.empty())) {
  11879. // Content reader handler
  11880. {
  11881. // Track whether the ContentReader was aborted due to the decompressed
  11882. // payload exceeding `payload_max_length_`.
  11883. // The user handler runs after the lambda returns, so we must restore the
  11884. // 413 status if the handler overwrites it.
  11885. bool content_reader_payload_too_large = false;
  11886. ContentReader reader(
  11887. [&](ContentReceiver receiver) {
  11888. auto result = read_content_with_content_receiver(
  11889. strm, req, res, std::move(receiver), nullptr, nullptr);
  11890. if (!result) {
  11891. output_error_log(Error::Read, &req);
  11892. if (res.status == StatusCode::PayloadTooLarge_413) {
  11893. content_reader_payload_too_large = true;
  11894. }
  11895. }
  11896. return result;
  11897. },
  11898. [&](FormDataHeader header, ContentReceiver receiver) {
  11899. auto result = read_content_with_content_receiver(
  11900. strm, req, res, nullptr, std::move(header),
  11901. std::move(receiver));
  11902. if (!result) {
  11903. output_error_log(Error::Read, &req);
  11904. if (res.status == StatusCode::PayloadTooLarge_413) {
  11905. content_reader_payload_too_large = true;
  11906. }
  11907. }
  11908. return result;
  11909. });
  11910. bool dispatched = false;
  11911. if (req.method == "POST") {
  11912. dispatched = dispatch_request_for_content_reader(
  11913. req, res, std::move(reader), post_handlers_for_content_reader_);
  11914. } else if (req.method == "PUT") {
  11915. dispatched = dispatch_request_for_content_reader(
  11916. req, res, std::move(reader), put_handlers_for_content_reader_);
  11917. } else if (req.method == "PATCH") {
  11918. dispatched = dispatch_request_for_content_reader(
  11919. req, res, std::move(reader), patch_handlers_for_content_reader_);
  11920. } else if (req.method == "DELETE") {
  11921. dispatched = dispatch_request_for_content_reader(
  11922. req, res, std::move(reader), delete_handlers_for_content_reader_);
  11923. } else if (custom) {
  11924. dispatched = dispatch_request_for_content_reader(
  11925. req, res, std::move(reader), custom->handlers_for_content_reader);
  11926. }
  11927. if (dispatched) {
  11928. if (content_reader_payload_too_large) {
  11929. // Enforce the limit: override any status the handler may have set
  11930. // and return false so the error path sends a plain 413 response.
  11931. res.status = StatusCode::PayloadTooLarge_413;
  11932. res.body.clear();
  11933. res.content_length_ = 0;
  11934. res.content_provider_ = nullptr;
  11935. return false;
  11936. }
  11937. return true;
  11938. }
  11939. }
  11940. // NOTE: `req.body` is not read here. For a regular handler the body is
  11941. // read inside dispatch_request(), after the route has matched and the
  11942. // pre-request handler has approved the request, so that a rejected
  11943. // request (e.g. failed authentication) never forces us to buffer a
  11944. // potentially large body.
  11945. }
  11946. // Regular handler
  11947. if (req.method == "GET" || req.method == "HEAD") {
  11948. return dispatch_request(req, res, get_handlers_, strm);
  11949. } else if (req.method == "POST") {
  11950. return dispatch_request(req, res, post_handlers_, strm);
  11951. } else if (req.method == "PUT") {
  11952. return dispatch_request(req, res, put_handlers_, strm);
  11953. } else if (req.method == "DELETE") {
  11954. return dispatch_request(req, res, delete_handlers_, strm);
  11955. } else if (req.method == "OPTIONS") {
  11956. return dispatch_request(req, res, options_handlers_, strm);
  11957. } else if (req.method == "PATCH") {
  11958. return dispatch_request(req, res, patch_handlers_, strm);
  11959. } else if (custom) {
  11960. return dispatch_request(req, res, custom->handlers, strm);
  11961. }
  11962. res.status = StatusCode::BadRequest_400;
  11963. return false;
  11964. }
  11965. inline bool Server::dispatch_request(Request &req, Response &res,
  11966. const Handlers &handlers, Stream &strm) {
  11967. for (const auto &x : handlers) {
  11968. const auto &matcher = x.first;
  11969. const auto &handler = x.second;
  11970. if (matcher->match(req)) {
  11971. req.matched_route = matcher->pattern();
  11972. // Run the pre-request handler before reading the body so a rejected
  11973. // request (e.g. failed authentication) never forces us to buffer a
  11974. // potentially large body. `req.matched_route` is available here.
  11975. if (pre_request_handler_ &&
  11976. pre_request_handler_(req, res) == HandlerResponse::Handled) {
  11977. return true;
  11978. }
  11979. // The route matched and the request was approved; read the body now.
  11980. if (detail::expect_content(req) && !read_content(strm, req, res)) {
  11981. output_error_log(Error::Read, &req);
  11982. return false;
  11983. }
  11984. handler(req, res);
  11985. return true;
  11986. }
  11987. }
  11988. return false;
  11989. }
  11990. // Decides the content coding for a response served straight from a file. Both
  11991. // the ETag, which has to name the representation actually sent, and
  11992. // `apply_static_file_compression()` go through this, so the two cannot drift
  11993. // apart.
  11994. inline detail::EncodingType
  11995. Server::static_file_encoding(const Request &req, const Response &res,
  11996. const std::string &content_type,
  11997. size_t length) const {
  11998. if (!static_file_compression_) { return detail::EncodingType::None; }
  11999. // Nothing to compress, and an empty file already answers with
  12000. // `Content-Length: 0`. Checked on its own so that a zero floor still cannot
  12001. // turn an empty body into a 20-byte gzip stream.
  12002. if (length == 0) { return detail::EncodingType::None; }
  12003. // A file that already fits in a single packet gains nothing from being made
  12004. // smaller, since it still travels in that one segment, and a file of a few
  12005. // bytes comes out larger than it went in.
  12006. if (length < static_file_compression_min_length_) {
  12007. return detail::EncodingType::None;
  12008. }
  12009. // RFC 9110 applies Range to the representation after content coding, so a
  12010. // compressed 206 would mean compressing the whole file and then slicing it.
  12011. // Serve ranges from the identity representation instead.
  12012. if (!req.ranges.empty()) { return detail::EncodingType::None; }
  12013. if (static_file_compression_max_length_ > 0 &&
  12014. length > static_file_compression_max_length_) {
  12015. return detail::EncodingType::None;
  12016. }
  12017. return detail::encoding_type(req, res, content_type);
  12018. }
  12019. // Compresses a file-backed content provider into `res.body` and takes over the
  12020. // framing headers. Returns false when the response is left untouched.
  12021. inline bool Server::apply_static_file_compression(const Request &req,
  12022. Response &res) const {
  12023. auto type = res.content_coding_;
  12024. if (type == detail::EncodingType::None || !res.content_provider_) {
  12025. return false;
  12026. }
  12027. auto compressor = detail::make_compressor(type);
  12028. if (!compressor) { return false; }
  12029. output_pre_compression_log(req, res);
  12030. std::string compressed;
  12031. if (!detail::compress_content_provider(res.content_provider_,
  12032. res.content_length_, *compressor,
  12033. compressed)) {
  12034. return false;
  12035. }
  12036. res.body.swap(compressed);
  12037. // The provider was consumed in full, so a resource releaser registered with
  12038. // it should hear about a success when the response goes away.
  12039. res.content_provider_success_ = true;
  12040. res.content_provider_ = nullptr;
  12041. res.content_length_ = 0;
  12042. res.content_coding_ = detail::EncodingType::None;
  12043. res.set_header("Content-Encoding", detail::encoding_name(type));
  12044. res.set_header("Vary", "Accept-Encoding");
  12045. res.set_header("Content-Length", std::to_string(res.body.size()));
  12046. return true;
  12047. }
  12048. inline void Server::apply_ranges(const Request &req, Response &res,
  12049. std::string &content_type,
  12050. std::string &boundary) const {
  12051. // A known-length content provider leaves `res.body` empty, so the compressor
  12052. // at the end of this function never runs for one (issue #2545). A file-backed
  12053. // provider is fully readable right here, so compress it and answer with an
  12054. // ordinary body: `Content-Length` and HEAD keep working, and the response
  12055. // takes the same path as `set_content()` from here on. Range requests never
  12056. // get a content coding, so `Content-Range` still names identity bytes and
  12057. // none of the framing below applies.
  12058. if (apply_static_file_compression(req, res)) { return; }
  12059. if (req.ranges.size() > 1 && res.status == StatusCode::PartialContent_206) {
  12060. auto it = res.headers.find("Content-Type");
  12061. if (it != res.headers.end()) {
  12062. content_type = it->second;
  12063. res.headers.erase(it);
  12064. }
  12065. boundary = detail::make_multipart_data_boundary();
  12066. res.set_header("Content-Type",
  12067. "multipart/byteranges; boundary=" + boundary);
  12068. }
  12069. auto type = detail::encoding_type(req, res);
  12070. if (res.body.empty()) {
  12071. if (res.content_length_ > 0) {
  12072. size_t length = 0;
  12073. if (req.ranges.empty() || res.status != StatusCode::PartialContent_206) {
  12074. length = res.content_length_;
  12075. } else if (req.ranges.size() == 1) {
  12076. auto offset_and_length = detail::get_range_offset_and_length(
  12077. req.ranges[0], res.content_length_);
  12078. length = offset_and_length.second;
  12079. auto content_range = detail::make_content_range_header_field(
  12080. offset_and_length, res.content_length_);
  12081. res.set_header("Content-Range", content_range);
  12082. } else {
  12083. length = detail::get_multipart_ranges_data_length(
  12084. req, boundary, content_type, res.content_length_);
  12085. }
  12086. res.set_header("Content-Length", std::to_string(length));
  12087. } else {
  12088. if (res.content_provider_) {
  12089. if (res.is_chunked_content_provider_) {
  12090. res.set_header("Transfer-Encoding", "chunked");
  12091. res.content_coding_ = type;
  12092. if (type != detail::EncodingType::None) {
  12093. res.set_header("Content-Encoding", detail::encoding_name(type));
  12094. res.set_header("Vary", "Accept-Encoding");
  12095. }
  12096. }
  12097. }
  12098. }
  12099. } else {
  12100. if (req.ranges.empty() || res.status != StatusCode::PartialContent_206) {
  12101. ;
  12102. } else if (req.ranges.size() == 1) {
  12103. auto offset_and_length =
  12104. detail::get_range_offset_and_length(req.ranges[0], res.body.size());
  12105. auto offset = offset_and_length.first;
  12106. auto length = offset_and_length.second;
  12107. auto content_range = detail::make_content_range_header_field(
  12108. offset_and_length, res.body.size());
  12109. res.set_header("Content-Range", content_range);
  12110. assert(offset + length <= res.body.size());
  12111. res.body = res.body.substr(offset, length);
  12112. } else {
  12113. std::string data;
  12114. detail::make_multipart_ranges_data(req, res, boundary, content_type,
  12115. res.body.size(), data);
  12116. res.body.swap(data);
  12117. }
  12118. if (type != detail::EncodingType::None) {
  12119. output_pre_compression_log(req, res);
  12120. if (auto compressor = detail::make_compressor(type)) {
  12121. std::string compressed;
  12122. if (compressor->compress(res.body.data(), res.body.size(), true,
  12123. [&](const char *data, size_t data_len) {
  12124. compressed.append(data, data_len);
  12125. return true;
  12126. })) {
  12127. res.body.swap(compressed);
  12128. res.set_header("Content-Encoding", detail::encoding_name(type));
  12129. res.set_header("Vary", "Accept-Encoding");
  12130. }
  12131. }
  12132. }
  12133. res.content_length_ = res.body.size();
  12134. res.set_header("Content-Length", std::to_string(res.content_length_));
  12135. }
  12136. }
  12137. inline bool Server::dispatch_request_for_content_reader(
  12138. Request &req, Response &res, ContentReader content_reader,
  12139. const HandlersForContentReader &handlers) const {
  12140. for (const auto &x : handlers) {
  12141. const auto &matcher = x.first;
  12142. const auto &handler = x.second;
  12143. if (matcher->match(req)) {
  12144. req.matched_route = matcher->pattern();
  12145. if (!pre_request_handler_ ||
  12146. pre_request_handler_(req, res) != HandlerResponse::Handled) {
  12147. handler(req, res, content_reader);
  12148. }
  12149. return true;
  12150. }
  12151. }
  12152. return false;
  12153. }
  12154. inline std::string
  12155. get_client_ip(const std::string &x_forwarded_for,
  12156. const std::vector<std::string> &trusted_proxies) {
  12157. // X-Forwarded-For is a comma-separated list per RFC 7239
  12158. std::vector<std::string> ip_list;
  12159. detail::split(x_forwarded_for.data(),
  12160. x_forwarded_for.data() + x_forwarded_for.size(), ',',
  12161. [&](const char *b, const char *e) {
  12162. auto r = detail::trim(b, e, 0, static_cast<size_t>(e - b));
  12163. ip_list.emplace_back(std::string(b + r.first, b + r.second));
  12164. });
  12165. // A malformed X-Forwarded-For (empty, comma-only, whitespace-only) yields
  12166. // no segments. Signal "no client IP derived" with an empty string so the
  12167. // caller can fall back to the connection-level remote address.
  12168. if (ip_list.empty()) { return std::string(); }
  12169. // Each hop appends the address it received the request from, so the rightmost
  12170. // entries are the ones written by our own infrastructure while the leftmost
  12171. // are whatever the original client chose to send. Walk from the right and
  12172. // skip trusted proxies; the first address that is not a trusted proxy is the
  12173. // furthest point still attributable to a real hop, i.e. the client. Scanning
  12174. // from the left instead lets a client forge an arbitrary address by following
  12175. // it with a trusted proxy's address, which the left-to-right scan then
  12176. // returned as the client.
  12177. for (size_t i = ip_list.size(); i-- > 0;) {
  12178. const auto &ip = ip_list[i];
  12179. auto is_trusted_proxy =
  12180. std::any_of(trusted_proxies.begin(), trusted_proxies.end(),
  12181. [&](const std::string &proxy) { return ip == proxy; });
  12182. if (!is_trusted_proxy) { return ip; }
  12183. }
  12184. // Every hop was a trusted proxy; fall back to the first entry.
  12185. return ip_list.front();
  12186. }
  12187. inline bool
  12188. Server::process_request(Stream &strm, const std::string &remote_addr,
  12189. int remote_port, const std::string &local_addr,
  12190. int local_port, bool close_connection,
  12191. bool &connection_closed,
  12192. const std::function<void(Request &)> &setup_request,
  12193. bool *websocket_upgraded) {
  12194. std::array<char, 2048> buf{};
  12195. detail::stream_line_reader line_reader(strm, buf.data(), buf.size());
  12196. // Connection has been closed on client
  12197. if (!line_reader.getline()) { return false; }
  12198. Request req;
  12199. req.start_time_ = std::chrono::steady_clock::now();
  12200. req.remote_addr = remote_addr;
  12201. req.remote_port = remote_port;
  12202. req.local_addr = local_addr;
  12203. req.local_port = local_port;
  12204. Response res;
  12205. res.version = "HTTP/1.1";
  12206. res.headers = default_headers_;
  12207. // RFC 9112 §9.6: a server that sends the "close" connection option must
  12208. // close the connection after that response, whichever path wrote it (an
  12209. // error status, a handler, or a rejected request). Reading on would also
  12210. // parse whatever the client sent next on a connection it considers done.
  12211. auto honor_connection_close = detail::scope_exit([&] {
  12212. if (detail::has_header_token(res.headers, "Connection", "close")) {
  12213. connection_closed = true;
  12214. }
  12215. });
  12216. // Request line and headers. A rejected message leaves the rest of it (and
  12217. // any body) unread, so the connection cannot be reused: the leftover bytes
  12218. // would be parsed as the next request.
  12219. if (!parse_request_line(line_reader.ptr(), req)) {
  12220. connection_closed = true;
  12221. res.status = StatusCode::BadRequest_400;
  12222. output_error_log(Error::InvalidRequestLine, &req);
  12223. return write_response(strm, close_connection, req, res);
  12224. }
  12225. // Request headers
  12226. if (!detail::read_headers(strm, req.headers)) {
  12227. connection_closed = true;
  12228. res.status = StatusCode::BadRequest_400;
  12229. output_error_log(Error::InvalidHeaders, &req);
  12230. return write_response(strm, close_connection, req, res);
  12231. }
  12232. // RFC 9112 §6.3: Reject requests whose framing is invalid or ambiguous,
  12233. // which would otherwise let an intermediary and this parser disagree on
  12234. // where the body ends and enable request smuggling. Three cases: a
  12235. // Content-Length that is not a valid decimal length (e.g. "42, 42", "+42"
  12236. // or empty), which would otherwise be read as "no body"; a non-zero
  12237. // Content-Length alongside any Transfer-Encoding (Content-Length: 0 is
  12238. // tolerated for compatibility with existing clients); and a
  12239. // Transfer-Encoding whose final coding is not chunked, which leaves the body
  12240. // length undeterminable. None of them may fall through to the "no body"
  12241. // path, or the body bytes are parsed as the next request on a persistent
  12242. // connection.
  12243. auto is_invalid_content_length = false;
  12244. detail::get_header_value_u64(req.headers, "Content-Length", 0, 0,
  12245. is_invalid_content_length);
  12246. if (is_invalid_content_length ||
  12247. detail::has_conflicting_content_length(req.headers) ||
  12248. (req.has_header("Transfer-Encoding") &&
  12249. !detail::is_chunked_transfer_encoding(req.headers))) {
  12250. connection_closed = true;
  12251. res.status = StatusCode::BadRequest_400;
  12252. return write_response(strm, close_connection, req, res);
  12253. }
  12254. // Check if the request URI doesn't exceed the limit
  12255. if (req.target.size() > CPPHTTPLIB_REQUEST_URI_MAX_LENGTH) {
  12256. connection_closed = true;
  12257. res.status = StatusCode::UriTooLong_414;
  12258. output_error_log(Error::ExceedUriMaxLength, &req);
  12259. return write_response(strm, close_connection, req, res);
  12260. }
  12261. if (detail::has_header_token(req.headers, "Connection", "close")) {
  12262. connection_closed = true;
  12263. }
  12264. if (req.version == "HTTP/1.0" &&
  12265. !detail::has_header_token(req.headers, "Connection", "keep-alive")) {
  12266. connection_closed = true;
  12267. }
  12268. // Only honor X-Forwarded-For if the peer on the actual TCP connection is
  12269. // itself a trusted proxy. Otherwise any direct client could spoof
  12270. // remote_addr simply by sending an arbitrary X-Forwarded-For header.
  12271. auto is_trusted_peer = std::any_of(
  12272. trusted_proxies_.begin(), trusted_proxies_.end(),
  12273. [&](const std::string &proxy) { return proxy == remote_addr; });
  12274. if (is_trusted_peer && req.has_header("X-Forwarded-For")) {
  12275. // Some proxies append the address they observed as a separate
  12276. // X-Forwarded-For field line instead of extending the one the client sent
  12277. // (e.g. HAProxy's "option forwardfor"), so the whole combined value has to
  12278. // be scanned. Reading only the first occurrence would hand back the
  12279. // client-supplied, and therefore forgeable, value.
  12280. auto x_forwarded_for =
  12281. detail::get_combined_header_value(req.headers, "X-Forwarded-For");
  12282. auto derived = get_client_ip(x_forwarded_for, trusted_proxies_);
  12283. req.remote_addr = derived.empty() ? remote_addr : derived;
  12284. } else {
  12285. req.remote_addr = remote_addr;
  12286. }
  12287. req.remote_port = remote_port;
  12288. req.local_addr = local_addr;
  12289. req.local_port = local_port;
  12290. if (req.has_header("Accept")) {
  12291. auto accept_header =
  12292. detail::get_combined_header_value(req.headers, "Accept");
  12293. if (!detail::parse_accept_header(accept_header, req.accept_content_types)) {
  12294. connection_closed = true;
  12295. res.status = StatusCode::BadRequest_400;
  12296. output_error_log(Error::HTTPParsing, &req);
  12297. return write_response(strm, close_connection, req, res);
  12298. }
  12299. }
  12300. if (req.has_header("Range")) {
  12301. const auto &range_header_value = req.get_header_value("Range");
  12302. if (!detail::parse_range_header(range_header_value, req.ranges)) {
  12303. connection_closed = true;
  12304. res.status = StatusCode::RangeNotSatisfiable_416;
  12305. output_error_log(Error::InvalidRangeHeader, &req);
  12306. return write_response(strm, close_connection, req, res);
  12307. }
  12308. }
  12309. if (setup_request) { setup_request(req); }
  12310. // RFC 9110 10.1.1: Expect is a comma-separated list whose value is
  12311. // case-insensitive, and a 100-continue expectation in an HTTP/1.0 request
  12312. // must be ignored. An expectation we do not recognize is left alone; the
  12313. // 417 the section allows for one is a MAY, not a requirement.
  12314. //
  12315. // `100 Continue` itself is deferred until the body is actually read (see
  12316. // read_content_core), so a request rejected by a later handler never
  12317. // invites the client to send a body nobody will read.
  12318. if (req.version != "HTTP/1.0" &&
  12319. detail::has_header_token(req.headers, "Expect", "100-continue")) {
  12320. int status = StatusCode::Continue_100;
  12321. if (expect_100_continue_handler_) {
  12322. status = expect_100_continue_handler_(req, res);
  12323. }
  12324. if (status == StatusCode::Continue_100) {
  12325. req.expect_100_continue_pending_ = true;
  12326. } else {
  12327. if (res.status == -1) { res.status = status; }
  12328. connection_closed = true;
  12329. return write_response(strm, true, req, res);
  12330. }
  12331. }
  12332. // Setup `is_connection_closed` method
  12333. auto sock = strm.socket();
  12334. req.is_connection_closed = [sock]() {
  12335. return !detail::is_socket_alive(sock);
  12336. };
  12337. // WebSocket upgrade
  12338. // Run pre_routing_handler_ and pre_request_handler_ before upgrading so
  12339. // that authentication and other middleware can reject the request with an
  12340. // HTTP response (e.g., 401) before the protocol switches.
  12341. if (detail::is_websocket_upgrade(req)) {
  12342. if (pre_routing_handler_ &&
  12343. pre_routing_handler_(req, res) == HandlerResponse::Handled) {
  12344. if (res.status == -1) { res.status = StatusCode::OK_200; }
  12345. return write_response_with_content(strm, close_connection, req, res);
  12346. }
  12347. // Find matching WebSocket handler
  12348. for (const auto &entry : websocket_handlers_) {
  12349. if (entry.matcher->match(req)) {
  12350. req.matched_route = entry.matcher->pattern();
  12351. if (pre_request_handler_ &&
  12352. pre_request_handler_(req, res) == HandlerResponse::Handled) {
  12353. if (res.status == -1) { res.status = StatusCode::OK_200; }
  12354. return write_response_with_content(strm, close_connection, req, res);
  12355. }
  12356. // Compute accept key
  12357. auto client_key = req.get_header_value("Sec-WebSocket-Key");
  12358. auto accept_key = detail::websocket_accept_key(client_key);
  12359. // Negotiate subprotocol
  12360. std::string selected_subprotocol;
  12361. if (entry.sub_protocol_selector) {
  12362. auto protocol_header = detail::get_combined_header_value(
  12363. req.headers, "Sec-WebSocket-Protocol");
  12364. if (!protocol_header.empty()) {
  12365. std::vector<std::string> protocols;
  12366. detail::split(protocol_header.data(),
  12367. protocol_header.data() + protocol_header.size(), ',',
  12368. [&](const char *b, const char *e) {
  12369. protocols.emplace_back(b, e);
  12370. });
  12371. selected_subprotocol = entry.sub_protocol_selector(protocols);
  12372. }
  12373. }
  12374. // Send 101 Switching Protocols
  12375. std::string handshake_response = "HTTP/1.1 101 Switching Protocols\r\n"
  12376. "Upgrade: websocket\r\n"
  12377. "Connection: Upgrade\r\n"
  12378. "Sec-WebSocket-Accept: " +
  12379. accept_key + "\r\n";
  12380. if (!selected_subprotocol.empty()) {
  12381. if (!detail::fields::is_field_value(selected_subprotocol)) {
  12382. return false;
  12383. }
  12384. handshake_response +=
  12385. "Sec-WebSocket-Protocol: " + selected_subprotocol + "\r\n";
  12386. }
  12387. handshake_response += "\r\n";
  12388. if (strm.write(handshake_response.data(), handshake_response.size()) <
  12389. 0) {
  12390. return false;
  12391. }
  12392. connection_closed = true;
  12393. if (websocket_upgraded) { *websocket_upgraded = true; }
  12394. {
  12395. #ifdef CPPHTTPLIB_SSL_ENABLED
  12396. if (req.ssl) {
  12397. // wss: the heartbeat ping thread and the read path enter the same
  12398. // TLS session from different threads. Hand the WebSocket a stream
  12399. // that serializes every TLS call, so the shared SSLSocketStream on
  12400. // the plain HTTP/HTTPS paths stays untouched.
  12401. auto ws_strm =
  12402. std::unique_ptr<Stream>(new detail::WebSocketSSLStream(
  12403. strm.socket(), const_cast<tls::session_t>(req.ssl),
  12404. CPPHTTPLIB_WEBSOCKET_SERVER_READ_TIMEOUT_SECOND, 0,
  12405. write_timeout_sec_, write_timeout_usec_));
  12406. ws::WebSocket ws(std::move(ws_strm), req, true,
  12407. websocket_ping_interval_sec_,
  12408. websocket_max_missed_pongs_);
  12409. entry.handler(req, ws);
  12410. return true;
  12411. }
  12412. #endif
  12413. // Use WebSocket-specific read timeout instead of HTTP timeout
  12414. strm.set_read_timeout(CPPHTTPLIB_WEBSOCKET_SERVER_READ_TIMEOUT_SECOND,
  12415. 0);
  12416. ws::WebSocket ws(strm, req, true, websocket_ping_interval_sec_,
  12417. websocket_max_missed_pongs_);
  12418. entry.handler(req, ws);
  12419. }
  12420. return true;
  12421. }
  12422. }
  12423. // No matching handler - fall through to 404
  12424. }
  12425. // Routing
  12426. auto routed = false;
  12427. #ifdef CPPHTTPLIB_NO_EXCEPTIONS
  12428. routed = routing(req, res, strm);
  12429. #else
  12430. try {
  12431. routed = routing(req, res, strm);
  12432. } catch (std::exception &) {
  12433. if (exception_handler_) {
  12434. auto ep = std::current_exception();
  12435. exception_handler_(req, res, ep);
  12436. routed = true;
  12437. } else {
  12438. res.status = StatusCode::InternalServerError_500;
  12439. }
  12440. } catch (...) {
  12441. if (exception_handler_) {
  12442. auto ep = std::current_exception();
  12443. exception_handler_(req, res, ep);
  12444. routed = true;
  12445. } else {
  12446. res.status = StatusCode::InternalServerError_500;
  12447. }
  12448. }
  12449. #endif
  12450. auto ret = false;
  12451. if (routed) {
  12452. if (res.status == -1) {
  12453. res.status = req.ranges.empty() ? StatusCode::OK_200
  12454. : StatusCode::PartialContent_206;
  12455. }
  12456. // Serve file content by using a content provider
  12457. auto file_open_error = false;
  12458. if (!res.file_content_path_.empty()) {
  12459. const auto &path = res.file_content_path_;
  12460. auto mm = std::make_shared<detail::mmap>(path.c_str());
  12461. if (!mm->is_open()) {
  12462. res.body.clear();
  12463. res.content_length_ = 0;
  12464. res.content_provider_ = nullptr;
  12465. res.status = StatusCode::NotFound_404;
  12466. output_error_log(Error::OpenFile, &req);
  12467. file_open_error = true;
  12468. } else {
  12469. auto content_type = res.file_content_content_type_;
  12470. if (content_type.empty()) {
  12471. content_type = detail::find_content_type(
  12472. path, file_extension_and_mimetype_map_, default_file_mimetype_);
  12473. }
  12474. detail::set_file_content_provider(
  12475. res, mm, content_type,
  12476. static_file_encoding(req, res, content_type, mm->size()));
  12477. }
  12478. }
  12479. if (file_open_error) {
  12480. ret = write_response(strm, close_connection, req, res);
  12481. } else if (detail::range_error(req, res)) {
  12482. res.body.clear();
  12483. res.content_length_ = 0;
  12484. res.content_provider_ = nullptr;
  12485. res.status = StatusCode::RangeNotSatisfiable_416;
  12486. ret = write_response(strm, close_connection, req, res);
  12487. } else {
  12488. ret = write_response_with_content(strm, close_connection, req, res);
  12489. }
  12490. } else {
  12491. if (res.status == -1) { res.status = StatusCode::NotFound_404; }
  12492. ret = write_response(strm, close_connection, req, res);
  12493. }
  12494. // Drain any unconsumed framed body to prevent request smuggling on
  12495. // keep-alive. Without framing there is no body to drain — reading would
  12496. // consume the next request (issue #2450). If the response has committed the
  12497. // connection to close, there is no next request to protect.
  12498. if (!req.body_consumed_ && detail::has_framed_body(req) &&
  12499. !detail::has_header_token(res.headers, "Connection", "close")) {
  12500. int dummy_status;
  12501. if (!detail::read_content(
  12502. strm, req, payload_max_length_, dummy_status, nullptr,
  12503. [](const char *, size_t, size_t, size_t) { return true; }, false)) {
  12504. connection_closed = true;
  12505. }
  12506. }
  12507. return ret;
  12508. }
  12509. inline bool Server::is_valid() const { return !has_invalid_registration_; }
  12510. inline bool Server::process_and_close_socket(socket_t sock) {
  12511. std::string remote_addr;
  12512. int remote_port = 0;
  12513. detail::get_remote_ip_and_port(sock, remote_addr, remote_port);
  12514. std::string local_addr;
  12515. int local_port = 0;
  12516. detail::get_local_ip_and_port(sock, local_addr, local_port);
  12517. bool websocket_upgraded = false;
  12518. auto ret = serve_guarded([&]() {
  12519. return detail::process_server_socket(
  12520. svr_sock_, sock, keep_alive_max_count_, keep_alive_timeout_sec_,
  12521. read_timeout_sec_, read_timeout_usec_, write_timeout_sec_,
  12522. write_timeout_usec_,
  12523. [&](Stream &strm, bool close_connection, bool &connection_closed) {
  12524. return process_request(strm, remote_addr, remote_port, local_addr,
  12525. local_port, close_connection,
  12526. connection_closed, nullptr,
  12527. &websocket_upgraded);
  12528. });
  12529. });
  12530. detail::drain_and_close_socket(sock);
  12531. return ret;
  12532. }
  12533. inline void Server::output_log(const Request &req, const Response &res) const {
  12534. if (logger_) {
  12535. std::lock_guard<std::mutex> guard(logger_mutex_);
  12536. logger_(req, res);
  12537. }
  12538. }
  12539. inline void Server::output_pre_compression_log(const Request &req,
  12540. const Response &res) const {
  12541. if (pre_compression_logger_) {
  12542. std::lock_guard<std::mutex> guard(logger_mutex_);
  12543. pre_compression_logger_(req, res);
  12544. }
  12545. }
  12546. inline void Server::output_error_log(const Error &err,
  12547. const Request *req) const {
  12548. if (error_logger_) {
  12549. std::lock_guard<std::mutex> guard(logger_mutex_);
  12550. error_logger_(err, req);
  12551. }
  12552. }
  12553. /*
  12554. * Group 5: ClientImpl and Client (Universal) implementation
  12555. */
  12556. // HTTP client implementation
  12557. inline ClientImpl::ClientImpl(const std::string &host)
  12558. : ClientImpl(host, 80, std::string(), std::string()) {}
  12559. inline ClientImpl::ClientImpl(const std::string &host, int port)
  12560. : ClientImpl(host, port, std::string(), std::string()) {}
  12561. inline ClientImpl::ClientImpl(const std::string &host, int port,
  12562. const std::string &client_cert_path,
  12563. const std::string &client_key_path)
  12564. : host_(detail::escape_abstract_namespace_unix_domain(host)), port_(port),
  12565. client_cert_path_(client_cert_path), client_key_path_(client_key_path) {}
  12566. inline ClientImpl::~ClientImpl() {
  12567. // Wait until all the requests in flight are handled.
  12568. size_t retry_count = 10;
  12569. while (retry_count-- > 0) {
  12570. {
  12571. std::lock_guard<std::mutex> guard(socket_mutex_);
  12572. if (socket_requests_in_flight_ == 0) { break; }
  12573. }
  12574. std::this_thread::sleep_for(std::chrono::milliseconds{1});
  12575. }
  12576. std::lock_guard<std::mutex> guard(socket_mutex_);
  12577. shutdown_socket(socket_);
  12578. close_socket(socket_);
  12579. }
  12580. inline bool ClientImpl::is_valid() const { return true; }
  12581. inline void ClientImpl::copy_settings(const ClientImpl &rhs) {
  12582. client_cert_path_ = rhs.client_cert_path_;
  12583. client_key_path_ = rhs.client_key_path_;
  12584. connection_timeout_sec_ = rhs.connection_timeout_sec_;
  12585. read_timeout_sec_ = rhs.read_timeout_sec_;
  12586. read_timeout_usec_ = rhs.read_timeout_usec_;
  12587. write_timeout_sec_ = rhs.write_timeout_sec_;
  12588. write_timeout_usec_ = rhs.write_timeout_usec_;
  12589. max_timeout_msec_ = rhs.max_timeout_msec_;
  12590. basic_auth_username_ = rhs.basic_auth_username_;
  12591. basic_auth_password_ = rhs.basic_auth_password_;
  12592. bearer_token_auth_token_ = rhs.bearer_token_auth_token_;
  12593. keep_alive_ = rhs.keep_alive_;
  12594. follow_location_ = rhs.follow_location_;
  12595. path_encode_ = rhs.path_encode_;
  12596. address_family_ = rhs.address_family_;
  12597. tcp_nodelay_ = rhs.tcp_nodelay_;
  12598. ipv6_v6only_ = rhs.ipv6_v6only_;
  12599. socket_options_ = rhs.socket_options_;
  12600. compress_ = rhs.compress_;
  12601. decompress_ = rhs.decompress_;
  12602. payload_max_length_ = rhs.payload_max_length_;
  12603. has_payload_max_length_ = rhs.has_payload_max_length_;
  12604. interface_ = rhs.interface_;
  12605. proxy_host_ = rhs.proxy_host_;
  12606. proxy_port_ = rhs.proxy_port_;
  12607. proxy_basic_auth_username_ = rhs.proxy_basic_auth_username_;
  12608. proxy_basic_auth_password_ = rhs.proxy_basic_auth_password_;
  12609. proxy_bearer_token_auth_token_ = rhs.proxy_bearer_token_auth_token_;
  12610. no_proxy_entries_ = rhs.no_proxy_entries_;
  12611. logger_ = rhs.logger_;
  12612. error_logger_ = rhs.error_logger_;
  12613. #ifdef CPPHTTPLIB_SSL_ENABLED
  12614. digest_auth_username_ = rhs.digest_auth_username_;
  12615. digest_auth_password_ = rhs.digest_auth_password_;
  12616. proxy_digest_auth_username_ = rhs.proxy_digest_auth_username_;
  12617. proxy_digest_auth_password_ = rhs.proxy_digest_auth_password_;
  12618. ca_cert_file_path_ = rhs.ca_cert_file_path_;
  12619. ca_cert_dir_path_ = rhs.ca_cert_dir_path_;
  12620. server_certificate_verification_ = rhs.server_certificate_verification_;
  12621. server_hostname_verification_ = rhs.server_hostname_verification_;
  12622. system_ca_mode_ = rhs.system_ca_mode_;
  12623. #endif
  12624. }
  12625. inline bool
  12626. ClientImpl::is_proxy_enabled_for_host(const std::string &host) const {
  12627. if (proxy_host_.empty() || proxy_port_ == -1) { return false; }
  12628. if (no_proxy_entries_.empty()) { return true; }
  12629. // host_ is const so its normalized form is invariant; cache it. The
  12630. // cross-host path (setup_redirect_client passing next_host) re-normalizes.
  12631. if (host == host_) {
  12632. if (!host_normalized_valid_) {
  12633. host_normalized_ = detail::normalize_target(host_);
  12634. host_normalized_valid_ = true;
  12635. }
  12636. return !detail::host_matches_no_proxy(host_normalized_, no_proxy_entries_);
  12637. }
  12638. auto target = detail::normalize_target(host);
  12639. return !detail::host_matches_no_proxy(target, no_proxy_entries_);
  12640. }
  12641. inline socket_t ClientImpl::create_client_socket(Error &error) const {
  12642. if (is_proxy_enabled_for_host(host_)) {
  12643. return detail::create_client_socket(
  12644. proxy_host_, std::string(), proxy_port_, address_family_, tcp_nodelay_,
  12645. ipv6_v6only_, socket_options_, connection_timeout_sec_,
  12646. connection_timeout_usec_, read_timeout_sec_, read_timeout_usec_,
  12647. write_timeout_sec_, write_timeout_usec_, interface_, error);
  12648. }
  12649. // Check is custom IP or hostname specified for host_
  12650. std::string connect_host;
  12651. std::string ip;
  12652. detail::apply_addr_map(addr_map_, host_, connect_host, ip);
  12653. return detail::create_client_socket(
  12654. connect_host, ip, port_, address_family_, tcp_nodelay_, ipv6_v6only_,
  12655. socket_options_, connection_timeout_sec_, connection_timeout_usec_,
  12656. read_timeout_sec_, read_timeout_usec_, write_timeout_sec_,
  12657. write_timeout_usec_, interface_, error);
  12658. }
  12659. inline bool ClientImpl::create_and_connect_socket(Socket &socket,
  12660. Error &error) {
  12661. auto sock = create_client_socket(error);
  12662. if (sock == INVALID_SOCKET) { return false; }
  12663. socket.sock = sock;
  12664. return true;
  12665. }
  12666. inline bool ClientImpl::ensure_socket_connection(Socket &socket, Error &error) {
  12667. return create_and_connect_socket(socket, error);
  12668. }
  12669. inline bool ClientImpl::setup_proxy_connection(
  12670. Socket & /*socket*/,
  12671. std::chrono::time_point<std::chrono::steady_clock> /*start_time*/,
  12672. Response & /*res*/, bool & /*success*/, Error & /*error*/) {
  12673. return true;
  12674. }
  12675. inline void ClientImpl::shutdown_ssl(Socket & /*socket*/,
  12676. bool /*shutdown_gracefully*/) {
  12677. // If there are any requests in flight from threads other than us, then it's
  12678. // a thread-unsafe race because individual ssl* objects are not thread-safe.
  12679. assert(socket_requests_in_flight_ == 0 ||
  12680. socket_requests_are_from_thread_ == std::this_thread::get_id());
  12681. }
  12682. inline void ClientImpl::shutdown_socket(Socket &socket) const {
  12683. if (socket.sock == INVALID_SOCKET) { return; }
  12684. detail::shutdown_socket(socket.sock);
  12685. }
  12686. inline void ClientImpl::close_socket(Socket &socket) {
  12687. // If there are requests in flight in another thread, usually closing
  12688. // the socket will be fine and they will simply receive an error when
  12689. // using the closed socket, but it is still a bug since rarely the OS
  12690. // may reassign the socket id to be used for a new socket, and then
  12691. // suddenly they will be operating on a live socket that is different
  12692. // than the one they intended!
  12693. assert(socket_requests_in_flight_ == 0 ||
  12694. socket_requests_are_from_thread_ == std::this_thread::get_id());
  12695. // It is also a bug if this happens while SSL is still active
  12696. #ifdef CPPHTTPLIB_SSL_ENABLED
  12697. assert(socket.ssl == nullptr);
  12698. #endif
  12699. if (socket.sock == INVALID_SOCKET) { return; }
  12700. detail::close_socket(socket.sock);
  12701. socket.sock = INVALID_SOCKET;
  12702. }
  12703. inline void ClientImpl::disconnect(bool gracefully) {
  12704. shutdown_ssl(socket_, gracefully);
  12705. shutdown_socket(socket_);
  12706. close_socket(socket_);
  12707. }
  12708. inline bool ClientImpl::read_response_line(Stream &strm, const Request &req,
  12709. Response &res,
  12710. bool skip_100_continue) const {
  12711. std::array<char, 2048> buf{};
  12712. detail::stream_line_reader line_reader(strm, buf.data(), buf.size());
  12713. if (!line_reader.getline()) { return false; }
  12714. if (!detail::parse_status_line(line_reader.ptr(), res.version, res.status,
  12715. res.reason)) {
  12716. return req.method == "CONNECT";
  12717. }
  12718. // Ignore '100 Continue' (only when not using Expect: 100-continue explicitly)
  12719. while (skip_100_continue && res.status == StatusCode::Continue_100) {
  12720. if (!line_reader.getline()) { return false; } // CRLF
  12721. if (!line_reader.getline()) { return false; } // next response line
  12722. if (!detail::parse_status_line(line_reader.ptr(), res.version, res.status,
  12723. res.reason)) {
  12724. return false;
  12725. }
  12726. }
  12727. return true;
  12728. }
  12729. inline bool ClientImpl::send(Request &req, Response &res, Error &error) {
  12730. std::lock_guard<std::recursive_mutex> request_mutex_guard(request_mutex_);
  12731. auto ret = send_(req, res, error);
  12732. if (error == Error::SSLPeerCouldBeClosed_) {
  12733. assert(!ret);
  12734. ret = send_(req, res, error);
  12735. // If still failing with SSLPeerCouldBeClosed_, convert to Read error
  12736. if (error == Error::SSLPeerCouldBeClosed_) { error = Error::Read; }
  12737. }
  12738. return ret;
  12739. }
  12740. inline bool ClientImpl::send_(Request &req, Response &res, Error &error) {
  12741. {
  12742. std::lock_guard<std::mutex> guard(socket_mutex_);
  12743. // Set this to false immediately - if it ever gets set to true by the end
  12744. // of the request, we know another thread instructed us to close the
  12745. // socket.
  12746. socket_should_be_closed_when_request_is_done_ = false;
  12747. auto is_alive = false;
  12748. if (socket_.is_open()) {
  12749. is_alive = detail::is_socket_alive(socket_.sock);
  12750. #ifdef CPPHTTPLIB_SSL_ENABLED
  12751. if (is_alive && is_ssl()) {
  12752. if (tls::is_peer_closed(socket_.ssl, socket_.sock)) {
  12753. is_alive = false;
  12754. }
  12755. }
  12756. #endif
  12757. if (!is_alive) {
  12758. // Peer seems gone — non-graceful shutdown to avoid SIGPIPE.
  12759. disconnect(/*gracefully=*/false);
  12760. }
  12761. }
  12762. if (!is_alive) {
  12763. if (!ensure_socket_connection(socket_, error)) {
  12764. output_error_log(error, &req);
  12765. return false;
  12766. }
  12767. {
  12768. auto success = true;
  12769. if (!setup_proxy_connection(socket_, req.start_time_, res, success,
  12770. error)) {
  12771. if (!success) { output_error_log(error, &req); }
  12772. return success;
  12773. }
  12774. }
  12775. }
  12776. // Mark the current socket as being in use so that it cannot be closed by
  12777. // anyone else while this request is ongoing, even though we will be
  12778. // releasing the mutex.
  12779. if (socket_requests_in_flight_ > 1) {
  12780. assert(socket_requests_are_from_thread_ == std::this_thread::get_id());
  12781. }
  12782. socket_requests_in_flight_ += 1;
  12783. socket_requests_are_from_thread_ = std::this_thread::get_id();
  12784. }
  12785. for (const auto &header : default_headers_) {
  12786. if (req.headers.find(header.first) == req.headers.end()) {
  12787. req.headers.insert(header);
  12788. }
  12789. }
  12790. auto ret = false;
  12791. auto close_connection = !keep_alive_;
  12792. auto se = detail::scope_exit([&]() {
  12793. // Briefly lock mutex in order to mark that a request is no longer ongoing
  12794. std::lock_guard<std::mutex> guard(socket_mutex_);
  12795. socket_requests_in_flight_ -= 1;
  12796. if (socket_requests_in_flight_ <= 0) {
  12797. assert(socket_requests_in_flight_ == 0);
  12798. socket_requests_are_from_thread_ = std::thread::id();
  12799. }
  12800. if (socket_should_be_closed_when_request_is_done_ || close_connection ||
  12801. !ret) {
  12802. disconnect(/*gracefully=*/true);
  12803. }
  12804. });
  12805. ret = process_socket(socket_, req.start_time_, [&](Stream &strm) {
  12806. return handle_request(strm, req, res, close_connection, error);
  12807. });
  12808. if (!ret) {
  12809. if (error == Error::Success) {
  12810. error = Error::Unknown;
  12811. output_error_log(error, &req);
  12812. }
  12813. }
  12814. return ret;
  12815. }
  12816. inline Result ClientImpl::send(const Request &req) {
  12817. auto req2 = req;
  12818. return send_(std::move(req2));
  12819. }
  12820. inline Result ClientImpl::send_(Request &&req) {
  12821. auto res = detail::make_unique<Response>();
  12822. auto error = Error::Success;
  12823. auto ret = send(req, *res, error);
  12824. #ifdef CPPHTTPLIB_SSL_ENABLED
  12825. return Result{ret ? std::move(res) : nullptr, error, std::move(req.headers),
  12826. last_ssl_error_, last_backend_error_};
  12827. #else
  12828. return Result{ret ? std::move(res) : nullptr, error, std::move(req.headers)};
  12829. #endif
  12830. }
  12831. inline void ClientImpl::prepare_default_headers(Request &r, bool for_stream,
  12832. const std::string &ct) {
  12833. (void)for_stream;
  12834. // Default headers are meant for the origin and may carry its credentials, so
  12835. // keep them off the CONNECT request the proxy reads.
  12836. if (r.method != "CONNECT") {
  12837. for (const auto &header : default_headers_) {
  12838. if (!r.has_header(header.first)) { r.headers.insert(header); }
  12839. }
  12840. }
  12841. // RFC 9110 5.3 recommends sending control data such as Host first, so
  12842. // prepend it rather than appending it after the caller's own fields.
  12843. if (!r.has_header("Host")) {
  12844. r.headers.emplace_front(
  12845. "Host", detail::make_default_host_header_value(host_, port_, is_ssl(),
  12846. address_family_));
  12847. }
  12848. if (!r.has_header("Accept")) { r.headers.emplace("Accept", "*/*"); }
  12849. if (!r.content_receiver) {
  12850. if (!r.has_header("Accept-Encoding")) {
  12851. std::string accept_encoding;
  12852. #ifdef CPPHTTPLIB_BROTLI_SUPPORT
  12853. accept_encoding = "br";
  12854. #endif
  12855. #ifdef CPPHTTPLIB_ZLIB_SUPPORT
  12856. if (!accept_encoding.empty()) { accept_encoding += ", "; }
  12857. accept_encoding += "gzip, deflate";
  12858. #endif
  12859. #ifdef CPPHTTPLIB_ZSTD_SUPPORT
  12860. if (!accept_encoding.empty()) { accept_encoding += ", "; }
  12861. accept_encoding += "zstd";
  12862. #endif
  12863. r.set_header("Accept-Encoding", accept_encoding);
  12864. }
  12865. detail::add_default_user_agent_header(r);
  12866. }
  12867. if (!r.body.empty()) {
  12868. if (!ct.empty() && !r.has_header("Content-Type")) {
  12869. r.headers.emplace("Content-Type", ct);
  12870. }
  12871. if (!r.has_header("Content-Length")) {
  12872. r.headers.emplace("Content-Length", std::to_string(r.body.size()));
  12873. }
  12874. }
  12875. }
  12876. inline ClientImpl::StreamHandle
  12877. ClientImpl::open_stream(const std::string &method, const std::string &path,
  12878. const Params &params, const Headers &headers,
  12879. const std::string &body,
  12880. const std::string &content_type) {
  12881. StreamHandle handle;
  12882. handle.response = detail::make_unique<Response>();
  12883. handle.error = Error::Success;
  12884. // Encode the target exactly like the buffered send path does, so that the
  12885. // same `path` produces the same request line through either API.
  12886. auto raw_query_path =
  12887. params.empty() ? path : append_query_params(path, params);
  12888. auto query_path = detail::encode_request_target(raw_query_path, path_encode_);
  12889. handle.connection_ = detail::make_unique<ClientConnection>();
  12890. {
  12891. std::lock_guard<std::mutex> guard(socket_mutex_);
  12892. auto is_alive = false;
  12893. if (socket_.is_open()) {
  12894. is_alive = detail::is_socket_alive(socket_.sock);
  12895. #ifdef CPPHTTPLIB_SSL_ENABLED
  12896. if (is_alive && is_ssl()) {
  12897. if (tls::is_peer_closed(socket_.ssl, socket_.sock)) {
  12898. is_alive = false;
  12899. }
  12900. }
  12901. #endif
  12902. if (!is_alive) { disconnect(/*gracefully=*/false); }
  12903. }
  12904. if (!is_alive) {
  12905. if (!ensure_socket_connection(socket_, handle.error)) {
  12906. handle.response.reset();
  12907. return handle;
  12908. }
  12909. {
  12910. auto success = true;
  12911. auto start_time = std::chrono::steady_clock::now();
  12912. if (!setup_proxy_connection(socket_, start_time, *handle.response,
  12913. success, handle.error)) {
  12914. if (!success) { handle.response.reset(); }
  12915. return handle;
  12916. }
  12917. }
  12918. }
  12919. transfer_socket_ownership_to_handle(handle);
  12920. }
  12921. #ifdef CPPHTTPLIB_SSL_ENABLED
  12922. if (is_ssl() && handle.connection_->session) {
  12923. handle.socket_stream_ = detail::make_unique<detail::SSLSocketStream>(
  12924. handle.connection_->sock, handle.connection_->session,
  12925. read_timeout_sec_, read_timeout_usec_, write_timeout_sec_,
  12926. write_timeout_usec_);
  12927. } else {
  12928. handle.socket_stream_ = detail::make_unique<detail::SocketStream>(
  12929. handle.connection_->sock, read_timeout_sec_, read_timeout_usec_,
  12930. write_timeout_sec_, write_timeout_usec_);
  12931. }
  12932. #else
  12933. handle.socket_stream_ = detail::make_unique<detail::SocketStream>(
  12934. handle.connection_->sock, read_timeout_sec_, read_timeout_usec_,
  12935. write_timeout_sec_, write_timeout_usec_);
  12936. #endif
  12937. handle.stream_ = handle.socket_stream_.get();
  12938. Request req;
  12939. req.method = method;
  12940. req.path = query_path;
  12941. req.headers = headers;
  12942. req.body = body;
  12943. prepare_default_headers(req, true, content_type);
  12944. auto &strm = *handle.stream_;
  12945. // Build the request line and headers in memory first, like write_request()
  12946. // does, so that a rejected header leaves nothing on the wire.
  12947. {
  12948. detail::BufferStream bstrm;
  12949. if (detail::write_request_line(bstrm, req.method, req.path) < 0) {
  12950. handle.error = Error::Write;
  12951. handle.response.reset();
  12952. return handle;
  12953. }
  12954. if (!detail::check_and_write_headers(bstrm, req.headers, header_writer_,
  12955. handle.error)) {
  12956. handle.response.reset();
  12957. return handle;
  12958. }
  12959. const auto &data = bstrm.get_buffer();
  12960. if (!detail::write_data(strm, data.data(), data.size())) {
  12961. handle.error = Error::Write;
  12962. handle.response.reset();
  12963. return handle;
  12964. }
  12965. }
  12966. if (!body.empty()) {
  12967. if (strm.write(body.data(), body.size()) < 0) {
  12968. handle.error = Error::Write;
  12969. handle.response.reset();
  12970. return handle;
  12971. }
  12972. }
  12973. if (!read_response_line(strm, req, *handle.response) ||
  12974. !detail::read_headers(strm, handle.response->headers)) {
  12975. handle.error = Error::Read;
  12976. handle.response.reset();
  12977. return handle;
  12978. }
  12979. // Same framing check as ClientImpl::process_request(). A HEAD or bodyless
  12980. // (204/304) response legitimately carries framing headers with no body.
  12981. if (method != "HEAD" &&
  12982. handle.response->status != StatusCode::NoContent_204 &&
  12983. handle.response->status != StatusCode::NotModified_304 &&
  12984. detail::has_conflicting_content_length(handle.response->headers)) {
  12985. handle.error = Error::Read;
  12986. handle.response.reset();
  12987. return handle;
  12988. }
  12989. handle.body_reader_.stream = handle.stream_;
  12990. handle.body_reader_.payload_max_length = payload_max_length_;
  12991. if (handle.response->has_header("Content-Length")) {
  12992. bool is_invalid = false;
  12993. auto content_length = detail::get_header_value_u64(
  12994. handle.response->headers, "Content-Length", 0, 0, is_invalid);
  12995. if (is_invalid) {
  12996. handle.error = Error::Read;
  12997. handle.response.reset();
  12998. return handle;
  12999. }
  13000. handle.body_reader_.has_content_length = true;
  13001. handle.body_reader_.content_length = content_length;
  13002. }
  13003. handle.body_reader_.chunked =
  13004. detail::is_chunked_transfer_encoding(handle.response->headers);
  13005. auto content_encoding = detail::get_combined_header_value(
  13006. handle.response->headers, "Content-Encoding");
  13007. if (!content_encoding.empty()) {
  13008. // Same policy as prepare_content_receiver(): reject a coding we know about
  13009. // but were not built with, pass an unrecognized one through as-is.
  13010. handle.decompressor_ = detail::create_decompressor(content_encoding);
  13011. if (!handle.decompressor_) {
  13012. if (detail::is_known_content_encoding(content_encoding)) {
  13013. handle.error = Error::UnsupportedContentEncoding;
  13014. handle.response.reset();
  13015. return handle;
  13016. }
  13017. } else if (!handle.decompressor_->is_valid()) {
  13018. handle.error = Error::Compression;
  13019. handle.response.reset();
  13020. return handle;
  13021. }
  13022. }
  13023. return handle;
  13024. }
  13025. inline ssize_t ClientImpl::StreamHandle::read(char *buf, size_t len) {
  13026. if (!is_valid() || !response) { return -1; }
  13027. if (decompressor_) { return read_with_decompression(buf, len); }
  13028. auto n = detail::read_body_content(stream_, body_reader_, buf, len);
  13029. if (n <= 0 && body_reader_.chunked && !trailers_parsed_ && stream_) {
  13030. trailers_parsed_ = true;
  13031. if (body_reader_.chunked_decoder) {
  13032. if (!body_reader_.chunked_decoder->parse_trailers_into(
  13033. response->trailers, response->headers)) {
  13034. return n;
  13035. }
  13036. } else {
  13037. detail::ChunkedDecoder dec(*stream_);
  13038. if (!dec.parse_trailers_into(response->trailers, response->headers)) {
  13039. return n;
  13040. }
  13041. }
  13042. }
  13043. return n;
  13044. }
  13045. inline ssize_t ClientImpl::StreamHandle::read_with_decompression(char *buf,
  13046. size_t len) {
  13047. if (decompress_offset_ < decompress_buffer_.size()) {
  13048. auto available = decompress_buffer_.size() - decompress_offset_;
  13049. auto to_copy = (std::min)(len, available);
  13050. std::memcpy(buf, decompress_buffer_.data() + decompress_offset_, to_copy);
  13051. decompress_offset_ += to_copy;
  13052. decompressed_bytes_read_ += to_copy;
  13053. return static_cast<ssize_t>(to_copy);
  13054. }
  13055. decompress_buffer_.clear();
  13056. decompress_offset_ = 0;
  13057. constexpr size_t kDecompressionBufferSize = 8192;
  13058. char compressed_buf[kDecompressionBufferSize];
  13059. while (true) {
  13060. auto n = detail::read_body_content(stream_, body_reader_, compressed_buf,
  13061. sizeof(compressed_buf));
  13062. if (n <= 0) { return n; }
  13063. bool decompress_ok = decompressor_->decompress(
  13064. compressed_buf, static_cast<size_t>(n),
  13065. [this](const char *data, size_t data_len) {
  13066. decompress_buffer_.append(data, data_len);
  13067. auto limit = body_reader_.payload_max_length;
  13068. if (decompressed_bytes_read_ + decompress_buffer_.size() > limit) {
  13069. return false;
  13070. }
  13071. return true;
  13072. });
  13073. if (!decompress_ok) {
  13074. body_reader_.last_error = Error::Read;
  13075. return -1;
  13076. }
  13077. if (!decompress_buffer_.empty()) { break; }
  13078. }
  13079. auto to_copy = (std::min)(len, decompress_buffer_.size());
  13080. std::memcpy(buf, decompress_buffer_.data(), to_copy);
  13081. decompress_offset_ = to_copy;
  13082. decompressed_bytes_read_ += to_copy;
  13083. return static_cast<ssize_t>(to_copy);
  13084. }
  13085. inline void ClientImpl::StreamHandle::parse_trailers_if_needed() {
  13086. if (!response || !stream_ || !body_reader_.chunked || trailers_parsed_) {
  13087. return;
  13088. }
  13089. trailers_parsed_ = true;
  13090. const auto bufsiz = 128;
  13091. char line_buf[bufsiz];
  13092. detail::stream_line_reader line_reader(*stream_, line_buf, bufsiz);
  13093. if (!line_reader.getline()) { return; }
  13094. if (!detail::parse_trailers(line_reader, response->trailers,
  13095. response->headers)) {
  13096. return;
  13097. }
  13098. }
  13099. namespace detail {
  13100. inline ChunkedDecoder::ChunkedDecoder(Stream &s) : strm(s) {}
  13101. inline ssize_t ChunkedDecoder::read_payload(char *buf, size_t len,
  13102. size_t &out_chunk_offset,
  13103. size_t &out_chunk_total) {
  13104. if (finished) { return 0; }
  13105. if (chunk_remaining == 0) {
  13106. stream_line_reader lr(strm, line_buf, sizeof(line_buf));
  13107. if (!lr.getline()) { return -1; }
  13108. // Everything below is bounded by eol rather than by the buffer's NUL, so
  13109. // the line terminator is never mistaken for line content.
  13110. const char *eol = lr.ptr() + lr.size();
  13111. if (lr.end_with_crlf()) {
  13112. eol -= 2;
  13113. } else if (eol != lr.ptr() && eol[-1] == '\n') {
  13114. // Only reachable under CPPHTTPLIB_ALLOW_LF_AS_LINE_TERMINATOR, where
  13115. // getline() ends the line on a bare LF. That LF is the terminator, so it
  13116. // has to come off here or the check below would reject the line.
  13117. eol -= 1;
  13118. }
  13119. // RFC 9112 §7.1: chunk-size = 1*HEXDIG
  13120. const char *p = lr.ptr();
  13121. int v = 0;
  13122. if (p == eol || !is_hex(*p, v)) { return -1; }
  13123. size_t chunk_len = 0;
  13124. constexpr size_t chunk_len_max = (std::numeric_limits<size_t>::max)();
  13125. for (; p < eol && is_hex(*p, v); ++p) {
  13126. if (chunk_len > (chunk_len_max >> 4)) { return -1; }
  13127. chunk_len = (chunk_len << 4) | static_cast<size_t>(v);
  13128. }
  13129. while (p < eol && is_space_or_tab(*p)) {
  13130. ++p;
  13131. }
  13132. // RFC 9112 §7.1.1: only a chunk-ext may sit between the size and the line
  13133. // terminator, and it is built from tokens and quoted-strings, so it never
  13134. // holds a CR, LF or any other control character. getline() reads up to the
  13135. // CRLF, so a bare LF left in here would be swallowed as extension text
  13136. // while an intermediary that ends the line on it delimits the chunks
  13137. // differently, and the two disagree on where the body ends (request
  13138. // smuggling).
  13139. if (p < eol && *p != ';') { return -1; }
  13140. for (; p < eol; ++p) {
  13141. if (!is_space_or_tab(*p) && !fields::is_field_vchar(*p)) { return -1; }
  13142. }
  13143. if (chunk_len == 0) {
  13144. chunk_remaining = 0;
  13145. finished = true;
  13146. out_chunk_offset = 0;
  13147. out_chunk_total = 0;
  13148. return 0;
  13149. }
  13150. chunk_remaining = chunk_len;
  13151. last_chunk_total = chunk_remaining;
  13152. last_chunk_offset = 0;
  13153. }
  13154. auto to_read = (std::min)(chunk_remaining, len);
  13155. auto n = strm.read(buf, to_read);
  13156. if (n <= 0) { return -1; }
  13157. auto offset_before = last_chunk_offset;
  13158. last_chunk_offset += static_cast<size_t>(n);
  13159. chunk_remaining -= static_cast<size_t>(n);
  13160. out_chunk_offset = offset_before;
  13161. out_chunk_total = last_chunk_total;
  13162. if (chunk_remaining == 0) {
  13163. stream_line_reader lr(strm, line_buf, sizeof(line_buf));
  13164. if (!lr.getline()) { return -1; }
  13165. if (std::strcmp(lr.ptr(), "\r\n") != 0) { return -1; }
  13166. }
  13167. return n;
  13168. }
  13169. inline bool ChunkedDecoder::parse_trailers_into(Headers &dest,
  13170. const Headers &src_headers) {
  13171. stream_line_reader lr(strm, line_buf, sizeof(line_buf));
  13172. if (!lr.getline()) { return false; }
  13173. return parse_trailers(lr, dest, src_headers);
  13174. }
  13175. } // namespace detail
  13176. inline void
  13177. ClientImpl::transfer_socket_ownership_to_handle(StreamHandle &handle) {
  13178. handle.connection_->sock = socket_.sock;
  13179. #ifdef CPPHTTPLIB_SSL_ENABLED
  13180. handle.connection_->session = socket_.ssl;
  13181. socket_.ssl = nullptr;
  13182. #endif
  13183. socket_.sock = INVALID_SOCKET;
  13184. }
  13185. inline bool ClientImpl::handle_request(Stream &strm, Request &req,
  13186. Response &res, bool close_connection,
  13187. Error &error) {
  13188. if (req.path.empty()) {
  13189. error = Error::Connection;
  13190. output_error_log(error, &req);
  13191. return false;
  13192. }
  13193. auto req_save = req;
  13194. bool ret;
  13195. if (!is_ssl() && is_proxy_enabled_for_host(host_)) {
  13196. auto req2 = req;
  13197. req2.path = "http://" +
  13198. detail::make_host_and_port_string(host_, port_, false) +
  13199. req.path;
  13200. ret = process_request(strm, req2, res, close_connection, error);
  13201. req = std::move(req2);
  13202. req.path = req_save.path;
  13203. } else {
  13204. ret = process_request(strm, req, res, close_connection, error);
  13205. }
  13206. if (!ret) { return false; }
  13207. if (detail::has_header_token(res.headers, "Connection", "close") ||
  13208. (res.version == "HTTP/1.0" && res.reason != "Connection established")) {
  13209. // NOTE: this requires a not-entirely-obvious chain of calls to be correct
  13210. // for this to be safe.
  13211. // This is safe to call because handle_request is only called by send_
  13212. // which locks the request mutex during the process. It would be a bug
  13213. // to call it from a different thread since it's a thread-safety issue
  13214. // to do these things to the socket if another thread is using the socket.
  13215. std::lock_guard<std::mutex> guard(socket_mutex_);
  13216. disconnect(/*gracefully=*/true);
  13217. }
  13218. if (300 < res.status && res.status < 400 && follow_location_) {
  13219. req = std::move(req_save);
  13220. ret = redirect(req, res, error);
  13221. }
  13222. #ifdef CPPHTTPLIB_SSL_ENABLED
  13223. if ((res.status == StatusCode::Unauthorized_401 ||
  13224. res.status == StatusCode::ProxyAuthenticationRequired_407) &&
  13225. req.authorization_count_ < 5) {
  13226. auto is_proxy = res.status == StatusCode::ProxyAuthenticationRequired_407;
  13227. // Only retry when the 407 actually came from a proxy hop: plain HTTP
  13228. // through an enabled proxy. HTTPS via CONNECT tunnels the 407 from the
  13229. // origin (#2457); direct/bypassed origins have no proxy hop at all.
  13230. if (is_proxy && !(!is_ssl() && is_proxy_enabled_for_host(host_))) {
  13231. return ret;
  13232. }
  13233. const auto &username =
  13234. is_proxy ? proxy_digest_auth_username_ : digest_auth_username_;
  13235. const auto &password =
  13236. is_proxy ? proxy_digest_auth_password_ : digest_auth_password_;
  13237. if (!username.empty() && !password.empty()) {
  13238. std::map<std::string, std::string> auth;
  13239. if (detail::parse_www_authenticate(res, auth, is_proxy)) {
  13240. Request new_req = req;
  13241. new_req.authorization_count_ += 1;
  13242. new_req.headers.erase(is_proxy ? "Proxy-Authorization"
  13243. : "Authorization");
  13244. new_req.headers.insert(detail::make_digest_authentication_header(
  13245. req, auth, new_req.authorization_count_, detail::random_string(10),
  13246. username, password, is_proxy));
  13247. Response new_res;
  13248. ret = send(new_req, new_res, error);
  13249. if (ret) { res = std::move(new_res); }
  13250. }
  13251. }
  13252. }
  13253. #endif
  13254. return ret;
  13255. }
  13256. inline bool ClientImpl::redirect(Request &req, Response &res, Error &error) {
  13257. if (req.redirect_count_ == 0) {
  13258. error = Error::ExceedRedirectCount;
  13259. output_error_log(error, &req);
  13260. return false;
  13261. }
  13262. auto location = res.get_header_value("location");
  13263. if (location.empty()) { return false; }
  13264. detail::UrlComponents uc;
  13265. if (!detail::parse_url(detail::resolve_relative_location(location, req.path),
  13266. uc)) {
  13267. return false;
  13268. }
  13269. // Only follow http/https redirects
  13270. if (!uc.scheme.empty() && uc.scheme != "http" && uc.scheme != "https") {
  13271. return false;
  13272. }
  13273. auto scheme = is_ssl() ? "https" : "http";
  13274. auto next_scheme = std::move(uc.scheme);
  13275. auto next_host = std::move(uc.host);
  13276. auto port_str = std::move(uc.port);
  13277. auto next_path = std::move(uc.path);
  13278. auto next_query = std::move(uc.query);
  13279. auto next_port = port_;
  13280. if (!port_str.empty()) {
  13281. if (!detail::parse_port(port_str, next_port)) { return false; }
  13282. } else if (!next_scheme.empty()) {
  13283. next_port = next_scheme == "https" ? 443 : 80;
  13284. }
  13285. if (next_scheme.empty()) { next_scheme = scheme; }
  13286. if (next_host.empty()) { next_host = host_; }
  13287. if (next_path.empty()) { next_path = "/"; }
  13288. auto path = decode_path_component(next_path) + next_query;
  13289. // Same host redirect - use current client
  13290. if (next_scheme == scheme && next_host == host_ && next_port == port_) {
  13291. return detail::redirect(*this, req, res, path, location, error);
  13292. }
  13293. // Cross-host/scheme redirect - create new client with robust setup
  13294. return create_redirect_client(next_scheme, next_host, next_port, req, res,
  13295. path, location, error);
  13296. }
  13297. // New method for robust redirect client creation
  13298. inline bool ClientImpl::create_redirect_client(
  13299. const std::string &scheme, const std::string &host, int port, Request &req,
  13300. Response &res, const std::string &path, const std::string &location,
  13301. Error &error) {
  13302. // Determine if we need SSL
  13303. auto need_ssl = (scheme == "https");
  13304. // Clean up request headers that are host/client specific
  13305. // Remove headers that should not be carried over to new host
  13306. auto headers_to_remove = std::vector<std::string>{
  13307. "Host", "Proxy-Authorization", "Authorization", "Cookie", "Cookie2"};
  13308. for (const auto &header_name : headers_to_remove) {
  13309. auto it = req.headers.find(header_name);
  13310. while (it != req.headers.end()) {
  13311. it = req.headers.erase(it);
  13312. it = req.headers.find(header_name);
  13313. }
  13314. }
  13315. // Create appropriate client type and handle redirect
  13316. if (need_ssl) {
  13317. #ifdef CPPHTTPLIB_SSL_ENABLED
  13318. // Create SSL client for HTTPS redirect
  13319. SSLClient redirect_client(host, port);
  13320. // Setup basic client configuration first
  13321. setup_redirect_client(redirect_client);
  13322. redirect_client.enable_server_certificate_verification(
  13323. server_certificate_verification_);
  13324. redirect_client.enable_server_hostname_verification(
  13325. server_hostname_verification_);
  13326. redirect_client.system_ca_mode_ = system_ca_mode_;
  13327. // Transfer CA certificate to redirect client
  13328. if (!ca_cert_pem_.empty()) {
  13329. redirect_client.load_ca_cert_store(ca_cert_pem_.c_str(),
  13330. ca_cert_pem_.size());
  13331. }
  13332. if (!ca_cert_file_path_.empty()) {
  13333. redirect_client.set_ca_cert_path(ca_cert_file_path_, ca_cert_dir_path_);
  13334. }
  13335. // Client certificates are set through constructor for SSLClient
  13336. // NOTE: SSLClient constructor already takes client_cert_path and
  13337. // client_key_path so we need to create it properly if client certs are
  13338. // needed
  13339. // Execute the redirect
  13340. return detail::redirect(redirect_client, req, res, path, location, error);
  13341. #else
  13342. // SSL not supported - set appropriate error
  13343. error = Error::SSLConnection;
  13344. output_error_log(error, &req);
  13345. return false;
  13346. #endif
  13347. } else {
  13348. // HTTP redirect
  13349. ClientImpl redirect_client(host, port);
  13350. // Setup client with robust configuration
  13351. setup_redirect_client(redirect_client);
  13352. // Execute the redirect
  13353. return detail::redirect(redirect_client, req, res, path, location, error);
  13354. }
  13355. }
  13356. // New method for robust client setup (based on basic_manual_redirect.cpp
  13357. // logic)
  13358. template <typename ClientType>
  13359. inline void ClientImpl::setup_redirect_client(ClientType &client) {
  13360. // Copy basic settings first
  13361. client.set_connection_timeout(connection_timeout_sec_);
  13362. client.set_read_timeout(read_timeout_sec_, read_timeout_usec_);
  13363. client.set_write_timeout(write_timeout_sec_, write_timeout_usec_);
  13364. client.set_keep_alive(keep_alive_);
  13365. client.set_follow_location(
  13366. true); // Enable redirects to handle multi-step redirects
  13367. client.set_path_encode(path_encode_);
  13368. client.set_compress(compress_);
  13369. client.set_decompress(decompress_);
  13370. // NOTE: Authentication credentials (basic auth, bearer token, digest auth)
  13371. // are intentionally NOT copied to the redirect client. Per RFC 9110 Section
  13372. // 15.4, credentials must not be forwarded when redirecting to a different
  13373. // host. This function is only called for cross-host redirects; same-host
  13374. // redirects are handled directly in ClientImpl::redirect().
  13375. // Copy the proxy configuration unconditionally; the per-target bypass is
  13376. // re-evaluated at send time, so a later hop to a non-bypassed host can
  13377. // still use the proxy.
  13378. client.no_proxy_entries_ = no_proxy_entries_;
  13379. if (!proxy_host_.empty() && proxy_port_ != -1) {
  13380. client.set_proxy(proxy_host_, proxy_port_);
  13381. if (!proxy_basic_auth_username_.empty()) {
  13382. client.set_proxy_basic_auth(proxy_basic_auth_username_,
  13383. proxy_basic_auth_password_);
  13384. }
  13385. if (!proxy_bearer_token_auth_token_.empty()) {
  13386. client.set_proxy_bearer_token_auth(proxy_bearer_token_auth_token_);
  13387. }
  13388. #ifdef CPPHTTPLIB_SSL_ENABLED
  13389. if (!proxy_digest_auth_username_.empty()) {
  13390. client.set_proxy_digest_auth(proxy_digest_auth_username_,
  13391. proxy_digest_auth_password_);
  13392. }
  13393. #endif
  13394. }
  13395. // Copy network and socket settings
  13396. client.set_address_family(address_family_);
  13397. client.set_tcp_nodelay(tcp_nodelay_);
  13398. client.set_ipv6_v6only(ipv6_v6only_);
  13399. if (socket_options_) { client.set_socket_options(socket_options_); }
  13400. if (!interface_.empty()) { client.set_interface(interface_); }
  13401. // Copy logging and headers
  13402. if (logger_) { client.set_logger(logger_); }
  13403. if (error_logger_) { client.set_error_logger(error_logger_); }
  13404. // NOTE: DO NOT copy default_headers_ as they may contain stale Host headers
  13405. // Each new client should generate its own headers based on its target host
  13406. }
  13407. inline bool ClientImpl::write_content_with_provider(Stream &strm,
  13408. const Request &req,
  13409. Error &error) const {
  13410. auto is_shutting_down = []() { return false; };
  13411. if (req.is_chunked_content_provider_) {
  13412. auto compressor = compress_ ? detail::create_compressor().first
  13413. : std::unique_ptr<detail::compressor>();
  13414. if (!compressor) {
  13415. compressor = detail::make_unique<detail::nocompressor>();
  13416. }
  13417. return detail::write_content_chunked(strm, req.content_provider_,
  13418. is_shutting_down, *compressor, error);
  13419. } else {
  13420. return detail::write_content_with_progress(
  13421. strm, req.content_provider_, 0, req.content_length_, is_shutting_down,
  13422. req.upload_progress, error);
  13423. }
  13424. }
  13425. inline bool ClientImpl::write_request(Stream &strm, Request &req,
  13426. bool close_connection, Error &error,
  13427. bool skip_body, bool &rejected_locally) {
  13428. rejected_locally = false;
  13429. // Prepare additional headers
  13430. if (close_connection) {
  13431. if (!req.has_header("Connection")) {
  13432. req.set_header("Connection", "close");
  13433. }
  13434. }
  13435. std::string ct_for_defaults;
  13436. if (!req.has_header("Content-Type") && !req.body.empty()) {
  13437. ct_for_defaults = "text/plain";
  13438. }
  13439. prepare_default_headers(req, false, ct_for_defaults);
  13440. if (req.body.empty()) {
  13441. if (req.content_provider_) {
  13442. if (!req.is_chunked_content_provider_) {
  13443. if (!req.has_header("Content-Length")) {
  13444. auto length = std::to_string(req.content_length_);
  13445. req.set_header("Content-Length", length);
  13446. }
  13447. }
  13448. } else {
  13449. if (req.method == "POST" || req.method == "PUT" ||
  13450. req.method == "PATCH") {
  13451. req.set_header("Content-Length", "0");
  13452. }
  13453. }
  13454. }
  13455. // A CONNECT request is read by the proxy; everything sent through the tunnel
  13456. // it opens is read by the origin. Each credential goes only to its own hop.
  13457. auto is_connect = req.method == "CONNECT";
  13458. if (!is_connect && !req.has_header("Authorization")) {
  13459. if (!basic_auth_password_.empty() || !basic_auth_username_.empty()) {
  13460. req.headers.insert(make_basic_authentication_header(
  13461. basic_auth_username_, basic_auth_password_, false));
  13462. } else if (!bearer_token_auth_token_.empty()) {
  13463. req.headers.insert(make_bearer_token_authentication_header(
  13464. bearer_token_auth_token_, false));
  13465. }
  13466. }
  13467. // Proxy-Authorization is only sent when the proxy reads this message —
  13468. // otherwise NO_PROXY-matched requests, and requests inside a TLS tunnel,
  13469. // would leak proxy credentials to the destination server.
  13470. if (is_proxy_enabled_for_host(host_) && (!is_ssl() || is_connect)) {
  13471. if (!proxy_basic_auth_username_.empty() &&
  13472. !proxy_basic_auth_password_.empty() &&
  13473. !req.has_header("Proxy-Authorization")) {
  13474. req.headers.insert(make_basic_authentication_header(
  13475. proxy_basic_auth_username_, proxy_basic_auth_password_, true));
  13476. }
  13477. if (!proxy_bearer_token_auth_token_.empty() &&
  13478. !req.has_header("Proxy-Authorization")) {
  13479. req.headers.insert(make_bearer_token_authentication_header(
  13480. proxy_bearer_token_auth_token_, true));
  13481. }
  13482. }
  13483. // Request line and headers
  13484. {
  13485. detail::BufferStream bstrm;
  13486. // Extract the query from req.path. The encoding itself is delegated to
  13487. // `encode_request_target`; the raw query is still needed here to decide
  13488. // between populating `req.params` from it and falling back to building a
  13489. // query out of caller-supplied `req.params`.
  13490. auto query_pos = req.path.find('?');
  13491. auto query_part = query_pos == std::string::npos
  13492. ? std::string()
  13493. : req.path.substr(query_pos + 1);
  13494. auto path_with_query =
  13495. detail::encode_request_target(req.path, path_encode_);
  13496. if (!query_part.empty()) {
  13497. // The query already came in through `req.path`; still populate
  13498. // `req.params` for handlers/users who read them.
  13499. detail::parse_query_text(query_part, req.params);
  13500. } else if (!req.params.empty()) {
  13501. // No query in `req.path`; build one from `req.params` so existing
  13502. // callers that pass `Params` separately continue to work.
  13503. path_with_query = append_query_params(path_with_query, req.params);
  13504. }
  13505. // Write request line and headers
  13506. if (detail::write_request_line(bstrm, req.method, path_with_query) < 0) {
  13507. // A rejected method (not a token, e.g. carrying CR/LF) or target (e.g.
  13508. // CR/LF smuggled in via a decoded redirect Location under
  13509. // set_path_encode(false)) must fail the request cleanly instead of
  13510. // emitting a request-line-less, header-injecting request.
  13511. error = Error::Write;
  13512. rejected_locally = true;
  13513. output_error_log(error, &req);
  13514. return false;
  13515. }
  13516. if (!detail::check_and_write_headers(bstrm, req.headers, header_writer_,
  13517. error)) {
  13518. rejected_locally = true;
  13519. output_error_log(error, &req);
  13520. return false;
  13521. }
  13522. // Flush buffer
  13523. auto &data = bstrm.get_buffer();
  13524. if (!detail::write_data(strm, data.data(), data.size())) {
  13525. error = Error::Write;
  13526. output_error_log(error, &req);
  13527. return false;
  13528. }
  13529. }
  13530. // After sending request line and headers, wait briefly for an early server
  13531. // response (e.g. 4xx) and avoid sending a potentially large request body
  13532. // unnecessarily. This workaround is only enabled on Windows because Unix
  13533. // platforms surface write errors (EPIPE) earlier; on Windows kernel send
  13534. // buffering can accept large writes even when the peer already responded.
  13535. // Check the stream first (which covers SSL via `is_readable()`), then
  13536. // fall back to select on the socket. Only perform the wait for very large
  13537. // request bodies to avoid interfering with normal small requests and
  13538. // reduce side-effects. Poll briefly (up to 50ms as default) for an early
  13539. // response. Skip this check when using Expect: 100-continue, as the protocol
  13540. // handles early responses properly.
  13541. #if defined(_WIN32)
  13542. if (!skip_body &&
  13543. req.body.size() > CPPHTTPLIB_WAIT_EARLY_SERVER_RESPONSE_THRESHOLD &&
  13544. req.path.size() > CPPHTTPLIB_REQUEST_URI_MAX_LENGTH) {
  13545. auto start = std::chrono::high_resolution_clock::now();
  13546. for (;;) {
  13547. // Prefer socket-level readiness to avoid SSL_pending() false-positives
  13548. // from SSL internals. If the underlying socket is readable, assume an
  13549. // early response may be present.
  13550. auto sock = strm.socket();
  13551. if (sock != INVALID_SOCKET && detail::select_read(sock, 0, 0) > 0) {
  13552. return false;
  13553. }
  13554. // Fallback to stream-level check for non-socket streams or when the
  13555. // socket isn't reporting readable. Avoid using `is_readable()` for
  13556. // SSL, since `SSL_pending()` may report buffered records that do not
  13557. // indicate a complete application-level response yet.
  13558. if (!is_ssl() && strm.is_readable()) { return false; }
  13559. auto now = std::chrono::high_resolution_clock::now();
  13560. auto elapsed =
  13561. std::chrono::duration_cast<std::chrono::milliseconds>(now - start)
  13562. .count();
  13563. if (elapsed >= CPPHTTPLIB_WAIT_EARLY_SERVER_RESPONSE_TIMEOUT_MSECOND) {
  13564. break;
  13565. }
  13566. std::this_thread::sleep_for(std::chrono::milliseconds(1));
  13567. }
  13568. }
  13569. #endif
  13570. // Body
  13571. if (skip_body) { return true; }
  13572. return write_request_body(strm, req, error);
  13573. }
  13574. inline bool ClientImpl::write_request_body(Stream &strm, Request &req,
  13575. Error &error) {
  13576. if (req.body.empty()) {
  13577. return write_content_with_provider(strm, req, error);
  13578. }
  13579. if (req.upload_progress) {
  13580. auto body_size = req.body.size();
  13581. size_t written = 0;
  13582. auto data = req.body.data();
  13583. while (written < body_size) {
  13584. size_t to_write = (std::min)(CPPHTTPLIB_SEND_BUFSIZ, body_size - written);
  13585. if (!detail::write_data(strm, data + written, to_write)) {
  13586. error = Error::Write;
  13587. output_error_log(error, &req);
  13588. return false;
  13589. }
  13590. written += to_write;
  13591. if (!req.upload_progress(written, body_size)) {
  13592. error = Error::Canceled;
  13593. output_error_log(error, &req);
  13594. return false;
  13595. }
  13596. }
  13597. } else {
  13598. if (!detail::write_data(strm, req.body.data(), req.body.size())) {
  13599. error = Error::Write;
  13600. output_error_log(error, &req);
  13601. return false;
  13602. }
  13603. }
  13604. return true;
  13605. }
  13606. inline std::unique_ptr<Response>
  13607. ClientImpl::send_with_content_provider_and_receiver(
  13608. Request &req, const char *body, size_t content_length,
  13609. ContentProvider content_provider,
  13610. ContentProviderWithoutLength content_provider_without_length,
  13611. const std::string &content_type, ContentReceiver content_receiver,
  13612. Error &error) {
  13613. if (!content_type.empty()) { req.set_header("Content-Type", content_type); }
  13614. auto enc = compress_
  13615. ? detail::create_compressor()
  13616. : std::pair<std::unique_ptr<detail::compressor>, const char *>(
  13617. nullptr, nullptr);
  13618. if (enc.second) { req.set_header("Content-Encoding", enc.second); }
  13619. if (enc.first && !content_provider_without_length) {
  13620. auto &compressor = enc.first;
  13621. if (content_provider) {
  13622. auto ok = true;
  13623. auto finished = false;
  13624. size_t offset = 0;
  13625. DataSink data_sink;
  13626. data_sink.write = [&](const char *data, size_t data_len) -> bool {
  13627. if (ok) {
  13628. auto last = offset + data_len == content_length;
  13629. auto ret = compressor->compress(
  13630. data, data_len, last,
  13631. [&](const char *compressed_data, size_t compressed_data_len) {
  13632. req.body.append(compressed_data, compressed_data_len);
  13633. return true;
  13634. });
  13635. if (ret) {
  13636. offset += data_len;
  13637. } else {
  13638. ok = false;
  13639. }
  13640. }
  13641. return ok;
  13642. };
  13643. // As in detail::write_content_with_progress(): the body is framed by
  13644. // content_length, so a provider that finishes early has truncated it.
  13645. // Stop and report that instead of calling the provider forever.
  13646. data_sink.done = [&]() { finished = true; };
  13647. while (ok && !finished && offset < content_length) {
  13648. if (!content_provider(offset, content_length - offset, data_sink)) {
  13649. error = Error::Canceled;
  13650. output_error_log(error, &req);
  13651. return nullptr;
  13652. }
  13653. }
  13654. // A short body here means either the provider stopped early or the
  13655. // compressor gave up. The branch below reports a failing compressor as
  13656. // Error::Compression, so keep the two distinguishable.
  13657. if (offset < content_length) {
  13658. error = ok ? Error::Write : Error::Compression;
  13659. output_error_log(error, &req);
  13660. return nullptr;
  13661. }
  13662. } else {
  13663. if (!compressor->compress(body, content_length, true,
  13664. [&](const char *data, size_t data_len) {
  13665. req.body.append(data, data_len);
  13666. return true;
  13667. })) {
  13668. error = Error::Compression;
  13669. output_error_log(error, &req);
  13670. return nullptr;
  13671. }
  13672. }
  13673. } else {
  13674. if (content_provider) {
  13675. req.content_length_ = content_length;
  13676. req.content_provider_ = std::move(content_provider);
  13677. req.is_chunked_content_provider_ = false;
  13678. } else if (content_provider_without_length) {
  13679. req.content_length_ = 0;
  13680. req.content_provider_ = detail::ContentProviderAdapter(
  13681. std::move(content_provider_without_length));
  13682. req.is_chunked_content_provider_ = true;
  13683. req.set_header("Transfer-Encoding", "chunked");
  13684. } else {
  13685. req.body.assign(body, content_length);
  13686. }
  13687. }
  13688. if (content_receiver) {
  13689. req.content_receiver =
  13690. [content_receiver](const char *data, size_t data_length,
  13691. size_t /*offset*/, size_t /*total_length*/) {
  13692. return content_receiver(data, data_length);
  13693. };
  13694. }
  13695. auto res = detail::make_unique<Response>();
  13696. return send(req, *res, error) ? std::move(res) : nullptr;
  13697. }
  13698. inline Result ClientImpl::send_with_content_provider_and_receiver(
  13699. const std::string &method, const std::string &path, const Headers &headers,
  13700. const char *body, size_t content_length, ContentProvider content_provider,
  13701. ContentProviderWithoutLength content_provider_without_length,
  13702. const std::string &content_type, ContentReceiver content_receiver,
  13703. UploadProgress progress) {
  13704. Request req;
  13705. req.method = method;
  13706. req.headers = headers;
  13707. req.path = path;
  13708. req.upload_progress = std::move(progress);
  13709. if (max_timeout_msec_ > 0) {
  13710. req.start_time_ = std::chrono::steady_clock::now();
  13711. }
  13712. auto error = Error::Success;
  13713. auto res = send_with_content_provider_and_receiver(
  13714. req, body, content_length, std::move(content_provider),
  13715. std::move(content_provider_without_length), content_type,
  13716. std::move(content_receiver), error);
  13717. #ifdef CPPHTTPLIB_SSL_ENABLED
  13718. return Result{std::move(res), error, std::move(req.headers), last_ssl_error_,
  13719. last_backend_error_};
  13720. #else
  13721. return Result{std::move(res), error, std::move(req.headers)};
  13722. #endif
  13723. }
  13724. inline void ClientImpl::output_log(const Request &req,
  13725. const Response &res) const {
  13726. if (logger_) {
  13727. std::lock_guard<std::mutex> guard(logger_mutex_);
  13728. logger_(req, res);
  13729. }
  13730. }
  13731. inline void ClientImpl::output_error_log(const Error &err,
  13732. const Request *req) const {
  13733. if (error_logger_) {
  13734. std::lock_guard<std::mutex> guard(logger_mutex_);
  13735. error_logger_(err, req);
  13736. }
  13737. }
  13738. inline bool ClientImpl::process_request(Stream &strm, Request &req,
  13739. Response &res, bool close_connection,
  13740. Error &error) {
  13741. // Auto-add Expect: 100-continue for large bodies
  13742. if (CPPHTTPLIB_EXPECT_100_THRESHOLD > 0 && !req.has_header("Expect")) {
  13743. auto body_size = req.body.empty() ? req.content_length_ : req.body.size();
  13744. if (body_size >= CPPHTTPLIB_EXPECT_100_THRESHOLD) {
  13745. req.set_header("Expect", "100-continue");
  13746. }
  13747. }
  13748. // Check for Expect: 100-continue
  13749. auto expect_100_continue =
  13750. detail::has_header_token(req.headers, "Expect", "100-continue");
  13751. // Send request (skip body if using Expect: 100-continue)
  13752. auto rejected_locally = false;
  13753. auto write_request_success =
  13754. write_request(strm, req, close_connection, error, expect_100_continue,
  13755. rejected_locally);
  13756. // A failed write normally still reads the response below, since the server
  13757. // may have answered early (e.g. 413/414) and closed while the body was being
  13758. // sent. A request rejected before any byte reached the socket gets no such
  13759. // response, and waiting for one would block until the read timeout.
  13760. if (rejected_locally) { return false; }
  13761. #ifdef CPPHTTPLIB_SSL_ENABLED
  13762. if (is_ssl() && !expect_100_continue) {
  13763. auto is_proxy_enabled = is_proxy_enabled_for_host(host_);
  13764. if (!is_proxy_enabled) {
  13765. if (tls::is_peer_closed(socket_.ssl, socket_.sock)) {
  13766. error = Error::SSLPeerCouldBeClosed_;
  13767. output_error_log(error, &req);
  13768. return false;
  13769. }
  13770. }
  13771. }
  13772. #endif
  13773. // Handle Expect: 100-continue.
  13774. //
  13775. // Wait for an interim/early response by attempting to read the status line
  13776. // under a short timeout, instead of trusting raw socket readability. Over
  13777. // TLS, post-handshake records (e.g. session tickets) make the socket
  13778. // readable without any HTTP response being available; relying on
  13779. // `select_read` there caused the body to be withheld forever and the
  13780. // request to fail with `Read` (#2458). If no status line arrives within the
  13781. // timeout, send the body anyway (matching curl's behavior).
  13782. auto status_line_read = false;
  13783. if (expect_100_continue && write_request_success) {
  13784. if (CPPHTTPLIB_EXPECT_100_TIMEOUT_MSECOND > 0) {
  13785. time_t sec = CPPHTTPLIB_EXPECT_100_TIMEOUT_MSECOND / 1000;
  13786. time_t usec = (CPPHTTPLIB_EXPECT_100_TIMEOUT_MSECOND % 1000) * 1000;
  13787. strm.set_read_timeout(sec, usec);
  13788. status_line_read = read_response_line(strm, req, res, false);
  13789. strm.set_read_timeout(read_timeout_sec_, read_timeout_usec_);
  13790. }
  13791. if (!status_line_read) {
  13792. // No interim response within the timeout: send the body and handle the
  13793. // response as usual.
  13794. if (!write_request_body(strm, req, error)) { return false; }
  13795. expect_100_continue = false; // Switch to normal response handling
  13796. }
  13797. }
  13798. // Receive response and headers
  13799. // When using Expect: 100-continue, don't auto-skip `100 Continue` response
  13800. if ((!status_line_read &&
  13801. !read_response_line(strm, req, res, !expect_100_continue)) ||
  13802. !detail::read_headers(strm, res.headers)) {
  13803. if (write_request_success) { error = Error::Read; }
  13804. output_error_log(error, &req);
  13805. return false;
  13806. }
  13807. if (!write_request_success) { return false; }
  13808. // Handle Expect: 100-continue response
  13809. if (expect_100_continue) {
  13810. if (res.status == StatusCode::Continue_100) {
  13811. // Server accepted, send the body
  13812. if (!write_request_body(strm, req, error)) { return false; }
  13813. // Read the actual response
  13814. res.headers.clear();
  13815. res.body.clear();
  13816. if (!read_response_line(strm, req, res) ||
  13817. !detail::read_headers(strm, res.headers)) {
  13818. error = Error::Read;
  13819. output_error_log(error, &req);
  13820. return false;
  13821. }
  13822. }
  13823. // If not 100 Continue, server returned an error; proceed with that response
  13824. }
  13825. // Body
  13826. if ((res.status != StatusCode::NoContent_204) && req.method != "HEAD" &&
  13827. req.method != "CONNECT") {
  13828. // Reject ambiguous framing (RFC 9112 §6.3). Unlike a request, a response
  13829. // whose final transfer coding is not chunked is not ambiguous: its body
  13830. // runs until the server closes the connection, so it is not rejected.
  13831. // HEAD/204 are excluded above and a 304 carries no body.
  13832. if (res.status != StatusCode::NotModified_304 &&
  13833. detail::has_conflicting_content_length(res.headers)) {
  13834. error = Error::Read;
  13835. output_error_log(error, &req);
  13836. return false;
  13837. }
  13838. auto redirect = 300 < res.status && res.status < 400 &&
  13839. res.status != StatusCode::NotModified_304 &&
  13840. follow_location_;
  13841. if (req.response_handler && !redirect) {
  13842. if (!req.response_handler(res)) {
  13843. error = Error::Canceled;
  13844. output_error_log(error, &req);
  13845. return false;
  13846. }
  13847. }
  13848. auto out =
  13849. req.content_receiver
  13850. ? static_cast<ContentReceiverWithProgress>(
  13851. [&](const char *buf, size_t n, size_t off, size_t len) {
  13852. if (redirect) { return true; }
  13853. auto ret = req.content_receiver(buf, n, off, len);
  13854. if (!ret) {
  13855. error = Error::Canceled;
  13856. output_error_log(error, &req);
  13857. }
  13858. return ret;
  13859. })
  13860. : static_cast<ContentReceiverWithProgress>(
  13861. [&](const char *buf, size_t n, size_t /*off*/,
  13862. size_t /*len*/) {
  13863. assert(res.body.size() + n <= res.body.max_size());
  13864. if (payload_max_length_ > 0 &&
  13865. (res.body.size() >= payload_max_length_ ||
  13866. n > payload_max_length_ - res.body.size())) {
  13867. return false;
  13868. }
  13869. res.body.append(buf, n);
  13870. return true;
  13871. });
  13872. auto progress = [&](size_t current, size_t total) {
  13873. if (!req.download_progress || redirect) { return true; }
  13874. auto ret = req.download_progress(current, total);
  13875. if (!ret) {
  13876. error = Error::Canceled;
  13877. output_error_log(error, &req);
  13878. }
  13879. return ret;
  13880. };
  13881. if (res.has_header("Content-Length")) {
  13882. if (!req.content_receiver) {
  13883. auto len = res.get_header_value_u64("Content-Length");
  13884. if (len > res.body.max_size()) {
  13885. error = Error::Read;
  13886. output_error_log(error, &req);
  13887. return false;
  13888. }
  13889. // Cap the reservation by payload_max_length_ to avoid OOM when a
  13890. // hostile or malformed server sends an enormous Content-Length.
  13891. // The actual body read below is bounded by payload_max_length_,
  13892. // so reserving more than that is never useful.
  13893. auto reserve_len = static_cast<size_t>(len);
  13894. if (payload_max_length_ > 0 && reserve_len > payload_max_length_) {
  13895. reserve_len = payload_max_length_;
  13896. }
  13897. res.body.reserve(reserve_len);
  13898. }
  13899. }
  13900. if (res.status != StatusCode::NotModified_304) {
  13901. auto content_status = 0;
  13902. auto max_length = (!has_payload_max_length_ && req.content_receiver)
  13903. ? (std::numeric_limits<size_t>::max)()
  13904. : payload_max_length_;
  13905. if (!detail::read_content(strm, res, max_length, content_status,
  13906. std::move(progress), std::move(out),
  13907. decompress_)) {
  13908. if (error != Error::Canceled) {
  13909. // Tell the caller apart from a plain read failure when the body could
  13910. // not be decoded because of its Content-Encoding.
  13911. switch (content_status) {
  13912. case StatusCode::UnsupportedMediaType_415:
  13913. error = Error::UnsupportedContentEncoding;
  13914. break;
  13915. case StatusCode::InternalServerError_500:
  13916. error = Error::Compression;
  13917. break;
  13918. default: error = Error::Read; break;
  13919. }
  13920. }
  13921. output_error_log(error, &req);
  13922. return false;
  13923. }
  13924. }
  13925. }
  13926. // Log
  13927. output_log(req, res);
  13928. return true;
  13929. }
  13930. inline ContentProviderWithoutLength ClientImpl::get_multipart_content_provider(
  13931. const std::string &boundary, const UploadFormDataItems &items,
  13932. const FormDataProviderItems &provider_items) const {
  13933. size_t cur_item = 0;
  13934. size_t cur_start = 0;
  13935. // cur_item and cur_start are copied to within the std::function and
  13936. // maintain state between successive calls
  13937. return [&, cur_item, cur_start](size_t offset,
  13938. DataSink &sink) mutable -> bool {
  13939. if (!offset && !items.empty()) {
  13940. sink.os << detail::serialize_multipart_formdata(items, boundary, false);
  13941. return true;
  13942. } else if (cur_item < provider_items.size()) {
  13943. if (!cur_start) {
  13944. const auto &begin = detail::serialize_multipart_formdata_item_begin(
  13945. provider_items[cur_item], boundary);
  13946. offset += begin.size();
  13947. cur_start = offset;
  13948. sink.os << begin;
  13949. }
  13950. DataSink cur_sink;
  13951. auto has_data = true;
  13952. cur_sink.write = sink.write;
  13953. // Forward is_writable so a provider item asking whether it may keep
  13954. // going gets the outer sink's answer rather than the default `true`.
  13955. cur_sink.is_writable = sink.is_writable;
  13956. cur_sink.done = [&]() { has_data = false; };
  13957. if (!provider_items[cur_item].provider(offset - cur_start, cur_sink)) {
  13958. return false;
  13959. }
  13960. if (!has_data) {
  13961. sink.os << detail::serialize_multipart_formdata_item_end();
  13962. cur_item++;
  13963. cur_start = 0;
  13964. }
  13965. return true;
  13966. } else {
  13967. sink.os << detail::serialize_multipart_formdata_finish(boundary);
  13968. sink.done();
  13969. return true;
  13970. }
  13971. };
  13972. }
  13973. inline bool ClientImpl::process_socket(
  13974. const Socket &socket,
  13975. std::chrono::time_point<std::chrono::steady_clock> start_time,
  13976. std::function<bool(Stream &strm)> callback) {
  13977. return detail::process_client_socket(
  13978. socket.sock, read_timeout_sec_, read_timeout_usec_, write_timeout_sec_,
  13979. write_timeout_usec_, max_timeout_msec_, start_time, std::move(callback));
  13980. }
  13981. inline bool ClientImpl::is_ssl() const { return false; }
  13982. inline Result ClientImpl::Get(const std::string &path,
  13983. DownloadProgress progress) {
  13984. return Get(path, Headers(), std::move(progress));
  13985. }
  13986. inline Result ClientImpl::Get(const std::string &path, const Params &params,
  13987. DownloadProgress progress) {
  13988. return Get(path, params, Headers(), std::move(progress));
  13989. }
  13990. inline Result ClientImpl::Get(const std::string &path, const Params &params,
  13991. const Headers &headers,
  13992. DownloadProgress progress) {
  13993. if (params.empty()) { return Get(path, headers); }
  13994. std::string path_with_query = append_query_params(path, params);
  13995. return Get(path_with_query, headers, std::move(progress));
  13996. }
  13997. inline Result ClientImpl::Get(const std::string &path, const Headers &headers,
  13998. DownloadProgress progress) {
  13999. Request req;
  14000. req.method = "GET";
  14001. req.path = path;
  14002. req.headers = headers;
  14003. req.download_progress = std::move(progress);
  14004. if (max_timeout_msec_ > 0) {
  14005. req.start_time_ = std::chrono::steady_clock::now();
  14006. }
  14007. return send_(std::move(req));
  14008. }
  14009. inline Result ClientImpl::Get(const std::string &path,
  14010. ContentReceiver content_receiver,
  14011. DownloadProgress progress) {
  14012. return Get(path, Headers(), nullptr, std::move(content_receiver),
  14013. std::move(progress));
  14014. }
  14015. inline Result ClientImpl::Get(const std::string &path, const Headers &headers,
  14016. ContentReceiver content_receiver,
  14017. DownloadProgress progress) {
  14018. return Get(path, headers, nullptr, std::move(content_receiver),
  14019. std::move(progress));
  14020. }
  14021. inline Result ClientImpl::Get(const std::string &path,
  14022. ResponseHandler response_handler,
  14023. ContentReceiver content_receiver,
  14024. DownloadProgress progress) {
  14025. return Get(path, Headers(), std::move(response_handler),
  14026. std::move(content_receiver), std::move(progress));
  14027. }
  14028. inline Result ClientImpl::Get(const std::string &path, const Headers &headers,
  14029. ResponseHandler response_handler,
  14030. ContentReceiver content_receiver,
  14031. DownloadProgress progress) {
  14032. Request req;
  14033. req.method = "GET";
  14034. req.path = path;
  14035. req.headers = headers;
  14036. req.response_handler = std::move(response_handler);
  14037. req.content_receiver =
  14038. [content_receiver](const char *data, size_t data_length,
  14039. size_t /*offset*/, size_t /*total_length*/) {
  14040. return content_receiver(data, data_length);
  14041. };
  14042. req.download_progress = std::move(progress);
  14043. if (max_timeout_msec_ > 0) {
  14044. req.start_time_ = std::chrono::steady_clock::now();
  14045. }
  14046. return send_(std::move(req));
  14047. }
  14048. inline Result ClientImpl::Get(const std::string &path, const Params &params,
  14049. const Headers &headers,
  14050. ContentReceiver content_receiver,
  14051. DownloadProgress progress) {
  14052. return Get(path, params, headers, nullptr, std::move(content_receiver),
  14053. std::move(progress));
  14054. }
  14055. inline Result ClientImpl::Get(const std::string &path, const Params &params,
  14056. const Headers &headers,
  14057. ResponseHandler response_handler,
  14058. ContentReceiver content_receiver,
  14059. DownloadProgress progress) {
  14060. if (params.empty()) {
  14061. return Get(path, headers, std::move(response_handler),
  14062. std::move(content_receiver), std::move(progress));
  14063. }
  14064. std::string path_with_query = append_query_params(path, params);
  14065. return Get(path_with_query, headers, std::move(response_handler),
  14066. std::move(content_receiver), std::move(progress));
  14067. }
  14068. inline Result ClientImpl::Head(const std::string &path) {
  14069. return Head(path, Headers());
  14070. }
  14071. inline Result ClientImpl::Head(const std::string &path,
  14072. const Headers &headers) {
  14073. Request req;
  14074. req.method = "HEAD";
  14075. req.headers = headers;
  14076. req.path = path;
  14077. if (max_timeout_msec_ > 0) {
  14078. req.start_time_ = std::chrono::steady_clock::now();
  14079. }
  14080. return send_(std::move(req));
  14081. }
  14082. inline Result ClientImpl::Post(const std::string &path) {
  14083. return Post(path, std::string(), std::string());
  14084. }
  14085. inline Result ClientImpl::Post(const std::string &path,
  14086. const Headers &headers) {
  14087. return Post(path, headers, nullptr, 0, std::string());
  14088. }
  14089. inline Result ClientImpl::Post(const std::string &path, const char *body,
  14090. size_t content_length,
  14091. const std::string &content_type,
  14092. UploadProgress progress) {
  14093. return Post(path, Headers(), body, content_length, content_type, progress);
  14094. }
  14095. inline Result ClientImpl::Post(const std::string &path, const std::string &body,
  14096. const std::string &content_type,
  14097. UploadProgress progress) {
  14098. return Post(path, Headers(), body, content_type, progress);
  14099. }
  14100. inline Result ClientImpl::Post(const std::string &path, const Params &params) {
  14101. return Post(path, Headers(), params);
  14102. }
  14103. inline Result ClientImpl::Post(const std::string &path, size_t content_length,
  14104. ContentProvider content_provider,
  14105. const std::string &content_type,
  14106. UploadProgress progress) {
  14107. return Post(path, Headers(), content_length, std::move(content_provider),
  14108. content_type, progress);
  14109. }
  14110. inline Result ClientImpl::Post(const std::string &path, size_t content_length,
  14111. ContentProvider content_provider,
  14112. const std::string &content_type,
  14113. ContentReceiver content_receiver,
  14114. UploadProgress progress) {
  14115. return Post(path, Headers(), content_length, std::move(content_provider),
  14116. content_type, std::move(content_receiver), progress);
  14117. }
  14118. inline Result ClientImpl::Post(const std::string &path,
  14119. ContentProviderWithoutLength content_provider,
  14120. const std::string &content_type,
  14121. UploadProgress progress) {
  14122. return Post(path, Headers(), std::move(content_provider), content_type,
  14123. progress);
  14124. }
  14125. inline Result ClientImpl::Post(const std::string &path,
  14126. ContentProviderWithoutLength content_provider,
  14127. const std::string &content_type,
  14128. ContentReceiver content_receiver,
  14129. UploadProgress progress) {
  14130. return Post(path, Headers(), std::move(content_provider), content_type,
  14131. std::move(content_receiver), progress);
  14132. }
  14133. inline Result ClientImpl::Post(const std::string &path, const Headers &headers,
  14134. const Params &params) {
  14135. auto query = detail::params_to_query_str(params);
  14136. return Post(path, headers, query, "application/x-www-form-urlencoded");
  14137. }
  14138. inline Result ClientImpl::Post(const std::string &path,
  14139. const UploadFormDataItems &items,
  14140. UploadProgress progress) {
  14141. return Post(path, Headers(), items, progress);
  14142. }
  14143. inline Result ClientImpl::Post(const std::string &path, const Headers &headers,
  14144. const UploadFormDataItems &items,
  14145. UploadProgress progress) {
  14146. const auto &boundary = detail::make_multipart_data_boundary();
  14147. const auto &content_type =
  14148. detail::serialize_multipart_formdata_get_content_type(boundary);
  14149. auto content_length = detail::get_multipart_content_length(items, boundary);
  14150. return Post(path, headers, content_length,
  14151. detail::make_multipart_content_provider(items, boundary),
  14152. content_type, progress);
  14153. }
  14154. inline Result ClientImpl::Post(const std::string &path, const Headers &headers,
  14155. const UploadFormDataItems &items,
  14156. const std::string &boundary,
  14157. UploadProgress progress) {
  14158. if (!detail::is_multipart_boundary_chars_valid(boundary)) {
  14159. return Result{nullptr, Error::UnsupportedMultipartBoundaryChars};
  14160. }
  14161. const auto &content_type =
  14162. detail::serialize_multipart_formdata_get_content_type(boundary);
  14163. auto content_length = detail::get_multipart_content_length(items, boundary);
  14164. return Post(path, headers, content_length,
  14165. detail::make_multipart_content_provider(items, boundary),
  14166. content_type, progress);
  14167. }
  14168. inline Result ClientImpl::Post(const std::string &path, const Headers &headers,
  14169. const char *body, size_t content_length,
  14170. const std::string &content_type,
  14171. UploadProgress progress) {
  14172. return send_with_content_provider_and_receiver(
  14173. "POST", path, headers, body, content_length, nullptr, nullptr,
  14174. content_type, nullptr, progress);
  14175. }
  14176. inline Result ClientImpl::Post(const std::string &path, const Headers &headers,
  14177. const std::string &body,
  14178. const std::string &content_type,
  14179. UploadProgress progress) {
  14180. return send_with_content_provider_and_receiver(
  14181. "POST", path, headers, body.data(), body.size(), nullptr, nullptr,
  14182. content_type, nullptr, progress);
  14183. }
  14184. inline Result ClientImpl::Post(const std::string &path, const Headers &headers,
  14185. size_t content_length,
  14186. ContentProvider content_provider,
  14187. const std::string &content_type,
  14188. UploadProgress progress) {
  14189. return send_with_content_provider_and_receiver(
  14190. "POST", path, headers, nullptr, content_length,
  14191. std::move(content_provider), nullptr, content_type, nullptr, progress);
  14192. }
  14193. inline Result ClientImpl::Post(const std::string &path, const Headers &headers,
  14194. size_t content_length,
  14195. ContentProvider content_provider,
  14196. const std::string &content_type,
  14197. ContentReceiver content_receiver,
  14198. DownloadProgress progress) {
  14199. return send_with_content_provider_and_receiver(
  14200. "POST", path, headers, nullptr, content_length,
  14201. std::move(content_provider), nullptr, content_type,
  14202. std::move(content_receiver), std::move(progress));
  14203. }
  14204. inline Result ClientImpl::Post(const std::string &path, const Headers &headers,
  14205. ContentProviderWithoutLength content_provider,
  14206. const std::string &content_type,
  14207. UploadProgress progress) {
  14208. return send_with_content_provider_and_receiver(
  14209. "POST", path, headers, nullptr, 0, nullptr, std::move(content_provider),
  14210. content_type, nullptr, progress);
  14211. }
  14212. inline Result ClientImpl::Post(const std::string &path, const Headers &headers,
  14213. ContentProviderWithoutLength content_provider,
  14214. const std::string &content_type,
  14215. ContentReceiver content_receiver,
  14216. DownloadProgress progress) {
  14217. return send_with_content_provider_and_receiver(
  14218. "POST", path, headers, nullptr, 0, nullptr, std::move(content_provider),
  14219. content_type, std::move(content_receiver), std::move(progress));
  14220. }
  14221. inline Result ClientImpl::Post(const std::string &path, const Headers &headers,
  14222. const UploadFormDataItems &items,
  14223. const FormDataProviderItems &provider_items,
  14224. UploadProgress progress) {
  14225. const auto &boundary = detail::make_multipart_data_boundary();
  14226. const auto &content_type =
  14227. detail::serialize_multipart_formdata_get_content_type(boundary);
  14228. return send_with_content_provider_and_receiver(
  14229. "POST", path, headers, nullptr, 0, nullptr,
  14230. get_multipart_content_provider(boundary, items, provider_items),
  14231. content_type, nullptr, progress);
  14232. }
  14233. inline Result ClientImpl::Post(const std::string &path, const Headers &headers,
  14234. const std::string &body,
  14235. const std::string &content_type,
  14236. ContentReceiver content_receiver,
  14237. DownloadProgress progress) {
  14238. Request req;
  14239. req.method = "POST";
  14240. req.path = path;
  14241. req.headers = headers;
  14242. req.body = body;
  14243. req.content_receiver =
  14244. [content_receiver](const char *data, size_t data_length,
  14245. size_t /*offset*/, size_t /*total_length*/) {
  14246. return content_receiver(data, data_length);
  14247. };
  14248. req.download_progress = std::move(progress);
  14249. if (max_timeout_msec_ > 0) {
  14250. req.start_time_ = std::chrono::steady_clock::now();
  14251. }
  14252. if (!content_type.empty()) { req.set_header("Content-Type", content_type); }
  14253. return send_(std::move(req));
  14254. }
  14255. inline Result ClientImpl::Put(const std::string &path) {
  14256. return Put(path, std::string(), std::string());
  14257. }
  14258. inline Result ClientImpl::Put(const std::string &path, const Headers &headers) {
  14259. return Put(path, headers, nullptr, 0, std::string());
  14260. }
  14261. inline Result ClientImpl::Put(const std::string &path, const char *body,
  14262. size_t content_length,
  14263. const std::string &content_type,
  14264. UploadProgress progress) {
  14265. return Put(path, Headers(), body, content_length, content_type, progress);
  14266. }
  14267. inline Result ClientImpl::Put(const std::string &path, const std::string &body,
  14268. const std::string &content_type,
  14269. UploadProgress progress) {
  14270. return Put(path, Headers(), body, content_type, progress);
  14271. }
  14272. inline Result ClientImpl::Put(const std::string &path, const Params &params) {
  14273. return Put(path, Headers(), params);
  14274. }
  14275. inline Result ClientImpl::Put(const std::string &path, size_t content_length,
  14276. ContentProvider content_provider,
  14277. const std::string &content_type,
  14278. UploadProgress progress) {
  14279. return Put(path, Headers(), content_length, std::move(content_provider),
  14280. content_type, progress);
  14281. }
  14282. inline Result ClientImpl::Put(const std::string &path, size_t content_length,
  14283. ContentProvider content_provider,
  14284. const std::string &content_type,
  14285. ContentReceiver content_receiver,
  14286. UploadProgress progress) {
  14287. return Put(path, Headers(), content_length, std::move(content_provider),
  14288. content_type, std::move(content_receiver), progress);
  14289. }
  14290. inline Result ClientImpl::Put(const std::string &path,
  14291. ContentProviderWithoutLength content_provider,
  14292. const std::string &content_type,
  14293. UploadProgress progress) {
  14294. return Put(path, Headers(), std::move(content_provider), content_type,
  14295. progress);
  14296. }
  14297. inline Result ClientImpl::Put(const std::string &path,
  14298. ContentProviderWithoutLength content_provider,
  14299. const std::string &content_type,
  14300. ContentReceiver content_receiver,
  14301. UploadProgress progress) {
  14302. return Put(path, Headers(), std::move(content_provider), content_type,
  14303. std::move(content_receiver), progress);
  14304. }
  14305. inline Result ClientImpl::Put(const std::string &path, const Headers &headers,
  14306. const Params &params) {
  14307. auto query = detail::params_to_query_str(params);
  14308. return Put(path, headers, query, "application/x-www-form-urlencoded");
  14309. }
  14310. inline Result ClientImpl::Put(const std::string &path,
  14311. const UploadFormDataItems &items,
  14312. UploadProgress progress) {
  14313. return Put(path, Headers(), items, progress);
  14314. }
  14315. inline Result ClientImpl::Put(const std::string &path, const Headers &headers,
  14316. const UploadFormDataItems &items,
  14317. UploadProgress progress) {
  14318. const auto &boundary = detail::make_multipart_data_boundary();
  14319. const auto &content_type =
  14320. detail::serialize_multipart_formdata_get_content_type(boundary);
  14321. auto content_length = detail::get_multipart_content_length(items, boundary);
  14322. return Put(path, headers, content_length,
  14323. detail::make_multipart_content_provider(items, boundary),
  14324. content_type, progress);
  14325. }
  14326. inline Result ClientImpl::Put(const std::string &path, const Headers &headers,
  14327. const UploadFormDataItems &items,
  14328. const std::string &boundary,
  14329. UploadProgress progress) {
  14330. if (!detail::is_multipart_boundary_chars_valid(boundary)) {
  14331. return Result{nullptr, Error::UnsupportedMultipartBoundaryChars};
  14332. }
  14333. const auto &content_type =
  14334. detail::serialize_multipart_formdata_get_content_type(boundary);
  14335. auto content_length = detail::get_multipart_content_length(items, boundary);
  14336. return Put(path, headers, content_length,
  14337. detail::make_multipart_content_provider(items, boundary),
  14338. content_type, progress);
  14339. }
  14340. inline Result ClientImpl::Put(const std::string &path, const Headers &headers,
  14341. const char *body, size_t content_length,
  14342. const std::string &content_type,
  14343. UploadProgress progress) {
  14344. return send_with_content_provider_and_receiver(
  14345. "PUT", path, headers, body, content_length, nullptr, nullptr,
  14346. content_type, nullptr, progress);
  14347. }
  14348. inline Result ClientImpl::Put(const std::string &path, const Headers &headers,
  14349. const std::string &body,
  14350. const std::string &content_type,
  14351. UploadProgress progress) {
  14352. return send_with_content_provider_and_receiver(
  14353. "PUT", path, headers, body.data(), body.size(), nullptr, nullptr,
  14354. content_type, nullptr, progress);
  14355. }
  14356. inline Result ClientImpl::Put(const std::string &path, const Headers &headers,
  14357. size_t content_length,
  14358. ContentProvider content_provider,
  14359. const std::string &content_type,
  14360. UploadProgress progress) {
  14361. return send_with_content_provider_and_receiver(
  14362. "PUT", path, headers, nullptr, content_length,
  14363. std::move(content_provider), nullptr, content_type, nullptr, progress);
  14364. }
  14365. inline Result ClientImpl::Put(const std::string &path, const Headers &headers,
  14366. size_t content_length,
  14367. ContentProvider content_provider,
  14368. const std::string &content_type,
  14369. ContentReceiver content_receiver,
  14370. UploadProgress progress) {
  14371. return send_with_content_provider_and_receiver(
  14372. "PUT", path, headers, nullptr, content_length,
  14373. std::move(content_provider), nullptr, content_type,
  14374. std::move(content_receiver), progress);
  14375. }
  14376. inline Result ClientImpl::Put(const std::string &path, const Headers &headers,
  14377. ContentProviderWithoutLength content_provider,
  14378. const std::string &content_type,
  14379. UploadProgress progress) {
  14380. return send_with_content_provider_and_receiver(
  14381. "PUT", path, headers, nullptr, 0, nullptr, std::move(content_provider),
  14382. content_type, nullptr, progress);
  14383. }
  14384. inline Result ClientImpl::Put(const std::string &path, const Headers &headers,
  14385. ContentProviderWithoutLength content_provider,
  14386. const std::string &content_type,
  14387. ContentReceiver content_receiver,
  14388. UploadProgress progress) {
  14389. return send_with_content_provider_and_receiver(
  14390. "PUT", path, headers, nullptr, 0, nullptr, std::move(content_provider),
  14391. content_type, std::move(content_receiver), progress);
  14392. }
  14393. inline Result ClientImpl::Put(const std::string &path, const Headers &headers,
  14394. const UploadFormDataItems &items,
  14395. const FormDataProviderItems &provider_items,
  14396. UploadProgress progress) {
  14397. const auto &boundary = detail::make_multipart_data_boundary();
  14398. const auto &content_type =
  14399. detail::serialize_multipart_formdata_get_content_type(boundary);
  14400. return send_with_content_provider_and_receiver(
  14401. "PUT", path, headers, nullptr, 0, nullptr,
  14402. get_multipart_content_provider(boundary, items, provider_items),
  14403. content_type, nullptr, progress);
  14404. }
  14405. inline Result ClientImpl::Put(const std::string &path, const Headers &headers,
  14406. const std::string &body,
  14407. const std::string &content_type,
  14408. ContentReceiver content_receiver,
  14409. DownloadProgress progress) {
  14410. Request req;
  14411. req.method = "PUT";
  14412. req.path = path;
  14413. req.headers = headers;
  14414. req.body = body;
  14415. req.content_receiver =
  14416. [content_receiver](const char *data, size_t data_length,
  14417. size_t /*offset*/, size_t /*total_length*/) {
  14418. return content_receiver(data, data_length);
  14419. };
  14420. req.download_progress = std::move(progress);
  14421. if (max_timeout_msec_ > 0) {
  14422. req.start_time_ = std::chrono::steady_clock::now();
  14423. }
  14424. if (!content_type.empty()) { req.set_header("Content-Type", content_type); }
  14425. return send_(std::move(req));
  14426. }
  14427. inline Result ClientImpl::Patch(const std::string &path) {
  14428. return Patch(path, std::string(), std::string());
  14429. }
  14430. inline Result ClientImpl::Patch(const std::string &path, const Headers &headers,
  14431. UploadProgress progress) {
  14432. return Patch(path, headers, nullptr, 0, std::string(), progress);
  14433. }
  14434. inline Result ClientImpl::Patch(const std::string &path, const char *body,
  14435. size_t content_length,
  14436. const std::string &content_type,
  14437. UploadProgress progress) {
  14438. return Patch(path, Headers(), body, content_length, content_type, progress);
  14439. }
  14440. inline Result ClientImpl::Patch(const std::string &path,
  14441. const std::string &body,
  14442. const std::string &content_type,
  14443. UploadProgress progress) {
  14444. return Patch(path, Headers(), body, content_type, progress);
  14445. }
  14446. inline Result ClientImpl::Patch(const std::string &path, const Params &params) {
  14447. return Patch(path, Headers(), params);
  14448. }
  14449. inline Result ClientImpl::Patch(const std::string &path, size_t content_length,
  14450. ContentProvider content_provider,
  14451. const std::string &content_type,
  14452. UploadProgress progress) {
  14453. return Patch(path, Headers(), content_length, std::move(content_provider),
  14454. content_type, progress);
  14455. }
  14456. inline Result ClientImpl::Patch(const std::string &path, size_t content_length,
  14457. ContentProvider content_provider,
  14458. const std::string &content_type,
  14459. ContentReceiver content_receiver,
  14460. UploadProgress progress) {
  14461. return Patch(path, Headers(), content_length, std::move(content_provider),
  14462. content_type, std::move(content_receiver), progress);
  14463. }
  14464. inline Result ClientImpl::Patch(const std::string &path,
  14465. ContentProviderWithoutLength content_provider,
  14466. const std::string &content_type,
  14467. UploadProgress progress) {
  14468. return Patch(path, Headers(), std::move(content_provider), content_type,
  14469. progress);
  14470. }
  14471. inline Result ClientImpl::Patch(const std::string &path,
  14472. ContentProviderWithoutLength content_provider,
  14473. const std::string &content_type,
  14474. ContentReceiver content_receiver,
  14475. UploadProgress progress) {
  14476. return Patch(path, Headers(), std::move(content_provider), content_type,
  14477. std::move(content_receiver), progress);
  14478. }
  14479. inline Result ClientImpl::Patch(const std::string &path, const Headers &headers,
  14480. const Params &params) {
  14481. auto query = detail::params_to_query_str(params);
  14482. return Patch(path, headers, query, "application/x-www-form-urlencoded");
  14483. }
  14484. inline Result ClientImpl::Patch(const std::string &path,
  14485. const UploadFormDataItems &items,
  14486. UploadProgress progress) {
  14487. return Patch(path, Headers(), items, progress);
  14488. }
  14489. inline Result ClientImpl::Patch(const std::string &path, const Headers &headers,
  14490. const UploadFormDataItems &items,
  14491. UploadProgress progress) {
  14492. const auto &boundary = detail::make_multipart_data_boundary();
  14493. const auto &content_type =
  14494. detail::serialize_multipart_formdata_get_content_type(boundary);
  14495. auto content_length = detail::get_multipart_content_length(items, boundary);
  14496. return Patch(path, headers, content_length,
  14497. detail::make_multipart_content_provider(items, boundary),
  14498. content_type, progress);
  14499. }
  14500. inline Result ClientImpl::Patch(const std::string &path, const Headers &headers,
  14501. const UploadFormDataItems &items,
  14502. const std::string &boundary,
  14503. UploadProgress progress) {
  14504. if (!detail::is_multipart_boundary_chars_valid(boundary)) {
  14505. return Result{nullptr, Error::UnsupportedMultipartBoundaryChars};
  14506. }
  14507. const auto &content_type =
  14508. detail::serialize_multipart_formdata_get_content_type(boundary);
  14509. auto content_length = detail::get_multipart_content_length(items, boundary);
  14510. return Patch(path, headers, content_length,
  14511. detail::make_multipart_content_provider(items, boundary),
  14512. content_type, progress);
  14513. }
  14514. inline Result ClientImpl::Patch(const std::string &path, const Headers &headers,
  14515. const char *body, size_t content_length,
  14516. const std::string &content_type,
  14517. UploadProgress progress) {
  14518. return send_with_content_provider_and_receiver(
  14519. "PATCH", path, headers, body, content_length, nullptr, nullptr,
  14520. content_type, nullptr, progress);
  14521. }
  14522. inline Result ClientImpl::Patch(const std::string &path, const Headers &headers,
  14523. const std::string &body,
  14524. const std::string &content_type,
  14525. UploadProgress progress) {
  14526. return send_with_content_provider_and_receiver(
  14527. "PATCH", path, headers, body.data(), body.size(), nullptr, nullptr,
  14528. content_type, nullptr, progress);
  14529. }
  14530. inline Result ClientImpl::Patch(const std::string &path, const Headers &headers,
  14531. size_t content_length,
  14532. ContentProvider content_provider,
  14533. const std::string &content_type,
  14534. UploadProgress progress) {
  14535. return send_with_content_provider_and_receiver(
  14536. "PATCH", path, headers, nullptr, content_length,
  14537. std::move(content_provider), nullptr, content_type, nullptr, progress);
  14538. }
  14539. inline Result ClientImpl::Patch(const std::string &path, const Headers &headers,
  14540. size_t content_length,
  14541. ContentProvider content_provider,
  14542. const std::string &content_type,
  14543. ContentReceiver content_receiver,
  14544. UploadProgress progress) {
  14545. return send_with_content_provider_and_receiver(
  14546. "PATCH", path, headers, nullptr, content_length,
  14547. std::move(content_provider), nullptr, content_type,
  14548. std::move(content_receiver), progress);
  14549. }
  14550. inline Result ClientImpl::Patch(const std::string &path, const Headers &headers,
  14551. ContentProviderWithoutLength content_provider,
  14552. const std::string &content_type,
  14553. UploadProgress progress) {
  14554. return send_with_content_provider_and_receiver(
  14555. "PATCH", path, headers, nullptr, 0, nullptr, std::move(content_provider),
  14556. content_type, nullptr, progress);
  14557. }
  14558. inline Result ClientImpl::Patch(const std::string &path, const Headers &headers,
  14559. ContentProviderWithoutLength content_provider,
  14560. const std::string &content_type,
  14561. ContentReceiver content_receiver,
  14562. UploadProgress progress) {
  14563. return send_with_content_provider_and_receiver(
  14564. "PATCH", path, headers, nullptr, 0, nullptr, std::move(content_provider),
  14565. content_type, std::move(content_receiver), progress);
  14566. }
  14567. inline Result ClientImpl::Patch(const std::string &path, const Headers &headers,
  14568. const UploadFormDataItems &items,
  14569. const FormDataProviderItems &provider_items,
  14570. UploadProgress progress) {
  14571. const auto &boundary = detail::make_multipart_data_boundary();
  14572. const auto &content_type =
  14573. detail::serialize_multipart_formdata_get_content_type(boundary);
  14574. return send_with_content_provider_and_receiver(
  14575. "PATCH", path, headers, nullptr, 0, nullptr,
  14576. get_multipart_content_provider(boundary, items, provider_items),
  14577. content_type, nullptr, progress);
  14578. }
  14579. inline Result ClientImpl::Patch(const std::string &path, const Headers &headers,
  14580. const std::string &body,
  14581. const std::string &content_type,
  14582. ContentReceiver content_receiver,
  14583. DownloadProgress progress) {
  14584. Request req;
  14585. req.method = "PATCH";
  14586. req.path = path;
  14587. req.headers = headers;
  14588. req.body = body;
  14589. req.content_receiver =
  14590. [content_receiver](const char *data, size_t data_length,
  14591. size_t /*offset*/, size_t /*total_length*/) {
  14592. return content_receiver(data, data_length);
  14593. };
  14594. req.download_progress = std::move(progress);
  14595. if (max_timeout_msec_ > 0) {
  14596. req.start_time_ = std::chrono::steady_clock::now();
  14597. }
  14598. if (!content_type.empty()) { req.set_header("Content-Type", content_type); }
  14599. return send_(std::move(req));
  14600. }
  14601. inline Result ClientImpl::Delete(const std::string &path,
  14602. DownloadProgress progress) {
  14603. return Delete(path, Headers(), std::string(), std::string(), progress);
  14604. }
  14605. inline Result ClientImpl::Delete(const std::string &path,
  14606. const Headers &headers,
  14607. DownloadProgress progress) {
  14608. return Delete(path, headers, std::string(), std::string(), progress);
  14609. }
  14610. inline Result ClientImpl::Delete(const std::string &path, const char *body,
  14611. size_t content_length,
  14612. const std::string &content_type,
  14613. DownloadProgress progress) {
  14614. return Delete(path, Headers(), body, content_length, content_type, progress);
  14615. }
  14616. inline Result ClientImpl::Delete(const std::string &path,
  14617. const std::string &body,
  14618. const std::string &content_type,
  14619. DownloadProgress progress) {
  14620. return Delete(path, Headers(), body.data(), body.size(), content_type,
  14621. progress);
  14622. }
  14623. inline Result ClientImpl::Delete(const std::string &path,
  14624. const Headers &headers,
  14625. const std::string &body,
  14626. const std::string &content_type,
  14627. DownloadProgress progress) {
  14628. return Delete(path, headers, body.data(), body.size(), content_type,
  14629. progress);
  14630. }
  14631. inline Result ClientImpl::Delete(const std::string &path, const Params &params,
  14632. DownloadProgress progress) {
  14633. return Delete(path, Headers(), params, progress);
  14634. }
  14635. inline Result ClientImpl::Delete(const std::string &path,
  14636. const Headers &headers, const Params &params,
  14637. DownloadProgress progress) {
  14638. auto query = detail::params_to_query_str(params);
  14639. return Delete(path, headers, query, "application/x-www-form-urlencoded",
  14640. progress);
  14641. }
  14642. inline Result ClientImpl::Delete(const std::string &path,
  14643. const Headers &headers, const char *body,
  14644. size_t content_length,
  14645. const std::string &content_type,
  14646. DownloadProgress progress) {
  14647. Request req;
  14648. req.method = "DELETE";
  14649. req.headers = headers;
  14650. req.path = path;
  14651. req.download_progress = std::move(progress);
  14652. if (max_timeout_msec_ > 0) {
  14653. req.start_time_ = std::chrono::steady_clock::now();
  14654. }
  14655. if (!content_type.empty()) { req.set_header("Content-Type", content_type); }
  14656. req.body.assign(body, content_length);
  14657. return send_(std::move(req));
  14658. }
  14659. inline Result ClientImpl::Options(const std::string &path) {
  14660. return Options(path, Headers());
  14661. }
  14662. inline Result ClientImpl::Options(const std::string &path,
  14663. const Headers &headers) {
  14664. Request req;
  14665. req.method = "OPTIONS";
  14666. req.headers = headers;
  14667. req.path = path;
  14668. if (max_timeout_msec_ > 0) {
  14669. req.start_time_ = std::chrono::steady_clock::now();
  14670. }
  14671. return send_(std::move(req));
  14672. }
  14673. inline void ClientImpl::stop() {
  14674. std::lock_guard<std::mutex> guard(socket_mutex_);
  14675. // If there is anything ongoing right now, the ONLY thread-safe thing we can
  14676. // do is to shutdown_socket, so that threads using this socket suddenly
  14677. // discover they can't read/write any more and error out. Everything else
  14678. // (closing the socket, shutting ssl down) is unsafe because these actions
  14679. // are not thread-safe.
  14680. if (socket_requests_in_flight_ > 0) {
  14681. shutdown_socket(socket_);
  14682. // Aside from that, we set a flag for the socket to be closed when we're
  14683. // done.
  14684. socket_should_be_closed_when_request_is_done_ = true;
  14685. return;
  14686. }
  14687. disconnect(/*gracefully=*/true);
  14688. }
  14689. inline std::string ClientImpl::host() const { return host_; }
  14690. inline int ClientImpl::port() const { return port_; }
  14691. inline size_t ClientImpl::is_socket_open() const {
  14692. std::lock_guard<std::mutex> guard(socket_mutex_);
  14693. return socket_.is_open();
  14694. }
  14695. inline socket_t ClientImpl::socket() const { return socket_.sock; }
  14696. inline void ClientImpl::set_connection_timeout(time_t sec, time_t usec) {
  14697. connection_timeout_sec_ = sec;
  14698. connection_timeout_usec_ = usec;
  14699. }
  14700. inline void ClientImpl::set_read_timeout(time_t sec, time_t usec) {
  14701. read_timeout_sec_ = sec;
  14702. read_timeout_usec_ = usec;
  14703. }
  14704. inline void ClientImpl::set_write_timeout(time_t sec, time_t usec) {
  14705. write_timeout_sec_ = sec;
  14706. write_timeout_usec_ = usec;
  14707. }
  14708. inline void ClientImpl::set_max_timeout(time_t msec) {
  14709. max_timeout_msec_ = msec;
  14710. }
  14711. inline void ClientImpl::set_basic_auth(const std::string &username,
  14712. const std::string &password) {
  14713. basic_auth_username_ = username;
  14714. basic_auth_password_ = password;
  14715. }
  14716. inline void ClientImpl::set_bearer_token_auth(const std::string &token) {
  14717. bearer_token_auth_token_ = token;
  14718. }
  14719. inline void ClientImpl::set_keep_alive(bool on) { keep_alive_ = on; }
  14720. inline void ClientImpl::set_follow_location(bool on) { follow_location_ = on; }
  14721. inline void ClientImpl::set_path_encode(bool on) { path_encode_ = on; }
  14722. inline void
  14723. ClientImpl::set_hostname_addr_map(std::map<std::string, std::string> addr_map) {
  14724. addr_map_ = std::move(addr_map);
  14725. }
  14726. inline void ClientImpl::set_default_headers(Headers headers) {
  14727. default_headers_ = std::move(headers);
  14728. }
  14729. inline void ClientImpl::set_header_writer(
  14730. std::function<ssize_t(Stream &, Headers &)> const &writer) {
  14731. header_writer_ = writer;
  14732. }
  14733. inline void ClientImpl::set_address_family(int family) {
  14734. address_family_ = family;
  14735. }
  14736. inline void ClientImpl::set_tcp_nodelay(bool on) { tcp_nodelay_ = on; }
  14737. inline void ClientImpl::set_ipv6_v6only(bool on) { ipv6_v6only_ = on; }
  14738. inline void ClientImpl::set_socket_options(SocketOptions socket_options) {
  14739. socket_options_ = std::move(socket_options);
  14740. }
  14741. inline void ClientImpl::set_compress(bool on) { compress_ = on; }
  14742. inline void ClientImpl::set_decompress(bool on) { decompress_ = on; }
  14743. inline void ClientImpl::set_payload_max_length(size_t length) {
  14744. payload_max_length_ = length;
  14745. has_payload_max_length_ = true;
  14746. }
  14747. inline void ClientImpl::set_interface(const std::string &intf) {
  14748. interface_ = intf;
  14749. }
  14750. inline void ClientImpl::set_proxy(const std::string &host, int port) {
  14751. proxy_host_ = host;
  14752. proxy_port_ = port;
  14753. std::lock_guard<std::mutex> guard(socket_mutex_);
  14754. disconnect(/*gracefully=*/true);
  14755. }
  14756. inline void ClientImpl::set_proxy_basic_auth(const std::string &username,
  14757. const std::string &password) {
  14758. proxy_basic_auth_username_ = username;
  14759. proxy_basic_auth_password_ = password;
  14760. }
  14761. inline void ClientImpl::set_proxy_bearer_token_auth(const std::string &token) {
  14762. proxy_bearer_token_auth_token_ = token;
  14763. }
  14764. inline void ClientImpl::set_no_proxy(const std::vector<std::string> &patterns) {
  14765. std::vector<detail::NoProxyEntry> parsed;
  14766. parsed.reserve(patterns.size());
  14767. for (const auto &p : patterns) {
  14768. auto trimmed = detail::trim_copy(p);
  14769. if (trimmed.empty()) { continue; }
  14770. detail::NoProxyEntry entry;
  14771. if (detail::parse_no_proxy_entry(trimmed, entry)) {
  14772. parsed.push_back(std::move(entry));
  14773. }
  14774. }
  14775. no_proxy_entries_ = std::move(parsed);
  14776. std::lock_guard<std::mutex> guard(socket_mutex_);
  14777. disconnect(/*gracefully=*/true);
  14778. }
  14779. #ifdef CPPHTTPLIB_SSL_ENABLED
  14780. inline void ClientImpl::set_digest_auth(const std::string &username,
  14781. const std::string &password) {
  14782. digest_auth_username_ = username;
  14783. digest_auth_password_ = password;
  14784. }
  14785. inline void ClientImpl::set_ca_cert_path(const std::string &ca_cert_file_path,
  14786. const std::string &ca_cert_dir_path) {
  14787. ca_cert_file_path_ = ca_cert_file_path;
  14788. ca_cert_dir_path_ = ca_cert_dir_path;
  14789. }
  14790. inline void ClientImpl::set_proxy_digest_auth(const std::string &username,
  14791. const std::string &password) {
  14792. proxy_digest_auth_username_ = username;
  14793. proxy_digest_auth_password_ = password;
  14794. }
  14795. inline void ClientImpl::enable_server_certificate_verification(bool enabled) {
  14796. server_certificate_verification_ = enabled;
  14797. }
  14798. inline void ClientImpl::enable_server_hostname_verification(bool enabled) {
  14799. server_hostname_verification_ = enabled;
  14800. }
  14801. inline void ClientImpl::enable_system_ca(bool enabled) {
  14802. system_ca_mode_ = enabled ? SystemCAMode::Enabled : SystemCAMode::Disabled;
  14803. }
  14804. #endif
  14805. inline void ClientImpl::set_logger(Logger logger) {
  14806. logger_ = std::move(logger);
  14807. }
  14808. inline void ClientImpl::set_error_logger(ErrorLogger error_logger) {
  14809. error_logger_ = std::move(error_logger);
  14810. }
  14811. /*
  14812. * SSL/TLS Common Implementation
  14813. */
  14814. inline ClientConnection::~ClientConnection() {
  14815. #ifdef CPPHTTPLIB_SSL_ENABLED
  14816. if (session) {
  14817. tls::shutdown(session, true);
  14818. tls::free_session(session);
  14819. session = nullptr;
  14820. }
  14821. #endif
  14822. if (sock != INVALID_SOCKET) {
  14823. detail::close_socket(sock);
  14824. sock = INVALID_SOCKET;
  14825. }
  14826. }
  14827. // Universal client implementation
  14828. inline Client::Client(const std::string &scheme_host_port)
  14829. : Client(scheme_host_port, std::string(), std::string()) {}
  14830. inline Client::Client(const std::string &scheme_host_port,
  14831. const std::string &client_cert_path,
  14832. const std::string &client_key_path) {
  14833. detail::UrlComponents uc;
  14834. if (detail::parse_url(scheme_host_port, uc) && !uc.host.empty()) {
  14835. auto &scheme = uc.scheme;
  14836. #ifdef CPPHTTPLIB_SSL_ENABLED
  14837. if (!scheme.empty() && (scheme != "http" && scheme != "https")) {
  14838. #else
  14839. if (!scheme.empty() && scheme != "http") {
  14840. #endif
  14841. #ifndef CPPHTTPLIB_NO_EXCEPTIONS
  14842. std::string msg = "'" + scheme + "' scheme is not supported.";
  14843. throw std::invalid_argument(msg);
  14844. #endif
  14845. return;
  14846. }
  14847. auto is_ssl = scheme == "https";
  14848. auto host = std::move(uc.host);
  14849. auto port = is_ssl ? 443 : 80;
  14850. if (!uc.port.empty() && !detail::parse_port(uc.port, port)) { return; }
  14851. if (is_ssl) {
  14852. #ifdef CPPHTTPLIB_SSL_ENABLED
  14853. cli_ = detail::make_unique<SSLClient>(host, port, client_cert_path,
  14854. client_key_path);
  14855. is_ssl_ = is_ssl;
  14856. #endif
  14857. } else {
  14858. cli_ = detail::make_unique<ClientImpl>(host, port, client_cert_path,
  14859. client_key_path);
  14860. }
  14861. } else {
  14862. // NOTE: Update TEST(UniversalClientImplTest, Ipv6LiteralAddress)
  14863. // if port param below changes.
  14864. cli_ = detail::make_unique<ClientImpl>(scheme_host_port, 80,
  14865. client_cert_path, client_key_path);
  14866. }
  14867. }
  14868. inline Client::Client(const std::string &host, int port)
  14869. : Client(host, port, std::string(), std::string()) {}
  14870. inline Client::Client(const std::string &host, int port,
  14871. const std::string &client_cert_path,
  14872. const std::string &client_key_path)
  14873. : cli_(detail::make_unique<ClientImpl>(host, port, client_cert_path,
  14874. client_key_path)) {}
  14875. inline Client::~Client() = default;
  14876. inline bool Client::is_valid() const {
  14877. return cli_ != nullptr && cli_->is_valid();
  14878. }
  14879. inline Result Client::Get(const std::string &path, DownloadProgress progress) {
  14880. return cli_->Get(path, std::move(progress));
  14881. }
  14882. inline Result Client::Get(const std::string &path, const Headers &headers,
  14883. DownloadProgress progress) {
  14884. return cli_->Get(path, headers, std::move(progress));
  14885. }
  14886. inline Result Client::Get(const std::string &path,
  14887. ContentReceiver content_receiver,
  14888. DownloadProgress progress) {
  14889. return cli_->Get(path, std::move(content_receiver), std::move(progress));
  14890. }
  14891. inline Result Client::Get(const std::string &path, const Headers &headers,
  14892. ContentReceiver content_receiver,
  14893. DownloadProgress progress) {
  14894. return cli_->Get(path, headers, std::move(content_receiver),
  14895. std::move(progress));
  14896. }
  14897. inline Result Client::Get(const std::string &path,
  14898. ResponseHandler response_handler,
  14899. ContentReceiver content_receiver,
  14900. DownloadProgress progress) {
  14901. return cli_->Get(path, std::move(response_handler),
  14902. std::move(content_receiver), std::move(progress));
  14903. }
  14904. inline Result Client::Get(const std::string &path, const Headers &headers,
  14905. ResponseHandler response_handler,
  14906. ContentReceiver content_receiver,
  14907. DownloadProgress progress) {
  14908. return cli_->Get(path, headers, std::move(response_handler),
  14909. std::move(content_receiver), std::move(progress));
  14910. }
  14911. inline Result Client::Get(const std::string &path, const Params &params,
  14912. DownloadProgress progress) {
  14913. return cli_->Get(path, params, std::move(progress));
  14914. }
  14915. inline Result Client::Get(const std::string &path, const Params &params,
  14916. const Headers &headers, DownloadProgress progress) {
  14917. return cli_->Get(path, params, headers, std::move(progress));
  14918. }
  14919. inline Result Client::Get(const std::string &path, const Params &params,
  14920. const Headers &headers,
  14921. ContentReceiver content_receiver,
  14922. DownloadProgress progress) {
  14923. return cli_->Get(path, params, headers, std::move(content_receiver),
  14924. std::move(progress));
  14925. }
  14926. inline Result Client::Get(const std::string &path, const Params &params,
  14927. const Headers &headers,
  14928. ResponseHandler response_handler,
  14929. ContentReceiver content_receiver,
  14930. DownloadProgress progress) {
  14931. return cli_->Get(path, params, headers, std::move(response_handler),
  14932. std::move(content_receiver), std::move(progress));
  14933. }
  14934. inline Result Client::Head(const std::string &path) { return cli_->Head(path); }
  14935. inline Result Client::Head(const std::string &path, const Headers &headers) {
  14936. return cli_->Head(path, headers);
  14937. }
  14938. inline Result Client::Post(const std::string &path) { return cli_->Post(path); }
  14939. inline Result Client::Post(const std::string &path, const Headers &headers) {
  14940. return cli_->Post(path, headers);
  14941. }
  14942. inline Result Client::Post(const std::string &path, const char *body,
  14943. size_t content_length,
  14944. const std::string &content_type,
  14945. UploadProgress progress) {
  14946. return cli_->Post(path, body, content_length, content_type, progress);
  14947. }
  14948. inline Result Client::Post(const std::string &path, const Headers &headers,
  14949. const char *body, size_t content_length,
  14950. const std::string &content_type,
  14951. UploadProgress progress) {
  14952. return cli_->Post(path, headers, body, content_length, content_type,
  14953. progress);
  14954. }
  14955. inline Result Client::Post(const std::string &path, const std::string &body,
  14956. const std::string &content_type,
  14957. UploadProgress progress) {
  14958. return cli_->Post(path, body, content_type, progress);
  14959. }
  14960. inline Result Client::Post(const std::string &path, const Headers &headers,
  14961. const std::string &body,
  14962. const std::string &content_type,
  14963. UploadProgress progress) {
  14964. return cli_->Post(path, headers, body, content_type, progress);
  14965. }
  14966. inline Result Client::Post(const std::string &path, size_t content_length,
  14967. ContentProvider content_provider,
  14968. const std::string &content_type,
  14969. UploadProgress progress) {
  14970. return cli_->Post(path, content_length, std::move(content_provider),
  14971. content_type, progress);
  14972. }
  14973. inline Result Client::Post(const std::string &path, size_t content_length,
  14974. ContentProvider content_provider,
  14975. const std::string &content_type,
  14976. ContentReceiver content_receiver,
  14977. UploadProgress progress) {
  14978. return cli_->Post(path, content_length, std::move(content_provider),
  14979. content_type, std::move(content_receiver), progress);
  14980. }
  14981. inline Result Client::Post(const std::string &path,
  14982. ContentProviderWithoutLength content_provider,
  14983. const std::string &content_type,
  14984. UploadProgress progress) {
  14985. return cli_->Post(path, std::move(content_provider), content_type, progress);
  14986. }
  14987. inline Result Client::Post(const std::string &path,
  14988. ContentProviderWithoutLength content_provider,
  14989. const std::string &content_type,
  14990. ContentReceiver content_receiver,
  14991. UploadProgress progress) {
  14992. return cli_->Post(path, std::move(content_provider), content_type,
  14993. std::move(content_receiver), progress);
  14994. }
  14995. inline Result Client::Post(const std::string &path, const Headers &headers,
  14996. size_t content_length,
  14997. ContentProvider content_provider,
  14998. const std::string &content_type,
  14999. UploadProgress progress) {
  15000. return cli_->Post(path, headers, content_length, std::move(content_provider),
  15001. content_type, progress);
  15002. }
  15003. inline Result Client::Post(const std::string &path, const Headers &headers,
  15004. size_t content_length,
  15005. ContentProvider content_provider,
  15006. const std::string &content_type,
  15007. ContentReceiver content_receiver,
  15008. DownloadProgress progress) {
  15009. return cli_->Post(path, headers, content_length, std::move(content_provider),
  15010. content_type, std::move(content_receiver), progress);
  15011. }
  15012. inline Result Client::Post(const std::string &path, const Headers &headers,
  15013. ContentProviderWithoutLength content_provider,
  15014. const std::string &content_type,
  15015. UploadProgress progress) {
  15016. return cli_->Post(path, headers, std::move(content_provider), content_type,
  15017. progress);
  15018. }
  15019. inline Result Client::Post(const std::string &path, const Headers &headers,
  15020. ContentProviderWithoutLength content_provider,
  15021. const std::string &content_type,
  15022. ContentReceiver content_receiver,
  15023. DownloadProgress progress) {
  15024. return cli_->Post(path, headers, std::move(content_provider), content_type,
  15025. std::move(content_receiver), progress);
  15026. }
  15027. inline Result Client::Post(const std::string &path, const Params &params) {
  15028. return cli_->Post(path, params);
  15029. }
  15030. inline Result Client::Post(const std::string &path, const Headers &headers,
  15031. const Params &params) {
  15032. return cli_->Post(path, headers, params);
  15033. }
  15034. inline Result Client::Post(const std::string &path,
  15035. const UploadFormDataItems &items,
  15036. UploadProgress progress) {
  15037. return cli_->Post(path, items, progress);
  15038. }
  15039. inline Result Client::Post(const std::string &path, const Headers &headers,
  15040. const UploadFormDataItems &items,
  15041. UploadProgress progress) {
  15042. return cli_->Post(path, headers, items, progress);
  15043. }
  15044. inline Result Client::Post(const std::string &path, const Headers &headers,
  15045. const UploadFormDataItems &items,
  15046. const std::string &boundary,
  15047. UploadProgress progress) {
  15048. return cli_->Post(path, headers, items, boundary, progress);
  15049. }
  15050. inline Result Client::Post(const std::string &path, const Headers &headers,
  15051. const UploadFormDataItems &items,
  15052. const FormDataProviderItems &provider_items,
  15053. UploadProgress progress) {
  15054. return cli_->Post(path, headers, items, provider_items, progress);
  15055. }
  15056. inline Result Client::Post(const std::string &path, const Headers &headers,
  15057. const std::string &body,
  15058. const std::string &content_type,
  15059. ContentReceiver content_receiver,
  15060. DownloadProgress progress) {
  15061. return cli_->Post(path, headers, body, content_type,
  15062. std::move(content_receiver), progress);
  15063. }
  15064. inline Result Client::Put(const std::string &path) { return cli_->Put(path); }
  15065. inline Result Client::Put(const std::string &path, const Headers &headers) {
  15066. return cli_->Put(path, headers);
  15067. }
  15068. inline Result Client::Put(const std::string &path, const char *body,
  15069. size_t content_length,
  15070. const std::string &content_type,
  15071. UploadProgress progress) {
  15072. return cli_->Put(path, body, content_length, content_type, progress);
  15073. }
  15074. inline Result Client::Put(const std::string &path, const Headers &headers,
  15075. const char *body, size_t content_length,
  15076. const std::string &content_type,
  15077. UploadProgress progress) {
  15078. return cli_->Put(path, headers, body, content_length, content_type, progress);
  15079. }
  15080. inline Result Client::Put(const std::string &path, const std::string &body,
  15081. const std::string &content_type,
  15082. UploadProgress progress) {
  15083. return cli_->Put(path, body, content_type, progress);
  15084. }
  15085. inline Result Client::Put(const std::string &path, const Headers &headers,
  15086. const std::string &body,
  15087. const std::string &content_type,
  15088. UploadProgress progress) {
  15089. return cli_->Put(path, headers, body, content_type, progress);
  15090. }
  15091. inline Result Client::Put(const std::string &path, size_t content_length,
  15092. ContentProvider content_provider,
  15093. const std::string &content_type,
  15094. UploadProgress progress) {
  15095. return cli_->Put(path, content_length, std::move(content_provider),
  15096. content_type, progress);
  15097. }
  15098. inline Result Client::Put(const std::string &path, size_t content_length,
  15099. ContentProvider content_provider,
  15100. const std::string &content_type,
  15101. ContentReceiver content_receiver,
  15102. UploadProgress progress) {
  15103. return cli_->Put(path, content_length, std::move(content_provider),
  15104. content_type, std::move(content_receiver), progress);
  15105. }
  15106. inline Result Client::Put(const std::string &path,
  15107. ContentProviderWithoutLength content_provider,
  15108. const std::string &content_type,
  15109. UploadProgress progress) {
  15110. return cli_->Put(path, std::move(content_provider), content_type, progress);
  15111. }
  15112. inline Result Client::Put(const std::string &path,
  15113. ContentProviderWithoutLength content_provider,
  15114. const std::string &content_type,
  15115. ContentReceiver content_receiver,
  15116. UploadProgress progress) {
  15117. return cli_->Put(path, std::move(content_provider), content_type,
  15118. std::move(content_receiver), progress);
  15119. }
  15120. inline Result Client::Put(const std::string &path, const Headers &headers,
  15121. size_t content_length,
  15122. ContentProvider content_provider,
  15123. const std::string &content_type,
  15124. UploadProgress progress) {
  15125. return cli_->Put(path, headers, content_length, std::move(content_provider),
  15126. content_type, progress);
  15127. }
  15128. inline Result Client::Put(const std::string &path, const Headers &headers,
  15129. size_t content_length,
  15130. ContentProvider content_provider,
  15131. const std::string &content_type,
  15132. ContentReceiver content_receiver,
  15133. UploadProgress progress) {
  15134. return cli_->Put(path, headers, content_length, std::move(content_provider),
  15135. content_type, std::move(content_receiver), progress);
  15136. }
  15137. inline Result Client::Put(const std::string &path, const Headers &headers,
  15138. ContentProviderWithoutLength content_provider,
  15139. const std::string &content_type,
  15140. UploadProgress progress) {
  15141. return cli_->Put(path, headers, std::move(content_provider), content_type,
  15142. progress);
  15143. }
  15144. inline Result Client::Put(const std::string &path, const Headers &headers,
  15145. ContentProviderWithoutLength content_provider,
  15146. const std::string &content_type,
  15147. ContentReceiver content_receiver,
  15148. UploadProgress progress) {
  15149. return cli_->Put(path, headers, std::move(content_provider), content_type,
  15150. std::move(content_receiver), progress);
  15151. }
  15152. inline Result Client::Put(const std::string &path, const Params &params) {
  15153. return cli_->Put(path, params);
  15154. }
  15155. inline Result Client::Put(const std::string &path, const Headers &headers,
  15156. const Params &params) {
  15157. return cli_->Put(path, headers, params);
  15158. }
  15159. inline Result Client::Put(const std::string &path,
  15160. const UploadFormDataItems &items,
  15161. UploadProgress progress) {
  15162. return cli_->Put(path, items, progress);
  15163. }
  15164. inline Result Client::Put(const std::string &path, const Headers &headers,
  15165. const UploadFormDataItems &items,
  15166. UploadProgress progress) {
  15167. return cli_->Put(path, headers, items, progress);
  15168. }
  15169. inline Result Client::Put(const std::string &path, const Headers &headers,
  15170. const UploadFormDataItems &items,
  15171. const std::string &boundary,
  15172. UploadProgress progress) {
  15173. return cli_->Put(path, headers, items, boundary, progress);
  15174. }
  15175. inline Result Client::Put(const std::string &path, const Headers &headers,
  15176. const UploadFormDataItems &items,
  15177. const FormDataProviderItems &provider_items,
  15178. UploadProgress progress) {
  15179. return cli_->Put(path, headers, items, provider_items, progress);
  15180. }
  15181. inline Result Client::Put(const std::string &path, const Headers &headers,
  15182. const std::string &body,
  15183. const std::string &content_type,
  15184. ContentReceiver content_receiver,
  15185. DownloadProgress progress) {
  15186. return cli_->Put(path, headers, body, content_type, content_receiver,
  15187. progress);
  15188. }
  15189. inline Result Client::Patch(const std::string &path) {
  15190. return cli_->Patch(path);
  15191. }
  15192. inline Result Client::Patch(const std::string &path, const Headers &headers) {
  15193. return cli_->Patch(path, headers);
  15194. }
  15195. inline Result Client::Patch(const std::string &path, const char *body,
  15196. size_t content_length,
  15197. const std::string &content_type,
  15198. UploadProgress progress) {
  15199. return cli_->Patch(path, body, content_length, content_type, progress);
  15200. }
  15201. inline Result Client::Patch(const std::string &path, const Headers &headers,
  15202. const char *body, size_t content_length,
  15203. const std::string &content_type,
  15204. UploadProgress progress) {
  15205. return cli_->Patch(path, headers, body, content_length, content_type,
  15206. progress);
  15207. }
  15208. inline Result Client::Patch(const std::string &path, const std::string &body,
  15209. const std::string &content_type,
  15210. UploadProgress progress) {
  15211. return cli_->Patch(path, body, content_type, progress);
  15212. }
  15213. inline Result Client::Patch(const std::string &path, const Headers &headers,
  15214. const std::string &body,
  15215. const std::string &content_type,
  15216. UploadProgress progress) {
  15217. return cli_->Patch(path, headers, body, content_type, progress);
  15218. }
  15219. inline Result Client::Patch(const std::string &path, size_t content_length,
  15220. ContentProvider content_provider,
  15221. const std::string &content_type,
  15222. UploadProgress progress) {
  15223. return cli_->Patch(path, content_length, std::move(content_provider),
  15224. content_type, progress);
  15225. }
  15226. inline Result Client::Patch(const std::string &path, size_t content_length,
  15227. ContentProvider content_provider,
  15228. const std::string &content_type,
  15229. ContentReceiver content_receiver,
  15230. UploadProgress progress) {
  15231. return cli_->Patch(path, content_length, std::move(content_provider),
  15232. content_type, std::move(content_receiver), progress);
  15233. }
  15234. inline Result Client::Patch(const std::string &path,
  15235. ContentProviderWithoutLength content_provider,
  15236. const std::string &content_type,
  15237. UploadProgress progress) {
  15238. return cli_->Patch(path, std::move(content_provider), content_type, progress);
  15239. }
  15240. inline Result Client::Patch(const std::string &path,
  15241. ContentProviderWithoutLength content_provider,
  15242. const std::string &content_type,
  15243. ContentReceiver content_receiver,
  15244. UploadProgress progress) {
  15245. return cli_->Patch(path, std::move(content_provider), content_type,
  15246. std::move(content_receiver), progress);
  15247. }
  15248. inline Result Client::Patch(const std::string &path, const Headers &headers,
  15249. size_t content_length,
  15250. ContentProvider content_provider,
  15251. const std::string &content_type,
  15252. UploadProgress progress) {
  15253. return cli_->Patch(path, headers, content_length, std::move(content_provider),
  15254. content_type, progress);
  15255. }
  15256. inline Result Client::Patch(const std::string &path, const Headers &headers,
  15257. size_t content_length,
  15258. ContentProvider content_provider,
  15259. const std::string &content_type,
  15260. ContentReceiver content_receiver,
  15261. UploadProgress progress) {
  15262. return cli_->Patch(path, headers, content_length, std::move(content_provider),
  15263. content_type, std::move(content_receiver), progress);
  15264. }
  15265. inline Result Client::Patch(const std::string &path, const Headers &headers,
  15266. ContentProviderWithoutLength content_provider,
  15267. const std::string &content_type,
  15268. UploadProgress progress) {
  15269. return cli_->Patch(path, headers, std::move(content_provider), content_type,
  15270. progress);
  15271. }
  15272. inline Result Client::Patch(const std::string &path, const Headers &headers,
  15273. ContentProviderWithoutLength content_provider,
  15274. const std::string &content_type,
  15275. ContentReceiver content_receiver,
  15276. UploadProgress progress) {
  15277. return cli_->Patch(path, headers, std::move(content_provider), content_type,
  15278. std::move(content_receiver), progress);
  15279. }
  15280. inline Result Client::Patch(const std::string &path, const Params &params) {
  15281. return cli_->Patch(path, params);
  15282. }
  15283. inline Result Client::Patch(const std::string &path, const Headers &headers,
  15284. const Params &params) {
  15285. return cli_->Patch(path, headers, params);
  15286. }
  15287. inline Result Client::Patch(const std::string &path,
  15288. const UploadFormDataItems &items,
  15289. UploadProgress progress) {
  15290. return cli_->Patch(path, items, progress);
  15291. }
  15292. inline Result Client::Patch(const std::string &path, const Headers &headers,
  15293. const UploadFormDataItems &items,
  15294. UploadProgress progress) {
  15295. return cli_->Patch(path, headers, items, progress);
  15296. }
  15297. inline Result Client::Patch(const std::string &path, const Headers &headers,
  15298. const UploadFormDataItems &items,
  15299. const std::string &boundary,
  15300. UploadProgress progress) {
  15301. return cli_->Patch(path, headers, items, boundary, progress);
  15302. }
  15303. inline Result Client::Patch(const std::string &path, const Headers &headers,
  15304. const UploadFormDataItems &items,
  15305. const FormDataProviderItems &provider_items,
  15306. UploadProgress progress) {
  15307. return cli_->Patch(path, headers, items, provider_items, progress);
  15308. }
  15309. inline Result Client::Patch(const std::string &path, const Headers &headers,
  15310. const std::string &body,
  15311. const std::string &content_type,
  15312. ContentReceiver content_receiver,
  15313. DownloadProgress progress) {
  15314. return cli_->Patch(path, headers, body, content_type, content_receiver,
  15315. progress);
  15316. }
  15317. inline Result Client::Delete(const std::string &path,
  15318. DownloadProgress progress) {
  15319. return cli_->Delete(path, progress);
  15320. }
  15321. inline Result Client::Delete(const std::string &path, const Headers &headers,
  15322. DownloadProgress progress) {
  15323. return cli_->Delete(path, headers, progress);
  15324. }
  15325. inline Result Client::Delete(const std::string &path, const char *body,
  15326. size_t content_length,
  15327. const std::string &content_type,
  15328. DownloadProgress progress) {
  15329. return cli_->Delete(path, body, content_length, content_type, progress);
  15330. }
  15331. inline Result Client::Delete(const std::string &path, const Headers &headers,
  15332. const char *body, size_t content_length,
  15333. const std::string &content_type,
  15334. DownloadProgress progress) {
  15335. return cli_->Delete(path, headers, body, content_length, content_type,
  15336. progress);
  15337. }
  15338. inline Result Client::Delete(const std::string &path, const std::string &body,
  15339. const std::string &content_type,
  15340. DownloadProgress progress) {
  15341. return cli_->Delete(path, body, content_type, progress);
  15342. }
  15343. inline Result Client::Delete(const std::string &path, const Headers &headers,
  15344. const std::string &body,
  15345. const std::string &content_type,
  15346. DownloadProgress progress) {
  15347. return cli_->Delete(path, headers, body, content_type, progress);
  15348. }
  15349. inline Result Client::Delete(const std::string &path, const Params &params,
  15350. DownloadProgress progress) {
  15351. return cli_->Delete(path, params, progress);
  15352. }
  15353. inline Result Client::Delete(const std::string &path, const Headers &headers,
  15354. const Params &params, DownloadProgress progress) {
  15355. return cli_->Delete(path, headers, params, progress);
  15356. }
  15357. inline Result Client::Options(const std::string &path) {
  15358. return cli_->Options(path);
  15359. }
  15360. inline Result Client::Options(const std::string &path, const Headers &headers) {
  15361. return cli_->Options(path, headers);
  15362. }
  15363. inline ClientImpl::StreamHandle
  15364. Client::open_stream(const std::string &method, const std::string &path,
  15365. const Params &params, const Headers &headers,
  15366. const std::string &body, const std::string &content_type) {
  15367. return cli_->open_stream(method, path, params, headers, body, content_type);
  15368. }
  15369. inline bool Client::send(Request &req, Response &res, Error &error) {
  15370. return cli_->send(req, res, error);
  15371. }
  15372. inline Result Client::send(const Request &req) { return cli_->send(req); }
  15373. inline void Client::stop() { cli_->stop(); }
  15374. inline std::string Client::host() const { return cli_->host(); }
  15375. inline int Client::port() const { return cli_->port(); }
  15376. inline size_t Client::is_socket_open() const { return cli_->is_socket_open(); }
  15377. inline socket_t Client::socket() const { return cli_->socket(); }
  15378. inline void
  15379. Client::set_hostname_addr_map(std::map<std::string, std::string> addr_map) {
  15380. cli_->set_hostname_addr_map(std::move(addr_map));
  15381. }
  15382. inline void Client::set_default_headers(Headers headers) {
  15383. cli_->set_default_headers(std::move(headers));
  15384. }
  15385. inline void Client::set_header_writer(
  15386. std::function<ssize_t(Stream &, Headers &)> const &writer) {
  15387. cli_->set_header_writer(writer);
  15388. }
  15389. inline void Client::set_address_family(int family) {
  15390. cli_->set_address_family(family);
  15391. }
  15392. inline void Client::set_tcp_nodelay(bool on) { cli_->set_tcp_nodelay(on); }
  15393. inline void Client::set_socket_options(SocketOptions socket_options) {
  15394. cli_->set_socket_options(std::move(socket_options));
  15395. }
  15396. inline void Client::set_connection_timeout(time_t sec, time_t usec) {
  15397. cli_->set_connection_timeout(sec, usec);
  15398. }
  15399. inline void Client::set_read_timeout(time_t sec, time_t usec) {
  15400. cli_->set_read_timeout(sec, usec);
  15401. }
  15402. inline void Client::set_write_timeout(time_t sec, time_t usec) {
  15403. cli_->set_write_timeout(sec, usec);
  15404. }
  15405. inline void Client::set_basic_auth(const std::string &username,
  15406. const std::string &password) {
  15407. cli_->set_basic_auth(username, password);
  15408. }
  15409. inline void Client::set_bearer_token_auth(const std::string &token) {
  15410. cli_->set_bearer_token_auth(token);
  15411. }
  15412. inline void Client::set_keep_alive(bool on) { cli_->set_keep_alive(on); }
  15413. inline void Client::set_follow_location(bool on) {
  15414. cli_->set_follow_location(on);
  15415. }
  15416. inline void Client::set_path_encode(bool on) { cli_->set_path_encode(on); }
  15417. inline void Client::set_compress(bool on) { cli_->set_compress(on); }
  15418. inline void Client::set_decompress(bool on) { cli_->set_decompress(on); }
  15419. inline void Client::set_payload_max_length(size_t length) {
  15420. cli_->set_payload_max_length(length);
  15421. }
  15422. inline void Client::set_interface(const std::string &intf) {
  15423. cli_->set_interface(intf);
  15424. }
  15425. inline void Client::set_proxy(const std::string &host, int port) {
  15426. cli_->set_proxy(host, port);
  15427. }
  15428. inline void Client::set_proxy_basic_auth(const std::string &username,
  15429. const std::string &password) {
  15430. cli_->set_proxy_basic_auth(username, password);
  15431. }
  15432. inline void Client::set_proxy_bearer_token_auth(const std::string &token) {
  15433. cli_->set_proxy_bearer_token_auth(token);
  15434. }
  15435. inline void Client::set_no_proxy(const std::vector<std::string> &patterns) {
  15436. cli_->set_no_proxy(patterns);
  15437. }
  15438. inline void Client::set_logger(Logger logger) {
  15439. cli_->set_logger(std::move(logger));
  15440. }
  15441. inline void Client::set_error_logger(ErrorLogger error_logger) {
  15442. cli_->set_error_logger(std::move(error_logger));
  15443. }
  15444. /*
  15445. * Group 6: SSL Server and Client implementation
  15446. */
  15447. #ifdef CPPHTTPLIB_SSL_ENABLED
  15448. // SSL HTTP server implementation
  15449. inline SSLServer::SSLServer(const char *cert_path, const char *private_key_path,
  15450. const char *client_ca_cert_file_path,
  15451. const char *client_ca_cert_dir_path,
  15452. const char *private_key_password) {
  15453. using namespace tls;
  15454. ctx_ = create_server_context();
  15455. if (!ctx_) { return; }
  15456. // Load server certificate and private key
  15457. if (!set_server_cert_file(ctx_, cert_path, private_key_path,
  15458. private_key_password)) {
  15459. last_ssl_error_ = static_cast<int>(get_error());
  15460. free_context(ctx_);
  15461. ctx_ = nullptr;
  15462. return;
  15463. }
  15464. // Load client CA certificates for client authentication
  15465. if (client_ca_cert_file_path || client_ca_cert_dir_path) {
  15466. if (!set_client_ca_file(ctx_, client_ca_cert_file_path,
  15467. client_ca_cert_dir_path)) {
  15468. last_ssl_error_ = static_cast<int>(get_error());
  15469. free_context(ctx_);
  15470. ctx_ = nullptr;
  15471. return;
  15472. }
  15473. // Enable client certificate verification
  15474. set_verify_client(ctx_, true);
  15475. }
  15476. }
  15477. inline SSLServer::SSLServer(const PemMemory &pem) {
  15478. using namespace tls;
  15479. ctx_ = create_server_context();
  15480. if (ctx_) {
  15481. if (!set_server_cert_pem(ctx_, pem.cert_pem, pem.key_pem,
  15482. pem.private_key_password)) {
  15483. last_ssl_error_ = static_cast<int>(get_error());
  15484. free_context(ctx_);
  15485. ctx_ = nullptr;
  15486. } else if (pem.client_ca_pem && pem.client_ca_pem_len > 0) {
  15487. if (!load_ca_pem(ctx_, pem.client_ca_pem, pem.client_ca_pem_len)) {
  15488. last_ssl_error_ = static_cast<int>(get_error());
  15489. free_context(ctx_);
  15490. ctx_ = nullptr;
  15491. } else {
  15492. set_verify_client(ctx_, true);
  15493. }
  15494. }
  15495. }
  15496. }
  15497. inline SSLServer::SSLServer(const tls::ContextSetupCallback &setup_callback) {
  15498. using namespace tls;
  15499. ctx_ = create_server_context();
  15500. if (ctx_) {
  15501. if (!setup_callback(ctx_)) {
  15502. free_context(ctx_);
  15503. ctx_ = nullptr;
  15504. }
  15505. }
  15506. }
  15507. inline SSLServer::~SSLServer() {
  15508. if (ctx_) { tls::free_context(ctx_); }
  15509. }
  15510. inline bool SSLServer::is_valid() const {
  15511. return ctx_ != nullptr && Server::is_valid();
  15512. }
  15513. inline bool SSLServer::process_and_close_socket(socket_t sock) {
  15514. using namespace tls;
  15515. // Create TLS session with mutex protection
  15516. session_t session = nullptr;
  15517. {
  15518. std::lock_guard<std::mutex> guard(ctx_mutex_);
  15519. session = create_session(static_cast<ctx_t>(ctx_), sock);
  15520. }
  15521. if (!session) {
  15522. last_ssl_error_ = static_cast<int>(get_error());
  15523. detail::shutdown_socket(sock);
  15524. detail::close_socket(sock);
  15525. return false;
  15526. }
  15527. // Use scope_exit to ensure cleanup on all paths (including exceptions)
  15528. bool handshake_done = false;
  15529. bool ret = false;
  15530. bool websocket_upgraded = false;
  15531. auto cleanup = detail::scope_exit([&] {
  15532. if (handshake_done) { shutdown(session, !websocket_upgraded && ret); }
  15533. free_session(session);
  15534. detail::shutdown_socket(sock);
  15535. detail::close_socket(sock);
  15536. });
  15537. // Perform TLS accept handshake with timeout
  15538. TlsError tls_err;
  15539. if (!accept_nonblocking(session, sock, read_timeout_sec_, read_timeout_usec_,
  15540. &tls_err)) {
  15541. #ifdef CPPHTTPLIB_OPENSSL_SUPPORT
  15542. // Map TlsError to legacy ssl_error for backward compatibility
  15543. if (tls_err.code == ErrorCode::WantRead) {
  15544. last_ssl_error_ = SSL_ERROR_WANT_READ;
  15545. } else if (tls_err.code == ErrorCode::WantWrite) {
  15546. last_ssl_error_ = SSL_ERROR_WANT_WRITE;
  15547. } else {
  15548. last_ssl_error_ = SSL_ERROR_SSL;
  15549. }
  15550. #else
  15551. last_ssl_error_ = static_cast<int>(get_error());
  15552. #endif
  15553. return false;
  15554. }
  15555. handshake_done = true;
  15556. std::string remote_addr;
  15557. int remote_port = 0;
  15558. detail::get_remote_ip_and_port(sock, remote_addr, remote_port);
  15559. std::string local_addr;
  15560. int local_port = 0;
  15561. detail::get_local_ip_and_port(sock, local_addr, local_port);
  15562. ret = serve_guarded([&]() {
  15563. return detail::process_server_socket_ssl(
  15564. svr_sock_, session, sock, keep_alive_max_count_,
  15565. keep_alive_timeout_sec_, read_timeout_sec_, read_timeout_usec_,
  15566. write_timeout_sec_, write_timeout_usec_,
  15567. [&](Stream &strm, bool close_connection, bool &connection_closed) {
  15568. return process_request(
  15569. strm, remote_addr, remote_port, local_addr, local_port,
  15570. close_connection, connection_closed,
  15571. [&](Request &req) { req.ssl = session; }, &websocket_upgraded);
  15572. });
  15573. });
  15574. return ret;
  15575. }
  15576. inline bool SSLServer::update_certs_pem(const char *cert_pem,
  15577. const char *key_pem,
  15578. const char *client_ca_pem,
  15579. const char *password) {
  15580. if (!ctx_) { return false; }
  15581. std::lock_guard<std::mutex> guard(ctx_mutex_);
  15582. if (!tls::update_server_cert(ctx_, cert_pem, key_pem, password)) {
  15583. return false;
  15584. }
  15585. if (client_ca_pem) {
  15586. return tls::update_server_client_ca(ctx_, client_ca_pem);
  15587. }
  15588. return true;
  15589. }
  15590. // SSL HTTP client implementation
  15591. inline SSLClient::~SSLClient() {
  15592. // Make sure to shut down SSL since shutdown_ssl will resolve to the
  15593. // base function rather than the derived function once we get to the
  15594. // base class destructor, and won't free the SSL (causing a leak).
  15595. // This must happen before the context is freed below: some backends
  15596. // (e.g. mbedTLS) have the SSL session borrow a raw pointer into the
  15597. // context, so freeing the context first leaves close_notify reading
  15598. // freed memory.
  15599. shutdown_ssl_impl(socket_, true);
  15600. if (ctx_) {
  15601. tls::free_context(ctx_);
  15602. ctx_ = nullptr;
  15603. }
  15604. }
  15605. inline bool SSLClient::is_valid() const { return ctx_ != nullptr; }
  15606. inline void SSLClient::shutdown_ssl(Socket &socket, bool shutdown_gracefully) {
  15607. shutdown_ssl_impl(socket, shutdown_gracefully);
  15608. }
  15609. inline void SSLClient::shutdown_ssl_impl(Socket &socket,
  15610. bool shutdown_gracefully) {
  15611. if (socket.sock == INVALID_SOCKET) {
  15612. assert(socket.ssl == nullptr);
  15613. return;
  15614. }
  15615. if (socket.ssl) {
  15616. tls::shutdown(socket.ssl, shutdown_gracefully);
  15617. {
  15618. std::lock_guard<std::mutex> guard(ctx_mutex_);
  15619. tls::free_session(socket.ssl);
  15620. }
  15621. socket.ssl = nullptr;
  15622. }
  15623. assert(socket.ssl == nullptr);
  15624. }
  15625. inline bool SSLClient::process_socket(
  15626. const Socket &socket,
  15627. std::chrono::time_point<std::chrono::steady_clock> start_time,
  15628. std::function<bool(Stream &strm)> callback) {
  15629. assert(socket.ssl);
  15630. return detail::process_client_socket_ssl(
  15631. socket.ssl, socket.sock, read_timeout_sec_, read_timeout_usec_,
  15632. write_timeout_sec_, write_timeout_usec_, max_timeout_msec_, start_time,
  15633. std::move(callback));
  15634. }
  15635. inline bool SSLClient::is_ssl() const { return true; }
  15636. inline bool SSLClient::create_and_connect_socket(Socket &socket, Error &error) {
  15637. if (!is_valid()) {
  15638. error = Error::SSLConnection;
  15639. return false;
  15640. }
  15641. return ClientImpl::create_and_connect_socket(socket, error);
  15642. }
  15643. inline bool SSLClient::setup_proxy_connection(
  15644. Socket &socket,
  15645. std::chrono::time_point<std::chrono::steady_clock> start_time,
  15646. Response &res, bool &success, Error &error) {
  15647. if (!is_proxy_enabled_for_host(host_)) { return true; }
  15648. if (!connect_with_proxy(socket, start_time, res, success, error)) {
  15649. return false;
  15650. }
  15651. if (!initialize_ssl(socket, error)) {
  15652. success = false;
  15653. return false;
  15654. }
  15655. return true;
  15656. }
  15657. // Assumes that socket_mutex_ is locked and that there are no requests in
  15658. // flight
  15659. inline bool SSLClient::connect_with_proxy(
  15660. Socket &socket,
  15661. std::chrono::time_point<std::chrono::steady_clock> start_time,
  15662. Response &res, bool &success, Error &error) {
  15663. success = true;
  15664. Response proxy_res;
  15665. if (!detail::process_client_socket(
  15666. socket.sock, read_timeout_sec_, read_timeout_usec_,
  15667. write_timeout_sec_, write_timeout_usec_, max_timeout_msec_,
  15668. start_time, [&](Stream &strm) {
  15669. Request req2;
  15670. req2.method = "CONNECT";
  15671. req2.path =
  15672. detail::make_host_and_port_string_always_port(host_, port_);
  15673. if (max_timeout_msec_ > 0) {
  15674. req2.start_time_ = std::chrono::steady_clock::now();
  15675. }
  15676. return process_request(strm, req2, proxy_res, false, error);
  15677. })) {
  15678. // Thread-safe to close everything because we are assuming there are no
  15679. // requests in flight
  15680. shutdown_ssl(socket, true);
  15681. shutdown_socket(socket);
  15682. close_socket(socket);
  15683. success = false;
  15684. return false;
  15685. }
  15686. if (proxy_res.status == StatusCode::ProxyAuthenticationRequired_407) {
  15687. if (!proxy_digest_auth_username_.empty() &&
  15688. !proxy_digest_auth_password_.empty()) {
  15689. std::map<std::string, std::string> auth;
  15690. if (detail::parse_www_authenticate(proxy_res, auth, true)) {
  15691. // Close the current socket and create a new one for the authenticated
  15692. // request
  15693. shutdown_ssl(socket, true);
  15694. shutdown_socket(socket);
  15695. close_socket(socket);
  15696. // Create a new socket for the authenticated CONNECT request
  15697. if (!ensure_socket_connection(socket, error)) {
  15698. success = false;
  15699. output_error_log(error, nullptr);
  15700. return false;
  15701. }
  15702. proxy_res = Response();
  15703. if (!detail::process_client_socket(
  15704. socket.sock, read_timeout_sec_, read_timeout_usec_,
  15705. write_timeout_sec_, write_timeout_usec_, max_timeout_msec_,
  15706. start_time, [&](Stream &strm) {
  15707. Request req3;
  15708. req3.method = "CONNECT";
  15709. req3.path = detail::make_host_and_port_string_always_port(
  15710. host_, port_);
  15711. req3.headers.insert(detail::make_digest_authentication_header(
  15712. req3, auth, 1, detail::random_string(10),
  15713. proxy_digest_auth_username_, proxy_digest_auth_password_,
  15714. true));
  15715. if (max_timeout_msec_ > 0) {
  15716. req3.start_time_ = std::chrono::steady_clock::now();
  15717. }
  15718. return process_request(strm, req3, proxy_res, false, error);
  15719. })) {
  15720. // Thread-safe to close everything because we are assuming there are
  15721. // no requests in flight
  15722. shutdown_ssl(socket, true);
  15723. shutdown_socket(socket);
  15724. close_socket(socket);
  15725. success = false;
  15726. return false;
  15727. }
  15728. }
  15729. }
  15730. }
  15731. // If status code is not 200, proxy request is failed.
  15732. // Set error to ProxyConnection and return proxy response
  15733. // as the response of the request
  15734. if (proxy_res.status != StatusCode::OK_200) {
  15735. error = Error::ProxyConnection;
  15736. output_error_log(error, nullptr);
  15737. res = std::move(proxy_res);
  15738. // Thread-safe to close everything because we are assuming there are
  15739. // no requests in flight
  15740. shutdown_ssl(socket, true);
  15741. shutdown_socket(socket);
  15742. close_socket(socket);
  15743. return false;
  15744. }
  15745. return true;
  15746. }
  15747. inline bool SSLClient::ensure_socket_connection(Socket &socket, Error &error) {
  15748. if (!ClientImpl::ensure_socket_connection(socket, error)) { return false; }
  15749. if (is_proxy_enabled_for_host(host_)) { return true; }
  15750. if (!initialize_ssl(socket, error)) {
  15751. shutdown_socket(socket);
  15752. close_socket(socket);
  15753. return false;
  15754. }
  15755. return true;
  15756. }
  15757. // SSL HTTP client implementation
  15758. inline SSLClient::SSLClient(const std::string &host)
  15759. : SSLClient(host, 443, std::string(), std::string()) {}
  15760. inline SSLClient::SSLClient(const std::string &host, int port)
  15761. : SSLClient(host, port, std::string(), std::string()) {}
  15762. inline void SSLClient::init_ctx() {
  15763. ctx_ = tls::create_client_context();
  15764. if (ctx_) { tls::set_min_version(ctx_, tls::Version::TLS1_2); }
  15765. }
  15766. inline void SSLClient::reset_ctx_on_error() {
  15767. last_backend_error_ = tls::get_error();
  15768. tls::free_context(ctx_);
  15769. ctx_ = nullptr;
  15770. }
  15771. inline SSLClient::SSLClient(const std::string &host, int port,
  15772. const std::string &client_cert_path,
  15773. const std::string &client_key_path,
  15774. const std::string &private_key_password)
  15775. : ClientImpl(host, port, client_cert_path, client_key_path) {
  15776. init_ctx();
  15777. if (!ctx_) { return; }
  15778. if (!client_cert_path.empty() && !client_key_path.empty()) {
  15779. const char *password =
  15780. private_key_password.empty() ? nullptr : private_key_password.c_str();
  15781. if (!tls::set_client_cert_file(ctx_, client_cert_path.c_str(),
  15782. client_key_path.c_str(), password)) {
  15783. reset_ctx_on_error();
  15784. }
  15785. }
  15786. }
  15787. inline SSLClient::SSLClient(const std::string &host, int port,
  15788. const PemMemory &pem)
  15789. : ClientImpl(host, port) {
  15790. init_ctx();
  15791. if (!ctx_) { return; }
  15792. if (pem.cert_pem && pem.key_pem) {
  15793. if (!tls::set_client_cert_pem(ctx_, pem.cert_pem, pem.key_pem,
  15794. pem.private_key_password)) {
  15795. reset_ctx_on_error();
  15796. }
  15797. }
  15798. }
  15799. inline void SSLClient::set_ca_cert_store(tls::ca_store_t ca_cert_store) {
  15800. if (ca_cert_store && ctx_) {
  15801. // set_ca_store takes ownership of ca_cert_store
  15802. tls::set_ca_store(ctx_, ca_cert_store);
  15803. ca_cert_store_set_ = true;
  15804. } else if (ca_cert_store) {
  15805. tls::free_ca_store(ca_cert_store);
  15806. }
  15807. }
  15808. inline void
  15809. SSLClient::set_server_certificate_verifier(tls::VerifyCallback verifier) {
  15810. if (!ctx_) { return; }
  15811. #ifdef CPPHTTPLIB_WINDOWS_AUTOMATIC_ROOT_CERTIFICATES_UPDATE
  15812. server_certificate_verifier_set_ = static_cast<bool>(verifier);
  15813. #endif
  15814. tls::set_verify_callback(ctx_, verifier);
  15815. }
  15816. inline void SSLClient::set_session_verifier(
  15817. std::function<SSLVerifierResponse(tls::session_t)> verifier) {
  15818. session_verifier_ = std::move(verifier);
  15819. }
  15820. #ifdef CPPHTTPLIB_WINDOWS_AUTOMATIC_ROOT_CERTIFICATES_UPDATE
  15821. inline void SSLClient::enable_windows_certificate_verification(bool enabled) {
  15822. enable_windows_cert_verification_ = enabled;
  15823. }
  15824. #endif
  15825. inline void SSLClient::load_ca_cert_store(const char *ca_cert,
  15826. std::size_t size) {
  15827. if (ctx_ && ca_cert && size > 0) {
  15828. ca_cert_pem_.assign(ca_cert, size); // Store for redirect transfer
  15829. tls::load_ca_pem(ctx_, ca_cert, size);
  15830. }
  15831. }
  15832. inline bool SSLClient::load_certs() {
  15833. auto ret = true;
  15834. // call_once rather than the plain flag WebSocketClient::create_stream() uses:
  15835. // one client is shared across concurrent requests here.
  15836. std::call_once(initialize_cert_, [&]() {
  15837. std::lock_guard<std::mutex> guard(ctx_mutex_);
  15838. ret = detail::load_client_ca_config(
  15839. ctx_, ca_cert_file_path_, ca_cert_dir_path_,
  15840. !ca_cert_pem_.empty() || ca_cert_store_set_, system_ca_mode_,
  15841. last_backend_error_);
  15842. });
  15843. return ret;
  15844. }
  15845. inline bool SSLClient::initialize_ssl(Socket &socket, Error &error) {
  15846. // Load CA certificates if server verification is enabled
  15847. if (server_certificate_verification_) {
  15848. if (!load_certs()) {
  15849. error = Error::SSLLoadingCerts;
  15850. output_error_log(error, nullptr);
  15851. return false;
  15852. }
  15853. }
  15854. detail::ClientTlsSessionOptions options;
  15855. options.server_hostname_verification = server_hostname_verification_;
  15856. options.session_verifier = session_verifier_;
  15857. options.ctx_mutex = &ctx_mutex_;
  15858. #ifdef CPPHTTPLIB_WINDOWS_AUTOMATIC_ROOT_CERTIFICATES_UPDATE
  15859. // Skip Schannel when a custom CA cert is specified, as the Windows
  15860. // certificate store would not know about user-provided CA certificates.
  15861. // Also skip when system CA trust is explicitly disabled.
  15862. options.windows_cert_verification =
  15863. enable_windows_cert_verification_ &&
  15864. system_ca_mode_ != SystemCAMode::Disabled && ca_cert_file_path_.empty() &&
  15865. ca_cert_dir_path_.empty() && ca_cert_pem_.empty() && !ca_cert_store_set_;
  15866. // Only a verifier set through set_server_certificate_verifier() is seen
  15867. // here, not one installed with tls::set_verify_callback() directly.
  15868. options.server_certificate_verifier_set = server_certificate_verifier_set_;
  15869. #endif
  15870. tls::session_t session = nullptr;
  15871. // Use scope_exit to ensure session is freed on error paths
  15872. bool success = false;
  15873. auto session_guard = detail::scope_exit([&] {
  15874. if (!success) { tls::free_session(session); }
  15875. });
  15876. detail::ClientTlsSessionError tls_error;
  15877. if (!detail::setup_client_tls_session(
  15878. host_, ctx_, session, socket.sock, server_certificate_verification_,
  15879. connection_timeout_sec_, connection_timeout_usec_, &tls_error,
  15880. options)) {
  15881. error = tls_error.error;
  15882. last_ssl_error_ = tls_error.ssl_error;
  15883. last_backend_error_ = tls_error.backend_error;
  15884. output_error_log(error, nullptr);
  15885. return false;
  15886. }
  15887. success = true;
  15888. socket.ssl = session;
  15889. return true;
  15890. }
  15891. inline void Client::set_digest_auth(const std::string &username,
  15892. const std::string &password) {
  15893. cli_->set_digest_auth(username, password);
  15894. }
  15895. inline void Client::set_proxy_digest_auth(const std::string &username,
  15896. const std::string &password) {
  15897. cli_->set_proxy_digest_auth(username, password);
  15898. }
  15899. inline void Client::enable_server_certificate_verification(bool enabled) {
  15900. cli_->enable_server_certificate_verification(enabled);
  15901. }
  15902. inline void Client::enable_server_hostname_verification(bool enabled) {
  15903. cli_->enable_server_hostname_verification(enabled);
  15904. }
  15905. inline void Client::enable_system_ca(bool enabled) {
  15906. cli_->enable_system_ca(enabled);
  15907. }
  15908. #ifdef CPPHTTPLIB_WINDOWS_AUTOMATIC_ROOT_CERTIFICATES_UPDATE
  15909. inline void Client::enable_windows_certificate_verification(bool enabled) {
  15910. if (is_ssl_) {
  15911. static_cast<SSLClient &>(*cli_).enable_windows_certificate_verification(
  15912. enabled);
  15913. }
  15914. }
  15915. #endif
  15916. inline void Client::set_ca_cert_path(const std::string &ca_cert_file_path,
  15917. const std::string &ca_cert_dir_path) {
  15918. cli_->set_ca_cert_path(ca_cert_file_path, ca_cert_dir_path);
  15919. }
  15920. inline void Client::set_ca_cert_store(tls::ca_store_t ca_cert_store) {
  15921. if (is_ssl_) {
  15922. static_cast<SSLClient &>(*cli_).set_ca_cert_store(ca_cert_store);
  15923. } else if (ca_cert_store) {
  15924. tls::free_ca_store(ca_cert_store);
  15925. }
  15926. }
  15927. inline void Client::load_ca_cert_store(const char *ca_cert, std::size_t size) {
  15928. if (is_ssl_) {
  15929. // Use the PEM-based path so the CA data is retained for redirect transfer
  15930. static_cast<SSLClient &>(*cli_).load_ca_cert_store(ca_cert, size);
  15931. }
  15932. }
  15933. inline void
  15934. Client::set_server_certificate_verifier(tls::VerifyCallback verifier) {
  15935. if (is_ssl_) {
  15936. static_cast<SSLClient &>(*cli_).set_server_certificate_verifier(
  15937. std::move(verifier));
  15938. }
  15939. }
  15940. inline void Client::set_session_verifier(
  15941. std::function<SSLVerifierResponse(tls::session_t)> verifier) {
  15942. if (is_ssl_) {
  15943. static_cast<SSLClient &>(*cli_).set_session_verifier(std::move(verifier));
  15944. }
  15945. }
  15946. inline tls::ctx_t Client::tls_context() const {
  15947. if (is_ssl_) { return static_cast<SSLClient &>(*cli_).tls_context(); }
  15948. return nullptr;
  15949. }
  15950. #endif // CPPHTTPLIB_SSL_ENABLED
  15951. /*
  15952. * Group 7: TLS abstraction layer - Common API
  15953. */
  15954. #ifdef CPPHTTPLIB_SSL_ENABLED
  15955. namespace tls {
  15956. // Helper for PeerCert construction
  15957. inline PeerCert get_peer_cert_from_session(const_session_t session) {
  15958. return PeerCert(get_peer_cert(session));
  15959. }
  15960. namespace impl {
  15961. inline VerifyCallback &get_verify_callback() {
  15962. static thread_local VerifyCallback callback;
  15963. return callback;
  15964. }
  15965. inline VerifyCallback &get_mbedtls_verify_callback() {
  15966. static thread_local VerifyCallback callback;
  15967. return callback;
  15968. }
  15969. // Check if a string is an IPv4 address
  15970. inline bool is_ipv4_address(const std::string &str) {
  15971. int dots = 0;
  15972. for (char c : str) {
  15973. if (c == '.') {
  15974. dots++;
  15975. } else if (!detail::is_ascii_digit(c)) {
  15976. return false;
  15977. }
  15978. }
  15979. return dots == 3;
  15980. }
  15981. // Parse IPv4 address string to bytes
  15982. inline bool parse_ipv4(const std::string &str, unsigned char *out) {
  15983. const char *p = str.c_str();
  15984. for (int i = 0; i < 4; i++) {
  15985. if (i > 0) {
  15986. if (*p != '.') { return false; }
  15987. p++;
  15988. }
  15989. int val = 0;
  15990. int digits = 0;
  15991. while (detail::is_ascii_digit(*p)) {
  15992. val = val * 10 + (*p - '0');
  15993. if (val > 255) { return false; }
  15994. p++;
  15995. digits++;
  15996. }
  15997. if (digits == 0) { return false; }
  15998. // Reject leading zeros (e.g., "01.002.03.04") to prevent ambiguity
  15999. if (digits > 1 && *(p - digits) == '0') { return false; }
  16000. out[i] = static_cast<unsigned char>(val);
  16001. }
  16002. return *p == '\0';
  16003. }
  16004. // Parse an IP literal (IPv4 or IPv6) into raw network-order bytes.
  16005. // `out` must have room for at least 16 bytes. Returns the address length
  16006. // (4 for IPv4, 16 for IPv6) on success, or 0 if the string is not an IP
  16007. // literal. Used to match a host against iPAddress SANs the same way the
  16008. // OpenSSL backend does via X509_check_ip.
  16009. inline size_t parse_ip_address(const std::string &str, unsigned char *out) {
  16010. if (is_ipv4_address(str)) { return parse_ipv4(str, out) ? 4 : 0; }
  16011. struct in6_addr addr6 = {};
  16012. if (inet_pton(AF_INET6, str.c_str(), &addr6) == 1) {
  16013. memcpy(out, &addr6, 16);
  16014. return 16;
  16015. }
  16016. return 0;
  16017. }
  16018. #ifdef _WIN32
  16019. // Enumerate Windows system certificates and call callback with DER data
  16020. template <typename Callback>
  16021. inline bool enumerate_windows_system_certs(Callback cb) {
  16022. bool loaded = false;
  16023. static const wchar_t *store_names[] = {L"ROOT", L"CA"};
  16024. for (auto store_name : store_names) {
  16025. HCERTSTORE hStore = CertOpenSystemStoreW(0, store_name);
  16026. if (hStore) {
  16027. PCCERT_CONTEXT pContext = nullptr;
  16028. while ((pContext = CertEnumCertificatesInStore(hStore, pContext)) !=
  16029. nullptr) {
  16030. if (cb(pContext->pbCertEncoded, pContext->cbCertEncoded)) {
  16031. loaded = true;
  16032. }
  16033. }
  16034. CertCloseStore(hStore, 0);
  16035. }
  16036. }
  16037. return loaded;
  16038. }
  16039. #endif
  16040. #ifdef CPPHTTPLIB_USE_CERTS_FROM_MACOSX_KEYCHAIN
  16041. // Enumerate macOS Keychain certificates and call callback with DER data
  16042. template <typename Callback>
  16043. inline bool enumerate_macos_keychain_certs(Callback cb) {
  16044. bool loaded = false;
  16045. const SecTrustSettingsDomain domains[] = {
  16046. kSecTrustSettingsDomainSystem,
  16047. kSecTrustSettingsDomainAdmin,
  16048. kSecTrustSettingsDomainUser,
  16049. };
  16050. for (auto domain : domains) {
  16051. CFArrayRef certs = nullptr;
  16052. OSStatus status = SecTrustSettingsCopyCertificates(domain, &certs);
  16053. if (status != errSecSuccess || !certs) {
  16054. if (certs) CFRelease(certs);
  16055. continue;
  16056. }
  16057. CFIndex count = CFArrayGetCount(certs);
  16058. for (CFIndex i = 0; i < count; i++) {
  16059. SecCertificateRef cert =
  16060. (SecCertificateRef)CFArrayGetValueAtIndex(certs, i);
  16061. CFDataRef data = SecCertificateCopyData(cert);
  16062. if (data) {
  16063. if (cb(CFDataGetBytePtr(data),
  16064. static_cast<size_t>(CFDataGetLength(data)))) {
  16065. loaded = true;
  16066. }
  16067. CFRelease(data);
  16068. }
  16069. }
  16070. CFRelease(certs);
  16071. }
  16072. return loaded;
  16073. }
  16074. #endif
  16075. #if !defined(_WIN32) && !(defined(__APPLE__) && \
  16076. defined(CPPHTTPLIB_USE_CERTS_FROM_MACOSX_KEYCHAIN))
  16077. // Common CA certificate file paths on Linux/Unix
  16078. inline const char **system_ca_paths() {
  16079. static const char *paths[] = {
  16080. "/etc/ssl/certs/ca-certificates.crt", // Debian/Ubuntu
  16081. "/etc/pki/tls/certs/ca-bundle.crt", // RHEL/CentOS
  16082. "/etc/ssl/ca-bundle.pem", // OpenSUSE
  16083. "/etc/pki/tls/cacert.pem", // OpenELEC
  16084. "/etc/ssl/cert.pem", // Alpine, FreeBSD
  16085. nullptr};
  16086. return paths;
  16087. }
  16088. // Common CA certificate directory paths on Linux/Unix
  16089. inline const char **system_ca_dirs() {
  16090. static const char *dirs[] = {"/etc/ssl/certs", // Debian/Ubuntu
  16091. "/etc/pki/tls/certs", // RHEL/CentOS
  16092. "/usr/share/ca-certificates", // Other
  16093. nullptr};
  16094. return dirs;
  16095. }
  16096. #endif
  16097. } // namespace impl
  16098. inline bool set_client_ca_file(ctx_t ctx, const char *ca_file,
  16099. const char *ca_dir) {
  16100. if (!ctx) { return false; }
  16101. bool success = true;
  16102. if (ca_file && *ca_file) {
  16103. if (!load_ca_file(ctx, ca_file)) { success = false; }
  16104. }
  16105. if (ca_dir && *ca_dir) {
  16106. if (!load_ca_dir(ctx, ca_dir)) { success = false; }
  16107. }
  16108. #ifdef CPPHTTPLIB_OPENSSL_SUPPORT
  16109. // Set CA list for client certificate request (CertificateRequest message)
  16110. if (ca_file && *ca_file) {
  16111. auto list = SSL_load_client_CA_file(ca_file);
  16112. if (list) { SSL_CTX_set_client_CA_list(static_cast<SSL_CTX *>(ctx), list); }
  16113. }
  16114. #endif
  16115. return success;
  16116. }
  16117. inline bool set_server_cert_pem(ctx_t ctx, const char *cert, const char *key,
  16118. const char *password) {
  16119. return set_client_cert_pem(ctx, cert, key, password);
  16120. }
  16121. inline bool set_server_cert_file(ctx_t ctx, const char *cert_path,
  16122. const char *key_path, const char *password) {
  16123. return set_client_cert_file(ctx, cert_path, key_path, password);
  16124. }
  16125. // PeerCert implementation
  16126. inline PeerCert::PeerCert() = default;
  16127. inline PeerCert::PeerCert(cert_t cert) : cert_(cert) {}
  16128. inline PeerCert::PeerCert(PeerCert &&other) noexcept : cert_(other.cert_) {
  16129. other.cert_ = nullptr;
  16130. }
  16131. inline PeerCert &PeerCert::operator=(PeerCert &&other) noexcept {
  16132. if (this != &other) {
  16133. if (cert_) { free_cert(cert_); }
  16134. cert_ = other.cert_;
  16135. other.cert_ = nullptr;
  16136. }
  16137. return *this;
  16138. }
  16139. inline PeerCert::~PeerCert() {
  16140. if (cert_) { free_cert(cert_); }
  16141. }
  16142. inline PeerCert::operator bool() const { return cert_ != nullptr; }
  16143. inline std::string PeerCert::subject_cn() const {
  16144. return cert_ ? get_cert_subject_cn(cert_) : std::string();
  16145. }
  16146. inline std::string PeerCert::issuer_name() const {
  16147. return cert_ ? get_cert_issuer_name(cert_) : std::string();
  16148. }
  16149. inline bool PeerCert::check_hostname(const char *hostname) const {
  16150. return cert_ ? verify_hostname(cert_, hostname) : false;
  16151. }
  16152. inline std::vector<SanEntry> PeerCert::sans() const {
  16153. std::vector<SanEntry> result;
  16154. if (cert_) { get_cert_sans(cert_, result); }
  16155. return result;
  16156. }
  16157. inline bool PeerCert::validity(time_t &not_before, time_t &not_after) const {
  16158. return cert_ ? get_cert_validity(cert_, not_before, not_after) : false;
  16159. }
  16160. inline std::string PeerCert::serial() const {
  16161. return cert_ ? get_cert_serial(cert_) : std::string();
  16162. }
  16163. // VerifyContext method implementations
  16164. inline std::string VerifyContext::subject_cn() const {
  16165. return cert ? get_cert_subject_cn(cert) : std::string();
  16166. }
  16167. inline std::string VerifyContext::issuer_name() const {
  16168. return cert ? get_cert_issuer_name(cert) : std::string();
  16169. }
  16170. inline bool VerifyContext::check_hostname(const char *hostname) const {
  16171. return cert ? verify_hostname(cert, hostname) : false;
  16172. }
  16173. inline std::vector<SanEntry> VerifyContext::sans() const {
  16174. std::vector<SanEntry> result;
  16175. if (cert) { get_cert_sans(cert, result); }
  16176. return result;
  16177. }
  16178. inline bool VerifyContext::validity(time_t &not_before,
  16179. time_t &not_after) const {
  16180. return cert ? get_cert_validity(cert, not_before, not_after) : false;
  16181. }
  16182. inline std::string VerifyContext::serial() const {
  16183. return cert ? get_cert_serial(cert) : std::string();
  16184. }
  16185. // TlsError static method implementation
  16186. inline std::string TlsError::verify_error_to_string(long error_code) {
  16187. return verify_error_string(error_code);
  16188. }
  16189. } // namespace tls
  16190. // Request::peer_cert() implementation
  16191. inline tls::PeerCert Request::peer_cert() const {
  16192. return tls::get_peer_cert_from_session(ssl);
  16193. }
  16194. // Request::sni() implementation
  16195. inline std::string Request::sni() const {
  16196. if (!ssl) { return std::string(); }
  16197. const char *s = tls::get_sni(ssl);
  16198. return s ? std::string(s) : std::string();
  16199. }
  16200. #endif // CPPHTTPLIB_SSL_ENABLED
  16201. /*
  16202. * Group 8: TLS abstraction layer - OpenSSL backend
  16203. */
  16204. /*
  16205. * OpenSSL Backend Implementation
  16206. */
  16207. #ifdef CPPHTTPLIB_OPENSSL_SUPPORT
  16208. namespace tls {
  16209. namespace impl {
  16210. // Helper to map OpenSSL SSL_get_error to ErrorCode
  16211. inline ErrorCode map_ssl_error(int ssl_error, int &out_errno) {
  16212. switch (ssl_error) {
  16213. case SSL_ERROR_NONE: return ErrorCode::Success;
  16214. case SSL_ERROR_WANT_READ: return ErrorCode::WantRead;
  16215. case SSL_ERROR_WANT_WRITE: return ErrorCode::WantWrite;
  16216. case SSL_ERROR_ZERO_RETURN: return ErrorCode::PeerClosed;
  16217. case SSL_ERROR_SYSCALL: out_errno = errno; return ErrorCode::SyscallError;
  16218. case SSL_ERROR_SSL:
  16219. default: return ErrorCode::Fatal;
  16220. }
  16221. }
  16222. // Helper: Create client CA list from PEM string
  16223. // Returns a new STACK_OF(X509_NAME)* or nullptr on failure
  16224. // Caller takes ownership of returned list
  16225. inline STACK_OF(X509_NAME) *
  16226. create_client_ca_list_from_pem(const char *ca_pem) {
  16227. if (!ca_pem) { return nullptr; }
  16228. auto ca_list = sk_X509_NAME_new_null();
  16229. if (!ca_list) { return nullptr; }
  16230. BIO *bio = BIO_new_mem_buf(ca_pem, -1);
  16231. if (!bio) {
  16232. sk_X509_NAME_pop_free(ca_list, X509_NAME_free);
  16233. return nullptr;
  16234. }
  16235. X509 *cert = nullptr;
  16236. while ((cert = PEM_read_bio_X509(bio, nullptr, nullptr, nullptr)) !=
  16237. nullptr) {
  16238. const X509_NAME *name = X509_get_subject_name(cert);
  16239. if (name) {
  16240. sk_X509_NAME_push(ca_list, X509_NAME_dup(const_cast<X509_NAME *>(name)));
  16241. }
  16242. X509_free(cert);
  16243. }
  16244. BIO_free(bio);
  16245. return ca_list;
  16246. }
  16247. // OpenSSL verify callback wrapper
  16248. inline int openssl_verify_callback(int preverify_ok, X509_STORE_CTX *ctx) {
  16249. auto &callback = get_verify_callback();
  16250. if (!callback) { return preverify_ok; }
  16251. // Get SSL object from X509_STORE_CTX
  16252. auto ssl = static_cast<SSL *>(
  16253. X509_STORE_CTX_get_ex_data(ctx, SSL_get_ex_data_X509_STORE_CTX_idx()));
  16254. if (!ssl) { return preverify_ok; }
  16255. // Get current certificate and depth
  16256. auto cert = X509_STORE_CTX_get_current_cert(ctx);
  16257. int depth = X509_STORE_CTX_get_error_depth(ctx);
  16258. int error = X509_STORE_CTX_get_error(ctx);
  16259. // Build context
  16260. VerifyContext verify_ctx;
  16261. verify_ctx.session = static_cast<session_t>(ssl);
  16262. verify_ctx.cert = static_cast<cert_t>(cert);
  16263. verify_ctx.depth = depth;
  16264. verify_ctx.preverify_ok = (preverify_ok != 0);
  16265. verify_ctx.error_code = error;
  16266. verify_ctx.error_string =
  16267. (error != X509_V_OK) ? X509_verify_cert_error_string(error) : nullptr;
  16268. return callback(verify_ctx) ? 1 : 0;
  16269. }
  16270. // X509_STORE_get0_objects is deprecated since OpenSSL 4.0 because it is not
  16271. // thread-safe; X509_STORE_get1_objects (OpenSSL 3.3+) returns a snapshot
  16272. // that must be released with release_store_objects
  16273. #if !defined(OPENSSL_IS_BORINGSSL) && !defined(LIBRESSL_VERSION_NUMBER) && \
  16274. OPENSSL_VERSION_NUMBER >= 0x30300000L
  16275. #define CPPHTTPLIB_HAS_X509_STORE_GET1_OBJECTS
  16276. #endif
  16277. inline STACK_OF(X509_OBJECT) * get_store_objects(X509_STORE *store) {
  16278. #ifdef CPPHTTPLIB_HAS_X509_STORE_GET1_OBJECTS
  16279. return X509_STORE_get1_objects(store);
  16280. #else
  16281. return X509_STORE_get0_objects(store);
  16282. #endif
  16283. }
  16284. inline void release_store_objects(STACK_OF(X509_OBJECT) * objs) {
  16285. #ifdef CPPHTTPLIB_HAS_X509_STORE_GET1_OBJECTS
  16286. sk_X509_OBJECT_pop_free(objs, X509_OBJECT_free);
  16287. #else
  16288. (void)objs; // get0 variant returns an internal pointer; nothing to free
  16289. #endif
  16290. }
  16291. } // namespace impl
  16292. inline ctx_t create_client_context() {
  16293. SSL_CTX *ctx = SSL_CTX_new(TLS_client_method());
  16294. if (ctx) {
  16295. // Disable auto-retry to properly handle non-blocking I/O
  16296. SSL_CTX_clear_mode(ctx, SSL_MODE_AUTO_RETRY);
  16297. // Set minimum TLS version
  16298. SSL_CTX_set_min_proto_version(ctx, TLS1_2_VERSION);
  16299. }
  16300. return static_cast<ctx_t>(ctx);
  16301. }
  16302. inline void free_context(ctx_t ctx) {
  16303. if (ctx) { SSL_CTX_free(static_cast<SSL_CTX *>(ctx)); }
  16304. }
  16305. inline bool set_min_version(ctx_t ctx, Version version) {
  16306. if (!ctx) return false;
  16307. return SSL_CTX_set_min_proto_version(static_cast<SSL_CTX *>(ctx),
  16308. static_cast<int>(version)) == 1;
  16309. }
  16310. inline bool load_ca_pem(ctx_t ctx, const char *pem, size_t len) {
  16311. if (!ctx || !pem || len == 0) return false;
  16312. auto ssl_ctx = static_cast<SSL_CTX *>(ctx);
  16313. auto store = SSL_CTX_get_cert_store(ssl_ctx);
  16314. if (!store) return false;
  16315. auto bio = BIO_new_mem_buf(pem, static_cast<int>(len));
  16316. if (!bio) return false;
  16317. bool ok = true;
  16318. X509 *cert = nullptr;
  16319. while ((cert = PEM_read_bio_X509(bio, nullptr, nullptr, nullptr)) !=
  16320. nullptr) {
  16321. if (X509_STORE_add_cert(store, cert) != 1) {
  16322. // Ignore duplicate errors
  16323. auto err = ERR_peek_last_error();
  16324. if (ERR_GET_REASON(err) != X509_R_CERT_ALREADY_IN_HASH_TABLE) {
  16325. ok = false;
  16326. }
  16327. }
  16328. X509_free(cert);
  16329. if (!ok) break;
  16330. }
  16331. BIO_free(bio);
  16332. // Clear any "no more certificates" errors
  16333. ERR_clear_error();
  16334. return ok;
  16335. }
  16336. inline bool load_ca_file(ctx_t ctx, const char *file_path) {
  16337. if (!ctx || !file_path) return false;
  16338. return SSL_CTX_load_verify_locations(static_cast<SSL_CTX *>(ctx), file_path,
  16339. nullptr) == 1;
  16340. }
  16341. inline bool load_ca_dir(ctx_t ctx, const char *dir_path) {
  16342. if (!ctx || !dir_path) return false;
  16343. return SSL_CTX_load_verify_locations(static_cast<SSL_CTX *>(ctx), nullptr,
  16344. dir_path) == 1;
  16345. }
  16346. inline bool load_system_certs(ctx_t ctx) {
  16347. if (!ctx) return false;
  16348. auto ssl_ctx = static_cast<SSL_CTX *>(ctx);
  16349. #ifdef _WIN32
  16350. // Windows: Load from system certificate store (ROOT and CA)
  16351. auto store = SSL_CTX_get_cert_store(ssl_ctx);
  16352. if (!store) return false;
  16353. bool loaded_any = false;
  16354. static const wchar_t *store_names[] = {L"ROOT", L"CA"};
  16355. for (auto store_name : store_names) {
  16356. auto hStore = CertOpenSystemStoreW(NULL, store_name);
  16357. if (!hStore) continue;
  16358. PCCERT_CONTEXT pContext = nullptr;
  16359. while ((pContext = CertEnumCertificatesInStore(hStore, pContext)) !=
  16360. nullptr) {
  16361. const unsigned char *data = pContext->pbCertEncoded;
  16362. auto x509 = d2i_X509(nullptr, &data, pContext->cbCertEncoded);
  16363. if (x509) {
  16364. if (X509_STORE_add_cert(store, x509) == 1) { loaded_any = true; }
  16365. X509_free(x509);
  16366. }
  16367. }
  16368. CertCloseStore(hStore, 0);
  16369. }
  16370. return loaded_any;
  16371. #elif defined(__APPLE__)
  16372. #ifdef CPPHTTPLIB_USE_CERTS_FROM_MACOSX_KEYCHAIN
  16373. // macOS: Load from Keychain
  16374. auto store = SSL_CTX_get_cert_store(ssl_ctx);
  16375. if (!store) return false;
  16376. bool loaded_any = false;
  16377. const SecTrustSettingsDomain domains[] = {
  16378. kSecTrustSettingsDomainSystem,
  16379. kSecTrustSettingsDomainAdmin,
  16380. kSecTrustSettingsDomainUser,
  16381. };
  16382. for (auto domain : domains) {
  16383. CFArrayRef certs = nullptr;
  16384. if (SecTrustSettingsCopyCertificates(domain, &certs) != errSecSuccess ||
  16385. !certs) {
  16386. if (certs) CFRelease(certs);
  16387. continue;
  16388. }
  16389. auto count = CFArrayGetCount(certs);
  16390. for (CFIndex i = 0; i < count; i++) {
  16391. auto cert = reinterpret_cast<SecCertificateRef>(
  16392. const_cast<void *>(CFArrayGetValueAtIndex(certs, i)));
  16393. CFDataRef der = SecCertificateCopyData(cert);
  16394. if (der) {
  16395. const unsigned char *data = CFDataGetBytePtr(der);
  16396. auto x509 = d2i_X509(nullptr, &data, CFDataGetLength(der));
  16397. if (x509) {
  16398. if (X509_STORE_add_cert(store, x509) == 1) { loaded_any = true; }
  16399. X509_free(x509);
  16400. }
  16401. CFRelease(der);
  16402. }
  16403. }
  16404. CFRelease(certs);
  16405. }
  16406. return loaded_any || SSL_CTX_set_default_verify_paths(ssl_ctx) == 1;
  16407. #else
  16408. return SSL_CTX_set_default_verify_paths(ssl_ctx) == 1;
  16409. #endif
  16410. #else
  16411. // Other Unix: use default verify paths
  16412. return SSL_CTX_set_default_verify_paths(ssl_ctx) == 1;
  16413. #endif
  16414. }
  16415. inline bool set_client_cert_pem(ctx_t ctx, const char *cert, const char *key,
  16416. const char *password) {
  16417. if (!ctx || !cert || !key) return false;
  16418. auto ssl_ctx = static_cast<SSL_CTX *>(ctx);
  16419. // Load certificate
  16420. auto cert_bio = BIO_new_mem_buf(cert, -1);
  16421. if (!cert_bio) return false;
  16422. auto x509 = PEM_read_bio_X509(cert_bio, nullptr, nullptr, nullptr);
  16423. BIO_free(cert_bio);
  16424. if (!x509) return false;
  16425. auto cert_ok = SSL_CTX_use_certificate(ssl_ctx, x509) == 1;
  16426. X509_free(x509);
  16427. if (!cert_ok) return false;
  16428. // Load private key
  16429. auto key_bio = BIO_new_mem_buf(key, -1);
  16430. if (!key_bio) return false;
  16431. auto pkey = PEM_read_bio_PrivateKey(key_bio, nullptr, nullptr,
  16432. password ? const_cast<char *>(password)
  16433. : nullptr);
  16434. BIO_free(key_bio);
  16435. if (!pkey) return false;
  16436. auto key_ok = SSL_CTX_use_PrivateKey(ssl_ctx, pkey) == 1;
  16437. EVP_PKEY_free(pkey);
  16438. return key_ok && SSL_CTX_check_private_key(ssl_ctx) == 1;
  16439. }
  16440. inline bool set_client_cert_file(ctx_t ctx, const char *cert_path,
  16441. const char *key_path, const char *password) {
  16442. if (!ctx || !cert_path || !key_path) return false;
  16443. auto ssl_ctx = static_cast<SSL_CTX *>(ctx);
  16444. if (password && password[0] != '\0') {
  16445. SSL_CTX_set_default_passwd_cb_userdata(
  16446. ssl_ctx, reinterpret_cast<void *>(const_cast<char *>(password)));
  16447. }
  16448. return SSL_CTX_use_certificate_chain_file(ssl_ctx, cert_path) == 1 &&
  16449. SSL_CTX_use_PrivateKey_file(ssl_ctx, key_path, SSL_FILETYPE_PEM) == 1;
  16450. }
  16451. inline ctx_t create_server_context() {
  16452. SSL_CTX *ctx = SSL_CTX_new(TLS_server_method());
  16453. if (ctx) {
  16454. SSL_CTX_set_options(ctx, SSL_OP_NO_COMPRESSION |
  16455. SSL_OP_NO_SESSION_RESUMPTION_ON_RENEGOTIATION);
  16456. SSL_CTX_set_min_proto_version(ctx, TLS1_2_VERSION);
  16457. }
  16458. return static_cast<ctx_t>(ctx);
  16459. }
  16460. inline void set_verify_client(ctx_t ctx, bool require) {
  16461. if (!ctx) return;
  16462. SSL_CTX_set_verify(static_cast<SSL_CTX *>(ctx),
  16463. require
  16464. ? (SSL_VERIFY_PEER | SSL_VERIFY_FAIL_IF_NO_PEER_CERT)
  16465. : SSL_VERIFY_NONE,
  16466. nullptr);
  16467. }
  16468. inline session_t create_session(ctx_t ctx, socket_t sock) {
  16469. if (!ctx || sock == INVALID_SOCKET) return nullptr;
  16470. auto ssl_ctx = static_cast<SSL_CTX *>(ctx);
  16471. SSL *ssl = SSL_new(ssl_ctx);
  16472. if (!ssl) return nullptr;
  16473. // Disable auto-retry for proper non-blocking I/O handling
  16474. SSL_clear_mode(ssl, SSL_MODE_AUTO_RETRY);
  16475. auto bio = BIO_new_socket(static_cast<int>(sock), BIO_NOCLOSE);
  16476. if (!bio) {
  16477. SSL_free(ssl);
  16478. return nullptr;
  16479. }
  16480. SSL_set_bio(ssl, bio, bio);
  16481. return static_cast<session_t>(ssl);
  16482. }
  16483. inline void free_session(session_t session) {
  16484. if (session) { SSL_free(static_cast<SSL *>(session)); }
  16485. }
  16486. inline bool set_sni(session_t session, const char *hostname,
  16487. bool /*verify_hostname*/) {
  16488. if (!session || !hostname) return false;
  16489. auto ssl = static_cast<SSL *>(session);
  16490. // Set SNI (Server Name Indication) only - does not enable verification.
  16491. // OpenSSL never binds identity checking to SNI (that happens post-
  16492. // handshake in setup_client_tls_session()), so verify_hostname is unused.
  16493. #if defined(OPENSSL_IS_BORINGSSL)
  16494. return SSL_set_tlsext_host_name(ssl, hostname) == 1;
  16495. #else
  16496. // Direct call instead of macro to suppress -Wold-style-cast warning
  16497. return SSL_ctrl(ssl, SSL_CTRL_SET_TLSEXT_HOSTNAME, TLSEXT_NAMETYPE_host_name,
  16498. static_cast<void *>(const_cast<char *>(hostname))) == 1;
  16499. #endif
  16500. }
  16501. inline TlsError connect(session_t session) {
  16502. if (!session) { return TlsError(); }
  16503. auto ssl = static_cast<SSL *>(session);
  16504. auto ret = SSL_connect(ssl);
  16505. TlsError err;
  16506. if (ret == 1) {
  16507. err.code = ErrorCode::Success;
  16508. } else {
  16509. auto ssl_err = SSL_get_error(ssl, ret);
  16510. err.code = impl::map_ssl_error(ssl_err, err.sys_errno);
  16511. err.backend_code = ERR_get_error();
  16512. }
  16513. return err;
  16514. }
  16515. inline TlsError accept(session_t session) {
  16516. if (!session) { return TlsError(); }
  16517. auto ssl = static_cast<SSL *>(session);
  16518. auto ret = SSL_accept(ssl);
  16519. TlsError err;
  16520. if (ret == 1) {
  16521. err.code = ErrorCode::Success;
  16522. } else {
  16523. auto ssl_err = SSL_get_error(ssl, ret);
  16524. err.code = impl::map_ssl_error(ssl_err, err.sys_errno);
  16525. err.backend_code = ERR_get_error();
  16526. }
  16527. return err;
  16528. }
  16529. inline bool connect_nonblocking(session_t session, socket_t sock,
  16530. time_t timeout_sec, time_t timeout_usec,
  16531. TlsError *err) {
  16532. if (!session) {
  16533. if (err) { err->code = ErrorCode::Fatal; }
  16534. return false;
  16535. }
  16536. auto ssl = static_cast<SSL *>(session);
  16537. auto bio = SSL_get_rbio(ssl);
  16538. // Set non-blocking mode for handshake
  16539. detail::set_nonblocking(sock, true);
  16540. if (bio) { BIO_set_nbio(bio, 1); }
  16541. auto cleanup = detail::scope_exit([&]() {
  16542. // Restore blocking mode after handshake
  16543. if (bio) { BIO_set_nbio(bio, 0); }
  16544. detail::set_nonblocking(sock, false);
  16545. });
  16546. auto res = 0;
  16547. while ((res = SSL_connect(ssl)) != 1) {
  16548. auto ssl_err = SSL_get_error(ssl, res);
  16549. switch (ssl_err) {
  16550. case SSL_ERROR_WANT_READ:
  16551. if (detail::select_read(sock, timeout_sec, timeout_usec) > 0) {
  16552. continue;
  16553. }
  16554. break;
  16555. case SSL_ERROR_WANT_WRITE:
  16556. if (detail::select_write(sock, timeout_sec, timeout_usec) > 0) {
  16557. continue;
  16558. }
  16559. break;
  16560. default: break;
  16561. }
  16562. if (err) {
  16563. err->code = impl::map_ssl_error(ssl_err, err->sys_errno);
  16564. err->backend_code = ERR_get_error();
  16565. }
  16566. return false;
  16567. }
  16568. if (err) { err->code = ErrorCode::Success; }
  16569. return true;
  16570. }
  16571. inline bool accept_nonblocking(session_t session, socket_t sock,
  16572. time_t timeout_sec, time_t timeout_usec,
  16573. TlsError *err) {
  16574. if (!session) {
  16575. if (err) { err->code = ErrorCode::Fatal; }
  16576. return false;
  16577. }
  16578. auto ssl = static_cast<SSL *>(session);
  16579. auto bio = SSL_get_rbio(ssl);
  16580. // Set non-blocking mode for handshake
  16581. detail::set_nonblocking(sock, true);
  16582. if (bio) { BIO_set_nbio(bio, 1); }
  16583. auto cleanup = detail::scope_exit([&]() {
  16584. // Restore blocking mode after handshake
  16585. if (bio) { BIO_set_nbio(bio, 0); }
  16586. detail::set_nonblocking(sock, false);
  16587. });
  16588. auto res = 0;
  16589. while ((res = SSL_accept(ssl)) != 1) {
  16590. auto ssl_err = SSL_get_error(ssl, res);
  16591. switch (ssl_err) {
  16592. case SSL_ERROR_WANT_READ:
  16593. if (detail::select_read(sock, timeout_sec, timeout_usec) > 0) {
  16594. continue;
  16595. }
  16596. break;
  16597. case SSL_ERROR_WANT_WRITE:
  16598. if (detail::select_write(sock, timeout_sec, timeout_usec) > 0) {
  16599. continue;
  16600. }
  16601. break;
  16602. default: break;
  16603. }
  16604. if (err) {
  16605. err->code = impl::map_ssl_error(ssl_err, err->sys_errno);
  16606. err->backend_code = ERR_get_error();
  16607. }
  16608. return false;
  16609. }
  16610. if (err) { err->code = ErrorCode::Success; }
  16611. return true;
  16612. }
  16613. inline ssize_t read(session_t session, void *buf, size_t len, TlsError &err) {
  16614. if (!session || !buf) {
  16615. err.code = ErrorCode::Fatal;
  16616. return -1;
  16617. }
  16618. auto ssl = static_cast<SSL *>(session);
  16619. constexpr auto max_len =
  16620. static_cast<size_t>((std::numeric_limits<int>::max)());
  16621. if (len > max_len) { len = max_len; }
  16622. auto ret = SSL_read(ssl, buf, static_cast<int>(len));
  16623. if (ret > 0) {
  16624. err.code = ErrorCode::Success;
  16625. return ret;
  16626. }
  16627. auto ssl_err = SSL_get_error(ssl, ret);
  16628. err.code = impl::map_ssl_error(ssl_err, err.sys_errno);
  16629. if (err.code == ErrorCode::PeerClosed) {
  16630. return 0;
  16631. } // Gracefully handle the peer closed state.
  16632. if (err.code == ErrorCode::Fatal) { err.backend_code = ERR_get_error(); }
  16633. return -1;
  16634. }
  16635. inline ssize_t write(session_t session, const void *buf, size_t len,
  16636. TlsError &err) {
  16637. if (!session || !buf) {
  16638. err.code = ErrorCode::Fatal;
  16639. return -1;
  16640. }
  16641. auto ssl = static_cast<SSL *>(session);
  16642. auto ret = SSL_write(ssl, buf, static_cast<int>(len));
  16643. if (ret > 0) {
  16644. err.code = ErrorCode::Success;
  16645. return ret;
  16646. }
  16647. auto ssl_err = SSL_get_error(ssl, ret);
  16648. err.code = impl::map_ssl_error(ssl_err, err.sys_errno);
  16649. if (err.code == ErrorCode::Fatal) { err.backend_code = ERR_get_error(); }
  16650. return -1;
  16651. }
  16652. inline int pending(const_session_t session) {
  16653. if (!session) return 0;
  16654. return SSL_pending(static_cast<SSL *>(const_cast<void *>(session)));
  16655. }
  16656. inline void shutdown(session_t session, bool graceful) {
  16657. if (!session) return;
  16658. auto ssl = static_cast<SSL *>(session);
  16659. if (graceful) {
  16660. // Send close_notify without waiting for the peer's. The connection is
  16661. // closed right after this, so a unidirectional shutdown is enough, and an
  16662. // idle peer that never answers would otherwise hold this thread until the
  16663. // read timeout. The other backends do not wait either.
  16664. SSL_shutdown(ssl);
  16665. }
  16666. }
  16667. inline bool is_peer_closed(session_t session, socket_t sock) {
  16668. if (!session) return true;
  16669. // Temporarily set socket to non-blocking to avoid blocking on SSL_peek
  16670. detail::set_nonblocking(sock, true);
  16671. auto se = detail::scope_exit([&]() { detail::set_nonblocking(sock, false); });
  16672. auto ssl = static_cast<SSL *>(session);
  16673. char buf;
  16674. auto ret = SSL_peek(ssl, &buf, 1);
  16675. if (ret > 0) return false;
  16676. auto err = SSL_get_error(ssl, ret);
  16677. return err == SSL_ERROR_ZERO_RETURN;
  16678. }
  16679. inline cert_t get_peer_cert(const_session_t session) {
  16680. if (!session) return nullptr;
  16681. return static_cast<cert_t>(SSL_get1_peer_certificate(
  16682. static_cast<SSL *>(const_cast<void *>(session))));
  16683. }
  16684. inline size_t get_peer_certs(const_session_t session,
  16685. std::vector<cert_t> &certs) {
  16686. certs.clear();
  16687. if (!session) { return 0; }
  16688. auto ssl = static_cast<const SSL *>(session);
  16689. // On the server side, the chain leaves out the peer's own certificate
  16690. if (SSL_is_server(ssl)) {
  16691. if (auto leaf = get_peer_cert(session)) { certs.push_back(leaf); }
  16692. }
  16693. auto sk = SSL_get_peer_cert_chain(ssl);
  16694. for (int i = 0; sk && i < sk_X509_num(sk); i++) {
  16695. auto x509 = sk_X509_value(sk, i);
  16696. X509_up_ref(x509);
  16697. certs.push_back(static_cast<cert_t>(x509));
  16698. }
  16699. return certs.size();
  16700. }
  16701. inline void free_cert(cert_t cert) {
  16702. if (cert) { X509_free(static_cast<X509 *>(cert)); }
  16703. }
  16704. inline bool verify_hostname(cert_t cert, const char *hostname) {
  16705. if (!cert || !hostname) return false;
  16706. auto x509 = static_cast<X509 *>(cert);
  16707. // Use X509_check_ip_asc for IP addresses, X509_check_host for DNS names
  16708. if (detail::is_ip_address(hostname)) {
  16709. return X509_check_ip_asc(x509, hostname, 0) == 1;
  16710. }
  16711. return X509_check_host(x509, hostname, strlen(hostname), 0, nullptr) == 1;
  16712. }
  16713. inline uint64_t hostname_mismatch_code() {
  16714. return static_cast<uint64_t>(X509_V_ERR_HOSTNAME_MISMATCH);
  16715. }
  16716. inline long get_verify_result(const_session_t session) {
  16717. if (!session) return X509_V_ERR_UNSPECIFIED;
  16718. return SSL_get_verify_result(static_cast<SSL *>(const_cast<void *>(session)));
  16719. }
  16720. inline std::string get_cert_subject_cn(cert_t cert) {
  16721. if (!cert) return "";
  16722. auto x509 = static_cast<X509 *>(cert);
  16723. auto subject_name = X509_get_subject_name(x509);
  16724. if (!subject_name) return "";
  16725. // X509_NAME_get_text_by_NID is deprecated since OpenSSL 4.0
  16726. auto idx = X509_NAME_get_index_by_NID(subject_name, NID_commonName, -1);
  16727. if (idx < 0) return "";
  16728. auto entry = X509_NAME_get_entry(subject_name, idx);
  16729. if (!entry) return "";
  16730. auto data = X509_NAME_ENTRY_get_data(entry);
  16731. if (!data) return "";
  16732. return std::string(
  16733. reinterpret_cast<const char *>(ASN1_STRING_get0_data(data)),
  16734. static_cast<size_t>(ASN1_STRING_length(data)));
  16735. }
  16736. inline std::string get_cert_issuer_name(cert_t cert) {
  16737. if (!cert) return "";
  16738. auto x509 = static_cast<X509 *>(cert);
  16739. auto issuer_name = X509_get_issuer_name(x509);
  16740. if (!issuer_name) return "";
  16741. char buf[256];
  16742. X509_NAME_oneline(issuer_name, buf, sizeof(buf));
  16743. return std::string(buf);
  16744. }
  16745. inline bool get_cert_sans(cert_t cert, std::vector<SanEntry> &sans) {
  16746. sans.clear();
  16747. if (!cert) return false;
  16748. auto x509 = static_cast<X509 *>(cert);
  16749. auto names = static_cast<GENERAL_NAMES *>(
  16750. X509_get_ext_d2i(x509, NID_subject_alt_name, nullptr, nullptr));
  16751. if (!names) return true; // No SANs is valid
  16752. auto count = sk_GENERAL_NAME_num(names);
  16753. for (decltype(count) i = 0; i < count; i++) {
  16754. auto gen = sk_GENERAL_NAME_value(names, i);
  16755. if (!gen) continue;
  16756. SanEntry entry;
  16757. switch (gen->type) {
  16758. case GEN_DNS:
  16759. entry.type = SanType::DNS;
  16760. if (gen->d.dNSName) {
  16761. entry.value = std::string(
  16762. reinterpret_cast<const char *>(
  16763. ASN1_STRING_get0_data(gen->d.dNSName)),
  16764. static_cast<size_t>(ASN1_STRING_length(gen->d.dNSName)));
  16765. }
  16766. break;
  16767. case GEN_IPADD:
  16768. entry.type = SanType::IP;
  16769. if (gen->d.iPAddress) {
  16770. auto data = ASN1_STRING_get0_data(gen->d.iPAddress);
  16771. auto len = ASN1_STRING_length(gen->d.iPAddress);
  16772. if (len == 4) {
  16773. // IPv4
  16774. char buf[INET_ADDRSTRLEN];
  16775. inet_ntop(AF_INET, data, buf, sizeof(buf));
  16776. entry.value = buf;
  16777. } else if (len == 16) {
  16778. // IPv6
  16779. char buf[INET6_ADDRSTRLEN];
  16780. inet_ntop(AF_INET6, data, buf, sizeof(buf));
  16781. entry.value = buf;
  16782. }
  16783. }
  16784. break;
  16785. case GEN_EMAIL:
  16786. entry.type = SanType::EMAIL;
  16787. if (gen->d.rfc822Name) {
  16788. entry.value = std::string(
  16789. reinterpret_cast<const char *>(
  16790. ASN1_STRING_get0_data(gen->d.rfc822Name)),
  16791. static_cast<size_t>(ASN1_STRING_length(gen->d.rfc822Name)));
  16792. }
  16793. break;
  16794. case GEN_URI:
  16795. entry.type = SanType::URI;
  16796. if (gen->d.uniformResourceIdentifier) {
  16797. entry.value = std::string(
  16798. reinterpret_cast<const char *>(
  16799. ASN1_STRING_get0_data(gen->d.uniformResourceIdentifier)),
  16800. static_cast<size_t>(
  16801. ASN1_STRING_length(gen->d.uniformResourceIdentifier)));
  16802. }
  16803. break;
  16804. default: entry.type = SanType::OTHER; break;
  16805. }
  16806. if (!entry.value.empty()) { sans.push_back(std::move(entry)); }
  16807. }
  16808. GENERAL_NAMES_free(names);
  16809. return true;
  16810. }
  16811. inline bool get_cert_validity(cert_t cert, time_t &not_before,
  16812. time_t &not_after) {
  16813. if (!cert) return false;
  16814. auto x509 = static_cast<X509 *>(cert);
  16815. auto nb = X509_get0_notBefore(x509);
  16816. auto na = X509_get0_notAfter(x509);
  16817. if (!nb || !na) return false;
  16818. ASN1_TIME *epoch = ASN1_TIME_new();
  16819. if (!epoch) return false;
  16820. auto se = detail::scope_exit([&] { ASN1_TIME_free(epoch); });
  16821. if (!ASN1_TIME_set(epoch, 0)) return false;
  16822. int pday, psec;
  16823. if (!ASN1_TIME_diff(&pday, &psec, epoch, nb)) return false;
  16824. not_before = 86400 * (time_t)pday + psec;
  16825. if (!ASN1_TIME_diff(&pday, &psec, epoch, na)) return false;
  16826. not_after = 86400 * (time_t)pday + psec;
  16827. return true;
  16828. }
  16829. inline std::string get_cert_serial(cert_t cert) {
  16830. if (!cert) return "";
  16831. auto x509 = static_cast<X509 *>(cert);
  16832. auto serial = X509_get_serialNumber(x509);
  16833. if (!serial) return "";
  16834. auto bn = ASN1_INTEGER_to_BN(serial, nullptr);
  16835. if (!bn) return "";
  16836. auto hex = BN_bn2hex(bn);
  16837. BN_free(bn);
  16838. if (!hex) return "";
  16839. std::string result(hex);
  16840. OPENSSL_free(hex);
  16841. return result;
  16842. }
  16843. inline bool get_cert_der(cert_t cert, std::vector<unsigned char> &der) {
  16844. if (!cert) return false;
  16845. auto x509 = static_cast<X509 *>(cert);
  16846. auto len = i2d_X509(x509, nullptr);
  16847. if (len < 0) return false;
  16848. der.resize(static_cast<size_t>(len));
  16849. auto p = der.data();
  16850. i2d_X509(x509, &p);
  16851. return true;
  16852. }
  16853. inline const char *get_sni(const_session_t session) {
  16854. if (!session) return nullptr;
  16855. auto ssl = static_cast<SSL *>(const_cast<void *>(session));
  16856. return SSL_get_servername(ssl, TLSEXT_NAMETYPE_host_name);
  16857. }
  16858. inline uint64_t peek_error() { return ERR_peek_last_error(); }
  16859. inline uint64_t get_error() { return ERR_get_error(); }
  16860. inline std::string error_string(uint64_t code) {
  16861. char buf[256];
  16862. ERR_error_string_n(static_cast<unsigned long>(code), buf, sizeof(buf));
  16863. return std::string(buf);
  16864. }
  16865. inline ca_store_t create_ca_store(const char *pem, size_t len) {
  16866. auto mem = BIO_new_mem_buf(pem, static_cast<int>(len));
  16867. if (!mem) { return nullptr; }
  16868. auto mem_guard = detail::scope_exit([&] { BIO_free_all(mem); });
  16869. auto inf = PEM_X509_INFO_read_bio(mem, nullptr, nullptr, nullptr);
  16870. if (!inf) { return nullptr; }
  16871. auto store = X509_STORE_new();
  16872. if (store) {
  16873. for (auto i = 0; i < static_cast<int>(sk_X509_INFO_num(inf)); i++) {
  16874. auto itmp = sk_X509_INFO_value(inf, i);
  16875. if (!itmp) { continue; }
  16876. if (itmp->x509) { X509_STORE_add_cert(store, itmp->x509); }
  16877. if (itmp->crl) { X509_STORE_add_crl(store, itmp->crl); }
  16878. }
  16879. }
  16880. sk_X509_INFO_pop_free(inf, X509_INFO_free);
  16881. return static_cast<ca_store_t>(store);
  16882. }
  16883. inline void free_ca_store(ca_store_t store) {
  16884. if (store) { X509_STORE_free(static_cast<X509_STORE *>(store)); }
  16885. }
  16886. inline bool set_ca_store(ctx_t ctx, ca_store_t store) {
  16887. if (!ctx || !store) { return false; }
  16888. auto ssl_ctx = static_cast<SSL_CTX *>(ctx);
  16889. auto x509_store = static_cast<X509_STORE *>(store);
  16890. // Check if same store is already set
  16891. if (SSL_CTX_get_cert_store(ssl_ctx) == x509_store) { return true; }
  16892. // SSL_CTX_set_cert_store takes ownership and frees the old store
  16893. SSL_CTX_set_cert_store(ssl_ctx, x509_store);
  16894. return true;
  16895. }
  16896. inline size_t get_ca_certs(ctx_t ctx, std::vector<cert_t> &certs) {
  16897. certs.clear();
  16898. if (!ctx) { return 0; }
  16899. auto ssl_ctx = static_cast<SSL_CTX *>(ctx);
  16900. auto store = SSL_CTX_get_cert_store(ssl_ctx);
  16901. if (!store) { return 0; }
  16902. auto objs = impl::get_store_objects(store);
  16903. if (!objs) { return 0; }
  16904. auto se = detail::scope_exit([&] { impl::release_store_objects(objs); });
  16905. auto count = sk_X509_OBJECT_num(objs);
  16906. for (decltype(count) i = 0; i < count; i++) {
  16907. auto obj = sk_X509_OBJECT_value(objs, i);
  16908. if (!obj) { continue; }
  16909. if (X509_OBJECT_get_type(obj) == X509_LU_X509) {
  16910. auto x509 = X509_OBJECT_get0_X509(obj);
  16911. if (x509) {
  16912. // Increment reference count so caller can free it
  16913. X509_up_ref(x509);
  16914. certs.push_back(static_cast<cert_t>(x509));
  16915. }
  16916. }
  16917. }
  16918. return certs.size();
  16919. }
  16920. inline std::vector<std::string> get_ca_names(ctx_t ctx) {
  16921. std::vector<std::string> names;
  16922. if (!ctx) { return names; }
  16923. auto ssl_ctx = static_cast<SSL_CTX *>(ctx);
  16924. auto store = SSL_CTX_get_cert_store(ssl_ctx);
  16925. if (!store) { return names; }
  16926. auto objs = impl::get_store_objects(store);
  16927. if (!objs) { return names; }
  16928. auto se = detail::scope_exit([&] { impl::release_store_objects(objs); });
  16929. auto count = sk_X509_OBJECT_num(objs);
  16930. for (decltype(count) i = 0; i < count; i++) {
  16931. auto obj = sk_X509_OBJECT_value(objs, i);
  16932. if (!obj) { continue; }
  16933. if (X509_OBJECT_get_type(obj) == X509_LU_X509) {
  16934. auto x509 = X509_OBJECT_get0_X509(obj);
  16935. if (x509) {
  16936. auto subject = X509_get_subject_name(x509);
  16937. if (subject) {
  16938. char buf[512];
  16939. X509_NAME_oneline(subject, buf, sizeof(buf));
  16940. names.push_back(buf);
  16941. }
  16942. }
  16943. }
  16944. }
  16945. return names;
  16946. }
  16947. inline bool update_server_cert(ctx_t ctx, const char *cert_pem,
  16948. const char *key_pem, const char *password) {
  16949. if (!ctx || !cert_pem || !key_pem) { return false; }
  16950. auto ssl_ctx = static_cast<SSL_CTX *>(ctx);
  16951. // Load certificate from PEM
  16952. auto cert_bio = BIO_new_mem_buf(cert_pem, -1);
  16953. if (!cert_bio) { return false; }
  16954. auto cert = PEM_read_bio_X509(cert_bio, nullptr, nullptr, nullptr);
  16955. BIO_free(cert_bio);
  16956. if (!cert) { return false; }
  16957. // Load private key from PEM
  16958. auto key_bio = BIO_new_mem_buf(key_pem, -1);
  16959. if (!key_bio) {
  16960. X509_free(cert);
  16961. return false;
  16962. }
  16963. auto key = PEM_read_bio_PrivateKey(key_bio, nullptr, nullptr,
  16964. password ? const_cast<char *>(password)
  16965. : nullptr);
  16966. BIO_free(key_bio);
  16967. if (!key) {
  16968. X509_free(cert);
  16969. return false;
  16970. }
  16971. // Update certificate and key
  16972. auto ret = SSL_CTX_use_certificate(ssl_ctx, cert) == 1 &&
  16973. SSL_CTX_use_PrivateKey(ssl_ctx, key) == 1;
  16974. X509_free(cert);
  16975. EVP_PKEY_free(key);
  16976. return ret;
  16977. }
  16978. inline bool update_server_client_ca(ctx_t ctx, const char *ca_pem) {
  16979. if (!ctx || !ca_pem) { return false; }
  16980. auto ssl_ctx = static_cast<SSL_CTX *>(ctx);
  16981. // Create new X509_STORE from PEM
  16982. auto store = create_ca_store(ca_pem, strlen(ca_pem));
  16983. if (!store) { return false; }
  16984. // SSL_CTX_set_cert_store takes ownership
  16985. SSL_CTX_set_cert_store(ssl_ctx, static_cast<X509_STORE *>(store));
  16986. // Set client CA list for client certificate request
  16987. auto ca_list = impl::create_client_ca_list_from_pem(ca_pem);
  16988. if (ca_list) {
  16989. // SSL_CTX_set_client_CA_list takes ownership of ca_list
  16990. SSL_CTX_set_client_CA_list(ssl_ctx, ca_list);
  16991. }
  16992. return true;
  16993. }
  16994. inline bool set_verify_callback(ctx_t ctx, VerifyCallback callback) {
  16995. if (!ctx) { return false; }
  16996. auto ssl_ctx = static_cast<SSL_CTX *>(ctx);
  16997. impl::get_verify_callback() = std::move(callback);
  16998. if (impl::get_verify_callback()) {
  16999. SSL_CTX_set_verify(ssl_ctx, SSL_VERIFY_PEER, impl::openssl_verify_callback);
  17000. } else {
  17001. SSL_CTX_set_verify(ssl_ctx, SSL_VERIFY_PEER, nullptr);
  17002. }
  17003. return true;
  17004. }
  17005. inline long get_verify_error(const_session_t session) {
  17006. if (!session) { return -1; }
  17007. auto ssl = static_cast<SSL *>(const_cast<void *>(session));
  17008. return SSL_get_verify_result(ssl);
  17009. }
  17010. inline std::string verify_error_string(long error_code) {
  17011. if (error_code == X509_V_OK) { return ""; }
  17012. const char *str = X509_verify_cert_error_string(static_cast<int>(error_code));
  17013. return str ? str : "unknown error";
  17014. }
  17015. } // namespace tls
  17016. #endif // CPPHTTPLIB_OPENSSL_SUPPORT
  17017. /*
  17018. * Group 9: TLS abstraction layer - Mbed TLS backend
  17019. */
  17020. /*
  17021. * Mbed TLS Backend Implementation
  17022. */
  17023. #ifdef CPPHTTPLIB_MBEDTLS_SUPPORT
  17024. namespace tls {
  17025. namespace impl {
  17026. // Mbed TLS session wrapper
  17027. struct MbedTlsSession {
  17028. mbedtls_ssl_context ssl;
  17029. socket_t sock = INVALID_SOCKET;
  17030. std::string hostname; // For client: set via set_sni
  17031. std::string sni_hostname; // For server: received from client via SNI callback
  17032. // Mbed TLS has no SSL_peek() equivalent, so is_peer_closed() must probe with
  17033. // a real 1-byte mbedtls_ssl_read(). If that probe lands on application data
  17034. // (e.g. a response that arrived while this side was still in its post-write
  17035. // check), the byte is pushed back here and served by the next read().
  17036. unsigned char peeked_byte = 0;
  17037. bool has_peeked_byte = false;
  17038. // Set by set_sni() when the caller disabled hostname verification, so the
  17039. // verify callback can clear the CN/SAN mismatch flag while still enforcing
  17040. // the rest of the chain (Mbed TLS ties SNI and identity checking together;
  17041. // OpenSSL and wolfSSL keep them independent).
  17042. bool suppress_hostname_mismatch = false;
  17043. // Copied from the owning MbedTlsContext at creation. set_sni() uses this to
  17044. // decide which verify callback to install when hostname verification is
  17045. // disabled: mbedtls_verify_callback() when a user callback is genuinely
  17046. // wired for this context, or a self-contained one otherwise, so a session
  17047. // that never opted into a callback never consults the process-wide
  17048. // set_verify_callback() slot (which some other, unrelated client may have
  17049. // populated).
  17050. bool has_verify_callback = false;
  17051. MbedTlsSession() { mbedtls_ssl_init(&ssl); }
  17052. ~MbedTlsSession() { mbedtls_ssl_free(&ssl); }
  17053. MbedTlsSession(const MbedTlsSession &) = delete;
  17054. MbedTlsSession &operator=(const MbedTlsSession &) = delete;
  17055. };
  17056. // Thread-local error code accessor for Mbed TLS (since it doesn't have an error
  17057. // queue)
  17058. inline int &mbedtls_last_error() {
  17059. static thread_local int err = 0;
  17060. return err;
  17061. }
  17062. // Helper to map Mbed TLS error to ErrorCode
  17063. inline ErrorCode map_mbedtls_error(int ret, int &out_errno,
  17064. uint32_t verify_flags) {
  17065. if (ret == 0) { return ErrorCode::Success; }
  17066. if (ret == MBEDTLS_ERR_SSL_WANT_READ) { return ErrorCode::WantRead; }
  17067. if (ret == MBEDTLS_ERR_SSL_WANT_WRITE) { return ErrorCode::WantWrite; }
  17068. if (ret == MBEDTLS_ERR_SSL_PEER_CLOSE_NOTIFY) {
  17069. return ErrorCode::PeerClosed;
  17070. }
  17071. if (ret == MBEDTLS_ERR_NET_CONN_RESET || ret == MBEDTLS_ERR_NET_SEND_FAILED ||
  17072. ret == MBEDTLS_ERR_NET_RECV_FAILED) {
  17073. out_errno = errno;
  17074. return ErrorCode::SyscallError;
  17075. }
  17076. if (ret == MBEDTLS_ERR_X509_CERT_VERIFY_FAILED) {
  17077. // Unlike OpenSSL/wolfSSL, Mbed TLS folds the CN/SAN identity check into
  17078. // the handshake's chain verification (see set_sni()); a mismatch there
  17079. // is reported the same way as any other verify_flags bit. Report it as
  17080. // HostnameMismatch, matching the other backends and the post-handshake
  17081. // identity check below, but only when naming is the sole problem -
  17082. // if the chain itself is also untrusted/expired/etc., that takes
  17083. // priority over the naming detail.
  17084. if (verify_flags == static_cast<uint32_t>(hostname_mismatch_code())) {
  17085. return ErrorCode::HostnameMismatch;
  17086. }
  17087. return ErrorCode::CertVerifyFailed;
  17088. }
  17089. return ErrorCode::Fatal;
  17090. }
  17091. // Populates a TlsError from a failed (non-zero) mbedtls_ssl_handshake()
  17092. // return value, including the verify-flags-dependent HostnameMismatch
  17093. // mapping; shared by connect() and connect_nonblocking() so the
  17094. // backend_code policy for that mapping only lives in one place.
  17095. inline void fill_mbedtls_tls_error(TlsError &err, mbedtls_ssl_context &ssl,
  17096. int ret) {
  17097. auto verify_flags = mbedtls_ssl_get_verify_result(&ssl);
  17098. err.code = map_mbedtls_error(ret, err.sys_errno, verify_flags);
  17099. err.backend_code = err.code == ErrorCode::HostnameMismatch
  17100. ? static_cast<uint64_t>(verify_flags)
  17101. : static_cast<uint64_t>(-ret);
  17102. }
  17103. // A TLS 1.3 NewSessionTicket (signaled by default on Mbed TLS 4.x) is a
  17104. // non-fatal notification delivered between records, not an error and not
  17105. // application data, so I/O calls that see it should just be retried. Kept in
  17106. // one helper so the retry loops keep an intact "do { } while (...)" instead of
  17107. // splitting the closing brace across an #if.
  17108. inline bool mbedtls_is_session_ticket(int ret) {
  17109. #if defined(MBEDTLS_ERR_SSL_RECEIVED_NEW_SESSION_TICKET)
  17110. return ret == MBEDTLS_ERR_SSL_RECEIVED_NEW_SESSION_TICKET;
  17111. #else
  17112. (void)ret;
  17113. return false;
  17114. #endif
  17115. }
  17116. // BIO-like send callback for Mbed TLS
  17117. inline int mbedtls_net_send_cb(void *ctx, const unsigned char *buf,
  17118. size_t len) {
  17119. auto sock = *static_cast<socket_t *>(ctx);
  17120. #ifdef _WIN32
  17121. auto ret =
  17122. send(sock, reinterpret_cast<const char *>(buf), static_cast<int>(len), 0);
  17123. if (ret == SOCKET_ERROR) {
  17124. int err = WSAGetLastError();
  17125. if (err == WSAEWOULDBLOCK) { return MBEDTLS_ERR_SSL_WANT_WRITE; }
  17126. return MBEDTLS_ERR_NET_SEND_FAILED;
  17127. }
  17128. #else
  17129. auto ret = send(sock, buf, len, 0);
  17130. if (ret < 0) {
  17131. if (errno == EAGAIN || errno == EWOULDBLOCK) {
  17132. return MBEDTLS_ERR_SSL_WANT_WRITE;
  17133. }
  17134. return MBEDTLS_ERR_NET_SEND_FAILED;
  17135. }
  17136. #endif
  17137. return static_cast<int>(ret);
  17138. }
  17139. // BIO-like recv callback for Mbed TLS
  17140. inline int mbedtls_net_recv_cb(void *ctx, unsigned char *buf, size_t len) {
  17141. auto sock = *static_cast<socket_t *>(ctx);
  17142. #ifdef _WIN32
  17143. auto ret =
  17144. recv(sock, reinterpret_cast<char *>(buf), static_cast<int>(len), 0);
  17145. if (ret == SOCKET_ERROR) {
  17146. int err = WSAGetLastError();
  17147. if (err == WSAEWOULDBLOCK) { return MBEDTLS_ERR_SSL_WANT_READ; }
  17148. return MBEDTLS_ERR_NET_RECV_FAILED;
  17149. }
  17150. #else
  17151. auto ret = recv(sock, buf, len, 0);
  17152. if (ret < 0) {
  17153. if (errno == EAGAIN || errno == EWOULDBLOCK) {
  17154. return MBEDTLS_ERR_SSL_WANT_READ;
  17155. }
  17156. return MBEDTLS_ERR_NET_RECV_FAILED;
  17157. }
  17158. #endif
  17159. if (ret == 0) { return MBEDTLS_ERR_SSL_PEER_CLOSE_NOTIFY; }
  17160. return static_cast<int>(ret);
  17161. }
  17162. // MbedTlsContext constructor/destructor implementations
  17163. inline MbedTlsContext::MbedTlsContext() {
  17164. mbedtls_ssl_config_init(&conf);
  17165. #ifndef CPPHTTPLIB_MBEDTLS_V4
  17166. mbedtls_entropy_init(&entropy);
  17167. mbedtls_ctr_drbg_init(&ctr_drbg);
  17168. #endif
  17169. mbedtls_x509_crt_init(&ca_chain);
  17170. mbedtls_x509_crt_init(&own_cert);
  17171. mbedtls_pk_init(&own_key);
  17172. }
  17173. inline MbedTlsContext::~MbedTlsContext() {
  17174. mbedtls_pk_free(&own_key);
  17175. mbedtls_x509_crt_free(&own_cert);
  17176. mbedtls_x509_crt_free(&ca_chain);
  17177. #ifndef CPPHTTPLIB_MBEDTLS_V4
  17178. mbedtls_ctr_drbg_free(&ctr_drbg);
  17179. mbedtls_entropy_free(&entropy);
  17180. #endif
  17181. mbedtls_ssl_config_free(&conf);
  17182. }
  17183. // Thread-local storage for SNI captured during handshake
  17184. // This is needed because the SNI callback doesn't have a way to pass
  17185. // session-specific data before the session is fully set up
  17186. inline std::string &mbedpending_sni() {
  17187. static thread_local std::string sni;
  17188. return sni;
  17189. }
  17190. // SNI callback for Mbed TLS server to capture client's SNI hostname
  17191. inline int mbedtls_sni_callback(void *p_ctx, mbedtls_ssl_context *ssl,
  17192. const unsigned char *name, size_t name_len) {
  17193. (void)p_ctx;
  17194. (void)ssl;
  17195. // Store SNI name in thread-local storage
  17196. // It will be retrieved and stored in the session after handshake
  17197. if (name && name_len > 0) {
  17198. mbedpending_sni().assign(reinterpret_cast<const char *>(name), name_len);
  17199. } else {
  17200. mbedpending_sni().clear();
  17201. }
  17202. return 0; // Accept any SNI
  17203. }
  17204. inline void mbedtls_clear_cn_mismatch(uint32_t *flags) {
  17205. *flags &= ~static_cast<uint32_t>(hostname_mismatch_code());
  17206. }
  17207. // Verify callback used when hostname verification is disabled for a session
  17208. // that has no user-supplied verify callback of its own (MbedTlsSession::
  17209. // has_verify_callback is false). Deliberately does not consult
  17210. // get_verify_callback(): that slot is process-wide, so reading it here would
  17211. // pick up whatever another, unrelated client last installed there.
  17212. inline int mbedtls_mask_hostname_mismatch_callback(void *data,
  17213. mbedtls_x509_crt *, int,
  17214. uint32_t *flags) {
  17215. (void)data;
  17216. mbedtls_clear_cn_mismatch(flags);
  17217. return 0;
  17218. }
  17219. inline int mbedtls_verify_callback(void *data, mbedtls_x509_crt *crt,
  17220. int cert_depth, uint32_t *flags);
  17221. // MbedTLS verify callback wrapper
  17222. inline int mbedtls_verify_callback(void *data, mbedtls_x509_crt *crt,
  17223. int cert_depth, uint32_t *flags) {
  17224. // data points to the MbedTlsSession
  17225. auto *session = static_cast<MbedTlsSession *>(data);
  17226. // set_sni() disabled hostname verification for this session: drop the
  17227. // CN/SAN mismatch flag so it doesn't fail the chain check below, mirroring
  17228. // the OpenSSL/wolfSSL backends where identity checking is independent of
  17229. // SNI. The final pass/fail decision still comes from the remaining flags
  17230. // (or, below, from the user's own verify callback).
  17231. if (session && session->suppress_hostname_mismatch) {
  17232. mbedtls_clear_cn_mismatch(flags);
  17233. }
  17234. auto &callback = get_verify_callback();
  17235. if (!callback) { return 0; } // Continue with default verification
  17236. // Build context
  17237. VerifyContext verify_ctx;
  17238. verify_ctx.session = static_cast<session_t>(session);
  17239. verify_ctx.cert = static_cast<cert_t>(crt);
  17240. verify_ctx.depth = cert_depth;
  17241. verify_ctx.preverify_ok = (*flags == 0);
  17242. verify_ctx.error_code = static_cast<long>(*flags);
  17243. // Convert Mbed TLS flags to error string
  17244. static thread_local char error_buf[256];
  17245. if (*flags != 0) {
  17246. mbedtls_x509_crt_verify_info(error_buf, sizeof(error_buf), "", *flags);
  17247. verify_ctx.error_string = error_buf;
  17248. } else {
  17249. verify_ctx.error_string = nullptr;
  17250. }
  17251. bool accepted = callback(verify_ctx);
  17252. if (accepted) {
  17253. *flags = 0; // Clear all error flags
  17254. return 0;
  17255. }
  17256. return MBEDTLS_ERR_X509_CERT_VERIFY_FAILED;
  17257. }
  17258. } // namespace impl
  17259. inline ctx_t create_client_context() {
  17260. auto ctx = new (std::nothrow) impl::MbedTlsContext();
  17261. if (!ctx) { return nullptr; }
  17262. ctx->is_server = false;
  17263. #ifdef CPPHTTPLIB_MBEDTLS_V4
  17264. // Mbed TLS 4.x draws randomness from PSA Crypto; just ensure it is ready.
  17265. if (!detail::ensure_mbedtls_psa_crypto()) {
  17266. delete ctx;
  17267. return nullptr;
  17268. }
  17269. int ret;
  17270. #else
  17271. // Seed the random number generator
  17272. const char *pers = "httplib_client";
  17273. int ret = mbedtls_ctr_drbg_seed(
  17274. &ctx->ctr_drbg, mbedtls_entropy_func, &ctx->entropy,
  17275. reinterpret_cast<const unsigned char *>(pers), strlen(pers));
  17276. if (ret != 0) {
  17277. impl::mbedtls_last_error() = ret;
  17278. delete ctx;
  17279. return nullptr;
  17280. }
  17281. #endif
  17282. // Set up SSL config for client
  17283. ret = mbedtls_ssl_config_defaults(&ctx->conf, MBEDTLS_SSL_IS_CLIENT,
  17284. MBEDTLS_SSL_TRANSPORT_STREAM,
  17285. MBEDTLS_SSL_PRESET_DEFAULT);
  17286. if (ret != 0) {
  17287. impl::mbedtls_last_error() = ret;
  17288. delete ctx;
  17289. return nullptr;
  17290. }
  17291. #ifndef CPPHTTPLIB_MBEDTLS_V4
  17292. // Set random number generator (Mbed TLS 4.x uses the PSA RNG implicitly)
  17293. mbedtls_ssl_conf_rng(&ctx->conf, mbedtls_ctr_drbg_random, &ctx->ctr_drbg);
  17294. #endif
  17295. // Default: verify peer certificate
  17296. mbedtls_ssl_conf_authmode(&ctx->conf, MBEDTLS_SSL_VERIFY_REQUIRED);
  17297. // Set minimum TLS version to 1.2
  17298. #ifdef CPPHTTPLIB_MBEDTLS_V3
  17299. mbedtls_ssl_conf_min_tls_version(&ctx->conf, MBEDTLS_SSL_VERSION_TLS1_2);
  17300. #else
  17301. mbedtls_ssl_conf_min_version(&ctx->conf, MBEDTLS_SSL_MAJOR_VERSION_3,
  17302. MBEDTLS_SSL_MINOR_VERSION_3);
  17303. #endif
  17304. return static_cast<ctx_t>(ctx);
  17305. }
  17306. inline ctx_t create_server_context() {
  17307. auto ctx = new (std::nothrow) impl::MbedTlsContext();
  17308. if (!ctx) { return nullptr; }
  17309. ctx->is_server = true;
  17310. #ifdef CPPHTTPLIB_MBEDTLS_V4
  17311. // Mbed TLS 4.x draws randomness from PSA Crypto; just ensure it is ready.
  17312. if (!detail::ensure_mbedtls_psa_crypto()) {
  17313. delete ctx;
  17314. return nullptr;
  17315. }
  17316. int ret;
  17317. #else
  17318. // Seed the random number generator
  17319. const char *pers = "httplib_server";
  17320. int ret = mbedtls_ctr_drbg_seed(
  17321. &ctx->ctr_drbg, mbedtls_entropy_func, &ctx->entropy,
  17322. reinterpret_cast<const unsigned char *>(pers), strlen(pers));
  17323. if (ret != 0) {
  17324. impl::mbedtls_last_error() = ret;
  17325. delete ctx;
  17326. return nullptr;
  17327. }
  17328. #endif
  17329. // Set up SSL config for server
  17330. ret = mbedtls_ssl_config_defaults(&ctx->conf, MBEDTLS_SSL_IS_SERVER,
  17331. MBEDTLS_SSL_TRANSPORT_STREAM,
  17332. MBEDTLS_SSL_PRESET_DEFAULT);
  17333. if (ret != 0) {
  17334. impl::mbedtls_last_error() = ret;
  17335. delete ctx;
  17336. return nullptr;
  17337. }
  17338. #ifndef CPPHTTPLIB_MBEDTLS_V4
  17339. // Set random number generator (Mbed TLS 4.x uses the PSA RNG implicitly)
  17340. mbedtls_ssl_conf_rng(&ctx->conf, mbedtls_ctr_drbg_random, &ctx->ctr_drbg);
  17341. #endif
  17342. // Default: don't verify client
  17343. mbedtls_ssl_conf_authmode(&ctx->conf, MBEDTLS_SSL_VERIFY_NONE);
  17344. // Set minimum TLS version to 1.2
  17345. #ifdef CPPHTTPLIB_MBEDTLS_V3
  17346. mbedtls_ssl_conf_min_tls_version(&ctx->conf, MBEDTLS_SSL_VERSION_TLS1_2);
  17347. #else
  17348. mbedtls_ssl_conf_min_version(&ctx->conf, MBEDTLS_SSL_MAJOR_VERSION_3,
  17349. MBEDTLS_SSL_MINOR_VERSION_3);
  17350. #endif
  17351. // Set SNI callback to capture client's SNI hostname
  17352. mbedtls_ssl_conf_sni(&ctx->conf, impl::mbedtls_sni_callback, nullptr);
  17353. return static_cast<ctx_t>(ctx);
  17354. }
  17355. inline void free_context(ctx_t ctx) {
  17356. if (ctx) { delete static_cast<impl::MbedTlsContext *>(ctx); }
  17357. }
  17358. inline bool set_min_version(ctx_t ctx, Version version) {
  17359. if (!ctx) { return false; }
  17360. auto mctx = static_cast<impl::MbedTlsContext *>(ctx);
  17361. #ifdef CPPHTTPLIB_MBEDTLS_V3
  17362. // Mbed TLS 3.x uses mbedtls_ssl_protocol_version enum
  17363. mbedtls_ssl_protocol_version min_ver = MBEDTLS_SSL_VERSION_TLS1_2;
  17364. if (version >= Version::TLS1_3) {
  17365. #if defined(MBEDTLS_SSL_PROTO_TLS1_3)
  17366. min_ver = MBEDTLS_SSL_VERSION_TLS1_3;
  17367. #endif
  17368. }
  17369. mbedtls_ssl_conf_min_tls_version(&mctx->conf, min_ver);
  17370. #else
  17371. // Mbed TLS 2.x uses major/minor version numbers
  17372. int major = MBEDTLS_SSL_MAJOR_VERSION_3;
  17373. int minor = MBEDTLS_SSL_MINOR_VERSION_3; // TLS 1.2
  17374. if (version >= Version::TLS1_3) {
  17375. #if defined(MBEDTLS_SSL_PROTO_TLS1_3)
  17376. minor = MBEDTLS_SSL_MINOR_VERSION_4; // TLS 1.3
  17377. #else
  17378. minor = MBEDTLS_SSL_MINOR_VERSION_3; // Fall back to TLS 1.2
  17379. #endif
  17380. }
  17381. mbedtls_ssl_conf_min_version(&mctx->conf, major, minor);
  17382. #endif
  17383. return true;
  17384. }
  17385. inline bool load_ca_pem(ctx_t ctx, const char *pem, size_t len) {
  17386. if (!ctx || !pem) { return false; }
  17387. auto mctx = static_cast<impl::MbedTlsContext *>(ctx);
  17388. // mbedtls_x509_crt_parse expects null-terminated string for PEM
  17389. // Add null terminator if not present
  17390. std::string pem_str(pem, len);
  17391. int ret = mbedtls_x509_crt_parse(
  17392. &mctx->ca_chain, reinterpret_cast<const unsigned char *>(pem_str.c_str()),
  17393. pem_str.size() + 1);
  17394. if (ret != 0) {
  17395. impl::mbedtls_last_error() = ret;
  17396. return false;
  17397. }
  17398. mbedtls_ssl_conf_ca_chain(&mctx->conf, &mctx->ca_chain, nullptr);
  17399. return true;
  17400. }
  17401. inline bool load_ca_file(ctx_t ctx, const char *file_path) {
  17402. if (!ctx || !file_path) { return false; }
  17403. auto mctx = static_cast<impl::MbedTlsContext *>(ctx);
  17404. int ret = mbedtls_x509_crt_parse_file(&mctx->ca_chain, file_path);
  17405. if (ret != 0) {
  17406. impl::mbedtls_last_error() = ret;
  17407. return false;
  17408. }
  17409. mbedtls_ssl_conf_ca_chain(&mctx->conf, &mctx->ca_chain, nullptr);
  17410. return true;
  17411. }
  17412. inline bool load_ca_dir(ctx_t ctx, const char *dir_path) {
  17413. if (!ctx || !dir_path) { return false; }
  17414. auto mctx = static_cast<impl::MbedTlsContext *>(ctx);
  17415. int ret = mbedtls_x509_crt_parse_path(&mctx->ca_chain, dir_path);
  17416. if (ret < 0) { // Returns number of certs on success, negative on error
  17417. impl::mbedtls_last_error() = ret;
  17418. return false;
  17419. }
  17420. mbedtls_ssl_conf_ca_chain(&mctx->conf, &mctx->ca_chain, nullptr);
  17421. return true;
  17422. }
  17423. inline bool load_system_certs(ctx_t ctx) {
  17424. if (!ctx) { return false; }
  17425. auto mctx = static_cast<impl::MbedTlsContext *>(ctx);
  17426. bool loaded = false;
  17427. #ifdef _WIN32
  17428. loaded = impl::enumerate_windows_system_certs(
  17429. [&](const unsigned char *data, size_t len) {
  17430. return mbedtls_x509_crt_parse_der(&mctx->ca_chain, data, len) == 0;
  17431. });
  17432. #elif defined(__APPLE__) && defined(CPPHTTPLIB_USE_CERTS_FROM_MACOSX_KEYCHAIN)
  17433. loaded = impl::enumerate_macos_keychain_certs(
  17434. [&](const unsigned char *data, size_t len) {
  17435. return mbedtls_x509_crt_parse_der(&mctx->ca_chain, data, len) == 0;
  17436. });
  17437. #else
  17438. for (auto path = impl::system_ca_paths(); *path; ++path) {
  17439. if (mbedtls_x509_crt_parse_file(&mctx->ca_chain, *path) >= 0) {
  17440. loaded = true;
  17441. break;
  17442. }
  17443. }
  17444. if (!loaded) {
  17445. for (auto dir = impl::system_ca_dirs(); *dir; ++dir) {
  17446. if (mbedtls_x509_crt_parse_path(&mctx->ca_chain, *dir) >= 0) {
  17447. loaded = true;
  17448. break;
  17449. }
  17450. }
  17451. }
  17452. #endif
  17453. if (loaded) {
  17454. mbedtls_ssl_conf_ca_chain(&mctx->conf, &mctx->ca_chain, nullptr);
  17455. }
  17456. return loaded;
  17457. }
  17458. inline bool set_client_cert_pem(ctx_t ctx, const char *cert, const char *key,
  17459. const char *password) {
  17460. if (!ctx || !cert || !key) { return false; }
  17461. auto mctx = static_cast<impl::MbedTlsContext *>(ctx);
  17462. // Parse certificate
  17463. std::string cert_str(cert);
  17464. int ret = mbedtls_x509_crt_parse(
  17465. &mctx->own_cert,
  17466. reinterpret_cast<const unsigned char *>(cert_str.c_str()),
  17467. cert_str.size() + 1);
  17468. if (ret != 0) {
  17469. impl::mbedtls_last_error() = ret;
  17470. return false;
  17471. }
  17472. // Parse private key
  17473. std::string key_str(key);
  17474. const unsigned char *pwd =
  17475. password ? reinterpret_cast<const unsigned char *>(password) : nullptr;
  17476. size_t pwd_len = password ? strlen(password) : 0;
  17477. #if defined(CPPHTTPLIB_MBEDTLS_V3) && !defined(CPPHTTPLIB_MBEDTLS_V4)
  17478. ret = mbedtls_pk_parse_key(
  17479. &mctx->own_key, reinterpret_cast<const unsigned char *>(key_str.c_str()),
  17480. key_str.size() + 1, pwd, pwd_len, mbedtls_ctr_drbg_random,
  17481. &mctx->ctr_drbg);
  17482. #else
  17483. ret = mbedtls_pk_parse_key(
  17484. &mctx->own_key, reinterpret_cast<const unsigned char *>(key_str.c_str()),
  17485. key_str.size() + 1, pwd, pwd_len);
  17486. #endif
  17487. if (ret != 0) {
  17488. impl::mbedtls_last_error() = ret;
  17489. return false;
  17490. }
  17491. // Verify that the certificate and private key match.
  17492. // Mbed TLS 4.x: mbedtls_pk_check_pair() reports a spurious mismatch for
  17493. // PSA-backed keys, so skip it and let the handshake surface a real mismatch.
  17494. #ifndef CPPHTTPLIB_MBEDTLS_V4
  17495. #ifdef CPPHTTPLIB_MBEDTLS_V3
  17496. ret = mbedtls_pk_check_pair(&mctx->own_cert.pk, &mctx->own_key,
  17497. mbedtls_ctr_drbg_random, &mctx->ctr_drbg);
  17498. #else
  17499. ret = mbedtls_pk_check_pair(&mctx->own_cert.pk, &mctx->own_key);
  17500. #endif
  17501. if (ret != 0) {
  17502. impl::mbedtls_last_error() = ret;
  17503. return false;
  17504. }
  17505. #endif
  17506. ret = mbedtls_ssl_conf_own_cert(&mctx->conf, &mctx->own_cert, &mctx->own_key);
  17507. if (ret != 0) {
  17508. impl::mbedtls_last_error() = ret;
  17509. return false;
  17510. }
  17511. return true;
  17512. }
  17513. inline bool set_client_cert_file(ctx_t ctx, const char *cert_path,
  17514. const char *key_path, const char *password) {
  17515. if (!ctx || !cert_path || !key_path) { return false; }
  17516. auto mctx = static_cast<impl::MbedTlsContext *>(ctx);
  17517. // Parse certificate file
  17518. int ret = mbedtls_x509_crt_parse_file(&mctx->own_cert, cert_path);
  17519. if (ret != 0) {
  17520. impl::mbedtls_last_error() = ret;
  17521. return false;
  17522. }
  17523. // Parse private key file
  17524. #if defined(CPPHTTPLIB_MBEDTLS_V3) && !defined(CPPHTTPLIB_MBEDTLS_V4)
  17525. ret = mbedtls_pk_parse_keyfile(&mctx->own_key, key_path, password,
  17526. mbedtls_ctr_drbg_random, &mctx->ctr_drbg);
  17527. #else
  17528. ret = mbedtls_pk_parse_keyfile(&mctx->own_key, key_path, password);
  17529. #endif
  17530. if (ret != 0) {
  17531. impl::mbedtls_last_error() = ret;
  17532. return false;
  17533. }
  17534. // Verify that the certificate and private key match.
  17535. // Mbed TLS 4.x: see set_client_cert() — skip the spurious check_pair.
  17536. #ifndef CPPHTTPLIB_MBEDTLS_V4
  17537. #ifdef CPPHTTPLIB_MBEDTLS_V3
  17538. ret = mbedtls_pk_check_pair(&mctx->own_cert.pk, &mctx->own_key,
  17539. mbedtls_ctr_drbg_random, &mctx->ctr_drbg);
  17540. #else
  17541. ret = mbedtls_pk_check_pair(&mctx->own_cert.pk, &mctx->own_key);
  17542. #endif
  17543. if (ret != 0) {
  17544. impl::mbedtls_last_error() = ret;
  17545. return false;
  17546. }
  17547. #endif
  17548. ret = mbedtls_ssl_conf_own_cert(&mctx->conf, &mctx->own_cert, &mctx->own_key);
  17549. if (ret != 0) {
  17550. impl::mbedtls_last_error() = ret;
  17551. return false;
  17552. }
  17553. return true;
  17554. }
  17555. inline void set_verify_client(ctx_t ctx, bool require) {
  17556. if (!ctx) { return; }
  17557. auto mctx = static_cast<impl::MbedTlsContext *>(ctx);
  17558. mctx->verify_client = require;
  17559. if (require) {
  17560. mbedtls_ssl_conf_authmode(&mctx->conf, MBEDTLS_SSL_VERIFY_REQUIRED);
  17561. } else {
  17562. // If a verify callback is set, use OPTIONAL mode to ensure the callback
  17563. // is called (matching OpenSSL behavior). Otherwise use NONE.
  17564. mbedtls_ssl_conf_authmode(&mctx->conf, mctx->has_verify_callback
  17565. ? MBEDTLS_SSL_VERIFY_OPTIONAL
  17566. : MBEDTLS_SSL_VERIFY_NONE);
  17567. }
  17568. }
  17569. inline session_t create_session(ctx_t ctx, socket_t sock) {
  17570. if (!ctx || sock == INVALID_SOCKET) { return nullptr; }
  17571. auto mctx = static_cast<impl::MbedTlsContext *>(ctx);
  17572. auto session = new (std::nothrow) impl::MbedTlsSession();
  17573. if (!session) { return nullptr; }
  17574. session->sock = sock;
  17575. int ret = mbedtls_ssl_setup(&session->ssl, &mctx->conf);
  17576. if (ret != 0) {
  17577. impl::mbedtls_last_error() = ret;
  17578. delete session;
  17579. return nullptr;
  17580. }
  17581. // Explicitly opt out of in-handshake hostname verification by default;
  17582. // since Mbed TLS 3.6.4 a client handshake with certificate verification
  17583. // fails outright when no hostname was set. set_sni() installs the real
  17584. // hostname for DNS hosts; for IP hosts (where SNI must not be set) the
  17585. // caller verifies the certificate identity post-handshake via
  17586. // verify_hostname().
  17587. mbedtls_ssl_set_hostname(&session->ssl, nullptr);
  17588. // Set BIO callbacks
  17589. mbedtls_ssl_set_bio(&session->ssl, &session->sock, impl::mbedtls_net_send_cb,
  17590. impl::mbedtls_net_recv_cb, nullptr);
  17591. // Set per-session verify callback with session pointer if callback is
  17592. // registered
  17593. session->has_verify_callback = mctx->has_verify_callback;
  17594. if (mctx->has_verify_callback) {
  17595. mbedtls_ssl_set_verify(&session->ssl, impl::mbedtls_verify_callback,
  17596. session);
  17597. }
  17598. return static_cast<session_t>(session);
  17599. }
  17600. inline void free_session(session_t session) {
  17601. if (session) { delete static_cast<impl::MbedTlsSession *>(session); }
  17602. }
  17603. inline bool set_sni(session_t session, const char *hostname,
  17604. bool verify_hostname) {
  17605. if (!session || !hostname) { return false; }
  17606. auto msession = static_cast<impl::MbedTlsSession *>(session);
  17607. // mbedtls_ssl_set_hostname() both sends the SNI extension and binds the
  17608. // handshake-time CN/SAN check to `hostname`; the two can't be requested
  17609. // independently, so a disabled hostname check is handled below by masking
  17610. // the resulting mismatch flag instead of skipping this call.
  17611. int ret = mbedtls_ssl_set_hostname(&msession->ssl, hostname);
  17612. if (ret != 0) {
  17613. impl::mbedtls_last_error() = ret;
  17614. return false;
  17615. }
  17616. msession->hostname = hostname;
  17617. if (!verify_hostname) {
  17618. msession->suppress_hostname_mismatch = true;
  17619. // If a user verify callback is already wired for this session,
  17620. // mbedtls_verify_callback() masks the mismatch flag itself before
  17621. // consulting it (see suppress_hostname_mismatch above) - reinstalling it
  17622. // here would be redundant. Otherwise install the self-contained masking
  17623. // callback, which never touches the process-wide callback slot.
  17624. if (!msession->has_verify_callback) {
  17625. mbedtls_ssl_set_verify(&msession->ssl,
  17626. impl::mbedtls_mask_hostname_mismatch_callback,
  17627. msession);
  17628. }
  17629. }
  17630. return true;
  17631. }
  17632. inline TlsError connect(session_t session) {
  17633. TlsError err;
  17634. if (!session) {
  17635. err.code = ErrorCode::Fatal;
  17636. return err;
  17637. }
  17638. auto msession = static_cast<impl::MbedTlsSession *>(session);
  17639. int ret;
  17640. do {
  17641. ret = mbedtls_ssl_handshake(&msession->ssl);
  17642. } while (impl::mbedtls_is_session_ticket(ret));
  17643. if (ret == 0) {
  17644. err.code = ErrorCode::Success;
  17645. } else {
  17646. impl::fill_mbedtls_tls_error(err, msession->ssl, ret);
  17647. impl::mbedtls_last_error() = ret;
  17648. }
  17649. return err;
  17650. }
  17651. inline TlsError accept(session_t session) {
  17652. // Same as connect for Mbed TLS - handshake works for both client and server
  17653. auto result = connect(session);
  17654. // After successful handshake, capture SNI from thread-local storage
  17655. if (result.code == ErrorCode::Success && session) {
  17656. auto msession = static_cast<impl::MbedTlsSession *>(session);
  17657. msession->sni_hostname = std::move(impl::mbedpending_sni());
  17658. impl::mbedpending_sni().clear();
  17659. }
  17660. return result;
  17661. }
  17662. inline bool connect_nonblocking(session_t session, socket_t sock,
  17663. time_t timeout_sec, time_t timeout_usec,
  17664. TlsError *err) {
  17665. if (!session) {
  17666. if (err) { err->code = ErrorCode::Fatal; }
  17667. return false;
  17668. }
  17669. auto msession = static_cast<impl::MbedTlsSession *>(session);
  17670. // Set socket to non-blocking mode
  17671. detail::set_nonblocking(sock, true);
  17672. auto cleanup =
  17673. detail::scope_exit([&]() { detail::set_nonblocking(sock, false); });
  17674. int ret;
  17675. while ((ret = mbedtls_ssl_handshake(&msession->ssl)) != 0) {
  17676. // Non-fatal TLS 1.3 ticket; retry immediately.
  17677. if (impl::mbedtls_is_session_ticket(ret)) { continue; }
  17678. if (ret == MBEDTLS_ERR_SSL_WANT_READ) {
  17679. if (detail::select_read(sock, timeout_sec, timeout_usec) > 0) {
  17680. continue;
  17681. }
  17682. } else if (ret == MBEDTLS_ERR_SSL_WANT_WRITE) {
  17683. if (detail::select_write(sock, timeout_sec, timeout_usec) > 0) {
  17684. continue;
  17685. }
  17686. }
  17687. // TlsError or timeout
  17688. if (err) { impl::fill_mbedtls_tls_error(*err, msession->ssl, ret); }
  17689. impl::mbedtls_last_error() = ret;
  17690. return false;
  17691. }
  17692. if (err) { err->code = ErrorCode::Success; }
  17693. return true;
  17694. }
  17695. inline bool accept_nonblocking(session_t session, socket_t sock,
  17696. time_t timeout_sec, time_t timeout_usec,
  17697. TlsError *err) {
  17698. // Same implementation as connect for Mbed TLS
  17699. bool result =
  17700. connect_nonblocking(session, sock, timeout_sec, timeout_usec, err);
  17701. // After successful handshake, capture SNI from thread-local storage
  17702. if (result && session) {
  17703. auto msession = static_cast<impl::MbedTlsSession *>(session);
  17704. msession->sni_hostname = std::move(impl::mbedpending_sni());
  17705. impl::mbedpending_sni().clear();
  17706. }
  17707. return result;
  17708. }
  17709. inline ssize_t read(session_t session, void *buf, size_t len, TlsError &err) {
  17710. if (!session || !buf) {
  17711. err.code = ErrorCode::Fatal;
  17712. return -1;
  17713. }
  17714. auto msession = static_cast<impl::MbedTlsSession *>(session);
  17715. // Serve a byte consumed by the is_peer_closed() probe before reading more.
  17716. if (msession->has_peeked_byte) {
  17717. if (len == 0) { return 0; }
  17718. auto p = static_cast<unsigned char *>(buf);
  17719. p[0] = msession->peeked_byte;
  17720. msession->has_peeked_byte = false;
  17721. size_t n = 1;
  17722. // Top up with any already-decrypted bytes without risking a block.
  17723. if (len > 1 && mbedtls_ssl_get_bytes_avail(&msession->ssl) > 0) {
  17724. int extra = mbedtls_ssl_read(&msession->ssl, p + 1, len - 1);
  17725. if (extra > 0) { n += static_cast<size_t>(extra); }
  17726. }
  17727. err.code = ErrorCode::Success;
  17728. return static_cast<ssize_t>(n);
  17729. }
  17730. int ret;
  17731. do {
  17732. ret = mbedtls_ssl_read(&msession->ssl, static_cast<unsigned char *>(buf),
  17733. len);
  17734. } while (impl::mbedtls_is_session_ticket(ret));
  17735. if (ret > 0) {
  17736. err.code = ErrorCode::Success;
  17737. return static_cast<ssize_t>(ret);
  17738. }
  17739. if (ret == 0) {
  17740. err.code = ErrorCode::PeerClosed;
  17741. return 0;
  17742. }
  17743. err.code = impl::map_mbedtls_error(ret, err.sys_errno, 0);
  17744. err.backend_code = static_cast<uint64_t>(-ret);
  17745. impl::mbedtls_last_error() = ret;
  17746. // mbedTLS signals a clean close_notify via a negative error code rather
  17747. // than 0; surface it as a clean EOF the way OpenSSL/wolfSSL do.
  17748. if (err.code == ErrorCode::PeerClosed) { return 0; }
  17749. return -1;
  17750. }
  17751. inline ssize_t write(session_t session, const void *buf, size_t len,
  17752. TlsError &err) {
  17753. if (!session || !buf) {
  17754. err.code = ErrorCode::Fatal;
  17755. return -1;
  17756. }
  17757. auto msession = static_cast<impl::MbedTlsSession *>(session);
  17758. int ret;
  17759. do {
  17760. ret = mbedtls_ssl_write(&msession->ssl,
  17761. static_cast<const unsigned char *>(buf), len);
  17762. } while (impl::mbedtls_is_session_ticket(ret));
  17763. if (ret > 0) {
  17764. err.code = ErrorCode::Success;
  17765. return static_cast<ssize_t>(ret);
  17766. }
  17767. if (ret == 0) {
  17768. err.code = ErrorCode::PeerClosed;
  17769. return 0;
  17770. }
  17771. err.code = impl::map_mbedtls_error(ret, err.sys_errno, 0);
  17772. err.backend_code = static_cast<uint64_t>(-ret);
  17773. impl::mbedtls_last_error() = ret;
  17774. return -1;
  17775. }
  17776. inline int pending(const_session_t session) {
  17777. if (!session) { return 0; }
  17778. auto msession =
  17779. static_cast<impl::MbedTlsSession *>(const_cast<void *>(session));
  17780. return static_cast<int>(mbedtls_ssl_get_bytes_avail(&msession->ssl)) +
  17781. (msession->has_peeked_byte ? 1 : 0);
  17782. }
  17783. inline void shutdown(session_t session, bool graceful) {
  17784. if (!session) { return; }
  17785. auto msession = static_cast<impl::MbedTlsSession *>(session);
  17786. if (graceful) {
  17787. // Try to send close_notify, but don't block forever
  17788. int ret;
  17789. int attempts = 0;
  17790. while ((ret = mbedtls_ssl_close_notify(&msession->ssl)) != 0 &&
  17791. attempts < 3) {
  17792. if (ret != MBEDTLS_ERR_SSL_WANT_READ &&
  17793. ret != MBEDTLS_ERR_SSL_WANT_WRITE) {
  17794. break;
  17795. }
  17796. attempts++;
  17797. }
  17798. }
  17799. }
  17800. inline bool is_peer_closed(session_t session, socket_t sock) {
  17801. if (!session || sock == INVALID_SOCKET) { return true; }
  17802. auto msession = static_cast<impl::MbedTlsSession *>(session);
  17803. // Check if there's already decrypted or pushed-back data available.
  17804. // If so, the connection is definitely alive.
  17805. if (msession->has_peeked_byte ||
  17806. mbedtls_ssl_get_bytes_avail(&msession->ssl) > 0) {
  17807. return false;
  17808. }
  17809. // Set socket to non-blocking to avoid blocking on read
  17810. detail::set_nonblocking(sock, true);
  17811. auto cleanup =
  17812. detail::scope_exit([&]() { detail::set_nonblocking(sock, false); });
  17813. // Probe with a 1-byte read (Mbed TLS has no peek API). If the probe lands
  17814. // on application data — e.g. a response that already arrived — push the
  17815. // byte back so the next read() delivers it instead of losing it.
  17816. unsigned char buf;
  17817. int ret;
  17818. do {
  17819. ret = mbedtls_ssl_read(&msession->ssl, &buf, 1);
  17820. } while (impl::mbedtls_is_session_ticket(ret));
  17821. // If we got data or WANT_READ (would block), connection is alive
  17822. if (ret > 0) {
  17823. msession->peeked_byte = buf;
  17824. msession->has_peeked_byte = true;
  17825. return false;
  17826. }
  17827. if (ret == MBEDTLS_ERR_SSL_WANT_READ) { return false; }
  17828. // If we get a peer close notify or a connection reset, the peer is closed
  17829. return ret == MBEDTLS_ERR_SSL_PEER_CLOSE_NOTIFY ||
  17830. ret == MBEDTLS_ERR_NET_CONN_RESET || ret == 0;
  17831. }
  17832. inline cert_t get_peer_cert(const_session_t session) {
  17833. if (!session) { return nullptr; }
  17834. auto msession =
  17835. static_cast<impl::MbedTlsSession *>(const_cast<void *>(session));
  17836. // Mbed TLS returns a pointer to the internal peer cert chain.
  17837. // WARNING: This pointer is only valid while the session is active.
  17838. // Do not use the certificate after calling free_session().
  17839. const mbedtls_x509_crt *cert = mbedtls_ssl_get_peer_cert(&msession->ssl);
  17840. return const_cast<mbedtls_x509_crt *>(cert);
  17841. }
  17842. inline size_t get_peer_certs(const_session_t session,
  17843. std::vector<cert_t> &certs) {
  17844. certs.clear();
  17845. // Mbed TLS parses the whole received chain into a list headed by the peer
  17846. // certificate, owned by the session like get_peer_cert()'s result
  17847. for (auto crt = static_cast<mbedtls_x509_crt *>(get_peer_cert(session));
  17848. crt && crt->raw.len > 0; crt = crt->next) {
  17849. certs.push_back(static_cast<cert_t>(crt));
  17850. }
  17851. return certs.size();
  17852. }
  17853. inline void free_cert(cert_t cert) {
  17854. // Mbed TLS: peer certificate is owned by the SSL context.
  17855. // No-op here, but callers should still call this for cross-backend
  17856. // portability.
  17857. (void)cert;
  17858. }
  17859. inline bool verify_hostname(cert_t cert, const char *hostname) {
  17860. if (!cert || !hostname) { return false; }
  17861. auto mcert = static_cast<const mbedtls_x509_crt *>(cert);
  17862. std::string host_str(hostname);
  17863. // Check if hostname is an IP address (IPv4 or IPv6)
  17864. unsigned char ip_bytes[16];
  17865. auto ip_len = impl::parse_ip_address(host_str, ip_bytes);
  17866. auto is_ip = ip_len > 0;
  17867. // Check Subject Alternative Names (SAN)
  17868. // In Mbed TLS 3.x, subject_alt_names contains raw values without ASN.1 tags
  17869. // - DNS names: raw string bytes
  17870. // - IP addresses: raw IP bytes (4 for IPv4, 16 for IPv6)
  17871. const mbedtls_x509_sequence *san = &mcert->subject_alt_names;
  17872. while (san != nullptr && san->buf.p != nullptr && san->buf.len > 0) {
  17873. const unsigned char *p = san->buf.p;
  17874. size_t len = san->buf.len;
  17875. if (is_ip) {
  17876. // For an IP host, only a matching iPAddress SAN of the same family
  17877. // (4 bytes for IPv4, 16 bytes for IPv6) may authenticate it.
  17878. if (len == ip_len && memcmp(p, ip_bytes, ip_len) == 0) { return true; }
  17879. } else {
  17880. // Check if this SAN is a DNS name (printable ASCII string)
  17881. bool is_dns = len > 0;
  17882. for (size_t i = 0; i < len && is_dns; i++) {
  17883. if (p[i] < 32 || p[i] > 126) { is_dns = false; }
  17884. }
  17885. if (is_dns) {
  17886. std::string san_name(reinterpret_cast<const char *>(p), len);
  17887. if (detail::match_hostname(san_name, host_str)) { return true; }
  17888. }
  17889. }
  17890. san = san->next;
  17891. }
  17892. // Fallback: Check Common Name (CN) in subject. Skipped for IP-literal hosts:
  17893. // an IP identity is only valid via an iPAddress SAN, never the CN (RFC 9110;
  17894. // the OpenSSL backend's X509_check_ip behaves the same way).
  17895. if (!is_ip) {
  17896. char cn[256];
  17897. int ret = mbedtls_x509_dn_gets(cn, sizeof(cn), &mcert->subject);
  17898. if (ret > 0) {
  17899. std::string cn_str(cn);
  17900. // Look for "CN=" in the DN string
  17901. size_t cn_pos = cn_str.find("CN=");
  17902. if (cn_pos != std::string::npos) {
  17903. size_t start = cn_pos + 3;
  17904. size_t end = cn_str.find(',', start);
  17905. std::string cn_value =
  17906. cn_str.substr(start, end == std::string::npos ? end : end - start);
  17907. if (detail::match_hostname(cn_value, host_str)) { return true; }
  17908. }
  17909. }
  17910. }
  17911. return false;
  17912. }
  17913. inline uint64_t hostname_mismatch_code() {
  17914. return static_cast<uint64_t>(MBEDTLS_X509_BADCERT_CN_MISMATCH);
  17915. }
  17916. inline long get_verify_result(const_session_t session) {
  17917. if (!session) { return -1; }
  17918. auto msession =
  17919. static_cast<impl::MbedTlsSession *>(const_cast<void *>(session));
  17920. uint32_t flags = mbedtls_ssl_get_verify_result(&msession->ssl);
  17921. // Return 0 (X509_V_OK equivalent) if verification passed
  17922. return flags == 0 ? 0 : static_cast<long>(flags);
  17923. }
  17924. inline std::string get_cert_subject_cn(cert_t cert) {
  17925. if (!cert) return "";
  17926. auto x509 = static_cast<mbedtls_x509_crt *>(cert);
  17927. // Find the CN in the subject
  17928. const mbedtls_x509_name *name = &x509->subject;
  17929. while (name != nullptr) {
  17930. if (MBEDTLS_OID_CMP(MBEDTLS_OID_AT_CN, &name->oid) == 0) {
  17931. return std::string(reinterpret_cast<const char *>(name->val.p),
  17932. name->val.len);
  17933. }
  17934. name = name->next;
  17935. }
  17936. return "";
  17937. }
  17938. inline std::string get_cert_issuer_name(cert_t cert) {
  17939. if (!cert) return "";
  17940. auto x509 = static_cast<mbedtls_x509_crt *>(cert);
  17941. // Build a human-readable issuer name string
  17942. char buf[512];
  17943. int ret = mbedtls_x509_dn_gets(buf, sizeof(buf), &x509->issuer);
  17944. if (ret < 0) return "";
  17945. return std::string(buf);
  17946. }
  17947. inline bool get_cert_sans(cert_t cert, std::vector<SanEntry> &sans) {
  17948. sans.clear();
  17949. if (!cert) return false;
  17950. auto x509 = static_cast<mbedtls_x509_crt *>(cert);
  17951. // Parse the Subject Alternative Name extension
  17952. const mbedtls_x509_sequence *cur = &x509->subject_alt_names;
  17953. while (cur != nullptr) {
  17954. if (cur->buf.len > 0) {
  17955. // Mbed TLS stores SAN as ASN.1 sequences
  17956. // The tag byte indicates the type
  17957. const unsigned char *p = cur->buf.p;
  17958. size_t len = cur->buf.len;
  17959. // First byte is the tag
  17960. unsigned char tag = *p;
  17961. p++;
  17962. len--;
  17963. // Parse length (simple single-byte length assumed)
  17964. if (len > 0 && *p < 0x80) {
  17965. size_t value_len = *p;
  17966. p++;
  17967. len--;
  17968. if (value_len <= len) {
  17969. SanEntry entry;
  17970. // ASN.1 context tags for GeneralName
  17971. switch (tag & 0x1F) {
  17972. case 2: // dNSName
  17973. entry.type = SanType::DNS;
  17974. entry.value =
  17975. std::string(reinterpret_cast<const char *>(p), value_len);
  17976. break;
  17977. case 7: // iPAddress
  17978. entry.type = SanType::IP;
  17979. if (value_len == 4) {
  17980. // IPv4
  17981. char buf[16];
  17982. snprintf(buf, sizeof(buf), "%d.%d.%d.%d", p[0], p[1], p[2], p[3]);
  17983. entry.value = buf;
  17984. } else if (value_len == 16) {
  17985. // IPv6
  17986. char buf[64];
  17987. snprintf(buf, sizeof(buf),
  17988. "%02x%02x:%02x%02x:%02x%02x:%02x%02x:"
  17989. "%02x%02x:%02x%02x:%02x%02x:%02x%02x",
  17990. p[0], p[1], p[2], p[3], p[4], p[5], p[6], p[7], p[8],
  17991. p[9], p[10], p[11], p[12], p[13], p[14], p[15]);
  17992. entry.value = buf;
  17993. }
  17994. break;
  17995. case 1: // rfc822Name (email)
  17996. entry.type = SanType::EMAIL;
  17997. entry.value =
  17998. std::string(reinterpret_cast<const char *>(p), value_len);
  17999. break;
  18000. case 6: // uniformResourceIdentifier
  18001. entry.type = SanType::URI;
  18002. entry.value =
  18003. std::string(reinterpret_cast<const char *>(p), value_len);
  18004. break;
  18005. default: entry.type = SanType::OTHER; break;
  18006. }
  18007. if (!entry.value.empty()) { sans.push_back(std::move(entry)); }
  18008. }
  18009. }
  18010. }
  18011. cur = cur->next;
  18012. }
  18013. return true;
  18014. }
  18015. inline bool get_cert_validity(cert_t cert, time_t &not_before,
  18016. time_t &not_after) {
  18017. if (!cert) return false;
  18018. auto x509 = static_cast<mbedtls_x509_crt *>(cert);
  18019. // Convert mbedtls_x509_time to time_t
  18020. auto to_time_t = [](const mbedtls_x509_time &t) -> time_t {
  18021. struct tm tm_time = {};
  18022. tm_time.tm_year = t.year - 1900;
  18023. tm_time.tm_mon = t.mon - 1;
  18024. tm_time.tm_mday = t.day;
  18025. tm_time.tm_hour = t.hour;
  18026. tm_time.tm_min = t.min;
  18027. tm_time.tm_sec = t.sec;
  18028. #ifdef _WIN32
  18029. return _mkgmtime(&tm_time);
  18030. #else
  18031. return timegm(&tm_time);
  18032. #endif
  18033. };
  18034. not_before = to_time_t(x509->valid_from);
  18035. not_after = to_time_t(x509->valid_to);
  18036. return true;
  18037. }
  18038. inline std::string get_cert_serial(cert_t cert) {
  18039. if (!cert) return "";
  18040. auto x509 = static_cast<mbedtls_x509_crt *>(cert);
  18041. // Convert serial number to hex string
  18042. std::string result;
  18043. result.reserve(x509->serial.len * 2);
  18044. for (size_t i = 0; i < x509->serial.len; i++) {
  18045. char hex[3];
  18046. snprintf(hex, sizeof(hex), "%02X", x509->serial.p[i]);
  18047. result += hex;
  18048. }
  18049. return result;
  18050. }
  18051. inline bool get_cert_der(cert_t cert, std::vector<unsigned char> &der) {
  18052. if (!cert) return false;
  18053. auto crt = static_cast<mbedtls_x509_crt *>(cert);
  18054. if (!crt->raw.p || crt->raw.len == 0) return false;
  18055. der.assign(crt->raw.p, crt->raw.p + crt->raw.len);
  18056. return true;
  18057. }
  18058. inline const char *get_sni(const_session_t session) {
  18059. if (!session) return nullptr;
  18060. auto msession = static_cast<const impl::MbedTlsSession *>(session);
  18061. // For server: return SNI received from client during handshake
  18062. if (!msession->sni_hostname.empty()) {
  18063. return msession->sni_hostname.c_str();
  18064. }
  18065. // For client: return the hostname set via set_sni
  18066. if (!msession->hostname.empty()) { return msession->hostname.c_str(); }
  18067. return nullptr;
  18068. }
  18069. inline uint64_t peek_error() {
  18070. // Mbed TLS doesn't have an error queue, return the last error
  18071. return static_cast<uint64_t>(-impl::mbedtls_last_error());
  18072. }
  18073. inline uint64_t get_error() {
  18074. // Mbed TLS doesn't have an error queue, return and clear the last error
  18075. uint64_t err = static_cast<uint64_t>(-impl::mbedtls_last_error());
  18076. impl::mbedtls_last_error() = 0;
  18077. return err;
  18078. }
  18079. inline std::string error_string(uint64_t code) {
  18080. char buf[256];
  18081. mbedtls_strerror(-static_cast<int>(code), buf, sizeof(buf));
  18082. return std::string(buf);
  18083. }
  18084. inline ca_store_t create_ca_store(const char *pem, size_t len) {
  18085. auto *ca_chain = new (std::nothrow) mbedtls_x509_crt;
  18086. if (!ca_chain) { return nullptr; }
  18087. mbedtls_x509_crt_init(ca_chain);
  18088. // mbedtls_x509_crt_parse expects null-terminated PEM
  18089. int ret = mbedtls_x509_crt_parse(ca_chain,
  18090. reinterpret_cast<const unsigned char *>(pem),
  18091. len + 1); // +1 for null terminator
  18092. if (ret != 0) {
  18093. // Try without +1 in case PEM is already null-terminated
  18094. ret = mbedtls_x509_crt_parse(
  18095. ca_chain, reinterpret_cast<const unsigned char *>(pem), len);
  18096. if (ret != 0) {
  18097. mbedtls_x509_crt_free(ca_chain);
  18098. delete ca_chain;
  18099. return nullptr;
  18100. }
  18101. }
  18102. return static_cast<ca_store_t>(ca_chain);
  18103. }
  18104. inline void free_ca_store(ca_store_t store) {
  18105. if (store) {
  18106. auto *ca_chain = static_cast<mbedtls_x509_crt *>(store);
  18107. mbedtls_x509_crt_free(ca_chain);
  18108. delete ca_chain;
  18109. }
  18110. }
  18111. inline bool set_ca_store(ctx_t ctx, ca_store_t store) {
  18112. if (!ctx || !store) { return false; }
  18113. auto *mbed_ctx = static_cast<impl::MbedTlsContext *>(ctx);
  18114. auto *ca_chain = static_cast<mbedtls_x509_crt *>(store);
  18115. // Free existing CA chain
  18116. mbedtls_x509_crt_free(&mbed_ctx->ca_chain);
  18117. mbedtls_x509_crt_init(&mbed_ctx->ca_chain);
  18118. // Copy the CA chain (deep copy)
  18119. // Parse from the raw data of the source cert
  18120. mbedtls_x509_crt *src = ca_chain;
  18121. while (src != nullptr) {
  18122. int ret = mbedtls_x509_crt_parse_der(&mbed_ctx->ca_chain, src->raw.p,
  18123. src->raw.len);
  18124. if (ret != 0) {
  18125. free_ca_store(store);
  18126. return false;
  18127. }
  18128. src = src->next;
  18129. }
  18130. // This function takes ownership of the store; the chain was deep-copied
  18131. // above, so release the source
  18132. free_ca_store(store);
  18133. // Update the SSL config to use the new CA chain
  18134. mbedtls_ssl_conf_ca_chain(&mbed_ctx->conf, &mbed_ctx->ca_chain, nullptr);
  18135. return true;
  18136. }
  18137. inline size_t get_ca_certs(ctx_t ctx, std::vector<cert_t> &certs) {
  18138. certs.clear();
  18139. if (!ctx) { return 0; }
  18140. auto *mbed_ctx = static_cast<impl::MbedTlsContext *>(ctx);
  18141. // Iterate through the CA chain
  18142. mbedtls_x509_crt *cert = &mbed_ctx->ca_chain;
  18143. while (cert != nullptr && cert->raw.len > 0) {
  18144. // Create a copy of the certificate for the caller
  18145. auto *copy = new mbedtls_x509_crt;
  18146. mbedtls_x509_crt_init(copy);
  18147. int ret = mbedtls_x509_crt_parse_der(copy, cert->raw.p, cert->raw.len);
  18148. if (ret == 0) {
  18149. certs.push_back(static_cast<cert_t>(copy));
  18150. } else {
  18151. mbedtls_x509_crt_free(copy);
  18152. delete copy;
  18153. }
  18154. cert = cert->next;
  18155. }
  18156. return certs.size();
  18157. }
  18158. inline std::vector<std::string> get_ca_names(ctx_t ctx) {
  18159. std::vector<std::string> names;
  18160. if (!ctx) { return names; }
  18161. auto *mbed_ctx = static_cast<impl::MbedTlsContext *>(ctx);
  18162. // Iterate through the CA chain
  18163. mbedtls_x509_crt *cert = &mbed_ctx->ca_chain;
  18164. while (cert != nullptr && cert->raw.len > 0) {
  18165. char buf[512];
  18166. int ret = mbedtls_x509_dn_gets(buf, sizeof(buf), &cert->subject);
  18167. if (ret > 0) { names.push_back(buf); }
  18168. cert = cert->next;
  18169. }
  18170. return names;
  18171. }
  18172. inline bool update_server_cert(ctx_t ctx, const char *cert_pem,
  18173. const char *key_pem, const char *password) {
  18174. if (!ctx || !cert_pem || !key_pem) { return false; }
  18175. auto *mbed_ctx = static_cast<impl::MbedTlsContext *>(ctx);
  18176. // Free existing certificate and key
  18177. mbedtls_x509_crt_free(&mbed_ctx->own_cert);
  18178. mbedtls_pk_free(&mbed_ctx->own_key);
  18179. mbedtls_x509_crt_init(&mbed_ctx->own_cert);
  18180. mbedtls_pk_init(&mbed_ctx->own_key);
  18181. // Parse certificate PEM
  18182. int ret = mbedtls_x509_crt_parse(
  18183. &mbed_ctx->own_cert, reinterpret_cast<const unsigned char *>(cert_pem),
  18184. strlen(cert_pem) + 1);
  18185. if (ret != 0) {
  18186. impl::mbedtls_last_error() = ret;
  18187. return false;
  18188. }
  18189. // Parse private key PEM
  18190. #if defined(CPPHTTPLIB_MBEDTLS_V3) && !defined(CPPHTTPLIB_MBEDTLS_V4)
  18191. ret = mbedtls_pk_parse_key(
  18192. &mbed_ctx->own_key, reinterpret_cast<const unsigned char *>(key_pem),
  18193. strlen(key_pem) + 1,
  18194. password ? reinterpret_cast<const unsigned char *>(password) : nullptr,
  18195. password ? strlen(password) : 0, mbedtls_ctr_drbg_random,
  18196. &mbed_ctx->ctr_drbg);
  18197. #else
  18198. ret = mbedtls_pk_parse_key(
  18199. &mbed_ctx->own_key, reinterpret_cast<const unsigned char *>(key_pem),
  18200. strlen(key_pem) + 1,
  18201. password ? reinterpret_cast<const unsigned char *>(password) : nullptr,
  18202. password ? strlen(password) : 0);
  18203. #endif
  18204. if (ret != 0) {
  18205. impl::mbedtls_last_error() = ret;
  18206. return false;
  18207. }
  18208. // Configure SSL to use the new certificate and key
  18209. ret = mbedtls_ssl_conf_own_cert(&mbed_ctx->conf, &mbed_ctx->own_cert,
  18210. &mbed_ctx->own_key);
  18211. if (ret != 0) {
  18212. impl::mbedtls_last_error() = ret;
  18213. return false;
  18214. }
  18215. return true;
  18216. }
  18217. inline bool update_server_client_ca(ctx_t ctx, const char *ca_pem) {
  18218. if (!ctx || !ca_pem) { return false; }
  18219. auto *mbed_ctx = static_cast<impl::MbedTlsContext *>(ctx);
  18220. // Free existing CA chain
  18221. mbedtls_x509_crt_free(&mbed_ctx->ca_chain);
  18222. mbedtls_x509_crt_init(&mbed_ctx->ca_chain);
  18223. // Parse CA PEM
  18224. int ret = mbedtls_x509_crt_parse(
  18225. &mbed_ctx->ca_chain, reinterpret_cast<const unsigned char *>(ca_pem),
  18226. strlen(ca_pem) + 1);
  18227. if (ret != 0) {
  18228. impl::mbedtls_last_error() = ret;
  18229. return false;
  18230. }
  18231. // Update SSL config to use new CA chain
  18232. mbedtls_ssl_conf_ca_chain(&mbed_ctx->conf, &mbed_ctx->ca_chain, nullptr);
  18233. return true;
  18234. }
  18235. inline bool set_verify_callback(ctx_t ctx, VerifyCallback callback) {
  18236. if (!ctx) { return false; }
  18237. auto *mbed_ctx = static_cast<impl::MbedTlsContext *>(ctx);
  18238. impl::get_verify_callback() = std::move(callback);
  18239. mbed_ctx->has_verify_callback =
  18240. static_cast<bool>(impl::get_verify_callback());
  18241. if (mbed_ctx->has_verify_callback) {
  18242. // Set OPTIONAL mode to ensure callback is called even when verification
  18243. // is disabled (matching OpenSSL behavior where SSL_VERIFY_PEER is set)
  18244. mbedtls_ssl_conf_authmode(&mbed_ctx->conf, MBEDTLS_SSL_VERIFY_OPTIONAL);
  18245. mbedtls_ssl_conf_verify(&mbed_ctx->conf, impl::mbedtls_verify_callback,
  18246. nullptr);
  18247. } else {
  18248. mbedtls_ssl_conf_verify(&mbed_ctx->conf, nullptr, nullptr);
  18249. }
  18250. return true;
  18251. }
  18252. inline long get_verify_error(const_session_t session) {
  18253. if (!session) { return -1; }
  18254. auto *msession =
  18255. static_cast<impl::MbedTlsSession *>(const_cast<void *>(session));
  18256. return static_cast<long>(mbedtls_ssl_get_verify_result(&msession->ssl));
  18257. }
  18258. inline std::string verify_error_string(long error_code) {
  18259. if (error_code == 0) { return ""; }
  18260. char buf[256];
  18261. mbedtls_x509_crt_verify_info(buf, sizeof(buf), "",
  18262. static_cast<uint32_t>(error_code));
  18263. // Remove trailing newline if present
  18264. std::string result(buf);
  18265. while (!result.empty() && (result.back() == '\n' || result.back() == ' ')) {
  18266. result.pop_back();
  18267. }
  18268. return result;
  18269. }
  18270. } // namespace tls
  18271. #endif // CPPHTTPLIB_MBEDTLS_SUPPORT
  18272. /*
  18273. * Group 10: TLS abstraction layer - wolfSSL backend
  18274. */
  18275. /*
  18276. * wolfSSL Backend Implementation
  18277. */
  18278. #ifdef CPPHTTPLIB_WOLFSSL_SUPPORT
  18279. namespace tls {
  18280. namespace impl {
  18281. // wolfSSL session wrapper
  18282. struct WolfSSLSession {
  18283. WOLFSSL *ssl = nullptr;
  18284. socket_t sock = INVALID_SOCKET;
  18285. std::string hostname; // For client: set via set_sni
  18286. std::string sni_hostname; // For server: received from client via SNI callback
  18287. WolfSSLSession() = default;
  18288. ~WolfSSLSession() {
  18289. if (ssl) { wolfSSL_free(ssl); }
  18290. }
  18291. WolfSSLSession(const WolfSSLSession &) = delete;
  18292. WolfSSLSession &operator=(const WolfSSLSession &) = delete;
  18293. };
  18294. // Thread-local error code accessor for wolfSSL
  18295. inline uint64_t &wolfssl_last_error() {
  18296. static thread_local uint64_t err = 0;
  18297. return err;
  18298. }
  18299. // Helper to map wolfSSL error to ErrorCode.
  18300. // ssl_error is the value from wolfSSL_get_error().
  18301. // raw_ret is the raw return value from the wolfSSL call (for low-level error).
  18302. inline ErrorCode map_wolfssl_error(WOLFSSL *ssl, int ssl_error,
  18303. int &out_errno) {
  18304. switch (ssl_error) {
  18305. case SSL_ERROR_NONE: return ErrorCode::Success;
  18306. case SSL_ERROR_WANT_READ: return ErrorCode::WantRead;
  18307. case SSL_ERROR_WANT_WRITE: return ErrorCode::WantWrite;
  18308. case SSL_ERROR_ZERO_RETURN: return ErrorCode::PeerClosed;
  18309. case SSL_ERROR_SYSCALL: out_errno = errno; return ErrorCode::SyscallError;
  18310. default:
  18311. if (ssl) {
  18312. // wolfSSL stores the low-level error code as a negative value.
  18313. // DOMAIN_NAME_MISMATCH (-322) indicates hostname verification failure.
  18314. int low_err = ssl_error; // wolfSSL_get_error returns the low-level code
  18315. if (low_err == DOMAIN_NAME_MISMATCH) {
  18316. return ErrorCode::HostnameMismatch;
  18317. }
  18318. // Check verify result to distinguish cert verification from generic SSL
  18319. // errors.
  18320. long vr = wolfSSL_get_verify_result(ssl);
  18321. if (vr != 0) { return ErrorCode::CertVerifyFailed; }
  18322. }
  18323. return ErrorCode::Fatal;
  18324. }
  18325. }
  18326. // WolfSSLContext constructor/destructor implementations
  18327. inline WolfSSLContext::WolfSSLContext() { wolfSSL_Init(); }
  18328. inline WolfSSLContext::~WolfSSLContext() {
  18329. if (ctx) { wolfSSL_CTX_free(ctx); }
  18330. }
  18331. // Thread-local storage for SNI captured during handshake
  18332. inline std::string &wolfssl_pending_sni() {
  18333. static thread_local std::string sni;
  18334. return sni;
  18335. }
  18336. // SNI callback for wolfSSL server to capture client's SNI hostname
  18337. inline int wolfssl_sni_callback(WOLFSSL *ssl, int *ret, void *exArg) {
  18338. (void)ret;
  18339. (void)exArg;
  18340. void *name_data = nullptr;
  18341. unsigned short name_len =
  18342. wolfSSL_SNI_GetRequest(ssl, WOLFSSL_SNI_HOST_NAME, &name_data);
  18343. if (name_data && name_len > 0) {
  18344. wolfssl_pending_sni().assign(static_cast<const char *>(name_data),
  18345. name_len);
  18346. } else {
  18347. wolfssl_pending_sni().clear();
  18348. }
  18349. return 0; // Continue regardless
  18350. }
  18351. // wolfSSL verify callback wrapper
  18352. inline int wolfssl_verify_callback(int preverify_ok,
  18353. WOLFSSL_X509_STORE_CTX *x509_ctx) {
  18354. auto &callback = get_verify_callback();
  18355. if (!callback) { return preverify_ok; }
  18356. WOLFSSL_X509 *cert = wolfSSL_X509_STORE_CTX_get_current_cert(x509_ctx);
  18357. int depth = wolfSSL_X509_STORE_CTX_get_error_depth(x509_ctx);
  18358. int err = wolfSSL_X509_STORE_CTX_get_error(x509_ctx);
  18359. // Get the WOLFSSL object from the X509_STORE_CTX
  18360. WOLFSSL *ssl = static_cast<WOLFSSL *>(wolfSSL_X509_STORE_CTX_get_ex_data(
  18361. x509_ctx, wolfSSL_get_ex_data_X509_STORE_CTX_idx()));
  18362. VerifyContext verify_ctx;
  18363. verify_ctx.session = static_cast<session_t>(ssl);
  18364. verify_ctx.cert = static_cast<cert_t>(cert);
  18365. verify_ctx.depth = depth;
  18366. verify_ctx.preverify_ok = (preverify_ok != 0);
  18367. verify_ctx.error_code = static_cast<long>(err);
  18368. if (err != 0) {
  18369. verify_ctx.error_string = wolfSSL_X509_verify_cert_error_string(err);
  18370. } else {
  18371. verify_ctx.error_string = nullptr;
  18372. }
  18373. bool accepted = callback(verify_ctx);
  18374. return accepted ? 1 : 0;
  18375. }
  18376. inline void set_wolfssl_password_cb(WOLFSSL_CTX *ctx, const char *password) {
  18377. wolfSSL_CTX_set_default_passwd_cb_userdata(ctx, const_cast<char *>(password));
  18378. wolfSSL_CTX_set_default_passwd_cb(
  18379. ctx, [](char *buf, int size, int /*rwflag*/, void *userdata) -> int {
  18380. auto *pwd = static_cast<const char *>(userdata);
  18381. if (!pwd) return 0;
  18382. auto len = static_cast<int>(strlen(pwd));
  18383. if (len > size) len = size;
  18384. memcpy(buf, pwd, static_cast<size_t>(len));
  18385. return len;
  18386. });
  18387. }
  18388. } // namespace impl
  18389. inline ctx_t create_client_context() {
  18390. auto ctx = new (std::nothrow) impl::WolfSSLContext();
  18391. if (!ctx) { return nullptr; }
  18392. ctx->is_server = false;
  18393. WOLFSSL_METHOD *method = wolfTLSv1_2_client_method();
  18394. if (!method) {
  18395. delete ctx;
  18396. return nullptr;
  18397. }
  18398. ctx->ctx = wolfSSL_CTX_new(method);
  18399. if (!ctx->ctx) {
  18400. delete ctx;
  18401. return nullptr;
  18402. }
  18403. // Default: verify peer certificate
  18404. wolfSSL_CTX_set_verify(ctx->ctx, SSL_VERIFY_PEER, nullptr);
  18405. return static_cast<ctx_t>(ctx);
  18406. }
  18407. inline ctx_t create_server_context() {
  18408. auto ctx = new (std::nothrow) impl::WolfSSLContext();
  18409. if (!ctx) { return nullptr; }
  18410. ctx->is_server = true;
  18411. WOLFSSL_METHOD *method = wolfTLSv1_2_server_method();
  18412. if (!method) {
  18413. delete ctx;
  18414. return nullptr;
  18415. }
  18416. ctx->ctx = wolfSSL_CTX_new(method);
  18417. if (!ctx->ctx) {
  18418. delete ctx;
  18419. return nullptr;
  18420. }
  18421. // Default: don't verify client
  18422. wolfSSL_CTX_set_verify(ctx->ctx, SSL_VERIFY_NONE, nullptr);
  18423. // Enable SNI on server
  18424. wolfSSL_CTX_SNI_SetOptions(ctx->ctx, WOLFSSL_SNI_HOST_NAME,
  18425. WOLFSSL_SNI_CONTINUE_ON_MISMATCH);
  18426. wolfSSL_CTX_set_servername_callback(ctx->ctx, impl::wolfssl_sni_callback);
  18427. return static_cast<ctx_t>(ctx);
  18428. }
  18429. inline void free_context(ctx_t ctx) {
  18430. if (ctx) { delete static_cast<impl::WolfSSLContext *>(ctx); }
  18431. }
  18432. inline bool set_min_version(ctx_t ctx, Version version) {
  18433. if (!ctx) { return false; }
  18434. auto wctx = static_cast<impl::WolfSSLContext *>(ctx);
  18435. int min_ver = WOLFSSL_TLSV1_2;
  18436. if (version >= Version::TLS1_3) { min_ver = WOLFSSL_TLSV1_3; }
  18437. return wolfSSL_CTX_SetMinVersion(wctx->ctx, min_ver) == WOLFSSL_SUCCESS;
  18438. }
  18439. inline bool load_ca_pem(ctx_t ctx, const char *pem, size_t len) {
  18440. if (!ctx || !pem) { return false; }
  18441. auto wctx = static_cast<impl::WolfSSLContext *>(ctx);
  18442. int ret = wolfSSL_CTX_load_verify_buffer(
  18443. wctx->ctx, reinterpret_cast<const unsigned char *>(pem),
  18444. static_cast<long>(len), SSL_FILETYPE_PEM);
  18445. if (ret != SSL_SUCCESS) {
  18446. impl::wolfssl_last_error() =
  18447. static_cast<uint64_t>(wolfSSL_ERR_peek_last_error());
  18448. return false;
  18449. }
  18450. wctx->ca_pem_data_.append(pem, len);
  18451. return true;
  18452. }
  18453. inline bool load_ca_file(ctx_t ctx, const char *file_path) {
  18454. if (!ctx || !file_path) { return false; }
  18455. auto wctx = static_cast<impl::WolfSSLContext *>(ctx);
  18456. int ret = wolfSSL_CTX_load_verify_locations(wctx->ctx, file_path, nullptr);
  18457. if (ret != SSL_SUCCESS) {
  18458. impl::wolfssl_last_error() =
  18459. static_cast<uint64_t>(wolfSSL_ERR_peek_last_error());
  18460. return false;
  18461. }
  18462. return true;
  18463. }
  18464. inline bool load_ca_dir(ctx_t ctx, const char *dir_path) {
  18465. if (!ctx || !dir_path) { return false; }
  18466. auto wctx = static_cast<impl::WolfSSLContext *>(ctx);
  18467. int ret = wolfSSL_CTX_load_verify_locations(wctx->ctx, nullptr, dir_path);
  18468. // wolfSSL may fail if the directory doesn't contain properly hashed certs.
  18469. // Unlike OpenSSL which lazily loads certs from directories, wolfSSL scans
  18470. // immediately. Return true even on failure since the CA file may have
  18471. // already been loaded, matching OpenSSL's lenient behavior.
  18472. (void)ret;
  18473. return true;
  18474. }
  18475. inline bool load_system_certs(ctx_t ctx) {
  18476. if (!ctx) { return false; }
  18477. auto wctx = static_cast<impl::WolfSSLContext *>(ctx);
  18478. bool loaded = false;
  18479. #ifdef _WIN32
  18480. loaded = impl::enumerate_windows_system_certs(
  18481. [&](const unsigned char *data, size_t len) {
  18482. return wolfSSL_CTX_load_verify_buffer(wctx->ctx, data,
  18483. static_cast<long>(len),
  18484. SSL_FILETYPE_ASN1) == SSL_SUCCESS;
  18485. });
  18486. #elif defined(__APPLE__) && defined(CPPHTTPLIB_USE_CERTS_FROM_MACOSX_KEYCHAIN)
  18487. loaded = impl::enumerate_macos_keychain_certs(
  18488. [&](const unsigned char *data, size_t len) {
  18489. return wolfSSL_CTX_load_verify_buffer(wctx->ctx, data,
  18490. static_cast<long>(len),
  18491. SSL_FILETYPE_ASN1) == SSL_SUCCESS;
  18492. });
  18493. #else
  18494. for (auto path = impl::system_ca_paths(); *path; ++path) {
  18495. if (wolfSSL_CTX_load_verify_locations(wctx->ctx, *path, nullptr) ==
  18496. SSL_SUCCESS) {
  18497. loaded = true;
  18498. break;
  18499. }
  18500. }
  18501. if (!loaded) {
  18502. for (auto dir = impl::system_ca_dirs(); *dir; ++dir) {
  18503. if (wolfSSL_CTX_load_verify_locations(wctx->ctx, nullptr, *dir) ==
  18504. SSL_SUCCESS) {
  18505. loaded = true;
  18506. break;
  18507. }
  18508. }
  18509. }
  18510. #endif
  18511. return loaded;
  18512. }
  18513. inline bool set_client_cert_pem(ctx_t ctx, const char *cert, const char *key,
  18514. const char *password) {
  18515. if (!ctx || !cert || !key) { return false; }
  18516. auto wctx = static_cast<impl::WolfSSLContext *>(ctx);
  18517. // Load certificate
  18518. int ret = wolfSSL_CTX_use_certificate_buffer(
  18519. wctx->ctx, reinterpret_cast<const unsigned char *>(cert),
  18520. static_cast<long>(strlen(cert)), SSL_FILETYPE_PEM);
  18521. if (ret != SSL_SUCCESS) {
  18522. impl::wolfssl_last_error() =
  18523. static_cast<uint64_t>(wolfSSL_ERR_peek_last_error());
  18524. return false;
  18525. }
  18526. // Set password callback if password is provided
  18527. if (password) { impl::set_wolfssl_password_cb(wctx->ctx, password); }
  18528. // Load private key
  18529. ret = wolfSSL_CTX_use_PrivateKey_buffer(
  18530. wctx->ctx, reinterpret_cast<const unsigned char *>(key),
  18531. static_cast<long>(strlen(key)), SSL_FILETYPE_PEM);
  18532. if (ret != SSL_SUCCESS) {
  18533. impl::wolfssl_last_error() =
  18534. static_cast<uint64_t>(wolfSSL_ERR_peek_last_error());
  18535. return false;
  18536. }
  18537. // Verify that the certificate and private key match
  18538. return wolfSSL_CTX_check_private_key(wctx->ctx) == SSL_SUCCESS;
  18539. }
  18540. inline bool set_client_cert_file(ctx_t ctx, const char *cert_path,
  18541. const char *key_path, const char *password) {
  18542. if (!ctx || !cert_path || !key_path) { return false; }
  18543. auto wctx = static_cast<impl::WolfSSLContext *>(ctx);
  18544. // Load certificate file
  18545. int ret =
  18546. wolfSSL_CTX_use_certificate_file(wctx->ctx, cert_path, SSL_FILETYPE_PEM);
  18547. if (ret != SSL_SUCCESS) {
  18548. impl::wolfssl_last_error() =
  18549. static_cast<uint64_t>(wolfSSL_ERR_peek_last_error());
  18550. return false;
  18551. }
  18552. // Set password callback if password is provided
  18553. if (password) { impl::set_wolfssl_password_cb(wctx->ctx, password); }
  18554. // Load private key file
  18555. ret = wolfSSL_CTX_use_PrivateKey_file(wctx->ctx, key_path, SSL_FILETYPE_PEM);
  18556. if (ret != SSL_SUCCESS) {
  18557. impl::wolfssl_last_error() =
  18558. static_cast<uint64_t>(wolfSSL_ERR_peek_last_error());
  18559. return false;
  18560. }
  18561. // Verify that the certificate and private key match
  18562. return wolfSSL_CTX_check_private_key(wctx->ctx) == SSL_SUCCESS;
  18563. }
  18564. inline void set_verify_client(ctx_t ctx, bool require) {
  18565. if (!ctx) { return; }
  18566. auto wctx = static_cast<impl::WolfSSLContext *>(ctx);
  18567. wctx->verify_client = require;
  18568. if (require) {
  18569. wolfSSL_CTX_set_verify(
  18570. wctx->ctx, SSL_VERIFY_PEER | SSL_VERIFY_FAIL_IF_NO_PEER_CERT,
  18571. wctx->has_verify_callback ? impl::wolfssl_verify_callback : nullptr);
  18572. } else {
  18573. if (wctx->has_verify_callback) {
  18574. wolfSSL_CTX_set_verify(wctx->ctx, SSL_VERIFY_PEER,
  18575. impl::wolfssl_verify_callback);
  18576. } else {
  18577. wolfSSL_CTX_set_verify(wctx->ctx, SSL_VERIFY_NONE, nullptr);
  18578. }
  18579. }
  18580. }
  18581. inline session_t create_session(ctx_t ctx, socket_t sock) {
  18582. if (!ctx || sock == INVALID_SOCKET) { return nullptr; }
  18583. auto wctx = static_cast<impl::WolfSSLContext *>(ctx);
  18584. auto session = new (std::nothrow) impl::WolfSSLSession();
  18585. if (!session) { return nullptr; }
  18586. session->sock = sock;
  18587. session->ssl = wolfSSL_new(wctx->ctx);
  18588. if (!session->ssl) {
  18589. impl::wolfssl_last_error() =
  18590. static_cast<uint64_t>(wolfSSL_ERR_peek_last_error());
  18591. delete session;
  18592. return nullptr;
  18593. }
  18594. wolfSSL_set_fd(session->ssl, static_cast<int>(sock));
  18595. return static_cast<session_t>(session);
  18596. }
  18597. inline void free_session(session_t session) {
  18598. if (session) { delete static_cast<impl::WolfSSLSession *>(session); }
  18599. }
  18600. inline bool set_sni(session_t session, const char *hostname,
  18601. bool verify_hostname) {
  18602. if (!session || !hostname) { return false; }
  18603. auto wsession = static_cast<impl::WolfSSLSession *>(session);
  18604. int ret = wolfSSL_UseSNI(wsession->ssl, WOLFSSL_SNI_HOST_NAME, hostname,
  18605. static_cast<word16>(strlen(hostname)));
  18606. if (ret != WOLFSSL_SUCCESS) {
  18607. impl::wolfssl_last_error() =
  18608. static_cast<uint64_t>(wolfSSL_ERR_peek_last_error());
  18609. return false;
  18610. }
  18611. // wolfSSL_check_domain_name binds identity checking to the handshake,
  18612. // separately from the SNI extension sent above; skip it when hostname
  18613. // verification is disabled so only the chain is checked, matching OpenSSL.
  18614. if (verify_hostname) { wolfSSL_check_domain_name(wsession->ssl, hostname); }
  18615. wsession->hostname = hostname;
  18616. return true;
  18617. }
  18618. inline TlsError connect(session_t session) {
  18619. TlsError err;
  18620. if (!session) {
  18621. err.code = ErrorCode::Fatal;
  18622. return err;
  18623. }
  18624. auto wsession = static_cast<impl::WolfSSLSession *>(session);
  18625. int ret = wolfSSL_connect(wsession->ssl);
  18626. if (ret == SSL_SUCCESS) {
  18627. err.code = ErrorCode::Success;
  18628. } else {
  18629. int ssl_error = wolfSSL_get_error(wsession->ssl, ret);
  18630. err.code = impl::map_wolfssl_error(wsession->ssl, ssl_error, err.sys_errno);
  18631. err.backend_code = static_cast<uint64_t>(ssl_error);
  18632. impl::wolfssl_last_error() = err.backend_code;
  18633. }
  18634. return err;
  18635. }
  18636. inline TlsError accept(session_t session) {
  18637. TlsError err;
  18638. if (!session) {
  18639. err.code = ErrorCode::Fatal;
  18640. return err;
  18641. }
  18642. auto wsession = static_cast<impl::WolfSSLSession *>(session);
  18643. int ret = wolfSSL_accept(wsession->ssl);
  18644. if (ret == SSL_SUCCESS) {
  18645. err.code = ErrorCode::Success;
  18646. // Capture SNI from thread-local storage after successful handshake
  18647. wsession->sni_hostname = std::move(impl::wolfssl_pending_sni());
  18648. impl::wolfssl_pending_sni().clear();
  18649. } else {
  18650. int ssl_error = wolfSSL_get_error(wsession->ssl, ret);
  18651. err.code = impl::map_wolfssl_error(wsession->ssl, ssl_error, err.sys_errno);
  18652. err.backend_code = static_cast<uint64_t>(ssl_error);
  18653. impl::wolfssl_last_error() = err.backend_code;
  18654. }
  18655. return err;
  18656. }
  18657. inline bool connect_nonblocking(session_t session, socket_t sock,
  18658. time_t timeout_sec, time_t timeout_usec,
  18659. TlsError *err) {
  18660. if (!session) {
  18661. if (err) { err->code = ErrorCode::Fatal; }
  18662. return false;
  18663. }
  18664. auto wsession = static_cast<impl::WolfSSLSession *>(session);
  18665. // Set socket to non-blocking mode
  18666. detail::set_nonblocking(sock, true);
  18667. auto cleanup =
  18668. detail::scope_exit([&]() { detail::set_nonblocking(sock, false); });
  18669. int ret;
  18670. while ((ret = wolfSSL_connect(wsession->ssl)) != SSL_SUCCESS) {
  18671. int ssl_error = wolfSSL_get_error(wsession->ssl, ret);
  18672. if (ssl_error == SSL_ERROR_WANT_READ) {
  18673. if (detail::select_read(sock, timeout_sec, timeout_usec) > 0) {
  18674. continue;
  18675. }
  18676. } else if (ssl_error == SSL_ERROR_WANT_WRITE) {
  18677. if (detail::select_write(sock, timeout_sec, timeout_usec) > 0) {
  18678. continue;
  18679. }
  18680. }
  18681. // Error or timeout
  18682. if (err) {
  18683. err->code =
  18684. impl::map_wolfssl_error(wsession->ssl, ssl_error, err->sys_errno);
  18685. err->backend_code = static_cast<uint64_t>(ssl_error);
  18686. }
  18687. impl::wolfssl_last_error() = static_cast<uint64_t>(ssl_error);
  18688. return false;
  18689. }
  18690. if (err) { err->code = ErrorCode::Success; }
  18691. return true;
  18692. }
  18693. inline bool accept_nonblocking(session_t session, socket_t sock,
  18694. time_t timeout_sec, time_t timeout_usec,
  18695. TlsError *err) {
  18696. if (!session) {
  18697. if (err) { err->code = ErrorCode::Fatal; }
  18698. return false;
  18699. }
  18700. auto wsession = static_cast<impl::WolfSSLSession *>(session);
  18701. // Set socket to non-blocking mode
  18702. detail::set_nonblocking(sock, true);
  18703. auto cleanup =
  18704. detail::scope_exit([&]() { detail::set_nonblocking(sock, false); });
  18705. int ret;
  18706. while ((ret = wolfSSL_accept(wsession->ssl)) != SSL_SUCCESS) {
  18707. int ssl_error = wolfSSL_get_error(wsession->ssl, ret);
  18708. if (ssl_error == SSL_ERROR_WANT_READ) {
  18709. if (detail::select_read(sock, timeout_sec, timeout_usec) > 0) {
  18710. continue;
  18711. }
  18712. } else if (ssl_error == SSL_ERROR_WANT_WRITE) {
  18713. if (detail::select_write(sock, timeout_sec, timeout_usec) > 0) {
  18714. continue;
  18715. }
  18716. }
  18717. // Error or timeout
  18718. if (err) {
  18719. err->code =
  18720. impl::map_wolfssl_error(wsession->ssl, ssl_error, err->sys_errno);
  18721. err->backend_code = static_cast<uint64_t>(ssl_error);
  18722. }
  18723. impl::wolfssl_last_error() = static_cast<uint64_t>(ssl_error);
  18724. return false;
  18725. }
  18726. if (err) { err->code = ErrorCode::Success; }
  18727. // Capture SNI from thread-local storage after successful handshake
  18728. wsession->sni_hostname = std::move(impl::wolfssl_pending_sni());
  18729. impl::wolfssl_pending_sni().clear();
  18730. return true;
  18731. }
  18732. inline ssize_t read(session_t session, void *buf, size_t len, TlsError &err) {
  18733. if (!session || !buf) {
  18734. err.code = ErrorCode::Fatal;
  18735. return -1;
  18736. }
  18737. auto wsession = static_cast<impl::WolfSSLSession *>(session);
  18738. int ret = wolfSSL_read(wsession->ssl, buf, static_cast<int>(len));
  18739. if (ret > 0) {
  18740. err.code = ErrorCode::Success;
  18741. return static_cast<ssize_t>(ret);
  18742. }
  18743. if (ret == 0) {
  18744. err.code = ErrorCode::PeerClosed;
  18745. return 0;
  18746. }
  18747. int ssl_error = wolfSSL_get_error(wsession->ssl, ret);
  18748. err.code = impl::map_wolfssl_error(wsession->ssl, ssl_error, err.sys_errno);
  18749. err.backend_code = static_cast<uint64_t>(ssl_error);
  18750. impl::wolfssl_last_error() = err.backend_code;
  18751. return -1;
  18752. }
  18753. inline ssize_t write(session_t session, const void *buf, size_t len,
  18754. TlsError &err) {
  18755. if (!session || !buf) {
  18756. err.code = ErrorCode::Fatal;
  18757. return -1;
  18758. }
  18759. auto wsession = static_cast<impl::WolfSSLSession *>(session);
  18760. int ret = wolfSSL_write(wsession->ssl, buf, static_cast<int>(len));
  18761. if (ret > 0) {
  18762. err.code = ErrorCode::Success;
  18763. return static_cast<ssize_t>(ret);
  18764. }
  18765. // wolfSSL_write returns 0 when the peer has sent a close_notify.
  18766. // Treat this as an error (return -1) so callers don't spin in a
  18767. // write loop adding zero to the offset.
  18768. if (ret == 0) {
  18769. err.code = ErrorCode::PeerClosed;
  18770. return -1;
  18771. }
  18772. int ssl_error = wolfSSL_get_error(wsession->ssl, ret);
  18773. err.code = impl::map_wolfssl_error(wsession->ssl, ssl_error, err.sys_errno);
  18774. err.backend_code = static_cast<uint64_t>(ssl_error);
  18775. impl::wolfssl_last_error() = err.backend_code;
  18776. return -1;
  18777. }
  18778. inline int pending(const_session_t session) {
  18779. if (!session) { return 0; }
  18780. auto wsession =
  18781. static_cast<impl::WolfSSLSession *>(const_cast<void *>(session));
  18782. return wolfSSL_pending(wsession->ssl);
  18783. }
  18784. inline void shutdown(session_t session, bool graceful) {
  18785. if (!session) { return; }
  18786. auto wsession = static_cast<impl::WolfSSLSession *>(session);
  18787. if (graceful) {
  18788. int ret;
  18789. int attempts = 0;
  18790. while ((ret = wolfSSL_shutdown(wsession->ssl)) != SSL_SUCCESS &&
  18791. attempts < 3) {
  18792. int ssl_error = wolfSSL_get_error(wsession->ssl, ret);
  18793. if (ssl_error != SSL_ERROR_WANT_READ &&
  18794. ssl_error != SSL_ERROR_WANT_WRITE) {
  18795. break;
  18796. }
  18797. attempts++;
  18798. }
  18799. } else {
  18800. wolfSSL_shutdown(wsession->ssl);
  18801. }
  18802. }
  18803. inline bool is_peer_closed(session_t session, socket_t sock) {
  18804. if (!session || sock == INVALID_SOCKET) { return true; }
  18805. auto wsession = static_cast<impl::WolfSSLSession *>(session);
  18806. // Check if there's already decrypted data available
  18807. if (wolfSSL_pending(wsession->ssl) > 0) { return false; }
  18808. // Set socket to non-blocking to avoid blocking on read
  18809. detail::set_nonblocking(sock, true);
  18810. auto cleanup =
  18811. detail::scope_exit([&]() { detail::set_nonblocking(sock, false); });
  18812. // Peek 1 byte to check connection status without consuming data
  18813. unsigned char buf;
  18814. int ret = wolfSSL_peek(wsession->ssl, &buf, 1);
  18815. // If we got data or WANT_READ (would block), connection is alive
  18816. if (ret > 0) { return false; }
  18817. int ssl_error = wolfSSL_get_error(wsession->ssl, ret);
  18818. if (ssl_error == SSL_ERROR_WANT_READ) { return false; }
  18819. return ssl_error == SSL_ERROR_ZERO_RETURN || ssl_error == SSL_ERROR_SYSCALL ||
  18820. ret == 0;
  18821. }
  18822. inline cert_t get_peer_cert(const_session_t session) {
  18823. if (!session) { return nullptr; }
  18824. auto wsession =
  18825. static_cast<impl::WolfSSLSession *>(const_cast<void *>(session));
  18826. WOLFSSL_X509 *cert = wolfSSL_get_peer_certificate(wsession->ssl);
  18827. return static_cast<cert_t>(cert);
  18828. }
  18829. inline size_t get_peer_certs(const_session_t session,
  18830. std::vector<cert_t> &certs) {
  18831. certs.clear();
  18832. if (!session) { return 0; }
  18833. // wolfSSL keeps the received chain only when built with SESSION_CERTS
  18834. #ifdef SESSION_CERTS
  18835. auto wsession =
  18836. static_cast<impl::WolfSSLSession *>(const_cast<void *>(session));
  18837. auto chain = wolfSSL_get_peer_chain(wsession->ssl);
  18838. auto count = chain ? wolfSSL_get_chain_count(chain) : 0;
  18839. for (int i = 0; i < count; i++) {
  18840. auto x509 = wolfSSL_get_chain_X509(chain, i);
  18841. if (x509) { certs.push_back(static_cast<cert_t>(x509)); }
  18842. }
  18843. #endif
  18844. return certs.size();
  18845. }
  18846. inline void free_cert(cert_t cert) {
  18847. if (cert) { wolfSSL_X509_free(static_cast<WOLFSSL_X509 *>(cert)); }
  18848. }
  18849. inline bool verify_hostname(cert_t cert, const char *hostname) {
  18850. if (!cert || !hostname) { return false; }
  18851. auto x509 = static_cast<WOLFSSL_X509 *>(cert);
  18852. std::string host_str(hostname);
  18853. // Check if hostname is an IP address (IPv4 or IPv6)
  18854. unsigned char ip_bytes[16];
  18855. auto ip_len = impl::parse_ip_address(host_str, ip_bytes);
  18856. auto is_ip = ip_len > 0;
  18857. // Check Subject Alternative Names
  18858. auto *san_names = static_cast<WOLF_STACK_OF(WOLFSSL_GENERAL_NAME) *>(
  18859. wolfSSL_X509_get_ext_d2i(x509, NID_subject_alt_name, nullptr, nullptr));
  18860. if (san_names) {
  18861. int san_count = wolfSSL_sk_num(san_names);
  18862. for (int i = 0; i < san_count; i++) {
  18863. auto *names =
  18864. static_cast<WOLFSSL_GENERAL_NAME *>(wolfSSL_sk_value(san_names, i));
  18865. if (!names) continue;
  18866. if (!is_ip && names->type == WOLFSSL_GEN_DNS) {
  18867. // DNS name
  18868. unsigned char *dns_name = nullptr;
  18869. int dns_len = wolfSSL_ASN1_STRING_to_UTF8(&dns_name, names->d.dNSName);
  18870. if (dns_name && dns_len > 0) {
  18871. std::string san_name(reinterpret_cast<char *>(dns_name),
  18872. static_cast<size_t>(dns_len));
  18873. XFREE(dns_name, nullptr, DYNAMIC_TYPE_OPENSSL);
  18874. if (detail::match_hostname(san_name, host_str)) {
  18875. wolfSSL_sk_free(san_names);
  18876. return true;
  18877. }
  18878. }
  18879. } else if (is_ip && names->type == WOLFSSL_GEN_IPADD) {
  18880. // IP address: only an iPAddress SAN of the same family (4 bytes for
  18881. // IPv4, 16 bytes for IPv6) may authenticate the host.
  18882. unsigned char *ip_data = wolfSSL_ASN1_STRING_data(names->d.iPAddress);
  18883. auto san_ip_len = wolfSSL_ASN1_STRING_length(names->d.iPAddress);
  18884. if (ip_data && san_ip_len == static_cast<int>(ip_len) &&
  18885. memcmp(ip_data, ip_bytes, ip_len) == 0) {
  18886. wolfSSL_sk_free(san_names);
  18887. return true;
  18888. }
  18889. }
  18890. }
  18891. wolfSSL_sk_free(san_names);
  18892. }
  18893. // Fallback: Check Common Name (CN) in subject. Skipped for IP-literal hosts:
  18894. // an IP identity is only valid via an iPAddress SAN, never the CN (RFC 9110;
  18895. // the OpenSSL backend's X509_check_ip behaves the same way).
  18896. auto subject = is_ip ? nullptr : wolfSSL_X509_get_subject_name(x509);
  18897. if (subject) {
  18898. char cn[256] = {};
  18899. int cn_len = wolfSSL_X509_NAME_get_text_by_NID(subject, NID_commonName, cn,
  18900. sizeof(cn));
  18901. if (cn_len > 0) {
  18902. std::string cn_str(cn, static_cast<size_t>(cn_len));
  18903. if (detail::match_hostname(cn_str, host_str)) { return true; }
  18904. }
  18905. }
  18906. return false;
  18907. }
  18908. inline uint64_t hostname_mismatch_code() {
  18909. return static_cast<uint64_t>(DOMAIN_NAME_MISMATCH);
  18910. }
  18911. inline long get_verify_result(const_session_t session) {
  18912. if (!session) { return -1; }
  18913. auto wsession =
  18914. static_cast<impl::WolfSSLSession *>(const_cast<void *>(session));
  18915. long result = wolfSSL_get_verify_result(wsession->ssl);
  18916. return result;
  18917. }
  18918. inline std::string get_cert_subject_cn(cert_t cert) {
  18919. if (!cert) return "";
  18920. auto x509 = static_cast<WOLFSSL_X509 *>(cert);
  18921. WOLFSSL_X509_NAME *subject = wolfSSL_X509_get_subject_name(x509);
  18922. if (!subject) return "";
  18923. char cn[256] = {};
  18924. int cn_len = wolfSSL_X509_NAME_get_text_by_NID(subject, NID_commonName, cn,
  18925. sizeof(cn));
  18926. if (cn_len <= 0) return "";
  18927. return std::string(cn, static_cast<size_t>(cn_len));
  18928. }
  18929. inline std::string get_cert_issuer_name(cert_t cert) {
  18930. if (!cert) return "";
  18931. auto x509 = static_cast<WOLFSSL_X509 *>(cert);
  18932. WOLFSSL_X509_NAME *issuer = wolfSSL_X509_get_issuer_name(x509);
  18933. if (!issuer) return "";
  18934. char *name_str = wolfSSL_X509_NAME_oneline(issuer, nullptr, 0);
  18935. if (!name_str) return "";
  18936. std::string result(name_str);
  18937. XFREE(name_str, nullptr, DYNAMIC_TYPE_OPENSSL);
  18938. return result;
  18939. }
  18940. inline bool get_cert_sans(cert_t cert, std::vector<SanEntry> &sans) {
  18941. sans.clear();
  18942. if (!cert) return false;
  18943. auto x509 = static_cast<WOLFSSL_X509 *>(cert);
  18944. auto *san_names = static_cast<WOLF_STACK_OF(WOLFSSL_GENERAL_NAME) *>(
  18945. wolfSSL_X509_get_ext_d2i(x509, NID_subject_alt_name, nullptr, nullptr));
  18946. if (!san_names) return true; // No SANs is not an error
  18947. int count = wolfSSL_sk_num(san_names);
  18948. for (int i = 0; i < count; i++) {
  18949. auto *name =
  18950. static_cast<WOLFSSL_GENERAL_NAME *>(wolfSSL_sk_value(san_names, i));
  18951. if (!name) continue;
  18952. SanEntry entry;
  18953. switch (name->type) {
  18954. case WOLFSSL_GEN_DNS: {
  18955. entry.type = SanType::DNS;
  18956. unsigned char *dns_name = nullptr;
  18957. int dns_len = wolfSSL_ASN1_STRING_to_UTF8(&dns_name, name->d.dNSName);
  18958. if (dns_name && dns_len > 0) {
  18959. entry.value = std::string(reinterpret_cast<char *>(dns_name),
  18960. static_cast<size_t>(dns_len));
  18961. XFREE(dns_name, nullptr, DYNAMIC_TYPE_OPENSSL);
  18962. }
  18963. break;
  18964. }
  18965. case WOLFSSL_GEN_IPADD: {
  18966. entry.type = SanType::IP;
  18967. unsigned char *ip_data = wolfSSL_ASN1_STRING_data(name->d.iPAddress);
  18968. int ip_len = wolfSSL_ASN1_STRING_length(name->d.iPAddress);
  18969. if (ip_data && ip_len == 4) {
  18970. char buf[16];
  18971. snprintf(buf, sizeof(buf), "%d.%d.%d.%d", ip_data[0], ip_data[1],
  18972. ip_data[2], ip_data[3]);
  18973. entry.value = buf;
  18974. } else if (ip_data && ip_len == 16) {
  18975. char buf[64];
  18976. snprintf(buf, sizeof(buf),
  18977. "%02x%02x:%02x%02x:%02x%02x:%02x%02x:"
  18978. "%02x%02x:%02x%02x:%02x%02x:%02x%02x",
  18979. ip_data[0], ip_data[1], ip_data[2], ip_data[3], ip_data[4],
  18980. ip_data[5], ip_data[6], ip_data[7], ip_data[8], ip_data[9],
  18981. ip_data[10], ip_data[11], ip_data[12], ip_data[13],
  18982. ip_data[14], ip_data[15]);
  18983. entry.value = buf;
  18984. }
  18985. break;
  18986. }
  18987. case WOLFSSL_GEN_EMAIL:
  18988. entry.type = SanType::EMAIL;
  18989. {
  18990. unsigned char *email = nullptr;
  18991. int email_len = wolfSSL_ASN1_STRING_to_UTF8(&email, name->d.rfc822Name);
  18992. if (email && email_len > 0) {
  18993. entry.value = std::string(reinterpret_cast<char *>(email),
  18994. static_cast<size_t>(email_len));
  18995. XFREE(email, nullptr, DYNAMIC_TYPE_OPENSSL);
  18996. }
  18997. }
  18998. break;
  18999. case WOLFSSL_GEN_URI:
  19000. entry.type = SanType::URI;
  19001. {
  19002. unsigned char *uri = nullptr;
  19003. int uri_len = wolfSSL_ASN1_STRING_to_UTF8(
  19004. &uri, name->d.uniformResourceIdentifier);
  19005. if (uri && uri_len > 0) {
  19006. entry.value = std::string(reinterpret_cast<char *>(uri),
  19007. static_cast<size_t>(uri_len));
  19008. XFREE(uri, nullptr, DYNAMIC_TYPE_OPENSSL);
  19009. }
  19010. }
  19011. break;
  19012. default: entry.type = SanType::OTHER; break;
  19013. }
  19014. if (!entry.value.empty()) { sans.push_back(std::move(entry)); }
  19015. }
  19016. wolfSSL_sk_free(san_names);
  19017. return true;
  19018. }
  19019. inline bool get_cert_validity(cert_t cert, time_t &not_before,
  19020. time_t &not_after) {
  19021. if (!cert) return false;
  19022. auto x509 = static_cast<WOLFSSL_X509 *>(cert);
  19023. const WOLFSSL_ASN1_TIME *nb = wolfSSL_X509_get_notBefore(x509);
  19024. const WOLFSSL_ASN1_TIME *na = wolfSSL_X509_get_notAfter(x509);
  19025. if (!nb || !na) return false;
  19026. // wolfSSL_ASN1_TIME_to_tm is available
  19027. struct tm tm_nb = {}, tm_na = {};
  19028. if (wolfSSL_ASN1_TIME_to_tm(nb, &tm_nb) != WOLFSSL_SUCCESS) return false;
  19029. if (wolfSSL_ASN1_TIME_to_tm(na, &tm_na) != WOLFSSL_SUCCESS) return false;
  19030. #ifdef _WIN32
  19031. not_before = _mkgmtime(&tm_nb);
  19032. not_after = _mkgmtime(&tm_na);
  19033. #else
  19034. not_before = timegm(&tm_nb);
  19035. not_after = timegm(&tm_na);
  19036. #endif
  19037. return true;
  19038. }
  19039. inline std::string get_cert_serial(cert_t cert) {
  19040. if (!cert) return "";
  19041. auto x509 = static_cast<WOLFSSL_X509 *>(cert);
  19042. WOLFSSL_ASN1_INTEGER *serial_asn1 = wolfSSL_X509_get_serialNumber(x509);
  19043. if (!serial_asn1) return "";
  19044. // Get the serial number data
  19045. int len = serial_asn1->length;
  19046. unsigned char *data = serial_asn1->data;
  19047. if (!data || len <= 0) return "";
  19048. std::string result;
  19049. result.reserve(static_cast<size_t>(len) * 2);
  19050. for (int i = 0; i < len; i++) {
  19051. char hex[3];
  19052. snprintf(hex, sizeof(hex), "%02X", data[i]);
  19053. result += hex;
  19054. }
  19055. return result;
  19056. }
  19057. inline bool get_cert_der(cert_t cert, std::vector<unsigned char> &der) {
  19058. if (!cert) return false;
  19059. auto x509 = static_cast<WOLFSSL_X509 *>(cert);
  19060. int der_len = 0;
  19061. const unsigned char *der_data = wolfSSL_X509_get_der(x509, &der_len);
  19062. if (!der_data || der_len <= 0) return false;
  19063. der.assign(der_data, der_data + der_len);
  19064. return true;
  19065. }
  19066. inline const char *get_sni(const_session_t session) {
  19067. if (!session) return nullptr;
  19068. auto wsession = static_cast<const impl::WolfSSLSession *>(session);
  19069. // For server: return SNI received from client during handshake
  19070. if (!wsession->sni_hostname.empty()) {
  19071. return wsession->sni_hostname.c_str();
  19072. }
  19073. // For client: return the hostname set via set_sni
  19074. if (!wsession->hostname.empty()) { return wsession->hostname.c_str(); }
  19075. return nullptr;
  19076. }
  19077. inline uint64_t peek_error() {
  19078. return static_cast<uint64_t>(wolfSSL_ERR_peek_last_error());
  19079. }
  19080. inline uint64_t get_error() {
  19081. uint64_t err = impl::wolfssl_last_error();
  19082. impl::wolfssl_last_error() = 0;
  19083. return err;
  19084. }
  19085. inline std::string error_string(uint64_t code) {
  19086. char buf[256];
  19087. wolfSSL_ERR_error_string(static_cast<unsigned long>(code), buf);
  19088. return std::string(buf);
  19089. }
  19090. inline ca_store_t create_ca_store(const char *pem, size_t len) {
  19091. if (!pem || len == 0) { return nullptr; }
  19092. // Validate by attempting to load into a temporary ctx
  19093. WOLFSSL_CTX *tmp_ctx = wolfSSL_CTX_new(wolfTLSv1_2_client_method());
  19094. if (!tmp_ctx) { return nullptr; }
  19095. int ret = wolfSSL_CTX_load_verify_buffer(
  19096. tmp_ctx, reinterpret_cast<const unsigned char *>(pem),
  19097. static_cast<long>(len), SSL_FILETYPE_PEM);
  19098. wolfSSL_CTX_free(tmp_ctx);
  19099. if (ret != SSL_SUCCESS) { return nullptr; }
  19100. return static_cast<ca_store_t>(
  19101. new impl::WolfSSLCAStore{std::string(pem, len)});
  19102. }
  19103. inline void free_ca_store(ca_store_t store) {
  19104. delete static_cast<impl::WolfSSLCAStore *>(store);
  19105. }
  19106. inline bool set_ca_store(ctx_t ctx, ca_store_t store) {
  19107. if (!ctx || !store) { return false; }
  19108. auto *wctx = static_cast<impl::WolfSSLContext *>(ctx);
  19109. auto *ca = static_cast<impl::WolfSSLCAStore *>(store);
  19110. int ret = wolfSSL_CTX_load_verify_buffer(
  19111. wctx->ctx, reinterpret_cast<const unsigned char *>(ca->pem_data.data()),
  19112. static_cast<long>(ca->pem_data.size()), SSL_FILETYPE_PEM);
  19113. if (ret == SSL_SUCCESS) { wctx->ca_pem_data_ += ca->pem_data; }
  19114. // This function takes ownership of the store; the PEM data was copied into
  19115. // the context, so release the source
  19116. free_ca_store(store);
  19117. return ret == SSL_SUCCESS;
  19118. }
  19119. inline size_t get_ca_certs(ctx_t ctx, std::vector<cert_t> &certs) {
  19120. certs.clear();
  19121. if (!ctx) { return 0; }
  19122. auto *wctx = static_cast<impl::WolfSSLContext *>(ctx);
  19123. if (wctx->ca_pem_data_.empty()) { return 0; }
  19124. const std::string &pem = wctx->ca_pem_data_;
  19125. const std::string begin_marker = "-----BEGIN CERTIFICATE-----";
  19126. const std::string end_marker = "-----END CERTIFICATE-----";
  19127. size_t pos = 0;
  19128. while ((pos = pem.find(begin_marker, pos)) != std::string::npos) {
  19129. size_t end_pos = pem.find(end_marker, pos);
  19130. if (end_pos == std::string::npos) { break; }
  19131. end_pos += end_marker.size();
  19132. std::string cert_pem = pem.substr(pos, end_pos - pos);
  19133. WOLFSSL_X509 *x509 = wolfSSL_X509_load_certificate_buffer(
  19134. reinterpret_cast<const unsigned char *>(cert_pem.data()),
  19135. static_cast<int>(cert_pem.size()), WOLFSSL_FILETYPE_PEM);
  19136. if (x509) { certs.push_back(static_cast<cert_t>(x509)); }
  19137. pos = end_pos;
  19138. }
  19139. return certs.size();
  19140. }
  19141. inline std::vector<std::string> get_ca_names(ctx_t ctx) {
  19142. std::vector<std::string> names;
  19143. if (!ctx) { return names; }
  19144. auto *wctx = static_cast<impl::WolfSSLContext *>(ctx);
  19145. if (wctx->ca_pem_data_.empty()) { return names; }
  19146. const std::string &pem = wctx->ca_pem_data_;
  19147. const std::string begin_marker = "-----BEGIN CERTIFICATE-----";
  19148. const std::string end_marker = "-----END CERTIFICATE-----";
  19149. size_t pos = 0;
  19150. while ((pos = pem.find(begin_marker, pos)) != std::string::npos) {
  19151. size_t end_pos = pem.find(end_marker, pos);
  19152. if (end_pos == std::string::npos) { break; }
  19153. end_pos += end_marker.size();
  19154. std::string cert_pem = pem.substr(pos, end_pos - pos);
  19155. WOLFSSL_X509 *x509 = wolfSSL_X509_load_certificate_buffer(
  19156. reinterpret_cast<const unsigned char *>(cert_pem.data()),
  19157. static_cast<int>(cert_pem.size()), WOLFSSL_FILETYPE_PEM);
  19158. if (x509) {
  19159. WOLFSSL_X509_NAME *subject = wolfSSL_X509_get_subject_name(x509);
  19160. if (subject) {
  19161. char *name_str = wolfSSL_X509_NAME_oneline(subject, nullptr, 0);
  19162. if (name_str) {
  19163. names.push_back(name_str);
  19164. XFREE(name_str, nullptr, DYNAMIC_TYPE_OPENSSL);
  19165. }
  19166. }
  19167. wolfSSL_X509_free(x509);
  19168. }
  19169. pos = end_pos;
  19170. }
  19171. return names;
  19172. }
  19173. inline bool update_server_cert(ctx_t ctx, const char *cert_pem,
  19174. const char *key_pem, const char *password) {
  19175. if (!ctx || !cert_pem || !key_pem) { return false; }
  19176. auto *wctx = static_cast<impl::WolfSSLContext *>(ctx);
  19177. // Load new certificate
  19178. int ret = wolfSSL_CTX_use_certificate_buffer(
  19179. wctx->ctx, reinterpret_cast<const unsigned char *>(cert_pem),
  19180. static_cast<long>(strlen(cert_pem)), SSL_FILETYPE_PEM);
  19181. if (ret != SSL_SUCCESS) {
  19182. impl::wolfssl_last_error() =
  19183. static_cast<uint64_t>(wolfSSL_ERR_peek_last_error());
  19184. return false;
  19185. }
  19186. // Set password if provided
  19187. if (password) { impl::set_wolfssl_password_cb(wctx->ctx, password); }
  19188. // Load new private key
  19189. ret = wolfSSL_CTX_use_PrivateKey_buffer(
  19190. wctx->ctx, reinterpret_cast<const unsigned char *>(key_pem),
  19191. static_cast<long>(strlen(key_pem)), SSL_FILETYPE_PEM);
  19192. if (ret != SSL_SUCCESS) {
  19193. impl::wolfssl_last_error() =
  19194. static_cast<uint64_t>(wolfSSL_ERR_peek_last_error());
  19195. return false;
  19196. }
  19197. return true;
  19198. }
  19199. inline bool update_server_client_ca(ctx_t ctx, const char *ca_pem) {
  19200. if (!ctx || !ca_pem) { return false; }
  19201. auto *wctx = static_cast<impl::WolfSSLContext *>(ctx);
  19202. int ret = wolfSSL_CTX_load_verify_buffer(
  19203. wctx->ctx, reinterpret_cast<const unsigned char *>(ca_pem),
  19204. static_cast<long>(strlen(ca_pem)), SSL_FILETYPE_PEM);
  19205. if (ret != SSL_SUCCESS) {
  19206. impl::wolfssl_last_error() =
  19207. static_cast<uint64_t>(wolfSSL_ERR_peek_last_error());
  19208. return false;
  19209. }
  19210. return true;
  19211. }
  19212. inline bool set_verify_callback(ctx_t ctx, VerifyCallback callback) {
  19213. if (!ctx) { return false; }
  19214. auto *wctx = static_cast<impl::WolfSSLContext *>(ctx);
  19215. impl::get_verify_callback() = std::move(callback);
  19216. wctx->has_verify_callback = static_cast<bool>(impl::get_verify_callback());
  19217. if (wctx->has_verify_callback) {
  19218. wolfSSL_CTX_set_verify(wctx->ctx, SSL_VERIFY_PEER,
  19219. impl::wolfssl_verify_callback);
  19220. } else {
  19221. wolfSSL_CTX_set_verify(
  19222. wctx->ctx,
  19223. wctx->verify_client
  19224. ? (SSL_VERIFY_PEER | SSL_VERIFY_FAIL_IF_NO_PEER_CERT)
  19225. : SSL_VERIFY_NONE,
  19226. nullptr);
  19227. }
  19228. return true;
  19229. }
  19230. inline long get_verify_error(const_session_t session) {
  19231. if (!session) { return -1; }
  19232. auto *wsession =
  19233. static_cast<impl::WolfSSLSession *>(const_cast<void *>(session));
  19234. return wolfSSL_get_verify_result(wsession->ssl);
  19235. }
  19236. inline std::string verify_error_string(long error_code) {
  19237. if (error_code == 0) { return ""; }
  19238. const char *str =
  19239. wolfSSL_X509_verify_cert_error_string(static_cast<int>(error_code));
  19240. return str ? std::string(str) : std::string();
  19241. }
  19242. } // namespace tls
  19243. #endif // CPPHTTPLIB_WOLFSSL_SUPPORT
  19244. // WebSocket implementation
  19245. namespace ws {
  19246. inline bool WebSocket::send_frame(Opcode op, const char *data, size_t len,
  19247. bool fin) {
  19248. std::lock_guard<std::mutex> lock(write_mutex_);
  19249. if (closed_) { return false; }
  19250. return detail::write_websocket_frame(strm_, op, data, len, fin, !is_server_);
  19251. }
  19252. inline ReadResult WebSocket::read(std::string &msg) {
  19253. std::unique_lock<std::mutex> read_lock(read_mutex_);
  19254. while (!closed_) {
  19255. Opcode opcode;
  19256. std::string payload;
  19257. bool fin;
  19258. impl::FrameRead r =
  19259. impl::read_websocket_frame(strm_, opcode, payload, fin, is_server_,
  19260. CPPHTTPLIB_WEBSOCKET_MAX_PAYLOAD_LENGTH);
  19261. // A timeout landed on a frame boundary: the connection is untouched and
  19262. // still usable, so hand control back without closing it. That is only
  19263. // useful to a caller who asked for the timeout; the compile-time default
  19264. // is a backstop against a peer gone quiet, and elapsing it closes the
  19265. // connection so a plain `while (ws.read(msg))` loop ends.
  19266. if (r == impl::FrameRead::Timeout && read_timeout_set_) { return Timeout; }
  19267. if (r != impl::FrameRead::Ok) {
  19268. closed_ = true;
  19269. return Fail;
  19270. }
  19271. switch (opcode) {
  19272. case Opcode::Ping: {
  19273. std::lock_guard<std::mutex> lock(write_mutex_);
  19274. detail::write_websocket_frame(strm_, Opcode::Pong, payload.data(),
  19275. payload.size(), true, !is_server_);
  19276. continue;
  19277. }
  19278. case Opcode::Pong: {
  19279. std::lock_guard<std::mutex> lock(ping_mutex_);
  19280. unacked_pings_ = 0;
  19281. continue;
  19282. }
  19283. case Opcode::Close: {
  19284. if (!closed_.exchange(true)) {
  19285. // Echo close frame back
  19286. std::lock_guard<std::mutex> lock(write_mutex_);
  19287. detail::write_websocket_frame(strm_, Opcode::Close, payload.data(),
  19288. payload.size(), true, !is_server_);
  19289. }
  19290. return Fail;
  19291. }
  19292. case Opcode::Text:
  19293. case Opcode::Binary: {
  19294. auto result = opcode == Opcode::Text ? Text : Binary;
  19295. msg = std::move(payload);
  19296. // Handle fragmentation
  19297. if (!fin) {
  19298. while (true) {
  19299. Opcode cont_opcode;
  19300. std::string cont_payload;
  19301. bool cont_fin;
  19302. // A timeout is not reportable here: half of a fragmented message is
  19303. // already in `msg` and read() has no way to resume it, so it is a
  19304. // failure like any other. Timeouts are only ever seen on a message
  19305. // boundary.
  19306. if (impl::read_websocket_frame(
  19307. strm_, cont_opcode, cont_payload, cont_fin, is_server_,
  19308. CPPHTTPLIB_WEBSOCKET_MAX_PAYLOAD_LENGTH) !=
  19309. impl::FrameRead::Ok) {
  19310. closed_ = true;
  19311. return Fail;
  19312. }
  19313. if (cont_opcode == Opcode::Ping) {
  19314. std::lock_guard<std::mutex> lock(write_mutex_);
  19315. detail::write_websocket_frame(
  19316. strm_, Opcode::Pong, cont_payload.data(), cont_payload.size(),
  19317. true, !is_server_);
  19318. continue;
  19319. }
  19320. if (cont_opcode == Opcode::Pong) {
  19321. std::lock_guard<std::mutex> lock(ping_mutex_);
  19322. unacked_pings_ = 0;
  19323. continue;
  19324. }
  19325. if (cont_opcode == Opcode::Close) {
  19326. if (!closed_.exchange(true)) {
  19327. std::lock_guard<std::mutex> lock(write_mutex_);
  19328. detail::write_websocket_frame(
  19329. strm_, Opcode::Close, cont_payload.data(),
  19330. cont_payload.size(), true, !is_server_);
  19331. }
  19332. return Fail;
  19333. }
  19334. // RFC 6455: continuation frames must use opcode 0x0
  19335. if (cont_opcode != Opcode::Continuation) {
  19336. closed_ = true;
  19337. return Fail;
  19338. }
  19339. msg += cont_payload;
  19340. if (msg.size() > CPPHTTPLIB_WEBSOCKET_MAX_PAYLOAD_LENGTH) {
  19341. closed_ = true;
  19342. return Fail;
  19343. }
  19344. if (cont_fin) { break; }
  19345. }
  19346. }
  19347. // RFC 6455 Section 5.6: text frames must contain valid UTF-8
  19348. if (result == Text && !impl::is_valid_utf8(msg)) {
  19349. // close() takes the read lock to wait for the peer's Close reply, so
  19350. // it must not run while this thread still holds it.
  19351. read_lock.unlock();
  19352. close(CloseStatus::InvalidPayload, "invalid UTF-8");
  19353. return Fail;
  19354. }
  19355. return result;
  19356. }
  19357. default: closed_ = true; return Fail;
  19358. }
  19359. }
  19360. return Fail;
  19361. }
  19362. inline bool WebSocket::send(const std::string &data) {
  19363. return send_frame(Opcode::Text, data.data(), data.size());
  19364. }
  19365. inline bool WebSocket::send(const char *data, size_t len) {
  19366. return send_frame(Opcode::Binary, data, len);
  19367. }
  19368. inline void WebSocket::close(CloseStatus status, const std::string &reason) {
  19369. if (closed_.exchange(true)) { return; }
  19370. ping_cv_.notify_all();
  19371. std::string payload;
  19372. auto code = static_cast<uint16_t>(status);
  19373. payload.push_back(static_cast<char>((code >> 8) & 0xFF));
  19374. payload.push_back(static_cast<char>(code & 0xFF));
  19375. // RFC 6455 Section 5.5: control frame payload must not exceed 125 bytes
  19376. // Close frame has 2-byte status code, so reason is limited to 123 bytes
  19377. payload += reason.substr(0, 123);
  19378. {
  19379. std::lock_guard<std::mutex> lock(write_mutex_);
  19380. detail::write_websocket_frame(strm_, Opcode::Close, payload.data(),
  19381. payload.size(), true, !is_server_);
  19382. }
  19383. // RFC 6455 Section 7.1.1: after sending a Close frame, wait for the peer's
  19384. // Close response before closing the TCP connection.
  19385. //
  19386. // Wait only when no other thread is parsing frames. When one is, it is the
  19387. // thread positioned to see the peer's reply, and reading here would take
  19388. // bytes out of the message it is assembling. Bailing out also leaves the
  19389. // stream, including its read timeout, entirely to that thread.
  19390. std::unique_lock<std::mutex> read_lock(read_mutex_, std::try_to_lock);
  19391. if (!read_lock.owns_lock()) { return; }
  19392. // Use a short timeout to avoid hanging if the peer doesn't respond.
  19393. strm_.set_read_timeout(CPPHTTPLIB_WEBSOCKET_CLOSE_TIMEOUT_SECOND, 0);
  19394. Opcode op;
  19395. std::string resp;
  19396. bool fin;
  19397. while (impl::read_websocket_frame(strm_, op, resp, fin, is_server_, 125) ==
  19398. impl::FrameRead::Ok) {
  19399. if (op == Opcode::Close) { break; }
  19400. }
  19401. }
  19402. inline WebSocket::~WebSocket() {
  19403. {
  19404. std::lock_guard<std::mutex> lock(ping_mutex_);
  19405. closed_ = true;
  19406. }
  19407. ping_cv_.notify_all();
  19408. if (ping_thread_.joinable()) { ping_thread_.join(); }
  19409. }
  19410. inline void WebSocket::start_heartbeat() {
  19411. if (ping_interval_sec_ == 0) { return; }
  19412. ping_thread_ = std::thread([this]() {
  19413. std::unique_lock<std::mutex> lock(ping_mutex_);
  19414. while (!closed_) {
  19415. ping_cv_.wait_for(lock, std::chrono::seconds(ping_interval_sec_));
  19416. if (closed_) { break; }
  19417. // If the peer has failed to respond to the previous pings, give up.
  19418. // RFC 6455 does not define a pong-timeout mechanism; this is an
  19419. // opt-in liveness check controlled by max_missed_pongs_.
  19420. if (max_missed_pongs_ > 0 && unacked_pings_ >= max_missed_pongs_) {
  19421. lock.unlock();
  19422. close(CloseStatus::GoingAway, "pong timeout");
  19423. return;
  19424. }
  19425. lock.unlock();
  19426. if (!send_frame(Opcode::Ping, nullptr, 0)) {
  19427. lock.lock();
  19428. closed_ = true;
  19429. break;
  19430. }
  19431. lock.lock();
  19432. unacked_pings_++;
  19433. }
  19434. });
  19435. }
  19436. inline const Request &WebSocket::request() const { return req_; }
  19437. inline bool WebSocket::is_open() const { return !closed_; }
  19438. inline void WebSocket::set_read_timeout(time_t sec, time_t usec) {
  19439. // 0 waits forever here, as it does for SO_RCVTIMEO. The stream waits with
  19440. // poll(), where 0 would instead mean "return immediately", so hand it the
  19441. // negative poll uses for an unbounded wait.
  19442. if (sec == 0 && usec == 0) { sec = -1; }
  19443. strm_.set_read_timeout(sec, usec);
  19444. read_timeout_set_ = true;
  19445. }
  19446. // WebSocketClient implementation
  19447. inline WebSocketClient::WebSocketClient(
  19448. const std::string &scheme_host_port_path, const Headers &headers)
  19449. : headers_(headers) {
  19450. detail::UrlComponents uc;
  19451. if (detail::parse_url(scheme_host_port_path, uc) && !uc.scheme.empty() &&
  19452. !uc.host.empty() && !uc.path.empty()) {
  19453. auto &scheme = uc.scheme;
  19454. #ifdef CPPHTTPLIB_SSL_ENABLED
  19455. if (scheme != "ws" && scheme != "wss") {
  19456. #else
  19457. if (scheme != "ws") {
  19458. #endif
  19459. #ifndef CPPHTTPLIB_NO_EXCEPTIONS
  19460. std::string msg = "'" + scheme + "' scheme is not supported.";
  19461. throw std::invalid_argument(msg);
  19462. #endif
  19463. return;
  19464. }
  19465. auto is_ssl = scheme == "wss";
  19466. host_ = std::move(uc.host);
  19467. port_ = is_ssl ? 443 : 80;
  19468. if (!uc.port.empty() && !detail::parse_port(uc.port, port_)) { return; }
  19469. path_ = std::move(uc.path);
  19470. if (!uc.query.empty()) { path_ += uc.query; }
  19471. #ifdef CPPHTTPLIB_SSL_ENABLED
  19472. is_ssl_ = is_ssl;
  19473. if (is_ssl_) {
  19474. // The context lives as long as the client so that CA configuration
  19475. // survives reconnects; sessions are created per connection.
  19476. tls_ctx_ = tls::create_client_context();
  19477. if (!tls_ctx_) { return; }
  19478. }
  19479. #else
  19480. if (is_ssl) { return; }
  19481. #endif
  19482. is_valid_ = true;
  19483. }
  19484. }
  19485. #ifdef CPPHTTPLIB_SSL_ENABLED
  19486. inline WebSocketClient::WebSocketClient(
  19487. const std::string &scheme_host_port_path, const PemMemory &pem,
  19488. const Headers &headers)
  19489. : WebSocketClient(scheme_host_port_path, headers) {
  19490. // For ws:// URLs the client certificate is silently ignored, consistent
  19491. // with the TLS-only setters such as set_ca_cert_path().
  19492. if (is_valid_ && is_ssl_ && pem.cert_pem && pem.key_pem) {
  19493. if (!tls::set_client_cert_pem(tls_ctx_, pem.cert_pem, pem.key_pem,
  19494. pem.private_key_password)) {
  19495. tls::free_context(tls_ctx_);
  19496. tls_ctx_ = nullptr;
  19497. is_valid_ = false;
  19498. }
  19499. }
  19500. }
  19501. #endif
  19502. inline WebSocketClient::~WebSocketClient() {
  19503. shutdown_and_close();
  19504. #ifdef CPPHTTPLIB_SSL_ENABLED
  19505. if (tls_ctx_) {
  19506. tls::free_context(tls_ctx_);
  19507. tls_ctx_ = nullptr;
  19508. }
  19509. #endif
  19510. }
  19511. inline bool WebSocketClient::is_valid() const { return is_valid_; }
  19512. inline void WebSocketClient::shutdown_and_close() {
  19513. // Send the close frame while the TLS session is still alive: ws_ holds an
  19514. // SSLSocketStream that keeps a raw pointer to tls_session_, so the session
  19515. // must outlive ws_->close() and ws_.reset() to avoid a use-after-free.
  19516. if (ws_ && ws_->is_open()) { ws_->close(); }
  19517. ws_.reset();
  19518. #ifdef CPPHTTPLIB_SSL_ENABLED
  19519. if (is_ssl_) {
  19520. if (tls_session_) {
  19521. tls::shutdown(tls_session_, true);
  19522. tls::free_session(tls_session_);
  19523. tls_session_ = nullptr;
  19524. }
  19525. }
  19526. #endif
  19527. if (sock_ != INVALID_SOCKET) {
  19528. detail::shutdown_socket(sock_);
  19529. detail::close_socket(sock_);
  19530. sock_ = INVALID_SOCKET;
  19531. }
  19532. }
  19533. inline bool WebSocketClient::create_stream(std::unique_ptr<Stream> &strm,
  19534. Error &error, int &ssl_error,
  19535. uint64_t &ssl_backend_error) {
  19536. // A read timeout of 0 means "wait forever", the way SO_RCVTIMEO reads it.
  19537. // The streams wait with poll(), where 0 instead means "return immediately",
  19538. // so they are given the negative poll uses for an unbounded wait.
  19539. auto unbounded = read_timeout_sec_ == 0 && read_timeout_usec_ == 0;
  19540. time_t strm_read_sec = unbounded ? -1 : read_timeout_sec_;
  19541. time_t strm_read_usec = unbounded ? 0 : read_timeout_usec_;
  19542. // The handshake belongs to establishing the connection, so an unset read
  19543. // timeout leaves it bounded by the connection timeout instead of forever.
  19544. time_t hs_sec = unbounded ? connection_timeout_sec_ : read_timeout_sec_;
  19545. time_t hs_usec = unbounded ? connection_timeout_usec_ : read_timeout_usec_;
  19546. #ifdef CPPHTTPLIB_SSL_ENABLED
  19547. if (is_ssl_) {
  19548. // A plain flag rather than SSLClient::load_certs()'s call_once: connect()
  19549. // is not safe to call concurrently on one client to begin with, since
  19550. // nothing else here is guarded either.
  19551. if (server_certificate_verification_ && !certs_loaded_) {
  19552. uint64_t backend_error = 0;
  19553. detail::load_client_ca_config(tls_ctx_, ca_cert_file_path_,
  19554. ca_cert_dir_path_, custom_ca_loaded_,
  19555. system_ca_mode_, backend_error);
  19556. certs_loaded_ = true;
  19557. }
  19558. detail::ClientTlsSessionOptions options;
  19559. options.server_hostname_verification = server_hostname_verification_;
  19560. detail::ClientTlsSessionError tls_error;
  19561. if (!detail::setup_client_tls_session(host_, tls_ctx_, tls_session_, sock_,
  19562. server_certificate_verification_,
  19563. hs_sec, hs_usec, &tls_error,
  19564. options)) {
  19565. error = tls_error.error;
  19566. ssl_error = tls_error.ssl_error;
  19567. ssl_backend_error = tls_error.backend_error;
  19568. return false;
  19569. }
  19570. strm = std::unique_ptr<Stream>(new detail::WebSocketSSLStream(
  19571. sock_, tls_session_, strm_read_sec, strm_read_usec, write_timeout_sec_,
  19572. write_timeout_usec_));
  19573. return true;
  19574. }
  19575. #else
  19576. (void)error;
  19577. (void)ssl_error;
  19578. (void)ssl_backend_error;
  19579. (void)hs_sec;
  19580. (void)hs_usec;
  19581. #endif
  19582. strm = std::unique_ptr<Stream>(
  19583. new detail::SocketStream(sock_, strm_read_sec, strm_read_usec,
  19584. write_timeout_sec_, write_timeout_usec_));
  19585. return true;
  19586. }
  19587. inline void WebSocketClient::prepare_default_headers(Request &req) {
  19588. #ifdef CPPHTTPLIB_SSL_ENABLED
  19589. auto is_ssl = is_ssl_;
  19590. #else
  19591. auto is_ssl = false;
  19592. #endif
  19593. if (!req.has_header("Host")) {
  19594. req.headers.emplace("Host", detail::make_default_host_header_value(
  19595. host_, port_, is_ssl, address_family_));
  19596. }
  19597. detail::add_default_user_agent_header(req);
  19598. }
  19599. inline Result WebSocketClient::connect() {
  19600. if (!is_valid_) { return Result{Error::Connection, -1, Headers{}}; }
  19601. shutdown_and_close();
  19602. // Check is custom IP or hostname specified for host_
  19603. std::string connect_host;
  19604. std::string ip;
  19605. detail::apply_addr_map(addr_map_, host_, connect_host, ip);
  19606. auto error = Error::Success;
  19607. sock_ = detail::create_client_socket(
  19608. connect_host, ip, port_, address_family_, tcp_nodelay_, ipv6_v6only_,
  19609. socket_options_, connection_timeout_sec_, connection_timeout_usec_,
  19610. read_timeout_sec_, read_timeout_usec_, write_timeout_sec_,
  19611. write_timeout_usec_, interface_, error);
  19612. if (sock_ == INVALID_SOCKET) {
  19613. if (error == Error::Success) { error = Error::Connection; }
  19614. return Result{error, -1, Headers{}};
  19615. }
  19616. std::unique_ptr<Stream> strm;
  19617. auto stream_error = Error::SSLConnection;
  19618. int ssl_error = 0;
  19619. uint64_t ssl_backend_error = 0;
  19620. if (!create_stream(strm, stream_error, ssl_error, ssl_backend_error)) {
  19621. shutdown_and_close();
  19622. #ifdef CPPHTTPLIB_SSL_ENABLED
  19623. return Result{stream_error, -1, Headers{}, ssl_error, ssl_backend_error};
  19624. #else
  19625. return Result{stream_error, -1, Headers{}};
  19626. #endif
  19627. }
  19628. Request req;
  19629. req.method = "GET";
  19630. req.path = path_;
  19631. req.headers = headers_;
  19632. prepare_default_headers(req);
  19633. detail::WebSocketUpgradeResponse upgrade;
  19634. if (!detail::perform_websocket_handshake(*strm, req, upgrade)) {
  19635. shutdown_and_close();
  19636. return Result{upgrade.error, upgrade.status, std::move(upgrade.headers)};
  19637. }
  19638. subprotocol_ = std::move(upgrade.selected_subprotocol);
  19639. ws_ = std::unique_ptr<WebSocket>(new WebSocket(std::move(strm), req, false,
  19640. websocket_ping_interval_sec_,
  19641. websocket_max_missed_pongs_));
  19642. // The stream was created with the timeout already; tell the WebSocket
  19643. // whether it came from the caller, so read() knows to report it as Timeout.
  19644. ws_->read_timeout_set_ = read_timeout_set_;
  19645. return Result{Error::Success, upgrade.status, std::move(upgrade.headers)};
  19646. }
  19647. inline ReadResult WebSocketClient::read(std::string &msg) {
  19648. if (!ws_) { return Fail; }
  19649. return ws_->read(msg);
  19650. }
  19651. inline bool WebSocketClient::send(const std::string &data) {
  19652. if (!ws_) { return false; }
  19653. return ws_->send(data);
  19654. }
  19655. inline bool WebSocketClient::send(const char *data, size_t len) {
  19656. if (!ws_) { return false; }
  19657. return ws_->send(data, len);
  19658. }
  19659. inline void WebSocketClient::close(CloseStatus status,
  19660. const std::string &reason) {
  19661. if (ws_) { ws_->close(status, reason); }
  19662. }
  19663. inline bool WebSocketClient::is_open() const { return ws_ && ws_->is_open(); }
  19664. inline const std::string &WebSocketClient::subprotocol() const {
  19665. return subprotocol_;
  19666. }
  19667. inline void WebSocketClient::set_read_timeout(time_t sec, time_t usec) {
  19668. read_timeout_sec_ = sec;
  19669. read_timeout_usec_ = usec;
  19670. read_timeout_set_ = true;
  19671. // The members above only seed the next connect(); read() consults the
  19672. // stream, so an already-open connection has to be told directly.
  19673. if (ws_) { ws_->set_read_timeout(sec, usec); }
  19674. }
  19675. inline void WebSocketClient::set_write_timeout(time_t sec, time_t usec) {
  19676. write_timeout_sec_ = sec;
  19677. write_timeout_usec_ = usec;
  19678. }
  19679. inline void WebSocketClient::set_websocket_ping_interval(time_t sec) {
  19680. websocket_ping_interval_sec_ = sec;
  19681. }
  19682. inline void WebSocketClient::set_websocket_max_missed_pongs(int count) {
  19683. websocket_max_missed_pongs_ = count;
  19684. }
  19685. inline void WebSocketClient::set_tcp_nodelay(bool on) { tcp_nodelay_ = on; }
  19686. inline void WebSocketClient::set_address_family(int family) {
  19687. address_family_ = family;
  19688. }
  19689. inline void WebSocketClient::set_ipv6_v6only(bool on) { ipv6_v6only_ = on; }
  19690. inline void WebSocketClient::set_socket_options(SocketOptions socket_options) {
  19691. socket_options_ = std::move(socket_options);
  19692. }
  19693. inline void WebSocketClient::set_connection_timeout(time_t sec, time_t usec) {
  19694. connection_timeout_sec_ = sec;
  19695. connection_timeout_usec_ = usec;
  19696. }
  19697. inline void WebSocketClient::set_interface(const std::string &intf) {
  19698. interface_ = intf;
  19699. }
  19700. inline void WebSocketClient::set_hostname_addr_map(
  19701. std::map<std::string, std::string> addr_map) {
  19702. addr_map_ = std::move(addr_map);
  19703. }
  19704. #ifdef CPPHTTPLIB_SSL_ENABLED
  19705. inline void
  19706. WebSocketClient::set_ca_cert_path(const std::string &ca_cert_file_path,
  19707. const std::string &ca_cert_dir_path) {
  19708. ca_cert_file_path_ = ca_cert_file_path;
  19709. ca_cert_dir_path_ = ca_cert_dir_path;
  19710. }
  19711. inline void WebSocketClient::set_ca_cert_store(tls::ca_store_t store) {
  19712. if (store && tls_ctx_) {
  19713. // set_ca_store takes ownership of store
  19714. tls::set_ca_store(tls_ctx_, store);
  19715. custom_ca_loaded_ = true;
  19716. } else if (store) {
  19717. tls::free_ca_store(store);
  19718. }
  19719. }
  19720. inline void WebSocketClient::load_ca_cert_store(const char *ca_cert,
  19721. std::size_t size) {
  19722. if (tls_ctx_ && ca_cert && size > 0) {
  19723. tls::load_ca_pem(tls_ctx_, ca_cert, size);
  19724. custom_ca_loaded_ = true;
  19725. }
  19726. }
  19727. inline void
  19728. WebSocketClient::enable_server_certificate_verification(bool enabled) {
  19729. server_certificate_verification_ = enabled;
  19730. }
  19731. inline void WebSocketClient::enable_server_hostname_verification(bool enabled) {
  19732. server_hostname_verification_ = enabled;
  19733. }
  19734. inline void WebSocketClient::enable_system_ca(bool enabled) {
  19735. system_ca_mode_ = enabled ? SystemCAMode::Enabled : SystemCAMode::Disabled;
  19736. }
  19737. #endif // CPPHTTPLIB_SSL_ENABLED
  19738. } // namespace ws
  19739. // ----------------------------------------------------------------------------
  19740. } // namespace httplib
  19741. #endif // CPPHTTPLIB_HTTPLIB_H